Replace old Security API doc links with API ref links in doc link service

[natasha-moore-elastic]

This PR replaces the old Security API doc links with API reference links in the Kibana doc link service.

This security-docs PR, which removes outdated Security Detections asciidoc API docs, is failing with the following error:

INFO:build_docs:Bad cross-document links:
INFO:build_docs: Kibana [8.x]: src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts contains broken links to:
INFO:build_docs: - en/security/8.x/rule-api-overview.html
INFO:build_docs: - en/security/8.x/signals-migration-api.htm

Replacing these links in the Kibana doc link service should unblock the docs PR.

The links were replaced in main in this PR.

[elasticmachine]

Pinging @elastic/kibana-docs (Team:Docs)

[lcawl]

I've added a commit because it seems like there are some hard-coded occurrences of the old URLs which is something we hit in #217722 too. I tried to switch from "be" to "includes" so we could omit that hard-coded URL part of the string from the test like in #219005 or #219656 but it continued to fail until I copied in the full new URL. Ideally this would be fixed after discussing with appropriate dev team.

[jkelas]

I've added a commit because it seems like there are some hard-coded occurrences of the old URLs which is something we hit in #217722 too. I tried to switch from "be" to "includes" so we could omit that hard-coded URL part of the string from the test like in #219005 or #219656 but it continued to fail until I copied in the full new URL. Ideally this would be fixed after discussing with appropriate dev team.

Hi @lcawl
I tested that both below versions work the same, just fine.

expect(
          header.warning?.includes(
            '299 Kibana "Deprecated endpoint: /api/detection_engine/rules/_bulk_update API is deprecated since v8.2. Please use the /api/detection_engine/rules/_bulk_action API instead. See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail."'
          )
        ).to.be(true);


        expect(header.warning).to.be(
          '299 Kibana "Deprecated endpoint: /api/detection_engine/rules/_bulk_update API is deprecated since v8.2. Please use the /api/detection_engine/rules/_bulk_action API instead. See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail."'
        );

I think your problem was that in the first commit where you tried to change this, the 153d7a79f643131db0fbd9ecad43f2823816004b, the text verified was incomplete, that's why the test failed.
Then, in this commit a527f576ec80d1c6c15414402d51ef571138dfe8, you did two things: changed the expect method, and updated the text.
But I can see that this was not needed. Please restore the original expect, just update the text inside.

Basically use this version please:

expect(header.warning).to.be(
          '299 Kibana "Deprecated endpoint: /api/detection_engine/rules/_bulk_update API is deprecated since v8.2. Please use the /api/detection_engine/rules/_bulk_action API instead. See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail."'
        );

[lcawl]

Basically use this version please:

expect(header.warning).to.be(
          '299 Kibana "Deprecated endpoint: /api/detection_engine/rules/_bulk_update API is deprecated since v8.2. Please use the /api/detection_engine/rules/_bulk_action API instead. See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail."'
        );

Is there a way to do it but omit the last sentence from that test (" See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail.")? That's what I was trying and failing to accomplish, but has been accomplished in other places where we test only a part of a string not the whole string (e.g. in degraded_field_flyout.ts). This minimizes the fragility of the test suite when/if the URL changes again in the doc link service.

[jkelas]

Basically use this version please:

expect(header.warning).to.be(
          '299 Kibana "Deprecated endpoint: /api/detection_engine/rules/_bulk_update API is deprecated since v8.2. Please use the /api/detection_engine/rules/_bulk_action API instead. See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail."'
        );

Is there a way to do it but omit the last sentence from that test (" See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail.")? That's what I was trying and failing to accomplish, but has been accomplished in other places where we test only a part of a string not the whole string (e.g. in degraded_field_flyout.ts). This minimizes the fragility of the test suite when/if the URL changes again in the doc link service.

Basically use this version please:

expect(header.warning).to.be(
          '299 Kibana "Deprecated endpoint: /api/detection_engine/rules/_bulk_update API is deprecated since v8.2. Please use the /api/detection_engine/rules/_bulk_action API instead. See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail."'
        );

Is there a way to do it but omit the last sentence from that test (" See https://www.elastic.co/docs/api/doc/kibana/v8/group/endpoint-security-detections-api for more detail.")? That's what I was trying and failing to accomplish, but has been accomplished in other places where we test only a part of a string not the whole string (e.g. in degraded_field_flyout.ts). This minimizes the fragility of the test suite when/if the URL changes again in the doc link service.

As discussed offline, the header.warning.includes( should work.

[jkelas]

I verified the code, it is OK.
I discussed the commented issue with the author and advised on the proper structure.

LGTM now. Approving.

[elasticmachine]

💚 Build Succeeded

• Buildkite Build
• Commit: 136822a

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	93.3KB	93.5KB	+122.0B
lists	182.3KB	182.4KB	+122.0B
total			+244.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	451.0KB	451.1KB	+122.0B

History

• 💚 Build #308802 succeeded 89f3d5c
• 💚 Build #308351 succeeded 1587eaf
• 💔 Build #307611 failed 2e2499c
• 💔 Build #307543 failed bfb86d1
• 💔 Build #307496 failed 786723b
• 💔 Build #307410 failed 5ba57d2

cc @natasha-moore-elastic

[natasha-moore-elastic]

💔 Some backports could not be created

Status	Branch	Result
✅	8.18
❌	8.17	Conflict resolution was aborted by the user
❌	8.16	Conflict resolution was aborted by the user

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 223388

Questions ?

Please refer to the Backport tool documentation