Regenerate client from commit 5d8b0bc1 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-02 18:58:17.891416",
-            "spec_repo_commit": "aee9e14a"
+            "regenerated": "2023-10-04 18:34:01.004048",
+            "spec_repo_commit": "5d8b0bc1"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-02 18:58:17.905529",
-            "spec_repo_commit": "aee9e14a"
+            "regenerated": "2023-10-04 18:34:01.018668",
+            "spec_repo_commit": "5d8b0bc1"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -6839,6 +6839,33 @@ components:
           type: string
       readOnly: true
       type: object
+    MonitorOptionsCustomSchedule:
+      description: Configuration options for the custom schedule. **This feature is
+        in private beta.**
+      properties:
+        recurrences:
+          description: Array of custom schedule recurrences.
+          items:
+            $ref: '#/components/schemas/MonitorOptionsCustomScheduleRecurrence'
+          type: array
+      type: object
+    MonitorOptionsCustomScheduleRecurrence:
+      description: Configuration for a recurrence set on the monitor options for custom
+        schedule.
+      properties:
+        rrule:
+          description: Defines the recurrence rule (RRULE) for a given schedule.
+          example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR
+          type: string
+        start:
+          description: Defines the start date and time of the recurring schedule.
+          example: '2023-08-31T16:30:00'
+          type: string
+        timezone:
+          description: Defines the timezone the schedule runs on.
+          example: Europe/Paris
+          type: string
+      type: object
     MonitorOptionsNotificationPresets:
       default: show_all
       description: Toggles the display of additional content sent in the monitor notification.
@@ -6856,6 +6883,8 @@ components:
     MonitorOptionsSchedulingOptions:
       description: Configuration options for scheduling.
       properties:
+        custom_schedule:
+          $ref: '#/components/schemas/MonitorOptionsCustomSchedule'
         evaluation_window:
           $ref: '#/components/schemas/MonitorOptionsSchedulingOptionsEvaluationWindow'
       type: object

cassettes/v1/Monitors_4022238206/Validate-an-existing-monitor-returns-OK-response_898284207/frozen.json

@@ -1 +1 @@
-"2023-01-18T18:37:20.511Z"
+"2023-10-04T18:21:59.260Z"

cassettes/v1/Monitors_4022238206/Validate-an-existing-monitor-returns-OK-response_898284207/recording.har

