@elastic/schemas 0.4.4 → 0.5.0

package/src/es/json/indices._types.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices._types__IndexSettings":{"type":"object","additionalProperties":{}},"indices._types__DataStreamLifecycleWithRollover":{"type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"effective_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The least amount of time data should be kept by elasticsearch."},"retention_determined_by":{"$ref":"./indices._types.json#/$defs/indices._types__RetentionSource","description":"Configuration source that can influence the retention of a data stream."},"downsampling":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DownsamplingRound"},"description":"The list of downsampling rounds to execute as part of this downsampling configuration"},"downsampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."},"frozen_after":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots.\nThis field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles."},"rollover":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycleRolloverConditions","description":"The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change."}},"description":"Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked."},"indices._types__RetentionSource":{"enum":["data_stream_configuration","default_global_retention","max_global_retention","default_failures_retention"]},"indices._types__DownsamplingRound":{"type":"object","properties":{"after":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The duration since rollover when this downsampling round should execute"},"fixed_interval":{"type":"string","description":"The downsample interval."}},"required":["after","fixed_interval"]},"indices._types__SamplingMethod":{"enum":["aggregate","last_value"]},"indices._types__DataStreamLifecycleRolloverConditions":{"type":"object","properties":{"min_age":{"$ref":"./_types.json#/$defs/_types__Duration"},"max_age":{"type":"string"},"min_docs":{"type":"number"},"max_docs":{"type":"number"},"min_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"max_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"min_primary_shard_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"max_primary_shard_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"min_primary_shard_docs":{"type":"number"},"max_primary_shard_docs":{"type":"number"}}},"indices._types__NumericFielddata":{"type":"object","properties":{"format":{"$ref":"./indices._types.json#/$defs/indices._types__NumericFielddataFormat"}},"required":["format"]},"indices._types__NumericFielddataFormat":{"enum":["array","disabled"]},"indices._types__FielddataFrequencyFilter":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"min_segment_size":{"type":"number"}},"required":["max","min","min_segment_size"]},"indices._types__AliasDefinition":{"type":"object","properties":{"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access."},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations."},"is_write_index":{"type":"boolean","description":"If `true`, the index is the write index for the alias."},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard."},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations."},"is_hidden":{"type":"boolean","description":"If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value."}}},"indices._types__DataStreamOptions":{"type":"object","properties":{"failure_store":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamFailureStore","description":"If defined, it specifies configuration for the failure store of this data stream."}},"description":"Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration."},"indices._types__DataStreamFailureStore":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__FailureStoreLifecycle","description":"If defined, it specifies the lifecycle configuration for the failure store of this data stream."}},"description":"Data stream failure store contains the configuration of the failure store for a given data stream."},"indices._types__FailureStoreLifecycle":{"type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."}},"description":"The failure store lifecycle configures the data stream lifecycle configuration for failure indices."},"indices._types__Alias":{"type":"object","properties":{"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access."},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations."},"is_hidden":{"type":"boolean","description":"If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value."},"is_write_index":{"type":"boolean","description":"If `true`, the index is the write index for the alias."},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard."},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations."}}},"indices._types__DataStreamLifecycle":{"type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"effective_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The least amount of time data should be kept by elasticsearch."},"retention_determined_by":{"$ref":"./indices._types.json#/$defs/indices._types__RetentionSource","description":"Configuration source that can influence the retention of a data stream."},"downsampling":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DownsamplingRound"},"description":"The list of downsampling rounds to execute as part of this downsampling configuration"},"downsampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."},"frozen_after":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots.\nThis field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles."}},"description":"Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration."},"indices._types__DataStreamOptionsTemplate":{"type":"object","properties":{"failure_store":{"oneOf":[{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamFailureStoreTemplate"},{"type":"null"}]}},"description":"Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null."},"indices._types__DataStreamFailureStoreTemplate":{"type":"object","properties":{"enabled":{"oneOf":[{"type":"boolean"},{"type":"null"}],"description":"If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store."},"lifecycle":{"oneOf":[{"$ref":"./indices._types.json#/$defs/indices._types__FailureStoreLifecycleTemplate"},{"type":"null"}],"description":"If defined, it specifies the lifecycle configuration for the failure store of this data stream."}},"description":"Template equivalent of DataStreamFailureStore that allows nullable values."},"indices._types__FailureStoreLifecycleTemplate":{"type":"object","properties":{"data_retention":{"oneOf":[{"$ref":"./_types.json#/$defs/_types__Duration"},{"type":"null"}],"description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."}},"description":"Template equivalent of FailureStoreLifecycle that allows nullable values."},"indices._types__IndicesBlockOptions":{"enum":["metadata","read","read_only","write"]},"indices._types__IndexState":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"}},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"},"defaults":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Default settings, included when the request's `include_default` is `true`."},"data_stream":{"type":"string"},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycle","description":"Data stream lifecycle applicable if this is a data stream."}}},"indices._types__DataStream":{"type":"object","properties":{"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property."},"allow_custom_routing":{"type":"boolean","description":"If `true`, the data stream allows custom routing on write request."},"failure_store":{"$ref":"./indices._types.json#/$defs/indices._types__FailureStore","description":"Information about failure store backing indices"},"generation":{"type":"number","description":"Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1."},"hidden":{"type":"boolean","description":"If `true`, the data stream is hidden."},"ilm_policy":{"type":"string","description":"Name of the current ILM lifecycle policy in the stream’s matching index template.\nThis lifecycle policy is set in the `index.lifecycle.name` setting.\nIf the template does not include a lifecycle policy, this property is not included in the response.\nNOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API."},"next_generation_managed_by":{"$ref":"./indices._types.json#/$defs/indices._types__ManagedBy","description":"Name of the lifecycle system that'll manage the next generation of the data stream."},"prefer_ilm":{"type":"boolean","description":"Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream."},"indices":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamIndex"},"description":"Array of objects containing information about the data stream’s backing indices.\nThe last item in this array contains information about the stream’s current write index."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycleWithRollover","description":"Contains the configuration for the data stream lifecycle of this data stream."},"name":{"type":"string","description":"Name of the data stream."},"replicated":{"type":"boolean","description":"If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings."},"rollover_on_write":{"type":"boolean","description":"If `true`, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"The settings specific to this data stream that will take precedence over the settings in the matching index\ntemplate."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"The mappings specific to this data stream that will take precedence over the mappings in the matching index\ntemplate."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Health status of the data stream.\nThis health status is based on the state of the primary and replica shards of the stream’s backing indices."},"system":{"type":"boolean","description":"If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction."},"template":{"type":"string","description":"Name of the index template used to create the data stream’s backing indices.\nThe template’s index pattern must match the name of this data stream."},"timestamp_field":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamTimestampField","description":"Information about the `@timestamp` field in the data stream."},"index_mode":{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode","description":"The index mode for the data stream that will be used for newly created backing indices."}},"required":["generation","hidden","next_generation_managed_by","prefer_ilm","indices","name","rollover_on_write","settings","status","template","timestamp_field"]},"indices._types__FailureStore":{"type":"object","properties":{"enabled":{"type":"boolean"},"indices":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamIndex"}},"rollover_on_write":{"type":"boolean"}},"required":["enabled","indices","rollover_on_write"]},"indices._types__DataStreamIndex":{"type":"object","properties":{"index_name":{"type":"string","description":"Name of the backing index."},"index_uuid":{"type":"string","description":"Universally unique identifier (UUID) for the index."},"ilm_policy":{"type":"string","description":"Name of the current ILM lifecycle policy configured for this backing index."},"managed_by":{"$ref":"./indices._types.json#/$defs/indices._types__ManagedBy","description":"Name of the lifecycle system that's currently managing this backing index."},"prefer_ilm":{"type":"boolean","description":"Indicates if ILM should take precedence over DSL in case both are configured to manage this index."},"index_mode":{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode","description":"The index mode of this backing index of the data stream."}},"required":["index_name","index_uuid"]},"indices._types__ManagedBy":{"enum":["ilm","datastream","unmanaged"]},"indices._types__IndexMode":{"enum":["standard","time_series","logsdb","lookup"]},"indices._types__DataStreamTimestampField":{"type":"object","properties":{"name":{"type":"string","description":"Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream."}},"required":["name"]},"indices._types__IndexTemplateWithRollover":{"type":"object","properties":{"template":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateSummaryWithRollover","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration."},"index_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation."},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence."},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch."},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch."},"allow_auto_create":{"type":"boolean"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateDataStreamConfiguration","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object."},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning."},"ignore_missing_component_templates":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of component template names that are allowed to be absent."},"created_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was created. Only returned if the `human` query parameter is `true`."},"created_date_millis":{"description":"Date and time when the index template was created, in milliseconds since the epoch."},"modified_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`."},"modified_date_millis":{"description":"Date and time when the index template was last modified, in milliseconds since the epoch."}},"required":["index_patterns","composed_of"]},"indices._types__IndexTemplateSummaryWithRollover":{"type":"object","properties":{"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycleWithRollover"},"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index."},"data_stream_options":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamOptions"}}},"indices._types__IndexTemplateDataStreamConfiguration":{"type":"object","properties":{"hidden":{"type":"boolean","description":"If true, the data stream is hidden."},"allow_custom_routing":{"type":"boolean","description":"If true, the data stream supports custom routing."}}},"indices._types__TemplateMapping":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"}},"index_patterns":{"type":"array","items":{"type":"string"}},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"order":{"type":"number"},"settings":{"type":"object","additionalProperties":{}},"version":{"type":"number"}},"required":["aliases","index_patterns","mappings","order","settings"]},"indices._types__DataStreamVisibility":{"type":"object","properties":{"hidden":{"type":"boolean"},"allow_custom_routing":{"type":"boolean"},"failure_store":{"type":"boolean"}}},"indices._types__IndexRouting":{"type":"object","properties":{"allocation":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocation"},"rebalance":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingRebalance"}}},"indices._types__IndexRoutingAllocation":{"type":"object","properties":{"enable":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationOptions"},"include":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationInclude"},"initial_recovery":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationInitialRecovery"},"disk":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationDisk"}}},"indices._types__IndexRoutingAllocationOptions":{"enum":["all","primaries","new_primaries","none"]},"indices._types__IndexRoutingAllocationInclude":{"type":"object","properties":{"_tier_preference":{"type":"string"},"_id":{"type":"string"}}},"indices._types__IndexRoutingAllocationInitialRecovery":{"type":"object","properties":{"_id":{"type":"string"}}},"indices._types__IndexRoutingAllocationDisk":{"type":"object","properties":{"threshold_enabled":{"oneOf":[{"type":"boolean"},{"type":"string"}]}}},"indices._types__IndexRoutingRebalance":{"type":"object","properties":{"enable":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingRebalanceOptions"}},"required":["enable"]},"indices._types__IndexRoutingRebalanceOptions":{"enum":["all","primaries","replicas","none"]},"indices._types__IndexTemplate":{"type":"object","properties":{"index_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation."},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence."},"template":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateSummary","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration."},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch."},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch."},"allow_auto_create":{"type":"boolean"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateDataStreamConfiguration","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object."},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning."},"ignore_missing_component_templates":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of component template names that are allowed to be absent."},"created_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was created. Only returned if the `human` query parameter is `true`."},"created_date_millis":{"description":"Date and time when the index template was created, in milliseconds since the epoch."},"modified_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`."},"modified_date_millis":{"description":"Date and time when the index template was last modified, in milliseconds since the epoch."}},"required":["index_patterns","composed_of"]},"indices._types__IndexTemplateSummary":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycle"},"data_stream_options":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamOptions"}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices._types__IndexSettings":{"type":"object","additionalProperties":{}},"indices._types__DataStreamLifecycleWithRollover":{"type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"effective_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The least amount of time data should be kept by elasticsearch."},"retention_determined_by":{"$ref":"./indices._types.json#/$defs/indices._types__RetentionSource","description":"Configuration source that can influence the retention of a data stream."},"downsampling":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DownsamplingRound"},"description":"The list of downsampling rounds to execute as part of this downsampling configuration"},"downsampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."},"frozen_after":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots.\nThis field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles."},"rollover":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycleRolloverConditions","description":"The conditions which will trigger the rollover of a backing index as configured by the cluster setting `cluster.lifecycle.default.rollover`.\nThis property is an implementation detail and it will only be retrieved when the query param `include_defaults` is set to true.\nThe contents of this field are subject to change."}},"description":"Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked."},"indices._types__RetentionSource":{"enum":["data_stream_configuration","default_global_retention","max_global_retention","default_failures_retention"]},"indices._types__DownsamplingRound":{"type":"object","properties":{"after":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The duration since rollover when this downsampling round should execute"},"fixed_interval":{"type":"string","description":"The downsample interval."}},"required":["after","fixed_interval"]},"indices._types__SamplingMethod":{"enum":["aggregate","last_value"]},"indices._types__DataStreamLifecycleRolloverConditions":{"type":"object","properties":{"min_age":{"$ref":"./_types.json#/$defs/_types__Duration"},"max_age":{"type":"string"},"min_docs":{"type":"number"},"max_docs":{"type":"number"},"min_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"max_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"min_primary_shard_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"max_primary_shard_size":{"$ref":"./_types.json#/$defs/_types__ByteSize"},"min_primary_shard_docs":{"type":"number"},"max_primary_shard_docs":{"type":"number"}}},"indices._types__NumericFielddata":{"type":"object","properties":{"format":{"$ref":"./indices._types.json#/$defs/indices._types__NumericFielddataFormat"}},"required":["format"]},"indices._types__NumericFielddataFormat":{"enum":["array","disabled"]},"indices._types__FielddataFrequencyFilter":{"type":"object","properties":{"max":{"type":"number"},"min":{"type":"number"},"min_segment_size":{"type":"number"}},"required":["max","min","min_segment_size"]},"indices._types__AliasDefinition":{"type":"object","properties":{"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access."},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations."},"is_write_index":{"type":"boolean","description":"If `true`, the index is the write index for the alias."},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard."},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations."},"is_hidden":{"type":"boolean","description":"If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value."}}},"indices._types__DataStreamOptions":{"type":"object","properties":{"failure_store":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamFailureStore","description":"If defined, it specifies configuration for the failure store of this data stream."}},"description":"Data stream options contain the configuration of data stream level features for a given data stream, for example,\nthe failure store configuration."},"indices._types__DataStreamFailureStore":{"type":"object","properties":{"enabled":{"type":"boolean","description":"If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__FailureStoreLifecycle","description":"If defined, it specifies the lifecycle configuration for the failure store of this data stream."}},"description":"Data stream failure store contains the configuration of the failure store for a given data stream."},"indices._types__FailureStoreLifecycle":{"type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."}},"description":"The failure store lifecycle configures the data stream lifecycle configuration for failure indices."},"indices._types__Alias":{"type":"object","properties":{"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access."},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations."},"is_hidden":{"type":"boolean","description":"If `true`, the alias is hidden.\nAll indices for the alias must have the same `is_hidden` value."},"is_write_index":{"type":"boolean","description":"If `true`, the index is the write index for the alias."},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard."},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations."}}},"indices._types__DataStreamLifecycle":{"type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"effective_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The least amount of time data should be kept by elasticsearch."},"retention_determined_by":{"$ref":"./indices._types.json#/$defs/indices._types__RetentionSource","description":"Configuration source that can influence the retention of a data stream."},"downsampling":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DownsamplingRound"},"description":"The list of downsampling rounds to execute as part of this downsampling configuration"},"downsampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."},"frozen_after":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period after which data stream backing indices are automatically converted to partially mounted searchable snapshots.\nThis field is valid only on main data stream lifecycles and cannot be set on failure-store lifecycles."}},"description":"Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration."},"indices._types__DataStreamOptionsTemplate":{"type":"object","properties":{"failure_store":{"anyOf":[{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamFailureStoreTemplate"},{"type":"null"}]}},"description":"Data stream options template contains the same information as DataStreamOptions but allows them to be set explicitly to null."},"indices._types__DataStreamFailureStoreTemplate":{"type":"object","properties":{"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"If defined, it turns the failure store on/off (`true`/`false`) for this data stream. A data stream failure store\nthat's disabled (enabled: `false`) will redirect no new failed indices to the failure store; however, it will\nnot remove any existing data from the failure store."},"lifecycle":{"anyOf":[{"$ref":"./indices._types.json#/$defs/indices._types__FailureStoreLifecycleTemplate"},{"type":"null"}],"description":"If defined, it specifies the lifecycle configuration for the failure store of this data stream."}},"description":"Template equivalent of DataStreamFailureStore that allows nullable values."},"indices._types__FailureStoreLifecycleTemplate":{"type":"object","properties":{"data_retention":{"anyOf":[{"$ref":"./_types.json#/$defs/_types__Duration"},{"type":"null"}],"description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely."},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream."}},"description":"Template equivalent of FailureStoreLifecycle that allows nullable values."},"indices._types__IndicesBlockOptions":{"enum":["metadata","read","read_only","write"]},"indices._types__DownsampleConfig":{"type":"object","properties":{"fixed_interval":{"type":"string","description":"The interval at which to aggregate the original time series index."},"sampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The sampling method used to reduce the documents; it can be either `aggregate` or `last_value`. Defaults to `aggregate`."}},"required":["fixed_interval"]},"indices._types__IndexState":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"}},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings"},"defaults":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Default settings, included when the request's `include_default` is `true`."},"data_stream":{"type":"string"},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycle","description":"Data stream lifecycle applicable if this is a data stream."}}},"indices._types__DataStream":{"type":"object","properties":{"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Custom metadata for the stream, copied from the `_meta` object of the stream’s matching index template.\nIf empty, the response omits this property."},"allow_custom_routing":{"type":"boolean","description":"If `true`, the data stream allows custom routing on write request."},"failure_store":{"$ref":"./indices._types.json#/$defs/indices._types__FailureStore","description":"Information about failure store backing indices"},"generation":{"type":"number","description":"Current generation for the data stream. This number acts as a cumulative count of the stream’s rollovers, starting at 1."},"hidden":{"type":"boolean","description":"If `true`, the data stream is hidden."},"ilm_policy":{"type":"string","description":"Name of the current ILM lifecycle policy in the stream’s matching index template.\nThis lifecycle policy is set in the `index.lifecycle.name` setting.\nIf the template does not include a lifecycle policy, this property is not included in the response.\nNOTE: A data stream’s backing indices may be assigned different lifecycle policies. To retrieve the lifecycle policy for individual backing indices, use the get index settings API."},"next_generation_managed_by":{"$ref":"./indices._types.json#/$defs/indices._types__ManagedBy","description":"Name of the lifecycle system that'll manage the next generation of the data stream."},"prefer_ilm":{"type":"boolean","description":"Indicates if ILM should take precedence over DSL in case both are configured to managed this data stream."},"indices":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamIndex"},"description":"Array of objects containing information about the data stream’s backing indices.\nThe last item in this array contains information about the stream’s current write index."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycleWithRollover","description":"Contains the configuration for the data stream lifecycle of this data stream."},"name":{"type":"string","description":"Name of the data stream."},"replicated":{"type":"boolean","description":"If `true`, the data stream is created and managed by cross-cluster replication and the local cluster can not write into this data stream or change its mappings."},"rollover_on_write":{"type":"boolean","description":"If `true`, the next write to this data stream will trigger a rollover first and the document will be indexed in the new backing index. If the rollover fails the indexing request will fail too."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"The settings specific to this data stream that will take precedence over the settings in the matching index\ntemplate."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"The mappings specific to this data stream that will take precedence over the mappings in the matching index\ntemplate."},"status":{"$ref":"./_types.json#/$defs/_types__HealthStatus","description":"Health status of the data stream.\nThis health status is based on the state of the primary and replica shards of the stream’s backing indices."},"system":{"type":"boolean","description":"If `true`, the data stream is created and managed by an Elastic stack component and cannot be modified through normal user interaction."},"template":{"type":"string","description":"Name of the index template used to create the data stream’s backing indices.\nThe template’s index pattern must match the name of this data stream."},"timestamp_field":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamTimestampField","description":"Information about the `@timestamp` field in the data stream."},"index_mode":{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode","description":"The index mode for the data stream that will be used for newly created backing indices."}},"required":["generation","hidden","next_generation_managed_by","prefer_ilm","indices","name","rollover_on_write","settings","status","template","timestamp_field"]},"indices._types__FailureStore":{"type":"object","properties":{"enabled":{"type":"boolean"},"indices":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamIndex"}},"rollover_on_write":{"type":"boolean"}},"required":["enabled","indices","rollover_on_write"]},"indices._types__DataStreamIndex":{"type":"object","properties":{"index_name":{"type":"string","description":"Name of the backing index."},"index_uuid":{"type":"string","description":"Universally unique identifier (UUID) for the index."},"ilm_policy":{"type":"string","description":"Name of the current ILM lifecycle policy configured for this backing index."},"managed_by":{"$ref":"./indices._types.json#/$defs/indices._types__ManagedBy","description":"Name of the lifecycle system that's currently managing this backing index."},"prefer_ilm":{"type":"boolean","description":"Indicates if ILM should take precedence over DSL in case both are configured to manage this index."},"index_mode":{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode","description":"The index mode of this backing index of the data stream."}},"required":["index_name","index_uuid"]},"indices._types__ManagedBy":{"enum":["ilm","datastream","unmanaged"]},"indices._types__IndexMode":{"enum":["standard","time_series","logsdb","lookup"]},"indices._types__DataStreamTimestampField":{"type":"object","properties":{"name":{"type":"string","description":"Name of the timestamp field for the data stream, which must be `@timestamp`. The `@timestamp` field must be included in every document indexed to the data stream."}},"required":["name"]},"indices._types__IndexTemplateWithRollover":{"type":"object","properties":{"template":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateSummaryWithRollover","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration."},"index_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation."},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence."},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch."},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch."},"allow_auto_create":{"type":"boolean"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateDataStreamConfiguration","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object."},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning."},"ignore_missing_component_templates":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of component template names that are allowed to be absent."},"created_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was created. Only returned if the `human` query parameter is `true`."},"created_date_millis":{"description":"Date and time when the index template was created, in milliseconds since the epoch."},"modified_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`."},"modified_date_millis":{"description":"Date and time when the index template was last modified, in milliseconds since the epoch."}},"required":["index_patterns","composed_of"]},"indices._types__IndexTemplateSummaryWithRollover":{"type":"object","properties":{"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycleWithRollover"},"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index."},"data_stream_options":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamOptions"}}},"indices._types__IndexTemplateDataStreamConfiguration":{"type":"object","properties":{"hidden":{"type":"boolean","description":"If true, the data stream is hidden."},"allow_custom_routing":{"type":"boolean","description":"If true, the data stream supports custom routing."}}},"indices._types__TemplateMapping":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"}},"index_patterns":{"type":"array","items":{"type":"string"}},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping"},"order":{"type":"number"},"settings":{"type":"object","additionalProperties":{}},"version":{"type":"number"}},"required":["aliases","index_patterns","mappings","order","settings"]},"indices._types__DataStreamVisibility":{"type":"object","properties":{"hidden":{"type":"boolean"},"allow_custom_routing":{"type":"boolean"},"failure_store":{"type":"boolean"}}},"indices._types__IndexTemplate":{"type":"object","properties":{"index_patterns":{"$ref":"./_types.json#/$defs/_types__Names","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation."},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence."},"template":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateSummary","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration."},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch."},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch."},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template. May have any contents.\nThis map is not automatically generated by Elasticsearch."},"allow_auto_create":{"type":"boolean"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__IndexTemplateDataStreamConfiguration","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object."},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated.\nWhen creating or updating a non-deprecated index template that uses deprecated components,\nElasticsearch will emit a deprecation warning."},"ignore_missing_component_templates":{"$ref":"./_types.json#/$defs/_types__Names","description":"A list of component template names that are allowed to be absent."},"created_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was created. Only returned if the `human` query parameter is `true`."},"created_date_millis":{"description":"Date and time when the index template was created, in milliseconds since the epoch."},"modified_date":{"$ref":"./_types.json#/$defs/_types__DateTime","description":"Date and time when the index template was last modified. Only returned if the `human` query parameter is `true`."},"modified_date_millis":{"description":"Date and time when the index template was last modified, in milliseconds since the epoch."}},"required":["index_patterns","composed_of"]},"indices._types__IndexTemplateSummary":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycle"},"data_stream_options":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamOptions"}}},"indices._types__IndexRouting":{"type":"object","properties":{"allocation":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocation"},"rebalance":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingRebalance"}}},"indices._types__IndexRoutingAllocation":{"type":"object","properties":{"enable":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationOptions"},"include":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationInclude"},"initial_recovery":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationInitialRecovery"},"disk":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingAllocationDisk"}}},"indices._types__IndexRoutingAllocationOptions":{"enum":["all","primaries","new_primaries","none"]},"indices._types__IndexRoutingAllocationInclude":{"type":"object","properties":{"_tier_preference":{"type":"string"},"_id":{"type":"string"}}},"indices._types__IndexRoutingAllocationInitialRecovery":{"type":"object","properties":{"_id":{"type":"string"}}},"indices._types__IndexRoutingAllocationDisk":{"type":"object","properties":{"threshold_enabled":{"anyOf":[{"type":"boolean"},{"type":"string"}]}}},"indices._types__IndexRoutingRebalance":{"type":"object","properties":{"enable":{"$ref":"./indices._types.json#/$defs/indices._types__IndexRoutingRebalanceOptions"}},"required":["enable"]},"indices._types__IndexRoutingRebalanceOptions":{"enum":["all","primaries","replicas","none"]}}}

package/src/es/json/indices.analyze.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.analyze__TextToAnalyze":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"indices.analyze__AnalyzeDetail":{"type":"object","properties":{"analyzer":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__AnalyzerDetail"},"charfilters":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__CharFilterDetail"}},"custom_analyzer":{"type":"boolean"},"tokenfilters":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__TokenDetail"}},"tokenizer":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__TokenDetail"}},"required":["custom_analyzer"]},"indices.analyze__AnalyzerDetail":{"type":"object","properties":{"name":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__ExplainAnalyzeToken"}}},"required":["name","tokens"]},"indices.analyze__ExplainAnalyzeToken":{"type":"object","additionalProperties":{}},"indices.analyze__CharFilterDetail":{"type":"object","properties":{"filtered_text":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}},"required":["filtered_text","name"]},"indices.analyze__TokenDetail":{"type":"object","properties":{"name":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__ExplainAnalyzeToken"}}},"required":["name","tokens"]},"indices.analyze__AnalyzeToken":{"type":"object","properties":{"end_offset":{"type":"number"},"position":{"type":"number"},"positionLength":{"type":"number"},"start_offset":{"type":"number"},"token":{"type":"string"},"type":{"type":"string"}},"required":["end_offset","position","start_offset","token","type"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.analyze__TextToAnalyze":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}]},"indices.analyze__AnalyzeDetail":{"type":"object","properties":{"analyzer":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__AnalyzerDetail"},"charfilters":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__CharFilterDetail"}},"custom_analyzer":{"type":"boolean"},"tokenfilters":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__TokenDetail"}},"tokenizer":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__TokenDetail"}},"required":["custom_analyzer"]},"indices.analyze__AnalyzerDetail":{"type":"object","properties":{"name":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__ExplainAnalyzeToken"}}},"required":["name","tokens"]},"indices.analyze__ExplainAnalyzeToken":{"type":"object","additionalProperties":{}},"indices.analyze__CharFilterDetail":{"type":"object","properties":{"filtered_text":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}},"required":["filtered_text","name"]},"indices.analyze__TokenDetail":{"type":"object","properties":{"name":{"type":"string"},"tokens":{"type":"array","items":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__ExplainAnalyzeToken"}}},"required":["name","tokens"]},"indices.analyze__AnalyzeToken":{"type":"object","properties":{"end_offset":{"type":"number"},"position":{"type":"number"},"positionLength":{"type":"number"},"start_offset":{"type":"number"},"token":{"type":"string"},"type":{"type":"string"}},"required":["end_offset","position","start_offset","token","type"]}}}

