@elastic/schemas 0.4.3 → 0.4.5

package/src/es/json/security.query_api_keys.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_api_keys__ApiKeyAggregationContainer":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./security.query_api_keys.json#/$defs/security.query_api_keys__ApiKeyAggregationContainer"},"description":"Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations."},"meta":{"$ref":"./_types.json#/$defs/_types__Metadata"},"cardinality":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CardinalityAggregation","description":"A single-value metrics aggregation that calculates an approximate count of distinct values."},"composite":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CompositeAggregation","description":"A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently."},"date_range":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DateRangeAggregation","description":"A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket."},"filter":{"$ref":"./security.query_api_keys.json#/$defs/security.query_api_keys__ApiKeyQueryContainer","description":"A single bucket aggregation that narrows the set of documents to those that match a query."},"filters":{"$ref":"./security.query_api_keys.json#/$defs/security.query_api_keys__ApiKeyFiltersAggregation","description":"A multi-bucket aggregation where each bucket contains the documents that match a query."},"missing":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__MissingAggregation"},"range":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__RangeAggregation","description":"A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket."},"terms":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__TermsAggregation","description":"A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value."},"value_count":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__ValueCountAggregation","description":"A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents."}}},"security.query_api_keys__ApiKeyQueryContainer":{"type":"object","properties":{"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"Matches documents matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns documents that contain an indexed value for a field."},"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"description":"Returns documents 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 documents, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"description":"Returns documents 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 documents that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns documents 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 documents 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 documents 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 documents that contain terms matching a wildcard pattern."}}},"security.query_api_keys__ApiKeyFiltersAggregation":{"type":"object","properties":{"filters":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__Buckets","description":"Collection of queries from which to build buckets."},"other_bucket":{"type":"boolean","description":"Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters."},"other_bucket_key":{"type":"string","description":"The key with which the other bucket is returned."},"keyed":{"type":"boolean","description":"By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects."}}},"security.query_api_keys__ApiKeyAggregate":{"oneOf":[{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CardinalityAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__ValueCountAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__StringTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__LongTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DoubleTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__UnmappedTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__MultiTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__MissingAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__FilterAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__FiltersAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__RangeAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DateRangeAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CompositeAggregate"}]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_api_keys__ApiKeyAggregationContainer":{"type":"object","properties":{"aggregations":{"type":"object","additionalProperties":{"$ref":"./security.query_api_keys.json#/$defs/security.query_api_keys__ApiKeyAggregationContainer"},"description":"Sub-aggregations for this aggregation.\nOnly applies to bucket aggregations."},"meta":{"$ref":"./_types.json#/$defs/_types__Metadata"},"cardinality":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CardinalityAggregation","description":"A single-value metrics aggregation that calculates an approximate count of distinct values."},"composite":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CompositeAggregation","description":"A multi-bucket aggregation that creates composite buckets from different sources.\nUnlike the other multi-bucket aggregations, you can use the `composite` aggregation to paginate *all* buckets from a multi-level aggregation efficiently."},"date_range":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DateRangeAggregation","description":"A multi-bucket value source based aggregation that enables the user to define a set of date ranges - each representing a bucket."},"filter":{"$ref":"./security.query_api_keys.json#/$defs/security.query_api_keys__ApiKeyQueryContainer","description":"A single bucket aggregation that narrows the set of documents to those that match a query."},"filters":{"$ref":"./security.query_api_keys.json#/$defs/security.query_api_keys__ApiKeyFiltersAggregation","description":"A multi-bucket aggregation where each bucket contains the documents that match a query."},"missing":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__MissingAggregation"},"range":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__RangeAggregation","description":"A multi-bucket value source based aggregation that enables the user to define a set of ranges - each representing a bucket."},"terms":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__TermsAggregation","description":"A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value."},"value_count":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__ValueCountAggregation","description":"A single-value metrics aggregation that counts the number of values that are extracted from the aggregated documents."}}},"security.query_api_keys__ApiKeyQueryContainer":{"type":"object","properties":{"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"Matches documents matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns documents that contain an indexed value for a field."},"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns documents based on their IDs.\nThis query uses document IDs stored in the `_id` field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"description":"Returns documents 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 documents, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"description":"Returns documents 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 documents that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns documents 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 documents 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 documents 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 documents that contain terms matching a wildcard pattern."}}},"security.query_api_keys__ApiKeyFiltersAggregation":{"type":"object","properties":{"filters":{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__Buckets","description":"Collection of queries from which to build buckets."},"other_bucket":{"type":"boolean","description":"Set to `true` to add a bucket to the response which will contain all documents that do not match any of the given filters."},"other_bucket_key":{"type":"string","description":"The key with which the other bucket is returned."},"keyed":{"type":"boolean","description":"By default, the named filters aggregation returns the buckets as an object.\nSet to `false` to return the buckets as an array of objects."}}},"security.query_api_keys__ApiKeyAggregate":{"anyOf":[{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CardinalityAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__ValueCountAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__StringTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__LongTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DoubleTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__UnmappedTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__MultiTermsAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__MissingAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__FilterAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__FiltersAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__RangeAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__DateRangeAggregate"},{"$ref":"./_types.aggregations.json#/$defs/_types.aggregations__CompositeAggregate"}]}}}

