[ResponseOps][Alerting] Add deprecation object to legacy rule endpoints #201550

jcger · 2024-11-25T11:06:16Z

Summary

Adds deprecation object in deprecated alerting routes

Closes #196556

github-actions · 2024-11-25T11:06:31Z

A documentation preview will be available soon.

🔨 Buildkite builds
📚 HTML diff
📙 Preview page

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.}

jcger · 2024-11-25T16:29:07Z

docs/upgrade-notes.asciidoc

+`POST /api/alerts/alert/{id}/_mute_all` has been replaced by `POST /api/alerting/rule/{id}/_mute_all`
+`POST /api/alerts/alert/{id}/_unmute_all` has been replaced by `POST /api/alerting/rule/{id}/_unmute_all`
+`POST /api/alerts/alert/{id}/_update_api_key` has been replaced by `POST /api/alerting/rule/{id}/_update_api_key`
+`GET /api/alerts/{id}/_instance_summary` has been deprecated without replacement


I couldn't find a replacement for this, therefore the deprecation note

jcger · 2024-11-25T16:32:30Z

docs/upgrade-notes.asciidoc

+`POST /api/alerts/alert/{id}/_unmute_all` has been replaced by `POST /api/alerting/rule/{id}/_unmute_all`
+`POST /api/alerts/alert/{id}/_update_api_key` has been replaced by `POST /api/alerting/rule/{id}/_update_api_key`
+`GET /api/alerts/{id}/_instance_summary` has been deprecated without replacement
+`GET /api/alerts/{id}/state` has been deprecated without replacement


I found this replacement route but it's internal and therefore the deprecation note. Wdyt?

Yes, we should not offer the internal APIs as alternatives.

cnasikas

LGMT! I think we should put in the upgrade notes a link to our documentation (https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-alerting) if users want to learn about the new routes in more detail.

cnasikas · 2024-11-26T07:51:56Z

x-pack/plugins/alerting/server/routes/legacy/get_alert_instance_summary.ts

