@elastic/schemas 0.4.4 → 0.5.0

package/lib/es/json/graph.explore.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "graph.explore", "type": "object", "properties": { "connections": { "$ref": "./graph._types.json#/$defs/graph._types__Hop", "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", "x-found-in": "body" }, "controls": { "$ref": "./graph._types.json#/$defs/graph._types__ExploreControls", "description": "Direct the Graph API how to build the graph.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", "x-found-in": "body" }, "vertices": { "type": "array", "items": { "$ref": "./graph._types.json#/$defs/graph._types__VertexDefinition" }, "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", "x-found-in": "body" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "Custom value used to route operations to a specific shard.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Name of the index.", "x-found-in": "path" } }, "required": ["index"], "description": "Explore graph analytics.\n\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "graph.explore", "type": "object", "properties": { "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "Custom value used to route operations to a specific shard.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Specifies the period of time to wait for a response from each shard.\nIf no response is received before the timeout expires, the request fails and returns an error.\nDefaults to no timeout.", "x-found-in": "query" }, "connections": { "$ref": "./graph._types.json#/$defs/graph._types__Hop", "description": "Specifies or more fields from which you want to extract terms that are associated with the specified vertices.", "x-found-in": "body" }, "controls": { "$ref": "./graph._types.json#/$defs/graph._types__ExploreControls", "description": "Direct the Graph API how to build the graph.", "x-found-in": "body" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "A seed query that identifies the documents of interest. Can be any valid Elasticsearch query.", "x-found-in": "body" }, "vertices": { "type": "array", "items": { "$ref": "./graph._types.json#/$defs/graph._types__VertexDefinition" }, "description": "Specifies one or more fields that contain the terms you want to include in the graph as vertices.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "Name of the index.", "x-found-in": "path" } }, "required": ["index"], "description": "Explore graph analytics.\n\nExtract and summarize information about the documents and terms in an Elasticsearch data stream or index.\nThe easiest way to understand the behavior of this API is to use the Graph UI to explore connections.\nAn initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph.\nSubsequent requests enable you to spider out from one more vertices of interest.\nYou can exclude vertices that have already been returned." }

package/lib/es/json/health_report.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "health_report", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Explicit operation timeout.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Opt-in for more information about the health of the system.", "x-found-in": "query" }, "size": { "type": "number", "description": "Limit the number of affected resources the health report API returns.", "x-found-in": "query" }, "feature": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A feature of the cluster, as returned by the top-level health report API.", "x-found-in": "path" } }, "description": "Get the cluster health.\n\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "health_report", "type": "object", "properties": { "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Explicit operation timeout.", "x-found-in": "query" }, "verbose": { "type": "boolean", "description": "Opt-in for more information about the health of the system.", "x-found-in": "query" }, "size": { "type": "number", "description": "Limit the number of affected resources the health report API returns.", "x-found-in": "query" }, "feature": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "A feature of the cluster, as returned by the top-level health report API.", "x-found-in": "path" } }, "description": "Get the cluster health.\n\nGet a report with the health status of an Elasticsearch cluster.\nThe report contains a list of indicators that compose Elasticsearch functionality.\n\nEach indicator has a health status of: green, unknown, yellow or red.\nThe indicator will provide an explanation and metadata describing the reason for its current health status.\n\nThe cluster’s status is controlled by the worst indicator status.\n\nIn the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue.\nEach impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system.\n\nSome health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system.\nThe root cause and remediation steps are encapsulated in a diagnosis.\nA diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem.\n\nNOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently.\nWhen setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic." }

