1
0
Эх сурвалжийг харах

[Connectors API] Add cancel connector sync job docs (#103446)

Add docs for the cancel connector sync job API endpoint.
Tim Grein 1 жил өмнө
parent
commit
b53f9d45b2

+ 50 - 0
docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc

@@ -0,0 +1,50 @@
+[[cancel-connector-sync-job-api]]
+=== Cancel connector sync job API
+++++
+<titleabbrev>Cancel connector sync job</titleabbrev>
+++++
+
+Cancels a connector sync job.
+
+[[cancel-connector-sync-job-api-request]]
+==== {api-request-title}
+`PUT _connector/_sync_job/<connector_sync_job_id>/_cancel`
+
+[[cancel-connector-sync-job-api-prereqs]]
+==== {api-prereq-title}
+
+* To sync data using connectors, it's essential to have the Elastic connectors service running.
+* The `connector_sync_job_id` parameter should reference an existing connector sync job.
+
+[[cancel-connector-sync-job-api-desc]]
+==== {api-description-title}
+
+Cancels a connector sync job, which sets the `status` to `cancelling` and updates `cancellation_requested_at` to the current time.
+The connector service is then responsible for setting the `status` of connector sync jobs to `cancelled`.
+
+[[cancel-connector-sync-job-api-path-params]]
+==== {api-path-parms-title}
+
+`connector_sync_job_id`::
+(Required, string)
+
+[[cancel-connector-sync-job-api-response-codes]]
+==== {api-response-codes-title}
+
+`200`::
+Connector sync job cancellation was successfully requested.
+
+`404`::
+No connector sync job matching `connector_sync_job_id` could be found.
+
+[[cancel-connector-sync-job-api-example]]
+==== {api-examples-title}
+
+The following example cancels the connector sync job with ID `my-connector-sync-job-id`:
+
+[source,console]
+----
+PUT _connector/_sync_job/my-connector-sync-job-id/_cancel
+----
+// TEST[skip:there's no way to clean up after creating a connector sync job, as we don't know the id ahead of time. Therefore, skip this test.]
+

+ 3 - 0
docs/reference/connector/apis/connector-apis.asciidoc

@@ -36,11 +36,14 @@ You can use these APIs to create, cancel, delete and update sync jobs.
 
 Use the following APIs to manage sync jobs:
 
+* <<cancel-connector-sync-job-api>>
 * <<create-connector-sync-job-api>>
 * <<delete-connector-sync-job-api>
 * <<get-connector-sync-job-api>>
 * <<list-connector-sync-jobs-api>>
 
+
+include::cancel-connector-sync-job-api.asciidoc[]
 include::create-connector-api.asciidoc[]
 include::create-connector-sync-job-api.asciidoc[]
 include::delete-connector-api.asciidoc[]