@elastic/schemas 0.4.3 → 0.4.5

package/lib/cjs/es/json/ccr.put_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.put_auto_follow_pattern", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the collection of auto-follow patterns.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader indices to match against.", "x-found-in": "body" }, "follow_index_pattern": { "type": "string", "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", "x-found-in": "body" }, "leader_index_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", "x-found-in": "body" }, "leader_index_exclusion_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" } }, "required": ["name", "remote_cluster"], "description": "Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.put_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "remote_cluster": { "type": "string", "description": "The remote cluster containing the leader indices to match against.", "x-found-in": "body" }, "follow_index_pattern": { "type": "string", "description": "The name of follower index. The template {{leader_index}} can be used to derive the name of the follower index from the name of the leader index. When following a data stream, use {{leader_index}}; CCR does not support changes to the names of a follower data stream’s backing indices.", "x-found-in": "body" }, "leader_index_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns to match against indices in the remote cluster specified by the remote_cluster field.", "x-found-in": "body" }, "leader_index_exclusion_patterns": { "$ref": "./_types.json#/$defs/_types__IndexPatterns", "description": "An array of simple index patterns that can be used to exclude indices from being auto-followed. Indices in the remote cluster whose names are matching one or more leader_index_patterns and one or more leader_index_exclusion_patterns won’t be followed.", "x-found-in": "body" }, "max_outstanding_read_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "settings": { "type": "object", "additionalProperties": {}, "description": "Settings to override from the leader index. Note that certain settings can not be overrode (e.g., index.number_of_shards).", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "description": "The maximum number of outstanding reads requests from the remote cluster.", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for new operations on the remote cluster when the follower index is synchronized with the leader index. When the timeout has elapsed, the poll for operations will return to the follower so that it can update some statistics. Then the follower will immediately attempt to read from the leader again.", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "description": "The maximum number of operations to pull per read from the remote cluster.", "x-found-in": "body" }, "max_read_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum size in bytes of per read of a batch of operations pulled from the remote cluster.", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait before retrying an operation that failed exceptionally. An exponential backoff strategy is employed when retrying.", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "description": "The maximum number of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the number of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_buffer_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations that can be queued for writing. When this limit is reached, reads from the remote cluster will be deferred until the total bytes of queued operations goes below the limit.", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "description": "The maximum number of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "max_write_request_size": { "$ref": "./_types.json#/$defs/_types__ByteSize", "description": "The maximum total bytes of operations per bulk write request executed on the follower.", "x-found-in": "body" }, "name": { "type": "string", "description": "The name of the collection of auto-follow patterns.", "x-found-in": "path" } }, "required": ["name", "remote_cluster"], "description": "Create or update auto-follow patterns.\n\nCreate a collection of cross-cluster replication auto-follow patterns for a remote cluster.\nNewly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices.\nIndices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern.\n\nThis API can also be used to update auto-follow patterns.\nNOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns." }

package/lib/cjs/es/json/ccr.resume_auto_follow_pattern.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_auto_follow_pattern", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the auto-follow pattern to resume.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" } }, "required": ["name"], "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_auto_follow_pattern", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "name": { "type": "string", "description": "The name of the auto-follow pattern to resume.", "x-found-in": "path" } }, "required": ["name"], "description": "Resume an auto-follow pattern.\n\nResume a cross-cluster replication auto-follow pattern that was paused.\nThe auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster.\nRemote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim." }

package/lib/cjs/es/json/ccr.resume_follow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_follow", "type": "object", "properties": { "index": { "type": "string", "description": "Name of the follow index to resume following", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "max_outstanding_read_requests": { "type": "number", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_read_request_size": { "type": "string", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "x-found-in": "body" }, "max_write_buffer_size": { "type": "string", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_write_request_size": { "type": "string", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" } }, "required": ["index"], "description": "Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.resume_follow", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Period to wait for a connection to the master node.", "x-found-in": "query" }, "max_outstanding_read_requests": { "type": "number", "x-found-in": "body" }, "max_outstanding_write_requests": { "type": "number", "x-found-in": "body" }, "max_read_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_read_request_size": { "type": "string", "x-found-in": "body" }, "max_retry_delay": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "max_write_buffer_count": { "type": "number", "x-found-in": "body" }, "max_write_buffer_size": { "type": "string", "x-found-in": "body" }, "max_write_request_operation_count": { "type": "number", "x-found-in": "body" }, "max_write_request_size": { "type": "string", "x-found-in": "body" }, "read_poll_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "x-found-in": "body" }, "index": { "type": "string", "description": "Name of the follow index to resume following", "x-found-in": "path" } }, "required": ["index"], "description": "Resume a follower.\n\nResume a cross-cluster replication follower index that was paused.\nThe follower index could have been paused with the pause follower API.\nAlternatively it could be paused due to replication that cannot be retried due to failures during following tasks.\nWhen this API returns, the follower index will resume fetching operations from the leader index." }

