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.

Sign up for GitHub

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

Jump to bottom

Add deprecation warning to Saved Objects API landing page #191534

Closed
TinaHeiligers opened this issue Aug 27, 2024 · 1 comment · Fixed by #191693
Closed

Add deprecation warning to Saved Objects API landing page #191534

TinaHeiligers opened this issue Aug 27, 2024 · 1 comment · Fixed by #191693
Assignees
@TinaHeiligers
Labels
docs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc

Comments

@TinaHeiligers
Copy link
Contributor

The warning we added in #150124 was removed when the api documentation migrated to OAS. We need to add the warning back, with a removal version of 9.0 to the landing page to draw attention to pending changes.

The section should include the recommended migration paths for type-specific and multi-type APIs to use instead.
@TinaHeiligers TinaHeiligers added docs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc labels Aug 27, 2024
@TinaHeiligers TinaHeiligers self-assigned this Aug 27, 2024
@elasticmachine
Copy link
Contributor

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

@TinaHeiligers TinaHeiligers mentioned this issue Aug 29, 2024
Merged
1 task
TinaHeiligers added a commit that referenced this issue Aug 29, 2024
@TinaHeiligers @lcawl
[Docs] Add details to SO APIs landing page (#191693)
dd221a7 
Fix #191534
The deprecation warning in the Kibana Saved Objects API main page was
removed in #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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@TinaHeiligers TinaHeiligers

Labels
docs Team:Core Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Docs] Add details to SO APIs landing page TinaHeiligers/kibana
2 participants
@TinaHeiligers @elasticmachine