package/src/es/json/indices.analyze.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.analyze","type":"object","properties":{"analyzer":{"type":"string","description":"The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.","x-found-in":"body"},"attributes":{"type":"array","items":{"type":"string"},"description":"Array of token attributes used to filter the output of the `explain` parameter.","x-found-in":"body"},"char_filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__CharFilter"},"description":"Array of character filters used to preprocess characters before the tokenizer.","x-found-in":"body"},"explain":{"type":"boolean","description":"If `true`, the response includes token attributes and additional details.","x-found-in":"body"},"field":{"type":"string","description":"Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.","x-found-in":"body"},"filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__TokenFilter"},"description":"Array of token filters used to apply after the tokenizer.","x-found-in":"body"},"normalizer":{"type":"string","description":"Normalizer to use to convert text into a single token.","x-found-in":"body"},"text":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__TextToAnalyze","description":"Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.","x-found-in":"body"},"tokenizer":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__Tokenizer","description":"Tokenizer to use to convert text into tokens.","x-found-in":"body"},"index":{"type":"string","description":"Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.","x-found-in":"path"}},"description":"Get tokens from text analysis.\n\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.analyze","type":"object","properties":{"index":{"type":"string","description":"Index used to derive the analyzer.\nIf specified, the `analyzer` or field parameter overrides this value.\nIf no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer.","x-found-in":"path"},"analyzer":{"type":"string","description":"The name of the analyzer that should be applied to the provided `text`.\nThis could be a built-in analyzer, or an analyzer that’s been configured in the index.","x-found-in":"body"},"attributes":{"type":"array","items":{"type":"string"},"description":"Array of token attributes used to filter the output of the `explain` parameter.","x-found-in":"body"},"char_filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__CharFilter"},"description":"Array of character filters used to preprocess characters before the tokenizer.","x-found-in":"body"},"explain":{"type":"boolean","description":"If `true`, the response includes token attributes and additional details.","x-found-in":"body"},"field":{"type":"string","description":"Field used to derive the analyzer.\nTo use this parameter, you must specify an index.\nIf specified, the `analyzer` parameter overrides this value.","x-found-in":"body"},"filter":{"type":"array","items":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__TokenFilter"},"description":"Array of token filters used to apply after the tokenizer.","x-found-in":"body"},"normalizer":{"type":"string","description":"Normalizer to use to convert text into a single token.","x-found-in":"body"},"text":{"$ref":"./indices.analyze.json#/$defs/indices.analyze__TextToAnalyze","description":"Text to analyze.\nIf an array of strings is provided, it is analyzed as a multi-value field.","x-found-in":"body"},"tokenizer":{"$ref":"./_types.analysis.json#/$defs/_types.analysis__Tokenizer","description":"Tokenizer to use to convert text into tokens.","x-found-in":"body"}},"description":"Get tokens from text analysis.\n\nThe analyze API performs analysis on a text string and returns the resulting tokens.\n\nGenerating excessive amount of tokens may cause a node to run out of memory.\nThe `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced.\nIf more than this limit of tokens gets generated, an error occurs.\nThe `_analyze` endpoint without a specified index will always use `10000` as its limit."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.clone","type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the resulting index.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Configuration options for the target index.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).","x-found-in":"query"},"index":{"type":"string","description":"Name of the source index to clone.","x-found-in":"path"},"target":{"type":"string","description":"Name of the target index to create.","x-found-in":"path"}},"required":["index","target"],"description":"Clone an index.\n\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.clone","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).","x-found-in":"query"},"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the resulting index.","x-found-in":"body"},"settings":{"type":"object","additionalProperties":{},"description":"Configuration options for the target index.","x-found-in":"body"},"index":{"type":"string","description":"Name of the source index to clone.","x-found-in":"path"},"target":{"type":"string","description":"Name of the target index to create.","x-found-in":"path"}},"required":["index","target"],"description":"Clone an index.\n\nClone an existing index into a new index.\nEach original primary shard is cloned into a new primary shard in the new index.\n\nIMPORTANT: Elasticsearch does not apply index templates to the resulting index.\nThe API also does not copy index metadata from the original index.\nIndex metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information.\nFor example, if you clone a CCR follower index, the resulting clone will not be a follower index.\n\nThe clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`.\nTo set the number of replicas in the resulting index, configure these settings in the clone request.\n\nCloning works as follows:\n\n* First, it creates a new target index with the same definition as the source index.\n* Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process.\n* Finally, it recovers the target index as though it were a closed index which had just been re-opened.\n\nIMPORTANT: Indices can only be cloned if they meet the following requirements:\n\n* The index must be marked as read-only and have a cluster health status of green.\n* The target index must not exist.\n* The source index must have the same number of primary shards as the target index.\n* The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index.\n\nThe current write index on a data stream cannot be cloned.\nIn order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned.\n\nNOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index.\n\n**Monitor the cloning process**\n\nThe cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`.\n\nThe `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated.\nAt this point, all shards are in the state unassigned.\nIf, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node.\n\nOnce the primary shard is allocated, it moves to state initializing, and the clone process begins.\nWhen the clone operation completes, the shard will become active.\nAt that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node.\n\n**Wait for active shards**\n\nBecause the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well."}

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

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.create","type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the index.","x-found-in":"body"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).","x-found-in":"query"},"index":{"type":"string","description":"Name of the index you wish to create.\nIndex names must meet the following criteria:\n\n* Lowercase only\n* Cannot include `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#`\n* Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions\n* Cannot start with `-`, `_`, or `+`\n* Cannot be `.` or `..`\n* Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)\n* Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins","x-found-in":"path"}},"required":["index"],"description":"Create an index.\n\nYou can use the create index API to add a new index to an Elasticsearch cluster.\nWhen creating an index, you can specify the following:\n\n* Settings for the index.\n* Mappings for fields in the index.\n* Index aliases\n\n**Wait for active shards**\n\nBy default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.\nThe index creation response will indicate what happened.\nFor example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out.\nNote that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful.\nThese values simply indicate whether the operation completed before the timeout.\nIf `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.\nIf `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).\n\nYou can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.\nNote that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.create","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"wait_for_active_shards":{"$ref":"./_types.json#/$defs/_types__WaitForActiveShards","description":"The number of shard copies that must be active before proceeding with the operation.\nSet to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).","x-found-in":"query"},"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the index.","x-found-in":"body"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index. If specified, this mapping can include:\n- Field names\n- Field data types\n- Mapping parameters","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index.","x-found-in":"body"},"index":{"type":"string","description":"Name of the index you wish to create.\nIndex names must meet the following criteria:\n\n* Lowercase only\n* Cannot include `\\`, `/`, `*`, `?`, `\"`, `<`, `>`, `|`, ` ` (space character), `,`, or `#`\n* Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions\n* Cannot start with `-`, `_`, or `+`\n* Cannot be `.` or `..`\n* Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster)\n* Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins","x-found-in":"path"}},"required":["index"],"description":"Create an index.\n\nYou can use the create index API to add a new index to an Elasticsearch cluster.\nWhen creating an index, you can specify the following:\n\n* Settings for the index.\n* Mappings for fields in the index.\n* Index aliases\n\n**Wait for active shards**\n\nBy default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out.\nThe index creation response will indicate what happened.\nFor example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out.\nNote that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful.\nThese values simply indicate whether the operation completed before the timeout.\nIf `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon.\nIf `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`).\n\nYou can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`.\nNote that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations."}

