Add missing error codes and remove error schemas

elastic · Sep 18, 2024 · a8d4987 · a8d4987
1 parent 3c6121c
commit a8d4987
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 43 deletions.
diff --git a/x-pack/plugins/alerting/common/routes/rule/common/index.ts b/x-pack/plugins/alerting/common/routes/rule/common/index.ts
@@ -36,7 +36,3 @@ export type {
   RuleExecutionStatusErrorReason as RuleExecutionStatusErrorReasonV1,
   RuleExecutionStatusWarningReason as RuleExecutionStatusWarningReasonV1,
 } from './constants/v1';
-
-export { forbiddenErrorSchema } from './schemas/latest';
-
-export { forbiddenErrorSchema as forbiddenErrorSchemaV1 } from './schemas/v1';
diff --git a/x-pack/plugins/alerting/common/routes/rule/common/schemas/latest.ts b/x-pack/plugins/alerting/common/routes/rule/common/schemas/latest.ts
diff --git a/x-pack/plugins/alerting/common/routes/rule/common/schemas/v1.ts b/x-pack/plugins/alerting/common/routes/rule/common/schemas/v1.ts
diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/create/create_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/create/create_rule_route.ts
@@ -15,7 +15,6 @@ import {
   createBodySchemaV1,
   createParamsSchemaV1,
 } from '../../../../../common/routes/rule/apis/create';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
 import { RuleParamsV1, ruleResponseSchemaV1 } from '../../../../../common/routes/rule/response';
 import { Rule } from '../../../../application/rule/types';
 import { RuleTypeDisabledError } from '../../../../lib';
@@ -48,12 +47,14 @@ export const createRuleRoute = ({ router, licenseState, usageCounter }: RouteOpt
             body: () => ruleResponseSchemaV1,
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
-          400: {
-            description: 'Indicates that the requested rule type is not registered.',
+          409: {
+            description: 'Indicates that the rule id is already in use.',
           },
         },
       },

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/delete/delete_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/delete/delete_rule_route.ts
@@ -34,6 +34,12 @@ export const deleteRuleRoute = (
           204: {
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
+          403: {
+            description: 'Indicates that this call is forbidden.',
+          },
           404: {
             description: 'Indicates a rule with the given ID does not exist.',
           },

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/disable/disable_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/disable/disable_rule_route.ts
@@ -12,7 +12,6 @@ import {
   disableRuleRequestBodySchemaV1,
   disableRuleRequestParamsSchemaV1,
 } from '../../../../../common/routes/rule/apis/disable';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
 import { ILicenseState, RuleTypeDisabledError } from '../../../../lib';
 import { AlertingRequestHandlerContext, BASE_ALERTING_API_PATH } from '../../../../types';
 import { verifyAccessAndContext } from '../../../lib';
@@ -38,8 +37,10 @@ export const disableRuleRoute = (
           204: {
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
           404: {

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/enable/enable_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/enable/enable_rule_route.ts
@@ -14,8 +14,6 @@ import {
   EnableRuleRequestParamsV1,
   enableRuleRequestParamsSchemaV1,
 } from '../../../../../common/routes/rule/apis/enable';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
-
 export const enableRuleRoute = (
   router: IRouter<AlertingRequestHandlerContext>,
   licenseState: ILicenseState
@@ -36,8 +34,10 @@ export const enableRuleRoute = (
           204: {
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
           404: {

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/get/get_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/get/get_rule_route.ts
@@ -50,6 +50,12 @@ const buildGetRuleRoute = ({
             body: () => ruleResponseSchemaV1,
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
+          403: {
+            description: 'Indicates that this call is forbidden.',
+          },
           404: {
             description: 'Indicates a rule with the given ID does not exist.',
           },

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/mute_alert/mute_alert.ts b/x-pack/plugins/alerting/server/routes/rule/apis/mute_alert/mute_alert.ts
@@ -9,7 +9,6 @@ import { transformRequestParamsToApplicationV1 } from './transforms';
 import { ILicenseState, RuleTypeDisabledError } from '../../../../lib';
 import { verifyAccessAndContext } from '../../../lib';
 import { AlertingRequestHandlerContext, BASE_ALERTING_API_PATH } from '../../../../types';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
 import {
   muteAlertParamsSchemaV1,
   MuteAlertRequestParamsV1,
@@ -35,8 +34,10 @@ export const muteAlertRoute = (
           204: {
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
           404: {

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/unmute_alert/unmute_alert_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/unmute_alert/unmute_alert_route.ts
@@ -10,7 +10,6 @@ import {
   UnmuteAlertRequestParamsV1,
   unmuteAlertParamsSchemaV1,
 } from '../../../../../common/routes/rule/apis/unmute_alert';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
 import { ILicenseState, RuleTypeDisabledError } from '../../../../lib';
 import { AlertingRequestHandlerContext, BASE_ALERTING_API_PATH } from '../../../../types';
 import { verifyAccessAndContext } from '../../../lib';
@@ -36,8 +35,10 @@ export const unmuteAlertRoute = (
           204: {
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
           404: {

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/update/update_rule_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/update/update_rule_route.ts
@@ -6,7 +6,6 @@
  */
 
 import { IRouter } from '@kbn/core/server';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
 import type {
   UpdateRuleRequestBodyV1,
   UpdateRuleRequestParamsV1,
@@ -47,13 +46,18 @@ export const updateRuleRoute = (
             body: () => ruleResponseSchemaV1,
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
           404: {
             description: 'Indicates a rule with the given ID does not exist.',
           },
+          409: {
+            description: 'Indicates that the rule has already been updated by another user.',
+          },
         },
       },
     },

diff --git a/x-pack/plugins/alerting/server/routes/rule/apis/update_api_key/update_rule_api_key_route.ts b/x-pack/plugins/alerting/server/routes/rule/apis/update_api_key/update_rule_api_key_route.ts
@@ -10,7 +10,6 @@ import {
   UpdateApiKeyParamsV1,
   updateApiKeyParamsSchemaV1,
 } from '../../../../../common/routes/rule/apis/update_api_key';
-import { forbiddenErrorSchemaV1 } from '../../../../../common/routes/rule/common';
 import { ILicenseState, RuleTypeDisabledError } from '../../../../lib';
 import { AlertingRequestHandlerContext, BASE_ALERTING_API_PATH } from '../../../../types';
 import { verifyAccessAndContext } from '../../../lib';
@@ -35,13 +34,18 @@ export const updateRuleApiKeyRoute = (
           204: {
             description: 'Indicates a successful call.',
           },
+          400: {
+            description: 'Indicates an invalid schema or parameters.',
+          },
           403: {
-            body: () => forbiddenErrorSchemaV1,
             description: 'Indicates that this call is forbidden.',
           },
           404: {
             description: 'Indicates a rule with the given ID does not exist.',
           },
+          409: {
+            description: 'Indicates that the rule has already been updated by another user.',
+          },
         },
       },
     },