-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add specification for update connector features (#3364)
(cherry picked from commit 3937036)
- Loading branch information
1 parent
342755c
commit bd40061
Showing
8 changed files
with
263 additions
and
14 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
specification/connector/update_features/ConnectorUpdateFeaturesRequest.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/* | ||
* 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' | ||
import { ConnectorFeatures } from '../_types/Connector' | ||
|
||
/** | ||
* Update the connector features. | ||
* Update the connector features in the connector document. | ||
* This API can be used to control the following aspects of a connector: | ||
* | ||
* * document-level security | ||
* * incremental syncs | ||
* * advanced sync rules | ||
* * basic sync rules | ||
* | ||
* Normally, the running connector service automatically manages these features. | ||
* However, you can use this API to override the default behavior. | ||
* | ||
* 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.update_features | ||
* @availability stack stability=experimental visibility=public | ||
* @doc_id connector-features | ||
*/ | ||
export interface Request extends RequestBase { | ||
path_parts: { | ||
/** | ||
* The unique identifier of the connector to be updated. | ||
*/ | ||
connector_id: Id | ||
} | ||
/** | ||
* The connector configuration | ||
*/ | ||
body: { | ||
features: ConnectorFeatures | ||
} | ||
} |
Oops, something went wrong.