[Response Ops][Rules] OAS Ready Rule API (elastic#196150)

## Summary Linked to elastic#195182 ### muteAll - added 40x error codes to response - `public` access prop already set [here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/server/routes/rule/apis/mute_all/mute_all_rule.ts#L28) - request schema already with description [here](https://github.com/elastic/kibana/blob/8545b9ccfbad97881406e56ffd96f452c94032b8/x-pack/plugins/alerting/common/routes/rule/apis/mute_all/schemas/v1.ts#L11) - no response schema ### unmuteAll - added 40x error codes to response - `public` access prop already set [here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/unmute_all/unmute_all_rule.ts#L25) - params schema already with description [here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/common/routes/rule/apis/unmute_all/schemas/v1.ts#L11) - no response schema ### rule types - added 40x error code to response - `public` access prop already set [here](https://github.com/elastic/kibana/blob/563910b672b6dbe4f9e7931e36ec41e674fe8eb3/x-pack/plugins/alerting/server/routes/rule/apis/list_types/rule_types.ts#L23) - no request schema - added response schema descriptions --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
jcger · Oct 15, 2024 · 611082a · 611082a
1 parent 8afbbc0
commit 611082a
Show file tree

Hide file tree

Showing 10 changed files with 275 additions and 42 deletions.
diff --git a/oas_docs/bundle.json b/oas_docs/bundle.json
@@ -5077,6 +5077,15 @@
         "responses": {
           "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."
           }
         },
         "summary": "Mute all alerts",
@@ -5124,6 +5133,15 @@
         "responses": {
           "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."
           }
         },
         "summary": "Unmute all alerts",

diff --git a/oas_docs/bundle.serverless.json b/oas_docs/bundle.serverless.json
@@ -5077,6 +5077,15 @@
         "responses": {
           "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."
           }
         },
         "summary": "Mute all alerts",
@@ -5124,6 +5133,15 @@
         "responses": {
           "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."
           }
         },
         "summary": "Unmute all alerts",

diff --git a/oas_docs/output/kibana.serverless.staging.yaml b/oas_docs/output/kibana.serverless.staging.yaml
@@ -4217,6 +4217,12 @@ paths:
       responses:
         '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.
       summary: Mute all alerts
       tags:
         - alerting
@@ -4248,6 +4254,12 @@ paths:
       responses:
         '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.
       summary: Unmute all alerts
       tags:
         - alerting

diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -4217,6 +4217,12 @@ paths:
       responses:
         '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.
       summary: Mute all alerts
       tags:
         - alerting
@@ -4248,6 +4254,12 @@ paths:
       responses:
         '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.
       summary: Unmute all alerts
       tags:
         - alerting

diff --git a/oas_docs/output/kibana.staging.yaml b/oas_docs/output/kibana.staging.yaml
@@ -4598,6 +4598,12 @@ paths:
       responses:
         '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.
       summary: Mute all alerts
       tags:
         - alerting
@@ -4629,6 +4635,12 @@ paths:
       responses:
         '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.
       summary: Unmute all alerts
       tags:
         - alerting

diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -4598,6 +4598,12 @@ paths:
       responses:
         '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.
       summary: Mute all alerts
       tags:
         - alerting
@@ -4629,6 +4635,12 @@ paths:
       responses:
         '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.
       summary: Unmute all alerts
       tags:
         - alerting

diff --git a/x-pack/plugins/alerting/common/routes/rule/apis/list_types/schemas/v1.ts b/x-pack/plugins/alerting/common/routes/rule/apis/list_types/schemas/v1.ts
@@ -13,58 +13,175 @@ const actionVariableSchema = schema.object({
   usesPublicBaseUrl: schema.maybe(schema.boolean()),
 });
 
