Skip to content

Commit d42830d

Browse files
committed
[API] Updates generated code for Connectors API
Removes connector.last_sync endpoint The following endpoints have been promoted from Experimental to Beta: connector.delete, connector.get, connector.list, connector.post, connector.put, connector.sync_job_cancel, connector.sync_job_delete, connector.sync_job_get, connector.sync_job_list, connector.sync_job_post, connector.update_api_key_id, connector.update_configuration, connector.update_filtering, connector.update_index_name, connector.update_name, connector.update_native, connector.update_pipelien, connector.update_scheduling, connector.update_service_type
1 parent a6af2d0 commit d42830d

31 files changed

+336
-382
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,24 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit c34efd13258a01121b10a538e5b450b4e65c7bf3
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module Connector
2424
module Actions
25-
# Updates the last_seen timestamp in the connector document.
25+
# Check in a connector.
26+
# Update the +last_seen+ field in the connector and set it to the current timestamp.
2627
# This functionality is Experimental and may be changed or removed
2728
# completely in a future release. Elastic will take a best effort approach
2829
# to fix any issues, but experimental features are not subject to the
2930
# support SLA of official GA features.
3031
#
31-
# @option arguments [String] :connector_id The unique identifier of the connector to be updated.
32+
# @option arguments [String] :connector_id The unique identifier of the connector to be checked in (*Required*)
3233
# @option arguments [Hash] :headers Custom HTTP headers
3334
#
34-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html
35+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-check-in
3536
#
3637
def check_in(arguments = {})
3738
request_opts = { endpoint: arguments[:endpoint] || 'connector.check_in' }
@@ -51,7 +52,7 @@ def check_in(arguments = {})
5152
_connector_id = arguments.delete(:connector_id)
5253

5354
method = Elasticsearch::API::HTTP_PUT
54-
path = "_connector/#{Utils.__listify(_connector_id)}/_check_in"
55+
path = "_connector/#{Utils.listify(_connector_id)}/_check_in"
5556
params = {}
5657