package/src/es/json/indices.create_from.json

@@ -0,0 +1 @@
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.create_from__CreateFrom":{"type":"object","properties":{"mappings_override":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mappings overrides to be applied to the destination index (optional)"},"settings_override":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Settings overrides to be applied to the destination index (optional)"},"remove_index_blocks":{"type":"boolean","description":"If index blocks should be removed when creating destination index (optional)"}}}}}

package/src/es/json/indices.create_from.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.create_from","type":"object","properties":{"source":{"type":"string","description":"The source index or data stream name","x-found-in":"path"},"dest":{"type":"string","description":"The destination index or data stream name","x-found-in":"path"}},"required":["source","dest"],"description":"Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.create_from","type":"object","properties":{"create_from":{"$ref":"./indices.create_from.json#/$defs/indices.create_from__CreateFrom","x-found-in":"body"},"source":{"type":"string","description":"The source index or data stream name","x-found-in":"path"},"dest":{"type":"string","description":"The destination index or data stream name","x-found-in":"path"}},"required":["source","dest"],"description":"Create an index from a source index.\n\nCopy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values."}

package/src/es/json/indices.downsample.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.downsample","type":"object","properties":{"index":{"type":"string","description":"Name of the time series index to downsample.","x-found-in":"path"},"target_index":{"type":"string","description":"Name of the index to create.","x-found-in":"path"}},"required":["index","target_index"],"description":"Downsample an index.\n\nDownsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:\n\n- When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`)\nfor each metric field grouped by a configured time interval and their dimensions.\n- When running in `last_value` mode, it keeps the last value for each metric in the configured interval and their dimensions.\n\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read-only (`index.blocks.write: true`)."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.downsample","type":"object","properties":{"config":{"$ref":"./indices._types.json#/$defs/indices._types__DownsampleConfig","x-found-in":"body"},"index":{"type":"string","description":"Name of the time series index to downsample.","x-found-in":"path"},"target_index":{"type":"string","description":"Name of the index to create.","x-found-in":"path"}},"required":["index","target_index"],"description":"Downsample an index.\n\nDownsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:\n\n- When running in `aggregate` mode, it pre-calculates and stores statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`)\nfor each metric field grouped by a configured time interval and their dimensions.\n- When running in `last_value` mode, it keeps the last value for each metric in the configured interval and their dimensions.\n\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read-only (`index.blocks.write: true`)."}

