Forráskód Böngészése

[Docs] Add connectors links, cleanup connectors API docs (#104262)

* [Docs] Add connectors links

* 🧹 Cleanup abbreviations, add missing tech preview labels

* Unify remaining tech preview, abbreviations, update CLI verbiage

* Unify remaining tech preview, abbreviations
Liam Thompson 1 éve
szülő
commit
01751c0298
21 módosított fájl, 49 hozzáadás és 45 törlés
  1. 2 0
      docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc
  2. 2 3
      docs/reference/connector/apis/check-in-connector-api.asciidoc
  3. 2 0
      docs/reference/connector/apis/check-in-connector-sync-job-api.asciidoc
  4. 6 7
      docs/reference/connector/apis/connector-apis.asciidoc
  5. 2 0
      docs/reference/connector/apis/create-connector-api.asciidoc
  6. 3 0
      docs/reference/connector/apis/create-connector-sync-job-api.asciidoc
  7. 2 3
      docs/reference/connector/apis/delete-connector-api.asciidoc
  8. 2 3
      docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc
  9. 2 1
      docs/reference/connector/apis/get-connector-api.asciidoc
  10. 2 1
      docs/reference/connector/apis/get-connector-sync-job-api.asciidoc
  11. 2 3
      docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc
  12. 2 3
      docs/reference/connector/apis/list-connectors-api.asciidoc
  13. 2 0
      docs/reference/connector/apis/set-connector-sync-job-error-api.asciidoc
  14. 2 0
      docs/reference/connector/apis/set-connector-sync-job-stats-api.asciidoc
  15. 2 3
      docs/reference/connector/apis/update-connector-configuration-api.asciidoc
  16. 2 3
      docs/reference/connector/apis/update-connector-error-api.asciidoc
  17. 3 3
      docs/reference/connector/apis/update-connector-filtering-api.asciidoc
  18. 2 3
      docs/reference/connector/apis/update-connector-last-sync-api.asciidoc
  19. 3 3
      docs/reference/connector/apis/update-connector-name-description-api.asciidoc
  20. 2 3
      docs/reference/connector/apis/update-connector-pipeline-api.asciidoc
  21. 2 3
      docs/reference/connector/apis/update-connector-scheduling-api.asciidoc

+ 2 - 0
docs/reference/connector/apis/cancel-connector-sync-job-api.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Cancel connector sync job</titleabbrev>
 ++++
 
+preview::[]
+
 Cancels a connector sync job.
 
 [[cancel-connector-sync-job-api-request]]

+ 2 - 3
docs/reference/connector/apis/check-in-connector-api.asciidoc

@@ -1,12 +1,11 @@
 [[check-in-connector-api]]
 === Check in connector API
-
-preview::[]
-
 ++++
 <titleabbrev>Check in a connector</titleabbrev>
 ++++
 
+preview::[]
+
 Updates the `last_seen` field of a connector with current timestamp.
 
 [[check-in-connector-api-request]]

+ 2 - 0
docs/reference/connector/apis/check-in-connector-sync-job-api.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Check in connector sync job</titleabbrev>
 ++++
 
+preview::[]
+
 Checks in a connector sync job (updates `last_seen` to the current time).
 
 [[check-in-connector-sync-job-api-request]]

+ 6 - 7
docs/reference/connector/apis/connector-apis.asciidoc

@@ -3,17 +3,16 @@
 
 preview::[]
 
-++++
-<titleabbrev>Connector APIs</titleabbrev>
-++++
-
----
-
-The connector and sync jobs API provides a convenient way to create and manage Elastic connectors and sync jobs in an internal index.
+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.
 
 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.
 
+[TIP]
+====
+We also have a command-line interface for Elastic connectors. Learn more in the https://github.com/elastic/connectors/blob/main/docs/CLI.md[elastic/connectors] repository.
+====
+
 [discrete]
 [[elastic-connector-apis]]
 === Connector APIs

+ 2 - 0
docs/reference/connector/apis/create-connector-api.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Create connector</titleabbrev>
 ++++
 
+preview::[]
+
 Creates a connector.
 
 

+ 3 - 0
docs/reference/connector/apis/create-connector-sync-job-api.asciidoc

@@ -4,6 +4,9 @@
 <titleabbrev>Create connector sync job</titleabbrev>
 ++++
 
+preview::[]
+
+
 Creates a connector sync job.
 
 [source, console]

+ 2 - 3
docs/reference/connector/apis/delete-connector-api.asciidoc

@@ -1,12 +1,11 @@
 [[delete-connector-api]]
 === Delete connector API
-
-preview::[]
-
 ++++
 <titleabbrev>Delete connector</titleabbrev>
 ++++
 
+preview::[]
+
 Removes a connector and its associated data.
 This is a destructive action that is not recoverable.
 

+ 2 - 3
docs/reference/connector/apis/delete-connector-sync-job-api.asciidoc

@@ -1,12 +1,11 @@
 [[delete-connector-sync-job-api]]
 === Delete connector sync job API
-
-preview::[]
-
 ++++
 <titleabbrev>Delete connector sync job</titleabbrev>
 ++++
 
+preview::[]
+
 Removes a connector sync job and its associated data.
 This is a destructive action that is not recoverable.
 

+ 2 - 1
docs/reference/connector/apis/get-connector-api.asciidoc

@@ -1,10 +1,11 @@
 [[get-connector-api]]
 === Get connector API
-preview::[]
 ++++
 <titleabbrev>Get connector</titleabbrev>
 ++++
 
+preview::[]
+
 Retrieves the details about a connector.
 
 [[get-connector-api-request]]

+ 2 - 1
docs/reference/connector/apis/get-connector-sync-job-api.asciidoc

@@ -1,10 +1,11 @@
 [[get-connector-sync-job-api]]
 === Get connector sync job API
-preview::[]
 ++++
 <titleabbrev>Get connector sync job</titleabbrev>
 ++++
 
+preview::[]
+
 Retrieves the details about a connector sync job.
 
 [[get-connector-sync-job-api-request]]

+ 2 - 3
docs/reference/connector/apis/list-connector-sync-jobs-api.asciidoc

@@ -1,13 +1,12 @@
 [role="xpack"]
 [[list-connector-sync-jobs-api]]
 === List connector sync jobs API
-
-preview::[]
-
 ++++
 <titleabbrev>List connector sync jobs</titleabbrev>
 ++++
 
+preview::[]
+
 Returns information about all stored connector sync jobs ordered by their creation date in ascending order.
 
 

+ 2 - 3
docs/reference/connector/apis/list-connectors-api.asciidoc

@@ -1,13 +1,12 @@
 [role="xpack"]
 [[list-connector-api]]
 === List connectors API
-
-preview::[]
-
 ++++
 <titleabbrev>List connectors</titleabbrev>
 ++++
 
+preview::[]
+
 Returns information about all stored connectors.
 
 

+ 2 - 0
docs/reference/connector/apis/set-connector-sync-job-error-api.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Set connector sync job error</titleabbrev>
 ++++
 
+preview::[]
+
 Sets a connector sync job error.
 
 [[set-connector-sync-job-error-api-request]]

+ 2 - 0
docs/reference/connector/apis/set-connector-sync-job-stats-api.asciidoc

@@ -4,6 +4,8 @@
 <titleabbrev>Set connector sync job stats</titleabbrev>
 ++++
 
+preview::[]
+
 Sets connector sync job stats.
 
 [[set-connector-sync-job-stats-api-request]]

+ 2 - 3
docs/reference/connector/apis/update-connector-configuration-api.asciidoc

@@ -1,12 +1,11 @@
 [[update-connector-configuration-api]]
 === Update connector configuration API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector configuration</titleabbrev>
 ++++
 
+preview::[]
+
 Updates the `configuration` of a connector.
 
 

+ 2 - 3
docs/reference/connector/apis/update-connector-error-api.asciidoc

@@ -1,12 +1,11 @@
 [[update-connector-error-api]]
 === Update connector error API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector error</titleabbrev>
 ++++
 
+preview::[]
+
 Updates the `error` field of a connector.
 
 [[update-connector-error-api-request]]

+ 3 - 3
docs/reference/connector/apis/update-connector-filtering-api.asciidoc

@@ -1,12 +1,12 @@
 [[update-connector-filtering-api]]
 === Update connector filtering API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector filtering</titleabbrev>
 ++++
 
+preview::[]
+
+
 Updates the `filtering` configuration of a connector. Learn more about filtering in the {enterprise-search-ref}/sync-rules.html[sync rules] documentation.
 
 [[update-connector-filtering-api-request]]

+ 2 - 3
docs/reference/connector/apis/update-connector-last-sync-api.asciidoc

@@ -1,12 +1,11 @@
 [[update-connector-last-sync-api]]
 === Update connector last sync stats API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector last sync stats</titleabbrev>
 ++++
 
+preview::[]
+
 Updates the fields related to the last sync of a connector.
 
 This action is used for analytics and monitoring.

+ 3 - 3
docs/reference/connector/apis/update-connector-name-description-api.asciidoc

@@ -1,12 +1,12 @@
 [[update-connector-name-description-api]]
 === Update connector name and description API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector name and description</titleabbrev>
 ++++
 
+preview::[]
+
+
 Updates the `name` and `description` fields of a connector.
 
 [[update-connector-name-description-api-request]]

+ 2 - 3
docs/reference/connector/apis/update-connector-pipeline-api.asciidoc

@@ -1,12 +1,11 @@
 [[update-connector-pipeline-api]]
 === Update connector pipeline API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector pipeline</titleabbrev>
 ++++
 
+preview::[]
+
 Updates the `pipeline` configuration of a connector.
 
 When you create a new connector, the configuration of an <<ingest-pipeline-search-details-generic-reference, ingest pipeline>> is populated with default settings.

+ 2 - 3
docs/reference/connector/apis/update-connector-scheduling-api.asciidoc

@@ -1,12 +1,11 @@
 [[update-connector-scheduling-api]]
 === Update connector scheduling API
-
-preview::[]
-
 ++++
 <titleabbrev>Update connector scheduling</titleabbrev>
 ++++
 
+preview::[]
+
 Updates the `scheduling` configuration of a connector.
 
 [[update-connector-scheduling-api-request]]