package/src/es/json/security.query_role.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_role__RoleQueryContainer":{"type":"object","properties":{"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"matches roles matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns roles that contain an indexed value for a field."},"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"description":"Returns roles 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 roles, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"description":"Returns roles 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 roles that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns roles 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 roles 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 roles 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 roles that contain terms matching a wildcard pattern."}}},"security.query_role__QueryRole":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters."},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions."},"global":{"oneOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware."},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults"},"name":{"type":"string","description":"Name of the role."}},"required":["name"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"security.query_role__RoleQueryContainer":{"type":"object","properties":{"bool":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__BoolQuery","description":"matches roles matching boolean combinations of other queries."},"exists":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__ExistsQuery","description":"Returns roles that contain an indexed value for a field."},"ids":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__IdsQuery","description":"Returns roles based on their IDs.\nThis query uses role document IDs stored in the `_id` field."},"match":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__MatchQuery"},"description":"Returns roles 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 roles, giving them all a `_score` of 1.0."},"prefix":{"type":"object","additionalProperties":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__PrefixQuery"},"description":"Returns roles 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 roles that contain terms within a provided range."},"simple_query_string":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__SimpleQueryStringQuery","description":"Returns roles 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 roles 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 roles 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 roles that contain terms matching a wildcard pattern."}}},"security.query_role__QueryRole":{"type":"object","properties":{"cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ClusterPrivilege"},"description":"A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute."},"indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__IndicesPrivileges"},"description":"A list of indices permissions entries."},"remote_indices":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteIndicesPrivileges"},"description":"A list of indices permissions for remote clusters."},"remote_cluster":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__RemoteClusterPrivileges"},"description":"A list of cluster permissions for remote clusters.\nNOTE: This is limited a subset of the cluster permissions."},"global":{"anyOf":[{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}},{"$ref":"./security._types.json#/$defs/security._types__GlobalPrivilege"}],"description":"An object defining global privileges. A global privilege is a form of cluster privilege that is request-aware."},"applications":{"type":"array","items":{"$ref":"./security._types.json#/$defs/security._types__ApplicationPrivileges"},"description":"A list of application privilege entries"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional meta-data. Within the metadata object, keys that begin with `_` are reserved for system usage."},"run_as":{"type":"array","items":{"type":"string"},"description":"A list of users that the API keys can impersonate.\nNOTE: In Elastic Cloud Serverless, the run-as feature is disabled.\nFor API compatibility, you can still specify an empty `run_as` field, but a non-empty list will be rejected."},"description":{"type":"string","description":"Optional description of the role descriptor"},"restriction":{"$ref":"./security._types.json#/$defs/security._types__Restriction","description":"Restriction for when the role descriptor is allowed to be effective."},"transient_metadata":{"type":"object","additionalProperties":{}},"_sort":{"$ref":"./_types.json#/$defs/_types__SortResults"},"name":{"type":"string","description":"Name of the role."}},"required":["name"]}}}

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.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":{"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":"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."}
+{"$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_api_key.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_api_key","type":"object","properties":{"id":{"type":"string","description":"The ID of the API key to update.","x-found-in":"path"},"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.","x-found-in":"body"}},"required":["id"],"description":"Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_api_key","type":"object","properties":{"role_descriptors":{"type":"object","additionalProperties":{"$ref":"./security._types.json#/$defs/security._types__RoleDescriptor"},"description":"The role descriptors to assign to this API key.\nThe API key's effective permissions are an intersection of its assigned privileges and the point in time snapshot of permissions of the owner user.\nYou can assign new privileges by specifying them in this parameter.\nTo remove assigned privileges, you can supply an empty `role_descriptors` parameter, that is to say, an empty object `{}`.\nIf an API key has no assigned privileges, it inherits the owner user's full permissions.\nThe snapshot of the owner's permissions is always updated, whether you supply the `role_descriptors` parameter or not.\nThe structure of a role descriptor is the same as the request for the create API keys API.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the API key.\nIt supports a nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this value fully replaces the metadata previously associated with the API key.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the API key.\nBy default, API keys never expire.\nThis property can be omitted to leave the expiration unchanged.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the API key to update.","x-found-in":"path"}},"required":["id"],"description":"Update an API key.\n\nUpdate attributes of an existing API key.\nThis API supports updates to an API key's access scope, expiration, and metadata.\n\nTo use this API, you must have at least the `manage_own_api_key` cluster privilege.\nUsers can only update API keys that they created or that were granted to them.\nTo update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.\n\nUse this API to update API keys created by the create API key or grant API Key APIs.\nIf you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.\nIt's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.\n\nThe access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request.\nThe snapshot of the owner's permissions is updated automatically on every call.\n\nIMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope.\nThis change can occur if the owner user's permissions have changed since the API key was created or last modified."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_cross_cluster_api_key","type":"object","properties":{"id":{"type":"string","description":"The ID of the cross-cluster API key to update.","x-found-in":"path"},"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access to be granted to this API key.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this information fully replaces metadata previously associated with the API key.","x-found-in":"body"},"certificate_identity":{"type":"string","description":"The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.\nWhen specified, this fully replaces any previously assigned certificate identity.\nTo clear an existing certificate identity, explicitly set this field to `null`.\nWhen omitted, the existing certificate identity remains unchanged.","x-found-in":"body"}},"required":["id","access"],"description":"Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.\n\nTo learn more about how to use this API, refer to the [Update cross cluter API key API examples page](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples)."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"security.update_cross_cluster_api_key","type":"object","properties":{"access":{"$ref":"./security._types.json#/$defs/security._types__Access","description":"The access to be granted to this API key.\nThe access is composed of permissions for cross cluster search and cross cluster replication.\nAt least one of them must be specified.\nWhen specified, the new access assignment fully replaces the previously assigned access.","x-found-in":"body"},"expiration":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The expiration time for the API key.\nBy default, API keys never expire. This property can be omitted to leave the value unchanged.","x-found-in":"body"},"metadata":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Arbitrary metadata that you want to associate with the API key.\nIt supports nested data structure.\nWithin the metadata object, keys beginning with `_` are reserved for system usage.\nWhen specified, this information fully replaces metadata previously associated with the API key.","x-found-in":"body"},"certificate_identity":{"type":"string","description":"The certificate identity to associate with this API key.\nThis field is used to restrict the API key to connections authenticated by a specific TLS certificate.\nThe value should match the certificate's distinguished name (DN) pattern.\nWhen specified, this fully replaces any previously assigned certificate identity.\nTo clear an existing certificate identity, explicitly set this field to `null`.\nWhen omitted, the existing certificate identity remains unchanged.","x-found-in":"body"},"id":{"type":"string","description":"The ID of the cross-cluster API key to update.","x-found-in":"path"}},"required":["id","access"],"description":"Update a cross-cluster API key.\n\nUpdate the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.\n\nTo use this API, you must have at least the `manage_security` cluster privilege.\nUsers can only update API keys that they created.\nTo update another user's API key, use the `run_as` feature to submit a request on behalf of another user.\n\nIMPORTANT: It's not possible to use an API key as the authentication credential for this API.\nTo update an API key, the owner user's credentials are required.\n\nIt's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.\n\nThis API supports updates to an API key's access scope, metadata, and expiration.\nThe owner user's information, such as the `username` and `realm`, is also updated automatically on every call.\n\nNOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.\n\nTo learn more about how to use this API, refer to the [Update cross cluter API key API examples page](https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples)."}

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":{"uid":{"type":"string","description":"A unique identifier for the user profile.","x-found-in":"path"},"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"}},"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":{"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"},"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"}},"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.delete_lifecycle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.delete_lifecycle","type":"object","properties":{"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to remove","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["policy_id"],"description":"Delete a policy.\n\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.delete_lifecycle","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to remove","x-found-in":"path"}},"required":["policy_id"],"description":"Delete a policy.\n\nDelete a snapshot lifecycle policy definition.\nThis operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_lifecycle","type":"object","properties":{"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to be executed","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"required":["policy_id"],"description":"Run a policy.\n\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.execute_lifecycle","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"policy_id":{"type":"string","description":"The id of the snapshot lifecycle policy to be executed","x-found-in":"path"}},"required":["policy_id"],"description":"Run a policy.\n\nImmediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time.\nThe snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_lifecycle","type":"object","properties":{"policy_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot lifecycle policy identifiers.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"}},"description":"Get policy information.\n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"slm.get_lifecycle","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"policy_id":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot lifecycle policy identifiers.","x-found-in":"path"}},"description":"Get policy information.\n\nGet snapshot lifecycle policy definitions and information about the latest snapshot attempts."}

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":{"policy_id":{"type":"string","description":"The identifier for the snapshot lifecycle policy you want to create or update.","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\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"}},"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.cleanup_repository.request.json

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

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

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

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete","type":"object","properties":{"repository":{"type":"string","description":"The name of the repository to delete a snapshot from.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).","x-found-in":"path"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request returns a response when the matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.","x-found-in":"query"}},"required":["repository","snapshot"],"description":"Delete snapshots."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"snapshot.delete","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nTo indicate that the request should never timeout, set it to `-1`.","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"If `true`, the request returns a response when the matching snapshots are all deleted.\nIf `false`, the request returns a response as soon as the deletes are scheduled.","x-found-in":"query"},"repository":{"type":"string","description":"The name of the repository to delete a snapshot from.","x-found-in":"path"},"snapshot":{"$ref":"./_types.json#/$defs/_types__Names","description":"A comma-separated list of snapshot names to delete.\nIt also accepts wildcards (`*`).","x-found-in":"path"}},"required":["repository","snapshot"],"description":"Delete snapshots."}