github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

Adds deprecation notice to saved objects API docs (#150124)

Browse source 
Fix https://github.com/elastic/kibana/issues/149988
This commit is contained in:
Christiane (Tina) Heiligers 2023-02-02 11:13:45 -07:00 • committed by GitHub
parent 66e7bba497
commit 3f4f1cb8c7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/api/saved-objects.asciidoc
View file

@ -6,9 +6,16 @@ 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 {data-sources}, use the <<data-views-api, {data-sources} API>>.
The following saved objects APIs are available:
* <<saved-objects-api-export, Export objects API>> to retrieve sets of saved objects that you want to import into {kib}
* <<saved-objects-api-import, Import objects API>> to create sets of {kib} saved objects from a file created by the export API
* <<saved-objects-api-resolve-import-errors, Resolve import errors API>> to resolve errors from the import API
* <<saved-objects-api-rotate-encryption-key, Rotate encryption key API>> to rotate the encryption key for encrypted saved objects
deprecated::[8.7.0,Use <<data-views-api>> for managing data views]
* <<saved-objects-api-get, Get object API>> to retrieve a single {kib} saved object by ID
@ -32,13 +39,10 @@ The following saved objects APIs are available:
* <<saved-objects-api-bulk-delete, Bulk delete objects API>> to remove multiple {kib} saved objects
* <<saved-objects-api-export, Export objects API>> to retrieve sets of saved objects that you want to import into {kib}
* <<saved-objects-api-import, Import objects API>> to create sets of {kib} saved objects from a file created by the export API
* <<saved-objects-api-resolve-import-errors, Resolve import errors API>> to resolve errors from the import API
* <<saved-objects-api-rotate-encryption-key, Rotate encryption key API>> to rotate the encryption key for encrypted saved objects
include::saved-objects/export.asciidoc[]
include::saved-objects/import.asciidoc[]
include::saved-objects/resolve_import_errors.asciidoc[]
include::saved-objects/rotate_encryption_key.asciidoc[]
include::saved-objects/get.asciidoc[]
include::saved-objects/bulk_get.asciidoc[]
@ -49,9 +53,6 @@ include::saved-objects/update.asciidoc[]
include::saved-objects/bulk_update.asciidoc[]
include::saved-objects/delete.asciidoc[]
include::saved-objects/bulk_delete.asciidoc[]
include::saved-objects/export.asciidoc[]
include::saved-objects/import.asciidoc[]
include::saved-objects/resolve_import_errors.asciidoc[]
include::saved-objects/resolve.asciidoc[]
include::saved-objects/bulk_resolve.asciidoc[]
include::saved-objects/rotate_encryption_key.asciidoc[]