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

Adds deprecation notice to saved objects API docs #150124

Merged

Conversation

TinaHeiligers
Copy link
Contributor

Part of #149287
Fix 149988

Updates public API docs listing saved objects APIs that have been deprecated.

Checklist

  • Documentation was added for features that require explanation or tutorials

Risk Matrix

Risk Probability Severity Mitigation/Notes
High number of support cases and/or discuss issues asking for more alternative APIs than just for data views medium medium We plan to add more alternatives as public APIs become available

For maintainers

  • This was checked for breaking API changes and was labeled appropriately No breaking changes since these APIs are still available as deprecated

@github-actions
Copy link
Contributor

github-actions bot commented Feb 2, 2023

Documentation preview:

@TinaHeiligers TinaHeiligers added Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting docs v8.7.0 labels Feb 2, 2023
@elasticmachine
Copy link
Contributor

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

@TinaHeiligers
Copy link
Contributor Author

TinaHeiligers commented Feb 2, 2023

Preview of the SO APIs list:

Screen Shot 2023-02-01 at 5 39 54 PM

Copy link
Contributor

@KOTungseth KOTungseth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Do we know the version for when we plan to remove the APIs? If we do, can we include it?

@TinaHeiligers
Copy link
Contributor Author

Do we know the version for when we plan to remove the APIs?

Right now, we don't. Removing them entirely depends on when consumers no longer use these and we can guarantee there are alternatives. As soon as we know when they'll be removed, we'll add the version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs Feature:Saved Objects release_note:skip Skip the PR/issue when compiling release notes Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc v8.7.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Saved Objects API deprecation notice
3 participants