-const actionGroupSchema = schema.object({
-  id: schema.string(),
-  name: schema.string(),
-});
+const actionGroupSchema = schema.object(
+  {
+    id: schema.string(),
+    name: schema.string(),
+  },
+  {
+    meta: {
+      description:
+        'An action group to use when an alert goes from an active state to an inactive one.',
+    },
+  }
+);
 
 export const typesRulesResponseBodySchema = schema.arrayOf(
   schema.object({
-    action_groups: schema.maybe(schema.arrayOf(actionGroupSchema)),
-    action_variables: schema.maybe(
-      schema.object({
-        context: schema.maybe(schema.arrayOf(actionVariableSchema)),
-        state: schema.maybe(schema.arrayOf(actionVariableSchema)),
-        params: schema.maybe(schema.arrayOf(actionVariableSchema)),
+    action_groups: schema.maybe(
+      schema.arrayOf(actionGroupSchema, {
+        meta: {
+          description:
+            "An explicit list of groups for which the rule type can schedule actions, each with the action group's unique ID and human readable name. Rule actions validation uses this configuration to ensure that groups are valid.",
+        },
       })
     ),
+    action_variables: schema.maybe(
+      schema.object(
+        {
+          context: schema.maybe(schema.arrayOf(actionVariableSchema)),
+          state: schema.maybe(schema.arrayOf(actionVariableSchema)),
+          params: schema.maybe(schema.arrayOf(actionVariableSchema)),
+        },
+        {
+          meta: {
+            description:
+              'A list of action variables that the rule type makes available via context and state in action parameter templates, and a short human readable description. When you create a rule in Kibana, it uses this information to prompt you for these variables in action parameter editors.',
+          },
+        }
+      )
+    ),
     alerts: schema.maybe(
-      schema.object({
-        context: schema.string(),
-        mappings: schema.maybe(
-          schema.object({
-            dynamic: schema.maybe(schema.oneOf([schema.literal(false), schema.literal('strict')])),
-            fieldMap: schema.recordOf(schema.string(), schema.any()),
-            shouldWrite: schema.maybe(schema.boolean()),
-            useEcs: schema.maybe(schema.boolean()),
-          })
-        ),
-      })
+      schema.object(
+        {
+          context: schema.string({
+            meta: {
+              description: 'The namespace for this rule type.',
+            },
+          }),
+          mappings: schema.maybe(
+            schema.object({
+              dynamic: schema.maybe(
+                schema.oneOf([schema.literal(false), schema.literal('strict')], {
+                  meta: {
+                    description: 'Indicates whether new fields are added dynamically.',
+                  },
+                })
+              ),
+              fieldMap: schema.recordOf(schema.string(), schema.any(), {
+                meta: {
+                  description:
+                    'Mapping information for each field supported in alerts as data documents for this rule type. For more information about mapping parameters, refer to the Elasticsearch documentation.',
+                },
+              }),
+              shouldWrite: schema.maybe(
+                schema.boolean({
+                  meta: {
+                    description: 'Indicates whether the rule should write out alerts as data.',
+                  },
+                })
+              ),
+              useEcs: schema.maybe(
+                schema.boolean({
+                  meta: {
+                    description:
+                      'Indicates whether to include the ECS component template for the alerts.',
+                  },
+                })
+              ),
+            })
+          ),
+        },
+        {
+          meta: {
+            description: 'Details for writing alerts as data documents for this rule type.',
+          },
+        }
+      )
     ),
     authorized_consumers: schema.recordOf(
       schema.string(),
-      schema.object({ read: schema.boolean(), all: schema.boolean() })
+      schema.object({ read: schema.boolean(), all: schema.boolean() }),
+      {
+        meta: {
+          description: 'The list of the plugins IDs that have access to the rule type.',
+        },
+      }
     ),
-    category: schema.string(),
-    default_action_group_id: schema.string(),
+    category: schema.string({
+      meta: {
+        description:
+          'The rule category, which is used by features such as category-specific maintenance windows.',
+      },
+    }),
+    default_action_group_id: schema.string({
+      meta: {
+        description: 'The default identifier for the rule type group.',
+      },
+    }),
     default_schedule_interval: schema.maybe(schema.string()),
-    does_set_recovery_context: schema.maybe(schema.boolean()),
-    enabled_in_license: schema.boolean(),
+    does_set_recovery_context: schema.maybe(
+      schema.boolean({
+        meta: {
+          description:
+            'Indicates whether the rule passes context variables to its recovery action.',
+        },
+      })
+    ),
+    enabled_in_license: schema.boolean({
+      meta: {
+        description:
+          'Indicates whether the rule type is enabled or disabled based on the subscription.',
+      },
+    }),
     fieldsForAAD: schema.maybe(schema.arrayOf(schema.string())),
-    has_alerts_mappings: schema.boolean(),
-    has_fields_for_a_a_d: schema.boolean(),
-    id: schema.string(),
-    is_exportable: schema.boolean(),
-    minimum_license_required: schema.oneOf([
-      schema.literal('basic'),
-      schema.literal('gold'),
-      schema.literal('platinum'),
-      schema.literal('standard'),
-      schema.literal('enterprise'),
-      schema.literal('trial'),
-    ]),
-    name: schema.string(),
-    producer: schema.string(),
+    has_alerts_mappings: schema.boolean({
+      meta: {
+        description: 'Indicates whether the rule type has custom mappings for the alert data.',
+      },
+    }),
+    has_fields_for_a_a_d: schema.boolean({
+      meta: {
+        description:
+          'Indicates whether the rule type has fields for alert as data for the alert data.  ',
+      },
+    }),
+    id: schema.string({
+      meta: {
+        description: 'The unique identifier for the rule type.',
+      },
+    }),
+    is_exportable: schema.boolean({
+      meta: {
+        description:
+          'Indicates whether the rule type is exportable in Stack Management > Saved Objects.',
+      },
+    }),
+    minimum_license_required: schema.oneOf(
+      [
+        schema.literal('basic'),
+        schema.literal('gold'),
+        schema.literal('platinum'),
+        schema.literal('standard'),
+        schema.literal('enterprise'),
+        schema.literal('trial'),
+      ],
+      {
+        meta: {
+          description: 'The subscriptions required to use the rule type.',
+        },
+      }
+    ),
+    name: schema.string({
+      meta: {
+        description: 'The descriptive name of the rule type.',
+      },
+    }),
+    producer: schema.string({
+      meta: {
+        description: 'An identifier for the application that produces this rule type.',
+      },
+    }),
     recovery_action_group: actionGroupSchema,
     rule_task_timeout: schema.maybe(schema.string()),
   })