@elastic/schemas 0.4.4 → 0.5.0

package/src/es/json/security.query_user.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_user__UserQueryContainer":{"type":"object","properties":{"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns users based on their IDs.\nThis query uses the user document IDs stored in the `_id` field."},"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"matches users matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns users that contain an indexed value for a field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"description":"Returns users that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching."},"match_all":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchAllQuery","description":"Matches all users, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"description":"Returns users that contain a specific prefix in a provided field."},"range":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__RangeQuery"},"description":"Returns users that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax."},"term":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermQuery"},"description":"Returns users that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization."},"terms":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermsQuery","description":"Returns users that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization."},"wildcard":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__WildcardQuery"},"description":"Returns users that contain terms matching a wildcard pattern."}}},"security.query_user__QueryUser":{"type":"object","properties":{"email":{"oneOf":[{"type":"string"},{"type":"null"}]},"full_name":{"oneOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults"}},"required":["metadata","roles","username","enabled"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_user__UserQueryContainer":{"type":"object","properties":{"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns users based on their IDs.\nThis query uses the user document IDs stored in the `_id` field."},"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"matches users matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns users that contain an indexed value for a field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"description":"Returns users that match a provided text, number, date or boolean value.\nThe provided text is analyzed before matching."},"match_all":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchAllQuery","description":"Matches all users, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"description":"Returns users that contain a specific prefix in a provided field."},"range":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__RangeQuery"},"description":"Returns users that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns users based on a provided query string, using a parser with a limited but fault-tolerant syntax."},"term":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermQuery"},"description":"Returns users that contain an exact term in a provided field.\nTo return a document, the query term must exactly match the queried field's value, including whitespace and capitalization."},"terms":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__TermsQuery","description":"Returns users that contain one or more exact terms in a provided field.\nTo return a document, one or more terms must exactly match a field value, including whitespace and capitalization."},"wildcard":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__WildcardQuery"},"description":"Returns users that contain terms matching a wildcard pattern."}}},"security.query_user__QueryUser":{"type":"object","properties":{"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"full_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata"},"roles":{"type":"array","items":{"type":"string"}},"username":{"type":"string"},"enabled":{"type":"boolean"},"profile_uid":{"type":"string"},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults"}},"required":["metadata","roles","username","enabled"]}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.query_user","type":"object","properties":{"query":{"$ref":"./security.query_user.json#/$defs/security.query_user__UserQueryContainer","description":"A query to filter which users to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`.","x-found-in":"body"},"from":{"type":"number","description":"The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"The sort definition.\nFields eligible for sorting are: `username`, `roles`, `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.","x-found-in":"body"},"size":{"type":"number","description":"The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.","x-found-in":"body"},"search_after":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"The search after definition","x-found-in":"body"},"with_profile_uid":{"type":"boolean","description":"Determines whether to retrieve the user profile UID, if it exists, for the users.","x-found-in":"query"}},"description":"Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.\n\nNOTE: As opposed to the get user API, built-in users are excluded from the result.\nThis API is only for native users."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.query_user","type":"object","properties":{"with_profile_uid":{"type":"boolean","description":"Determines whether to retrieve the user profile UID, if it exists, for the users.","x-found-in":"query"},"query":{"$ref":"./security.query_user.json#/$defs/security.query_user__UserQueryContainer","description":"A query to filter which users to return.\nIf the query parameter is missing, it is equivalent to a `match_all` query.\nThe query supports a subset of query types, including `match_all`, `bool`, `term`, `terms`, `match`,\n`ids`, `prefix`, `wildcard`, `exists`, `range`, and `simple_query_string`.\nYou can query the following information associated with user: `username`, `roles`, `enabled`, `full_name`, and `email`.","x-found-in":"body"},"from":{"type":"number","description":"The starting document offset.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.","x-found-in":"body"},"sort":{"$ref":"./_types.json#/$defs/_types__Sort","description":"The sort definition.\nFields eligible for sorting are: `username`, `roles`, `enabled`.\nIn addition, sort can also be applied to the `_doc` field to sort by index order.","x-found-in":"body"},"size":{"type":"number","description":"The number of hits to return.\nIt must not be negative.\nBy default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.\nTo page through more hits, use the `search_after` parameter.","x-found-in":"body"},"search_after":{"$ref":"./_types.json#/$defs/_types__SortResults","description":"The search after definition","x-found-in":"body"}},"description":"Find users with a query.\n\nGet information for users in a paginated manner.\nYou can optionally filter the results with a query.\n\nNOTE: As opposed to the get user API, built-in users are excluded from the result.\nThis API is only for native users."}