package/lib/cjs/es/json/ccr.unfollow.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.unfollow", "type": "object", "properties": { "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" } }, "required": ["index"], "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "ccr.unfollow", "type": "object", "properties": { "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf the master node is not available before the timeout expires, the request fails and returns an error.\nIt can also be set to `-1` to indicate that the request should never timeout.", "x-found-in": "query" }, "index": { "type": "string", "description": "The name of the follower index.", "x-found-in": "path" } }, "required": ["index"], "description": "Unfollow an index.\n\nConvert a cross-cluster replication follower index to a regular index.\nThe API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication.\nThe follower index must be paused and closed before you call the unfollow API.\n\n> info\n> Currently cross-cluster replication does not support converting an existing regular index to a follower index. Converting a follower index to a regular index is an irreversible operation." }

package/lib/cjs/es/json/clear_scroll.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "clear_scroll", "type": "object", "properties": { "scroll_id": { "$ref": "./_types.json#/$defs/_types__ScrollIds", "description": "The scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.", "x-found-in": "body" } }, "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "clear_scroll", "type": "object", "properties": { "scroll_id": { "$ref": "./_types.json#/$defs/_types__ScrollIds", "description": "A comma-separated list of scroll IDs to clear.\nTo clear all scroll IDs, use `_all`.\nIMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter.", "x-found-in": "body" } }, "description": "Clear a scrolling search.\n\nClear the search context and results for a scrolling search." }

package/lib/cjs/es/json/cluster.delete_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.delete_component_template", "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", "x-found-in": "path" }, "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" } }, "required": ["name"], "description": "Delete component templates.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.delete_component_template", "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" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list or wildcard expression of component template names used to limit the request.", "x-found-in": "path" } }, "required": ["name"], "description": "Delete component templates.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases." }

package/lib/cjs/es/json/cluster.exists_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.exists_component_template", "type": "object", "properties": { "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", "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\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", "x-found-in": "query" } }, "required": ["name"], "description": "Check component templates.\n\nReturns information about whether a particular component template exists." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.exists_component_template", "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\nreceived before the timeout expires, the request fails and returns an\nerror.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, the request retrieves information from the local node only.\nDefaults to false, which means information is retrieved from the master node.", "x-found-in": "query" }, "name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "Comma-separated list of component template names used to limit the request.\nWildcard (*) expressions are supported.", "x-found-in": "path" } }, "required": ["name"], "description": "Check component templates.\n\nReturns information about whether a particular component template exists." }

