added public and internal access for rules and alerts

elastic · Sep 19, 2024 · a2c96ff · a2c96ff
1 parent d8aaab7
commit a2c96ff
Show file tree

Hide file tree

Showing 31 changed files with 33 additions and 0 deletions.
diff --git a/x-pack/plugins/alerting/server/routes/backfill/apis/find/find_backfill_route.ts b/x-pack/plugins/alerting/server/routes/backfill/apis/find/find_backfill_route.ts
@@ -28,6 +28,9 @@ export const findBackfillRoute = (
       validate: {
         query: findQuerySchemaV1,
       },
+      options: {
+        access: 'internal',
+      },
     },
     router.handleLegacyErrors(
       verifyAccessAndContext(licenseState, async function (context, req, res) {

diff --git a/x-pack/plugins/alerting/server/routes/legacy/create.ts b/x-pack/plugins/alerting/server/routes/legacy/create.ts
@@ -57,6 +57,7 @@ export const createAlertRoute = ({ router, licenseState, usageCounter }: RouteOp
         body: bodySchema,
       },
       options: {
+        access: 'public',
         summary: 'Create an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/delete.ts b/x-pack/plugins/alerting/server/routes/legacy/delete.ts
@@ -29,6 +29,7 @@ export const deleteAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Delete an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/disable.ts b/x-pack/plugins/alerting/server/routes/legacy/disable.ts
@@ -30,6 +30,7 @@ export const disableAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Disable an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/enable.ts b/x-pack/plugins/alerting/server/routes/legacy/enable.ts
@@ -31,6 +31,7 @@ export const enableAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Enable an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/find.ts b/x-pack/plugins/alerting/server/routes/legacy/find.ts
@@ -73,6 +73,7 @@ export const findAlertRoute = (
         query: querySchema,
       },
       options: {
+        access: 'public',
         summary: 'Find alerts',
         tags: ['oas-tag:alerting'],
         description:

diff --git a/x-pack/plugins/alerting/server/routes/legacy/get.ts b/x-pack/plugins/alerting/server/routes/legacy/get.ts
@@ -29,6 +29,7 @@ export const getAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Get an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/get_alert_instance_summary.ts b/x-pack/plugins/alerting/server/routes/legacy/get_alert_instance_summary.ts
@@ -40,6 +40,7 @@ export const getAlertInstanceSummaryRoute = (
         query: querySchema,
       },
       options: {
+        access: 'public',
         summary: 'Get an alert summary',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/get_alert_state.ts b/x-pack/plugins/alerting/server/routes/legacy/get_alert_state.ts
@@ -29,6 +29,7 @@ export const getAlertStateRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Get the state of an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/health.ts b/x-pack/plugins/alerting/server/routes/legacy/health.ts
@@ -25,6 +25,7 @@ export function healthRoute(
       path: '/api/alerts/_health',
       validate: false,
       options: {
+        access: 'public',
         summary: 'Get the alerting framework health',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/list_alert_types.ts b/x-pack/plugins/alerting/server/routes/legacy/list_alert_types.ts
@@ -21,6 +21,7 @@ export const listAlertTypesRoute = (
       path: `${LEGACY_BASE_ALERT_API_PATH}/list_alert_types`,
       validate: {},
       options: {
+        access: 'public',
         summary: 'Get the alert types',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/mute_all.ts b/x-pack/plugins/alerting/server/routes/legacy/mute_all.ts
@@ -30,6 +30,7 @@ export const muteAllAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Mute all alert instances',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/mute_instance.ts b/x-pack/plugins/alerting/server/routes/legacy/mute_instance.ts
@@ -33,6 +33,7 @@ export const muteAlertInstanceRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Mute an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/unmute_all.ts b/x-pack/plugins/alerting/server/routes/legacy/unmute_all.ts
@@ -30,6 +30,7 @@ export const unmuteAllAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Unmute all alert instances',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/unmute_instance.ts b/x-pack/plugins/alerting/server/routes/legacy/unmute_instance.ts
@@ -31,6 +31,7 @@ export const unmuteAlertInstanceRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Unmute an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/update.ts b/x-pack/plugins/alerting/server/routes/legacy/update.ts
@@ -57,6 +57,7 @@ export const updateAlertRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Update an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/x-pack/plugins/alerting/server/routes/legacy/update_api_key.ts b/x-pack/plugins/alerting/server/routes/legacy/update_api_key.ts
@@ -31,6 +31,7 @@ export const updateApiKeyRoute = (
         params: paramSchema,
       },
       options: {
+        access: 'public',
         summary: 'Update the API key for an alert',
         tags: ['oas-tag:alerting'],
         deprecated: true,

diff --git a/...lerting/server/routes/maintenance_window/apis/archive/archive_maintenance_window_route.ts b/...lerting/server/routes/maintenance_window/apis/archive/archive_maintenance_window_route.ts
@@ -35,6 +35,7 @@ export const archiveMaintenanceWindowRoute = (
         body: archiveBodySchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.WRITE_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/...ting/server/routes/maintenance_window/apis/bulk_get/bulk_get_maintenance_windows_route.ts b/...ting/server/routes/maintenance_window/apis/bulk_get/bulk_get_maintenance_windows_route.ts
@@ -32,6 +32,7 @@ export const bulkGetMaintenanceWindowRoute = (
         body: bulkGetBodySchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/.../alerting/server/routes/maintenance_window/apis/create/create_maintenance_window_route.ts b/.../alerting/server/routes/maintenance_window/apis/create/create_maintenance_window_route.ts
@@ -33,6 +33,7 @@ export const createMaintenanceWindowRoute = (
         body: createBodySchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.WRITE_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/.../alerting/server/routes/maintenance_window/apis/delete/delete_maintenance_window_route.ts b/.../alerting/server/routes/maintenance_window/apis/delete/delete_maintenance_window_route.ts
@@ -30,6 +30,7 @@ export const deleteMaintenanceWindowRoute = (
         params: deleteParamsSchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.WRITE_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/...ins/alerting/server/routes/maintenance_window/apis/find/find_maintenance_windows_route.ts b/...ins/alerting/server/routes/maintenance_window/apis/find/find_maintenance_windows_route.ts
@@ -26,6 +26,7 @@ export const findMaintenanceWindowsRoute = (
       path: `${INTERNAL_ALERTING_API_MAINTENANCE_WINDOW_PATH}/_find`,
       validate: {},
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/.../alerting/server/routes/maintenance_window/apis/finish/finish_maintenance_window_route.ts b/.../alerting/server/routes/maintenance_window/apis/finish/finish_maintenance_window_route.ts
@@ -32,6 +32,7 @@ export const finishMaintenanceWindowRoute = (
         params: finishParamsSchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.WRITE_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/...lugins/alerting/server/routes/maintenance_window/apis/get/get_maintenance_window_route.ts b/...lugins/alerting/server/routes/maintenance_window/apis/get/get_maintenance_window_route.ts
@@ -32,6 +32,7 @@ export const getMaintenanceWindowRoute = (
         params: getParamsSchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/.../server/routes/maintenance_window/apis/get_active/get_active_maintenance_windows_route.ts b/.../server/routes/maintenance_window/apis/get_active/get_active_maintenance_windows_route.ts
@@ -27,6 +27,7 @@ export const getActiveMaintenanceWindowsRoute = (
       path: INTERNAL_ALERTING_API_GET_ACTIVE_MAINTENANCE_WINDOWS_PATH,
       validate: {},
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.READ_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/.../alerting/server/routes/maintenance_window/apis/update/update_maintenance_window_route.ts b/.../alerting/server/routes/maintenance_window/apis/update/update_maintenance_window_route.ts
@@ -36,6 +36,7 @@ export const updateMaintenanceWindowRoute = (
         params: updateParamsSchemaV1,
       },
       options: {
+        access: 'internal',
         tags: [`access:${MAINTENANCE_WINDOW_API_PRIVILEGES.WRITE_MAINTENANCE_WINDOW}`],
       },
     },

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/find/find_rules_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/find/find_rules_route.ts
@@ -102,6 +102,7 @@ const buildFindRulesRoute = ({
     router.post(
       {
         path,
+        options: { access: 'internal' },
         validate: {
           body: findRulesRequestQuerySchemaV1,
         },

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/snooze/snooze_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/snooze/snooze_rule_route.ts
@@ -25,6 +25,7 @@ export const snoozeRuleRoute = (
   router.post(
     {
       path: INTERNAL_ALERTING_SNOOZE_RULE,
+      options: { access: 'internal' },
       validate: {
         params: snoozeParamsSchema,
         body: snoozeBodySchema,

diff --git a/x-pack/plugins/alerting/server/routes/suggestions/fields_rules.ts b/x-pack/plugins/alerting/server/routes/suggestions/fields_rules.ts
@@ -30,6 +30,7 @@ export function registerFieldsRoute(
   router.post(
     {
       path: '/internal/rules/saved_objects/fields',
+      options: { access: 'internal' },
       validate: {
         body: schema.nullable(
           schema.object({

diff --git a/x-pack/plugins/alerting/server/routes/suggestions/values_suggestion_alerts.ts b/x-pack/plugins/alerting/server/routes/suggestions/values_suggestion_alerts.ts
@@ -63,6 +63,7 @@ export function registerAlertsValueSuggestionsRoute(
   router.post(
     {
       path: '/internal/alerts/suggestions/values',
+      options: { access: 'internal' },
       validate: AlertsSuggestionsSchema,
     },
     router.handleLegacyErrors(

diff --git a/x-pack/plugins/alerting/server/routes/suggestions/values_suggestion_rules.ts b/x-pack/plugins/alerting/server/routes/suggestions/values_suggestion_rules.ts
@@ -49,6 +49,7 @@ export function registerRulesValueSuggestionsRoute(
   router.post(
     {
       path: '/internal/rules/suggestions/values',
+      options: { access: 'internal' },
       validate: RulesSuggestionsSchema,
     },
     router.handleLegacyErrors(