Skip to content

Commit 3937036

Browse files
authored
Add specification for update connector features (#3364)
1 parent aa2e838 commit 3937036

File tree

8 files changed

+263
-14
lines changed

8 files changed

+263
-14
lines changed

output/openapi/elasticsearch-openapi.json

Lines changed: 62 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: 93 additions & 8 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
@@ -267,12 +267,6 @@
267267
],
268268
"response": []
269269
},
270-
"connector.update_features": {
271-
"request": [
272-
"Missing request & response"
273-
],
274-
"response": []
275-
},
276270
"enrich.delete_policy": {
277271
"request": [
278272
"Request: missing json spec query parameter 'master_timeout'"

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
@@ -93,6 +93,7 @@ connector-sync-job-post,https://www.elastic.co/guide/en/elasticsearch/reference/
9393
connector-sync-job-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html
9494
connector-checkin,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html
9595
connector-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html
96+
connector-features,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-features-api.html
9697
connector-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html
9798
connector-last-sync,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html
9899
connector-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html

specification/connector/_types/Connector.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,13 +217,28 @@ interface FeatureEnabled {
217217
}
218218

219219
interface SyncRulesFeature {
220+
/**
221+
* Indicates whether advanced sync rules are enabled.
222+
*/
220223
advanced?: FeatureEnabled
224+
/**
225+
* Indicates whether basic sync rules are enabled.
226+
*/
221227
basic?: FeatureEnabled
222228
}
223229

224230
export interface ConnectorFeatures {
231+
/**
232+
* Indicates whether document-level security is enabled.
233+
*/
225234
document_level_security?: FeatureEnabled
235+
/**
236+
* Indicates whether incremental syncs are enabled.
237+
*/
226238
incremental_sync?: FeatureEnabled
239+
/**
240+
* Indicates whether managed connector API keys are enabled.
241+
*/
227242
native_connector_api_keys?: FeatureEnabled
228243
sync_rules?: SyncRulesFeature
229244
}
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
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+
import { ConnectorFeatures } from '../_types/Connector'
22+
23+
/**
24+
* Update the connector features.
25+
* Update the connector features in the connector document.
26+
* This API can be used to control the following aspects of a connector:
27+
*
28+
* * document-level security
29+
* * incremental syncs
30+
* * advanced sync rules
31+
* * basic sync rules
32+
*
33+
* Normally, the running connector service automatically manages these features.
34+
* However, you can use this API to override the default behavior.
35+
*
36+
* To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
37+
* This service runs automatically on Elastic Cloud for Elastic managed connectors.
38+
* @rest_spec_name connector.update_features
39+
* @availability stack stability=experimental visibility=public
40+
* @doc_id connector-features
41+
*/
42+
export interface Request extends RequestBase {
43+
path_parts: {
44+
/**
45+
* The unique identifier of the connector to be updated.
46+
*/
47+
connector_id: Id
48+
}
49+
/**
50+
* The connector configuration
51+
*/
52+
body: {
53+
features: ConnectorFeatures
54+
}
55+
}

0 commit comments

Comments
 (0)