5758
Elasticsearch::API::Response.new(

elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,25 +15,29 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit c34efd13258a01121b10a538e5b450b4e65c7bf3
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module Connector
2424
module Actions
25-
# Deletes a connector.
26-
# This functionality is Experimental and may be changed or removed
27-
# completely in a future release. Elastic will take a best effort approach
28-
# to fix any issues, but experimental features are not subject to the
29-
# support SLA of official GA features.
25+
# Delete a connector.
26+
# Removes a connector and associated sync jobs.
27+
# This is a destructive action that is not recoverable.
28+
# NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector.
29+
# These need to be removed manually.
30+
# This functionality is in Beta and is subject to change. The design and
31+
# code is less mature than official GA features and is being provided
32+
# as-is with no warranties. Beta features are not subject to the support
33+
# SLA of official GA features.
3034
#
31-
# @option arguments [String] :connector_id The unique identifier of the connector to be deleted.
32-
# @option arguments [Boolean] :hard If true, the connector doc is deleted. If false, connector doc is marked as deleted (soft-deleted).
33-
# @option arguments [Boolean] :delete_sync_jobs Determines whether associated sync jobs are also deleted.
35+
# @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*)
36+
# @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false.
37+
# @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted.
3438
# @option arguments [Hash] :headers Custom HTTP headers
3539
#
36-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html
40+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-delete
3741
#
3842
def delete(arguments = {})
3943
request_opts = { endpoint: arguments[:endpoint] || 'connector.delete' }
@@ -53,7 +57,7 @@ def delete(arguments = {})
5357
_connector_id = arguments.delete(:connector_id)
5458

5559
method = Elasticsearch::API::HTTP_DELETE
56-
path = "_connector/#{Utils.__listify(_connector_id)}"
60+
path = "_connector/#{Utils.listify(_connector_id)}"
5761
params = Utils.process_params(arguments)
5862

5963
Elasticsearch::API::Response.new(

elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,25 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit c34efd13258a01121b10a538e5b450b4e65c7bf3
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module Connector
2424
module Actions
25-
# Returns the details about a connector.
26-
# This functionality is Experimental and may be changed or removed
27-
# completely in a future release. Elastic will take a best effort approach
28-
# to fix any issues, but experimental features are not subject to the
29-
# support SLA of official GA features.
25+
# Get a connector.
26+
# Get the details about a connector.
27+
# This functionality is in Beta and is subject to change. The design and
28+
# code is less mature than official GA features and is being provided
29+
# as-is with no warranties. Beta features are not subject to the support
30+
# SLA of official GA features.
3031
#
31-
# @option arguments [String] :connector_id The unique identifier of the connector to be returned.
32-
# @option arguments [Boolean] :include_deleted A flag indicating whether to return connectors that have been soft-deleted.
32+
# @option arguments [String] :connector_id The unique identifier of the connector (*Required*)
33+
# @option arguments [Boolean] :include_deleted A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.
3334
# @option arguments [Hash] :headers Custom HTTP headers
3435
#
35-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html
36+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-get
3637
#
3738
def get(arguments = {})
3839
request_opts = { endpoint: arguments[:endpoint] || 'connector.get' }
@@ -52,7 +53,7 @@ def get(arguments = {})
5253
_connector_id = arguments.delete(:connector_id)
5354

5455
method = Elasticsearch::API::HTTP_GET
55-
path = "_connector/#{Utils.__listify(_connector_id)}"
56+
path = "_connector/#{Utils.listify(_connector_id)}"
5657
params = Utils.process_params(arguments)
5758

5859
Elasticsearch::API::Response.new(

elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb

Lines changed: 0 additions & 66 deletions
This file was deleted.

elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb

Lines changed: 16 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,37 +15,38 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit c34efd13258a01121b10a538e5b450b4e65c7bf3
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module Connector
2424
module Actions
25-
# Lists all connectors.
26-
# This functionality is Experimental and may be changed or removed
27-
# completely in a future release. Elastic will take a best effort approach
28-
# to fix any issues, but experimental features are not subject to the
29-
# support SLA of official GA features.
25+
# Get all connectors.
26+
# Get information about all connectors.
27+
# This functionality is in Beta and is subject to change. The design and
28+
# code is less mature than official GA features and is being provided
29+
# as-is with no warranties. Beta features are not subject to the support
30+
# SLA of official GA features.
3031
#
3132
# @option arguments [Integer] :from Starting offset (default: 0)
32-
# @option arguments [Integer] :size Specifies a max number of results to get (default: 100)
33-
# @option arguments [List] :index_name A comma-separated list of connector index names to fetch connector documents for
34-
# @option arguments [List] :connector_name A comma-separated list of connector names to fetch connector documents for
35-
# @option arguments [List] :service_type A comma-separated list of connector service types to fetch connector documents for
36-
# @option arguments [String] :query A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names
37-
# @option arguments [Boolean] :include_deleted A flag indicating whether to return connectors that have been soft-deleted.
33+
# @option arguments [Integer] :size Specifies a max number of results to get
34+
# @option arguments [String, Array] :index_name A comma-separated list of connector index names to fetch connector documents for
35+
# @option arguments [String, Array<String>] :connector_name A comma-separated list of connector names to fetch connector documents for
36+
# @option arguments [String, Array<String>] :service_type A comma-separated list of connector service types to fetch connector documents for
37+
# @option arguments [Boolean] :include_deleted A flag to indicate if the desired connector should be fetched, even if it was soft-deleted.
38+
# @option arguments [String] :query A wildcard query string that filters connectors with matching name, description or index name
3839
# @option arguments [Hash] :headers Custom HTTP headers
3940
#
40-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html
41+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-list
4142
#
4243
def list(arguments = {})
4344
request_opts = { endpoint: arguments[:endpoint] || 'connector.list' }
4445

4546
arguments = arguments.clone
4647
headers = arguments.delete(:headers) || {}
4748

48-
body = nil
49+
body = nil
4950

5051
method = Elasticsearch::API::HTTP_GET
5152
path = '_connector'

elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,34 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit c34efd13258a01121b10a538e5b450b4e65c7bf3
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module Connector
2424
module Actions
25-
# Creates a connector.
26-
# This functionality is Experimental and may be changed or removed
27-
# completely in a future release. Elastic will take a best effort approach
28-
# to fix any issues, but experimental features are not subject to the
29-
# support SLA of official GA features.
25+
# Create a connector.
26+
# Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure.
27+
# Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud.
28+
# Self-managed connectors (Connector clients) are self-managed on your infrastructure.
29+
# This functionality is in Beta and is subject to change. The design and
30+
# code is less mature than official GA features and is being provided
31+
# as-is with no warranties. Beta features are not subject to the support
32+
# SLA of official GA features.
3033
#
3134
# @option arguments [Hash] :headers Custom HTTP headers
32-
# @option arguments [Hash] :body The connector configuration.
35+
# @option arguments [Hash] :body request body
3336
#
34-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html
37+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put
3538
#
3639
def post(arguments = {})
3740
request_opts = { endpoint: arguments[:endpoint] || 'connector.post' }
3841

3942
arguments = arguments.clone
4043
headers = arguments.delete(:headers) || {}
4144

42-
body = arguments.delete(:body)
45+
body = arguments.delete(:body)
4346

4447
method = Elasticsearch::API::HTTP_POST
4548
path = '_connector'

elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,24 @@
1515
# specific language governing permissions and limitations
1616
# under the License.
1717
#
18-
# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80
19-
# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec
18+
# Auto generated from commit c34efd13258a01121b10a538e5b450b4e65c7bf3
19+
# @see https://github.com/elastic/elasticsearch-specification
2020
#
2121
module Elasticsearch
2222
module API
2323
module Connector
2424
module Actions
25-
# Creates or updates a connector.
26-
# This functionality is Experimental and may be changed or removed
27-
# completely in a future release. Elastic will take a best effort approach
28-
# to fix any issues, but experimental features are not subject to the
29-
# support SLA of official GA features.
25+
# Create or update a connector.
26+
# This functionality is in Beta and is subject to change. The design and
27+
# code is less mature than official GA features and is being provided
28+
# as-is with no warranties. Beta features are not subject to the support
29+
# SLA of official GA features.
3030
#
31-
# @option arguments [String] :connector_id The unique identifier of the connector to be created or updated.
31+
# @option arguments [String] :connector_id The unique identifier of the connector to be created or updated. ID is auto-generated if not provided.
3232
# @option arguments [Hash] :headers Custom HTTP headers
33-
# @option arguments [Hash] :body The connector configuration.
33+
# @option arguments [Hash] :body request body
3434
#
35-
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html
35+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-connector-put
3636
#
3737
def put(arguments = {})
3838
request_opts = { endpoint: arguments[:endpoint] || 'connector.put' }
@@ -51,7 +51,7 @@ def put(arguments = {})
5151

5252
method = Elasticsearch::API::HTTP_PUT
5353
path = if _connector_id
54-
"_connector/#{Utils.__listify(_connector_id)}"
54+
"_connector/#{Utils.listify(_connector_id)}"
5555
else
5656
'_connector'
5757
end

0 commit comments

Comments
 (0)