package/lib/cjs/es/json/cluster.get_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_component_template", "type": "object", "properties": { "name": { "type": "string", "description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", "x-found-in": "path" }, "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "settings_filter": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "Return all default configurations for the component template", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "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" } }, "description": "Get component templates.\n\nGet information about component templates." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.get_component_template", "type": "object", "properties": { "flat_settings": { "type": "boolean", "description": "If `true`, returns settings in flat format.", "x-found-in": "query" }, "settings_filter": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys", "x-found-in": "query" }, "include_defaults": { "type": "boolean", "description": "Return all default configurations for the component template", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If `true`, the request retrieves information from the local node only.\nIf `false`, information is retrieved from the master node.", "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" }, "name": { "type": "string", "description": "Name of component template to retrieve. Wildcard (`*`) expressions are supported.", "x-found-in": "path" } }, "description": "Get component templates.\n\nGet information about component templates." }

package/lib/cjs/es/json/cluster.health.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.health", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.", "x-found-in": "path" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__Level", "description": "Return health information at a specific level of detail.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.", "x-found-in": "query" }, "wait_for_events": { "$ref": "./_types.json#/$defs/_types__WaitForEvents", "description": "Wait until all currently queued events with the given priority are processed.", "x-found-in": "query" }, "wait_for_nodes": { "$ref": "./cluster.health.json#/$defs/cluster.health__WaitForNodes", "description": "Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `<N`.\nAlternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.", "x-found-in": "query" }, "wait_for_no_initializing_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard initializations.\nIf false, the request does not wait for initializing shards.", "x-found-in": "query" }, "wait_for_no_relocating_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard relocations.\nIf false, the request not wait for relocating shards.", "x-found-in": "query" }, "wait_for_status": { "$ref": "./_types.json#/$defs/_types__HealthStatus", "description": "Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).\nA green status is better than yellow and yellow is better than red.\nBy default, the request does not wait for a particular status.", "x-found-in": "query" } }, "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.health", "type": "object", "properties": { "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "Expand wildcard expression to concrete indices that are open, closed or both.", "x-found-in": "query" }, "level": { "$ref": "./_types.json#/$defs/_types__Level", "description": "Return health information at a specific level of detail.", "x-found-in": "query" }, "local": { "type": "boolean", "description": "If true, retrieve information from the local node only.\nIf false, retrieve information from the master node.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.\nIf no response is received before the timeout expires, the request fails and returns an error.", "x-found-in": "query" }, "wait_for_active_shards": { "$ref": "./_types.json#/$defs/_types__WaitForActiveShards", "description": "Wait for the specified number of active shards.\nUse `all` to wait for all shards in the cluster to be active.\nUse `0` to not wait.", "x-found-in": "query" }, "wait_for_events": { "$ref": "./_types.json#/$defs/_types__WaitForEvents", "description": "Wait until all currently queued events with the given priority are processed.", "x-found-in": "query" }, "wait_for_nodes": { "$ref": "./cluster.health.json#/$defs/cluster.health__WaitForNodes", "description": "Wait until the specified number (N) of nodes is available.\nIt also accepts `>=N`, `<=N`, `>N` and `<N`.\nAlternatively, use the notations `ge(N)`, `le(N)`, `gt(N)`, and `lt(N)`.", "x-found-in": "query" }, "wait_for_no_initializing_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard initializations.\nIf false, the request does not wait for initializing shards.", "x-found-in": "query" }, "wait_for_no_relocating_shards": { "type": "boolean", "description": "Wait (until the timeout expires) for the cluster to have no shard relocations.\nIf false, the request not wait for relocating shards.", "x-found-in": "query" }, "wait_for_status": { "$ref": "./_types.json#/$defs/_types__HealthStatus", "description": "Wait (until the timeout expires) for the cluster to reach a specific health status (or a better status).\nA green status is better than yellow and yellow is better than red.\nBy default, the request does not wait for a particular status.", "x-found-in": "query" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and index aliases that limit the request.\nWildcard expressions (`*`) are supported.\nTo target all data streams and indices in a cluster, omit this parameter or use _all or `*`.", "x-found-in": "path" } }, "description": "Get the cluster health status.\n\nYou can also use the API to get the health status of only specified data streams and indices.\nFor data streams, the API retrieves the health status of the stream’s backing indices.\n\nThe cluster health status is: green, yellow or red.\nOn the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated.\nThe index level status is controlled by the worst shard status.\n\nOne of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level.\nThe cluster status is controlled by the worst index status." }

package/lib/cjs/es/json/cluster.put_component_template.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_component_template", "type": "object", "properties": { "name": { "type": "string", "description": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", "x-found-in": "path" }, "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing component templates.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for create the component template.", "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" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", "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" } }, "required": ["name", "template"], "description": "Create or update a component template.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.put_component_template", "type": "object", "properties": { "create": { "type": "boolean", "description": "If `true`, this request cannot replace or update existing component templates.", "x-found-in": "query" }, "cause": { "type": "string", "description": "User defined reason for create the component template.", "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" }, "template": { "$ref": "./indices.put_index_template.json#/$defs/indices.put_index_template__IndexTemplateMapping", "description": "The template to be applied which includes mappings, settings, or aliases configuration.", "x-found-in": "body" }, "version": { "type": "number", "description": "Version number used to manage component templates externally.\nThis number isn't automatically generated or incremented by Elasticsearch.\nTo unset a version, replace the template without specifying a version.", "x-found-in": "body" }, "_meta": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "Optional user metadata about the component template.\nIt may have any contents. This map is not automatically generated by Elasticsearch.\nThis information is stored in the cluster state, so keeping it short is preferable.\nTo unset `_meta`, replace the template without specifying this information.", "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": "Name of the component template to create.\nElasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`.\nElastic Agent uses these templates to configure backing indices for its data streams.\nIf you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version.\nIf you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API.", "x-found-in": "path" } }, "required": ["name", "template"], "description": "Create or update a component template.\n\nComponent templates are building blocks for constructing index templates that specify index mappings, settings, and aliases.\n\nAn index template can be composed of multiple component templates.\nTo use a component template, specify it in an index template’s `composed_of` list.\nComponent templates are only applied to new data streams and indices as part of a matching index template.\n\nSettings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template.\n\nComponent templates are only used during index creation.\nFor data streams, this includes data stream creation and the creation of a stream’s backing indices.\nChanges to component templates do not affect existing indices, including a stream’s backing indices.\n\nYou can use C-style `/* *\\/` block comments in component templates.\nYou can include comments anywhere in the request body except before the opening curly bracket.\n\n**Applying component templates**\n\nYou cannot directly apply a component template to a data stream or index.\nTo be applied, a component template must be included in an index template's `composed_of` list." }