@@ -8,7 +8,7 @@
     },
     "entries": [
       {
-        "_id": "a6398d92236de6af6e0c182ccfc97958",
+        "_id": "872abdb5f24e9461c6643498d4bc4eb3",
         "_order": 0,
         "cache": {},
         "request": {
@@ -32,7 +32,7 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"message\":\"some message Notify: @hipchat-channel\",\"name\":\"Test-Validate_an_existing_monitor_returns_OK_response-1674067040\",\"options\":{\"enable_logs_sample\":true,\"escalation_message\":\"the situation has escalated\",\"evaluation_delay\":700,\"groupby_simple_monitor\":true,\"include_tags\":true,\"locked\":false,\"new_host_delay\":600,\"no_data_timeframe\":null,\"notification_preset_name\":\"hide_handles\",\"notify_audit\":false,\"notify_no_data\":false,\"on_missing_data\":\"show_and_notify_no_data\",\"renotify_interval\":60,\"require_full_window\":true,\"thresholds\":{\"critical\":2,\"warning\":1},\"timeout_h\":24},\"priority\":3,\"query\":\"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\"tags\":[\"test:testvalidateanexistingmonitorreturnsokresponse1674067040\",\"env:ci\"],\"type\":\"log alert\"}"
+            "text": "{\"message\":\"some message Notify: @hipchat-channel\",\"name\":\"Test-Validate_an_existing_monitor_returns_OK_response-1696443719\",\"options\":{\"enable_logs_sample\":true,\"escalation_message\":\"the situation has escalated\",\"evaluation_delay\":700,\"groupby_simple_monitor\":true,\"include_tags\":true,\"locked\":false,\"new_host_delay\":600,\"no_data_timeframe\":null,\"notification_preset_name\":\"hide_handles\",\"notify_audit\":false,\"notify_no_data\":false,\"on_missing_data\":\"show_and_notify_no_data\",\"renotify_interval\":60,\"require_full_window\":true,\"thresholds\":{\"critical\":2,\"warning\":1},\"timeout_h\":24},\"priority\":3,\"query\":\"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\"tags\":[\"test:testvalidateanexistingmonitorreturnsokresponse1696443719\",\"env:ci\"],\"type\":\"log alert\"}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/monitor"
@@ -42,7 +42,7 @@
           "content": {
             "mimeType": "application/json",
             "size": 1182,
-            "text": "{\"id\":108260307,\"org_id\":321813,\"type\":\"log alert\",\"name\":\"Test-Validate_an_existing_monitor_returns_OK_response-1674067040\",\"message\":\"some message Notify: @hipchat-channel\",\"tags\":[\"test:testvalidateanexistingmonitorreturnsokresponse1674067040\",\"env:ci\"],\"query\":\"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\"options\":{\"enable_logs_sample\":true,\"escalation_message\":\"the situation has escalated\",\"evaluation_delay\":700,\"groupby_simple_monitor\":true,\"include_tags\":true,\"locked\":false,\"new_host_delay\":600,\"no_data_timeframe\":null,\"notification_preset_name\":\"hide_handles\",\"notify_audit\":false,\"notify_no_data\":false,\"on_missing_data\":\"show_and_notify_no_data\",\"renotify_interval\":60,\"require_full_window\":true,\"thresholds\":{\"critical\":2.0,\"warning\":1.0},\"timeout_h\":24,\"silenced\":{}},\"multi\":true,\"created_at\":1674067040000,\"created\":\"2023-01-18T18:37:20.717952+00:00\",\"modified\":\"2023-01-18T18:37:20.717952+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":3,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":null,\"handle\":\"frog@datadoghq.com\",\"email\":\"frog@datadoghq.com\",\"id\":1445416}}\n"
+            "text": "{\"id\":132537531,\"org_id\":321813,\"type\":\"log alert\",\"name\":\"Test-Validate_an_existing_monitor_returns_OK_response-1696443719\",\"message\":\"some message Notify: @hipchat-channel\",\"tags\":[\"test:testvalidateanexistingmonitorreturnsokresponse1696443719\",\"env:ci\"],\"query\":\"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\"options\":{\"enable_logs_sample\":true,\"escalation_message\":\"the situation has escalated\",\"evaluation_delay\":700,\"groupby_simple_monitor\":true,\"include_tags\":true,\"locked\":false,\"new_host_delay\":600,\"no_data_timeframe\":null,\"notification_preset_name\":\"hide_handles\",\"notify_audit\":false,\"notify_no_data\":false,\"on_missing_data\":\"show_and_notify_no_data\",\"renotify_interval\":60,\"require_full_window\":true,\"thresholds\":{\"critical\":2.0,\"warning\":1.0},\"timeout_h\":24,\"silenced\":{}},\"multi\":true,\"created_at\":1696443719000,\"created\":\"2023-10-04T18:21:59.676309+00:00\",\"modified\":\"2023-10-04T18:21:59.676309+00:00\",\"deleted\":null,\"restricted_roles\":null,\"priority\":3,\"overall_state_modified\":null,\"overall_state\":\"No Data\",\"creator\":{\"name\":null,\"handle\":\"frog@datadoghq.com\",\"email\":\"frog@datadoghq.com\",\"id\":1445416}}\n"
           },
           "cookies": [],
           "headers": [
@@ -51,17 +51,17 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 623,
+          "headersSize": 649,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2023-01-18T18:37:20.519Z",
-        "time": 242
+        "startedDateTime": "2023-10-04T18:21:59.263Z",
+        "time": 466
       },
       {
-        "_id": "b495ccaf91c389cb4434e4eba81e682d",
+        "_id": "5617e437dd2a9746b727974e417a3e02",
         "_order": 0,
         "cache": {},
         "request": {
@@ -85,10 +85,10 @@
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"message\":\"some message Notify: @hipchat-channel\",\"name\":\"Test-Validate_an_existing_monitor_returns_OK_response-1674067040\",\"options\":{\"enable_logs_sample\":true,\"escalation_message\":\"the situation has escalated\",\"evaluation_delay\":700,\"groupby_simple_monitor\":true,\"include_tags\":true,\"locked\":false,\"new_host_delay\":600,\"no_data_timeframe\":null,\"notification_preset_name\":\"hide_handles\",\"notify_audit\":false,\"notify_no_data\":false,\"on_missing_data\":\"show_and_notify_no_data\",\"renotify_interval\":60,\"require_full_window\":true,\"thresholds\":{\"critical\":2,\"warning\":1},\"timeout_h\":24},\"priority\":3,\"query\":\"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\"tags\":[\"test:testvalidateanexistingmonitorreturnsokresponse1674067040\",\"env:ci\"],\"type\":\"log alert\"}"
+            "text": "{\"message\":\"some message Notify: @hipchat-channel\",\"name\":\"Test-Validate_an_existing_monitor_returns_OK_response-1696443719\",\"options\":{\"enable_logs_sample\":true,\"escalation_message\":\"the situation has escalated\",\"evaluation_delay\":700,\"groupby_simple_monitor\":true,\"include_tags\":true,\"locked\":false,\"new_host_delay\":600,\"no_data_timeframe\":null,\"notification_preset_name\":\"hide_handles\",\"notify_audit\":false,\"notify_no_data\":false,\"on_missing_data\":\"show_and_notify_no_data\",\"renotify_interval\":60,\"require_full_window\":true,\"thresholds\":{\"critical\":2,\"warning\":1},\"timeout_h\":24},\"priority\":3,\"query\":\"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\"tags\":[\"test:testvalidateanexistingmonitorreturnsokresponse1696443719\",\"env:ci\"],\"type\":\"log alert\"}"
           },
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/monitor/108260307/validate"
+          "url": "https://api.datadoghq.com/api/v1/monitor/132537531/validate"
         },
         "response": {
           "bodySize": 3,
@@ -104,17 +104,17 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 465,
+          "headersSize": 492,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2023-01-18T18:37:20.767Z",
-        "time": 202
+        "startedDateTime": "2023-10-04T18:21:59.738Z",
+        "time": 368
       },
       {
-        "_id": "446ceaa56aae6e109dbabd3db5f74550",
+        "_id": "63d7eb81b0cfd7dc7311ab550a0fd2f4",
         "_order": 0,
         "cache": {},
         "request": {
@@ -131,14 +131,14 @@
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/monitor/108260307"
+          "url": "https://api.datadoghq.com/api/v1/monitor/132537531"
         },
         "response": {
           "bodySize": 33,
           "content": {
             "mimeType": "application/json",
             "size": 33,
-            "text": "{\"deleted_monitor_id\":108260307}\n"
+            "text": "{\"deleted_monitor_id\":132537531}\n"
           },
           "cookies": [],
           "headers": [
@@ -147,14 +147,14 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 489,
+          "headersSize": 516,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2023-01-18T18:37:20.975Z",
-        "time": 117
+        "startedDateTime": "2023-10-04T18:22:00.114Z",
+        "time": 482
       }
     ],
     "pages": [],

examples/v1/monitors/CreateMonitor_1539578087.ts

@@ -0,0 +1,50 @@
+/**
+ * Create a metric monitor with a custom schedule returns "OK" response
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.MonitorsApi(configuration);
+
+const params: v1.MonitorsApiCreateMonitorRequest = {
+  body: {
+    message: "some message Notify: @hipchat-channel",
+    name: "Example-Monitor",
+    query: "avg(current_1mo):avg:system.load.5{*} > 0.5",
+    tags: [],
+    options: {
+      thresholds: {
+        critical: 0.5,
+      },
+      notifyAudit: false,
+      onMissingData: "default",
+      includeTags: false,
+      schedulingOptions: {
+        evaluationWindow: {
+          dayStarts: "04:00",
+          monthStarts: 1,
+        },
+        customSchedule: {
+          recurrences: [
+            {
+              rrule: "FREQ=DAILY;INTERVAL=1",
+              timezone: "America/Los_Angeles",
+              start: "2024-10-26T09:13:00",
+            },
+          ],
+        },
+      },
+    },
+    type: "query alert",
+  },
+};
+
+apiInstance
+  .createMonitor(params)
+  .then((data: v1.Monitor) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v1/monitors.feature

@@ -91,6 +91,17 @@ Feature: Monitors
     And the response "name" is equal to "{{ unique }}"
     And the response "query" is equal to "avg(current_1mo):avg:system.load.5{*} > 0.5"
 
+  @team:DataDog/monitor-app
+  Scenario: Create a metric monitor with a custom schedule returns "OK" response
+    Given new "CreateMonitor" request
+    And body with value {"message":"some message Notify: @hipchat-channel","name":"{{ unique }}","query":"avg(current_1mo):avg:system.load.5{*} > 0.5","tags":[],"options":{"thresholds":{"critical":0.5},"notify_audit":false,"on_missing_data":"default","include_tags":false,"scheduling_options":{"evaluation_window":{"day_starts":"04:00", "month_starts":1},"custom_schedule":{"recurrences":[{"rrule":"FREQ=DAILY;INTERVAL=1","timezone":"America/Los_Angeles","start":"2024-10-26T09:13:00"}]}}},"type":"query alert"}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "name" is equal to "{{ unique }}"
+    And the response "options.scheduling_options.custom_schedule.recurrences[0].rrule" is equal to "FREQ=DAILY;INTERVAL=1"
+    And the response "options.scheduling_options.custom_schedule.recurrences[0].start" is equal to "2024-10-26T09:13:00"
+    And the response "options.scheduling_options.custom_schedule.recurrences[0].timezone" is equal to "America/Los_Angeles"
+
   @team:DataDog/monitor-app
   Scenario: Create a monitor returns "Bad Request" response
     Given new "CreateMonitor" request
@@ -146,7 +157,7 @@ Feature: Monitors
   Scenario: Edit a monitor returns "Bad Request" response
     Given new "UpdateMonitor" request
     And request contains "monitor_id" parameter from "REPLACE.ME"
-    And body with value {"options": {"escalation_message": "none", "evaluation_delay": null, "include_tags": true, "min_failure_duration": 0, "min_location_failed": 1, "new_group_delay": null, "new_host_delay": 300, "no_data_timeframe": null, "notification_preset_name": "show_all", "notify_audit": false, "notify_by": [], "notify_no_data": false, "on_missing_data": "default", "renotify_interval": null, "renotify_occurrences": null, "renotify_statuses": ["alert"], "scheduling_options": {"evaluation_window": {"day_starts": "04:00", "hour_starts": 0, "month_starts": 1}}, "synthetics_check_id": null, "threshold_windows": {"recovery_window": null, "trigger_window": null}, "thresholds": {"critical_recovery": null, "ok": null, "unknown": null, "warning": null, "warning_recovery": null}, "timeout_h": null, "variables": [{"compute": {"aggregation": "avg", "interval": 60000, "metric": "@duration"}, "data_source": "rum", "group_by": [{"facet": "status", "limit": 10, "sort": {"aggregation": "avg", "order": "desc"}}], "indexes": ["days-3", "days-7"], "name": "query_errors", "search": {"query": "service:query"}}]}, "restricted_roles": [], "tags": [], "type": "query alert"}
+    And body with value {"options": {"escalation_message": "none", "evaluation_delay": null, "include_tags": true, "min_failure_duration": 0, "min_location_failed": 1, "new_group_delay": null, "new_host_delay": 300, "no_data_timeframe": null, "notification_preset_name": "show_all", "notify_audit": false, "notify_by": [], "notify_no_data": false, "on_missing_data": "default", "renotify_interval": null, "renotify_occurrences": null, "renotify_statuses": ["alert"], "scheduling_options": {"custom_schedule": {"recurrences": [{"rrule": "FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR", "start": "2023-08-31T16:30:00", "timezone": "Europe/Paris"}]}, "evaluation_window": {"day_starts": "04:00", "hour_starts": 0, "month_starts": 1}}, "synthetics_check_id": null, "threshold_windows": {"recovery_window": null, "trigger_window": null}, "thresholds": {"critical_recovery": null, "ok": null, "unknown": null, "warning": null, "warning_recovery": null}, "timeout_h": null, "variables": [{"compute": {"aggregation": "avg", "interval": 60000, "metric": "@duration"}, "data_source": "rum", "group_by": [{"facet": "status", "limit": 10, "sort": {"aggregation": "avg", "order": "desc"}}], "indexes": ["days-3", "days-7"], "name": "query_errors", "search": {"query": "service:query"}}]}, "restricted_roles": [], "tags": [], "type": "query alert"}
     When the request is sent
     Then the response status is 400 Bad Request
 

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

@@ -608,6 +608,8 @@ export { MonitorGroupSearchResponseCounts } from "./models/MonitorGroupSearchRes
 export { MonitorGroupSearchResult } from "./models/MonitorGroupSearchResult";
 export { MonitorOptions } from "./models/MonitorOptions";
 export { MonitorOptionsAggregation } from "./models/MonitorOptionsAggregation";
+export { MonitorOptionsCustomSchedule } from "./models/MonitorOptionsCustomSchedule";
+export { MonitorOptionsCustomScheduleRecurrence } from "./models/MonitorOptionsCustomScheduleRecurrence";
 export { MonitorOptionsNotificationPresets } from "./models/MonitorOptionsNotificationPresets";
 export { MonitorOptionsSchedulingOptions } from "./models/MonitorOptionsSchedulingOptions";
 export { MonitorOptionsSchedulingOptionsEvaluationWindow } from "./models/MonitorOptionsSchedulingOptionsEvaluationWindow";

packages/datadog-api-client-v1/models/MonitorOptionsCustomSchedule.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 { MonitorOptionsCustomScheduleRecurrence } from "./MonitorOptionsCustomScheduleRecurrence";
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * Configuration options for the custom schedule. **This feature is in private beta.**
+ */
+export class MonitorOptionsCustomSchedule {
+  /**
+   * Array of custom schedule recurrences.
+   */
+  "recurrences"?: Array<MonitorOptionsCustomScheduleRecurrence>;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    recurrences: {
+      baseName: "recurrences",
+      type: "Array<MonitorOptionsCustomScheduleRecurrence>",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return MonitorOptionsCustomSchedule.attributeTypeMap;
+  }
+
+  public constructor() {}
+}