@elastic/schemas 0.5.0 → 0.5.1

package/src/es/json/security.update_settings.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_settings","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"},"security":{"$ref":"./security._types.json#/$defs/security._types__SecuritySettings","description":"Settings for the index used for most security configuration, including native realm users and roles configured with the API.","x-found-in":"body"},"security-profile":{"$ref":"./security._types.json#/$defs/security._types__SecuritySettings","description":"Settings for the index used to store profile information.","x-found-in":"body"},"security-tokens":{"$ref":"./security._types.json#/$defs/security._types__SecuritySettings","description":"Settings for the index used to store tokens.","x-found-in":"body"}},"description":"Update security index settings.\n\nUpdate the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.\n\nNOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.\n\nIf a specific index is not in use on the system and settings are provided for it, the request will be rejected.\nThis API does not yet support configuring the settings for indices before they are in use."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_settings","description":"Update security index settings.\n\nUpdate the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`.\n\nNOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.\n\nIf a specific index is not in use on the system and settings are provided for it, the request will be rejected.\nThis API does not yet support configuring the settings for indices before they are in use.","x-api":{"id":"security.update_settings","name":"update-settings","namespace":"security"},"x-method":"PUT","x-path":"/_security/settings","x-urls":[{"path":"/_security/settings","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"stability":"stable","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"},"security":{"$ref":"./security._types.json#/$defs/security._types__SecuritySettings","description":"Settings for the index used for most security configuration, including native realm users and roles configured with the API.","x-found-in":"body"},"security-profile":{"$ref":"./security._types.json#/$defs/security._types__SecuritySettings","description":"Settings for the index used to store profile information.","x-found-in":"body"},"security-tokens":{"$ref":"./security._types.json#/$defs/security._types__SecuritySettings","description":"Settings for the index used to store tokens.","x-found-in":"body"}}}

package/src/es/json/security.update_settings.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_settings","type":"object","properties":{"acknowledged":{"type":"boolean"}},"required":["acknowledged"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_settings","x-api":{"id":"security.update_settings","name":"update-settings","namespace":"security"},"type":"object","properties":{"acknowledged":{"type":"boolean"}},"required":["acknowledged"]}