package/lib/cjs/es/json/cluster.reroute.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.reroute", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, then the request simulates the operation.\nIt will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, then the response contains an explanation of why the commands can or cannot run.", "x-found-in": "query" }, "metric": { "oneOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Limits the information returned to the specified metrics.", "x-found-in": "query" }, "retry_failed": { "type": "boolean", "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", "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 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" }, "commands": { "type": "array", "items": { "$ref": "./cluster.reroute.json#/$defs/cluster.reroute__Command" }, "description": "Defines the commands to perform.", "x-found-in": "body" } }, "description": "Reroute the cluster.\n\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.reroute", "type": "object", "properties": { "dry_run": { "type": "boolean", "description": "If true, then the request simulates the operation.\nIt will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.", "x-found-in": "query" }, "explain": { "type": "boolean", "description": "If true, then the response contains an explanation of why the commands can or cannot run.", "x-found-in": "query" }, "metric": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Limits the information returned to the specified metrics.", "x-found-in": "query" }, "retry_failed": { "type": "boolean", "description": "If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.", "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 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" }, "commands": { "type": "array", "items": { "$ref": "./cluster.reroute.json#/$defs/cluster.reroute__Command" }, "description": "Defines the commands to perform.", "x-found-in": "body" } }, "description": "Reroute the cluster.\n\nManually change the allocation of individual shards in the cluster.\nFor example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node.\n\nIt is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state.\nFor example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out.\n\nThe cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting.\nIf allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing.\n\nThe cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated.\nThis scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes.\n\nOnce the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards." }

package/lib/cjs/es/json/cluster.state.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.state", "type": "object", "properties": { "metric": { "$ref": "./cluster.state.json#/$defs/cluster.state__ClusterStateMetrics", "description": "Limit the information returned to the specified metrics.", "x-found-in": "path" }, "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" }, "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" }, "flat_settings": { "type": "boolean", "description": "Return 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" }, "local": { "type": "boolean", "description": "Return local information, do not retrieve the state from master node", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout for waiting for new cluster state in case it is blocked", "x-found-in": "query" }, "wait_for_metadata_version": { "type": "number", "description": "Wait for the metadata version to be equal or greater than the specified metadata version", "x-found-in": "query" }, "wait_for_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for wait_for_metadata_version before timing out", "x-found-in": "query" } }, "description": "Get the cluster state.\n\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "cluster.state", "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" }, "flat_settings": { "type": "boolean", "description": "Return 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" }, "local": { "type": "boolean", "description": "Return local information, do not retrieve the state from master node", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "Timeout for waiting for new cluster state in case it is blocked", "x-found-in": "query" }, "wait_for_metadata_version": { "type": "number", "description": "Wait for the metadata version to be equal or greater than the specified metadata version", "x-found-in": "query" }, "wait_for_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The maximum time to wait for wait_for_metadata_version before timing out", "x-found-in": "query" }, "metric": { "$ref": "./cluster.state.json#/$defs/cluster.state__ClusterStateMetrics", "description": "Limit the information returned to the specified metrics.", "x-found-in": "path" }, "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": "Get the cluster state.\n\nGet comprehensive information about the state of the cluster.\n\nThe cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.\n\nThe elected master node ensures that every node in the cluster has a copy of the same cluster state.\nThis API lets you retrieve a representation of this internal state for debugging or diagnostic purposes.\nYou may need to consult the Elasticsearch source code to determine the precise meaning of the response.\n\nBy default the API will route requests to the elected master node since this node is the authoritative source of cluster states.\nYou can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter.\n\nElasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data.\nIf you use this API repeatedly, your cluster may become unstable.\n\nWARNING: The response is a representation of an internal data structure.\nIts format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version.\nDo not query this API using external monitoring tools.\nInstead, obtain the information you require using other more stable cluster APIs." }

package/lib/cjs/es/json/connector.delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.delete", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be deleted", "x-found-in": "path" }, "delete_sync_jobs": { "type": "boolean", "description": "A flag indicating if associated sync jobs should be also removed.", "x-found-in": "query" }, "hard": { "type": "boolean", "description": "A flag indicating if the connector should be hard deleted.", "x-found-in": "query" } }, "required": ["connector_id"], "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.delete", "type": "object", "properties": { "delete_sync_jobs": { "type": "boolean", "description": "A flag indicating if associated sync jobs should be also removed.", "x-found-in": "query" }, "hard": { "type": "boolean", "description": "A flag indicating if the connector should be hard deleted.", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be deleted", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Delete a connector.\n\nRemoves a connector and associated sync jobs.\nThis is a destructive action that is not recoverable.\nNOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.\nThese need to be removed manually." }

package/lib/cjs/es/json/connector.get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.get", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector", "x-found-in": "path" }, "include_deleted": { "type": "boolean", "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", "x-found-in": "query" } }, "required": ["connector_id"], "description": "Get a connector.\n\nGet the details about a connector." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.get", "type": "object", "properties": { "include_deleted": { "type": "boolean", "description": "A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Get a connector.\n\nGet the details about a connector." }

package/lib/cjs/es/json/connector.put.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.put", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.", "x-found-in": "path" }, "description": { "type": "string", "x-found-in": "body" }, "index_name": { "type": "string", "x-found-in": "body" }, "is_native": { "type": "boolean", "x-found-in": "body" }, "language": { "type": "string", "x-found-in": "body" }, "name": { "type": "string", "x-found-in": "body" }, "service_type": { "type": "string", "x-found-in": "body" } }, "description": "Create or update a connector." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.put", "type": "object", "properties": { "description": { "type": "string", "x-found-in": "body" }, "index_name": { "type": "string", "x-found-in": "body" }, "is_native": { "type": "boolean", "x-found-in": "body" }, "language": { "type": "string", "x-found-in": "body" }, "name": { "type": "string", "x-found-in": "body" }, "service_type": { "type": "string", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.", "x-found-in": "path" } }, "description": "Create or update a connector." }

