Skip to content

Commit f6b94e3

Browse files
lcawlgithub-actions[bot]
authored andcommitted
Add specification for check in connector sync job (#3365)
(cherry picked from commit ca214ff)
1 parent 342755c commit f6b94e3

File tree

7 files changed

+164
-10
lines changed

7 files changed

+164
-10
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 36 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/schema.json

Lines changed: 59 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/schema/validation-errors.json

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -355,12 +355,6 @@
355355
],
356356
"response": []
357357
},
358-
"connector.sync_job_check_in": {
359-
"request": [
360-
"Missing request & response"
361-
],
362-
"response": []
363-
},
364358
"connector.sync_job_claim": {
365359
"request": [
366360
"Missing request & response"

output/typescript/types.ts

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_doc_ids/table.csv

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ cluster,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster
8686
common-options,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/common-options.html
8787
community-id-processor,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/community-id-processor.html
8888
connector-sync-job-cancel,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cancel-connector-sync-job-api.html
89+
connector-sync-job-checkin,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-sync-job-api.html
8990
collapse-search-results,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/collapse-search-results.html
9091
connector-sync-job-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-sync-job-api.html
9192
connector-sync-job-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-sync-job-api.html
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
import { RequestBase } from '@_types/Base'
20+
import { Id } from '@_types/common'
21+
22+
/**
23+
* Check in a connector sync job.
24+
* Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.
25+
*
26+
* To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
27+
* This service runs automatically on Elastic Cloud for Elastic managed connectors.
28+
* @rest_spec_name connector.sync_job_check_in
29+
* @availability stack stability=experimental visibility=public
30+
* @doc_id connector-sync-job-checkin
31+
*/
32+
export interface Request extends RequestBase {
33+
path_parts: {
34+
/**
35+
* The unique identifier of the connector sync job to be checked in.
36+
*/
37+
connector_sync_job_id: Id
38+
}
39+
}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/*
2+
* Licensed to Elasticsearch B.V. under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch B.V. licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
export class Response {
21+
body: {}
22+
}

0 commit comments

Comments
 (0)