Skip to content

Commit

Permalink
[DOCS] Port connector docs from Enterprise Search guide (#112953) (#1…
Browse files Browse the repository at this point in the history
…13771)

(cherry picked from commit 6e400c1)
  • Loading branch information
leemthompo committed Sep 30, 2024
1 parent 53d9c3c commit a7dfc80
Show file tree
Hide file tree
Showing 175 changed files with 18,457 additions and 77 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ beta::[]

Cancels a connector sync job.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[cancel-connector-sync-job-api-request]]
==== {api-request-title}
Expand All @@ -17,7 +18,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[cancel-connector-sync-job-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_sync_job_id` parameter should reference an existing connector sync job.

[[cancel-connector-sync-job-api-desc]]
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/connector/apis/check-in-connector-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ preview::[]

Updates the `last_seen` field of a connector with current timestamp.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[check-in-connector-api-request]]
==== {api-request-title}
Expand All @@ -18,7 +19,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[check-in-connector-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_id` parameter should reference an existing connector.

[[check-in-connector-api-path-params]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ preview::[]

Checks in a connector sync job (updates `last_seen` to the current time).

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[check-in-connector-sync-job-api-request]]
==== {api-request-title}
Expand All @@ -17,7 +18,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[check-in-connector-sync-job-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_sync_job_id` parameter should reference an existing connector sync job.

[[check-in-connector-sync-job-api-desc]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ Claims a connector sync job.

The `_claim` endpoint is not intended for direct connector management by users. It is there to support the implementation of services that utilize the https://github.com/elastic/connectors/blob/main/docs/CONNECTOR_PROTOCOL.md[Connector Protocol] to communicate with {es}.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[claim-connector-sync-job-api-request]]
==== {api-request-title}
Expand All @@ -19,7 +20,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[claim-connector-sync-job-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_sync_job_id` parameter should reference an existing connector sync job.

[[claim-connector-sync-job-api-desc]]
Expand Down
10 changes: 6 additions & 4 deletions docs/reference/connector/apis/connector-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@

beta::[]

The connector and sync jobs APIs provide a convenient way to create and manage Elastic {enterprise-search-ref}/connectors.html[connectors^] and sync jobs in an internal index. To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
The connector and sync jobs APIs provide a convenient way to create and manage Elastic <<es-connectors,connectors>>.
and sync jobs in an internal index. To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


Connectors are {es} integrations that bring content from third-party data sources, which can be deployed on {ecloud} or hosted on your own infrastructure:

* *Native connectors* are a managed service on {ecloud}
* *Connector clients* are self-managed on your infrastructure
* *Managed connectors* are a managed service on {ecloud}
* *Self-managed connectors* are self-hosted on your infrastructure

Find a list of all supported service types in the {enterprise-search-ref}/connectors.html[connectors documentation^].
Find a list of all supported service types in the <<es-connectors,connectors documentation>>.

This API provides an alternative to relying solely on {kib} UI for connector and sync job management. The API comes with a set of
validations and assertions to ensure that the state representation in the internal index remains valid.
Expand Down
17 changes: 9 additions & 8 deletions docs/reference/connector/apis/create-connector-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ beta::[]
Creates an Elastic connector.
Connectors are {es} integrations that bring content from third-party data sources, which can be deployed on {ecloud} or hosted on your own infrastructure:

* *Native connectors* are a managed service on {ecloud}
* *Connector clients* are self-managed on your infrastructure
* *Managed connectors* are a managed service on {ecloud}
* *Self-managed connectors* are self-hosted on your infrastructure

Find a list of all supported service types in the {enterprise-search-ref}/connectors.html[connectors documentation^].
Find a list of all supported service types in the <<es-connectors,connectors documentation>>.

To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].

[source,console]
--------------------------------------------------
Expand Down Expand Up @@ -43,8 +44,8 @@ DELETE _connector/my-connector
[[create-connector-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* The `service_type` parameter should reference a supported third-party service. See the available service types for {enterprise-search-ref}/native-connectors.html[native] and {enterprise-search-ref}/build-connector.html[self-managed] connectors. This can also reference the service type of your custom connector.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `service_type` parameter should reference a supported third-party service. See the available service types for <<es-native-connectors,Elastic managed>> and <<es-build-connector,self-managed>> connectors. This can also reference the service type of your custom connector.


[[create-connector-api-desc]]
Expand Down Expand Up @@ -73,13 +74,13 @@ Creates a connector document in the internal index and initializes its configura
(Optional, string) The name of the connector. Setting the connector name is recommended when managing connectors in {kib}.

`is_native`::
(Optional, boolean) Indicates if it's a native connector. Defaults to `false`.
(Optional, boolean) Indicates if it's a managed connector. Defaults to `false`.

`language`::
(Optional, string) Language analyzer for the data. Limited to supported languages.

`service_type`::
(Optional, string) Connector service type. Can reference Elastic-supported third-party services or a custom connector type. See the available service types for {enterprise-search-ref}/native-connectors.html[native] and {enterprise-search-ref}/build-connector.html[self-managed] connectors.
(Optional, string) Connector service type. Can reference Elastic-supported third-party services or a custom connector type. See the available service types for <<es-native-connectors,Elastic managed>> and <<es-build-connector,self-managed>> connectors.


[role="child_attributes"]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ beta::[]

Creates a connector sync job.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[source, console]
--------------------------------------------------
Expand All @@ -31,7 +32,7 @@ POST _connector/_sync_job
[[create-connector-sync-job-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `id` parameter should reference an existing connector.

[[create-connector-sync-job-api-desc]]
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/connector/apis/delete-connector-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ This is a destructive action that is not recoverable.

Note: this action doesn't delete any API key, ingest pipeline or data index associated with the connector. These need to be removed manually.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[delete-connector-api-request]]
==== {api-request-title}
Expand All @@ -21,7 +22,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[delete-connector-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_id` parameter should reference an existing connector.

[[delete-connector-api-path-params]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ beta::[]
Removes a connector sync job and its associated data.
This is a destructive action that is not recoverable.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[delete-connector-sync-job-api-request]]
==== {api-request-title}
Expand All @@ -19,7 +20,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[delete-connector-sync-job-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

[[delete-connector-sync-job-api-path-params]]
==== {api-path-parms-title}
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/connector/apis/get-connector-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ beta::[]

Retrieves the details about a connector.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[get-connector-api-request]]
==== {api-request-title}
Expand All @@ -18,7 +19,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[get-connector-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

[[get-connector-api-path-params]]
==== {api-path-parms-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ beta::[]

Retrieves the details about a connector sync job.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[get-connector-sync-job-api-request]]
==== {api-request-title}
Expand All @@ -18,7 +19,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[get-connector-sync-job-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

[[get-connector-sync-job-api-path-params]]
==== {api-path-parms-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ beta::[]

Returns information about all stored connector sync jobs ordered by their creation date in ascending order.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[list-connector-sync-jobs-api-request]]
==== {api-request-title}
Expand All @@ -19,7 +20,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[list-connector-sync-jobs-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

[[list-connector-sync-jobs-api-path-params]]
==== {api-path-parms-title}
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/connector/apis/list-connectors-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ beta::[]

Returns information about all created connectors.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.



[[list-connector-api-request]]
Expand All @@ -20,7 +21,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[list-connector-api-prereq]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.

[[list-connector-api-path-params]]
==== {api-path-parms-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ preview::[]

Sets a connector sync job error.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[set-connector-sync-job-error-api-request]]
==== {api-request-title}
Expand All @@ -17,7 +18,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[set-connector-sync-job-error-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_sync_job_id` parameter should reference an existing connector sync job.

[[set-connector-sync-job-error-api-desc]]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ preview::[]

Sets connector sync job stats.

To get started with Connector APIs, check out the {enterprise-search-ref}/connectors-tutorial-api.html[tutorial^].
To get started with Connector APIs, check out <<es-connectors-tutorial-api, our tutorial>>.


[[set-connector-sync-job-stats-api-request]]
==== {api-request-title}
Expand All @@ -17,7 +18,7 @@ To get started with Connector APIs, check out the {enterprise-search-ref}/connec
[[set-connector-sync-job-stats-api-prereqs]]
==== {api-prereq-title}

* To sync data using self-managed connectors, you need to deploy the {enterprise-search-ref}/build-connector.html[Elastic connector service] on your own infrastructure. This service runs automatically on Elastic Cloud for native connectors.
* To sync data using self-managed connectors, you need to deploy the <<es-connectors-deploy-connector-service,Elastic connector service>>. on your own infrastructure. This service runs automatically on Elastic Cloud for Elastic managed connectors.
* The `connector_sync_job_id` parameter should reference an existing connector sync job.

[[set-connector-sync-job-stats-api-desc]]
Expand Down
Loading

0 comments on commit a7dfc80

Please sign in to comment.