+          documentationUrl: docLinks.links.alerting.legacyRuleApiDeprecations,
+          severity: 'warning',
+          reason: {
+            type: 'deprecate',


I think this should be remove as the API will be removed in 9.0.

cnasikas · 2024-11-26T07:52:17Z

x-pack/plugins/alerting/server/routes/legacy/get_alert_state.ts

+          documentationUrl: docLinks.links.alerting.legacyRuleApiDeprecations,
+          severity: 'warning',
+          reason: {
+            type: 'deprecate',


I think this should be remove as the API will be removed in 9.0.

cnasikas · 2024-11-26T07:57:28Z

docs/upgrade-notes.asciidoc

+`POST /api/alerts/alert/{id}/_unmute_all` has been replaced by `POST /api/alerting/rule/{id}/_unmute_all`
+`POST /api/alerts/alert/{id}/_update_api_key` has been replaced by `POST /api/alerting/rule/{id}/_update_api_key`
+`GET /api/alerts/{id}/_instance_summary` has been deprecated without replacement
+`GET /api/alerts/{id}/state` has been deprecated without replacement


Yes, we should not offer the internal APIs as alternatives.

cnasikas · 2024-11-26T10:07:17Z

Btw, I checked the docs and noticed that the routes are shown in one big line/paragraph.

Also. the Kibana 9.0 section does not include the new changes

jcger · 2024-11-26T12:31:08Z

Btw, I checked the docs and noticed that the routes are shown in one big line/paragraph.

Yes, I've tried already with a list but didn't work, it's gonna be html so I'm trying with empty lines in between now. I would like to avoid adding <br /> tags as this issue should be solved in the renderer that inserts our notes. It's happening for all the others too.

add doc link to new api use reason.type remove instead oof deprecate for apis we will remove

cnasikas · 2024-11-26T13:48:27Z

Btw, I checked the docs and noticed that the routes are shown in one big line/paragraph.

Yes, I've tried already with a list but didn't work, it's gonna be html so I'm trying with empty lines in between now. I would like to avoid adding <br /> tags as this issue should be solved in the renderer that inserts our notes. It's happening for all the others too.

Ok! Maybe someone from the docs team can help with this. cc @lcawl

umbopepato

LGTM!

…s-deprecation-object

elasticmachine · 2024-11-27T15:08:47Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: 8b5766f

Failed CI Steps

Test Failures

[job] [logs] FTR Configs #9 / management Index patterns on aliases discover verify hits should be able to discover and verify no of hits for alias2
[job] [logs] FTR Configs #103 / Rules Management - Prebuilt Rules - Prebuilt Rules Management @ess @serverless @skipInServerlessMKI Prebuilt Rules status get_prebuilt_rules_status - legacy rule package with historical versions should return available rule updates when previous historical versions unavailable

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`aiAssistantManagementSelection`	92.9KB	93.0KB	+78.0B
`lists`	145.3KB	145.4KB	+78.0B
total			+156.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`core`	454.4KB	454.5KB	+78.0B

History

💛 Build #254784 was flaky 2ea6b1c
💚 Build #254501 succeeded 1a44804
💔 Build #254414 failed 1c6ffe5
💔 Build #254096 failed a90cabb
💔 Build #254016 failed 33fcdb8

lcawl · 2024-11-27T16:47:28Z

Btw, I checked the docs and noticed that the routes are shown in one big line/paragraph.

Yes, I've tried already with a list but didn't work, it's gonna be html so I'm trying with empty lines in between now. I would like to avoid adding <br /> tags as this issue should be solved in the renderer that inserts our notes. It's happening for all the others too.

I've added bulleted lists in b07b47e

lcawl · 2024-11-27T16:59:48Z

Also. the Kibana 9.0 section does not include the new changes

I've copied the content so it appears in both places and edited the subtitle to align with the other breaking changes via ad0e7cc

lcawl

Docs LGTM!
Note we'll also need to clean up the API docs, so I've left a comment in #196556

kibanamachine · 2024-11-28T07:45:29Z

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/12064571460

kibanamachine · 2024-11-28T07:50:24Z

💔 All backports failed

Status	Branch	Result
❌	8.x	Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 201550

Questions ?

Please refer to the Backport tool documentation

jcger · 2024-11-28T13:00:34Z

💚 All backports created successfully

Status	Branch	Result
✅	8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

…ts (elastic#201550) ## Summary Adds deprecation object in deprecated alerting routes Closes elastic#196556 --------- Co-authored-by: lcawl <lcawley@elastic.co> (cherry picked from commit 93b67fb) # Conflicts: # docs/CHANGELOG.asciidoc

…ndpoints (#201550) (#202165) # Backport This will backport the following commits from `main` to `8.x`: - [[ResponseOps][Alerting] Add deprecation object to legacy rule endpoints (#201550)](#201550)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)

…ts (elastic#201550) ## Summary Adds deprecation object in deprecated alerting routes Closes elastic#196556 --------- Co-authored-by: lcawl <lcawley@elastic.co>

first commit

c2d86ec

jcger added 18 commits November 25, 2024 12:08

update pr number

1996b09

types + create api

e689084

delete api

77595b1

disable

ce0047e

enable api

2124088

find api

dc06b62

get api

fd60625

instance summary api

c67a68d

get alert state api

25ac21f

health api

23ef000

get types api

b1ab837

mute all api

73ad1b7

mute instance api

cabfbf6

unmute_all api

271d1cd

unmute_instance api

7d80952

update api

8fbf230

update api key

0d61400

update docs

33fcdb8

jcger marked this pull request as ready for review November 25, 2024 13:43

jcger requested review from a team as code owners November 25, 2024 13:43

add missing test fix

a90cabb

fix types

c1d595f

jcger commented Nov 25, 2024

View reviewed changes

cnasikas changed the title ~~[Alerting] Add deprecation object to legacy rule endpoints~~ [ResponseOps][Alerting] Add deprecation object to legacy rule endpoints Nov 26, 2024

cnasikas approved these changes Nov 26, 2024

View reviewed changes

jcger added 2 commits November 26, 2024 13:37

pr review

76ada6e

add doc link to new api use reason.type remove instead oof deprecate for apis we will remove

Merge branch 'main' into issue-196556-rules-deprecation-object

1c6ffe5

fix test

1a44804

cnasikas requested a review from lcawl November 27, 2024 08:06

check suffix only in tests

2ea6b1c

umbopepato approved these changes Nov 27, 2024

View reviewed changes

Merge branch 'main' of github.com:jcger/kibana into issue-196556-rule…

8b5766f

…s-deprecation-object

[DOCS] Add bulleted lists

b07b47e

[DOCS] Update changelog

ad0e7cc

lcawl approved these changes Nov 27, 2024

View reviewed changes

jcger merged commit 93b67fb into elastic:main Nov 28, 2024
8 checks passed

jcger mentioned this pull request Nov 28, 2024

[8.x] [ResponseOps][Alerting] Add deprecation object to legacy rule endpoints (#201550) #202165

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ResponseOps][Alerting] Add deprecation object to legacy rule endpoints #201550

[ResponseOps][Alerting] Add deprecation object to legacy rule endpoints #201550

jcger commented Nov 25, 2024 •

edited by kibanamachine

Loading

github-actions bot commented Nov 25, 2024

jcger Nov 25, 2024

jcger Nov 25, 2024

cnasikas Nov 26, 2024

cnasikas left a comment

cnasikas Nov 26, 2024

cnasikas Nov 26, 2024

cnasikas Nov 26, 2024

cnasikas commented Nov 26, 2024

jcger commented Nov 26, 2024 •

edited

Loading

cnasikas commented Nov 26, 2024

umbopepato left a comment

elasticmachine commented Nov 27, 2024

lcawl commented Nov 27, 2024

lcawl commented Nov 27, 2024 •

edited

Loading

lcawl left a comment

kibanamachine commented Nov 28, 2024

kibanamachine commented Nov 28, 2024

jcger commented Nov 28, 2024

[ResponseOps][Alerting] Add deprecation object to legacy rule endpoints #201550

[ResponseOps][Alerting] Add deprecation object to legacy rule endpoints #201550

Conversation

jcger commented Nov 25, 2024 • edited by kibanamachine Loading

Summary

github-actions bot commented Nov 25, 2024

jcger Nov 25, 2024

Choose a reason for hiding this comment

jcger Nov 25, 2024

Choose a reason for hiding this comment

cnasikas Nov 26, 2024

Choose a reason for hiding this comment

cnasikas left a comment

Choose a reason for hiding this comment

cnasikas Nov 26, 2024

Choose a reason for hiding this comment

cnasikas Nov 26, 2024

Choose a reason for hiding this comment

cnasikas Nov 26, 2024

Choose a reason for hiding this comment

cnasikas commented Nov 26, 2024

jcger commented Nov 26, 2024 • edited Loading

cnasikas commented Nov 26, 2024

umbopepato left a comment

Choose a reason for hiding this comment

elasticmachine commented Nov 27, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Async chunks

Page load bundle

History

lcawl commented Nov 27, 2024

lcawl commented Nov 27, 2024 • edited Loading

lcawl left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 28, 2024

kibanamachine commented Nov 28, 2024

💔 All backports failed

Manual backport

Questions ?

jcger commented Nov 28, 2024

💚 All backports created successfully

Questions ?

jcger commented Nov 25, 2024 •

edited by kibanamachine

Loading

jcger commented Nov 26, 2024 •

edited

Loading

lcawl commented Nov 27, 2024 •

edited

Loading