package/lib/cjs/es/json/connector.sync_job_claim.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_claim", "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job.", "x-found-in": "path" }, "sync_cursor": { "description": "The cursor object from the last incremental sync job.\nThis should reference the `sync_cursor` field in the connector state for which the job runs.", "x-found-in": "body" }, "worker_hostname": { "type": "string", "description": "The host name of the current system that will run the job.", "x-found-in": "body" } }, "required": ["connector_sync_job_id", "worker_hostname"], "description": "Claim a connector sync job.\n\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_claim", "type": "object", "properties": { "sync_cursor": { "description": "The cursor object from the last incremental sync job.\nThis should reference the `sync_cursor` field in the connector state for which the job runs.", "x-found-in": "body" }, "worker_hostname": { "type": "string", "description": "The host name of the current system that will run the job.", "x-found-in": "body" }, "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job.", "x-found-in": "path" } }, "required": ["connector_sync_job_id", "worker_hostname"], "description": "Claim a connector sync job.\n\nThis action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time.\nAdditionally, it can set the `sync_cursor` property for the sync job.\n\nThis API is not intended for direct connector management by users.\nIt supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }

package/lib/cjs/es/json/connector.sync_job_error.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_error", "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier for the connector sync job.", "x-found-in": "path" }, "error": { "type": "string", "description": "The error for the connector sync job error field.", "x-found-in": "body" } }, "required": ["connector_sync_job_id", "error"], "description": "Set a connector sync job error.\n\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_error", "type": "object", "properties": { "error": { "type": "string", "description": "The error for the connector sync job error field.", "x-found-in": "body" }, "connector_sync_job_id": { "type": "string", "description": "The unique identifier for the connector sync job.", "x-found-in": "path" } }, "required": ["connector_sync_job_id", "error"], "description": "Set a connector sync job error.\n\nSet the `error` field for a connector sync job and set its `status` to `error`.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }

