update response with description

elastic · Jul 23, 2024 · 6cf0ed7 · 6cf0ed7
1 parent 81196f6
commit 6cf0ed7
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 6 deletions.
diff --git a/x-pack/plugins/alerting/common/routes/rule/response/schemas/v1.ts b/x-pack/plugins/alerting/common/routes/rule/response/schemas/v1.ts
@@ -337,12 +337,19 @@ export const monitoringSchema = schema.object(
           }),
           { meta: { description: 'History of the rule run.' } }
         ),
-        calculated_metrics: schema.object({
-          p50: schema.maybe(schema.number()),
-          p95: schema.maybe(schema.number()),
-          p99: schema.maybe(schema.number()),
-          success_ratio: schema.number(),
-        }),
+        calculated_metrics: schema.object(
+          {
+            p50: schema.maybe(schema.number()),
+            p95: schema.maybe(schema.number()),
+            p99: schema.maybe(schema.number()),
+            success_ratio: schema.number(),
+          },
+          {
+            meta: {
+              description: 'Calculation of different percentiles and success ratio.',
+            },
+          }
+        ),
         last_run: schema.object({
           timestamp: schema.string({
             meta: { description: 'Time when the rule was run last.' },

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
@@ -44,6 +44,7 @@ export const createRuleRoute = ({ router, licenseState, usageCounter }: RouteOpt
         response: {
           200: {
             body: () => ruleResponseSchemaV1,
+            description: 'Indicates a successful call.',
           },
         },
       },

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
@@ -29,6 +29,11 @@ export const deleteRuleRoute = (
         request: {
           params: deleteRuleRequestParamsSchemaV1,
         },
+        response: {
+          204: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(

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
@@ -52,6 +52,7 @@ const buildFindRulesRoute = ({
         response: {
           200: {
             body: () => ruleResponseSchemaV1,
+            description: 'Indicates a successful call.',
           },
         },
       },

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
@@ -48,6 +48,7 @@ const buildGetRuleRoute = ({
         response: {
           200: {
             body: () => ruleResponseSchemaV1,
+            description: 'Indicates a successful call.',
           },
         },
       },

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
@@ -29,6 +29,11 @@ export const muteAlertRoute = (
         request: {
           params: muteAlertParamsSchemaV1,
         },
+        response: {
+          204: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(

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
@@ -43,6 +43,7 @@ export const updateRuleRoute = (
         response: {
           200: {
             body: () => ruleResponseSchemaV1,
+            description: 'Indicates a successful call.',
           },
         },
       },
-Original file line number
+Diff line change
@@ Expand Up @@
             response: {
 : {
                 body: () => ruleResponseSchemaV1,
+                description: 'Indicates a successful call.',
               },
             },
           },
@@ Expand Down @@