package/src/es/json/indices.forcemerge.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.forcemerge","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both.","x-found-in":"query"},"flush":{"type":"boolean","description":"Specify whether the index should be flushed after performing the operation","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"max_num_segments":{"type":"number","description":"The number of segments the index should be merged into (default: dynamic)","x-found-in":"query"},"only_expunge_deletes":{"type":"boolean","description":"Specify whether the operation should only expunge deleted documents","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"Should the request wait until the force merge is completed","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices","x-found-in":"path"}},"description":"Force a merge.\n\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/<task_id>`.\nWhen you are done with a task, you should delete the task document so Elasticsearch can reclaim the space.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the force_merge threadpool.\nBy default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```"}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.forcemerge","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Whether to expand wildcard expression to concrete indices that are open, closed or both.","x-found-in":"query"},"flush":{"type":"boolean","description":"Specify whether the index should be flushed after performing the operation","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"max_num_segments":{"type":"number","description":"The number of segments the index should be merged into (default: dynamic)","x-found-in":"query"},"only_expunge_deletes":{"type":"boolean","description":"Specify whether the operation should only expunge deleted documents","x-found-in":"query"},"wait_for_completion":{"type":"boolean","description":"Should the request wait until the force merge is completed","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices","x-found-in":"path"}},"description":"Force a merge.\n\nPerform the force merge operation on the shards of one or more indices.\nFor data streams, the API forces a merge on the shards of the stream's backing indices.\n\nMerging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents.\nMerging normally happens automatically, but sometimes it is useful to trigger a merge manually.\n\nWARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes).\nWhen documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a \"tombstone\".\nThese soft-deleted documents are automatically cleaned up during regular segment merges.\nBut force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges.\nSo the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance.\nIf you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally.\n\n**Blocks during a force merge**\n\nCalls to this API block until the merge is complete (unless request contains `wait_for_completion=false`).\nIf the client connection is lost before completion then the force merge process will continue in the background.\nAny new requests to force merge the same indices will also block until the ongoing force merge is complete.\n\n**Running force merge asynchronously**\n\nIf the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task.\nHowever, you can not cancel this task as the force merge task is not cancelable.\nElasticsearch creates a record of this task as a document at `_tasks/<task_id>`.\n\n**Force merging multiple indices**\n\nYou can force merge multiple indices with a single request by targeting:\n\n* One or more data streams that contain multiple backing indices\n* Multiple indices\n* One or more aliases\n* All data streams and indices in a cluster\n\nEach targeted shard is force-merged separately using the `force_merge` threadpool.\nThe `force_merge` threadpool has a fixed size of `max(1, allocatedProcessors / 8)` per node, which means multiple shards on a node may be force-merged in parallel.\nIf you expand the `force_merge` threadpool on a node then it will force merge its shards with more parallelism.\n\nForce merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one.\n\n**Data streams and time-based indices**\n\nForce-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover.\nIn these cases, each index only receives indexing traffic for a certain period of time.\nOnce an index receive no more writes, its shards can be force-merged to a single segment.\nThis can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches.\nFor example:\n\n```\nPOST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1\n```"}

package/src/es/json/indices.get.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.get__Features":{"oneOf":[{"$ref":"./indices.get.json#/$defs/indices.get__Feature"},{"type":"array","items":{"$ref":"./indices.get.json#/$defs/indices.get__Feature"}}]},"indices.get__Feature":{"enum":["aliases","mappings","settings"]}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.get__Features":{"anyOf":[{"$ref":"./indices.get.json#/$defs/indices.get__Feature"},{"type":"array","items":{"$ref":"./indices.get.json#/$defs/indices.get__Feature"}}]},"indices.get__Feature":{"enum":["aliases","mappings","settings"]}}}

package/src/es/json/indices.migrate_reindex.json

@@ -0,0 +1 @@
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.migrate_reindex__MigrateReindex":{"type":"object","properties":{"mode":{"$ref":"./indices.migrate_reindex.json#/$defs/indices.migrate_reindex__ModeEnum","description":"Reindex mode. Currently only 'upgrade' is supported."},"source":{"$ref":"./indices.migrate_reindex.json#/$defs/indices.migrate_reindex__SourceIndex","description":"The source index or data stream (only data streams are currently supported)."}},"required":["mode","source"]},"indices.migrate_reindex__ModeEnum":{"enum":["upgrade"]},"indices.migrate_reindex__SourceIndex":{"type":"object","properties":{"index":{"type":"string"}},"required":["index"]}}}

package/src/es/json/indices.migrate_reindex.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.migrate_reindex","type":"object","properties":{},"description":"Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.migrate_reindex","type":"object","properties":{"reindex":{"$ref":"./indices.migrate_reindex.json#/$defs/indices.migrate_reindex__MigrateReindex","x-found-in":"body"}},"description":"Reindex legacy backing indices.\n\nReindex all legacy backing indices for a data stream.\nThis operation occurs in a persistent task.\nThe persistent task ID is returned immediately and the reindexing work is completed in that task."}

package/src/es/json/indices.put_alias.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_alias","type":"object","properties":{"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access.","x-found-in":"body"},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.","x-found-in":"body"},"is_write_index":{"type":"boolean","description":"If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.","x-found-in":"body"},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.","x-found-in":"body"},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.","x-found-in":"body"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"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"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.","x-found-in":"path"},"name":{"type":"string","description":"Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.","x-found-in":"path"}},"required":["index","name"],"description":"Create or update an alias.\n\nAdds a data stream or index to an alias."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_alias","type":"object","properties":{"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"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"},"filter":{"$ref":"./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer","description":"Query used to limit documents the alias can access.","x-found-in":"body"},"index_routing":{"type":"string","description":"Value used to route indexing operations to a specific shard.\nIf specified, this overwrites the `routing` value for indexing operations.\nData stream aliases don’t support this parameter.","x-found-in":"body"},"is_write_index":{"type":"boolean","description":"If `true`, sets the write index or data stream for the alias.\nIf an alias points to multiple indices or data streams and `is_write_index` isn’t set, the alias rejects write requests.\nIf an index alias points to one index and `is_write_index` isn’t set, the index automatically acts as the write index.\nData stream aliases don’t automatically set a write data stream, even if the alias points to one data stream.","x-found-in":"body"},"routing":{"type":"string","description":"Value used to route indexing and search operations to a specific shard.\nData stream aliases don’t support this parameter.","x-found-in":"body"},"search_routing":{"type":"string","description":"Value used to route search operations to a specific shard.\nIf specified, this overwrites the `routing` value for search operations.\nData stream aliases don’t support this parameter.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams or indices to add.\nSupports wildcards (`*`).\nWildcard patterns that match both data streams and indices return an error.","x-found-in":"path"},"name":{"type":"string","description":"Alias to update.\nIf the alias doesn’t exist, the request creates it.\nIndex alias names support date math.","x-found-in":"path"}},"required":["index","name"],"description":"Create or update an alias.\n\nAdds a data stream or index to an alias."}

package/src/es/json/indices.put_data_lifecycle.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_lifecycle","type":"object","properties":{"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.","x-found-in":"body"},"downsampling":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DownsamplingRound"},"description":"The downsampling configuration to execute for the managed backing index after rollover.","x-found-in":"body"},"downsampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`.","x-found-in":"body"},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.","x-found-in":"body"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__DataStreamNames","description":"Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.","x-found-in":"path"}},"required":["name"],"description":"Update data stream lifecycles.\n\nUpdate the data stream lifecycle of the specified data streams."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_lifecycle","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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"},"data_retention":{"$ref":"./_types.json#/$defs/_types__Duration","description":"If defined, every document added to this data stream will be stored at least for this time frame.\nAny time after this duration the document could be deleted.\nWhen empty, every document in this data stream will be stored indefinitely.","x-found-in":"body"},"downsampling":{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__DownsamplingRound"},"description":"The downsampling configuration to execute for the managed backing index after rollover.","x-found-in":"body"},"downsampling_method":{"$ref":"./indices._types.json#/$defs/indices._types__SamplingMethod","description":"The method used to downsample the data. There are two options `aggregate` and `last_value`. It requires\n`downsampling` to be defined. Defaults to `aggregate`.","x-found-in":"body"},"enabled":{"type":"boolean","description":"If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle\nthat's disabled (enabled: `false`) will have no effect on the data stream.","x-found-in":"body"},"name":{"$ref":"./_types.json#/$defs/_types__DataStreamNames","description":"Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.","x-found-in":"path"}},"required":["name"],"description":"Update data stream lifecycles.\n\nUpdate the data stream lifecycle of the specified data streams."}