package/src/es/json/security.suggest_user_profiles.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.suggest_user_profiles__Hint":{"type":"object","properties":{"uids":{"type":"array","items":{"type":"string"},"description":"A list of profile UIDs to match against."},"labels":{"type":"object","additionalProperties":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"description":"A single key-value pair to match against the labels section\nof a profile. A profile is considered matching if it matches\nat least one of the strings."}}},"security.suggest_user_profiles__TotalUserProfiles":{"type":"object","properties":{"value":{"type":"number"},"relation":{"type":"string"}},"required":["value","relation"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.suggest_user_profiles__Hint":{"type":"object","properties":{"uids":{"type":"array","items":{"type":"string"},"description":"A list of profile UIDs to match against."},"labels":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"description":"A single key-value pair to match against the labels section\nof a profile. A profile is considered matching if it matches\nat least one of the strings."}}},"security.suggest_user_profiles__TotalUserProfiles":{"type":"object","properties":{"value":{"type":"number"},"relation":{"type":"string"}},"required":["value","relation"]}}}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.suggest_user_profiles","type":"object","properties":{"name":{"type":"string","description":"A query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.","x-found-in":"body"},"size":{"type":"number","description":"The number of profiles to return.","x-found-in":"body"},"data":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=<key>` to retrieve content nested under the specified `<key>`.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.","x-found-in":"query"},"hint":{"$ref":"./security.suggest_user_profiles.json#/$defs/security.suggest_user_profiles__Hint","description":"Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.","x-found-in":"body"}},"description":"Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\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."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.suggest_user_profiles","type":"object","properties":{"data":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"A comma-separated list of filters for the `data` field of the profile document.\nTo return all content use `data=*`.\nTo return a subset of content, use `data=<key>` to retrieve content nested under the specified `<key>`.\nBy default, the API returns no `data` content.\nIt is an error to specify `data` as both the query parameter and the request body field.","x-found-in":"body"},"name":{"type":"string","description":"A query string used to match name-related fields in user profile documents.\nName-related fields are the user's `username`, `full_name`, and `email`.","x-found-in":"body"},"size":{"type":"number","description":"The number of profiles to return.","x-found-in":"body"},"hint":{"$ref":"./security.suggest_user_profiles.json#/$defs/security.suggest_user_profiles__Hint","description":"Extra search criteria to improve relevance of the suggestion result.\nProfiles matching the spcified hint are ranked higher in the response.\nProfiles not matching the hint aren't excluded from the response as long as the profile matches the `name` field query.","x-found-in":"body"}},"description":"Suggest a user profile.\n\nGet suggestions for user profiles that match specified search criteria.\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."}

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":{"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"},"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":"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","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."}

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":{"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"},"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"},"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","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."}

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":{"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"},"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"},"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","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."}

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":{"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"},"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"},"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","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."}

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__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__Repository":{"oneOf":[{"$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":{"oneOf":[{"$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__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"}},"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"]}}}

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":{"indices":{"type":"string","description":"A comma-separated list of indices to include in the snapshot.\nMulti-target syntax is supported.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"repository":{"type":"string","description":"The 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","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."}

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":{"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"},"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"},"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","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."}

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

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

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

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

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

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

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

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

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

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

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

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