diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index d2dac03b1c..df94e7547b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -4935,6 +4935,42 @@ "x-beta": true } }, + "/_connector/_sync_job/{connector_sync_job_id}/_check_in": { + "put": { + "tags": [ + "connector" + ], + "summary": "Check in a connector sync job", + "description": "Check 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.", + "operationId": "connector-sync-job-check-in", + "parameters": [ + { + "in": "path", + "name": "connector_sync_job_id", + "description": "The unique identifier of the connector sync job to be checked in.", + "required": true, + "deprecated": false, + "schema": { + "$ref": "#/components/schemas/_types:Id" + }, + "style": "simple" + } + ], + "responses": { + "200": { + "description": "", + "content": { + "application/json": { + "schema": { + "type": "object" + } + } + } + } + }, + "x-state": "Technical preview" + } + }, "/_connector/_sync_job/{connector_sync_job_id}/_claim": { "put": { "tags": [ @@ -25809,7 +25845,7 @@ "rollup" ], "summary": "Create a rollup job", - "description": "WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster either needs to contain a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", + "description": "WARNING: From 8.15.0, calling this API in a cluster with no rollup usage will fail with a message about the deprecation and planned removal of rollup features. A cluster needs to contain either a rollup job or a rollup index in order for this API to be allowed to run.\n\nThe rollup job configuration contains all the details about how the job should run, when it indexes documents, and what future queries will be able to run against the rollup index.\n\nThere are three main sections to the job configuration: the logistical details about the job (for example, the cron schedule), the fields that are used for grouping, and what metrics to collect for each group.\n\nJobs are created in a `STOPPED` state. You can start them with the start rollup jobs API.", "operationId": "rollup-put-job", "parameters": [ { @@ -25893,7 +25929,7 @@ "rollup" ], "summary": "Delete a rollup job", - "description": "A job must be stopped first before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", + "description": "A job must be stopped before it can be deleted.\nIf you attempt to delete a started job, an error occurs.\nSimilarly, if you attempt to delete a nonexistent job, an exception occurs.\n\nIMPORTANT: When you delete a job, you remove only the process that is actively monitoring and rolling up data.\nThe API does not delete any previously rolled up data.\nThis is by design; a user may wish to roll up a static data set.\nBecause the data set is static, after it has been fully rolled up there is no need to keep the indexing rollup job around (as there will be no new data).\nThus the job can be deleted, leaving behind the rolled up data for analysis.\nIf you wish to also remove the rollup data and the rollup index contains the data for only a single job, you can delete the whole rollup index.\nIf the rollup index stores data from several jobs, you must issue a delete-by-query that targets the rollup job's identifier in the rollup index. For example:\n\n```\nPOST my_rollup_index/_delete_by_query\n{\n \"query\": {\n \"term\": {\n \"_rollup.id\": \"the_rollup_job_id\"\n }\n }\n}\n```", "operationId": "rollup-delete-job", "parameters": [ { diff --git a/output/schema/schema.json b/output/schema/schema.json index f897ed46c9..de7a4785df 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -3322,12 +3322,19 @@ "visibility": "public" } }, - "description": "Checks in a connector sync job (refreshes 'last_seen').", - "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/check-in-connector-sync-job-api.html", + "description": "Check in a connector sync job.\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.", + "docId": "connector-sync-job-checkin", + "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-sync-job-api.html", "name": "connector.sync_job_check_in", - "request": null, + "request": { + "name": "Request", + "namespace": "connector.sync_job_check_in" + }, "requestBodyRequired": false, - "response": null, + "response": { + "name": "Response", + "namespace": "connector.sync_job_check_in" + }, "responseMediaType": [ "application/json" ], @@ -115358,6 +115365,54 @@ }, "specLocation": "connector/sync_job_cancel/SyncJobCancelResponse.ts#L22-L26" }, + { + "kind": "request", + "attachedBehaviors": [ + "CommonQueryParameters" + ], + "body": { + "kind": "no_body" + }, + "description": "Check in a connector sync job.\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.", + "inherits": { + "type": { + "name": "RequestBase", + "namespace": "_types" + } + }, + "name": { + "name": "Request", + "namespace": "connector.sync_job_check_in" + }, + "path": [ + { + "description": "The unique identifier of the connector sync job to be checked in.", + "name": "connector_sync_job_id", + "required": true, + "type": { + "kind": "instance_of", + "type": { + "name": "Id", + "namespace": "_types" + } + } + } + ], + "query": [], + "specLocation": "connector/sync_job_check_in/SyncJobCheckInRequest.ts#L22-L39" + }, + { + "kind": "response", + "body": { + "kind": "properties", + "properties": [] + }, + "name": { + "name": "Response", + "namespace": "connector.sync_job_check_in" + }, + "specLocation": "connector/sync_job_check_in/SyncJobCheckInResponse.ts#L20-L22" + }, { "kind": "request", "attachedBehaviors": [ diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json index b7a001a9c1..ac8a210930 100644 --- a/output/schema/validation-errors.json +++ b/output/schema/validation-errors.json @@ -470,12 +470,6 @@ ], "response": [] }, - "connector.sync_job_check_in": { - "request": [ - "Missing request & response" - ], - "response": [] - }, "connector.sync_job_update_stats": { "request": [ "Missing request & response" diff --git a/output/typescript/types.ts b/output/typescript/types.ts index cb7d35a471..f13920457d 100644 --- a/output/typescript/types.ts +++ b/output/typescript/types.ts @@ -9996,6 +9996,13 @@ export interface ConnectorSyncJobCancelResponse { result: Result } +export interface ConnectorSyncJobCheckInRequest extends RequestBase { + connector_sync_job_id: Id +} + +export interface ConnectorSyncJobCheckInResponse { +} + export interface ConnectorSyncJobClaimRequest extends RequestBase { connector_sync_job_id: Id body?: { diff --git a/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts b/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts new file mode 100644 index 0000000000..dc56f09a6c --- /dev/null +++ b/specification/connector/sync_job_check_in/SyncJobCheckInRequest.ts @@ -0,0 +1,39 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +import { RequestBase } from '@_types/Base' +import { Id } from '@_types/common' + +/** + * Check in a connector sync job. + * Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index. + * + * To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure. + * This service runs automatically on Elastic Cloud for Elastic managed connectors. + * @rest_spec_name connector.sync_job_check_in + * @availability stack stability=experimental visibility=public + * @doc_id connector-sync-job-checkin + */ +export interface Request extends RequestBase { + path_parts: { + /** + * The unique identifier of the connector sync job to be checked in. + */ + connector_sync_job_id: Id + } +} diff --git a/specification/connector/sync_job_check_in/SyncJobCheckInResponse.ts b/specification/connector/sync_job_check_in/SyncJobCheckInResponse.ts new file mode 100644 index 0000000000..0769bf66cb --- /dev/null +++ b/specification/connector/sync_job_check_in/SyncJobCheckInResponse.ts @@ -0,0 +1,22 @@ +/* + * Licensed to Elasticsearch B.V. under one or more contributor + * license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright + * ownership. Elasticsearch B.V. licenses this file to you under + * the Apache License, Version 2.0 (the "License"); you may + * not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ + +export class Response { + body: {} +}