package/src/es/json/indices.put_data_stream_mappings.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_stream_mappings","type":"object","properties":{"dry_run":{"type":"boolean","description":"If `true`, the request does not actually change the mappings on any data streams. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams or data stream patterns.","x-found-in":"path"}},"required":["name"],"description":"Update data stream mappings.\n\nThis API can be used to override mappings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. The mapping change is only applied to new write indices\nthat are created during rollover after this API is called. No indices are changed by this API."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_stream_mappings","type":"object","properties":{"dry_run":{"type":"boolean","description":"If `true`, the request does not actually change the mappings on any data streams. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.","x-found-in":"query"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","x-found-in":"body"},"name":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams or data stream patterns.","x-found-in":"path"}},"required":["name"],"description":"Update data stream mappings.\n\nThis API can be used to override mappings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. The mapping change is only applied to new write indices\nthat are created during rollover after this API is called. No indices are changed by this API."}

package/src/es/json/indices.put_data_stream_options.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_stream_options","type":"object","properties":{"failure_store":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamFailureStore","description":"If defined, it will update the failure store configuration of every data stream resolved by the name expression.","x-found-in":"body"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__DataStreamNames","description":"Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.","x-found-in":"path"}},"required":["name"],"description":"Update data stream options.\n\nUpdate the data stream options of the specified data streams."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_stream_options","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of data stream that wildcard patterns can match.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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"},"failure_store":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamFailureStore","description":"If defined, it will update the failure store configuration of every data stream resolved by the name expression.","x-found-in":"body"},"name":{"$ref":"./_types.json#/$defs/_types__DataStreamNames","description":"Comma-separated list of data streams used to limit the request.\nSupports wildcards (`*`).\nTo target all data streams use `*` or `_all`.","x-found-in":"path"}},"required":["name"],"description":"Update data stream options.\n\nUpdate the data stream options of the specified data streams."}

