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] Add details to SO APIs landing page #191693

Merged

Conversation

TinaHeiligers
Copy link
Contributor

@TinaHeiligers TinaHeiligers commented Aug 29, 2024

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.

  • Documentation was added for features that require explanation or tutorials

VIew the html diff for these changes:

Short URLs API landing page

Data views API landing page

The updated OpenAPI document looks like this in a Bump.sh preview:

image

Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@TinaHeiligers TinaHeiligers added the release_note:skip Skip the PR/issue when compiling release notes label Aug 29, 2024
@TinaHeiligers
Copy link
Contributor Author

FYI @elastic/kibana-core

@TinaHeiligers TinaHeiligers removed the request for review from vadimkibana August 29, 2024 15:24
Copy link
Contributor

@mattkime mattkime left a comment

Choose a reason for hiding this comment

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

changes lgtm

@lcawl lcawl requested a review from a team as a code owner August 29, 2024 17:26
Copy link
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@TinaHeiligers TinaHeiligers enabled auto-merge (squash) August 29, 2024 17:50
@TinaHeiligers
Copy link
Contributor Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@TinaHeiligers TinaHeiligers merged commit dd221a7 into elastic:main Aug 29, 2024
21 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Aug 29, 2024
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 release_note:skip Skip the PR/issue when compiling release notes v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add deprecation warning to Saved Objects API landing page
6 participants