Add delete log index to public API (#2084)

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

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 18:30:09.656601",
-            "spec_repo_commit": "fb234cde"
+            "regenerated": "2025-03-06 19:05:44.923367",
+            "spec_repo_commit": "b892dbfc"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-06 18:30:09.671867",
-            "spec_repo_commit": "fb234cde"
+            "regenerated": "2025-03-06 19:05:44.939641",
+            "spec_repo_commit": "b892dbfc"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -28758,6 +28758,47 @@ paths:
         permissions:
         - logs_modify_indexes
   /api/v1/logs/config/indexes/{name}:
+    delete:
+      description: 'Delete an existing index from your organization. Index deletions
+        are permanent and cannot be reverted.
+
+        You cannot recreate an index with the same name as deleted ones.'
+      operationId: DeleteLogsIndex
+      parameters:
+      - description: Name of the log index.
+        in: path
+        name: name
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LogsIndex'
+          description: OK
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/APIErrorResponse'
+          description: Forbidden
+        '404':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/LogsAPIErrorResponse'
+          description: Not Found
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: Delete an index
+      tags:
+      - Logs Indexes
+      x-permission:
+        operator: OR
+        permissions:
+        - logs_modify_indexes
     get:
       description: Get one log index from your organization. This endpoint takes no
         JSON arguments.

examples/v1/logs-indexes/DeleteLogsIndex.ts

@@ -0,0 +1,21 @@
+/**
+ * Delete an index returns "OK" response
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.LogsIndexesApi(configuration);
+
+const params: v1.LogsIndexesApiDeleteLogsIndexRequest = {
+  name: "name",
+};
+
+apiInstance
+  .deleteLogsIndex(params)
+  .then((data: v1.LogsIndex) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

@@ -1394,6 +1394,13 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             },
         "operationResponseType": "LogsIndex",
     },
+    "v1.DeleteLogsIndex": {
+        "name": {
+            "type": "string",
+            "format": "",
+            },
+        "operationResponseType": "LogsIndex",
+    },
     "v1.GetLogsIndex": {
         "name": {
             "type": "string",

features/v1/logs_indexes.feature

@@ -22,6 +22,20 @@ Feature: Logs Indexes
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
+  Scenario: Delete an index returns "Not Found" response
+    Given new "DeleteLogsIndex" request
+    And request contains "name" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 404 Not Found
+
+  @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
+  Scenario: Delete an index returns "OK" response
+    Given new "DeleteLogsIndex" request
+    And request contains "name" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/logs-backend @team:DataDog/logs-core
   Scenario: Get all indexes returns "OK" response
     Given new "ListLogIndexes" request

features/v1/undo.json

@@ -694,6 +694,12 @@
       "type": "unsafe"
     }
   },
+  "DeleteLogsIndex": {
+    "tag": "Logs Indexes",
+    "undo": {
+      "type": "idempotent"
+    }
+  },
   "GetLogsIndex": {
     "tag": "Logs Indexes",
     "undo": {

packages/datadog-api-client-v1/apis/LogsIndexesApi.ts

@@ -65,6 +65,39 @@ export class LogsIndexesApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
+  public async deleteLogsIndex(
+    name: string,
+    _options?: Configuration
+  ): Promise<RequestContext> {
+    const _config = _options || this.configuration;
+
+    // verify required parameter 'name' is not null or undefined
+    if (name === null || name === undefined) {
+      throw new RequiredError("name", "deleteLogsIndex");
+    }
+
+    // Path Params
+    const localVarPath = "/api/v1/logs/config/indexes/{name}".replace(
+      "{name}",
+      encodeURIComponent(String(name))
+    );
+
+    // Make Request Context
+    const requestContext = _config
+      .getServer("v1.LogsIndexesApi.deleteLogsIndex")
+      .makeRequestContext(localVarPath, HttpMethod.DELETE);
+    requestContext.setHeaderParam("Accept", "application/json");
+    requestContext.setHttpConfig(_config.httpConfig);
+
+    // Apply auth methods
+    applySecurityAuthentication(_config, requestContext, [
+      "apiKeyAuth",
+      "appKeyAuth",
+    ]);
+
+    return requestContext;
+  }
+
   public async getLogsIndex(
     name: string,
     _options?: Configuration
@@ -319,6 +352,85 @@ export class LogsIndexesApiResponseProcessor {
     );
   }
 
+  /**
+   * Unwraps the actual response sent by the server from the response context and deserializes the response content
+   * to the expected objects
+   *
+   * @params response Response returned by the server for a request to deleteLogsIndex
+   * @throws ApiException if the response code was not in [200, 299]
+   */
+  public async deleteLogsIndex(response: ResponseContext): Promise<LogsIndex> {
+    const contentType = ObjectSerializer.normalizeMediaType(
+      response.headers["content-type"]
+    );
+    if (response.httpStatusCode === 200) {
+      const body: LogsIndex = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "LogsIndex"
+      ) as LogsIndex;
+      return body;
+    }
+    if (response.httpStatusCode === 403 || response.httpStatusCode === 429) {
+      const bodyText = ObjectSerializer.parse(
+        await response.body.text(),
+        contentType
+      );
+      let body: APIErrorResponse;
+      try {
+        body = ObjectSerializer.deserialize(
+          bodyText,
+          "APIErrorResponse"
+        ) as APIErrorResponse;
+      } catch (error) {
+        logger.debug(`Got error deserializing error: ${error}`);
+        throw new ApiException<APIErrorResponse>(
+          response.httpStatusCode,
+          bodyText
+        );
+      }
+      throw new ApiException<APIErrorResponse>(response.httpStatusCode, body);
+    }
+    if (response.httpStatusCode === 404) {
+      const bodyText = ObjectSerializer.parse(
+        await response.body.text(),
+        contentType
+      );
+      let body: LogsAPIErrorResponse;
+      try {
+        body = ObjectSerializer.deserialize(
+          bodyText,
+          "LogsAPIErrorResponse"
+        ) as LogsAPIErrorResponse;
+      } catch (error) {
+        logger.debug(`Got error deserializing error: ${error}`);
+        throw new ApiException<LogsAPIErrorResponse>(
+          response.httpStatusCode,
+          bodyText
+        );
+      }
+      throw new ApiException<LogsAPIErrorResponse>(
+        response.httpStatusCode,
+        body
+      );
+    }
+
+    // Work around for missing responses in specification, e.g. for petstore.yaml
+    if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+      const body: LogsIndex = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "LogsIndex",
+        ""
+      ) as LogsIndex;
+      return body;
+    }
+
+    const body = (await response.body.text()) || "";
+    throw new ApiException<string>(
+      response.httpStatusCode,
+      'Unknown API Status Code!\nBody: "' + body + '"'
+    );
+  }
+
   /**
    * Unwraps the actual response sent by the server from the response context and deserializes the response content
    * to the expected objects
@@ -683,6 +795,14 @@ export interface LogsIndexesApiCreateLogsIndexRequest {
   body: LogsIndex;
 }
 
+export interface LogsIndexesApiDeleteLogsIndexRequest {
+  /**
+   * Name of the log index.
+   * @type string
+   */
+  name: string;
+}
+
 export interface LogsIndexesApiGetLogsIndexRequest {
   /**
    * Name of the log index.
@@ -750,6 +870,28 @@ export class LogsIndexesApi {
     });
   }
 
+  /**
+   * Delete an existing index from your organization. Index deletions are permanent and cannot be reverted.
+   * You cannot recreate an index with the same name as deleted ones.
+   * @param param The request object
+   */
+  public deleteLogsIndex(
+    param: LogsIndexesApiDeleteLogsIndexRequest,
+    options?: Configuration
+  ): Promise<LogsIndex> {
+    const requestContextPromise = this.requestFactory.deleteLogsIndex(
+      param.name,
+      options
+    );
+    return requestContextPromise.then((requestContext) => {
+      return this.configuration.httpApi
+        .send(requestContext)
+        .then((responseContext) => {
+          return this.responseProcessor.deleteLogsIndex(responseContext);
+        });
+    });
+  }
+
   /**
    * Get one log index from your organization. This endpoint takes no JSON arguments.
    * @param param The request object

packages/datadog-api-client-v1/index.ts

@@ -112,6 +112,7 @@ export {
 
 export {
   LogsIndexesApiCreateLogsIndexRequest,
+  LogsIndexesApiDeleteLogsIndexRequest,
   LogsIndexesApiGetLogsIndexRequest,
   LogsIndexesApiUpdateLogsIndexRequest,
   LogsIndexesApiUpdateLogsIndexOrderRequest,