Regenerate client from commit af78fdc4 of spec repo (#848)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-09-22 15:10:38.455972",
-            "spec_repo_commit": "7f715655"
+            "regenerated": "2022-09-26 07:51:10.791644",
+            "spec_repo_commit": "af78fdc4"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-09-22 15:10:38.471408",
-            "spec_repo_commit": "7f715655"
+            "regenerated": "2022-09-26 07:51:10.803830",
+            "spec_repo_commit": "af78fdc4"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -12863,6 +12863,31 @@ paths:
         cursorPath: meta.page.after
         limitParam: body.page.limit
         resultsPath: data
+  /api/v2/security_monitoring/signals/{signal_id}:
+    get:
+      description: Get a signal's details.
+      operationId: GetSecurityMonitoringSignal
+      parameters:
+      - $ref: '#/components/parameters/SignalID'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/SecurityMonitoringSignal'
+          description: OK
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - security_monitoring_rules_read
+      summary: Get a signal's details
+      tags:
+      - Security Monitoring
   /api/v2/security_monitoring/signals/{signal_id}/assignee:
     patch:
       description: Modify the triage assignee of a security signal.

cassettes/v2/Security-Monitoring_1187227211/Get-a-signal-s-details-returns-Not-Found-response_3888721171/frozen.json

@@ -0,0 +1 @@
+"2022-09-23T14:12:23.353Z"

cassettes/v2/Security-Monitoring_1187227211/Get-a-signal-s-details-returns-Not-Found-response_3888721171/recording.har

@@ -0,0 +1,57 @@
+{
+  "log": {
+    "_recordingName": "Security Monitoring/Get a signal's details returns \"Not Found\" response",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "80586166ccca7aeabc4b8dc902a483fd",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 591,
+          "httpVersion": "HTTP/1.1",
+          "method": "GET",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v2/security_monitoring/signals/AQAAAYNqUBVU4-rffwAAAABBWU5xVUJWVUFBQjJBd3ptCL3QUEm3nt2"
+        },
+        "response": {
+          "bodySize": 31,
+          "content": {
+            "mimeType": "application/json",
+            "size": 31,
+            "text": "{\"errors\":[\"Signal not found\"]}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 669,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 404,
+          "statusText": "Not Found"
+        },
+        "startedDateTime": "2022-09-23T14:12:23.357Z",
+        "time": 413
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

cassettes/v2/Security-Monitoring_1187227211/Get-a-signal-s-details-returns-OK-response_1307184810/frozen.json

@@ -0,0 +1 @@
+"2022-09-23T14:12:23.776Z"

cassettes/v2/Security-Monitoring_1187227211/Get-a-signal-s-details-returns-OK-response_1307184810/recording.har

@@ -0,0 +1,21 @@
+/**
+ * Get a signal's details returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.SecurityMonitoringApi(configuration);
+
+const params: v2.SecurityMonitoringApiGetSecurityMonitoringSignalRequest = {
+  signalId: "AQAAAYNqUBVU4-rffwAAAABBWU5xVUJWVUFBQjJBd3ptMDdQUnF3QUE",
+};
+
+apiInstance
+  .getSecurityMonitoringSignal(params)
+  .then((data: v2.SecurityMonitoringSignal) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/security-monitoring/GetSecurityMonitoringSignal.ts

@@ -219,6 +219,20 @@ Feature: Security Monitoring
     When the request is sent
     Then the response status is 200 OK
 
+  @replay-only @team:DataDog/k9-cloud-security-platform
+  Scenario: Get a signal's details returns "Not Found" response
+    Given new "GetSecurityMonitoringSignal" request
+    And request contains "signal_id" parameter with value "AQAAAYNqUBVU4-rffwAAAABBWU5xVUJWVUFBQjJBd3ptCL3QUEm3nt2"
+    When the request is sent
+    Then the response status is 404 Not Found
+
+  @replay-only @team:DataDog/k9-cloud-security-platform
+  Scenario: Get a signal's details returns "OK" response
+    Given new "GetSecurityMonitoringSignal" request
+    And request contains "signal_id" parameter with value "AQAAAYNqUBVU4-rffwAAAABBWU5xVUJWVUFBQjJBd3ptMDdQUnF3QUE"
+    When the request is sent
+    Then the response status is 200 OK
+
   @team:DataDog/k9-cloud-security-platform
   Scenario: Get all security filters returns "OK" response
     Given new "ListSecurityFilters" request

features/v2/security_monitoring.feature

@@ -752,6 +752,12 @@
       "type": "safe"
     }
   },
+  "GetSecurityMonitoringSignal": {
+    "tag": "Security Monitoring",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "EditSecurityMonitoringSignalAssignee": {
     "tag": "Security Monitoring",
     "undo": {

features/v2/undo.json

@@ -462,6 +462,44 @@ export class SecurityMonitoringApiRequestFactory extends BaseAPIRequestFactory {
     return requestContext;
   }
 
+  public async getSecurityMonitoringSignal(
+    signalId: string,
+    _options?: Configuration
+  ): Promise<RequestContext> {
+    const _config = _options || this.configuration;
+
+    // verify required parameter 'signalId' is not null or undefined
+    if (signalId === null || signalId === undefined) {
+      throw new RequiredError(
+        "Required parameter signalId was null or undefined when calling getSecurityMonitoringSignal."
+      );
+    }
+
+    // Path Params
+    const localVarPath =
+      "/api/v2/security_monitoring/signals/{signal_id}".replace(
+        "{" + "signal_id" + "}",
+        encodeURIComponent(String(signalId))
+      );
+
+    // Make Request Context
+    const requestContext = getServer(
+      _config,
+      "v2.SecurityMonitoringApi.getSecurityMonitoringSignal"
+    ).makeRequestContext(localVarPath, HttpMethod.GET);
+    requestContext.setHeaderParam("Accept", "application/json");
+    requestContext.setHttpConfig(_config.httpConfig);
+
+    // Apply auth methods
+    applySecurityAuthentication(_config, requestContext, [
+      "AuthZ",
+      "apiKeyAuth",
+      "appKeyAuth",
+    ]);
+
+    return requestContext;
+  }
+
   public async listSecurityFilters(
     _options?: Configuration
   ): Promise<RequestContext> {
@@ -1307,6 +1345,63 @@ export class SecurityMonitoringApiResponseProcessor {
     );
   }
 
+  /**
+   * 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 getSecurityMonitoringSignal
+   * @throws ApiException if the response code was not in [200, 299]
+   */
+  public async getSecurityMonitoringSignal(
+    response: ResponseContext
+  ): Promise<SecurityMonitoringSignal> {
+    const contentType = ObjectSerializer.normalizeMediaType(
+      response.headers["content-type"]
+    );
+    if (response.httpStatusCode == 200) {
+      const body: SecurityMonitoringSignal = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "SecurityMonitoringSignal"
+      ) as SecurityMonitoringSignal;
+      return body;
+    }
+    if (response.httpStatusCode == 404 || response.httpStatusCode == 429) {
+      const bodyText = ObjectSerializer.parse(
+        await response.body.text(),
+        contentType
+      );
+      try {
+        const body: APIErrorResponse = ObjectSerializer.deserialize(
+          bodyText,
+          "APIErrorResponse"
+        ) as APIErrorResponse;
+        throw new ApiException<APIErrorResponse>(response.httpStatusCode, body);
+      } catch (error) {
+        logger.info(`Got error deserializing error: ${error}`);
+        throw new ApiException<APIErrorResponse>(
+          response.httpStatusCode,
+          bodyText
+        );
+      }
+    }
+
+    // Work around for missing responses in specification, e.g. for petstore.yaml
+    if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+      const body: SecurityMonitoringSignal = ObjectSerializer.deserialize(
+        ObjectSerializer.parse(await response.body.text(), contentType),
+        "SecurityMonitoringSignal",
+        ""
+      ) as SecurityMonitoringSignal;
+      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
@@ -1762,6 +1857,14 @@ export interface SecurityMonitoringApiGetSecurityMonitoringRuleRequest {
   ruleId: string;
 }
 
+export interface SecurityMonitoringApiGetSecurityMonitoringSignalRequest {
+  /**
+   * The ID of the signal.
+   * @type string
+   */
+  signalId: string;
+}
+
 export interface SecurityMonitoringApiListSecurityMonitoringRulesRequest {
   /**
    * Size for a given page.
@@ -2066,6 +2169,27 @@ export class SecurityMonitoringApi {
     });
   }
 
+  /**
+   * Get a signal's details.
+   * @param param The request object
+   */
+  public getSecurityMonitoringSignal(
+    param: SecurityMonitoringApiGetSecurityMonitoringSignalRequest,
+    options?: Configuration
+  ): Promise<SecurityMonitoringSignal> {
+    const requestContextPromise =
+      this.requestFactory.getSecurityMonitoringSignal(param.signalId, options);
+    return requestContextPromise.then((requestContext) => {
+      return this.configuration.httpApi
+        .send(requestContext)
+        .then((responseContext) => {
+          return this.responseProcessor.getSecurityMonitoringSignal(
+            responseContext
+          );
+        });
+    });
+  }
+
   /**
    * Get the list of configured security filters with their definitions.
    * @param param The request object