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

Release note: internal HTTP APIs blocked from 9.0.0 #195257

Merged
merged 3 commits into from
Oct 7, 2024
Merged

Release note: internal HTTP APIs blocked from 9.0.0 #195257

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bf8ab14
some copy and formatting updates
jloleysens Oct 7, 2024
e737d5b
added first pass at breaking change guide for 9.0.0
jloleysens Oct 7, 2024
20a4f21
Update docs/upgrade-notes.asciidoc
jloleysens Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions docs/upgrade-notes.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ ADD INSTRUCTIONS FOR USERS LOOKING TO UPGRADE. HOW CAN THEY WORK AROUND THIS?
====


1. Copy and edit the template in the right area section of this file. Most recent entries should be at the top of the section.
2. Edit the anchor ID [[REPO-PR]] of the template with proper values.
1. Copy and edit the template in the right section of this file. Most recent entries should be at the top of the section, search for sections using the text "[float]".
2. Edit the anchor ID [[REPO-PR]] of the template with proper values.
3. Don't hardcode the link to the new entry. Instead, make it available through the doc link service files:
- https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/get_doc_links.ts
- https://github.com/elastic/kibana/blob/main/packages/kbn-doc-links/src/types.ts
Expand All @@ -31,15 +31,15 @@ The entry in the main links file should look like this:
id: `${KIBANA_DOCS}breaking-changes-summary.html#REPO-PR`

Where:
- `id` is the ID of your choice.
- `id` is the ID of your choice.
- `REPO-PR` is the anchor ID that you assigned to the entry in this upgrade document.

4. You can then call the link from any Kibana code. For example: `href: docLinks.links.upgradeAssistant.id`
Check https://docs.elastic.dev/docs/kibana-doc-links (internal) for more details about the Doc links service.

////

Before you upgrade, review the breaking changes and deprecations introduced in {kib} 8.x, then mitigate the impact.
Before you upgrade, review the breaking changes and deprecations introduced in {kib} 8.x, then mitigate the impact.

For Elastic Security release information, refer to {security-guide}/release-notes.html[_Elastic Security Solution Release Notes_].

Expand All @@ -49,6 +49,27 @@ For Elastic Security release information, refer to {security-guide}/release-note
[float]
==== Kibana APIs

[discrete]
[[breaking-193792]]
.Access to all internal APIs is blocked (9.0.0)
[%collapsible]
====
*Details* +
Access to internal Kibana HTTP APIs will be restricted from 9.0.0. This is to ensure
a HTTP API integrations with Kibana avoid unexpected breaking changes. See {kibana-pull}193792[#193792].

*Impact* +
Any HTTP API calls to internal Kibana endpoints will fail with a 400 status code starting
from 9.0.0.

*Action* +
**Do not integrate with internal HTTP APIs**. They may change or be removed without notice
or lead to unexpected behavior. If you would like some capability to be exposed over
HTTP API please create an issue:https://github.com/elastic/kibana/issues/new/choose,
we would love to discuss your use case.

====
jloleysens marked this conversation as resolved.
Show resolved Hide resolved

[discrete]
[[breaking-162506]]
.Get case metrics APIs became internal. (8.10)
Expand Down