Regenerate client from commit 4c3cdd2 of spec repo (#755)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 8d451ad85b08 · 2022-01-03T22:08:20.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.5.1.dev2",
-            "regenerated": "2022-01-03 15:42:01.243984",
-            "spec_repo_commit": "e29fa5e"
+            "regenerated": "2022-01-03 20:48:54.810514",
+            "spec_repo_commit": "4c3cdd2"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2022-01-03 15:42:01.688130",
-            "spec_repo_commit": "e29fa5e"
+            "regenerated": "2022-01-03 20:48:55.301764",
+            "spec_repo_commit": "4c3cdd2"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -915,6 +915,12 @@ components:
           example: test@datadoghq.com
           readOnly: true
           type: string
+        author_name:
+          description: Name of the dashboard author.
+          example: John Doe
+          nullable: true
+          readOnly: true
+          type: string
         created_at:
           description: Creation date of the dashboard.
           format: date-time
diff --git a/docs/v1/Dashboard.md b/docs/v1/Dashboard.md
diff --git a/examples/v1/dashboards/GetDashboard_4262333854.py b/examples/v1/dashboards/GetDashboard_4262333854.py
@@ -0,0 +1,17 @@
+"""
+Get a dashboard returns 'author_name'
+"""
+
+from os import environ
+from datadog_api_client.v1 import ApiClient, Configuration
+from datadog_api_client.v1.api.dashboards_api import DashboardsApi
+
+# there is a valid "dashboard" in the system
+DASHBOARD_ID = environ["DASHBOARD_ID"]
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = DashboardsApi(api_client)
+    response = api_instance.get_dashboard(dashboard_id=DASHBOARD_ID)
+
+    print(response)
diff --git a/src/datadog_api_client/v1/model/dashboard.py b/src/datadog_api_client/v1/model/dashboard.py
diff --git a/tests/v1/cassettes/test_scenarios/test_get_a_dashboard_returns_author_name.frozen b/tests/v1/cassettes/test_scenarios/test_get_a_dashboard_returns_author_name.frozen
@@ -0,0 +1 @@
+2021-12-30T21:04:23.650Z
diff --git a/tests/v1/cassettes/test_scenarios/test_get_a_dashboard_returns_author_name.yaml b/tests/v1/cassettes/test_scenarios/test_get_a_dashboard_returns_author_name.yaml
@@ -0,0 +1,148 @@
+interactions:
+- request:
+    body: '{"layout_type":"ordered","title":"Test-Get_a_dashboard_returns_author_name_-1640898263
+      with Profile Metrics Query","widgets":[{"definition":{"requests":[{"profile_metrics_query":{"compute":{"aggregation":"sum","facet":"@prof_core_cpu_cores"},"group_by":[{"facet":"service","limit":10,"sort":{"aggregation":"sum","facet":"@prof_core_cpu_cores","order":"desc"}}],"search":{"query":"runtime:jvm"}}}],"type":"timeseries"}}]}'
+    headers:
+      accept:
+      - application/json
+      connection:
+      - close
+      content-length:
+      - '420'
+      content-type:
+      - application/json
+      host:
+      - api.datadoghq.com
+      user-agent:
+      - datadog-api-spec/scripts/bdd-runner
+      x-datadog-parent-id:
+      - '9069669680455754936'
+      x-datadog-trace-id:
+      - '9069669680455754936'
+    method: POST
+    uri: https://api.datadoghq.com/api/v1/dashboard
+  response:
+    body:
+      string: '{"notify_list":null,"description":null,"restricted_roles":[],"author_name":null,"template_variables":null,"is_read_only":false,"id":"xb2-jve-hxz","title":"Test-Get_a_dashboard_returns_author_name_-1640898263
+        with Profile Metrics Query","url":"/dashboard/xb2-jve-hxz/test-getadashboardreturnsauthorname-1640898263-with-profile-metrics-query","created_at":"2021-12-30T21:04:23.947661+00:00","modified_at":"2021-12-30T21:04:23.947661+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"profile_metrics_query":{"search":{"query":"runtime:jvm"},"group_by":[{"facet":"service","sort":{"facet":"@prof_core_cpu_cores","aggregation":"sum","order":"desc"},"limit":10}],"compute":{"facet":"@prof_core_cpu_cores","aggregation":"sum"}}}],"type":"timeseries"},"id":2446599900087366}],"layout_type":"ordered"}'
+    headers:
+      cache-control:
+      - no-cache
+      connection:
+      - close
+      content-length:
+      - '826'
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      content-type:
+      - application/json
+      date:
+      - Thu, 30 Dec 2021 21:04:23 GMT
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      vary:
+      - Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-frame-options:
+      - SAMEORIGIN
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+      connection:
+      - close
+      host:
+      - api.datadoghq.com
+      user-agent:
+      - datadog-api-spec/scripts/bdd-runner
+      x-datadog-parent-id:
+      - '9069669680455754936'
+      x-datadog-trace-id:
+      - '9069669680455754936'
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/dashboard/xb2-jve-hxz
+  response:
+    body:
+      string: '{"notify_list":null,"description":null,"restricted_roles":[],"author_name":"Frog
+        Account","template_variables":null,"is_read_only":false,"id":"xb2-jve-hxz","title":"Test-Get_a_dashboard_returns_author_name_-1640898263
+        with Profile Metrics Query","url":"/dashboard/xb2-jve-hxz/test-getadashboardreturnsauthorname-1640898263-with-profile-metrics-query","created_at":"2021-12-30T21:04:23.947661+00:00","modified_at":"2021-12-30T21:04:23.947661+00:00","author_handle":"frog@datadoghq.com","widgets":[{"definition":{"requests":[{"profile_metrics_query":{"search":{"query":"runtime:jvm"},"group_by":[{"facet":"service","sort":{"facet":"@prof_core_cpu_cores","aggregation":"sum","order":"desc"},"limit":10}],"compute":{"facet":"@prof_core_cpu_cores","aggregation":"sum"}}}],"type":"timeseries"},"id":2446599900087366}],"layout_type":"ordered"}'
+    headers:
+      cache-control:
+      - no-cache
+      connection:
+      - close
+      content-length:
+      - '826'
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      content-type:
+      - application/json
+      date:
+      - Thu, 30 Dec 2021 21:04:24 GMT
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      vary:
+      - Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-frame-options:
+      - SAMEORIGIN
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+      connection:
+      - close
+      host:
+      - api.datadoghq.com
+      user-agent:
+      - datadog-api-spec/scripts/bdd-runner
+      x-datadog-parent-id:
+      - '9069669680455754936'
+      x-datadog-trace-id:
+      - '9069669680455754936'
+    method: DELETE
+    uri: https://api.datadoghq.com/api/v1/dashboard/xb2-jve-hxz
+  response:
+    body:
+      string: '{"deleted_dashboard_id":"xb2-jve-hxz"}'
+    headers:
+      cache-control:
+      - no-cache
+      connection:
+      - close
+      content-length:
+      - '38'
+      content-security-policy:
+      - frame-ancestors 'self'; report-uri https://api.datadoghq.com/csp-report
+      content-type:
+      - application/json
+      date:
+      - Thu, 30 Dec 2021 21:04:24 GMT
+      pragma:
+      - no-cache
+      strict-transport-security:
+      - max-age=15724800;
+      vary:
+      - Accept-Encoding
+      x-content-type-options:
+      - nosniff
+      x-frame-options:
+      - SAMEORIGIN
+    status:
+      code: 200
+      message: OK
+version: 1
diff --git a/tests/v1/features/dashboards.feature b/tests/v1/features/dashboards.feature
@@ -211,6 +211,15 @@ Feature: Dashboards
     When the request is sent
     Then the response status is 200 OK
 
+  @replay-only @team:DataDog/dashboards
+  Scenario: Get a dashboard returns 'author_name'
+    Given there is a valid "dashboard" in the system
+    And new "GetDashboard" request
+    And request contains "dashboard_id" parameter from "dashboard.id"
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "author_name" is equal to "Frog Account"
+
   @team:DataDog/dashboards
   Scenario: Get all dashboards returns "OK" response
     Given new "ListDashboards" request

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.5.1.dev2",`
`7`		`- "regenerated": "2022-01-03 15:42:01.243984",`
`8`		`- "spec_repo_commit": "e29fa5e"`
	`7`	`+ "regenerated": "2022-01-03 20:48:54.810514",`
	`8`	`+ "spec_repo_commit": "4c3cdd2"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.5.1.dev2",`
`12`		`- "regenerated": "2022-01-03 15:42:01.688130",`
`13`		`- "spec_repo_commit": "e29fa5e"`
	`12`	`+ "regenerated": "2022-01-03 20:48:55.301764",`
	`13`	`+ "spec_repo_commit": "4c3cdd2"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`