package/lib/es/json/ilm.migrate_to_data_tiers.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.migrate_to_data_tiers", "type": "object", "properties": { "legacy_template_to_delete": { "type": "string", "x-found-in": "body" }, "node_attribute": { "type": "string", "x-found-in": "body" }, "dry_run": { "type": "boolean", "description": "If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.\nThis provides a way to retrieve the indices and ILM policies that need to be migrated.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" } }, "description": "Migrate to data tiers routing.\n\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.migrate_to_data_tiers", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration.\nThis provides a way to retrieve the indices and ILM policies that need to be migrated.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "legacy_template_to_delete": { "type": "string", "x-found-in": "body" }, "node_attribute": { "type": "string", "x-found-in": "body" } }, "description": "Migrate to data tiers routing.\n\nSwitch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers.\nOptionally, delete one legacy index template.\nUsing node roles enables ILM to automatically move the indices between data tiers.\n\nMigrating away from custom node attributes routing can be manually performed.\nThis API provides an automated way of performing three out of the four manual steps listed in the migration guide:\n\n1. Stop setting the custom hot attribute on new indices.\n1. Remove custom allocation settings from existing ILM policies.\n1. Replace custom allocation settings from existing indices with the corresponding tier preference.\n\nILM must be stopped before performing the migration.\nUse the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`." }

package/lib/es/json/ilm.put_lifecycle.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.put_lifecycle", "type": "object", "properties": { "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" } }, "required": ["policy"], "description": "Create or update a lifecycle policy.\n\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ilm.put_lifecycle", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "policy": { "type": "string", "description": "Identifier for the policy.", "x-found-in": "path" } }, "required": ["policy"], "description": "Create or update a lifecycle policy.\n\nIf the specified policy exists, it is replaced and the policy version is incremented.\n\nNOTE: Only the latest version of the policy is stored, you cannot revert to previous versions." }

package/lib/es/json/index.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "index", "type": "object", "properties": { "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "include_source_on_error": { "type": "boolean", "description": "True or false if to include the document source in the error message in case of parsing errors.", "x-found-in": "query" }, "op_type": { "$ref": "./_types.json#/$defs/_types__OpType", "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `<index>/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "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.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", "x-found-in": "query" }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format and omit this parameter.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.", "x-found-in": "path" } }, "required": ["index"], "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior (this parameter is not available in Elasticsearch Serverless).\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter (this parameter is not available in Elasticsearch Serverless).\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n  \"user\": {\n    \"id\": \"elkbee\"\n  }\n}\n```\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "index", "type": "object", "properties": { "if_primary_term": { "type": "number", "description": "Only perform the operation if the document has this primary term.", "x-found-in": "query" }, "if_seq_no": { "type": "number", "description": "Only perform the operation if the document has this sequence number.", "x-found-in": "query" }, "include_source_on_error": { "type": "boolean", "description": "True or false if to include the document source in the error message in case of parsing errors.", "x-found-in": "query" }, "op_type": { "$ref": "./_types.json#/$defs/_types__OpType", "description": "Set to `create` to only index the document if it does not already exist (put if absent).\nIf a document with the specified `_id` already exists, the indexing operation will fail.\nThe behavior is the same as using the `<index>/_create` endpoint.\nIf a document ID is specified, this paramater defaults to `index`.\nOtherwise, it defaults to `create`.\nIf the request targets a data stream, an `op_type` of `create` is required.", "x-found-in": "query" }, "pipeline": { "type": "string", "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request.\nIf a final pipeline is configured it will always run, regardless of the value of this parameter.", "x-found-in": "query" }, "refresh": { "$ref": "./_types.json#/$defs/_types__Refresh", "description": "If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search.\nIf `wait_for`, it waits for a refresh to make this operation visible to search.\nIf `false`, it does nothing with refreshes.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.\nNot allowed when `index.slice.enabled` is `true` for the target index; use `_slice` instead.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation.\nBy default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error.\nThe actual wait time could be longer, particularly when multiple waits occur.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must be a non-negative long number.", "x-found-in": "query" }, "version_type": { "$ref": "./_types.json#/$defs/_types__VersionType", "description": "The version type.", "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.\nYou can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).\nThe default value of `1` means it waits for each primary shard to be active.", "x-found-in": "query" }, "require_alias": { "type": "boolean", "description": "If `true`, the destination must be an index alias.", "x-found-in": "query" }, "require_data_stream": { "type": "boolean", "description": "If `true`, the request's actions must target a data stream (existing or to be created).", "x-found-in": "query" }, "document": { "x-found-in": "body" }, "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format and omit this parameter.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the data stream or index to target.\nIf the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream.\nIf the target doesn't exist and doesn't match a data stream template, this request creates the index.\nYou can check for existing targets with the resolve index API.", "x-found-in": "path" } }, "required": ["index"], "description": "Create or update a document in an index.\n\nAdd a JSON document to the specified data stream or index and make it searchable.\nIf the target is an index and the document already exists, the request updates the document and increments its version.\n\nNOTE: You cannot use this API to send update requests for existing documents in a data stream.\n\nIf the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias:\n\n* To add or overwrite a document using the `PUT /<target>/_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege.\n* To add a document using the `POST /<target>/_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege.\n* To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege.\n\nAutomatic data stream creation requires a matching index template with data stream enabled.\n\nNOTE: Replica shards might not all be started when an indexing operation returns successfully.\nBy default, only the primary is required. Set `wait_for_active_shards` to change this default behavior (this parameter is not available in Elasticsearch Serverless).\n\n**Automatically create data streams and indices**\n\nIf the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream.\n\nIf the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates.\n\nNOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation.\n\nIf no mapping exists, the index operation creates a dynamic mapping.\nBy default, new fields and objects are automatically added to the mapping if needed.\n\nAutomatic index creation is controlled by the `action.auto_create_index` setting.\nIf it is `true`, any index can be created automatically.\nYou can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely.\nSpecify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked.\nWhen a list is specified, the default behaviour is to disallow.\n\nNOTE: The `action.auto_create_index` setting affects the automatic creation of indices only.\nIt does not affect the creation of data streams.\n\n**Optimistic concurrency control**\n\nIndex operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters.\nIf a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`.\n\n**Routing**\n\nBy default, shard placement — or routing — is controlled by using a hash of the document's ID value.\nFor more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter.\n\nWhen setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself.\nThis does come at the (very minimal) cost of an additional document parsing pass.\nIf the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted.\n\nNOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template.\n\n**Distributed**\n\nThe index operation is directed to the primary shard based on its route and performed on the actual node containing this shard.\nAfter the primary shard completes the operation, if needed, the update is distributed to applicable replicas.\n\n**Active shards**\n\nTo improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation.\nIf the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs.\nBy default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`).\nThis default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`.\nTo alter this behavior per operation, use the `wait_for_active_shards request` parameter (this parameter is not available in Elasticsearch Serverless).\n\nValid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1).\nSpecifying a negative value or a number greater than the number of shard copies will throw an error.\n\nFor example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes).\nIf you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding.\nThis means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data.\nIf `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding.\nThis requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard.\nHowever, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index.\nThe operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard.\n\nIt is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts.\nAfter the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary.\nThe `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed.\n\n**No operation (noop) updates**\n\nWhen updating a document by using this API, a new version of the document is always created even if the document hasn't changed.\nIf this isn't acceptable use the `_update` API with `detect_noop` set to `true`.\nThe `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source.\n\nThere isn't a definitive rule for when noop updates aren't acceptable.\nIt's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates.\n\n**Versioning**\n\nEach indexed document is given a version number.\nBy default, internal versioning is used that starts at 1 and increments with each update, deletes included.\nOptionally, the version number can be set to an external value (for example, if maintained in a database).\nTo enable this functionality, `version_type` should be set to `external`.\nThe value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`.\n\nNOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations.\nIf no version is provided, the operation runs without any version checks.\n\nWhen using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document.\nIf true, the document will be indexed and the new version number used.\nIf the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example:\n\n```\nPUT my-index-000001/_doc/1?version=2&version_type=external\n{\n  \"user\": {\n    \"id\": \"elkbee\"\n  }\n}\n```\n\nIn this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1.\nIf the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code).\n\nA nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used.\nEven the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order." }

