Skip to content

Commit

Permalink
Release note: internal HTTP APIs blocked from 9.0.0 (#195257)
Browse files Browse the repository at this point in the history
## Summary

Added a breaking change release note using the new template.

---------

Co-authored-by: florent-leborgne <[email protected]>
  • Loading branch information
jloleysens and florent-leborgne authored Oct 7, 2024
1 parent 6b3bb66 commit b3d6038
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions docs/upgrade-notes.asciidoc
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,28 @@ 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 is restricted from version 9.0.0. This is to ensure
that HTTP API integrations with Kibana avoid unexpected breaking changes.
Refer to {kibana-pull}193792[#193792].
*Impact* +
Any HTTP API calls to internal Kibana endpoints will fail with a 400 status code starting
from version 9.0.0.
*Action* +
**Do not integrate with internal HTTP APIs**. They may change or be removed without notice,
and lead to unexpected behaviors. If you would like some capability to be exposed over an
HTTP API, https://github.com/elastic/kibana/issues/new/choose[create an issue].
We would love to discuss your use case.
====

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

0 comments on commit b3d6038

Please sign in to comment.