package/lib/cjs/es/json/connector.sync_job_list.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_list", "type": "object", "properties": { "from": { "type": "number", "description": "Starting offset", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies a max number of results to get", "x-found-in": "query" }, "status": { "$ref": "./connector._types.json#/$defs/connector._types__SyncStatus", "description": "A sync job status to fetch connector sync jobs for", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "A connector id to fetch connector sync jobs for", "x-found-in": "query" }, "job_type": { "oneOf": [{ "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" }, { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" } }], "description": "A comma-separated list of job types to fetch the sync jobs for", "x-found-in": "query" } }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_list", "type": "object", "properties": { "from": { "type": "number", "description": "Starting offset", "x-found-in": "query" }, "size": { "type": "number", "description": "Specifies a max number of results to get", "x-found-in": "query" }, "status": { "$ref": "./connector._types.json#/$defs/connector._types__SyncStatus", "description": "A sync job status to fetch connector sync jobs for", "x-found-in": "query" }, "connector_id": { "type": "string", "description": "A connector id to fetch connector sync jobs for", "x-found-in": "query" }, "job_type": { "anyOf": [{ "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" }, { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType" } }], "description": "A comma-separated list of job types to fetch the sync jobs for", "x-found-in": "query" } }, "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order." }

package/lib/cjs/es/json/connector.sync_job_update_stats.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_update_stats", "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job.", "x-found-in": "path" }, "deleted_document_count": { "type": "number", "description": "The number of documents the sync job deleted.", "x-found-in": "body" }, "indexed_document_count": { "type": "number", "description": "The number of documents the sync job indexed.", "x-found-in": "body" }, "indexed_document_volume": { "type": "number", "description": "The total size of the data (in MiB) the sync job indexed.", "x-found-in": "body" }, "last_seen": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The timestamp to use in the `last_seen` property for the connector sync job.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "The connector-specific metadata.", "x-found-in": "body" }, "total_document_count": { "type": "number", "description": "The total number of documents in the target index after the sync job finished.", "x-found-in": "body" } }, "required": ["connector_sync_job_id", "deleted_document_count", "indexed_document_count", "indexed_document_volume"], "description": "Set the connector sync job stats.\n\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_update_stats", "type": "object", "properties": { "deleted_document_count": { "type": "number", "description": "The number of documents the sync job deleted.", "x-found-in": "body" }, "indexed_document_count": { "type": "number", "description": "The number of documents the sync job indexed.", "x-found-in": "body" }, "indexed_document_volume": { "type": "number", "description": "The total size of the data (in MiB) the sync job indexed.", "x-found-in": "body" }, "last_seen": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The timestamp to use in the `last_seen` property for the connector sync job.", "x-found-in": "body" }, "metadata": { "$ref": "./_types.json#/$defs/_types__Metadata", "description": "The connector-specific metadata.", "x-found-in": "body" }, "total_document_count": { "type": "number", "description": "The total number of documents in the target index after the sync job finished.", "x-found-in": "body" }, "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job.", "x-found-in": "path" } }, "required": ["connector_sync_job_id", "deleted_document_count", "indexed_document_count", "indexed_document_volume"], "description": "Set the connector sync job stats.\n\nStats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`.\nYou can also update `last_seen`.\nThis API is mainly used by the connector service for updating sync job information.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }

package/lib/cjs/es/json/connector.update_api_key_id.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_api_key_id", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "api_key_id": { "type": "string", "x-found-in": "body" }, "api_key_secret_id": { "type": "string", "x-found-in": "body" } }, "required": ["connector_id"], "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_api_key_id", "type": "object", "properties": { "api_key_id": { "type": "string", "x-found-in": "body" }, "api_key_secret_id": { "type": "string", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Update the connector API key ID.\n\nUpdate the `api_key_id` and `api_key_secret_id` fields of a connector.\nYou can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored.\nThe connector secret ID is required only for Elastic managed (native) connectors.\nSelf-managed connectors (connector clients) do not use this field." }

package/lib/cjs/es/json/connector.update_configuration.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_configuration", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "configuration": { "$ref": "./connector._types.json#/$defs/connector._types__ConnectorConfiguration", "x-found-in": "body" }, "values": { "type": "object", "additionalProperties": {}, "x-found-in": "body" } }, "required": ["connector_id"], "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_configuration", "type": "object", "properties": { "configuration": { "$ref": "./connector._types.json#/$defs/connector._types__ConnectorConfiguration", "x-found-in": "body" }, "values": { "type": "object", "additionalProperties": {}, "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document." }

package/lib/cjs/es/json/connector.update_error.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_error", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "error": { "$ref": "./_spec_utils.json#/$defs/_spec_utils__WithNullValue", "x-found-in": "body" } }, "required": ["connector_id", "error"], "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_error", "type": "object", "properties": { "error": { "$ref": "./_spec_utils.json#/$defs/_spec_utils__WithNullValue", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "error"], "description": "Update the connector error field.\n\nSet the error field for the connector.\nIf the error provided in the request body is non-null, the connector’s status is updated to error.\nOtherwise, if the error is reset to null, the connector status is updated to connected." }

package/lib/cjs/es/json/connector.update_features.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_features", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated.", "x-found-in": "path" }, "features": { "$ref": "./connector._types.json#/$defs/connector._types__ConnectorFeatures", "x-found-in": "body" } }, "required": ["connector_id", "features"], "description": "Update the connector features.\n\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_features", "type": "object", "properties": { "features": { "$ref": "./connector._types.json#/$defs/connector._types__ConnectorFeatures", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated.", "x-found-in": "path" } }, "required": ["connector_id", "features"], "description": "Update the connector features.\n\nUpdate the connector features in the connector document.\nThis API can be used to control the following aspects of a connector:\n\n* document-level security\n* incremental syncs\n* advanced sync rules\n* basic sync rules\n\nNormally, the running connector service automatically manages these features.\nHowever, you can use this API to override the default behavior.\n\nTo sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.\nThis service runs automatically on Elastic Cloud for Elastic managed connectors." }

package/lib/cjs/es/json/connector.update_filtering.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "filtering": { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringConfig" }, "x-found-in": "body" }, "rules": { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringRule" }, "x-found-in": "body" }, "advanced_snippet": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringAdvancedSnippet", "x-found-in": "body" } }, "required": ["connector_id"], "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering", "type": "object", "properties": { "filtering": { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringConfig" }, "x-found-in": "body" }, "rules": { "type": "array", "items": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringRule" }, "x-found-in": "body" }, "advanced_snippet": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringAdvancedSnippet", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Update the connector filtering.\n\nUpdate the draft filtering configuration of a connector and marks the draft validation state as edited.\nThe filtering draft is activated once validated by the running Elastic connector service.\nThe filtering property is used to configure sync rules (both basic and advanced) for a connector." }

package/lib/cjs/es/json/connector.update_filtering_validation.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering_validation", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "validation": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringRulesValidation", "x-found-in": "body" } }, "required": ["connector_id", "validation"], "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering_validation", "type": "object", "properties": { "validation": { "$ref": "./connector._types.json#/$defs/connector._types__FilteringRulesValidation", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "validation"], "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector." }

package/lib/cjs/es/json/connector.update_index_name.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_index_name", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "index_name": { "$ref": "./_spec_utils.json#/$defs/_spec_utils__WithNullValue", "x-found-in": "body" } }, "required": ["connector_id", "index_name"], "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_index_name", "type": "object", "properties": { "index_name": { "$ref": "./_spec_utils.json#/$defs/_spec_utils__WithNullValue", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "index_name"], "description": "Update the connector index name.\n\nUpdate the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored." }

