Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Saved Objects API deprecation notice #149988

Closed
TinaHeiligers opened this issue Jan 31, 2023 · 5 comments · Fixed by #150124
Closed

[Docs] Saved Objects API deprecation notice #149988

TinaHeiligers opened this issue Jan 31, 2023 · 5 comments · Fixed by #150124
Assignees
Labels
docs Epic:VersionedAPIs Kibana Versioned APIs Feature:Saved Objects Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@TinaHeiligers
Copy link
Contributor

TinaHeiligers commented Jan 31, 2023

The Saved Objects REST APIs have been deprecated in preparation for preferred versioned APIs. While these APIs have always been experimental and subject to change (or be removed) at any point, we realize they've been available for a while and most likely used by external consumers.

To give consumers enough time to migrate off of these, we're planning on deprecating them within an 18-month time frame.

Internal consumers will be working on implementing replacements but we need to determine the extent to which these API's are used outside of the context of Kibana source code.

As such, we need to update the docs to reflect their deprecated state and add alternative API's as they become public. At the moment, there's only a subset of alternatives for managing Data Views.

Note: The API's for import, export, resolve import errors, and rotate encryption key APIs are not deprecated and are not to be removed in the immediate future.

@botelastic botelastic bot added the needs-team Issues missing a team label label Jan 31, 2023
@TinaHeiligers TinaHeiligers added Feature:Saved Objects Epic:VersionedAPIs Kibana Versioned APIs and removed needs-team Issues missing a team label labels Jan 31, 2023
@botelastic botelastic bot added the needs-team Issues missing a team label label Jan 31, 2023
@TinaHeiligers TinaHeiligers self-assigned this Jan 31, 2023
@TinaHeiligers TinaHeiligers removed the needs-team Issues missing a team label label Feb 7, 2023
@botelastic botelastic bot added the needs-team Issues missing a team label label Feb 7, 2023
@nicholas-r-king
Copy link

When is this the removal occurring and what API is going to replace the Find Objects API for searching and acquiring object ids/objects. We have a use-case that requires this API and we don't want to build ourselves into a hole if this is still occurring without a good replacement.

@matthiasledergerber
Copy link

Same for us.

@rishithaminol
Copy link

Still I couldn't find a replacement API for this in the documentation.

@TinaHeiligers TinaHeiligers added the Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc label Apr 30, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-core (Team:Core)

@botelastic botelastic bot removed the needs-team Issues missing a team label label Apr 30, 2024
@TinaHeiligers
Copy link
Contributor Author

The date of removal will take a deprecation period into account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Epic:VersionedAPIs Kibana Versioned APIs Feature:Saved Objects Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants