Skip to content

[8.19] feat(slo): bulk delete APIs (#217405) #219308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kdelemme merged 3 commits into from
Apr 28, 2025
Merged

[8.19] feat(slo): bulk delete APIs (#217405) #219308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4d0a514
feat(slo): bulk delete APIs (#217405)
kdelemme Apr 25, 2025
f90eb1a
[CI] Auto-commit changed files from 'node scripts/lint_ts_projects --…
kibanamachine Apr 25, 2025
6b61bc8
Merge branch '8.19' into backport/8.19/pr-217405
kdelemme Apr 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 141 additions & 0 deletions oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45897,6 +45897,91 @@ paths:
summary: Create an SLO
tags:
- slo
/s/{spaceId}/api/observability/slos/_bulk_delete:
post:
description: |
Bulk delete SLO definitions and their associated summary and rollup data. This endpoint initiates a bulk deletion operation for SLOs, which may take some time to complete. The status of the operation can be checked using the `GET /api/slo/_bulk_delete/{taskId}` endpoint.
operationId: bulkDeleteOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
- $ref: '#/components/parameters/SLOs_space_id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SLOs_bulk_delete_request'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SLOs_bulk_delete_response'
description: Successful response
'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: Bulk delete SLO definitions and their associated summary and rollup data.
tags:
- slo
/s/{spaceId}/api/observability/slos/_bulk_delete/{taskId}:
get:
description: |
Retrieve the status of the bulk deletion operation for SLOs. This endpoint returns the status of the bulk deletion operation, including whether it is completed and the results of the operation.
operationId: bulkDeleteStatusOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
- $ref: '#/components/parameters/SLOs_space_id'
- description: The task id of the bulk delete operation
in: path
name: taskId
required: true
schema:
example: 8853df00-ae2e-11ed-90af-09bb6422b258
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SLOs_bulk_delete_status_response'
description: Successful response
'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: Retrieve the status of the bulk deletion
tags:
- slo
/s/{spaceId}/api/observability/slos/_bulk_purge_rollup:
post:
description: |
Expand Down Expand Up @@ -62085,6 +62170,62 @@ components:
example: occurrences
title: Budgeting method
type: string
SLOs_bulk_delete_request:
description: |
The bulk delete SLO request takes a list of SLOs Definition id to delete.
properties:
list:
description: An array of SLO Definition id
items:
description: The SLO Definition id
example: 8853df00-ae2e-11ed-90af-09bb6422b258
type: string
type: array
required:
- list
title: Bulk delete SLO request
type: object
SLOs_bulk_delete_response:
description: |
The bulk delete SLO response returns a taskId that can be used to poll for its status
properties:
taskId:
description: The taskId of the bulk delete operation
example: d08506b7-f0e8-4f8b-a06a-a83940f4db91
type: string
title: Bulk delete SLO response
type: object
SLOs_bulk_delete_status_response:
description: Indicates if the bulk deletion is completed, with the detailed results of the operation.
properties:
error:
description: The error message if the bulk deletion operation failed
example: Task not found
type: string
isDone:
description: Indicates if the bulk deletion operation is completed
example: true
type: boolean
results:
description: The results of the bulk deletion operation, including the success status and any errors for each SLO
items:
type: object
properties:
error:
description: The error message if the deletion operation failed for this SLO
example: SLO [d08506b7-f0e8-4f8b-a06a-a83940f4db91] not found
type: string
id:
description: The ID of the SLO that was deleted
example: d08506b7-f0e8-4f8b-a06a-a83940f4db91
type: string
success:
description: The result of the deletion operation for this SLO
example: true
type: boolean
type: array
title: The status of the bulk deletion
type: object
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.
Expand Down
141 changes: 141 additions & 0 deletions oas_docs/output/kibana.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24918,6 +24918,91 @@ paths:
summary: Create an SLO
tags:
- slo
/s/{spaceId}/api/observability/slos/_bulk_delete:
post:
description: |
Bulk delete SLO definitions and their associated summary and rollup data. This endpoint initiates a bulk deletion operation for SLOs, which may take some time to complete. The status of the operation can be checked using the `GET /api/slo/_bulk_delete/{taskId}` endpoint.
operationId: bulkDeleteOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
- $ref: '#/components/parameters/SLOs_space_id'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SLOs_bulk_delete_request'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SLOs_bulk_delete_response'
description: Successful response
'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: Bulk delete SLO definitions and their associated summary and rollup data.
tags:
- slo
/s/{spaceId}/api/observability/slos/_bulk_delete/{taskId}:
get:
description: |
Retrieve the status of the bulk deletion operation for SLOs. This endpoint returns the status of the bulk deletion operation, including whether it is completed and the results of the operation.
operationId: bulkDeleteStatusOp
parameters:
- $ref: '#/components/parameters/SLOs_kbn_xsrf'
- $ref: '#/components/parameters/SLOs_space_id'
- description: The task id of the bulk delete operation
in: path
name: taskId
required: true
schema:
example: 8853df00-ae2e-11ed-90af-09bb6422b258
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SLOs_bulk_delete_status_response'
description: Successful response
'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: Retrieve the status of the bulk deletion
tags:
- slo
/s/{spaceId}/api/observability/slos/_bulk_purge_rollup:
post:
description: |
Expand Down Expand Up @@ -46127,6 +46212,62 @@ components:
example: occurrences
title: Budgeting method
type: string
SLOs_bulk_delete_request:
description: |
The bulk delete SLO request takes a list of SLOs Definition id to delete.
properties:
list:
description: An array of SLO Definition id
items:
description: The SLO Definition id
example: 8853df00-ae2e-11ed-90af-09bb6422b258
type: string
type: array
required:
- list
title: Bulk delete SLO request
type: object
SLOs_bulk_delete_response:
description: |
The bulk delete SLO response returns a taskId that can be used to poll for its status
properties:
taskId:
description: The taskId of the bulk delete operation
example: d08506b7-f0e8-4f8b-a06a-a83940f4db91
type: string
title: Bulk delete SLO response
type: object
SLOs_bulk_delete_status_response:
description: Indicates if the bulk deletion is completed, with the detailed results of the operation.
properties:
error:
description: The error message if the bulk deletion operation failed
example: Task not found
type: string
isDone:
description: Indicates if the bulk deletion operation is completed
example: true
type: boolean
results:
description: The results of the bulk deletion operation, including the success status and any errors for each SLO
items:
type: object
properties:
error:
description: The error message if the deletion operation failed for this SLO
example: SLO [d08506b7-f0e8-4f8b-a06a-a83940f4db91] not found
type: string
id:
description: The ID of the SLO that was deleted
example: d08506b7-f0e8-4f8b-a06a-a83940f4db91
type: string
success:
description: The result of the deletion operation for this SLO
example: true
type: boolean
type: array
title: The status of the bulk deletion
type: object
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.
Expand Down
38 changes: 38 additions & 0 deletions x-pack/platform/packages/shared/kbn-slo-schema/src/rest_specs/routes/bulk_delete.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/*
* 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 { sloIdSchema } from '../../schema/slo';

const bulkDeleteParamsSchema = t.type({
body: t.type({
list: t.array(sloIdSchema),
}),
});

const bulkDeleteStatusParamsSchema = t.type({
path: t.type({
taskId: t.string,
}),
});

type BulkDeleteInput = t.OutputOf<typeof bulkDeleteParamsSchema.props.body>;
type BulkDeleteParams = t.TypeOf<typeof bulkDeleteParamsSchema.props.body>;

interface BulkDeleteResult {
id: string;
success: boolean;
error?: string;
}

interface BulkDeleteStatusResponse {
isDone: boolean;
results?: BulkDeleteResult[];
error?: string;
}

export type { BulkDeleteInput, BulkDeleteParams, BulkDeleteResult, BulkDeleteStatusResponse };
export { bulkDeleteParamsSchema, bulkDeleteStatusParamsSchema };
1 change: 1 addition & 0 deletions x-pack/platform/packages/shared/kbn-slo-schema/src/rest_specs/routes/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,3 +24,4 @@ export * from './fetch_historical_summary';
export * from './put_settings';
export * from './get_suggestions';
export * from './get_slo_health';
export * from './bulk_delete';
Loading