package/lib/cjs/es/json/connector.update_name.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_name", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "name": { "type": "string", "x-found-in": "body" }, "description": { "type": "string", "x-found-in": "body" } }, "required": ["connector_id"], "description": "Update the connector name and description." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_name", "type": "object", "properties": { "name": { "type": "string", "x-found-in": "body" }, "description": { "type": "string", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id"], "description": "Update the connector name and description." }

package/lib/cjs/es/json/connector.update_native.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_native", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "is_native": { "type": "boolean", "x-found-in": "body" } }, "required": ["connector_id", "is_native"], "description": "Update the connector is_native flag." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_native", "type": "object", "properties": { "is_native": { "type": "boolean", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "is_native"], "description": "Update the connector is_native flag." }

package/lib/cjs/es/json/connector.update_pipeline.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_pipeline", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "pipeline": { "$ref": "./connector._types.json#/$defs/connector._types__IngestPipelineParams", "x-found-in": "body" } }, "required": ["connector_id", "pipeline"], "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_pipeline", "type": "object", "properties": { "pipeline": { "$ref": "./connector._types.json#/$defs/connector._types__IngestPipelineParams", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "pipeline"], "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings." }

package/lib/cjs/es/json/connector.update_scheduling.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_scheduling", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "scheduling": { "$ref": "./connector._types.json#/$defs/connector._types__SchedulingConfiguration", "x-found-in": "body" } }, "required": ["connector_id", "scheduling"], "description": "Update the connector scheduling." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_scheduling", "type": "object", "properties": { "scheduling": { "$ref": "./connector._types.json#/$defs/connector._types__SchedulingConfiguration", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "scheduling"], "description": "Update the connector scheduling." }

package/lib/cjs/es/json/connector.update_service_type.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_service_type", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "service_type": { "type": "string", "x-found-in": "body" } }, "required": ["connector_id", "service_type"], "description": "Update the connector service type." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_service_type", "type": "object", "properties": { "service_type": { "type": "string", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "service_type"], "description": "Update the connector service type." }

package/lib/cjs/es/json/connector.update_status.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_status", "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "status": { "$ref": "./connector._types.json#/$defs/connector._types__ConnectorStatus", "x-found-in": "body" } }, "required": ["connector_id", "status"], "description": "Update the connector status." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_status", "type": "object", "properties": { "status": { "$ref": "./connector._types.json#/$defs/connector._types__ConnectorStatus", "x-found-in": "body" }, "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id", "status"], "description": "Update the connector status." }

package/lib/cjs/es/json/count.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "count", "type": "object", "properties": { "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" }, "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" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The 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.\nIt supports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded, or aliased indices are ignored when frozen.", "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" }, "lenient": { "type": "boolean", "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "min_score": { "type": "number", "description": "The minimum `_score` value that documents must have to be included in the result.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, it is random.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value 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" }, "stats": { "oneOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "string" }], "description": "Specific `tag` of the request for logging and statistical purposes.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", "x-found-in": "query" }, "q": { "type": "string", "description": "The query in Lucene query string syntax. This parameter cannot be used with a request body.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.", "x-found-in": "body" } }, "description": "Count search results.\n\nGet the number of documents matching a query.\n\nThe query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.\nThe query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n\nThe count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n\nThe operation is broadcast across all shards.\nFor each shard ID group, a replica is chosen and the search is run against it.\nThis means that replicas increase the scalability of the count." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "count", "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" }, "analyzer": { "type": "string", "description": "The analyzer to use for the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "analyze_wildcard": { "type": "boolean", "description": "If `true`, wildcard and prefix queries are analyzed.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "default_operator": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__Operator", "description": "The default operator for query string query: `and` or `or`.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "df": { "type": "string", "description": "The field to use as a default when no field prefix is given in the query string.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "expand_wildcards": { "$ref": "./_types.json#/$defs/_types__ExpandWildcards", "description": "The 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.\nIt supports comma-separated values, such as `open,hidden`.", "x-found-in": "query" }, "ignore_throttled": { "type": "boolean", "description": "If `true`, concrete, expanded, or aliased indices are ignored when frozen.", "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" }, "lenient": { "type": "boolean", "description": "If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.\nThis parameter can be used only when the `q` query string parameter is specified.", "x-found-in": "query" }, "min_score": { "type": "number", "description": "The minimum `_score` value that documents must have to be included in the result.", "x-found-in": "query" }, "preference": { "type": "string", "description": "The node or shard the operation should be performed on.\nBy default, it is random.", "x-found-in": "query" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value 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" }, "stats": { "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "string" }], "description": "Specific `tag` of the request for logging and statistical purposes.", "x-found-in": "query" }, "terminate_after": { "type": "number", "description": "The maximum number of documents to collect for each shard.\nIf a query reaches this limit, Elasticsearch terminates the query early.\nElasticsearch collects documents before sorting.\n\nIMPORTANT: Use with caution.\nElasticsearch applies this parameter to each shard handling the request.\nWhen possible, let Elasticsearch perform early termination automatically.\nAvoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers.", "x-found-in": "query" }, "q": { "type": "string", "description": "The query in Lucene query string syntax. This parameter cannot be used with a request body.", "x-found-in": "query" }, "query": { "$ref": "./_types.query_dsl.json#/$defs/_types.query_dsl__QueryContainer", "description": "Defines the search query using Query DSL. A request body query cannot be used\nwith the `q` query string parameter.", "x-found-in": "body" }, "index": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of data streams, indices, and aliases to search.\nIt supports wildcards (`*`).\nTo search all data streams and indices, omit this parameter or use `*` or `_all`.", "x-found-in": "path" } }, "description": "Count search results.\n\nGet the number of documents matching a query.\n\nThe query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body.\nThe query is optional. When no query is provided, the API uses `match_all` to count all the documents.\n\nThe count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices.\n\nThe operation is broadcast across all shards.\nFor each shard ID group, a replica is chosen and the search is run against it.\nThis means that replicas increase the scalability of the count." }

package/lib/cjs/es/json/create.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create", "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the document.\nTo automatically generate a document ID, use the `POST /<target>/_doc/` request format.", "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.", "x-found-in": "path" }, "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" }, "pipeline": { "type": "string", "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off 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" }, "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" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.", "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.\nElasticsearch waits for at least the specified timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.\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": "The 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" } }, "required": ["id", "index"], "description": "Create a new document in the index.\n\nYou can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `/<target>/_doc/` API.\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 a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, 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\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**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.\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." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create", "type": "object", "properties": { "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" }, "pipeline": { "type": "string", "description": "The ID of the pipeline to use to preprocess incoming documents.\nIf the index has a default ingest pipeline specified, setting the value to `_none` turns off 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" }, "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" }, "routing": { "$ref": "./_types.json#/$defs/_types__Routing", "description": "A custom value that is used to route operations to a specific shard.", "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.\nElasticsearch waits for at least the specified timeout period before failing.\nThe actual wait time could be longer, particularly when multiple waits occur.\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": "The 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" }, "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.", "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.", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Create a new document in the index.\n\nYou can index a new JSON document with the `/<target>/_doc/` or `/<target>/_create/<_id>` APIs\nUsing `_create` guarantees that the document is indexed only if it does not already exist.\nIt returns a 409 response when a document with a same ID already exists in the index.\nTo update an existing document, you must use the `/<target>/_doc/` API.\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 a document using the `PUT /<target>/_create/<_id>` or `POST /<target>/_create/<_id>` request formats, 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\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**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.\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." }

