Skip to content

Commit

Permalink
Add specification for update connector features (#3364) (#3379)
Browse files Browse the repository at this point in the history
(cherry picked from commit 3937036)

Co-authored-by: Lisa Cawley <[email protected]>
  • Loading branch information
github-actions[bot] and lcawl authored Dec 19, 2024
1 parent 0f1f39c commit 0f32ee8
Show file tree
Hide file tree
Showing 8 changed files with 263 additions and 14 deletions.
62 changes: 62 additions & 0 deletions output/openapi/elasticsearch-openapi.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

101 changes: 93 additions & 8 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 0 additions & 6 deletions output/schema/validation-errors.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions specification/_doc_ids/table.csv
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,7 @@ connector-sync-job-post,https://www.elastic.co/guide/en/elasticsearch/reference/
connector-sync-job-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-sync-jobs-api.html
connector-checkin,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/check-in-connector-api.html
connector-delete,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/delete-connector-api.html
connector-features,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-features-api.html
connector-get,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/get-connector-api.html
connector-last-sync,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/update-connector-last-sync-api.html
connector-list,https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/list-connector-api.html
Expand Down
15 changes: 15 additions & 0 deletions specification/connector/_types/Connector.ts
Original file line number Diff line number Diff line change
Expand Up @@ -217,13 +217,28 @@ interface FeatureEnabled {
}

interface SyncRulesFeature {
/**
* Indicates whether advanced sync rules are enabled.
*/
advanced?: FeatureEnabled
/**
* Indicates whether basic sync rules are enabled.
*/
basic?: FeatureEnabled
}

export interface ConnectorFeatures {
/**
* Indicates whether document-level security is enabled.
*/
document_level_security?: FeatureEnabled
/**
* Indicates whether incremental syncs are enabled.
*/
incremental_sync?: FeatureEnabled
/**
* Indicates whether managed connector API keys are enabled.
*/
native_connector_api_keys?: FeatureEnabled
sync_rules?: SyncRulesFeature
}
Expand Down
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
}
}
Loading

0 comments on commit 0f32ee8

Please sign in to comment.