Skip to content

Commit

Permalink
Add deprecation notice to dashboard import/export docs. (#108826)
Browse files Browse the repository at this point in the history
  • Loading branch information
lukeelmers authored Aug 18, 2021
1 parent 8c8dca6 commit 49ba7e7
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/api/dashboard-api.asciidoc
Original file line number Diff line number Diff line change
@@ -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>> and <<saved-objects-api-export>>.]

Import and export dashboards with the corresponding saved objects, such as visualizations, saved
searches, and index patterns.

Expand Down
4 changes: 3 additions & 1 deletion docs/api/dashboard/export-dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
<titleabbrev>Export dashboard</titleabbrev>
++++

experimental[] Export dashboards and corresponding saved objects.
deprecated::[7.15.0,Use <<saved-objects-api-export>> instead.]

Export dashboards and corresponding saved objects.

[[dashboard-api-export-request]]
==== Request
Expand Down
4 changes: 3 additions & 1 deletion docs/api/dashboard/import-dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@
<titleabbrev>Import dashboard</titleabbrev>
++++

experimental[] Import dashboards and corresponding saved objects.
deprecated::[7.15.0,Use <<saved-objects-api-import>> instead.]

Import dashboards and corresponding saved objects.

[[dashboard-api-import-request]]
==== Request
Expand Down
2 changes: 1 addition & 1 deletion docs/user/dashboard/dashboard.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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-export, Export objects API>>. It is important to export dashboards with all necessary references.

--
include::tutorial-create-a-dashboard-of-lens-panels.asciidoc[]
Expand Down
2 changes: 1 addition & 1 deletion src/plugins/legacy_export/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `legacyExport` plugin
# `legacyExport` plugin [deprecated]

The `legacyExport` plugin adds support for the legacy saved objects export format.
1 change: 1 addition & 0 deletions src/plugins/legacy_export/server/plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import { Plugin, CoreSetup, PluginInitializerContext } from 'kibana/server';
import { registerRoutes } from './routes';

/** @deprecated */
export class LegacyExportPlugin implements Plugin<{}, {}> {
constructor(private readonly initContext: PluginInitializerContext) {}

Expand Down

0 comments on commit 49ba7e7

Please sign in to comment.