Document new properties and fix security monitoring schemas (#1248)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-26 14:58:34.052664",
-            "spec_repo_commit": "3d6b3d5a"
+            "regenerated": "2023-07-26 17:14:51.413957",
+            "spec_repo_commit": "69e8c6e4"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-07-26 14:58:34.074888",
-            "spec_repo_commit": "3d6b3d5a"
+            "regenerated": "2023-07-26 17:14:51.429473",
+            "spec_repo_commit": "69e8c6e4"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -2596,6 +2596,7 @@ components:
           type: string
       type: object
     CloudConfigurationComplianceRuleOptions:
+      additionalProperties: {}
       description: 'Options for cloud_configuration rules.
 
         Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration`
@@ -2667,6 +2668,16 @@ components:
       description: How to generate compliance signals. Useful for cloud_configuration
         rules only.
       properties:
+        defaultActivationStatus:
+          description: The default activation status.
+          nullable: true
+          type: boolean
+        defaultGroupByFields:
+          description: The default group by fields.
+          items:
+            type: string
+          nullable: true
+          type: array
         userActivationStatus:
           description: Whether signals will be sent.
           nullable: true
@@ -12904,6 +12915,7 @@ components:
       - data
       type: object
     SecurityMonitoringSignalAttributes:
+      additionalProperties: {}
       description: 'The object containing all signal attributes and their
 
         associated values.'
@@ -13022,6 +13034,21 @@ components:
           maximum: 1000
           type: integer
       type: object
+    SecurityMonitoringSignalMetadataType:
+      default: signal_metadata
+      description: The type of event.
+      enum:
+      - signal_metadata
+      example: signal_metadata
+      type: string
+      x-enum-varnames:
+      - SIGNAL_METADATA
+    SecurityMonitoringSignalResponse:
+      description: Security Signal response data object.
+      properties:
+        data:
+          $ref: '#/components/schemas/SecurityMonitoringSignal'
+      type: object
     SecurityMonitoringSignalRuleCreatePayload:
       description: Create a new signal correlation rule.
       properties:
@@ -13190,7 +13217,7 @@ components:
         aggregation:
           $ref: '#/components/schemas/SecurityMonitoringRuleQueryAggregation'
         correlatedByFields:
-          description: Fields to group by.
+          description: Fields to correlate by.
           items:
             description: Field.
             type: string
@@ -13204,6 +13231,18 @@ components:
           description: Default Rule ID to match on signals.
           example: d3f-ru1-e1d
           type: string
+        distinctFields:
+          description: Field for which the cardinality is measured. Sent as an array.
+          items:
+            description: Field.
+            type: string
+          type: array
+        groupByFields:
+          description: Fields to group by.
+          items:
+            description: Field.
+            type: string
+          type: array
         metrics:
           description: Group of target fields to aggregate over.
           items:
@@ -13256,6 +13295,10 @@ components:
       properties:
         attributes:
           $ref: '#/components/schemas/SecurityMonitoringSignalStateUpdateAttributes'
+        id:
+          description: The unique ID of the security signal.
+        type:
+          $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
       required:
       - attributes
       type: object
@@ -13306,6 +13349,11 @@ components:
       properties:
         attributes:
           $ref: '#/components/schemas/SecurityMonitoringSignalTriageAttributes'
+        id:
+          description: The unique ID of the security signal.
+          type: string
+        type:
+          $ref: '#/components/schemas/SecurityMonitoringSignalMetadataType'
       type: object
     SecurityMonitoringSignalTriageUpdateResponse:
       description: The response returned after all triage operations, containing the
@@ -13481,8 +13529,6 @@ components:
           description: Query to run on logs.
           example: a > 3
           type: string
-      required:
-      - query
       type: object
     SecurityMonitoringStandardRuleResponse:
       description: Rule.
@@ -13563,6 +13609,11 @@ components:
         handle:
           description: The handle for this user account.
           type: string
+        icon:
+          description: Gravatar icon associated to the user.
+          example: /path/to/matching/gravatar/icon
+          readOnly: true
+          type: string
         id:
           description: Numerical ID assigned by Datadog to this user account.
           format: int64
@@ -24478,7 +24529,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/SecurityMonitoringSignal'
+                $ref: '#/components/schemas/SecurityMonitoringSignalResponse'
           description: OK
         '404':
           $ref: '#/components/responses/NotFoundResponse'

examples/v2/security-monitoring/GetSecurityMonitoringSignal.ts

@@ -13,7 +13,7 @@ const params: v2.SecurityMonitoringApiGetSecurityMonitoringSignalRequest = {
 
 apiInstance
   .getSecurityMonitoringSignal(params)
-  .then((data: v2.SecurityMonitoringSignal) => {
+  .then((data: v2.SecurityMonitoringSignalResponse) => {
     console.log(
       "API called successfully. Returned data: " + JSON.stringify(data)
     );

features/support/scenarios_model_mapping.ts

@@ -4003,7 +4003,7 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "string",
             "format": "",
             },
-        "operationResponseType": "SecurityMonitoringSignal",
+        "operationResponseType": "SecurityMonitoringSignalResponse",
     },
     "v2.EditSecurityMonitoringSignalAssignee": {
         "signalId": {

features/v2/security_monitoring.feature

@@ -35,15 +35,15 @@ Feature: Security Monitoring
   Scenario: Change the triage state of a security signal returns "Bad Request" response
     Given new "EditSecurityMonitoringSignalState" request
     And request contains "signal_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"archive_reason": "none", "state": "open"}}}
+    And body with value {"data": {"attributes": {"archive_reason": "none", "state": "open"}, "type": "signal_metadata"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Change the triage state of a security signal returns "Not Found" response
     Given new "EditSecurityMonitoringSignalState" request
     And request contains "signal_id" parameter from "REPLACE.ME"
-    And body with value {"data": {"attributes": {"archive_reason": "none", "state": "open"}}}
+    And body with value {"data": {"attributes": {"archive_reason": "none", "state": "open"}, "type": "signal_metadata"}}
     When the request is sent
     Then the response status is 404 Not Found
 

packages/datadog-api-client-v2/apis/SecurityMonitoringApi.ts

@@ -39,6 +39,7 @@ import { SecurityMonitoringSignalAssigneeUpdateRequest } from "../models/Securit
 import { SecurityMonitoringSignalIncidentsUpdateRequest } from "../models/SecurityMonitoringSignalIncidentsUpdateRequest";
 import { SecurityMonitoringSignalListRequest } from "../models/SecurityMonitoringSignalListRequest";
 import { SecurityMonitoringSignalListRequestPage } from "../models/SecurityMonitoringSignalListRequestPage";
+import { SecurityMonitoringSignalResponse } from "../models/SecurityMonitoringSignalResponse";
 import { SecurityMonitoringSignalsListResponse } from "../models/SecurityMonitoringSignalsListResponse";
 import { SecurityMonitoringSignalsSort } from "../models/SecurityMonitoringSignalsSort";
 import { SecurityMonitoringSignalStateUpdateRequest } from "../models/SecurityMonitoringSignalStateUpdateRequest";
@@ -1634,15 +1635,16 @@ export class SecurityMonitoringApiResponseProcessor {
    */
   public async getSecurityMonitoringSignal(
     response: ResponseContext
-  ): Promise<SecurityMonitoringSignal> {
+  ): Promise<SecurityMonitoringSignalResponse> {
     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;
+      const body: SecurityMonitoringSignalResponse =
+        ObjectSerializer.deserialize(
+          ObjectSerializer.parse(await response.body.text(), contentType),
+          "SecurityMonitoringSignalResponse"
+        ) as SecurityMonitoringSignalResponse;
       return body;
     }
     if (response.httpStatusCode == 404 || response.httpStatusCode == 429) {
@@ -1668,11 +1670,12 @@ export class SecurityMonitoringApiResponseProcessor {
 
     // 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;
+      const body: SecurityMonitoringSignalResponse =
+        ObjectSerializer.deserialize(
+          ObjectSerializer.parse(await response.body.text(), contentType),
+          "SecurityMonitoringSignalResponse",
+          ""
+        ) as SecurityMonitoringSignalResponse;
       return body;
     }
 
@@ -2710,7 +2713,7 @@ export class SecurityMonitoringApi {
   public getSecurityMonitoringSignal(
     param: SecurityMonitoringApiGetSecurityMonitoringSignalRequest,
     options?: Configuration
-  ): Promise<SecurityMonitoringSignal> {
+  ): Promise<SecurityMonitoringSignalResponse> {
     const requestContextPromise =
       this.requestFactory.getSecurityMonitoringSignal(param.signalId, options);
     return requestContextPromise.then((requestContext) => {

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

@@ -1202,6 +1202,8 @@ export { SecurityMonitoringSignalIncidentsUpdateRequest } from "./models/Securit
 export { SecurityMonitoringSignalListRequest } from "./models/SecurityMonitoringSignalListRequest";
 export { SecurityMonitoringSignalListRequestFilter } from "./models/SecurityMonitoringSignalListRequestFilter";
 export { SecurityMonitoringSignalListRequestPage } from "./models/SecurityMonitoringSignalListRequestPage";
+export { SecurityMonitoringSignalMetadataType } from "./models/SecurityMonitoringSignalMetadataType";
+export { SecurityMonitoringSignalResponse } from "./models/SecurityMonitoringSignalResponse";
 export { SecurityMonitoringSignalRuleCreatePayload } from "./models/SecurityMonitoringSignalRuleCreatePayload";
 export { SecurityMonitoringSignalRuleQuery } from "./models/SecurityMonitoringSignalRuleQuery";
 export { SecurityMonitoringSignalRuleResponse } from "./models/SecurityMonitoringSignalRuleResponse";

packages/datadog-api-client-v2/models/CloudConfigurationRuleComplianceSignalOptions.ts

@@ -10,6 +10,14 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  * How to generate compliance signals. Useful for cloud_configuration rules only.
  */
 export class CloudConfigurationRuleComplianceSignalOptions {
+  /**
+   * The default activation status.
+   */
+  "defaultActivationStatus"?: boolean;
+  /**
+   * The default group by fields.
+   */
+  "defaultGroupByFields"?: Array<string>;
   /**
    * Whether signals will be sent.
    */
@@ -28,6 +36,14 @@ export class CloudConfigurationRuleComplianceSignalOptions {
    * @ignore
    */
   static readonly attributeTypeMap: AttributeTypeMap = {
+    defaultActivationStatus: {
+      baseName: "defaultActivationStatus",
+      type: "boolean",
+    },
+    defaultGroupByFields: {
+      baseName: "defaultGroupByFields",
+      type: "Array<string>",
+    },
     userActivationStatus: {
       baseName: "userActivationStatus",
       type: "boolean",

packages/datadog-api-client-v2/models/ObjectSerializer.ts

@@ -618,6 +618,7 @@ import { SecurityMonitoringSignalIncidentsUpdateRequest } from "./SecurityMonito
 import { SecurityMonitoringSignalListRequest } from "./SecurityMonitoringSignalListRequest";
 import { SecurityMonitoringSignalListRequestFilter } from "./SecurityMonitoringSignalListRequestFilter";
 import { SecurityMonitoringSignalListRequestPage } from "./SecurityMonitoringSignalListRequestPage";
+import { SecurityMonitoringSignalResponse } from "./SecurityMonitoringSignalResponse";
 import { SecurityMonitoringSignalRuleCreatePayload } from "./SecurityMonitoringSignalRuleCreatePayload";
 import { SecurityMonitoringSignalRuleQuery } from "./SecurityMonitoringSignalRuleQuery";
 import { SecurityMonitoringSignalRuleResponse } from "./SecurityMonitoringSignalRuleResponse";
@@ -1202,6 +1203,7 @@ const enumsMap: { [key: string]: any[] } = {
     "investigated_case_opened",
     "other",
   ],
+  SecurityMonitoringSignalMetadataType: ["signal_metadata"],
   SecurityMonitoringSignalRuleType: ["signal_correlation"],
   SecurityMonitoringSignalState: ["open", "archived", "under_review"],
   SecurityMonitoringSignalType: ["signal"],
@@ -1991,6 +1993,7 @@ const typeMap: { [index: string]: any } = {
     SecurityMonitoringSignalListRequestFilter,
   SecurityMonitoringSignalListRequestPage:
     SecurityMonitoringSignalListRequestPage,
+  SecurityMonitoringSignalResponse: SecurityMonitoringSignalResponse,
   SecurityMonitoringSignalRuleCreatePayload:
     SecurityMonitoringSignalRuleCreatePayload,
   SecurityMonitoringSignalRuleQuery: SecurityMonitoringSignalRuleQuery,

packages/datadog-api-client-v2/models/SecurityMonitoringSignalMetadataType.ts

@@ -0,0 +1,16 @@
+/**
+ * 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 2020-Present Datadog, Inc.
+ */
+
+import { UnparsedObject } from "../../datadog-api-client-common/util";
+
+/**
+ * The type of event.
+ */
+
+export type SecurityMonitoringSignalMetadataType =
+  | typeof SIGNAL_METADATA
+  | UnparsedObject;
+export const SIGNAL_METADATA = "signal_metadata";

packages/datadog-api-client-v2/models/SecurityMonitoringSignalResponse.ts

@@ -0,0 +1,42 @@
+/**
+ * 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 2020-Present Datadog, Inc.
+ */
+import { SecurityMonitoringSignal } from "./SecurityMonitoringSignal";
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * Security Signal response data object.
+ */
+export class SecurityMonitoringSignalResponse {
+  /**
+   * Object description of a security signal.
+   */
+  "data"?: SecurityMonitoringSignal;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    data: {
+      baseName: "data",
+      type: "SecurityMonitoringSignal",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return SecurityMonitoringSignalResponse.attributeTypeMap;
+  }
+
+  public constructor() {}
+}