Add deprecation notice to dashboard import/export docs.

elastic · Aug 17, 2021 · 90c398e · 90c398e
1 parent 85e0766
commit 90c398e
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 3 deletions.
diff --git a/docs/api/dashboard-api.asciidoc b/docs/api/dashboard-api.asciidoc
@@ -1,6 +1,8 @@
 [[dashboard-api]]
 == Import and export dashboard APIs
 
+deprecated::[7.15.0,Both of these APIs have been deprecated in favor of <<saved-objects-api-import, Import objects API>> and <<saved-objects-api-export, Export objects API>>.]
+
 Import and export dashboards with the corresponding saved objects, such as visualizations, saved
 searches, and index patterns.
 

diff --git a/docs/api/dashboard/export-dashboard.asciidoc b/docs/api/dashboard/export-dashboard.asciidoc
@@ -4,7 +4,9 @@
 <titleabbrev>Export dashboard</titleabbrev>
 ++++
 
-experimental[] Export dashboards and corresponding saved objects.
+deprecated::[7.15.0,Use <<saved-objects-api-export, Export objects API>> instead.]
+
+Export dashboards and corresponding saved objects.
 
 [[dashboard-api-export-request]]
 ==== Request

diff --git a/docs/api/dashboard/import-dashboard.asciidoc b/docs/api/dashboard/import-dashboard.asciidoc
@@ -4,7 +4,9 @@
 <titleabbrev>Import dashboard</titleabbrev>
 ++++
 
-experimental[] Import dashboards and corresponding saved objects.
+deprecated::[7.15.0,Use <<saved-objects-api-import, Import objects API>> instead.]
+
+Import dashboards and corresponding saved objects.
 
 [[dashboard-api-import-request]]
 ==== Request

diff --git a/docs/user/dashboard/dashboard.asciidoc b/docs/user/dashboard/dashboard.asciidoc
@@ -345,7 +345,7 @@ To share the dashboard with a larger audience, click *Share* in the toolbar. For
 [[import-dashboards]]
 == Export dashboards
 
-To automate {kib}, you can export dashboards as JSON using the <<dashboard-api,import and export dashboard APIs>>. It is important to export dashboards with all necessary references.
+To automate {kib}, you can export dashboards as NDJSON using the <<saved-objects-api-import, Import objects API>> and <<saved-objects-api-export, Export objects API>>. It is important to export dashboards with all necessary references.
 
 --
 include::tutorial-create-a-dashboard-of-lens-panels.asciidoc[]

diff --git a/src/plugins/legacy_export/server/lib/export/export_dashboards.ts b/src/plugins/legacy_export/server/lib/export/export_dashboards.ts
@@ -9,6 +9,7 @@
 import { SavedObjectsClientContract } from 'src/core/server';
 import { collectReferencesDeep } from './collect_references_deep';
 
+/** @deprecated */
 export async function exportDashboards(
   ids: string[],
   savedObjectsClient: SavedObjectsClientContract,

diff --git a/src/plugins/legacy_export/server/lib/import/import_dashboards.ts b/src/plugins/legacy_export/server/lib/import/import_dashboards.ts
@@ -8,6 +8,7 @@
 
 import { SavedObject, SavedObjectsClientContract } from 'src/core/server';
 
+/** @deprecated */
 export async function importDashboards(
   savedObjectsClient: SavedObjectsClientContract,
   objects: SavedObject[],