Skip to content

Commit

Permalink
[DOCS] Add contextual info about connectors to API docs (elastic#106420
Browse files Browse the repository at this point in the history
…) (elastic#106422)

* [DOCS] Add contextual info about connectors to API docs

* Grammar nit
  • Loading branch information
leemthompo authored Mar 18, 2024
1 parent 0fafca9 commit 5c9f1cd
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
9 changes: 8 additions & 1 deletion docs/reference/connector/apis/connector-apis.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,14 @@

preview::[]

The connector and sync jobs API provides a convenient way to create and manage Elastic {enterprise-search-ref}/connectors.html[connectors^] and sync jobs in an internal index.
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.

Connectors are third-party {es} integrations 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

Find a list of all supported service types in the {enterprise-search-ref}/connectors.html[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
7 changes: 6 additions & 1 deletion docs/reference/connector/apis/create-connector-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,13 @@

preview::[]

Creates a connector.
Creates an Elastic connector.
Connectors are third-party {es} integrations 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

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

[source,console]
--------------------------------------------------
Expand Down

0 comments on commit 5c9f1cd

Please sign in to comment.