[8.x] [Response Ops][Alerting] HTTP Version health API (#196690) (#19…

…6878)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Response Ops][Alerting] HTTP Version health API
(#196690)](#196690)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Julian
Gernun","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-10-18T13:19:40Z","message":"[Response
Ops][Alerting] HTTP Version health API (#196690)\n\n##
Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195181\r\nCloses
https://github.com/elastic/kibana/issues/195182\r\n\r\nOAS descriptions
and HTTP version for `GET
/api/alerting/_health`","sha":"c1ac7228503de1ed4ddac4373f9a0bbf79c595c5","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","v9.0.0","backport:prev-minor"],"title":"[Response
Ops][Alerting] HTTP Version health
API","number":196690,"url":"https://github.com/elastic/kibana/pull/196690","mergeCommit":{"message":"[Response
Ops][Alerting] HTTP Version health API (#196690)\n\n##
Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195181\r\nCloses
https://github.com/elastic/kibana/issues/195182\r\n\r\nOAS descriptions
and HTTP version for `GET
/api/alerting/_health`","sha":"c1ac7228503de1ed4ddac4373f9a0bbf79c595c5"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/196690","number":196690,"mergeCommit":{"message":"[Response
Ops][Alerting] HTTP Version health API (#196690)\n\n##
Summary\r\n\r\nCloses
https://github.com/elastic/kibana/issues/195181\r\nCloses
https://github.com/elastic/kibana/issues/195182\r\n\r\nOAS descriptions
and HTTP version for `GET
/api/alerting/_health`","sha":"c1ac7228503de1ed4ddac4373f9a0bbf79c595c5"}}]}]
BACKPORT-->

Co-authored-by: Julian Gernun <[email protected]>

x-pack/plugins/alerting/common/routes/framework/apis/health/index.ts

@@ -0,0 +1,15 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export { healthFrameworkResponseSchema } from './schemas/latest';
+export type { HealthFrameworkResponse } from './types/latest';
+
+export {
+  healthFrameworkResponseBodySchema as healthFrameworkResponseBodySchemaV1,
+  healthFrameworkResponseSchema as healthFrameworkResponseSchemaV1,
+} from './schemas/v1';
+export type { HealthFrameworkResponseBody as HealthFrameworkResponseBodyV1 } from './types/v1';

x-pack/plugins/alerting/common/routes/framework/apis/health/schemas/latest.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export * from './v1';

x-pack/plugins/alerting/common/routes/framework/apis/health/schemas/v1.ts

@@ -0,0 +1,49 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { schema } from '@kbn/config-schema';
+
+const alertingFrameworkHealthSchemaObject = {
+  status: schema.oneOf([schema.literal('ok'), schema.literal('warn'), schema.literal('error')]),
+  timestamp: schema.string(),
+};
+
+export const healthFrameworkResponseBodySchema = schema.object({
+  is_sufficiently_secure: schema.boolean({
+    meta: {
+      description: 'If false, security is enabled but TLS is not.',
+    },
+  }),
+  has_permanent_encryption_key: schema.boolean({
+    meta: {
+      description: 'If false, the encryption key is not set',
+    },
+  }),
+  alerting_framework_health: schema.object(
+    {
+      decryption_health: schema.object(alertingFrameworkHealthSchemaObject, {
+        meta: { description: 'The timestamp and status of the alert decryption.' },
+      }),
+      execution_health: schema.object(alertingFrameworkHealthSchemaObject, {
+        meta: { description: 'The timestamp and status of the alert execution.' },
+      }),
+      read_health: schema.object(alertingFrameworkHealthSchemaObject, {
+        meta: { description: 'The timestamp and status of the alert reading events.' },
+      }),
+    },
+    {
+      meta: {
+        description:
+          'Three substates identify the health of the alerting framework: decryptionHealth, executionHealth, and readHealth.',
+      },
+    }
+  ),
+});
+
+export const healthFrameworkResponseSchema = schema.object({
+  body: healthFrameworkResponseBodySchema,
+});

x-pack/plugins/alerting/common/routes/framework/apis/health/types/latest.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export * from './v1';

x-pack/plugins/alerting/common/routes/framework/apis/health/types/v1.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import type { TypeOf } from '@kbn/config-schema';
+
+import { healthFrameworkResponseBodySchemaV1, healthFrameworkResponseSchemaV1 } from '..';
+
+export type HealthFrameworkResponseBody = TypeOf<typeof healthFrameworkResponseBodySchemaV1>;
+export type HealthFrameworkResponse = TypeOf<typeof healthFrameworkResponseSchemaV1>;

x-pack/plugins/alerting/server/routes/health.test.ts → x-pack/plugins/alerting/server/routes/framework/apis/health/health.test.ts

@@ -8,18 +8,18 @@
 import { healthRoute } from './health';
 import { httpServiceMock } from '@kbn/core/server/mocks';
 import { HealthStatus } from '@kbn/alerting-types';
-import { mockHandlerArguments } from './_mock_handler_arguments';
-import { verifyApiAccess } from '../lib/license_api_access';
-import { licenseStateMock } from '../lib/license_state.mock';
+import { mockHandlerArguments } from '../../../_mock_handler_arguments';
+import { verifyApiAccess } from '../../../../lib/license_api_access';
+import { licenseStateMock } from '../../../../lib/license_state.mock';
 import { encryptedSavedObjectsMock } from '@kbn/encrypted-saved-objects-plugin/server/mocks';
-import { rulesClientMock } from '../rules_client.mock';
-import { alertsMock } from '../mocks';
-import { RecoveredActionGroup } from '../../common';
-import { RegistryAlertTypeWithAuth } from '../authorization';
+import { rulesClientMock } from '../../../../rules_client.mock';
+import { alertsMock } from '../../../../mocks';
+import { RecoveredActionGroup } from '../../../../../common';
+import { RegistryAlertTypeWithAuth } from '../../../../authorization';
 
 const rulesClient = rulesClientMock.create();
 
-jest.mock('../lib/license_api_access', () => ({
+jest.mock('../../../../lib/license_api_access', () => ({
   verifyApiAccess: jest.fn(),
 }));
 

x-pack/plugins/alerting/server/routes/health.ts → x-pack/plugins/alerting/server/routes/framework/apis/health/health.ts

@@ -7,30 +7,16 @@
 
 import { IRouter } from '@kbn/core/server';
 import { EncryptedSavedObjectsPluginSetup } from '@kbn/encrypted-saved-objects-plugin/server';
-import { ILicenseState } from '../lib';
-import { RewriteResponseCase, verifyAccessAndContext } from './lib';
+import { healthFrameworkResponseSchemaV1 } from '../../../../../common/routes/framework/apis/health';
+import { ILicenseState } from '../../../../lib';
+import { verifyAccessAndContext } from '../../../lib';
 import {
   AlertingRequestHandlerContext,
   BASE_ALERTING_API_PATH,
   AlertingFrameworkHealth,
-} from '../types';
-import { getSecurityHealth } from '../lib/get_security_health';
-
-const rewriteBodyRes: RewriteResponseCase<AlertingFrameworkHealth> = ({
-  isSufficientlySecure,
-  hasPermanentEncryptionKey,
-  alertingFrameworkHealth,
-  ...rest
-}) => ({
-  ...rest,
-  is_sufficiently_secure: isSufficientlySecure,
-  has_permanent_encryption_key: hasPermanentEncryptionKey,
-  alerting_framework_health: {
-    decryption_health: alertingFrameworkHealth.decryptionHealth,
-    execution_health: alertingFrameworkHealth.executionHealth,
-    read_health: alertingFrameworkHealth.readHealth,
-  },
-});
+} from '../../../../types';
+import { getSecurityHealth } from '../../../../lib/get_security_health';
+import { transformHealthBodyResponse } from './transforms/transform_health_response/v1';
 
 export const healthRoute = (
   router: IRouter<AlertingRequestHandlerContext>,
@@ -45,7 +31,18 @@ export const healthRoute = (
         summary: `Get the alerting framework health`,
         tags: ['oas-tag:alerting'],
       },
-      validate: false,
+      validate: {
+        request: {},
+        response: {
+          200: {
+            body: () => healthFrameworkResponseSchemaV1,
+            description: 'Indicates a successful call.',
+          },
+          401: {
+            description: 'Authorization information is missing or invalid.',
+          },
+        },
+      },
     },
     router.handleLegacyErrors(
       verifyAccessAndContext(licenseState, async function (context, req, res) {
@@ -68,7 +65,7 @@ export const healthRoute = (
             };
 
             return res.ok({
-              body: rewriteBodyRes(frameworkHealth),
+              body: transformHealthBodyResponse(frameworkHealth),
             });
           } else {
             return res.forbidden({

x-pack/plugins/alerting/server/routes/framework/apis/health/index.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export { healthRoute } from './health';

x-pack/plugins/alerting/server/routes/framework/apis/health/transforms/index.ts

@@ -0,0 +1,9 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export { transformHealthBodyResponse } from './transform_health_response/latest';
+export { transformHealthBodyResponse as transformHealthBodyResponseV1 } from './transform_health_response/v1';

x-pack/plugins/alerting/server/routes/framework/apis/health/transforms/transform_health_response/latest.ts

@@ -0,0 +1,8 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+export * from './v1';

x-pack/plugins/alerting/server/routes/framework/apis/health/transforms/transform_health_response/v1.ts

@@ -0,0 +1,21 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { AlertingFrameworkHealth } from '../../../../../../types';
+import type { HealthFrameworkResponseBodyV1 } from '../../../../../../../common/routes/framework/apis/health';
+
+export const transformHealthBodyResponse = (
+  frameworkHealth: AlertingFrameworkHealth
+): HealthFrameworkResponseBodyV1 => ({
+  is_sufficiently_secure: frameworkHealth.isSufficientlySecure,
+  has_permanent_encryption_key: frameworkHealth.hasPermanentEncryptionKey,
+  alerting_framework_health: {
+    decryption_health: frameworkHealth.alertingFrameworkHealth.decryptionHealth,
+    execution_health: frameworkHealth.alertingFrameworkHealth.executionHealth,
+    read_health: frameworkHealth.alertingFrameworkHealth.readHealth,
+  },
+});

x-pack/plugins/alerting/server/routes/index.ts

@@ -28,7 +28,7 @@ import { getGlobalExecutionKPIRoute } from './get_global_execution_kpi';
 import { getActionErrorLogRoute } from './get_action_error_log';
 import { getRuleExecutionKPIRoute } from './get_rule_execution_kpi';
 import { getRuleStateRoute } from './get_rule_state';
-import { healthRoute } from './health';
+import { healthRoute } from './framework/apis/health';
 import { resolveRuleRoute } from './rule/apis/resolve';
 import { ruleTypesRoute } from './rule/apis/list_types/rule_types';
 import { muteAllRuleRoute } from './rule/apis/mute_all/mute_all_rule';