From f88a35d3e57db6e2b8519afcdf6c49cab1433f46 Mon Sep 17 00:00:00 2001 From: KOTungseth Date: Tue, 14 Dec 2021 15:01:52 -0600 Subject: [PATCH] [DOCS] Updates {data-source} in REST APIs --- docs/api/saved-objects.asciidoc | 2 +- docs/api/saved-objects/bulk_create.asciidoc | 4 ++-- docs/api/saved-objects/bulk_get.asciidoc | 4 ++-- docs/api/saved-objects/delete.asciidoc | 2 +- docs/api/saved-objects/export.asciidoc | 4 ++-- docs/api/saved-objects/find.asciidoc | 2 +- docs/api/saved-objects/get.asciidoc | 2 +- docs/api/saved-objects/import.asciidoc | 12 ++++++------ docs/api/saved-objects/resolve.asciidoc | 2 +- .../api/saved-objects/resolve_import_errors.asciidoc | 4 ++-- docs/api/saved-objects/update.asciidoc | 2 +- .../spaces-management/copy_saved_objects.asciidoc | 12 ++++++------ .../resolve_copy_saved_objects_conflicts.asciidoc | 2 +- 13 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/api/saved-objects.asciidoc b/docs/api/saved-objects.asciidoc index fcb4b119c06c6..2185dfd4d21a4 100644 --- a/docs/api/saved-objects.asciidoc +++ b/docs/api/saved-objects.asciidoc @@ -6,7 +6,7 @@ Manage {kib} saved objects, including dashboards, visualizations, and more. WARNING: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions. -NOTE: For managing {kib} index patterns, use the <>. +NOTE: For managing {data-sources}, use the <>. The following saved objects APIs are available: diff --git a/docs/api/saved-objects/bulk_create.asciidoc b/docs/api/saved-objects/bulk_create.asciidoc index 471e297316578..dcb402ee1a1dc 100644 --- a/docs/api/saved-objects/bulk_create.asciidoc +++ b/docs/api/saved-objects/bulk_create.asciidoc @@ -72,7 +72,7 @@ Saved objects that are unable to persist are replaced with an error object. [[saved-objects-api-bulk-create-example]] ==== Example -Create an index pattern with the `my-pattern` ID, and a dashboard with the `my-dashboard` ID: +Create {a-data-source} with the `my-pattern` ID, and a dashboard with the `my-dashboard` ID: [source,sh] -------------------------------------------------- @@ -122,7 +122,7 @@ The API returns the following: } -------------------------------------------------- -There is already a saved object with the `my-dashboard` ID, so only the index pattern is created. +There is already a saved object with the `my-dashboard` ID, so only the {data-source} is created. [[saved-objects-api-bulk-create-conflict-errors]] ==== Conflict errors diff --git a/docs/api/saved-objects/bulk_get.asciidoc b/docs/api/saved-objects/bulk_get.asciidoc index 65cd93fe212f8..23163b18e8faf 100644 --- a/docs/api/saved-objects/bulk_get.asciidoc +++ b/docs/api/saved-objects/bulk_get.asciidoc @@ -59,7 +59,7 @@ Saved objects that are unable to persist are replaced with an error object. [[saved-objects-api-bulk-get-body-example]] ==== Example -Retrieve an index pattern with the `my-pattern` ID, and a dashboard with the `my-dashboard` ID: +Retrieve an {data-source} with the `my-pattern` ID, and a dashboard with the `my-dashboard` ID: [source,sh] -------------------------------------------------- @@ -103,4 +103,4 @@ The API returns the following: } -------------------------------------------------- -Only the index pattern exists. +Only the {data-source} exists. diff --git a/docs/api/saved-objects/delete.asciidoc b/docs/api/saved-objects/delete.asciidoc index ab50fd6e37eac..eca46e202beda 100644 --- a/docs/api/saved-objects/delete.asciidoc +++ b/docs/api/saved-objects/delete.asciidoc @@ -43,7 +43,7 @@ TIP: Use this if you attempted to delete an object and received an HTTP 400 erro ==== Example -Delete an index pattern object with the `my-pattern` ID: +Delete {a-data-source} object with the `my-pattern` ID: [source,sh] -------------------------------------------------- diff --git a/docs/api/saved-objects/export.asciidoc b/docs/api/saved-objects/export.asciidoc index 667a9c57ca802..53910835c4989 100644 --- a/docs/api/saved-objects/export.asciidoc +++ b/docs/api/saved-objects/export.asciidoc @@ -67,7 +67,7 @@ When `excludeExportDetails=false` (the default) we append an export result detai [[ssaved-objects-api-create-example]] ==== Examples -Export all index pattern saved objects: +Export all {data-source} saved objects: [source,sh] -------------------------------------------------- @@ -78,7 +78,7 @@ $ curl -X POST api/saved_objects/_export -H 'kbn-xsrf: true' -H 'Content-Type: a -------------------------------------------------- // KIBANA -Export all index pattern saved objects and exclude the export summary from the stream: +Export all {data-source} saved objects and exclude the export summary from the stream: [source,sh] -------------------------------------------------- diff --git a/docs/api/saved-objects/find.asciidoc b/docs/api/saved-objects/find.asciidoc index f04aeb8420620..43c7f4cde8fa8 100644 --- a/docs/api/saved-objects/find.asciidoc +++ b/docs/api/saved-objects/find.asciidoc @@ -73,7 +73,7 @@ change. Use the find API for traditional paginated results, but avoid using it t ==== Examples -Find index patterns with titles that start with `my`: +Find {data-sources} with titles that start with `my`: [source,sh] -------------------------------------------------- diff --git a/docs/api/saved-objects/get.asciidoc b/docs/api/saved-objects/get.asciidoc index cfc591d811227..174587b400993 100644 --- a/docs/api/saved-objects/get.asciidoc +++ b/docs/api/saved-objects/get.asciidoc @@ -35,7 +35,7 @@ experimental[] Retrieve a single {kib} saved object by ID. [[saved-objects-api-get-example]] ==== Example -Retrieve the index pattern object with the `my-pattern` ID: +Retrieve the {data-source} object with the `my-pattern` ID: [source,sh] -------------------------------------------------- diff --git a/docs/api/saved-objects/import.asciidoc b/docs/api/saved-objects/import.asciidoc index a214598af31af..8a6ef5b26e424 100644 --- a/docs/api/saved-objects/import.asciidoc +++ b/docs/api/saved-objects/import.asciidoc @@ -95,7 +95,7 @@ to resolve errors, refer to the <>. [[saved-objects-api-import-example-1]] ===== Successful import with `createNewCopies` enabled -Import an index pattern and dashboard: +Import {a-data-source} and dashboard: [source,sh] -------------------------------------------------- @@ -147,7 +147,7 @@ The result indicates a successful import, and both objects are created. Since th [[saved-objects-api-import-example-2]] ===== Successful import with `createNewCopies` disabled -Import an index pattern and dashboard: +Import {a-data-source} and dashboard: [source,sh] -------------------------------------------------- @@ -196,7 +196,7 @@ The result indicates a successful import, and both objects are created. [[saved-objects-api-import-example-3]] ===== Failed import with conflict errors -Import an index pattern, visualization, *Canvas* workpad, and dashboard that include saved objects: +Import {a-data-source}, visualization, *Canvas* workpad, and dashboard that include saved objects: [source,sh] -------------------------------------------------- @@ -285,10 +285,10 @@ The API returns the following: } -------------------------------------------------- -The result indicates an unsuccessful import because the index pattern, visualization, *Canvas* workpad, and dashboard resulted in a conflict +The result indicates an unsuccessful import because the {data-source}, visualization, *Canvas* workpad, and dashboard resulted in a conflict error: -* An index pattern with the same ID already exists, which resulted in a conflict error. To resolve the error, overwrite the existing object, +* A {data-source} with the same ID already exists, which resulted in a conflict error. To resolve the error, overwrite the existing object, or skip the object. * A visualization with a different ID, but the same origin already exists, which resulted in a conflict error. The `destinationId` field @@ -307,7 +307,7 @@ Objects are created when the error is resolved using the <>. This example builds upon the <>. -Resolve conflict errors for an index pattern, visualization, and *Canvas* workpad by overwriting the existing saved objects: +Resolve conflict errors for {a-data-source}, visualization, and *Canvas* workpad by overwriting the existing saved objects: [source,sh] -------------------------------------------------- @@ -173,7 +173,7 @@ that were returned in the `successResults` array. In this example, we retried im This example builds upon the <>. -Resolve a missing reference error for a visualization by replacing the index pattern with another, and resolve a missing reference error for +Resolve a missing reference error for a visualization by replacing the {data-source} with another, and resolve a missing reference error for a search by ignoring it: [source,sh] diff --git a/docs/api/saved-objects/update.asciidoc b/docs/api/saved-objects/update.asciidoc index fccc6112948a1..fb7decccabd4c 100644 --- a/docs/api/saved-objects/update.asciidoc +++ b/docs/api/saved-objects/update.asciidoc @@ -54,7 +54,7 @@ WARNING: When you update, attributes are not validated, which allows you to pass [[saved-objects-api-update-example]] ==== Example -Update an existing index pattern object,`my-pattern`, with a different title: +Update an existing {data-source} object,`my-pattern`, with a different title: [source,sh] -------------------------------------------------- diff --git a/docs/api/spaces-management/copy_saved_objects.asciidoc b/docs/api/spaces-management/copy_saved_objects.asciidoc index cf18af9b28a34..0aa6ac58c55cb 100644 --- a/docs/api/spaces-management/copy_saved_objects.asciidoc +++ b/docs/api/spaces-management/copy_saved_objects.asciidoc @@ -8,7 +8,7 @@ experimental[] Copy saved objects between spaces. It also allows you to automatically copy related objects, so when you copy a `dashboard`, this can automatically copy over the -associated visualizations, index patterns, and saved searches, as required. +associated visualizations, {data-sources}, and saved searches, as required. You can request to overwrite any objects that already exist in the target space if they share an ID, or you can use the <> to do this on a per-object basis. @@ -125,7 +125,7 @@ refer to the <>. ===== Successful copy (with `createNewCopies` enabled) Copy a dashboard with the `my-dashboard` ID, including all references from the `default` space to the `marketing` space. In this example, -the dashboard has a reference to a visualization, and that has a reference to an index pattern: +the dashboard has a reference to a visualization, and that has a reference to {a-data-source}: [source,sh] ---- @@ -189,7 +189,7 @@ The result indicates a successful copy, and all three objects are created. Since ===== Successful copy (with `createNewCopies` disabled) Copy a dashboard with the `my-dashboard` ID, including all references from the `default` space to the `marketing` space. In this example, -the dashboard has a reference to a visualization, and that has a reference to an index pattern: +the dashboard has a reference to a visualization, and that has a reference to {a-data-source}: [source,sh] ---- @@ -379,10 +379,10 @@ The API returns the following: } ---- -The result indicates a successful copy for the `marketing` space, and an unsuccessful copy for the `sales` space because the index pattern, +The result indicates a successful copy for the `marketing` space, and an unsuccessful copy for the `sales` space because the {data-source}, visualization, and *Canvas* workpad each resulted in a conflict error: -* An index pattern with the same ID already exists, which resulted in a conflict error. To resolve the error, overwrite the existing object, +* A {data-source} with the same ID already exists, which resulted in a conflict error. To resolve the error, overwrite the existing object, or skip the object. * A visualization with a different ID, but the same origin already exists, which resulted in a conflict error. The `destinationId` field @@ -403,7 +403,7 @@ API>>. ===== Failed copy (with missing reference errors) Copy a dashboard with the `my-dashboard` ID, including all references from the `default` space to the `marketing` space. In this example, -the dashboard has a reference to a visualization and a *Canvas* workpad, and the visualization has a reference to an index pattern: +the dashboard has a reference to a visualization and a *Canvas* workpad, and the visualization has a reference to {a-data-source}: [source,sh] ---- diff --git a/docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc b/docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc index 1a0017fe167ab..d79df2c085b19 100644 --- a/docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc +++ b/docs/api/spaces-management/resolve_copy_saved_objects_conflicts.asciidoc @@ -141,7 +141,7 @@ refer to the < This example builds upon the <>. -Resolve conflict errors for an index pattern, visualization, and *Canvas* workpad by overwriting the existing saved objects: +Resolve conflict errors for {a-data-source}, visualization, and *Canvas* workpad by overwriting the existing saved objects: [source,sh] ----