package/src/es/json/security.update_user_profile_data.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_user_profile_data","type":"object","properties":{"if_seq_no":{"type":"number","description":"Only perform the operation if the document has this sequence number.","x-found-in":"query"},"if_primary_term":{"type":"number","description":"Only perform the operation if the document has this primary term.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.","x-found-in":"query"},"labels":{"type":"object","additionalProperties":{},"description":"Searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).","x-found-in":"body"},"data":{"type":"object","additionalProperties":{},"description":"Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).\nThe data object is not searchable, but can be retrieved with the get user profile API.","x-found-in":"body"},"uid":{"type":"string","description":"A unique identifier for the user profile.","x-found-in":"path"}},"required":["uid"],"description":"Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_user_profile_data","description":"Update user profile data.\n\nUpdate specific data for the user profile that is associated with a unique ID.\n\nNOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions.\nIndividual users and external applications should not call this API directly.\nElastic reserves the right to change or remove this feature in future releases without prior notice.\n\nTo use this API, you must have one of the following privileges:\n\n* The `manage_user_profile` cluster privilege.\n* The `update_profile_data` global privilege for the namespaces that are referenced in the request.\n\nThis API updates the `labels` and `data` fields of an existing user profile document with JSON objects.\nNew keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.\n\nFor both labels and data, content is namespaced by the top-level fields.\nThe `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.","x-api":{"id":"security.update_user_profile_data","name":"update-user-profile-data","namespace":"security"},"x-method":"PUT","x-path":"/_security/profile/{uid}/_data","x-urls":[{"path":"/_security/profile/{uid}/_data","methods":["PUT","POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"8.2.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"if_seq_no":{"type":"number","description":"Only perform the operation if the document has this sequence number.","x-found-in":"query"},"if_primary_term":{"type":"number","description":"Only perform the operation if the document has this primary term.","x-found-in":"query"},"refresh":{"$ref":"./_types.json#/$defs/_types__Refresh","description":"If 'true', Elasticsearch refreshes the affected shards to make this operation\nvisible to search.\nIf 'wait_for', it waits for a refresh to make this operation visible to search.\nIf 'false', nothing is done with refreshes.","x-found-in":"query"},"labels":{"type":"object","additionalProperties":{},"description":"Searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the labels object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).","x-found-in":"body"},"data":{"type":"object","additionalProperties":{},"description":"Non-searchable data that you want to associate with the user profile.\nThis field supports a nested data structure.\nWithin the `data` object, top-level keys cannot begin with an underscore (`_`) or contain a period (`.`).\nThe data object is not searchable, but can be retrieved with the get user profile API.","x-found-in":"body"},"uid":{"type":"string","description":"A unique identifier for the user profile.","x-found-in":"path"}},"required":["uid"]}

package/src/es/json/security.update_user_profile_data.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_user_profile_data","$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_user_profile_data","x-api":{"id":"security.update_user_profile_data","name":"update-user-profile-data","namespace":"security"},"$ref":"./_types.json#/$defs/_types__AcknowledgedResponseBase"}

package/src/es/json/simulate.ingest.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"simulate.ingest","type":"object","properties":{"pipeline":{"type":"string","description":"The pipeline to use as the default pipeline.\nThis value can be used to override the default pipeline of the index.","x-found-in":"query"},"merge_type":{"$ref":"./simulate.ingest.json#/$defs/simulate.ingest__MergeType","description":"The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__Document"},"description":"Sample documents to test in the pipeline.","x-found-in":"body"},"component_template_substitutions":{"type":"object","additionalProperties":{"$ref":"./cluster._types.json#/$defs/cluster._types__ComponentTemplateNode"},"description":"A map of component template names to substitute component template definition objects.","x-found-in":"body"},"index_template_substitutions":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplate"},"description":"A map of index template names to substitute index template definition objects.","x-found-in":"body"},"mapping_addition":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","x-found-in":"body"},"pipeline_substitutions":{"type":"object","additionalProperties":{"$ref":"./ingest._types.json#/$defs/ingest._types__Pipeline"},"description":"Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.","x-found-in":"body"},"index":{"type":"string","description":"The index to simulate ingesting into.\nThis value can be overridden by specifying an index on each document.\nIf you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.","x-found-in":"path"}},"required":["docs"],"description":"Simulate data ingestion.\n\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"simulate.ingest","description":"Simulate data ingestion.\n\nRun ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index.\n\nThis API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch.\n\nThe API runs the default and final pipeline for that index against a set of documents provided in the body of the request.\nIf a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would.\nNo data is indexed into Elasticsearch.\nInstead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation.\nThe transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result.\n\nThis API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline.\nThe simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index.\n\nBy default, the pipeline definitions that are currently in the system are used.\nHowever, you can supply substitute pipeline definitions in the body of the request.\nThese will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request.","x-api":{"id":"simulate.ingest","name":"ingest","namespace":"simulate"},"x-method":"GET","x-path":"/_ingest/{index}/_simulate","x-urls":[{"path":"/_ingest/_simulate","methods":["GET","POST"]},{"path":"/_ingest/{index}/_simulate","methods":["GET","POST"]}],"x-destructive":false,"x-availability":{"stack":{"since":"8.12.0","stability":"experimental","visibility":"public"}},"type":"object","properties":{"pipeline":{"type":"string","description":"The pipeline to use as the default pipeline.\nThis value can be used to override the default pipeline of the index.","x-found-in":"query"},"merge_type":{"$ref":"./simulate.ingest.json#/$defs/simulate.ingest__MergeType","description":"The mapping merge type if mapping overrides are being provided in mapping_addition.\nThe allowed values are one of index or template.\nThe index option merges mappings the way they would be merged into an existing index.\nThe template option merges mappings the way they would be merged into a template.","x-found-in":"query"},"docs":{"type":"array","items":{"$ref":"./ingest._types.json#/$defs/ingest._types__Document"},"description":"Sample documents to test in the pipeline.","x-found-in":"body"},"component_template_substitutions":{"type":"object","additionalProperties":{"$ref":"./cluster._types.json#/$defs/cluster._types__ComponentTemplateNode"},"description":"A map of component template names to substitute component template definition objects.","x-found-in":"body"},"index_template_substitutions":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplate"},"description":"A map of index template names to substitute index template definition objects.","x-found-in":"body"},"mapping_addition":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","x-found-in":"body"},"pipeline_substitutions":{"type":"object","additionalProperties":{"$ref":"./ingest._types.json#/$defs/ingest._types__Pipeline"},"description":"Pipelines to test.\nIf you don’t specify the `pipeline` request path parameter, this parameter is required.\nIf you specify both this and the request path parameter, the API only uses the request path parameter.","x-found-in":"body"},"index":{"type":"string","description":"The index to simulate ingesting into.\nThis value can be overridden by specifying an index on each document.\nIf you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.","x-found-in":"path"}},"required":["docs"]}

package/src/es/json/simulate.ingest.response.json

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

package/src/es/json/slm.delete_lifecycle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.delete_lifecycle","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"},"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to remove","x-found-in":"path"}},"required":["policy_id"],"description":"Delete a policy.\n\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.delete_lifecycle","description":"Delete a policy.\n\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots.","x-api":{"id":"slm.delete_lifecycle","name":"delete-lifecycle","namespace":"slm"},"x-method":"DELETE","x-path":"/_slm/policy/{policy_id}","x-urls":[{"path":"/_slm/policy/{policy_id}","methods":["DELETE"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"},"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to remove","x-found-in":"path"}},"required":["policy_id"]}

package/src/es/json/slm.delete_lifecycle.response.json

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

package/src/es/json/slm.execute_lifecycle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_lifecycle","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"},"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to be executed","x-found-in":"path"}},"required":["policy_id"],"description":"Run a policy.\n\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_lifecycle","description":"Run a policy.\n\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance.","x-api":{"id":"slm.execute_lifecycle","name":"execute-lifecycle","namespace":"slm"},"x-method":"PUT","x-path":"/_slm/policy/{policy_id}/_execute","x-urls":[{"path":"/_slm/policy/{policy_id}/_execute","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"},"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to be executed","x-found-in":"path"}},"required":["policy_id"]}

package/src/es/json/slm.execute_lifecycle.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_lifecycle","type":"object","properties":{"snapshot_name":{"type":"string"}},"required":["snapshot_name"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_lifecycle","x-api":{"id":"slm.execute_lifecycle","name":"execute-lifecycle","namespace":"slm"},"type":"object","properties":{"snapshot_name":{"type":"string"}},"required":["snapshot_name"]}

package/src/es/json/slm.execute_retention.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_retention","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"}},"description":"Run a retention policy.\n\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_retention","description":"Run a retention policy.\n\nManually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules.\nThe retention policy is normally applied according to its schedule.","x-api":{"id":"slm.execute_retention","name":"execute-retention","namespace":"slm"},"x-method":"POST","x-path":"/_slm/_execute_retention","x-urls":[{"path":"/_slm/_execute_retention","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"}}}

package/src/es/json/slm.execute_retention.response.json

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

package/src/es/json/slm.get_lifecycle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_lifecycle","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"},"policy_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot lifecycle policy identifiers.","x-found-in":"path"}},"description":"Get policy information.\n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_lifecycle","description":"Get policy information.\n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts.","x-api":{"id":"slm.get_lifecycle","name":"get-lifecycle","namespace":"slm"},"x-method":"GET","x-path":"/_slm/policy/{policy_id}","x-urls":[{"path":"/_slm/policy/{policy_id}","methods":["GET"]},{"path":"/_slm/policy","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"},"policy_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot lifecycle policy identifiers.","x-found-in":"path"}}}

package/src/es/json/slm.get_lifecycle.response.json

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

package/src/es/json/slm.get_stats.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_stats","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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"description":"Get snapshot lifecycle management statistics.\n\nGet global and policy-level statistics about actions taken by snapshot lifecycle management."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_stats","description":"Get snapshot lifecycle management statistics.\n\nGet global and policy-level statistics about actions taken by snapshot lifecycle management.","x-api":{"id":"slm.get_stats","name":"get-stats","namespace":"slm"},"x-method":"GET","x-path":"/_slm/stats","x-urls":[{"path":"/_slm/stats","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.5.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}}}

package/src/es/json/slm.get_stats.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_stats","type":"object","properties":{"retention_deletion_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"retention_deletion_time_millis":{},"retention_failed":{"type":"number"},"retention_runs":{"type":"number"},"retention_timed_out":{"type":"number"},"total_snapshots_deleted":{"type":"number"},"total_snapshot_deletion_failures":{"type":"number"},"total_snapshots_failed":{"type":"number"},"total_snapshots_taken":{"type":"number"},"policy_stats":{"type":"array","items":{"$ref":"./slm._types.json#/$defs/slm._types__SnapshotPolicyStats"}}},"required":["retention_deletion_time","retention_deletion_time_millis","retention_failed","retention_runs","retention_timed_out","total_snapshots_deleted","total_snapshot_deletion_failures","total_snapshots_failed","total_snapshots_taken","policy_stats"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_stats","x-api":{"id":"slm.get_stats","name":"get-stats","namespace":"slm"},"type":"object","properties":{"retention_deletion_time":{"$ref":"./_types.json#/$defs/_types__Duration"},"retention_deletion_time_millis":{},"retention_failed":{"type":"number"},"retention_runs":{"type":"number"},"retention_timed_out":{"type":"number"},"total_snapshots_deleted":{"type":"number"},"total_snapshot_deletion_failures":{"type":"number"},"total_snapshots_failed":{"type":"number"},"total_snapshots_taken":{"type":"number"},"policy_stats":{"type":"array","items":{"$ref":"./slm._types.json#/$defs/slm._types__SnapshotPolicyStats"}}},"required":["retention_deletion_time","retention_deletion_time_millis","retention_failed","retention_runs","retention_timed_out","total_snapshots_deleted","total_snapshot_deletion_failures","total_snapshots_failed","total_snapshots_taken","policy_stats"]}

package/src/es/json/slm.get_status.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_status","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.\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.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"description":"Get the snapshot lifecycle management status."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_status","description":"Get the snapshot lifecycle management status.","x-api":{"id":"slm.get_status","name":"get-status","namespace":"slm"},"x-method":"GET","x-path":"/_slm/status","x-urls":[{"path":"/_slm/status","methods":["GET"]}],"x-destructive":false,"x-availability":{"stack":{"since":"7.6.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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.\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.\nIf no response is received 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"}}}

package/src/es/json/slm.get_status.response.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_status","type":"object","properties":{"operation_mode":{"$ref":"./_types.json#/$defs/_types__LifecycleOperationMode"}},"required":["operation_mode"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_status","x-api":{"id":"slm.get_status","name":"get-status","namespace":"slm"},"type":"object","properties":{"operation_mode":{"$ref":"./_types.json#/$defs/_types__LifecycleOperationMode"}},"required":["operation_mode"]}

package/src/es/json/slm.put_lifecycle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.put_lifecycle","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.\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.\nIf no response is received 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"},"config":{"$ref":"./slm._types.json#/$defs/slm._types__Configuration","description":"Configuration for each snapshot created by the policy.","x-found-in":"body"},"name":{"type":"string","description":"Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.","x-found-in":"body"},"repository":{"type":"string","description":"Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.","x-found-in":"body"},"retention":{"$ref":"./slm._types.json#/$defs/slm._types__Retention","description":"Retention rules used to retain and delete snapshots created by the policy.","x-found-in":"body"},"schedule":{"type":"string","description":"Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.","x-found-in":"body"},"policy_id":{"type":"string","description":"The identifier for the snapshot lifecycle policy you want to create or update.","x-found-in":"path"}},"required":["policy_id"],"description":"Create or update a policy.\n\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.put_lifecycle","description":"Create or update a policy.\n\nCreate or update a snapshot lifecycle policy.\nIf the policy already exists, this request increments the policy version.\nOnly the latest version of a policy is stored.","x-api":{"id":"slm.put_lifecycle","name":"put-lifecycle","namespace":"slm"},"x-method":"PUT","x-path":"/_slm/policy/{policy_id}","x-urls":[{"path":"/_slm/policy/{policy_id}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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.\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.\nIf no response is received 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"},"config":{"$ref":"./slm._types.json#/$defs/slm._types__Configuration","description":"Configuration for each snapshot created by the policy.","x-found-in":"body"},"name":{"type":"string","description":"Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name.","x-found-in":"body"},"repository":{"type":"string","description":"Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API.","x-found-in":"body"},"retention":{"$ref":"./slm._types.json#/$defs/slm._types__Retention","description":"Retention rules used to retain and delete snapshots created by the policy.","x-found-in":"body"},"schedule":{"type":"string","description":"Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately.","x-found-in":"body"},"policy_id":{"type":"string","description":"The identifier for the snapshot lifecycle policy you want to create or update.","x-found-in":"path"}},"required":["policy_id"]}

package/src/es/json/slm.put_lifecycle.response.json

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

package/src/es/json/slm.start.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.start","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.\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.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"description":"Start snapshot lifecycle management.\n\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.start","description":"Start snapshot lifecycle management.\n\nSnapshot lifecycle management (SLM) starts automatically when a cluster is formed.\nManually starting SLM is necessary only if it has been stopped using the stop SLM API.","x-api":{"id":"slm.start","name":"start","namespace":"slm"},"x-method":"POST","x-path":"/_slm/start","x-urls":[{"path":"/_slm/start","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.6.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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.\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.\nIf no response is received 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"}}}

package/src/es/json/slm.start.response.json

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

package/src/es/json/slm.stop.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.stop","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.\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.\nIf no response is received before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"}},"description":"Stop snapshot lifecycle management.\n\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.stop","description":"Stop snapshot lifecycle management.\n\nStop all snapshot lifecycle management (SLM) operations and the SLM plugin.\nThis API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices.\nStopping SLM does not stop any snapshots that are in progress.\nYou can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped.\n\nThe API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped.\nUse the get snapshot lifecycle management status API to see if SLM is running.","x-api":{"id":"slm.stop","name":"stop","namespace":"slm"},"x-method":"POST","x-path":"/_slm/stop","x-urls":[{"path":"/_slm/stop","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.6.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"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.\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.\nIf no response is received 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"}}}

package/src/es/json/slm.stop.response.json

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

package/src/es/json/snapshot._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"snapshot._types__SnapshotInfo":{"type":"object","properties":{"data_streams":{"type":"array","items":{"type":"string"}},"duration":{"$ref":"./_types.json#/$defs/_types__Duration"},"duration_in_millis":{},"end_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"end_time_in_millis":{},"failures":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotShardFailure"}},"include_global_state":{"type":"boolean"},"indices":{"type":"array","items":{"type":"string"}},"index_details":{"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__IndexDetails"}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"reason":{"type":"string"},"repository":{"type":"string"},"snapshot":{"type":"string"},"shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"start_time_in_millis":{},"state":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"},"version_id":{"type":"number"},"feature_states":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__InfoFeatureState"}}},"required":["data_streams","snapshot","uuid"]},"snapshot._types__SnapshotShardFailure":{"type":"object","properties":{"index":{"type":"string"},"node_id":{"type":"string"},"reason":{"type":"string"},"shard_id":{"type":"number"},"index_uuid":{"type":"string"},"status":{"type":"string"}},"required":["index","reason","shard_id","index_uuid","status"]},"snapshot._types__IndexDetails":{"type":"object","properties":{"shard_count":{"type":"number"},"size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"size_in_bytes":{"type":"number"},"max_segments_per_shard":{"type":"number"}},"required":["shard_count","size_in_bytes","max_segments_per_shard"]},"snapshot._types__InfoFeatureState":{"type":"object","properties":{"feature_name":{"type":"string"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices"}},"required":["feature_name","indices"]},"snapshot._types__Repository":{"anyOf":[{"$ref":"./snapshot._types.json#/$defs/snapshot._types__AzureRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__GcsRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__S3Repository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SharedFileSystemRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ReadOnlyUrlRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepository"}]},"snapshot._types__AzureRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"azure","description":"The Azure repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__AzureRepositorySettings","description":"The repository settings."}},"required":["type"]},"snapshot._types__AzureRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"base_path":{"type":"string","description":"The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the Azure repository client to use."},"container":{"type":"string","description":"The Azure container."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API."},"location_mode":{"type":"string","description":"Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`."},"max_concurrent_batch_deletes":{"type":"number","description":"The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}}},"snapshot._types__GcsRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"gcs","description":"The Google Cloud Storage repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__GcsRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__GcsRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"bucket":{"type":"string","description":"The name of the bucket to be used for snapshots."},"application_name":{"type":"string","description":"The name used by the client when it uses the Google Cloud Storage service."},"base_path":{"type":"string","description":"The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the client to use to connect to Google Cloud Storage."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["bucket"]},"snapshot._types__S3Repository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"s3","description":"The S3 repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__S3RepositorySettings","description":"The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings."}},"required":["type","settings"]},"snapshot._types__S3RepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"bucket":{"type":"string","description":"The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules."},"base_path":{"type":"string","description":"The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket."},"buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller."},"canned_acl":{"type":"string","description":"The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects."},"client":{"type":"string","description":"The name of the S3 client to use to connect to S3."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the  AWS DeleteObjects API."},"get_register_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait before trying again if an attempt to read a linearizable register fails."},"max_multipart_parts":{"type":"number","description":"The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3."},"max_multipart_upload_cleanup_size":{"type":"number","description":"The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads."},"readonly":{"type":"boolean","description":"If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."},"server_side_encryption":{"type":"boolean","description":"When set to `true`, files are encrypted on server side using an AES256 algorithm."},"storage_class":{"type":"string","description":"The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`."},"throttled_delete_retry.delay_increment":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms."},"throttled_delete_retry.maximum_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms."},"throttled_delete_retry.maximum_number_of_retries":{"type":"number","description":"The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries."}},"required":["bucket"]},"snapshot._types__SharedFileSystemRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"fs","description":"The shared file system repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SharedFileSystemRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__SharedFileSystemRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"location":{"type":"string","description":"The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["location"]},"snapshot._types__ReadOnlyUrlRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"url","description":"The read-only URL repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ReadOnlyUrlRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__ReadOnlyUrlRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"http_max_retries":{"type":"number","description":"The maximum number of retries for HTTP and HTTPS URLs."},"http_socket_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum wait time for data transfers over a connection."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"url":{"type":"string","description":"The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting."}},"required":["url"]},"snapshot._types__SourceOnlyRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"source","description":"The source-only repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__SourceOnlyRepositorySettings":{"anyOf":[{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForSharedFileSystem"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForReadOnlyUrl"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForAzure"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForGcs"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForS3"}],"description":"The delegated repository type.\nSource repositories can use `settings` properties for its delegated repository type."},"snapshot._types__SourceOnlyRepositorySettingsForSharedFileSystem":{"type":"object","properties":{"delegate_type":{"const":"fs"},"location":{"type":"string","description":"The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["delegate_type","location"]},"snapshot._types__SourceOnlyRepositorySettingsForReadOnlyUrl":{"type":"object","properties":{"delegate_type":{"const":"url"},"http_max_retries":{"type":"number","description":"The maximum number of retries for HTTP and HTTPS URLs."},"http_socket_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum wait time for data transfers over a connection."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"url":{"type":"string","description":"The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting."}},"required":["delegate_type","url"]},"snapshot._types__SourceOnlyRepositorySettingsForAzure":{"type":"object","properties":{"delegate_type":{"const":"azure"},"base_path":{"type":"string","description":"The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the Azure repository client to use."},"container":{"type":"string","description":"The Azure container."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API."},"location_mode":{"type":"string","description":"Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`."},"max_concurrent_batch_deletes":{"type":"number","description":"The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["delegate_type"]},"snapshot._types__SourceOnlyRepositorySettingsForGcs":{"type":"object","properties":{"delegate_type":{"const":"gcs"},"bucket":{"type":"string","description":"The name of the bucket to be used for snapshots."},"application_name":{"type":"string","description":"The name used by the client when it uses the Google Cloud Storage service."},"base_path":{"type":"string","description":"The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the client to use to connect to Google Cloud Storage."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["delegate_type","bucket"]},"snapshot._types__SourceOnlyRepositorySettingsForS3":{"type":"object","properties":{"delegate_type":{"const":"s3"},"bucket":{"type":"string","description":"The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules."},"base_path":{"type":"string","description":"The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket."},"buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller."},"canned_acl":{"type":"string","description":"The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects."},"client":{"type":"string","description":"The name of the S3 client to use to connect to S3."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the  AWS DeleteObjects API."},"get_register_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait before trying again if an attempt to read a linearizable register fails."},"max_multipart_parts":{"type":"number","description":"The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3."},"max_multipart_upload_cleanup_size":{"type":"number","description":"The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads."},"readonly":{"type":"boolean","description":"If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."},"server_side_encryption":{"type":"boolean","description":"When set to `true`, files are encrypted on server side using an AES256 algorithm."},"storage_class":{"type":"string","description":"The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`."},"throttled_delete_retry.delay_increment":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms."},"throttled_delete_retry.maximum_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms."},"throttled_delete_retry.maximum_number_of_retries":{"type":"number","description":"The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries."}},"required":["delegate_type","bucket"]},"snapshot._types__SnapshotSort":{"enum":["start_time","duration","name","index_count","repository","shard_count","failed_shard_count"]},"snapshot._types__SnapshotState":{"enum":["IN_PROGRESS","SUCCESS","FAILED","PARTIAL","INCOMPATIBLE"]},"snapshot._types__Status":{"type":"object","properties":{"include_global_state":{"type":"boolean","description":"Indicates whether the current cluster state is included in the snapshot."},"indices":{"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotIndexStats"}},"repository":{"type":"string","description":"The name of the repository that includes the snapshot."},"shards_stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStats","description":"Statistics for the shards in the snapshot."},"snapshot":{"type":"string","description":"The name of the snapshot."},"state":{"type":"string","description":"The current snapshot state:\n\n* `STARTED`: The snapshot is currently running.\n* `SUCCESS`: All shard snapshots have completed. The snapshot may or may not have completed finalization.\n* `FAILED`: The snapshot finished with an error and failed to store any data."},"stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotStats","description":"Details about the number (`file_count`) and size (`size_in_bytes`) of files included in the snapshot."},"uuid":{"type":"string","description":"The universally unique identifier (UUID) for the snapshot."}},"required":["include_global_state","indices","repository","shards_stats","snapshot","state","stats","uuid"]},"snapshot._types__SnapshotIndexStats":{"type":"object","properties":{"shards":{"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotShardsStatus"}},"shards_stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStats"},"stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotStats"}},"required":["shards","shards_stats","stats"]},"snapshot._types__SnapshotShardsStatus":{"type":"object","properties":{"stage":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsStage"},"stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsSummary"}},"required":["stage","stats"]},"snapshot._types__ShardsStatsStage":{"enum":["DONE","FAILURE","FINALIZE","INIT","STARTED"]},"snapshot._types__ShardsStatsSummary":{"type":"object","properties":{"incremental":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsSummaryItem"},"total":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsSummaryItem"},"start_time_in_millis":{},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_millis":{}},"required":["incremental","total","start_time_in_millis","time_in_millis"]},"snapshot._types__ShardsStatsSummaryItem":{"type":"object","properties":{"file_count":{"type":"number"},"size_in_bytes":{"type":"number"}},"required":["file_count","size_in_bytes"]},"snapshot._types__ShardsStats":{"type":"object","properties":{"done":{"type":"number","description":"The number of shards that initialized, started, and finalized successfully."},"failed":{"type":"number","description":"The number of shards that failed to be included in the snapshot."},"finalizing":{"type":"number","description":"The number of shards that are finalizing but are not done."},"initializing":{"type":"number","description":"The number of shards that are still initializing."},"started":{"type":"number","description":"The number of shards that have started but are not finalized."},"total":{"type":"number","description":"The total number of shards included in the snapshot."}},"required":["done","failed","finalizing","initializing","started","total"]},"snapshot._types__SnapshotStats":{"type":"object","properties":{"incremental":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__FileCountSnapshotStats","description":"The number and size of files that still need to be copied as part of the incremental snapshot.\nFor completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot."},"start_time_in_millis":{"description":"The time, in milliseconds, when the snapshot creation process started."},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_millis":{"description":"The total time, in milliseconds, that it took for the snapshot process to complete."},"total":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__FileCountSnapshotStats","description":"The total number and size of files that are referenced by the snapshot."}},"required":["incremental","start_time_in_millis","time_in_millis","total"]},"snapshot._types__FileCountSnapshotStats":{"type":"object","properties":{"file_count":{"type":"number"},"size_in_bytes":{"type":"number"}},"required":["file_count","size_in_bytes"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"snapshot._types__SnapshotInfo":{"type":"object","properties":{"data_streams":{"type":"array","items":{"type":"string"}},"duration":{"$ref":"./_types.json#/$defs/_types__Duration"},"duration_in_millis":{},"end_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"end_time_in_millis":{},"failures":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotShardFailure"}},"include_global_state":{"type":"boolean"},"indices":{"type":"array","items":{"type":"string"}},"index_details":{"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__IndexDetails"},"x-availability":{"stack":{"since":"7.13.0"},"serverless":{}}},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"reason":{"type":"string"},"repository":{"type":"string","x-availability":{"stack":{"since":"7.14.0"},"serverless":{}}},"snapshot":{"type":"string"},"shards":{"$ref":"./_types.json#/$defs/_types__ShardStatistics"},"start_time":{"$ref":"./_types.json#/$defs/_types__DateTime"},"start_time_in_millis":{},"state":{"type":"string"},"uuid":{"type":"string"},"version":{"type":"string"},"version_id":{"type":"number"},"feature_states":{"type":"array","items":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__InfoFeatureState"}}},"required":["data_streams","snapshot","uuid"]},"snapshot._types__SnapshotShardFailure":{"type":"object","properties":{"index":{"type":"string"},"node_id":{"type":"string"},"reason":{"type":"string"},"shard_id":{"type":"number"},"index_uuid":{"type":"string"},"status":{"type":"string"}},"required":["index","reason","shard_id","index_uuid","status"]},"snapshot._types__IndexDetails":{"type":"object","properties":{"shard_count":{"type":"number"},"size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"size_in_bytes":{"type":"number"},"max_segments_per_shard":{"type":"number"}},"required":["shard_count","size_in_bytes","max_segments_per_shard"]},"snapshot._types__InfoFeatureState":{"type":"object","properties":{"feature_name":{"type":"string"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices"}},"required":["feature_name","indices"]},"snapshot._types__Repository":{"anyOf":[{"$ref":"./snapshot._types.json#/$defs/snapshot._types__AzureRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__GcsRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__S3Repository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SharedFileSystemRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ReadOnlyUrlRepository"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepository"}]},"snapshot._types__AzureRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"azure","description":"The Azure repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__AzureRepositorySettings","description":"The repository settings."}},"required":["type"]},"snapshot._types__AzureRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"base_path":{"type":"string","description":"The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the Azure repository client to use."},"container":{"type":"string","description":"The Azure container."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API."},"location_mode":{"type":"string","description":"Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`."},"max_concurrent_batch_deletes":{"type":"number","description":"The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}}},"snapshot._types__GcsRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"gcs","description":"The Google Cloud Storage repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__GcsRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__GcsRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"bucket":{"type":"string","description":"The name of the bucket to be used for snapshots."},"application_name":{"type":"string","description":"The name used by the client when it uses the Google Cloud Storage service.","x-deprecated":{"since":"6.3.0"}},"base_path":{"type":"string","description":"The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the client to use to connect to Google Cloud Storage."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["bucket"]},"snapshot._types__S3Repository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"s3","description":"The S3 repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__S3RepositorySettings","description":"The repository settings.\n\nNOTE: In addition to the specified settings, you can also use all non-secure client settings in the repository settings.\nIn this case, the client settings found in the repository settings will be merged with those of the named client used by the repository.\nConflicts between client and repository settings are resolved by the repository settings taking precedence over client settings."}},"required":["type","settings"]},"snapshot._types__S3RepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"bucket":{"type":"string","description":"The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules."},"base_path":{"type":"string","description":"The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket."},"buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller."},"canned_acl":{"type":"string","description":"The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects."},"client":{"type":"string","description":"The name of the S3 client to use to connect to S3."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the  AWS DeleteObjects API."},"get_register_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait before trying again if an attempt to read a linearizable register fails."},"max_multipart_parts":{"type":"number","description":"The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3."},"max_multipart_upload_cleanup_size":{"type":"number","description":"The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads."},"readonly":{"type":"boolean","description":"If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."},"server_side_encryption":{"type":"boolean","description":"When set to `true`, files are encrypted on server side using an AES256 algorithm."},"storage_class":{"type":"string","description":"The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`."},"throttled_delete_retry.delay_increment":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms."},"throttled_delete_retry.maximum_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms."},"throttled_delete_retry.maximum_number_of_retries":{"type":"number","description":"The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries."}},"required":["bucket"]},"snapshot._types__SharedFileSystemRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"fs","description":"The shared file system repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SharedFileSystemRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__SharedFileSystemRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"location":{"type":"string","description":"The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["location"]},"snapshot._types__ReadOnlyUrlRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"url","description":"The read-only URL repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ReadOnlyUrlRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__ReadOnlyUrlRepositorySettings":{"type":"object","properties":{"chunk_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"Big files can be broken down into multiple smaller blobs in the blob store during snapshotting.\nIt is not recommended to change this value from its default unless there is an explicit reason for limiting the size of blobs in the repository.\nSetting a value lower than the default can result in an increased number of API calls to the blob store during snapshot create and restore operations compared to using the default value and thus make both operations slower and more costly.\nSpecify the chunk size as a byte unit, for example: `10MB`, `5KB`, 500B.\nThe default varies by repository type."},"compress":{"type":"boolean","description":"When set to `true`, metadata files are stored in compressed format.\nThis setting doesn't affect index files that are already compressed by default."},"max_restore_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot restore rate per node.\nIt defaults to unlimited.\nNote that restores are also throttled through recovery settings."},"max_snapshot_bytes_per_sec":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The maximum snapshot creation rate per node.\nIt defaults to 40mb per second.\nNote that if the recovery settings for managed services are set, then it defaults to unlimited, and the rate is additionally throttled through recovery settings."},"http_max_retries":{"type":"number","description":"The maximum number of retries for HTTP and HTTPS URLs."},"http_socket_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum wait time for data transfers over a connection."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"url":{"type":"string","description":"The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting."}},"required":["url"]},"snapshot._types__SourceOnlyRepository":{"type":"object","properties":{"uuid":{"type":"string"},"type":{"const":"source","description":"The source-only repository type."},"settings":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettings","description":"The repository settings."}},"required":["type","settings"]},"snapshot._types__SourceOnlyRepositorySettings":{"anyOf":[{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForSharedFileSystem"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForReadOnlyUrl"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForAzure"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForGcs"},{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SourceOnlyRepositorySettingsForS3"}],"description":"The delegated repository type.\nSource repositories can use `settings` properties for its delegated repository type."},"snapshot._types__SourceOnlyRepositorySettingsForSharedFileSystem":{"type":"object","properties":{"delegate_type":{"const":"fs"},"location":{"type":"string","description":"The location of the shared filesystem used to store and retrieve snapshots.\nThis location must be registered in the `path.repo` setting on all master and data nodes in the cluster.\nUnlike `path.repo`, this setting supports only a single file path."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["delegate_type","location"]},"snapshot._types__SourceOnlyRepositorySettingsForReadOnlyUrl":{"type":"object","properties":{"delegate_type":{"const":"url"},"http_max_retries":{"type":"number","description":"The maximum number of retries for HTTP and HTTPS URLs."},"http_socket_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The maximum wait time for data transfers over a connection."},"max_number_of_snapshots":{"type":"number","description":"The maximum number of snapshots the repository can contain.\nThe default is `Integer.MAX_VALUE`, which is 2^31-1 or `2147483647`."},"url":{"type":"string","description":"The URL location of the root of the shared filesystem repository.\nThe following protocols are supported:\n\n* `file`\n* `ftp`\n* `http`\n* `https`\n* `jar`\n\nURLs using the HTTP, HTTPS, or FTP protocols must be explicitly allowed with the `repositories.url.allowed_urls` cluster setting.\nThis setting supports wildcards in the place of a host, path, query, or fragment in the URL.\n\nURLs using the file protocol must point to the location of a shared filesystem accessible to all master and data nodes in the cluster.\nThis location must be registered in the `path.repo` setting.\nYou don't need to register URLs using the FTP, HTTP, HTTPS, or JAR protocols in the `path.repo` setting."}},"required":["delegate_type","url"]},"snapshot._types__SourceOnlyRepositorySettingsForAzure":{"type":"object","properties":{"delegate_type":{"const":"azure"},"base_path":{"type":"string","description":"The path to the repository data within the container.\nIt defaults to the root directory.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the Azure repository client to use."},"container":{"type":"string","description":"The Azure container."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 256, used for `BlobBatch` requests.\nDefaults to 256 which is the maximum number supported by the Azure blob batch API."},"location_mode":{"type":"string","description":"Either `primary_only` or `secondary_only`.\nNote that if you set it to `secondary_only`, it will force `readonly` to `true`."},"max_concurrent_batch_deletes":{"type":"number","description":"The maximum number of concurrent batch delete requests that will be submitted for any individual bulk delete with `BlobBatch`.\nNote that the effective number of concurrent deletes is further limited by the Azure client connection and event loop thread limits.\nDefaults to 10, minimum is 1, maximum is 100."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["delegate_type"]},"snapshot._types__SourceOnlyRepositorySettingsForGcs":{"type":"object","properties":{"delegate_type":{"const":"gcs"},"bucket":{"type":"string","description":"The name of the bucket to be used for snapshots."},"application_name":{"type":"string","description":"The name used by the client when it uses the Google Cloud Storage service.","x-deprecated":{"since":"6.3.0"}},"base_path":{"type":"string","description":"The path to the repository data within the bucket.\nIt defaults to the root of the bucket.\n\nNOTE: Don't set `base_path` when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments can share the same bucket."},"client":{"type":"string","description":"The name of the client to use to connect to Google Cloud Storage."},"readonly":{"type":"boolean","description":"If `true`, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."}},"required":["delegate_type","bucket"]},"snapshot._types__SourceOnlyRepositorySettingsForS3":{"type":"object","properties":{"delegate_type":{"const":"s3"},"bucket":{"type":"string","description":"The name of the S3 bucket to use for snapshots.\nThe bucket name must adhere to Amazon's S3 bucket naming rules."},"base_path":{"type":"string","description":"The path to the repository data within its bucket.\nIt defaults to an empty string, meaning that the repository is at the root of the bucket.\nThe value of this setting should not start or end with a forward slash (`/`).\n\nNOTE: Don't set base_path when configuring a snapshot repository for Elastic Cloud Enterprise.\nElastic Cloud Enterprise automatically generates the `base_path` for each deployment so that multiple deployments may share the same bucket."},"buffer_size":{"$ref":"./_types.json#/$defs/_types__ByteSize","description":"The minimum threshold below which the chunk is uploaded using a single request.\nBeyond this threshold, the S3 repository will use the AWS Multipart Upload API to split the chunk into several parts, each of `buffer_size` length, and to upload each part in its own request.\nNote that setting a buffer size lower than 5mb is not allowed since it will prevent the use of the Multipart API and may result in upload errors.\nIt is also not possible to set a buffer size greater than 5gb as it is the maximum upload size allowed by S3.\nDefaults to `100mb` or 5% of JVM heap, whichever is smaller."},"canned_acl":{"type":"string","description":"The S3 repository supports all S3 canned ACLs: `private`, `public-read`, `public-read-write`, `authenticated-read`, `log-delivery-write`, `bucket-owner-read`, `bucket-owner-full-control`.\nYou could specify a canned ACL using the `canned_acl` setting.\nWhen the S3 repository creates buckets and objects, it adds the canned ACL into the buckets and objects."},"client":{"type":"string","description":"The name of the S3 client to use to connect to S3."},"delete_objects_max_size":{"type":"number","description":"The maxmimum batch size, between 1 and 1000, used for `DeleteObjects` requests.\nDefaults to 1000 which is the maximum number supported by the  AWS DeleteObjects API."},"get_register_retry_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The time to wait before trying again if an attempt to read a linearizable register fails."},"max_multipart_parts":{"type":"number","description":"The maximum number of parts that Elasticsearch will write during a multipart upload of a single object.\nFiles which are larger than `buffer_size × max_multipart_parts` will be chunked into several smaller objects.\nElasticsearch may also split a file across multiple objects to satisfy other constraints such as the `chunk_size` limit.\nDefaults to `10000` which is the maximum number of parts in a multipart upload in AWS S3."},"max_multipart_upload_cleanup_size":{"type":"number","description":"The maximum number of possibly-dangling multipart uploads to clean up in each batch of snapshot deletions.\nDefaults to 1000 which is the maximum number supported by the AWS ListMultipartUploads API.\nIf set to `0`, Elasticsearch will not attempt to clean up dangling multipart uploads."},"readonly":{"type":"boolean","description":"If true, the repository is read-only.\nThe cluster can retrieve and restore snapshots from the repository but not write to the repository or create snapshots in it.\n\nOnly a cluster with write access can create snapshots in the repository.\nAll other clusters connected to the repository should have the `readonly` parameter set to `true`.\n\nIf `false`, the cluster can write to the repository and create snapshots in it.\n\nIMPORTANT: If you register the same snapshot repository with multiple clusters, only one cluster should have write access to the repository.\nHaving multiple clusters write to the repository at the same time risks corrupting the contents of the repository."},"server_side_encryption":{"type":"boolean","description":"When set to `true`, files are encrypted on server side using an AES256 algorithm."},"storage_class":{"type":"string","description":"The S3 storage class for objects written to the repository.\nValues may be `standard`, `reduced_redundancy`, `standard_ia`, `onezone_ia`, and `intelligent_tiering`."},"throttled_delete_retry.delay_increment":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The delay before the first retry and the amount the delay is incremented by on each subsequent retry.\nThe default is 50ms and the minimum is 0ms."},"throttled_delete_retry.maximum_delay":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The upper bound on how long the delays between retries will grow to.\nThe default is 5s and the minimum is 0ms."},"throttled_delete_retry.maximum_number_of_retries":{"type":"number","description":"The number times to retry a throttled snapshot deletion.\nThe default is 10 and the minimum value is 0 which will disable retries altogether.\nNote that if retries are enabled in the Azure client, each of these retries comprises that many client-level retries."}},"required":["delegate_type","bucket"]},"snapshot._types__SnapshotSort":{"enum":["start_time","duration","name","index_count","repository","shard_count","failed_shard_count"]},"snapshot._types__SnapshotState":{"enum":["IN_PROGRESS","SUCCESS","FAILED","PARTIAL","INCOMPATIBLE"]},"snapshot._types__Status":{"type":"object","properties":{"include_global_state":{"type":"boolean","description":"Indicates whether the current cluster state is included in the snapshot."},"indices":{"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotIndexStats"}},"repository":{"type":"string","description":"The name of the repository that includes the snapshot."},"shards_stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStats","description":"Statistics for the shards in the snapshot."},"snapshot":{"type":"string","description":"The name of the snapshot."},"state":{"type":"string","description":"The current snapshot state:\n\n* `STARTED`: The snapshot is currently running.\n* `SUCCESS`: All shard snapshots have completed. The snapshot may or may not have completed finalization.\n* `FAILED`: The snapshot finished with an error and failed to store any data."},"stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotStats","description":"Details about the number (`file_count`) and size (`size_in_bytes`) of files included in the snapshot."},"uuid":{"type":"string","description":"The universally unique identifier (UUID) for the snapshot."}},"required":["include_global_state","indices","repository","shards_stats","snapshot","state","stats","uuid"]},"snapshot._types__SnapshotIndexStats":{"type":"object","properties":{"shards":{"type":"object","additionalProperties":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotShardsStatus"}},"shards_stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStats"},"stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotStats"}},"required":["shards","shards_stats","stats"]},"snapshot._types__SnapshotShardsStatus":{"type":"object","properties":{"stage":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsStage"},"stats":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsSummary"}},"required":["stage","stats"]},"snapshot._types__ShardsStatsStage":{"enum":["DONE","FAILURE","FINALIZE","INIT","STARTED"]},"snapshot._types__ShardsStatsSummary":{"type":"object","properties":{"incremental":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsSummaryItem"},"total":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__ShardsStatsSummaryItem"},"start_time_in_millis":{},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_millis":{}},"required":["incremental","total","start_time_in_millis","time_in_millis"]},"snapshot._types__ShardsStatsSummaryItem":{"type":"object","properties":{"file_count":{"type":"number"},"size_in_bytes":{"type":"number"}},"required":["file_count","size_in_bytes"]},"snapshot._types__ShardsStats":{"type":"object","properties":{"done":{"type":"number","description":"The number of shards that initialized, started, and finalized successfully."},"failed":{"type":"number","description":"The number of shards that failed to be included in the snapshot."},"finalizing":{"type":"number","description":"The number of shards that are finalizing but are not done."},"initializing":{"type":"number","description":"The number of shards that are still initializing."},"started":{"type":"number","description":"The number of shards that have started but are not finalized."},"total":{"type":"number","description":"The total number of shards included in the snapshot."}},"required":["done","failed","finalizing","initializing","started","total"]},"snapshot._types__SnapshotStats":{"type":"object","properties":{"incremental":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__FileCountSnapshotStats","description":"The number and size of files that still need to be copied as part of the incremental snapshot.\nFor completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot."},"start_time_in_millis":{"description":"The time, in milliseconds, when the snapshot creation process started."},"time":{"$ref":"./_types.json#/$defs/_types__Duration"},"time_in_millis":{"description":"The total time, in milliseconds, that it took for the snapshot process to complete."},"total":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__FileCountSnapshotStats","description":"The total number and size of files that are referenced by the snapshot."}},"required":["incremental","start_time_in_millis","time_in_millis","total"]},"snapshot._types__FileCountSnapshotStats":{"type":"object","properties":{"file_count":{"type":"number"},"size_in_bytes":{"type":"number"}},"required":["file_count","size_in_bytes"]}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.cleanup_repository","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to 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 clean up.","x-found-in":"path"}},"required":["repository"],"description":"Clean up the snapshot repository.\n\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.cleanup_repository","description":"Clean up the snapshot repository.\n\nTrigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots.","x-api":{"id":"snapshot.cleanup_repository","name":"cleanup-repository","namespace":"snapshot"},"x-method":"POST","x-path":"/_snapshot/{repository}/_cleanup","x-urls":[{"path":"/_snapshot/{repository}/_cleanup","methods":["POST"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.4.0","stability":"stable"},"serverless":{"stability":"stable","visibility":"private"}},"type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to 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 clean up.","x-found-in":"path"}},"required":["repository"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.cleanup_repository","type":"object","properties":{"results":{"$ref":"./snapshot.cleanup_repository.json#/$defs/snapshot.cleanup_repository__CleanupRepositoryResults","description":"Statistics for cleanup operations."}},"required":["results"]}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.cleanup_repository","x-api":{"id":"snapshot.cleanup_repository","name":"cleanup-repository","namespace":"snapshot"},"type":"object","properties":{"results":{"$ref":"./snapshot.cleanup_repository.json#/$defs/snapshot.cleanup_repository__CleanupRepositoryResults","description":"Statistics for cleanup operations."}},"required":["results"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.clone","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"},"indices":{"type":"string","description":"A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the snapshot repository that both source and target snapshot belong to.","x-found-in":"path"},"snapshot":{"type":"string","description":"The source snapshot name.","x-found-in":"path"},"target_snapshot":{"type":"string","description":"The target snapshot name.","x-found-in":"path"}},"required":["repository","snapshot","target_snapshot","indices"],"description":"Clone a snapshot.\n\nClone part of all of a snapshot into another snapshot in the same repository."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.clone","description":"Clone a snapshot.\n\nClone part of all of a snapshot into another snapshot in the same repository.","x-api":{"id":"snapshot.clone","name":"clone","namespace":"snapshot"},"x-method":"PUT","x-path":"/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}/_clone/{target_snapshot}","methods":["PUT"]}],"x-destructive":true,"x-availability":{"stack":{"since":"7.10.0","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"},"indices":{"type":"string","description":"A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the snapshot repository that both source and target snapshot belong to.","x-found-in":"path"},"snapshot":{"type":"string","description":"The source snapshot name.","x-found-in":"path"},"target_snapshot":{"type":"string","description":"The target snapshot name.","x-found-in":"path"}},"required":["repository","snapshot","target_snapshot","indices"]}

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.create","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"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request returns a response when the snapshot is complete.\nIf `false`, the request returns a response when the snapshot initializes.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Determines how wildcard patterns in the `indices` parameter match data streams and indices.\nIt supports comma-separated values such as `open,hidden`.","x-found-in":"body"},"feature_states":{"type":"array","items":{"type":"string"},"description":"The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).","x-found-in":"body"},"ignore_unavailable":{"type":"boolean","description":"If `true`, the request ignores data streams and indices in `indices` that are missing or closed.\nIf `false`, the request returns an error for any data stream or index that is missing or closed.","x-found-in":"body"},"include_global_state":{"type":"boolean","description":"If `true`, the current cluster state is included in the snapshot.\nThe cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.\nIt also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).","x-found-in":"body"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.","x-found-in":"body"},"partial":{"type":"boolean","description":"If `true`, allows the snapshot to proceed even if some of the target shards are unavailable.\nIn this case, the resulting snapshot will not contain snapshots of the unavailable target shards, and will report its state as `PARTIAL`.\nAdditionally, if `true`, allows index metadata operations such as deletions while the snapshot is in progress.\nThis is almost always preferable to failing the snapshot completely when a single shard is unavailable, and blocking index metadata operations.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available, and index metadata operations such as deletions will be forbidden until the snapshot completes.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository for the snapshot.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot.\nIt supportes date math.\nIt must be unique in the repository.","x-found-in":"path"}},"required":["repository","snapshot"],"description":"Create a snapshot.\n\nTake a snapshot of a cluster or of data streams and indices."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.create","description":"Create a snapshot.\n\nTake a snapshot of a cluster or of data streams and indices.","x-api":{"id":"snapshot.create","name":"create","namespace":"snapshot"},"x-method":"PUT","x-path":"/_snapshot/{repository}/{snapshot}","x-urls":[{"path":"/_snapshot/{repository}/{snapshot}","methods":["PUT","POST"]}],"x-destructive":false,"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 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"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request returns a response when the snapshot is complete.\nIf `false`, the request returns a response when the snapshot initializes.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Determines how wildcard patterns in the `indices` parameter match data streams and indices.\nIt supports comma-separated values such as `open,hidden`.","x-found-in":"body"},"feature_states":{"type":"array","items":{"type":"string"},"description":"The feature states to include in the snapshot.\nEach feature state includes one or more system indices containing related data.\nYou can view a list of eligible features using the get features API.\n\nIf `include_global_state` is `true`, all current feature states are included by default.\nIf `include_global_state` is `false`, no feature states are included by default.\n\nNote that specifying an empty array will result in the default behavior.\nTo exclude all feature states, regardless of the `include_global_state` value, specify an array with only the value `none` (`[\"none\"]`).","x-found-in":"body"},"ignore_unavailable":{"type":"boolean","description":"If `true`, the request ignores data streams and indices in `indices` that are missing or closed.\nIf `false`, the request returns an error for any data stream or index that is missing or closed.","x-found-in":"body"},"include_global_state":{"type":"boolean","description":"If `true`, the current cluster state is included in the snapshot.\nThe cluster state includes persistent cluster settings, composable index templates, legacy index templates, ingest pipelines, and ILM policies.\nIt also includes data stored in system indices, such as Watches and task records (configurable via `feature_states`).","x-found-in":"body"},"indices":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams and indices to include in the snapshot.\nIt supports a multi-target syntax.\nThe default is an empty array (`[]`), which includes all regular data streams and regular indices.\nTo exclude all data streams and indices, use `-*`.\n\nYou can't use this parameter to include or exclude system indices or system data streams from a snapshot.\nUse `feature_states` instead.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata to the snapshot, such as a record of who took the snapshot, why it was taken, or any other useful data.\nIt can have any contents but it must be less than 1024 bytes.\nThis information is not automatically generated by Elasticsearch.","x-found-in":"body"},"partial":{"type":"boolean","description":"If `true`, allows the snapshot to proceed even if some of the target shards are unavailable.\nIn this case, the resulting snapshot will not contain snapshots of the unavailable target shards, and will report its state as `PARTIAL`.\nAdditionally, if `true`, allows index metadata operations such as deletions while the snapshot is in progress.\nThis is almost always preferable to failing the snapshot completely when a single shard is unavailable, and blocking index metadata operations.\n\nIf `false`, the entire restore operation will fail if one or more indices included in the snapshot do not have all primary shards available, and index metadata operations such as deletions will be forbidden until the snapshot completes.","x-found-in":"body"},"repository":{"type":"string","description":"The name of the repository for the snapshot.","x-found-in":"path"},"snapshot":{"type":"string","description":"The name of the snapshot.\nIt supportes date math.\nIt must be unique in the repository.","x-found-in":"path"}},"required":["repository","snapshot"]}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.create","type":"object","properties":{"accepted":{"type":"boolean","description":"Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`"},"snapshot":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotInfo","description":"Snapshot information. Present when the request had `wait_for_completion` set to `true`"}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.create","x-api":{"id":"snapshot.create","name":"create","namespace":"snapshot"},"type":"object","properties":{"accepted":{"type":"boolean","description":"Equals `true` if the snapshot was accepted. Present when the request had `wait_for_completion` set to `false`","x-availability":{"stack":{"since":"7.15.0"},"serverless":{}}},"snapshot":{"$ref":"./snapshot._types.json#/$defs/snapshot._types__SnapshotInfo","description":"Snapshot information. Present when the request had `wait_for_completion` set to `true`"}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.create_repository","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.\nIf no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"verify":{"type":"boolean","description":"If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.\nIf `false`, this verification is skipped.\nYou can also perform this verification with the verify snapshot repository API.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the snapshot repository to register or update.","x-found-in":"path"}},"required":["repository"],"description":"Create or update a snapshot repository.\n\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.create_repository","description":"Create or update a snapshot repository.\n\nIMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.\nTo register a snapshot repository, the cluster's global metadata must be writeable.\nEnsure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.\n\nSeveral options for this API can be specified using a query parameter or a request body parameter.\nIf both parameters are specified, only the query parameter is used.","x-api":{"id":"snapshot.create_repository","name":"create-repository","namespace":"snapshot"},"x-method":"PUT","x-path":"/_snapshot/{repository}","x-urls":[{"path":"/_snapshot/{repository}","methods":["PUT","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"},"verify":{"type":"boolean","description":"If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.\nIf `false`, this verification is skipped.\nYou can also perform this verification with the verify snapshot repository API.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the snapshot repository to register or update.","x-found-in":"path"}},"required":["repository"]}

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

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