kibana/docs/api/dashboard-api.asciidoc
Christiane (Tina) Heiligers dd221a7be1
[Docs] Add details to SO APIs landing page (#191693)
Fix https://github.com/elastic/kibana/issues/191534
The deprecation warning in the Kibana Saved Objects API main page was
removed in https://github.com/elastic/kibana/pull/190654.

This PR adds a section about when the APIs will be removed and what to
use instead.

The PR also includes updates to other API main pages that mention the SO
APIs.

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials

VIew the [html
diff](https://kibana_bk_191693.docs-preview.app.elstc.co/diff) for these
changes:

![Short URLs API landing
page](https://github.com/user-attachments/assets/3716f33e-0d00-4ff7-b29d-7a5ba0a0f1f2)

![Data views API landing
page](https://github.com/user-attachments/assets/81c8a843-27ca-4510-a181-7ec9b20f86d6)

The updated OpenAPI document looks like this in a Bump.sh preview:


![image](https://github.com/user-attachments/assets/a8b58142-5082-4b75-8b3f-339b8a6b57e4)

---------

Co-authored-by: lcawl <lcawley@elastic.co>
2024-08-29 15:04:00 -05:00

19 lines
820 B
Text

[[dashboard-api]]
== Import and export dashboard APIs
deprecated::[7.15.0,Both of these APIs have been deprecated and will be removed in 9.0.0]
Import and export dashboards with the corresponding saved objects, such as visualizations, saved
searches, and data views.
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.
The following import and export dashboard APIs are available:
* <<dashboard-import-api, Import dashboard API>> to import dashboards and corresponding saved objects
* <<dashboard-api-export, Export dashboard API>> to export dashboards and corresponding saved objects
include::dashboard/import-dashboard.asciidoc[]
include::dashboard/export-dashboard.asciidoc[]