package/src/es/json/indices.put_data_stream_settings.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_stream_settings","type":"object","properties":{"dry_run":{"type":"boolean","description":"If `true`, the request does not actually change the settings on any data streams or indices. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams or data stream patterns.","x-found-in":"path"}},"required":["name"],"description":"Update data stream settings.\n\nNOTE: Available in 8.19. Not available in earlier versions.\n\nThis API can be used to override settings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,\nonly certain settings are allowed. If possible, the setting change is applied to all\nbacking indices. Otherwise, it will be applied when the data stream is next rolled over."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_data_stream_settings","type":"object","properties":{"dry_run":{"type":"boolean","description":"If `true`, the request does not actually change the settings on any data streams or indices. Instead, it\nsimulates changing the settings and reports back to the user what would have happened had these settings\nactually been applied.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"The period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.","x-found-in":"query"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","x-found-in":"body"},"name":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of data streams or data stream patterns.","x-found-in":"path"}},"required":["name"],"description":"Update data stream settings.\n\nNOTE: Available in 8.19. Not available in earlier versions.\n\nThis API can be used to override settings on specific data streams. These overrides will take precedence over what\nis specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,\nonly certain settings are allowed. If possible, the setting change is applied to all\nbacking indices. Otherwise, it will be applied when the data stream is next rolled over."}

package/src/es/json/indices.put_index_template.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.put_index_template__IndexTemplateMapping":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycle"},"data_stream_options":{"oneOf":[{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamOptionsTemplate"},{"type":"null"}]}}}}}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","$defs":{"indices.put_index_template__IndexTemplateMapping":{"type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases to add.\nIf the index template includes a `data_stream` object, these are data stream aliases.\nOtherwise, these are index aliases.\nData stream aliases ignore the `index_routing`, `routing`, and `search_routing` options."},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.\nIf specified, this mapping can include field names, field data types, and mapping parameters."},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index."},"lifecycle":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamLifecycle"},"data_stream_options":{"anyOf":[{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamOptionsTemplate"},{"type":"null"}]}}}}}

