Skip to content

Commit 2f37ceb

Browse files
committed
Add specification for claim connector sync job
1 parent 5987f79 commit 2f37ceb

File tree

7 files changed

+220
-10
lines changed

7 files changed

+220
-10
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 58 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: 81 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
@@ -249,12 +249,6 @@
249249
],
250250
"response": []
251251
},
252-
"connector.sync_job_claim": {
253-
"request": [
254-
"Missing request & response"
255-
],
256-
"response": []
257-
},
258252
"connector.sync_job_error": {
259253
"request": [
260254
"Missing request & response"

output/typescript/types.ts

Lines changed: 11 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-claim,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/claim-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: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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 { UserDefinedValue } from '@spec_utils/UserDefinedValue'
20+
import { RequestBase } from '@_types/Base'
21+
import { Id } from '@_types/common'
22+
23+
/**
24+
* Claim a connector sync job.
25+
* @rest_spec_name connector.sync_job_claim
26+
* @availability stack stability=experimental visibility=public
27+
* @doc_id connector-sync-job-claim
28+
*/
29+
export interface Request extends RequestBase {
30+
path_parts: {
31+
/**
32+
* The unique identifier of the connector sync job.
33+
*/
34+
connector_sync_job_id: Id
35+
}
36+
body: {
37+
/**
38+
* The cursor object from the last incremental sync job.
39+
* This should reference the `sync_cursor` field in the connector state for which the job runs.
40+
*/
41+
sync_cursor?: UserDefinedValue
42+
/**
43+
* The host name of the current system that will run the job.
44+
*/
45+
worker_hostname: string
46+
}
47+
}
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)