package/lib/cjs/es/json/dangling_indices.delete_dangling_index.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.delete_dangling_index", "type": "object", "properties": { "index_uuid": { "type": "string", "description": "The UUID of the index to delete. Use the get dangling indices API to find the UUID.", "x-found-in": "path" }, "accept_data_loss": { "type": "boolean", "description": "This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.", "x-found-in": "query" } }, "required": ["index_uuid"], "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.delete_dangling_index", "type": "object", "properties": { "accept_data_loss": { "type": "boolean", "description": "This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.", "x-found-in": "query" }, "index_uuid": { "type": "string", "description": "The UUID of the index to delete. Use the get dangling indices API to find the UUID.", "x-found-in": "path" } }, "required": ["index_uuid"], "description": "Delete a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline." }

package/lib/cjs/es/json/dangling_indices.import_dangling_index.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.import_dangling_index", "type": "object", "properties": { "index_uuid": { "type": "string", "description": "The UUID of the index to import. Use the get dangling indices API to locate the UUID.", "x-found-in": "path" }, "accept_data_loss": { "type": "boolean", "description": "This parameter must be set to true to import a dangling index.\nBecause Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.", "x-found-in": "query" } }, "required": ["index_uuid"], "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.import_dangling_index", "type": "object", "properties": { "accept_data_loss": { "type": "boolean", "description": "This parameter must be set to true to import a dangling index.\nBecause Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster.", "x-found-in": "query" }, "master_timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a connection to the master node.", "x-found-in": "query" }, "timeout": { "$ref": "./_types.json#/$defs/_types__Duration", "description": "The period to wait for a response.", "x-found-in": "query" }, "index_uuid": { "type": "string", "description": "The UUID of the index to import. Use the get dangling indices API to locate the UUID.", "x-found-in": "path" } }, "required": ["index_uuid"], "description": "Import a dangling index.\n\nIf Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling.\nFor example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline." }

package/lib/cjs/es/json/delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete", "type": "object", "properties": { "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the target index.", "x-found-in": "path" }, "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" }, "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 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 to wait for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "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 minimum 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" } }, "required": ["id", "index"], "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete 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**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group." }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "delete", "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" }, "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 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 to wait for active shards.\n\nThis parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs.\nSome reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation.\nBy default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error.", "x-found-in": "query" }, "version": { "type": "number", "description": "An explicit version number for concurrency control.\nIt must match the current version of the document for the request to succeed.", "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 minimum 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" }, "id": { "type": "string", "description": "A unique identifier for the document.", "x-found-in": "path" }, "index": { "type": "string", "description": "The name of the target index.", "x-found-in": "path" } }, "required": ["id", "index"], "description": "Delete a document.\n\nRemove a JSON document from the specified index.\n\nNOTE: You cannot send deletion requests directly to a data stream.\nTo delete a document in a data stream, you must target the backing index containing the document.\n\n**Optimistic concurrency control**\n\nDelete 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**Versioning**\n\nEach document indexed is versioned.\nWhen deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime.\nEvery write operation run on a document, deletes included, causes its version to be incremented.\nThe version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations.\nThe length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting.\n\n**Routing**\n\nIf routing is used during indexing, the routing value also needs to be specified to delete a document.\n\nIf the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request.\n\nFor example:\n\n```\nDELETE /my-index-000001/_doc/1?routing=shard-1\n```\n\nThis request deletes the document with ID 1, but it is routed based on the user.\nThe document is not deleted if the correct routing is not specified.\n\n**Distributed**\n\nThe delete operation gets hashed into a specific shard ID.\nIt then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group." }