Skip to content

Commit e29e432

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add BulkDeleteDatastoreItems to Datastore API spec (#31891)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 6de9695 commit e29e432

File tree

8 files changed

+1244
-0
lines changed

8 files changed

+1244
-0
lines changed

config/_default/menus/api.en.yaml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5188,6 +5188,18 @@ menu:
51885188
- BulkWriteDatastoreItems
51895189
unstable: []
51905190
order: 10
5191+
- name: Bulk delete datastore items
5192+
url: '#bulk-delete-datastore-items'
5193+
identifier: actions-datastores-bulk-delete-datastore-items
5194+
parent: actions-datastores
5195+
generated: true
5196+
params:
5197+
versions:
5198+
- v2
5199+
operationids:
5200+
- BulkDeleteDatastoreItems
5201+
unstable: []
5202+
order: 11
51915203
- name: Update datastore item
51925204
url: '#update-datastore-item'
51935205
identifier: actions-datastores-update-datastore-item

content/en/api/v2/actions-datastores/examples.json

Lines changed: 94 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"data": {
3+
"attributes": {
4+
"item_keys": [
5+
"test-key"
6+
]
7+
},
8+
"type": "items"
9+
}
10+
}

data/api/v2/CodeExamples.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,13 @@
6363
"description": "Update an existing Action Connection returns \"Successfully updated Action Connection\" response"
6464
}
6565
],
66+
"BulkDeleteDatastoreItems": [
67+
{
68+
"group": "actions_datastores",
69+
"suffix": "",
70+
"description": "Bulk delete datastore items returns \"OK\" response"
71+
}
72+
],
6673
"BulkWriteDatastoreItems": [
6774
{
6875
"group": "actions_datastores",

data/api/v2/full_spec.yaml

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6616,6 +6616,46 @@ components:
66166616
description: The type of the object, must be `budget`.
66176617
type: string
66186618
type: object
6619+
BulkDeleteAppsDatastoreItemsRequest:
6620+
description: Request to delete items from a datastore.
6621+
properties:
6622+
data:
6623+
$ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestData'
6624+
type: object
6625+
BulkDeleteAppsDatastoreItemsRequestData:
6626+
description: Data wrapper containing the data needed to delete items from a
6627+
datastore.
6628+
properties:
6629+
attributes:
6630+
$ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataAttributes'
6631+
id:
6632+
description: ID for the datastore of the items to delete.
6633+
type: string
6634+
type:
6635+
$ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataType'
6636+
required:
6637+
- type
6638+
type: object
6639+
BulkDeleteAppsDatastoreItemsRequestDataAttributes:
6640+
description: Attributes of request data to delete items from a datastore.
6641+
properties:
6642+
item_keys:
6643+
description: List of primary keys identifying items to delete from datastore.
6644+
Up to 100 items can be deleted in a single request.
6645+
items:
6646+
type: string
6647+
maxItems: 100
6648+
type: array
6649+
type: object
6650+
BulkDeleteAppsDatastoreItemsRequestDataType:
6651+
default: items
6652+
description: Items resource type.
6653+
enum:
6654+
- items
6655+
example: items
6656+
type: string
6657+
x-enum-varnames:
6658+
- ITEMS
66196659
BulkMuteFindingsRequest:
66206660
description: The new bulk mute finding request.
66216661
properties:
@@ -14733,6 +14773,17 @@ components:
1473314773
data:
1473414774
$ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData'
1473514775
type: object
14776+
DeleteAppsDatastoreItemResponseArray:
14777+
description: The definition of `DeleteAppsDatastoreItemResponseArray` object.
14778+
properties:
14779+
data:
14780+
description: The `DeleteAppsDatastoreItemResponseArray` `data`.
14781+
items:
14782+
$ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData'
14783+
type: array
14784+
required:
14785+
- data
14786+
type: object
1473614787
DeleteAppsDatastoreItemResponseData:
1473714788
description: Data containing the identifier of the datastore item that was successfully
1473814789
deleted.
@@ -51998,6 +52049,60 @@ paths:
5199852049
x-undo:
5199952050
type: idempotent
5200052051
/api/v2/actions-datastores/{datastore_id}/items/bulk:
52052+
delete:
52053+
description: Deletes multiple items from a datastore by their keys in a single
52054+
operation.
52055+
operationId: BulkDeleteDatastoreItems
52056+
parameters:
52057+
- description: The ID of the datastore.
52058+
in: path
52059+
name: datastore_id
52060+
required: true
52061+
schema:
52062+
type: string
52063+
requestBody:
52064+
content:
52065+
application/json:
52066+
schema:
52067+
$ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequest'
52068+
required: true
52069+
responses:
52070+
'200':
52071+
content:
52072+
application/json:
52073+
schema:
52074+
$ref: '#/components/schemas/DeleteAppsDatastoreItemResponseArray'
52075+
description: OK
52076+
'400':
52077+
content:
52078+
application/json:
52079+
schema:
52080+
$ref: '#/components/schemas/JSONAPIErrorResponse'
52081+
description: Bad Request
52082+
'404':
52083+
content:
52084+
application/json:
52085+
schema:
52086+
$ref: '#/components/schemas/JSONAPIErrorResponse'
52087+
description: Not Found
52088+
'429':
52089+
$ref: '#/components/responses/TooManyRequestsResponse'
52090+
'500':
52091+
content:
52092+
application/json:
52093+
schema:
52094+
$ref: '#/components/schemas/JSONAPIErrorResponse'
52095+
description: Internal Server Error
52096+
summary: Bulk delete datastore items
52097+
tags:
52098+
- Actions Datastores
52099+
x-menu-order: 11
52100+
x-permission:
52101+
operator: OR
52102+
permissions:
52103+
- apps_datastore_write
52104+
x-undo:
52105+
type: idempotent
5200152106
post:
5200252107
description: Creates or replaces multiple items in a datastore by their keys
5200352108
in a single operation.

0 commit comments

Comments
 (0)