package/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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/lib/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." }

package/lib/es/json/indices.rollover.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.rollover", "type": "object", "properties": { "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the target index.\nData streams do not support this parameter.", "x-found-in": "body" }, "conditions": { "$ref": "./indices.rollover.json#/$defs/indices.rollover__RolloverConditions", "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", "x-found-in": "body" }, "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 paramaters.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the index.\nData streams do not support this parameter.", "x-found-in": "body" }, "dry_run": { "type": "boolean", "description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.", "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" }, "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" }, "lazy": { "type": "boolean", "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.", "x-found-in": "query" }, "alias": { "type": "string", "description": "Name of the data stream or index alias to roll over.", "x-found-in": "path" }, "new_index": { "type": "string", "description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.", "x-found-in": "path" } }, "required": ["alias"], "description": "Roll over to a new index.\n\nTIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.rollover", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover.", "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" }, "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" }, "lazy": { "type": "boolean", "description": "If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write.\nOnly allowed on data streams.", "x-found-in": "query" }, "aliases": { "type": "object", "additionalProperties": { "$ref": "./indices._types.json#/$defs/indices._types__Alias" }, "description": "Aliases for the target index.\nData streams do not support this parameter.", "x-found-in": "body" }, "conditions": { "$ref": "./indices.rollover.json#/$defs/indices.rollover__RolloverConditions", "description": "Conditions for the rollover.\nIf specified, Elasticsearch only performs the rollover if the current index satisfies these conditions.\nIf this parameter is not specified, Elasticsearch performs the rollover unconditionally.\nIf conditions are specified, at least one of them must be a `max_*` condition.\nThe index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied.", "x-found-in": "body" }, "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 paramaters.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Configuration options for the index.\nData streams do not support this parameter.", "x-found-in": "body" }, "alias": { "type": "string", "description": "Name of the data stream or index alias to roll over.", "x-found-in": "path" }, "new_index": { "type": "string", "description": "Name of the index to create.\nSupports date math.\nData streams do not support this parameter.", "x-found-in": "path" } }, "required": ["alias"], "description": "Roll over to a new index.\n\nTIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context.\n\nThe rollover API creates a new index for a data stream or index alias.\nThe API behavior depends on the rollover target.\n\n**Roll over a data stream**\n\nIf you roll over a data stream, the API creates a new write index for the stream.\nThe stream's previous write index becomes a regular backing index.\nA rollover also increments the data stream's generation.\n\n**Roll over an index alias with a write index**\n\nTIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data.\nData streams replace this functionality, require less maintenance, and automatically integrate with data tiers.\n\nIf an index alias points to multiple indices, one of the indices must be a write index.\nThe rollover API creates a new write index for the alias with `is_write_index` set to `true`.\nThe API also `sets is_write_index` to `false` for the previous write index.\n\n**Roll over an index alias with one index**\n\nIf you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias.\n\nNOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting.\n\n**Increment index names for an alias**\n\nWhen you roll over an index alias, you can specify a name for the new index.\nIf you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number.\nFor example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`.\nThis number is always six characters and zero-padded, regardless of the previous index's name.\n\nIf you use an index alias for time series data, you can use date math in the index name to track the rollover date.\nFor example, you can create an alias that points to an index named `<my-index-{now/d}-000001>`.\nIf you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`.\nIf you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`." }

package/lib/es/json/indices.shard_stores.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shard_stores", "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 data streams,\nthis argument determines whether wildcard expressions match hidden data streams.", "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" }, "status": { "oneOf": [{ "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" }, { "type": "array", "items": { "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" } }], "description": "List of shard health statuses used to limit the request.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "List of data streams, indices, and aliases used to limit the request.", "x-found-in": "path" } }, "description": "Get index shard stores.\n\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "indices.shard_stores", "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 data streams,\nthis argument determines whether wildcard expressions match hidden data streams.", "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" }, "status": { "anyOf": [{ "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" }, { "type": "array", "items": { "$ref": "./indices.shard_stores.json#/$defs/indices.shard_stores__ShardStoreStatus" } }], "description": "List of shard health statuses used to limit the request.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "List of data streams, indices, and aliases used to limit the request.", "x-found-in": "path" } }, "description": "Get index shard stores.\n\nGet store information about replica shards in one or more indices.\nFor data streams, the API retrieves store information for the stream's backing indices.\n\nThe index shard stores API returns the following information:\n\n* The node on which each replica shard exists.\n* The allocation ID for each replica shard.\n* A unique ID for each replica shard.\n* Any errors encountered while opening the shard index or from an earlier failure.\n\nBy default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards." }