package/src/es/json/indices.put_index_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_index_template","type":"object","properties":{"index_patterns":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.","x-found-in":"body"},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.","x-found-in":"body"},"template":{"$ref":"./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.","x-found-in":"body"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamVisibility","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.","x-found-in":"body"},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.","x-found-in":"body"},"allow_auto_create":{"type":"boolean","description":"This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.","x-found-in":"body"},"ignore_missing_component_templates":{"type":"array","items":{"type":"string"},"description":"The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist","x-found-in":"body"},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.","x-found-in":"body"},"create":{"type":"boolean","description":"If `true`, this request cannot replace or update existing index templates.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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"},"cause":{"type":"string","description":"User defined reason for creating or updating the index template","x-found-in":"query"},"name":{"type":"string","description":"Index or template name","x-found-in":"path"}},"required":["name"],"description":"Create or update an index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_index_template","type":"object","properties":{"create":{"type":"boolean","description":"If `true`, this request cannot replace or update existing index templates.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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"},"cause":{"type":"string","description":"User defined reason for creating or updating the index template","x-found-in":"query"},"index_patterns":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Array of wildcard (`*`) expressions used to match the names of data streams and indices during creation.","x-found-in":"body"},"composed_of":{"type":"array","items":{"type":"string"},"description":"An ordered list of component template names.\nComponent templates are merged in the order specified, meaning that the last component template specified has the highest precedence.","x-found-in":"body"},"template":{"$ref":"./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping","description":"Template to be applied.\nIt may optionally include an `aliases`, `mappings`, or `settings` configuration.","x-found-in":"body"},"data_stream":{"$ref":"./indices._types.json#/$defs/indices._types__DataStreamVisibility","description":"If this object is included, the template is used to create data streams and their backing indices.\nSupports an empty object.\nData streams require a matching index template with a `data_stream` object.","x-found-in":"body"},"priority":{"type":"number","description":"Priority to determine index template precedence when a new data stream or index is created.\nThe index template with the highest priority is chosen.\nIf no priority is specified the template is treated as though it is of priority 0 (lowest priority).\nThis number is not automatically generated by Elasticsearch.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage index templates externally.\nThis number is not automatically generated by Elasticsearch.\nExternal systems can use these version numbers to simplify template management.\nTo unset a version, replace the template without specifying one.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"Optional user metadata about the index template.\nIt may have any contents.\nIt is not automatically generated or used by Elasticsearch.\nThis user-defined object is stored in the cluster state, so keeping it short is preferable\nTo unset the metadata, replace the template without specifying it.","x-found-in":"body"},"allow_auto_create":{"type":"boolean","description":"This setting overrides the value of the `action.auto_create_index` cluster setting.\nIf set to `true` in a template, then indices can be automatically created using that template even if auto-creation of indices is disabled via `actions.auto_create_index`.\nIf set to `false`, then indices or data streams matching the template must always be explicitly created, and may never be automatically created.","x-found-in":"body"},"ignore_missing_component_templates":{"type":"array","items":{"type":"string"},"description":"The configuration option ignore_missing_component_templates can be used when an index template\nreferences a component template that might not exist","x-found-in":"body"},"deprecated":{"type":"boolean","description":"Marks this index template as deprecated. When creating or updating a non-deprecated index template\nthat uses deprecated components, Elasticsearch will emit a deprecation warning.","x-found-in":"body"},"name":{"type":"string","description":"Index or template name","x-found-in":"path"}},"required":["name"],"description":"Create or update an index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\n\nElasticsearch applies templates to new indices based on an wildcard pattern that matches the index name.\nIndex templates are applied during data stream or index creation.\nFor data streams, these settings and mappings are applied when the stream's backing indices are created.\nSettings and mappings specified in a create index API request override any settings or mappings specified in an index template.\nChanges to index templates do not affect existing indices, including the existing backing indices of a data stream.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Multiple matching templates**\n\nIf multiple index templates match the name of a new index or data stream, the template with the highest priority is used.\n\nMultiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities.\n\n**Composing aliases, mappings, and settings**\n\nWhen multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates.\nAny mappings, settings, or aliases from the parent index template are merged in next.\nFinally, any configuration on the index request itself is merged.\nMapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration.\nIf a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one.\nThis recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`.\nIf an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end.\nIf an entry already exists with the same key, then it is overwritten by the new definition."}

package/src/es/json/indices.put_mapping.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_mapping","type":"object","properties":{"date_detection":{"type":"boolean","description":"Controls whether dynamic date detection is enabled.","x-found-in":"body"},"dynamic":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__DynamicMapping","description":"Controls whether new fields are added dynamically.","x-found-in":"body"},"dynamic_date_formats":{"type":"array","items":{"type":"string"},"description":"If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.","x-found-in":"body"},"dynamic_templates":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__DynamicTemplate"}},"description":"Specify dynamic templates for the mapping.","x-found-in":"body"},"_field_names":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__FieldNamesField","description":"Control whether field names are enabled for the index.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.","x-found-in":"body"},"numeric_detection":{"type":"boolean","description":"Automatically map strings into numeric data types for all fields.","x-found-in":"body"},"properties":{"type":"object","additionalProperties":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__Property"},"description":"Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters","x-found-in":"body"},"_routing":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RoutingField","description":"Enable making a routing value required on indexed documents.","x-found-in":"body"},"_source":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__SourceField","description":"Control whether the _source field is enabled on the index.","x-found-in":"body"},"runtime":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Mapping of runtime fields for the index.","x-found-in":"body"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"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"},"write_index_only":{"type":"boolean","description":"If `true`, the mappings are applied only to the current write index for the target.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.","x-found-in":"path"}},"required":["index"],"description":"Update field mappings.\n\nAdd new fields to an existing data stream or index.\nYou can use the update mapping API to:\n\n- Add a new field to an existing index\n- Update mappings for multiple indices in a single request\n- Add new properties to an object field\n- Enable multi-fields for an existing field\n- Update supported mapping parameters\n- Change a field's mapping using reindexing\n- Rename a field using a field alias\n\nLearn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_mapping","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"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":"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"},"write_index_only":{"type":"boolean","description":"If `true`, the mappings are applied only to the current write index for the target.","x-found-in":"query"},"date_detection":{"type":"boolean","description":"Controls whether dynamic date detection is enabled.","x-found-in":"body"},"dynamic":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__DynamicMapping","description":"Controls whether new fields are added dynamically.","x-found-in":"body"},"dynamic_date_formats":{"type":"array","items":{"type":"string"},"description":"If date detection is enabled then new string fields are checked\nagainst 'dynamic_date_formats' and if the value matches then\na new date field is added instead of string.","x-found-in":"body"},"dynamic_templates":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__DynamicTemplate"}},"description":"Specify dynamic templates for the mapping.","x-found-in":"body"},"_field_names":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__FieldNamesField","description":"Control whether field names are enabled for the index.","x-found-in":"body"},"_meta":{"$ref":"./_types.json#/$defs/_types__Metadata","description":"A mapping type can have custom meta data associated with it. These are\nnot used at all by Elasticsearch, but can be used to store\napplication-specific metadata.","x-found-in":"body"},"numeric_detection":{"type":"boolean","description":"Automatically map strings into numeric data types for all fields.","x-found-in":"body"},"properties":{"type":"object","additionalProperties":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__Property"},"description":"Mapping for a field. For new fields, this mapping can include:\n\n- Field name\n- Field data type\n- Mapping parameters","x-found-in":"body"},"_routing":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RoutingField","description":"Enable making a routing value required on indexed documents.","x-found-in":"body"},"_source":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__SourceField","description":"Control whether the _source field is enabled on the index.","x-found-in":"body"},"runtime":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__RuntimeFields","description":"Mapping of runtime fields for the index.","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"A comma-separated list of index names the mapping should be added to (supports wildcards).\nUse `_all` or omit to add the mapping on all indices.","x-found-in":"path"}},"required":["index"],"description":"Update field mappings.\n\nAdd new fields to an existing data stream or index.\nYou can use the update mapping API to:\n\n- Add a new field to an existing index\n- Update mappings for multiple indices in a single request\n- Add new properties to an object field\n- Enable multi-fields for an existing field\n- Update supported mapping parameters\n- Change a field's mapping using reindexing\n- Rename a field using a field alias\n\nLearn how to use the update mapping API with practical examples in the [Update mapping API examples](https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples) guide."}

