forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into rcs2-rebuild-connections
- Loading branch information
Showing
345 changed files
with
4,235 additions
and
1,795 deletions.
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
pr: 102557 | ||
summary: Metrics for search latencies | ||
area: Search | ||
type: enhancement | ||
issues: [] |
This file was deleted.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
pr: 103150 | ||
summary: "ES|QL: Fix NPE on single value detection" | ||
area: ES|QL | ||
type: bug | ||
issues: | ||
- 103141 |
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,5 @@ | ||
pr: 103387 | ||
summary: Upgrade to Lucene 9.9.1 | ||
area: Search | ||
type: upgrade | ||
issues: [] |
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,11 @@ | ||
pr: 103434 | ||
summary: Lower the `look_ahead_time` index setting's max value from 7 days to 2 hours. | ||
area: TSDB | ||
type: breaking | ||
issues: [] | ||
breaking: | ||
title: Lower the `look_ahead_time` index setting's max value | ||
area: Index setting | ||
details: "Lower the `look_ahead_time` index setting's max value from 7 days to 2 hours." | ||
impact: "Any value between 2 hours and 7 days will be as a look ahead time of 2 hours is defined" | ||
notable: false |
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,5 @@ | ||
pr: 103520 | ||
summary: Request indexing memory pressure in APM node metrics publisher | ||
area: Distributed | ||
type: bug | ||
issues: [] |
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,5 @@ | ||
pr: 103530 | ||
summary: Exclude quantiles when fetching model snapshots where possible | ||
area: Machine Learning | ||
type: bug | ||
issues: [] |
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,5 @@ | ||
pr: 103574 | ||
summary: Samples should check if the aggregations result is empty or null | ||
area: EQL | ||
type: bug | ||
issues: [] |
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,6 @@ | ||
pr: 103580 | ||
summary: Copy counter field properties to downsampled index | ||
area: Downsampling | ||
type: bug | ||
issues: | ||
- 103569 |
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
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
154 changes: 154 additions & 0 deletions
154
docs/reference/connector/apis/update-connector-configuration-api.asciidoc
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,154 @@ | ||
[[update-connector-configuration-api]] | ||
=== Update connector configuration API | ||
|
||
preview::[] | ||
|
||
++++ | ||
<titleabbrev>Update connector configuration</titleabbrev> | ||
++++ | ||
|
||
Updates the `configuration` of a connector. | ||
|
||
|
||
[[update-connector-configuration-api-request]] | ||
==== {api-request-title} | ||
|
||
`PUT _connector/<connector_id>/_configuration` | ||
|
||
[[update-connector-configuration-api-prereq]] | ||
==== {api-prereq-title} | ||
|
||
* To sync data using connectors, it's essential to have the Elastic connectors service running. | ||
* The `connector_id` parameter should reference an existing connector. | ||
* The configuration fields definition must be compatible with the specific connector type being used. | ||
|
||
[[update-connector-configuration-api-path-params]] | ||
==== {api-path-parms-title} | ||
|
||
`<connector_id>`:: | ||
(Required, string) | ||
|
||
[role="child_attributes"] | ||
[[update-connector-configuration-api-request-body]] | ||
==== {api-request-body-title} | ||
|
||
`configuration`:: | ||
(Required, object) The configuration for the connector. The configuration field is a map where each key represents a specific configuration field name, and the value is a `ConnectorConfiguration` object. | ||
|
||
Each `ConnectorConfiguration` object contains the following attributes: | ||
|
||
* `category` (Optional, string) The category of the configuration field. This helps in grouping related configurations together in the user interface. | ||
|
||
* `default_value` (Required, string | number | bool) The default value for the configuration. This value is used if the value field is empty, applicable only for non-required fields. | ||
|
||
* `depends_on` (Required, array of `ConfigurationDependency`) An array of dependencies on other configurations. A field will not be enabled unless these dependencies are met. Each dependency specifies a field key and the required value for the dependency to be considered fulfilled. | ||
|
||
* `display` (Required, string) The display type for the UI element that represents this configuration. This defines how the field should be rendered in the user interface. Supported types are: `text`, `textbox`, `textarea`, `numeric`, `toggle` and `dropdown`. | ||
|
||
* `label` (Required, string) The display label for the configuration field. This label is shown in the user interface, adjacent to the field. | ||
|
||
* `options` (Required, array of `ConfigurationSelectOption`) An array of options for list-type fields. These options are used for inputs in the user interface, each having a label for display and a value. | ||
|
||
* `order` (Required, number) The order in which this configuration appears in the user interface. This helps in organizing fields logically. | ||
|
||
* `placeholder` (Required, string) Placeholder text for the configuration field. This text is displayed inside the field before a value is entered. | ||
|
||
* `required` (Required, boolean) Indicates whether the configuration is mandatory. If true, a value must be provided for the field. | ||
|
||
* `sensitive` (Required, boolean) Indicates whether the configuration contains sensitive information. Sensitive fields may be obfuscated in the user interface. | ||
|
||
* `tooltip` (Optional, string) Tooltip text providing additional information about the configuration. This text appears when the user hovers over the info icon next to the configuration field. | ||
|
||
* `type` (Required, string) The type of the configuration field, such as `str`, `int`, `bool`, `list`. This defines the data type and format of the field's value. | ||
|
||
* `ui_restrictions` (Required, array of strings) A list of UI restrictions. These restrictions define where in the user interface this field should be available or restricted. | ||
|
||
* `validations` (Required, array of `ConfigurationValidation`) An array of rules for validating the field's value. Each validation specifies a type and a constraint that the field's value must meet. | ||
|
||
* `value` (Required, string | number | bool) The current value of the configuration. This is the actual value set for the field and is used by the connector during its operations. | ||
|
||
`ConfigurationDependency` represents a dependency that a configuration field has on another field's value. It contains the following attributes: | ||
|
||
* `field` (Required, string) The name of the field in the configuration that this dependency relates to. | ||
|
||
* `value` (Required, string | number | bool) The required value of the specified field for this dependency to be met. | ||
|
||
`ConfigurationSelectOption` defines an option within a selectable configuration field. It contains the following attributes: | ||
|
||
* `label` (Required, string) The display label for the option. | ||
|
||
* `value` (Required, string) The actual value associated with the option. | ||
|
||
`ConfigurationValidation` specifies validation rules for configuration fields. Each ConfigurationValidation instance enforces a specific type of validation based on its type and constraint. It contains the following attributes: | ||
|
||
* `constraint` (Required, string | number) The validation constraint. The nature of this constraint depends on the validation type. It could be a numeric value, a list, a regular expression pattern. | ||
|
||
* `type` (Required, ConfigurationValidationType) The type of validation to be performed. Possible values include: `less_than`, `greater_than`, `list_type`, `included_in`, `regex` and `unset`. | ||
|
||
|
||
[[update-connector-configuration-api-response-codes]] | ||
==== {api-response-codes-title} | ||
|
||
`200`:: | ||
Connector configuration was successfully updated. | ||
|
||
`400`:: | ||
The `connector_id` was not provided or the request payload was malformed. | ||
|
||
`404` (Missing resources):: | ||
No connector matching `connector_id` could be found. | ||
|
||
[[update-connector-configuration-api-example]] | ||
==== {api-examples-title} | ||
|
||
The following example updates the `configuration` for the connector with ID `my-connector`: | ||
|
||
//// | ||
[source, console] | ||
-------------------------------------------------- | ||
PUT _connector/my-connector | ||
{ | ||
"index_name": "search-google-drive", | ||
"name": "My Connector", | ||
"service_type": "google_drive" | ||
} | ||
-------------------------------------------------- | ||
// TESTSETUP | ||
[source,console] | ||
-------------------------------------------------- | ||
DELETE _connector/my-connector | ||
-------------------------------------------------- | ||
// TEARDOWN | ||
//// | ||
|
||
[source,console] | ||
---- | ||
PUT _connector/my-connector/_configuration | ||
{ | ||
"configuration": { | ||
"service_account_credentials": { | ||
"default_value": null, | ||
"depends_on": [], | ||
"display": "textarea", | ||
"label": "Google Drive service account JSON", | ||
"options": [], | ||
"order": 1, | ||
"required": true, | ||
"sensitive": true, | ||
"tooltip": "This connectors authenticates as a service account to synchronize content from Google Drive.", | ||
"type": "str", | ||
"ui_restrictions": [], | ||
"validations": [], | ||
"value": "...service account JSON..." | ||
} | ||
} | ||
} | ||
---- | ||
|
||
[source,console-result] | ||
---- | ||
{ | ||
"result": "updated" | ||
} | ||
---- |
Oops, something went wrong.