[Response Ops][Cases] Use deprecation object #201004

jcger · 2024-11-20T16:52:03Z

Summary

Adds deprecation object in deprecated cases routes

Closes #196557

github-actions · 2024-11-20T16:52:20Z

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

…s-deprecation-object

elasticmachine · 2024-11-25T09:13:54Z

Pinging @elastic/response-ops (Team:ResponseOps)

elasticmachine · 2024-11-25T09:13:54Z

Pinging @elastic/response-ops-cases (Feature:Cases)

adcoelho · 2024-11-25T09:46:23Z

docs/upgrade-notes.asciidoc

@@ -50,6 +50,24 @@ For Elastic Security solution release information, refer to {security-guide}/rel


 [discrete]
+[[breaking-201004]]


How did you find out these needed to be updated too?

Because the link to the docs' reference is this value. I just kept "breaking" because of consistency with the other references

That said, I'm still not sure it's working :) I'm waiting for CI to generate the docs

jcger · 2024-11-25T16:06:52Z

/buildkite run docs-build

cnasikas

LGTM!

cnasikas · 2024-11-26T10:08:19Z

packages/kbn-doc-links/src/get_doc_links.ts

@@ -1004,5 +1004,8 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
    inferenceManagement: {
      inferenceAPIDocumentation: `${ELASTIC_WEBSITE_URL}docs/api/doc/elasticsearch/operation/operation-inference-put`,
    },