package/src/es/json/indices.put_settings.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_settings","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`open,hidden`.","x-found-in":"query"},"flat_settings":{"type":"boolean","description":"If `true`, returns settings in flat format.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"preserve_existing":{"type":"boolean","description":"If `true`, existing index settings remain unchanged.","x-found-in":"query"},"reopen":{"type":"boolean","description":"Whether to close and reopen the index to apply non-dynamic settings.\nIf set to `true` the indices to which the settings are being applied\nwill be closed temporarily and then reopened in order to apply the changes.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.","x-found-in":"query"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Update index settings.\n\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nFor performance optimization during bulk indexing, you can disable the refresh interval.\nRefer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.\nThere are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:\n\n```\n{\n  \"number_of_replicas\": 1\n}\n```\n\nOr you can use an `index` setting object:\n```\n{\n  \"index\": {\n    \"number_of_replicas\": 1\n  }\n}\n```\n\nOr you can use dot annotation:\n```\n{\n  \"index.number_of_replicas\": 1\n}\n```\n\nOr you can embed any of the aforementioned options in a `settings` object. For example:\n\n```\n{\n  \"settings\": {\n    \"index\": {\n      \"number_of_replicas\": 1\n    }\n  }\n}\n```\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.\nRefer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_settings","type":"object","properties":{"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match. If the request can target\ndata streams, this argument determines whether wildcard expressions match\nhidden data streams. Supports comma-separated values, such as\n`open,hidden`.","x-found-in":"query"},"flat_settings":{"type":"boolean","description":"If `true`, returns settings in flat format.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an\nerror.","x-found-in":"query"},"preserve_existing":{"type":"boolean","description":"If `true`, existing index settings remain unchanged.","x-found-in":"query"},"reopen":{"type":"boolean","description":"Whether to close and reopen the index to apply non-dynamic settings.\nIf set to `true` the indices to which the settings are being applied\nwill be closed temporarily and then reopened in order to apply the changes.","x-found-in":"query"},"timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a response. If no response is received before the\n timeout expires, the request fails and returns an error.","x-found-in":"query"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","x-found-in":"body"},"index":{"$ref":"./_types.json#/$defs/_types__Indices","description":"Comma-separated list of data streams, indices, and aliases used to limit\nthe request. Supports wildcards (`*`). To target all data streams and\nindices, omit this parameter or use `*` or `_all`.","x-found-in":"path"}},"description":"Update index settings.\n\nChanges dynamic index settings in real time.\nFor data streams, index setting changes are applied to all backing indices by default.\n\nTo revert a setting to the default value, use a null value.\nThe list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation.\nTo preserve existing settings from being updated, set the `preserve_existing` parameter to `true`.\n\nFor performance optimization during bulk indexing, you can disable the refresh interval.\nRefer to [disable refresh interval](https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval) for an example.\nThere are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example:\n\n```\n{\n  \"number_of_replicas\": 1\n}\n```\n\nOr you can use an `index` setting object:\n```\n{\n  \"index\": {\n    \"number_of_replicas\": 1\n  }\n}\n```\n\nOr you can use dot annotation:\n```\n{\n  \"index.number_of_replicas\": 1\n}\n```\n\nOr you can embed any of the aforementioned options in a `settings` object. For example:\n\n```\n{\n  \"settings\": {\n    \"index\": {\n      \"number_of_replicas\": 1\n    }\n  }\n}\n```\n\nNOTE: You can only define new analyzers on closed indices.\nTo add an analyzer, you must close the index, define the analyzer, and reopen the index.\nYou cannot close the write index of a data stream.\nTo update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream.\nThen roll over the data stream to apply the new analyzer to the stream's write index and future backing indices.\nThis affects searches and any new data added to the stream after the rollover.\nHowever, it does not affect the data stream's backing indices or their existing data.\nTo change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it.\nRefer to [updating analyzers on existing indices](https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices) for step-by-step examples."}

package/src/es/json/indices.put_template.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_template","type":"object","properties":{"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the index.","x-found-in":"body"},"index_patterns":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Array of wildcard expressions used to match the names\nof indices during creation.","x-found-in":"body"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.","x-found-in":"body"},"order":{"type":"number","description":"Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.","x-found-in":"query"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.","x-found-in":"body"},"create":{"type":"boolean","description":"If true, this request cannot replace or update existing index templates.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"cause":{"type":"string","description":"User defined reason for creating or updating the index template","x-found-in":"query"},"name":{"type":"string","description":"The name of the template","x-found-in":"path"}},"required":["name"],"description":"Create or update a legacy index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.put_template","type":"object","properties":{"create":{"type":"boolean","description":"If true, this request cannot replace or update existing index templates.","x-found-in":"query"},"master_timeout":{"$ref":"./_types.json#/$defs/_types__Duration","description":"Period to wait for a connection to the master node. If no response is\nreceived before the timeout expires, the request fails and returns an error.","x-found-in":"query"},"order":{"type":"number","description":"Order in which Elasticsearch applies this template if index\nmatches multiple templates.\n\nTemplates with lower 'order' values are merged first. Templates with higher\n'order' values are merged later, overriding templates with lower values.","x-found-in":"body"},"cause":{"type":"string","description":"User defined reason for creating or updating the index template","x-found-in":"query"},"aliases":{"type":"object","additionalProperties":{"$ref":"./indices._types.json#/$defs/indices._types__Alias"},"description":"Aliases for the index.","x-found-in":"body"},"index_patterns":{"anyOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"description":"Array of wildcard expressions used to match the names\nof indices during creation.","x-found-in":"body"},"mappings":{"$ref":"./_types.mapping.json#/$defs/_types.mapping__TypeMapping","description":"Mapping for fields in the index.","x-found-in":"body"},"settings":{"$ref":"./indices._types.json#/$defs/indices._types__IndexSettings","description":"Configuration options for the index.","x-found-in":"body"},"version":{"type":"number","description":"Version number used to manage index templates externally. This number\nis not automatically generated by Elasticsearch.\nTo unset a version, replace the template without specifying one.","x-found-in":"body"},"name":{"type":"string","description":"The name of the template","x-found-in":"path"}},"required":["name"],"description":"Create or update a legacy index template.\n\nIndex templates define settings, mappings, and aliases that can be applied automatically to new indices.\nElasticsearch applies templates to new indices based on an index pattern that matches the index name.\n\nIMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8.\n\nComposable templates always take precedence over legacy templates.\nIf no composable template matches a new index, matching legacy templates are applied according to their order.\n\nIndex templates are only applied during index creation.\nChanges to index templates do not affect existing indices.\nSettings and mappings specified in create index API requests override any settings or mappings specified in an index template.\n\nYou can use C-style `/* *\\/` block comments in index templates.\nYou can include comments anywhere in the request body, except before the opening curly bracket.\n\n**Indices matching multiple templates**\n\nMultiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index.\nThe order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them.\nNOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order."}

package/src/es/json/indices.resolve_index.request.json

@@ -1 +1 @@
-{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.resolve_index","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"mode":{"oneOf":[{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode"},{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode"}}],"description":"Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.","x-found-in":"path"}},"required":["name"],"description":"Resolve indices.\n\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported."}
+{"$schema":"https://json-schema.org/draft/2020-12/schema","title":"indices.resolve_index","type":"object","properties":{"expand_wildcards":{"$ref":"./_types.json#/$defs/_types__ExpandWildcards","description":"Type of index that wildcard patterns can match.\nIf the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.\nSupports comma-separated values, such as `open,hidden`.","x-found-in":"query"},"ignore_unavailable":{"type":"boolean","description":"If `false`, the request returns an error if it targets a concrete (non-wildcarded)\nindex, alias, or data stream that is missing, closed, or otherwise unavailable.\nIf `true`, unavailable concrete targets are silently ignored.","x-found-in":"query"},"allow_no_indices":{"type":"boolean","description":"A setting that does two separate checks on the index expression.\nIf `false`, the request returns an error (1) if any wildcard expression\n(including `_all` and `*`) resolves to zero matching indices or (2) if the\ncomplete set of resolved indices, aliases or data streams is empty after all\nexpressions are evaluated. If `true`, index expressions that resolve to no\nindices are allowed and the request returns an empty result.","x-found-in":"query"},"mode":{"anyOf":[{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode"},{"type":"array","items":{"$ref":"./indices._types.json#/$defs/indices._types__IndexMode"}}],"description":"Filter indices by index mode - standard, lookup, time_series, etc. Comma-separated list of IndexMode. Empty means no filter.","x-found-in":"query"},"name":{"$ref":"./_types.json#/$defs/_types__Names","description":"Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve.\nResources on remote clusters can be specified using the `<cluster>`:`<name>` syntax.","x-found-in":"path"}},"required":["name"],"description":"Resolve indices.\n\nResolve the names and/or index patterns for indices, aliases, and data streams.\nMultiple patterns and remote clusters are supported."}