@elastic/schemas 0.5.1 → 0.6.0

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.delete", "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.", "x-api": { "id": "connector.delete", "name": "delete", "namespace": "connector" }, "x-method": "DELETE", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.delete", "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.", "x-api": { "id": "connector.delete", "name": "delete", "namespace": "connector" }, "x-method": "DELETE", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.get", "description": "Get a connector.\n\nGet the details about a connector.", "x-api": { "id": "connector.get", "name": "get", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.get", "description": "Get a connector.\n\nGet the details about a connector.", "x-api": { "id": "connector.get", "name": "get", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

package/lib/es/json/connector.list.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.list", "description": "Get all connectors.\n\nGet information about all connectors.", "x-api": { "id": "connector.list", "name": "list", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector", "x-urls": [{ "path": "/_connector", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "index_name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of connector index names to fetch connector documents for", "x-found-in": "query" }, "connector_name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of connector names to fetch connector documents for", "x-found-in": "query" }, "service_type": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of connector service types to fetch connector documents for", "x-found-in": "query" }, "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" }, "query": { "type": "string", "description": "A wildcard query string that filters connectors with matching name, description or index name", "x-found-in": "query" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.list", "description": "Get all connectors.\n\nGet information about all connectors.", "x-api": { "id": "connector.list", "name": "list", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector", "x-urls": [{ "path": "/_connector", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "index_name": { "$ref": "./_types.json#/$defs/_types__Indices", "description": "A comma-separated list of connector index names to fetch connector documents for", "x-found-in": "query" }, "connector_name": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of connector names to fetch connector documents for", "x-found-in": "query" }, "service_type": { "$ref": "./_types.json#/$defs/_types__Names", "description": "A comma-separated list of connector service types to fetch connector documents for", "x-found-in": "query" }, "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" }, "query": { "type": "string", "description": "A wildcard query string that filters connectors with matching name, description or index name", "x-found-in": "query" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/connector.post.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.post", "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "x-api": { "id": "connector.post", "name": "post", "namespace": "connector" }, "x-method": "POST", "x-path": "/_connector", "x-urls": [{ "path": "/_connector", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.post", "description": "Create a connector.\n\nConnectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.\nElastic managed connectors (Native connectors) are a managed service on Elastic Cloud.\nSelf-managed connectors (Connector clients) are self-managed on your infrastructure.", "x-api": { "id": "connector.post", "name": "post", "namespace": "connector" }, "x-method": "POST", "x-path": "/_connector", "x-urls": [{ "path": "/_connector", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.put", "description": "Create or update a connector.", "x-api": { "id": "connector.put", "name": "put", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["PUT"] }, { "path": "/_connector", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.put", "description": "Create or update a connector.", "x-api": { "id": "connector.put", "name": "put", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}", "x-urls": [{ "path": "/_connector/{connector_id}", "methods": ["PUT"] }, { "path": "/_connector", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/connector.sync_job_cancel.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_cancel", "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "x-api": { "id": "connector.sync_job_cancel", "name": "sync-job-cancel", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_cancel", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_cancel", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job", "x-found-in": "path" } }, "required": ["connector_sync_job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_cancel", "description": "Cancel a connector sync job.\n\nCancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time.\nThe connector service is then responsible for setting the status of connector sync jobs to cancelled.", "x-api": { "id": "connector.sync_job_cancel", "name": "sync-job-cancel", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_cancel", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_cancel", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id"] }

package/lib/es/json/connector.sync_job_check_in.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_check_in", "description": "Check in a connector sync job.\n\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\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.", "x-api": { "id": "connector.sync_job_check_in", "name": "sync-job-check-in", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job to be checked in.", "x-found-in": "path" } }, "required": ["connector_sync_job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_check_in", "description": "Check in a connector sync job.\n\nCheck in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.\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.", "x-api": { "id": "connector.sync_job_check_in", "name": "sync-job-check-in", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_check_in", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job to be checked in.", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_claim", "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.", "x-api": { "id": "connector.sync_job_claim", "name": "sync-job-claim", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_claim", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_claim", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_claim", "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.", "x-api": { "id": "connector.sync_job_claim", "name": "sync-job-claim", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_claim", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_claim", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id", "worker_hostname"] }

package/lib/es/json/connector.sync_job_delete.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_delete", "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "x-api": { "id": "connector.sync_job_delete", "name": "sync-job-delete", "namespace": "connector" }, "x-method": "DELETE", "x-path": "/_connector/_sync_job/{connector_sync_job_id}", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job to be deleted", "x-found-in": "path" } }, "required": ["connector_sync_job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_delete", "description": "Delete a connector sync job.\n\nRemove a connector sync job and its associated data.\nThis is a destructive action that is not recoverable.", "x-api": { "id": "connector.sync_job_delete", "name": "sync-job-delete", "namespace": "connector" }, "x-method": "DELETE", "x-path": "/_connector/_sync_job/{connector_sync_job_id}", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job to be deleted", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_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.", "x-api": { "id": "connector.sync_job_error", "name": "sync-job-error", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_error", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_error", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_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.", "x-api": { "id": "connector.sync_job_error", "name": "sync-job-error", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_error", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_error", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id", "error"] }

package/lib/es/json/connector.sync_job_get.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_get", "description": "Get a connector sync job.", "x-api": { "id": "connector.sync_job_get", "name": "sync-job-get", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/_sync_job/{connector_sync_job_id}", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job", "x-found-in": "path" } }, "required": ["connector_sync_job_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_get", "description": "Get a connector sync job.", "x-api": { "id": "connector.sync_job_get", "name": "sync-job-get", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/_sync_job/{connector_sync_job_id}", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "connector_sync_job_id": { "type": "string", "description": "The unique identifier of the connector sync job", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_list", "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "x-api": { "id": "connector.sync_job_list", "name": "sync-job-list", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/_sync_job", "x-urls": [{ "path": "/_connector/_sync_job", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_list", "description": "Get all connector sync jobs.\n\nGet information about all stored connector sync jobs listed by their creation date in ascending order.", "x-api": { "id": "connector.sync_job_list", "name": "sync-job-list", "namespace": "connector" }, "x-method": "GET", "x-path": "/_connector/_sync_job", "x-urls": [{ "path": "/_connector/_sync_job", "methods": ["GET"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

package/lib/es/json/connector.sync_job_post.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_post", "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "x-api": { "id": "connector.sync_job_post", "name": "sync-job-post", "namespace": "connector" }, "x-method": "POST", "x-path": "/_connector/_sync_job", "x-urls": [{ "path": "/_connector/_sync_job", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The id of the associated connector", "x-found-in": "body" }, "job_type": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType", "x-found-in": "body" }, "trigger_method": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobTriggerMethod", "x-found-in": "body" } }, "required": ["id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_post", "description": "Create a connector sync job.\n\nCreate a connector sync job document in the internal index and initialize its counters and timestamps with default values.", "x-api": { "id": "connector.sync_job_post", "name": "sync-job-post", "namespace": "connector" }, "x-method": "POST", "x-path": "/_connector/_sync_job", "x-urls": [{ "path": "/_connector/_sync_job", "methods": ["POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "type": "object", "properties": { "id": { "type": "string", "description": "The id of the associated connector", "x-found-in": "body" }, "job_type": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobType", "x-found-in": "body" }, "trigger_method": { "$ref": "./connector._types.json#/$defs/connector._types__SyncJobTriggerMethod", "x-found-in": "body" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id"] }

package/lib/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", "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.", "x-api": { "id": "connector.sync_job_update_stats", "name": "sync-job-update-stats", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_stats", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_stats", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.sync_job_update_stats", "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.", "x-api": { "id": "connector.sync_job_update_stats", "name": "sync-job-update-stats", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/_sync_job/{connector_sync_job_id}/_stats", "x-urls": [{ "path": "/_connector/_sync_job/{connector_sync_job_id}/_stats", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_sync_job_id", "deleted_document_count", "indexed_document_count", "indexed_document_volume"] }

package/lib/es/json/connector.update_active_filtering.request.json

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_active_filtering", "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "x-api": { "id": "connector.update_active_filtering", "name": "update-active-filtering", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_filtering/_activate", "x-urls": [{ "path": "/_connector/{connector_id}/_filtering/_activate", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" } }, "required": ["connector_id"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_active_filtering", "description": "Activate the connector draft filter.\n\nActivates the valid draft filtering for a connector.", "x-api": { "id": "connector.update_active_filtering", "name": "update-active-filtering", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_filtering/_activate", "x-urls": [{ "path": "/_connector/{connector_id}/_filtering/_activate", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "type": "object", "properties": { "connector_id": { "type": "string", "description": "The unique identifier of the connector to be updated", "x-found-in": "path" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

package/lib/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", "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.", "x-api": { "id": "connector.update_api_key_id", "name": "update-api-key-id", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_api_key_id", "x-urls": [{ "path": "/_connector/{connector_id}/_api_key_id", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_api_key_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.", "x-api": { "id": "connector.update_api_key_id", "name": "update-api-key-id", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_api_key_id", "x-urls": [{ "path": "/_connector/{connector_id}/_api_key_id", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_configuration", "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "x-api": { "id": "connector.update_configuration", "name": "update-configuration", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_configuration", "x-urls": [{ "path": "/_connector/{connector_id}/_configuration", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_configuration", "description": "Update the connector configuration.\n\nUpdate the configuration field in the connector document.", "x-api": { "id": "connector.update_configuration", "name": "update-configuration", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_configuration", "x-urls": [{ "path": "/_connector/{connector_id}/_configuration", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_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.", "x-api": { "id": "connector.update_error", "name": "update-error", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_error", "x-urls": [{ "path": "/_connector/{connector_id}/_error", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_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.", "x-api": { "id": "connector.update_error", "name": "update-error", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_error", "x-urls": [{ "path": "/_connector/{connector_id}/_error", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "error"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_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.", "x-api": { "id": "connector.update_features", "name": "update-features", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_features", "x-urls": [{ "path": "/_connector/{connector_id}/_features", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_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.", "x-api": { "id": "connector.update_features", "name": "update-features", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_features", "x-urls": [{ "path": "/_connector/{connector_id}/_features", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "features"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering", "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.", "x-api": { "id": "connector.update_filtering", "name": "update-filtering", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_filtering", "x-urls": [{ "path": "/_connector/{connector_id}/_filtering", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering", "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.", "x-api": { "id": "connector.update_filtering", "name": "update-filtering", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_filtering", "x-urls": [{ "path": "/_connector/{connector_id}/_filtering", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering_validation", "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "x-api": { "id": "connector.update_filtering_validation", "name": "update-filtering-validation", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_filtering/_validation", "x-urls": [{ "path": "/_connector/{connector_id}/_filtering/_validation", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_filtering_validation", "description": "Update the connector draft filtering validation.\n\nUpdate the draft filtering validation info for a connector.", "x-api": { "id": "connector.update_filtering_validation", "name": "update-filtering-validation", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_filtering/_validation", "x-urls": [{ "path": "/_connector/{connector_id}/_filtering/_validation", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "validation"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_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.", "x-api": { "id": "connector.update_index_name", "name": "update-index-name", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_index_name", "x-urls": [{ "path": "/_connector/{connector_id}/_index_name", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_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.", "x-api": { "id": "connector.update_index_name", "name": "update-index-name", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_index_name", "x-urls": [{ "path": "/_connector/{connector_id}/_index_name", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "index_name"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_name", "description": "Update the connector name and description.", "x-api": { "id": "connector.update_name", "name": "update-name", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_name", "x-urls": [{ "path": "/_connector/{connector_id}/_name", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_name", "description": "Update the connector name and description.", "x-api": { "id": "connector.update_name", "name": "update-name", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_name", "x-urls": [{ "path": "/_connector/{connector_id}/_name", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_native", "description": "Update the connector is_native flag.", "x-api": { "id": "connector.update_native", "name": "update-native", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_native", "x-urls": [{ "path": "/_connector/{connector_id}/_native", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_native", "description": "Update the connector is_native flag.", "x-api": { "id": "connector.update_native", "name": "update-native", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_native", "x-urls": [{ "path": "/_connector/{connector_id}/_native", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "is_native"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_pipeline", "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "x-api": { "id": "connector.update_pipeline", "name": "update-pipeline", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_pipeline", "x-urls": [{ "path": "/_connector/{connector_id}/_pipeline", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_pipeline", "description": "Update the connector pipeline.\n\nWhen you create a new connector, the configuration of an ingest pipeline is populated with default settings.", "x-api": { "id": "connector.update_pipeline", "name": "update-pipeline", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_pipeline", "x-urls": [{ "path": "/_connector/{connector_id}/_pipeline", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "pipeline"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_scheduling", "description": "Update the connector scheduling.", "x-api": { "id": "connector.update_scheduling", "name": "update-scheduling", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_scheduling", "x-urls": [{ "path": "/_connector/{connector_id}/_scheduling", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_scheduling", "description": "Update the connector scheduling.", "x-api": { "id": "connector.update_scheduling", "name": "update-scheduling", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_scheduling", "x-urls": [{ "path": "/_connector/{connector_id}/_scheduling", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "scheduling"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_service_type", "description": "Update the connector service type.", "x-api": { "id": "connector.update_service_type", "name": "update-service-type", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_service_type", "x-urls": [{ "path": "/_connector/{connector_id}/_service_type", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_service_type", "description": "Update the connector service type.", "x-api": { "id": "connector.update_service_type", "name": "update-service-type", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_service_type", "x-urls": [{ "path": "/_connector/{connector_id}/_service_type", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "beta" }, "serverless": { "stability": "beta", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "service_type"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_status", "description": "Update the connector status.", "x-api": { "id": "connector.update_status", "name": "update-status", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_status", "x-urls": [{ "path": "/_connector/{connector_id}/_status", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "connector.update_status", "description": "Update the connector status.", "x-api": { "id": "connector.update_status", "name": "update-status", "namespace": "connector" }, "x-method": "PUT", "x-path": "/_connector/{connector_id}/_status", "x-urls": [{ "path": "/_connector/{connector_id}/_status", "methods": ["PUT"] }], "x-destructive": true, "x-availability": { "stack": { "since": "8.12.0", "stability": "experimental" }, "serverless": { "stability": "experimental", "visibility": "public" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["connector_id", "status"] }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "count", "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.", "x-api": { "id": "count", "name": "count", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_count", "x-urls": [{ "path": "/_count", "methods": ["POST", "GET"] }, { "path": "/{index}/_count", "methods": ["POST", "GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-deprecated": { "since": "7.16.0" } }, "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" } } }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "count", "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.", "x-api": { "id": "count", "name": "count", "namespace": null }, "x-method": "POST", "x-path": "/{index}/_count", "x-urls": [{ "path": "/_count", "methods": ["POST", "GET"] }, { "path": "/{index}/_count", "methods": ["POST", "GET"] }], "x-destructive": false, "x-availability": { "stack": { "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-deprecated": { "since": "7.16.0" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } } }

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

@@ -1 +1 @@
-{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create", "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.", "x-api": { "id": "create", "name": "create", "namespace": null }, "x-method": "PUT", "x-path": "/{index}/_create/{id}", "x-urls": [{ "path": "/{index}/_create/{id}", "methods": ["PUT", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": {} } }, "document": { "x-found-in": "body", "x-body-root": true }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "create", "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.", "x-api": { "id": "create", "name": "create", "namespace": null }, "x-method": "PUT", "x-path": "/{index}/_create/{id}", "x-urls": [{ "path": "/{index}/_create/{id}", "methods": ["PUT", "POST"] }], "x-destructive": false, "x-availability": { "stack": { "since": "5.0.0", "stability": "stable" }, "serverless": { "stability": "stable", "visibility": "public" } }, "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", "x-availability": { "stack": {} } }, "document": { "x-found-in": "body", "x-body-root": true }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["id", "index"] }

package/lib/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", "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.", "x-api": { "id": "dangling-indices.delete_dangling_index", "name": "delete-dangling-index", "namespace": "dangling-indices" }, "x-method": "DELETE", "x-path": "/_dangling/{index_uuid}", "x-urls": [{ "path": "/_dangling/{index_uuid}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.delete_dangling_index", "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.", "x-api": { "id": "dangling-indices.delete_dangling_index", "name": "delete-dangling-index", "namespace": "dangling-indices" }, "x-method": "DELETE", "x-path": "/_dangling/{index_uuid}", "x-urls": [{ "path": "/_dangling/{index_uuid}", "methods": ["DELETE"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index_uuid"] }

package/lib/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", "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.", "x-api": { "id": "dangling-indices.import_dangling_index", "name": "import-dangling-index", "namespace": "dangling-indices" }, "x-method": "POST", "x-path": "/_dangling/{index_uuid}", "x-urls": [{ "path": "/_dangling/{index_uuid}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "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"] }
+{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "dangling_indices.import_dangling_index", "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.", "x-api": { "id": "dangling-indices.import_dangling_index", "name": "import-dangling-index", "namespace": "dangling-indices" }, "x-method": "POST", "x-path": "/_dangling/{index_uuid}", "x-urls": [{ "path": "/_dangling/{index_uuid}", "methods": ["POST"] }], "x-destructive": true, "x-availability": { "stack": { "since": "7.9.0", "stability": "stable" } }, "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" }, "error_trace": { "type": "boolean", "description": "When set to `true` Elasticsearch will include the full stack trace of errors\nwhen they occur.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "filter_path": { "anyOf": [{ "type": "string" }, { "type": "array", "items": { "type": "string" } }], "description": "Comma-separated list of filters in dot notation which reduce the response\nreturned by Elasticsearch.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "human": { "type": "boolean", "description": "When set to `true` will return statistics in a format suitable for humans.\nFor example `\"exists_time\": \"1h\"` for humans and\n`\"exists_time_in_millis\": 3600000` for computers. When disabled the human\nreadable values will be omitted. This makes sense for responses being consumed\nonly by machines.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" }, "pretty": { "type": "boolean", "description": "If set to `true` the returned JSON will be \"pretty-formatted\". Only use\nthis option for debugging only.", "x-found-in": "query", "x-behavior": "CommonQueryParameters" } }, "required": ["index_uuid"] }