Add sort field to SLOListWidgetQuery (#1026)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit a472edb22d6e · 2023-02-15T15:32:12.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-14 22:24:35.435746",
-            "spec_repo_commit": "7a7cb634"
+            "regenerated": "2023-02-15 14:54:20.667520",
+            "spec_repo_commit": "3371aaa2"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-14 22:24:35.448427",
-            "spec_repo_commit": "7a7cb634"
+            "regenerated": "2023-02-15 14:54:20.679789",
+            "spec_repo_commit": "3371aaa2"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -9668,6 +9668,11 @@ components:
           description: Widget query.
           example: env:prod AND service:my-app
           type: string
+        sort:
+          description: Options for sorting results.
+          items:
+            $ref: '#/components/schemas/WidgetFieldSort'
+          type: array
       required:
       - query_string
       type: object
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-slo-list-widget-with-sort_3997807092/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-slo-list-widget-with-sort_3997807092/frozen.json
@@ -0,0 +1 @@
+"2023-02-14T18:54:56.599Z"
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-slo-list-widget-with-sort_3997807092/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-slo-list-widget-with-sort_3997807092/recording.har
@@ -0,0 +1,206 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with slo list widget with sort",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "a4b727ac685f572ba6bba942086c5af1",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 280,
+          "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_with_sort-1676400896\",\"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": 647,
+          "content": {
+            "mimeType": "application/json",
+            "size": 647,
+            "text": "{\"data\":[{\"id\":\"80091437d0165587a0831040981e44f9\",\"name\":\"Test-Create_a_new_dashboard_with_slo_list_widget_with_sort-1676400896\",\"tags\":[],\"monitor_tags\":[],\"thresholds\":[{\"timeframe\":\"7d\",\"target\":95.0,\"target_display\":\"95.\",\"warning\":98.0,\"warning_display\":\"98.\"}],\"type\":\"metric\",\"type_id\":1,\"description\":\"\",\"timeframe\":\"7d\",\"warning_threshold\":98,\"target_threshold\":95,\"query\":{\"denominator\":\"sum:httpservice.hits{!code:3xx}.as_count()\",\"numerator\":\"sum:httpservice.hits{code:2xx}.as_count()\"},\"creator\":{\"name\":null,\"handle\":\"frog@datadoghq.com\",\"email\":\"frog@datadoghq.com\"},\"created_at\":1676400896,\"modified_at\":1676400896}],\"error\":null}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 618,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-02-14T18:54:56.619Z",
+        "time": 212
+      },
+      {
+        "_id": "5e4765b17db434d7ffd55d5a84dc0226",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 467,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 559,
+          "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_with_sort-1676400896\",\"widgets\":[{\"definition\":{\"requests\":[{\"query\":{\"limit\":75,\"query_string\":\"env:prod AND service:my-app\",\"sort\":[{\"column\":\"status.sli\",\"order\":\"asc\"}]},\"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": 776,
+          "content": {
+            "mimeType": "application/json",
+            "size": 776,
+            "text": "{\"id\":\"6hq-ih3-tzg\",\"title\":\"Test-Create_a_new_dashboard_with_slo_list_widget_with_sort-1676400896\",\"description\":\"\",\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"free\",\"url\":\"/dashboard/6hq-ih3-tzg/test-createanewdashboardwithslolistwidgetwithsort-1676400896\",\"is_read_only\":false,\"template_variables\":[],\"widgets\":[{\"definition\":{\"requests\":[{\"query\":{\"limit\":75,\"query_string\":\"env:prod AND service:my-app\",\"sort\":[{\"column\":\"status.sli\",\"order\":\"asc\"}]},\"request_type\":\"slo_list\"}],\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"slo_list\"},\"layout\":{\"height\":21,\"width\":60,\"x\":0,\"y\":0},\"id\":1642439378480719}],\"notify_list\":[],\"created_at\":\"2023-02-14T18:54:57.012649+00:00\",\"modified_at\":\"2023-02-14T18:54:57.012649+00:00\",\"restricted_roles\":[]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 490,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-02-14T18:54:56.842Z",
+        "time": 219
+      },
+      {
+        "_id": "60e194a3d250c7f428af022b3e6e2b1b",
+        "_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/6hq-ih3-tzg"
+        },
+        "response": {
+          "bodySize": 39,
+          "content": {
+            "mimeType": "application/json",
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"6hq-ih3-tzg\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 489,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-02-14T18:54:57.071Z",
+        "time": 192
+      },
+      {
+        "_id": "518d81951afd78981f3fe895abd3f819",
+        "_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/80091437d0165587a0831040981e44f9"
+        },
+        "response": {
+          "bodySize": 59,
+          "content": {
+            "mimeType": "application/json",
+            "size": 59,
+            "text": "{\"data\":[\"80091437d0165587a0831040981e44f9\"],\"error\":null}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 616,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-02-14T18:54:57.286Z",
+        "time": 180
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/dashboards/CreateDashboard_109450134.ts b/examples/v1/dashboards/CreateDashboard_109450134.ts
@@ -0,0 +1,58 @@
+/**
+ * Create a new dashboard with slo list widget with sort
+ */
+
+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_with_sort",
+    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,
+                sort: [
+                  {
+                    column: "status.sli",
+                    order: "asc",
+                  },
+                ],
+              },
+              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));
diff --git a/features/v1/dashboards.feature b/features/v1/dashboards.feature
@@ -462,6 +462,19 @@ Feature: Dashboards
     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 list widget with sort
+    Given there is a valid "slo" in the system
+    And new "CreateDashboard" request
+    And body from file "dashboards_json_payload/slo_list_widget_with_sort.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
+    And the response "widgets[0].definition.requests[0].query.sort[0].column" is equal to "status.sli"
+    And the response "widgets[0].definition.requests[0].query.sort[0].order" is equal to "asc"
+
   @team:DataDog/dashboards
   Scenario: Create a new dashboard with slo widget
     Given there is a valid "slo" in the system
diff --git a/features/v1/dashboards_json_payload/slo_list_widget_with_sort.json b/features/v1/dashboards_json_payload/slo_list_widget_with_sort.json
@@ -0,0 +1,38 @@
+{
+   "title": "{{ unique }}",
+   "description": "",
+   "widgets": [
+      {
+         "layout": {
+            "x": 0,
+            "y": 0,
+            "width": 60,
+            "height": 21
+         },
+         "definition": {
+            "title_size": "16",
+            "title_align": "left",
+            "type": "slo_list",
+            "requests": [
+               {
+                  "query": {
+                     "query_string": "env:prod AND service:my-app",
+                     "limit": 75,
+                     "sort": [
+                       {
+                         "column": "status.sli",
+                         "order": "asc"
+                       }
+                     ]
+                  },
+                  "request_type": "slo_list"
+               }
+            ]
+         }
+      }
+   ],
+   "template_variables": [],
+   "layout_type": "free",
+   "is_read_only": false,
+   "notify_list": []
+}
diff --git a/packages/datadog-api-client-v1/models/SLOListWidgetQuery.ts b/packages/datadog-api-client-v1/models/SLOListWidgetQuery.ts
@@ -3,6 +3,7 @@
  * This product includes software developed at Datadog (https://www.datadoghq.com/).
  * Copyright 2020-Present Datadog, Inc.
  */
+import { WidgetFieldSort } from "./WidgetFieldSort";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -18,6 +19,10 @@ export class SLOListWidgetQuery {
    * Widget query.
    */
   "queryString": string;
+  /**
+   * Options for sorting results.
+   */
+  "sort"?: Array<WidgetFieldSort>;
 
   /**
    * @ignore
@@ -38,6 +43,10 @@ export class SLOListWidgetQuery {
       type: "string",
       required: true,
     },
+    sort: {
+      baseName: "sort",
+      type: "Array<WidgetFieldSort>",
+    },
   };
 
   /**

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.4",`
`7`		`- "regenerated": "2023-02-14 22:24:35.435746",`
`8`		`- "spec_repo_commit": "7a7cb634"`
	`7`	`+ "regenerated": "2023-02-15 14:54:20.667520",`
	`8`	`+ "spec_repo_commit": "3371aaa2"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-02-14 22:24:35.448427",`
`13`		`- "spec_repo_commit": "7a7cb634"`
	`12`	`+ "regenerated": "2023-02-15 14:54:20.679789",`
	`13`	`+ "spec_repo_commit": "3371aaa2"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`