Add BulkDeleteDatastoreItems to Datastore API spec (#2863)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -6553,6 +6553,46 @@ components:
           description: The type of the object, must be `budget`.
           type: string
       type: object
+    BulkDeleteAppsDatastoreItemsRequest:
+      description: Request to delete items from a datastore.
+      properties:
+        data:
+          $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestData'
+      type: object
+    BulkDeleteAppsDatastoreItemsRequestData:
+      description: Data wrapper containing the data needed to delete items from a
+        datastore.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataAttributes'
+        id:
+          description: ID for the datastore of the items to delete.
+          type: string
+        type:
+          $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequestDataType'
+      required:
+      - type
+      type: object
+    BulkDeleteAppsDatastoreItemsRequestDataAttributes:
+      description: Attributes of request data to delete items from a datastore.
+      properties:
+        item_keys:
+          description: List of primary keys identifying items to delete from datastore.
+            Up to 100 items can be deleted in a single request.
+          items:
+            type: string
+          maxItems: 100
+          type: array
+      type: object
+    BulkDeleteAppsDatastoreItemsRequestDataType:
+      default: items
+      description: Items resource type.
+      enum:
+      - items
+      example: items
+      type: string
+      x-enum-varnames:
+      - ITEMS
     BulkMuteFindingsRequest:
       description: The new bulk mute finding request.
       properties:
@@ -14869,6 +14909,17 @@ components:
         data:
           $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData'
       type: object
+    DeleteAppsDatastoreItemResponseArray:
+      description: The definition of `DeleteAppsDatastoreItemResponseArray` object.
+      properties:
+        data:
+          description: The `DeleteAppsDatastoreItemResponseArray` `data`.
+          items:
+            $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseData'
+          type: array
+      required:
+      - data
+      type: object
     DeleteAppsDatastoreItemResponseData:
       description: Data containing the identifier of the datastore item that was successfully
         deleted.
@@ -51257,6 +51308,57 @@ paths:
         permissions:
         - apps_datastore_write
   /api/v2/actions-datastores/{datastore_id}/items/bulk:
+    delete:
+      description: Deletes multiple items from a datastore by their keys in a single
+        operation.
+      operationId: BulkDeleteDatastoreItems
+      parameters:
+      - description: The ID of the datastore.
+        in: path
+        name: datastore_id
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/BulkDeleteAppsDatastoreItemsRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DeleteAppsDatastoreItemResponseArray'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Not Found
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+        '500':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Internal Server Error
+      summary: Bulk delete datastore items
+      tags:
+      - Actions Datastores
+      x-permission:
+        operator: OR
+        permissions:
+        - apps_datastore_write
     post:
       description: Creates or replaces multiple items in a datastore by their keys
         in a single operation.

docs/datadog_api_client.v2.model.rst

@@ -2398,6 +2398,34 @@ datadog\_api\_client.v2.model.budget\_with\_entries\_data module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.bulk\_delete\_apps\_datastore\_items\_request module
+----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.bulk\_delete\_apps\_datastore\_items\_request\_data module
+----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.bulk\_delete\_apps\_datastore\_items\_request\_data\_attributes module
+----------------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data_attributes
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.bulk\_delete\_apps\_datastore\_items\_request\_data\_type module
+----------------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.bulk\_mute\_findings\_request module
 ------------------------------------------------------------------
 
@@ -5856,6 +5884,13 @@ datadog\_api\_client.v2.model.delete\_apps\_datastore\_item\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.delete\_apps\_datastore\_item\_response\_array module
+-----------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.delete_apps_datastore_item_response_array
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.delete\_apps\_datastore\_item\_response\_data module
 ----------------------------------------------------------------------------------
 

examples/v2/actions-datastores/BulkDeleteDatastoreItems.py

@@ -0,0 +1,38 @@
+"""
+Bulk delete datastore items returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.actions_datastores_api import ActionsDatastoresApi
+from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request import BulkDeleteAppsDatastoreItemsRequest
+from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data import (
+    BulkDeleteAppsDatastoreItemsRequestData,
+)
+from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data_attributes import (
+    BulkDeleteAppsDatastoreItemsRequestDataAttributes,
+)
+from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data_type import (
+    BulkDeleteAppsDatastoreItemsRequestDataType,
+)
+
+# there is a valid "datastore" in the system
+DATASTORE_DATA_ID = environ["DATASTORE_DATA_ID"]
+
+body = BulkDeleteAppsDatastoreItemsRequest(
+    data=BulkDeleteAppsDatastoreItemsRequestData(
+        attributes=BulkDeleteAppsDatastoreItemsRequestDataAttributes(
+            item_keys=[
+                "test-key",
+            ],
+        ),
+        type=BulkDeleteAppsDatastoreItemsRequestDataType.ITEMS,
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ActionsDatastoresApi(api_client)
+    response = api_instance.bulk_delete_datastore_items(datastore_id=DATASTORE_DATA_ID, body=body)
+
+    print(response)

src/datadog_api_client/v2/api/actions_datastores_api.py

@@ -21,6 +21,8 @@
 from datadog_api_client.v2.model.item_api_payload_array import ItemApiPayloadArray
 from datadog_api_client.v2.model.item_api_payload import ItemApiPayload
 from datadog_api_client.v2.model.update_apps_datastore_item_request import UpdateAppsDatastoreItemRequest
+from datadog_api_client.v2.model.delete_apps_datastore_item_response_array import DeleteAppsDatastoreItemResponseArray
+from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request import BulkDeleteAppsDatastoreItemsRequest
 from datadog_api_client.v2.model.put_apps_datastore_item_response_array import PutAppsDatastoreItemResponseArray
 from datadog_api_client.v2.model.bulk_put_apps_datastore_items_request import BulkPutAppsDatastoreItemsRequest
 
@@ -36,6 +38,32 @@ def __init__(self, api_client=None):
             api_client = ApiClient(Configuration())
         self.api_client = api_client
 
+        self._bulk_delete_datastore_items_endpoint = _Endpoint(
+            settings={
+                "response_type": (DeleteAppsDatastoreItemResponseArray,),
+                "auth": ["apiKeyAuth", "appKeyAuth"],
+                "endpoint_path": "/api/v2/actions-datastores/{datastore_id}/items/bulk",
+                "operation_id": "bulk_delete_datastore_items",
+                "http_method": "DELETE",
+                "version": "v2",
+            },
+            params_map={
+                "datastore_id": {
+                    "required": True,
+                    "openapi_types": (str,),
+                    "attribute": "datastore_id",
+                    "location": "path",
+                },
+                "body": {
+                    "required": True,
+                    "openapi_types": (BulkDeleteAppsDatastoreItemsRequest,),
+                    "location": "body",
+                },
+            },
+            headers_map={"accept": ["application/json"], "content_type": ["application/json"]},
+            api_client=api_client,
+        )
+
         self._bulk_write_datastore_items_endpoint = _Endpoint(
             settings={
                 "response_type": (PutAppsDatastoreItemResponseArray,),
@@ -277,6 +305,27 @@ def __init__(self, api_client=None):
             api_client=api_client,
         )
 
+    def bulk_delete_datastore_items(
+        self,
+        datastore_id: str,
+        body: BulkDeleteAppsDatastoreItemsRequest,
+    ) -> DeleteAppsDatastoreItemResponseArray:
+        """Bulk delete datastore items.
+
+        Deletes multiple items from a datastore by their keys in a single operation.
+
+        :param datastore_id: The ID of the datastore.
+        :type datastore_id: str
+        :type body: BulkDeleteAppsDatastoreItemsRequest
+        :rtype: DeleteAppsDatastoreItemResponseArray
+        """
+        kwargs: Dict[str, Any] = {}
+        kwargs["datastore_id"] = datastore_id
+
+        kwargs["body"] = body
+
+        return self._bulk_delete_datastore_items_endpoint.call_with_http_info(**kwargs)
+
     def bulk_write_datastore_items(
         self,
         datastore_id: str,

src/datadog_api_client/v2/model/bulk_delete_apps_datastore_items_request.py

@@ -0,0 +1,46 @@
+# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+# This product includes software developed at Datadog (https://www.datadoghq.com/).
+# Copyright 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import Union, TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+    unset,
+    UnsetType,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data import (
+        BulkDeleteAppsDatastoreItemsRequestData,
+    )
+
+
+class BulkDeleteAppsDatastoreItemsRequest(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.bulk_delete_apps_datastore_items_request_data import (
+            BulkDeleteAppsDatastoreItemsRequestData,
+        )
+
+        return {
+            "data": (BulkDeleteAppsDatastoreItemsRequestData,),
+        }
+
+    attribute_map = {
+        "data": "data",
+    }
+
+    def __init__(self_, data: Union[BulkDeleteAppsDatastoreItemsRequestData, UnsetType] = unset, **kwargs):
+        """
+        Request to delete items from a datastore.
+
+        :param data: Data wrapper containing the data needed to delete items from a datastore.
+        :type data: BulkDeleteAppsDatastoreItemsRequestData, optional
+        """
+        if data is not unset:
+            kwargs["data"] = data
+        super().__init__(kwargs)