-
Notifications
You must be signed in to change notification settings - Fork 8.2k
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] Remove saved object and data view API pages #190654
Conversation
A documentation preview will be available soon. Request a new doc build by commenting
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. |
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
💚 Build Succeeded
History
To update your PR or re-run it, just comment with: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, with very minor alignment on how these deprecation notes refer to the saved objects API(s?)
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
Co-authored-by: florent-leborgne <florent.leborgne@elastic.co> (cherry picked from commit cf43ba2)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…190842) # Backport This will backport the following commits from `main` to `8.15`: - [[DOCS] Remove saved object and data view API pages (#190654)](#190654) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-08-20T17:29:06Z","message":"[DOCS] Remove saved object and data view API pages (#190654)\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>","sha":"cf43ba2f2702bdcb857d19290931ba6bfc84ff5a","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Saved Objects","release_note:skip","docs","backport:prev-minor","v8.16.0"],"title":"[DOCS] Remove saved object and data view API pages","number":190654,"url":"https://github.com/elastic/kibana/pull/190654","mergeCommit":{"message":"[DOCS] Remove saved object and data view API pages (#190654)\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>","sha":"cf43ba2f2702bdcb857d19290931ba6bfc84ff5a"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","branchLabelMappingKey":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190654","number":190654,"mergeCommit":{"message":"[DOCS] Remove saved object and data view API pages (#190654)\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>","sha":"cf43ba2f2702bdcb857d19290931ba6bfc84ff5a"}}]}] BACKPORT--> Co-authored-by: Lisa Cawley <lcawley@elastic.co>
@lcawl I wish I'd seen this PR before merge. With the changes in this PR, users might think we've decided against removing most of them (they've been experimental for years) and do nothing, only to get frustrated when the APIs are removed in 9.0. |
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 <lcawley@elastic.co>
Fix elastic#191534 The deprecation warning in the Kibana Saved Objects API main page was removed in elastic#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 <lcawley@elastic.co>
Summary
This PR removes the pages under https://www.elastic.co/guide/en/kibana/current/saved-objects-api.html and https://www.elastic.co/guide/en/kibana/current/data-views-api.html and adds redirects to https://www.elastic.co/docs/api/doc/kibana/group/endpoint-saved-objects and https://www.elastic.co/docs/api/doc/kibana/group/endpoint-data-views