More specific name for the doc link: legacyRuleManagementBulkApiDepre…

…cations
elastic · Feb 5, 2025 · e64f45c · e64f45c
1 parent 8181858
commit e64f45c
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 7 deletions.
diff --git a/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts b/src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
@@ -454,7 +454,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
       aiAssistant: `${SECURITY_SOLUTION_DOCS}security-assistant.html`,
       signalsMigrationApi: `${SECURITY_SOLUTION_DOCS}signals-migration-api.html`,
       legacyEndpointManagementApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-199598`,
-      legacyBulkApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-207091`,
+      legacyRuleManagementBulkApiDeprecations: `${KIBANA_DOCS}breaking-changes-summary.html#breaking-207091`,
     },
     query: {
       eql: `${ELASTICSEARCH_DOCS}eql.html`,

diff --git a/src/platform/packages/shared/kbn-doc-links/src/types.ts b/src/platform/packages/shared/kbn-doc-links/src/types.ts
@@ -319,7 +319,7 @@ export interface DocLinks {
     readonly detectionEngineOverview: string;
     readonly signalsMigrationApi: string;
     readonly legacyEndpointManagementApiDeprecations: string;
-    readonly legacyBulkApiDeprecations: string;
+    readonly legacyRuleManagementBulkApiDeprecations: string;
   };
   readonly query: {
     readonly eql: string;

diff --git a/...solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.ts b/...solution/server/lib/detection_engine/rule_management/api/rules/bulk_create_rules/route.ts
@@ -42,6 +42,8 @@ export const bulkCreateRulesRoute = (
   logger: Logger,
   docLinks: DocLinksServiceSetup
 ) => {
+  const securityDocLinks = docLinks.links.securitySolution;
+
   router.versioned
     .post({
       access: 'public',
@@ -67,7 +69,7 @@ export const bulkCreateRulesRoute = (
         },
         options: {
           deprecated: {
-            documentationUrl: docLinks.links.securitySolution.legacyBulkApiDeprecations,
+            documentationUrl: securityDocLinks.legacyRuleManagementBulkApiDeprecations,
             severity: 'critical',
             reason: {
               type: 'migrate',

diff --git a/...solution/server/lib/detection_engine/rule_management/api/rules/bulk_delete_rules/route.ts b/...solution/server/lib/detection_engine/rule_management/api/rules/bulk_delete_rules/route.ts
@@ -130,6 +130,9 @@ export const bulkDeleteRulesRoute = (
       },
     },
   };
+
+  const securityDocLinks = docLinks.links.securitySolution;
+
   router.versioned.delete(routeConfig).addVersion(
     {
       version: '2023-10-31',
@@ -140,7 +143,7 @@ export const bulkDeleteRulesRoute = (
       },
       options: {
         deprecated: {
-          documentationUrl: docLinks.links.securitySolution.legacyBulkApiDeprecations,
+          documentationUrl: securityDocLinks.legacyRuleManagementBulkApiDeprecations,
           severity: 'critical',
           reason: {
             type: 'migrate',
@@ -152,6 +155,7 @@ export const bulkDeleteRulesRoute = (
     },
     handler
   );
+
   router.versioned.post(routeConfig).addVersion(
     {
       version: '2023-10-31',
@@ -162,7 +166,7 @@ export const bulkDeleteRulesRoute = (
       },
       options: {
         deprecated: {
-          documentationUrl: docLinks.links.securitySolution.legacyBulkApiDeprecations,
+          documentationUrl: securityDocLinks.legacyRuleManagementBulkApiDeprecations,
           severity: 'critical',
           reason: {
             type: 'migrate',

diff --git a/..._solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.ts b/..._solution/server/lib/detection_engine/rule_management/api/rules/bulk_patch_rules/route.ts
@@ -36,6 +36,8 @@ export const bulkPatchRulesRoute = (
   logger: Logger,
   docLinks: DocLinksServiceSetup
 ) => {
+  const securityDocLinks = docLinks.links.securitySolution;
+
   router.versioned
     .patch({
       access: 'public',
@@ -61,7 +63,7 @@ export const bulkPatchRulesRoute = (
         },
         options: {
           deprecated: {
-            documentationUrl: docLinks.links.securitySolution.legacyBulkApiDeprecations,
+            documentationUrl: securityDocLinks.legacyRuleManagementBulkApiDeprecations,
             severity: 'critical',
             reason: {
               type: 'migrate',

diff --git a/...solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.ts b/...solution/server/lib/detection_engine/rule_management/api/rules/bulk_update_rules/route.ts
@@ -40,6 +40,8 @@ export const bulkUpdateRulesRoute = (
   logger: Logger,
   docLinks: DocLinksServiceSetup
 ) => {
+  const securityDocLinks = docLinks.links.securitySolution;
+
   router.versioned
     .put({
       access: 'public',
@@ -65,7 +67,7 @@ export const bulkUpdateRulesRoute = (
         },
         options: {
           deprecated: {
-            documentationUrl: docLinks.links.securitySolution.legacyBulkApiDeprecations,
+            documentationUrl: securityDocLinks.legacyRuleManagementBulkApiDeprecations,
             severity: 'critical',
             reason: {
               type: 'migrate',