Skip to content
Merged
Show file tree
Hide file tree
Changes from 53 commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
259d493
wip
leemthompo Aug 22, 2024
28ddf8c
WIP before changing IDs
leemthompo Sep 15, 2024
8985eca
Update IDs, internal links
leemthompo Sep 16, 2024
384a25c
Update ids,links
leemthompo Sep 16, 2024
84f63b5
Delete file
leemthompo Sep 16, 2024
58a76b7
Delete draft file
leemthompo Sep 16, 2024
7679a7a
Merge branch 'main' into move-connector-docs
leemthompo Sep 16, 2024
34c28ec
Use managed/self-managed taxonomy
leemthompo Sep 16, 2024
b2ec582
Hosted --> Managed
leemthompo Sep 16, 2024
ecced7a
idem
leemthompo Sep 16, 2024
797065f
idem
leemthompo Sep 16, 2024
d60ba84
Delete redundant page
leemthompo Sep 16, 2024
7c48848
Find/replaces
leemthompo Sep 16, 2024
cb74637
Fix index page
leemthompo Sep 16, 2024
f1c09ca
Use source,js
leemthompo Sep 16, 2024
940ff78
idem
leemthompo Sep 17, 2024
90ef250
javascript -> js
leemthompo Sep 17, 2024
7d21738
Use source txt
leemthompo Sep 17, 2024
d2efbcd
Update mongo tutorial
leemthompo Sep 17, 2024
cf2ae3b
Comment out example tests
leemthompo Sep 17, 2024
e4dccc7
Revert "Comment out example tests"
leemthompo Sep 17, 2024
df05797
Fix test snippet comments
leemthompo Sep 17, 2024
4c6fdb4
Remove unncessary NOT CONSOLE comments
leemthompo Sep 17, 2024
e667ab0
curl not console
leemthompo Sep 17, 2024
710e160
comment out source, js ?
leemthompo Sep 17, 2024
9957f41
delete bad angle brackets
leemthompo Sep 17, 2024
ede8c54
hide the pain
leemthompo Sep 17, 2024
51c4faf
quote your field names for goodness sake
leemthompo Sep 17, 2024
d5ba3de
delete link
leemthompo Sep 18, 2024
64ca670
remove angle brackets in console calls
leemthompo Sep 18, 2024
ffa7d21
idem
leemthompo Sep 18, 2024
7c4c902
what is life
leemthompo Sep 18, 2024
a9d8966
Remove include
leemthompo Sep 18, 2024
b7125d0
delete duplicates
leemthompo Sep 18, 2024
647b6a7
comment out untestables
leemthompo Sep 18, 2024
559e12e
hello the light
leemthompo Sep 18, 2024
7364d61
Remove script
leemthompo Sep 18, 2024
fd8a135
Fix TODOs
leemthompo Sep 25, 2024
8af2117
Delete comment text
leemthompo Sep 25, 2024
0fa7fb6
What is grammar?
leemthompo Sep 25, 2024
c058431
managed -> Elastic managed
leemthompo Sep 25, 2024
ab02c12
Update local extraction docker path for 8.16
leemthompo Sep 25, 2024
a285266
Update hardcoded ent search links to internal docs links in es book
leemthompo Sep 25, 2024
fc9b68d
take 2: Update hardcoded ent search links to internal docs links in e…
leemthompo Sep 25, 2024
6a38deb
Fix typo
leemthompo Sep 25, 2024
8f23c05
fix typos
leemthompo Sep 25, 2024
a35fc86
Nest internal knowledge search under use cases
leemthompo Sep 26, 2024
f94827b
Fix index page
leemthompo Sep 26, 2024
e8e6be8
Clarify naming history
leemthompo Sep 27, 2024
773a6a9
Make headings uniform
leemthompo Sep 27, 2024
6ea6f9d
Update SP server incremental sync availability in table
leemthompo Sep 27, 2024
32b4f74
Update servicenow compats
leemthompo Sep 27, 2024
c82f601
Update ntwrk drive configs
leemthompo Sep 27, 2024
a2b2387
Update _connectors-overview-table.asciidoc
danajuratoni Sep 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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