Skip to content

Commit

Permalink
[OAS] Add deprecated saved object APIs (#164355)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Aug 25, 2023
1 parent c115f5d commit 16f7189
Show file tree
Hide file tree
Showing 35 changed files with 2,250 additions and 268 deletions.
6 changes: 6 additions & 0 deletions docs/api/saved-objects/bulk_create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Create multiple {kib} saved objects.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-bulk-create-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/bulk_delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Remove multiple {kib} saved objects.

WARNING: Once you delete a saved object, _it cannot be recovered_.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

==== Request

`POST <kibana host>:<port>/api/saved_objects/_bulk_delete`
Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/bulk_get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Retrieve multiple {kib} saved objects by ID.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-bulk-get-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/bulk_resolve.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ Under certain circumstances, when Kibana is upgraded, saved object migrations ma
features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that
object can be retrieved via the Bulk Resolve API using either its new ID or its old ID.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-bulk-resolve-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/bulk_update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Update the attributes for multiple existing {kib} saved objects.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-bulk-update-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Create {kib} saved objects.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-create-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/delete.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Remove {kib} saved objects.

WARNING: Once you delete a saved object, _it cannot be recovered_.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-delete-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/find.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Retrieve a paginated set of {kib} saved objects by various conditions.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-find-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/get.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Retrieve a single {kib} saved object by ID.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-get-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/resolve.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ Under certain circumstances, when Kibana is upgraded, saved object migrations ma
features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that
object can be retrieved via the Resolve API using either its new ID or its old ID.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-resolve-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/resolve_import_errors.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ To resolve errors, you can:

* Change references to different saved objects

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-resolve-import-errors-request]]
==== Request

Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/rotate_encryption_key.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@

experimental[] Rotate the encryption key for encrypted saved objects.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

If a saved object cannot be decrypted using the primary encryption key, then {kib} will attempt to decrypt it using the specified <<xpack-encryptedSavedObjects-keyRotation-decryptionOnlyKeys, decryption-only keys>>. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.

[IMPORTANT]
Expand Down
6 changes: 6 additions & 0 deletions docs/api/saved-objects/update.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]

Update the attributes for existing {kib} saved objects.

[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====

[[saved-objects-api-update-request]]
==== Request

Expand Down
Loading

0 comments on commit 16f7189

Please sign in to comment.