[SLO] Bulk Purge SLI data

oas_docs/output/kibana.serverless.yaml

@@ -49743,6 +49743,48 @@ paths:
       summary: Create an SLO
       tags:
         - slo
+  /s/{spaceId}/api/observability/slos/_bulk_purge_rollup:
+    post:
+      description: |
+        The deletion occurs for the specified list of `sloId`. You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
+      operationId: deleteRollupDataOp
+      parameters:
+        - $ref: '#/components/parameters/SLOs_kbn_xsrf'
+        - $ref: '#/components/parameters/SLOs_space_id'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SLOs_bulk_purge_rollup_request'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_bulk_purge_rollup_response'
+          description: Successful request
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_400_response'
+          description: Bad request
+        '401':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_401_response'
+          description: Unauthorized response
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_403_response'
+          description: Unauthorized response
+      summary: Batch delete rollup and summary data
+      tags:
+        - slo
   /s/{spaceId}/api/observability/slos/_delete_instances:
     post:
       description: |
@@ -50051,7 +50093,7 @@ paths:
           name: includeOutdatedOnly
           schema:
             type: boolean
-        - description: Specify which SLO tags to query by (comma-separated list)
+        - description: Filters the SLOs by tag
           in: query
           name: tags
           schema:
@@ -65575,6 +65617,58 @@ components:
       example: occurrences
       title: Budgeting method
       type: string
+    SLOs_bulk_purge_rollup_request:
+      description: |
+        The bulk purge rollup data request takes a list of SLO ids and a purge policy, then deletes the rollup data according to the purge policy. This API can be used to remove the staled data of an instance SLO that no longer get updated.
+      properties:
+        list:
+          description: An array of slo ids
+          items:
+            description: The SLO Definition id
+            example: 8853df00-ae2e-11ed-90af-09bb6422b258
+            type: string
+          type: array
+        purgePolicy:
+          description: Policy that dictates which SLI documents to purge based on age
+          oneOf:
+            - type: object
+              properties:
+                age:
+                  description: The duration to determine which documents to purge, formatted as {duration}{unit}. This value should be greater than or equal to the time window of every SLO provided.
+                  example: 7d
+                  type: string
+                purgeType:
+                  description: Specifies whether documents will be purged based on a specific age or on a timestamp
+                  enum:
+                    - fixed-age
+                  type: string
+            - type: object
+              properties:
+                purgeType:
+                  description: Specifies whether documents will be purged based on a specific age or on a timestamp
+                  enum:
+                    - fixed-time
+                  type: string
+                timestamp:
+                  description: The timestamp to determine which documents to purge, formatted in ISO. This value should be older than the applicable time window of every SLO provided.
+                  example: '2024-12-31T00:00:00.000Z'
+                  type: string
+          type: object
+      required:
+        - list
+        - purgePolicy
+      title: Bulk Purge Rollup data request
+      type: object
+    SLOs_bulk_purge_rollup_response:
+      description: |
+        The bulk purge rollup data response returns a task id from the elasticsearch deleteByQuery response.
+      properties:
+        taskId:
+          description: The task id of the purge operation
+          example: 8853df00-ae2e-11ed-90af-09bb6422b258
+          type: string
+      title: Bulk Purge Rollup data response
+      type: object
     SLOs_create_slo_request:
       description: |
         The create SLO API request body varies depending on the type of indicator, time window and budgeting method.

oas_docs/output/kibana.yaml

@@ -54383,6 +54383,48 @@ paths:
       summary: Create an SLO
       tags:
         - slo
+  /s/{spaceId}/api/observability/slos/_bulk_purge_rollup:
+    post:
+      description: |
+        The deletion occurs for the specified list of `sloId`. You must have `all` privileges for the **SLOs** feature in the **Observability** section of the Kibana feature privileges.
+      operationId: deleteRollupDataOp
+      parameters:
+        - $ref: '#/components/parameters/SLOs_kbn_xsrf'
+        - $ref: '#/components/parameters/SLOs_space_id'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SLOs_bulk_purge_rollup_request'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_bulk_purge_rollup_response'
+          description: Successful request
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_400_response'
+          description: Bad request
+        '401':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_401_response'
+          description: Unauthorized response
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SLOs_403_response'
+          description: Unauthorized response
+      summary: Batch delete rollup and summary data
+      tags:
+        - slo
   /s/{spaceId}/api/observability/slos/_delete_instances:
     post:
       description: |
