Regenerate client from commit 27106c20 of spec repo (#847)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
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-26 09:51:31.902097",
-            "spec_repo_commit": "24936e30"
+            "regenerated": "2022-09-26 14:13:13.234730",
+            "spec_repo_commit": "27106c20"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-09-26 09:51:31.917551",
-            "spec_repo_commit": "24936e30"
+            "regenerated": "2022-09-26 14:13:13.251814",
+            "spec_repo_commit": "27106c20"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9270,6 +9270,75 @@ components:
           format: int64
           type: integer
       type: object
+    SLOListWidgetDefinition:
+      description: Use the SLO List widget to track your SLOs (Service Level Objectives)
+        on dashboards.
+      properties:
+        requests:
+          description: Array of one request object to display in the widget.
+          items:
+            $ref: '#/components/schemas/SLOListWidgetRequest'
+          maxItems: 1
+          minItems: 1
+          type: array
+        title:
+          description: Title of the widget.
+          type: string
+        title_align:
+          $ref: '#/components/schemas/WidgetTextAlign'
+        title_size:
+          description: Size of the title.
+          type: string
+        type:
+          $ref: '#/components/schemas/SLOListWidgetDefinitionType'
+      required:
+      - type
+      - requests
+      type: object
+    SLOListWidgetDefinitionType:
+      default: slo_list
+      description: Type of the SLO List widget.
+      enum:
+      - slo_list
+      example: slo_list
+      type: string
+      x-enum-varnames:
+      - SLO_LIST
+    SLOListWidgetQuery:
+      description: Updated SLO List widget.
+      properties:
+        limit:
+          default: 100
+          description: Maximum number of results to display in the table.
+          format: int64
+          maximum: 100
+          minimum: 1
+          type: integer
+        query_string:
+          description: Widget query.
+          example: env:prod AND service:my-app
+          type: string
+      required:
+      - query_string
+      type: object
+    SLOListWidgetRequest:
+      description: Updated SLO List widget.
+      properties:
+        query:
+          $ref: '#/components/schemas/SLOListWidgetQuery'
+        request_type:
+          $ref: '#/components/schemas/SLOListWidgetRequestType'
+      required:
+      - query
+      - request_type
+      type: object
+    SLOListWidgetRequestType:
+      description: Widget request type.
+      enum:
+      - slo_list
+      type: string
+      x-enum-varnames:
+      - SLO_LIST
     SLOOverallStatuses:
       description: Overall status of the SLO by timeframes.
       properties:
@@ -17348,6 +17417,7 @@ components:
       - $ref: '#/components/schemas/QueryValueWidgetDefinition'
       - $ref: '#/components/schemas/ScatterPlotWidgetDefinition'
       - $ref: '#/components/schemas/SLOWidgetDefinition'
+      - $ref: '#/components/schemas/SLOListWidgetDefinition'
       - $ref: '#/components/schemas/ServiceMapWidgetDefinition'
       - $ref: '#/components/schemas/ServiceSummaryWidgetDefinition'
       - $ref: '#/components/schemas/SunburstWidgetDefinition'

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-slo-list-widget_885923584/frozen.json

@@ -0,0 +1 @@
+"2022-09-21T14:58:35.783Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-slo-list-widget_885923584/recording.har

@@ -0,0 +1,206 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with slo list widget",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "2839d3d9d3c57889cd6eee6bb561bac8",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 270,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 547,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"name\":\"Test-Create_a_new_dashboard_with_slo_list_widget-1663772315\",\"query\":{\"denominator\":\"sum:httpservice.hits{!code:3xx}.as_count()\",\"numerator\":\"sum:httpservice.hits{code:2xx}.as_count()\"},\"thresholds\":[{\"target\":95,\"timeframe\":\"7d\",\"warning\":98}],\"type\":\"metric\"}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/slo"
+        },
+        "response": {
+          "bodySize": 575,
+          "content": {
+            "mimeType": "application/json",
+            "size": 575,
+            "text": "{\"data\":[{\"description\":\"\",\"monitor_tags\":[],\"creator\":{\"handle\":\"frog@datadoghq.com\",\"name\":null,\"email\":\"frog@datadoghq.com\"},\"thresholds\":[{\"warning\":98.0,\"warning_display\":\"98.\",\"target\":95.0,\"target_display\":\"95.\",\"timeframe\":\"7d\"}],\"type_id\":1,\"query\":{\"denominator\":\"sum:httpservice.hits{!code:3xx}.as_count()\",\"numerator\":\"sum:httpservice.hits{code:2xx}.as_count()\"},\"id\":\"7f88381afe5f5c1e987664e7057253fd\",\"name\":\"Test-Create_a_new_dashboard_with_slo_list_widget-1663772315\",\"created_at\":1663772316,\"tags\":[],\"modified_at\":1663772316,\"type\":\"metric\"}],\"error\":null}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 619,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-09-21T14:58:35.802Z",
+        "time": 574
+      },
+      {
+        "_id": "634c497ca94124af52948714b215b0ee",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 410,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 558,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"description\":\"\",\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_slo_list_widget-1663772315\",\"widgets\":[{\"definition\":{\"requests\":[{\"query\":{\"limit\":75,\"query_string\":\"env:prod AND service:my-app\"},\"request_type\":\"slo_list\"}],\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"slo_list\"},\"layout\":{\"height\":21,\"width\":60,\"x\":0,\"y\":0}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 710,
+          "content": {
+            "mimeType": "application/json",
+            "size": 710,
+            "text": "{\"notify_list\":[],\"description\":\"\",\"restricted_roles\":[],\"author_name\":null,\"template_variables\":[],\"is_read_only\":false,\"id\":\"xf3-y64-ib5\",\"title\":\"Test-Create_a_new_dashboard_with_slo_list_widget-1663772315\",\"url\":\"/dashboard/xf3-y64-ib5/test-createanewdashboardwithslolistwidget-1663772315\",\"created_at\":\"2022-09-21T14:58:36.648616+00:00\",\"modified_at\":\"2022-09-21T14:58:36.648616+00:00\",\"author_handle\":\"frog@datadoghq.com\",\"widgets\":[{\"definition\":{\"type\":\"slo_list\",\"requests\":[{\"query\":{\"query_string\":\"env:prod AND service:my-app\",\"limit\":75},\"request_type\":\"slo_list\"}],\"title_align\":\"left\",\"title_size\":\"16\"},\"layout\":{\"y\":0,\"width\":60,\"x\":0,\"height\":21},\"id\":434825034616209}],\"layout_type\":\"free\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 593,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-09-21T14:58:36.388Z",
+        "time": 338
+      },
+      {
+        "_id": "f2ac0c6bc92815ab8c0a6d864b5178f8",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 520,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard/xf3-y64-ib5"
+        },
+        "response": {
+          "bodySize": 39,
+          "content": {
+            "mimeType": "application/json",
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"xf3-y64-ib5\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 592,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-09-21T14:58:36.737Z",
+        "time": 374
+      },
+      {
+        "_id": "3ba0b158cb4723a3e05d3ffaa6afb990",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 529,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/slo/7f88381afe5f5c1e987664e7057253fd"
+        },
+        "response": {
+          "bodySize": 59,
+          "content": {
+            "mimeType": "application/json",
+            "size": 59,
+            "text": "{\"data\":[\"7f88381afe5f5c1e987664e7057253fd\"],\"error\":null}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 619,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-09-21T14:58:37.116Z",
+        "time": 397
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

examples/v1/dashboards/CreateDashboard_1423904722.ts

@@ -0,0 +1,52 @@
+/**
+ * Create a new dashboard with slo list widget
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.DashboardsApi(configuration);
+
+const params: v1.DashboardsApiCreateDashboardRequest = {
+  body: {
+    title: "Example-Create_a_new_dashboard_with_slo_list_widget",
+    description: "",
+    widgets: [
+      {
+        layout: {
+          x: 0,
+          y: 0,
+          width: 60,
+          height: 21,
+        },
+        definition: {
+          titleSize: "16",
+          titleAlign: "left",
+          type: "slo_list",
+          requests: [
+            {
+              query: {
+                queryString: "env:prod AND service:my-app",
+                limit: 75,
+              },
+              requestType: "slo_list",
+            },
+          ],
+        },
+      },
+    ],
+    templateVariables: [],
+    layoutType: "free",
+    isReadOnly: false,
+    notifyList: [],
+  },
+};
+
+apiInstance
+  .createDashboard(params)
+  .then((data: v1.Dashboard) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v1/dashboards.feature

@@ -410,6 +410,17 @@ Feature: Dashboards
     And the response "widgets[0].definition.type" is equal to "servicemap"
     And the response "widgets[0].definition.filters" is equal to ["env:none","environment:*"]
 
+  @team:DataDog/dashboards
+  Scenario: Create a new dashboard with slo list widget
+    Given there is a valid "slo" in the system
+    And new "CreateDashboard" request
+    And body from file "dashboards_json_payload/slo_list_widget.json"
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "widgets[0].definition.type" is equal to "slo_list"
+    And the response "widgets[0].definition.requests[0].query.query_string" is equal to "env:prod AND service:my-app"
+    And the response "widgets[0].definition.requests[0].query.limit" is equal to 75
+
   @team:DataDog/dashboards
   Scenario: Create a new dashboard with slo widget
     Given there is a valid "slo" in the system