+    cases: {
+      legacyDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-201004`,


nit: legacyApiDeprecations

cnasikas · 2024-11-26T10:09:42Z

x-pack/plugins/cases/server/routes/api/comments/get_all_comment.test.ts


    expect(router.routerOptions?.access).toBe('internal');
+    expect(router.routerOptions?.deprecated).toMatchInlineSnapshot(`


nit: I think it would be better if we had a dedicated test for the deprecation object check. The object is available in all flavors, serverless or non-serverless. Same for all test files.

cnasikas · 2024-11-26T10:10:41Z

x-pack/plugins/cases/server/routes/api/stats/get_status.ts

+        documentationUrl: docLinks.links.cases.legacyDeprecations,
+        severity: 'warning',
+        reason: {
+          type: 'deprecate',


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

rename docs key, create unique test for deprecation object, use remove reason type for status api and trying improve docs output

lcawl

Minor syntax error and comment, otherwise doc links and upgrade notes LGTM

lcawl · 2024-11-26T19:32:04Z

x-pack/plugins/cases/server/routes/api/user_actions/get_all_user_actions.test.ts


    expect(router.routerOptions?.access).toBe('internal');
+    expect(router.routerOptions?.deprecated).toMatchInlineSnapshot(`
+      Object {
+        "documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201004",


"documentationUrl": "https://www.elastic.co/guide/en/kibana/test-branch/breaking-changes-summary.html#breaking-201004",

If it's at all possible to make this a fuzzier match that would be a good idea IMO since the initial part of that URL is almost certain to change as we migrate to the new docs system.

We will test that the url ends with #breaking-201004

docs/upgrade-notes.asciidoc

Co-authored-by: Lisa Cawley <[email protected]>

…ger/kibana into issue-196557-cases-deprecation-object

umbopepato

LGTM!

kibanamachine · 2024-11-27T10:38:06Z

Starting backport for target branches: 8.x

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

elasticmachine · 2024-11-27T10:38:23Z

💛 Build succeeded, but was flaky

Buildkite Build
Commit: c7bb5e0

Failed CI Steps

FTR Configs #77

Test Failures

[job] [logs] FTR Configs #77 / Exception items APIs Authentication - Complete Tier @serverless @serverlessQA editor exception items API behaviors find exception item should return 200 for editor

Metrics [docs]

Public APIs missing comments

Total count of every public API that lacks a comment. Target amount is 0. Run node scripts/build_api_docs --plugin [yourplugin] --stats comments for more detailed information.

id	before	after	diff
`@kbn/doc-links`	79	80	+1

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.8KB	92.9KB	+82.0B
`lists`	145.2KB	145.3KB	+82.0B
total			+164.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.3KB	454.4KB	+82.0B

Unknown metric groups

API count

id	before	after	diff
`@kbn/doc-links`	79	80	+1

History

💔 Build #254504 failed b8f9640
💛 Build #253881 was flaky 3af43a8
💔 Build #253230 failed a69d1e2

## Summary Adds deprecation object in deprecated cases routes Closes [elastic#196557](elastic#196557) --------- Co-authored-by: Lisa Cawley <[email protected]> (cherry picked from commit 0735ab8)

kibanamachine · 2024-11-27T10:42:47Z

💚 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

# Backport This will backport the following commits from `main` to `8.x`: - [[Response Ops][Cases] Use deprecation object (#201004)](#201004)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: Julian Gernun <[email protected]>

## Summary Adds deprecation object in deprecated cases routes Closes [elastic#196557](elastic#196557) --------- Co-authored-by: Lisa Cawley <[email protected]>

first commit

5268611

update docs anchor with pr#

00983c9

jcger changed the title ~~[Cases] Add deprecation object to deprecated endpoints~~ [Cases] Use deprecation object Nov 20, 2024

jcger added 6 commits November 21, 2024 15:52

create docs + use deprecation object

3664f50

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

24b35fa

…s-deprecation-object

add missing docs separator

72cd4cb

remove not needed space

a69d1e2

fix tests

79972e2

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

3af43a8

…s-deprecation-object

jcger marked this pull request as ready for review November 25, 2024 09:12

jcger requested review from a team as code owners November 25, 2024 09:12

adcoelho reviewed Nov 25, 2024

View reviewed changes

adcoelho approved these changes Nov 25, 2024

View reviewed changes

improved deprecated notes format

12dc126

jcger changed the title ~~[Cases] Use deprecation object~~ [Response Ops][Cases] Use deprecation object Nov 26, 2024

cnasikas approved these changes Nov 26, 2024

View reviewed changes

jcger added 3 commits November 26, 2024 13:22

pr review

b1d3b17

rename docs key, create unique test for deprecation object, use remove reason type for status api and trying improve docs output

Merge branch 'main' into issue-196557-cases-deprecation-object

0ce90e7

add forgotten remove type

8fd091e

fix test

b8f9640

lcawl approved these changes Nov 26, 2024

View reviewed changes

jcger and others added 6 commits November 27, 2024 09:08

Update docs/upgrade-notes.asciidoc

a42a25f

Co-authored-by: Lisa Cawley <[email protected]>

Update docs/upgrade-notes.asciidoc

b6c6280

Co-authored-by: Lisa Cawley <[email protected]>

check url suffix only in test

6ec9cce

Merge branch 'issue-196557-cases-deprecation-object' of github.com:jc…

c849eea

…ger/kibana into issue-196557-cases-deprecation-object

include hash fragment in url test

b653ea6

all test suffix check

c7bb5e0

jcger enabled auto-merge (squash) November 27, 2024 08:45

umbopepato approved these changes Nov 27, 2024

View reviewed changes

jcger merged commit 0735ab8 into elastic:main Nov 27, 2024
8 checks passed

kibanamachine mentioned this pull request Nov 27, 2024

[8.x] [Response Ops][Cases] Use deprecation object (#201004) #201935

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Response Ops][Cases] Use deprecation object #201004

[Response Ops][Cases] Use deprecation object #201004

jcger commented Nov 20, 2024 •

edited by kibanamachine

Loading

github-actions bot commented Nov 20, 2024

elasticmachine commented Nov 25, 2024

elasticmachine commented Nov 25, 2024

adcoelho Nov 25, 2024

jcger Nov 25, 2024 •

edited

Loading

jcger commented Nov 25, 2024

cnasikas left a comment

cnasikas Nov 26, 2024

cnasikas Nov 26, 2024

cnasikas Nov 26, 2024

lcawl left a comment

lcawl Nov 26, 2024

jcger Nov 27, 2024

umbopepato left a comment

kibanamachine commented Nov 27, 2024

elasticmachine commented Nov 27, 2024

API count

kibanamachine commented Nov 27, 2024

		@@ -50,6 +50,24 @@ For Elastic Security solution release information, refer to {security-guide}/rel


		[discrete]
		[[breaking-201004]]


		expect(router.routerOptions?.access).toBe('internal');
		expect(router.routerOptions?.deprecated).toMatchInlineSnapshot(`

[Response Ops][Cases] Use deprecation object #201004

[Response Ops][Cases] Use deprecation object #201004

Conversation

jcger commented Nov 20, 2024 • edited by kibanamachine Loading

Summary

github-actions bot commented Nov 20, 2024

elasticmachine commented Nov 25, 2024

elasticmachine commented Nov 25, 2024

adcoelho Nov 25, 2024

Choose a reason for hiding this comment

jcger Nov 25, 2024 • edited Loading

Choose a reason for hiding this comment

jcger commented Nov 25, 2024

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

lcawl left a comment

Choose a reason for hiding this comment

lcawl Nov 26, 2024

Choose a reason for hiding this comment

jcger Nov 27, 2024

Choose a reason for hiding this comment

umbopepato left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 27, 2024

elasticmachine commented Nov 27, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

Metrics [docs]

Public APIs missing comments

Async chunks

Page load bundle

API count

History

kibanamachine commented Nov 27, 2024

💚 All backports created successfully

Questions ?

jcger commented Nov 20, 2024 •

edited by kibanamachine

Loading

jcger Nov 25, 2024 •

edited

Loading