@@ -54691,7 +54733,7 @@ paths:
           name: includeOutdatedOnly
           schema:
             type: boolean
-        - description: Specify which SLO tags to query by (comma-separated list)
+        - description: Filters the SLOs by tag
           in: query
           name: tags
           schema:
@@ -75088,6 +75130,58 @@ components:
       example: occurrences
       title: Budgeting method
       type: string
+    SLOs_bulk_purge_rollup_request:
+      description: |
+        The bulk purge rollup data request takes a list of SLO ids and a purge policy, then deletes the rollup data according to the purge policy. This API can be used to remove the staled data of an instance SLO that no longer get updated.
+      properties:
+        list:
+          description: An array of slo ids
+          items:
+            description: The SLO Definition id
+            example: 8853df00-ae2e-11ed-90af-09bb6422b258
+            type: string
+          type: array
+        purgePolicy:
+          description: Policy that dictates which SLI documents to purge based on age
+          oneOf:
+            - type: object
+              properties:
+                age:
+                  description: The duration to determine which documents to purge, formatted as {duration}{unit}. This value should be greater than or equal to the time window of every SLO provided.
+                  example: 7d
+                  type: string
+                purgeType:
+                  description: Specifies whether documents will be purged based on a specific age or on a timestamp
+                  enum:
+                    - fixed-age
+                  type: string
+            - type: object
+              properties:
+                purgeType:
+                  description: Specifies whether documents will be purged based on a specific age or on a timestamp
+                  enum:
+                    - fixed-time
+                  type: string
+                timestamp:
+                  description: The timestamp to determine which documents to purge, formatted in ISO. This value should be older than the applicable time window of every SLO provided.
+                  example: '2024-12-31T00:00:00.000Z'
+                  type: string
+          type: object
+      required:
+        - list
+        - purgePolicy
+      title: Bulk Purge Rollup data request
+      type: object
+    SLOs_bulk_purge_rollup_response:
+      description: |
+        The bulk purge rollup data response returns a task id from the elasticsearch deleteByQuery response.
+      properties:
+        taskId:
+          description: The task id of the purge operation
+          example: 8853df00-ae2e-11ed-90af-09bb6422b258
+          type: string
+      title: Bulk Purge Rollup data response
+      type: object
     SLOs_create_slo_request:
       description: |
         The create SLO API request body varies depending on the type of indicator, time window and budgeting method.

x-pack/platform/packages/shared/kbn-slo-schema/src/rest_specs/routes/bulk_purge_rollup.ts

@@ -0,0 +1,46 @@
+/*
+ * 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 * as t from 'io-ts';
+import { DeleteByQueryResponse } from '@elastic/elasticsearch/lib/api/types';
+import { dateType, durationType } from '../../schema';
+
+const fixedAgePurgeVal = t.literal('fixed_age');
+const fixedTimePurgeVal = t.literal('fixed_time');
+
+const fixedAgePurge = t.type({
+  purgeType: fixedAgePurgeVal,
+  age: durationType,
+});
+
+const fixedTimePurge = t.type({
+  purgeType: fixedTimePurgeVal,
+  timestamp: dateType,
+});
+
+const bulkPurgePolicy = t.union([fixedAgePurge, fixedTimePurge]);
+
+const bulkPurgeRollupSchema = t.type({
+  body: t.intersection([
+    t.type({
+      list: t.array(t.string),
+      purgePolicy: bulkPurgePolicy,
+    }),
+    t.partial({
+      force: t.boolean,
+    }),
+  ]),
+});
+
+interface BulkPurgeRollupResponse {
+  taskId?: DeleteByQueryResponse['task'];
+}
+
+type BulkPurgePolicyType = t.TypeOf<typeof bulkPurgePolicy>;
+type BulkPurgeRollupParams = t.TypeOf<typeof bulkPurgeRollupSchema.props.body>;
+
+export type { BulkPurgeRollupResponse, BulkPurgePolicyType, BulkPurgeRollupParams };
+export { bulkPurgeRollupSchema };

x-pack/platform/packages/shared/kbn-slo-schema/src/rest_specs/routes/index.ts

@@ -13,6 +13,7 @@ export * from './find_group';
 export * from './find_definition';
 export * from './get';
 export * from './get_burn_rates';
+export * from './bulk_purge_rollup';
 export * from './get_slo_groupings';
 export * from './get_slo_stats_overview';
 export * from './get_preview_data';