Skip to content

Commit c26d031

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 7b09d7dd of spec repo
1 parent bab3ac4 commit c26d031

12 files changed

+454
-32
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-02-24 14:19:09.982374",
8-
"spec_repo_commit": "b34a35ef"
7+
"regenerated": "2025-02-25 17:19:34.286623",
8+
"spec_repo_commit": "7b09d7dd"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-24 14:19:09.997906",
13-
"spec_repo_commit": "b34a35ef"
12+
"regenerated": "2025-02-25 17:19:34.302231",
13+
"spec_repo_commit": "7b09d7dd"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 128 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1451,11 +1451,13 @@ components:
14511451
enum:
14521452
- open
14531453
- invite
1454+
- embed
14541455
nullable: true
14551456
type: string
14561457
x-enum-varnames:
14571458
- OPEN
14581459
- INVITE
1460+
- EMBED
14591461
DashboardSummary:
14601462
description: Dashboard summary response.
14611463
properties:
@@ -13047,7 +13049,7 @@ components:
1304713049
properties:
1304813050
author:
1304913051
$ref: '#/components/schemas/SharedDashboardAuthor'
13050-
created_at:
13052+
created:
1305113053
description: Date the dashboard was shared.
1305213054
format: date-time
1305313055
readOnly: true
@@ -13058,13 +13060,44 @@ components:
1305813060
type: string
1305913061
dashboard_type:
1306013062
$ref: '#/components/schemas/DashboardType'
13063+
embeddable_domains:
13064+
description: The `SharedDashboard` `embeddable_domains`.
13065+
example:
13066+
- https://domain.atlassian.net/
13067+
- http://myserver.com/
13068+
items:
13069+
description: The allowlisted referrers for an EMBED shared dashboard.
13070+
type: string
13071+
type: array
13072+
expiration:
13073+
description: The time when an OPEN shared dashboard becomes publicly unavailable.
13074+
format: date-time
13075+
nullable: true
13076+
type: string
1306113077
global_time:
1306213078
$ref: '#/components/schemas/DashboardGlobalTime'
1306313079
global_time_selectable_enabled:
1306413080
description: Whether to allow viewers to select a different global time
1306513081
setting for the shared dashboard.
1306613082
nullable: true
1306713083
type: boolean
13084+
invitees:
13085+
description: The `SharedDashboard` `invitees`.
13086+
example:
13087+
- access_expiration: '2030-01-01T12:00:00.00Z'
13088+
email: test@datadoghq.com
13089+
- access_expiration: null
13090+
email: test2@datadoghq.com
13091+
items:
13092+
$ref: '#/components/schemas/SharedDashboardInviteesItems'
13093+
type: array
13094+
last_accessed:
13095+
description: The last time the shared dashboard was accessed. Null if never
13096+
accessed.
13097+
format: date-time
13098+
nullable: true
13099+
readOnly: true
13100+
type: string
1306813101
public_url:
1306913102
description: URL of the shared dashboard.
1307013103
readOnly: true
@@ -13084,6 +13117,7 @@ components:
1308413117
nullable: true
1308513118
type: array
1308613119
share_list:
13120+
deprecated: true
1308713121
description: List of email addresses that can receive an invitation to access
1308813122
to the shared dashboard.
1308913123
example:
@@ -13097,10 +13131,17 @@ components:
1309713131
type: array
1309813132
share_type:
1309913133
$ref: '#/components/schemas/DashboardShareType'
13134+
status:
13135+
$ref: '#/components/schemas/SharedDashboardStatus'
13136+
title:
13137+
description: Title of the shared dashboard.
13138+
type: string
1310013139
token:
1310113140
description: A unique token assigned to the shared dashboard.
1310213141
readOnly: true
1310313142
type: string
13143+
viewing_preferences:
13144+
$ref: '#/components/schemas/ViewingPreferences'
1310413145
required:
1310513146
- dashboard_id
1310613147
- dashboard_type
@@ -13120,6 +13161,27 @@ components:
1312013161
type: string
1312113162
readOnly: true
1312213163
type: object
13164+
SharedDashboardInviteesItems:
13165+
description: The allowlisted invitees for an INVITE-only shared dashboard.
13166+
properties:
13167+
access_expiration:
13168+
description: Time of the invitee expiration. Null means the invite will
13169+
not expire.
13170+
format: date-time
13171+
nullable: true
13172+
type: string
13173+
created_at:
13174+
description: Time that the invitee was created.
13175+
format: date-time
13176+
readOnly: true
13177+
type: string
13178+
email:
13179+
description: Email of the invitee.
13180+
example: test@datadoghq.com
13181+
type: string
13182+
required:
13183+
- email
13184+
type: object
1312313185
SharedDashboardInvites:
1312413186
description: Invitations data and metadata that exists for a shared dashboard
1312513187
returned by the API.
@@ -13236,6 +13298,17 @@ components:
1323613298
format: int64
1323713299
type: integer
1323813300
type: object
13301+
SharedDashboardStatus:
13302+
description: Active means the dashboard is publicly available. Paused means
13303+
the dashboard is not publicly available.
13304+
enum:
13305+
- active
13306+
- paused
13307+
example: active
13308+
type: string
13309+
x-enum-varnames:
13310+
- ACTIVE
13311+
- PAUSED
1323913312
SharedDashboardUpdateRequest:
1324013313
description: Update a shared dashboard's settings.
1324113314
example:
@@ -13246,13 +13319,37 @@ components:
1324613319
- test2@datadoghq.com
1324713320
share_type: invite
1324813321
properties:
13322+
embeddable_domains:
13323+
description: The `SharedDashboard` `embeddable_domains`.
13324+
example:
13325+
- https://domain.atlassian.net/
13326+
- http://myserver.com/
13327+
items:
13328+
description: The allowlisted referrers for an EMBED shared dashboard.
13329+
type: string
13330+
type: array
13331+
expiration:
13332+
description: The time when an OPEN shared dashboard becomes publicly unavailable.
13333+
format: date-time
13334+
nullable: true
13335+
type: string
1324913336
global_time:
1325013337
$ref: '#/components/schemas/SharedDashboardUpdateRequestGlobalTime'
1325113338
global_time_selectable_enabled:
1325213339
description: Whether to allow viewers to select a different global time
1325313340
setting for the shared dashboard.
1325413341
nullable: true
1325513342
type: boolean
13343+
invitees:
13344+
description: The `SharedDashboard` `invitees`.
13345+
example:
13346+
- access_expiration: '2030-01-01T12:00:00.00Z'
13347+
email: test@datadoghq.com
13348+
- access_expiration: null
13349+
email: test2@datadoghq.com
13350+
items:
13351+
$ref: '#/components/schemas/SharedDashboardInviteesItems'
13352+
type: array
1325613353
selectable_template_vars:
1325713354
description: List of objects representing template variables on the shared
1325813355
dashboard which can have selectable values.
@@ -13268,6 +13365,7 @@ components:
1326813365
nullable: true
1326913366
type: array
1327013367
share_list:
13368+
deprecated: true
1327113369
description: List of email addresses that can be given access to the shared
1327213370
dashboard.
1327313371
example:
@@ -13281,8 +13379,13 @@ components:
1328113379
type: array
1328213380
share_type:
1328313381
$ref: '#/components/schemas/DashboardShareType'
13284-
required:
13285-
- global_time
13382+
status:
13383+
$ref: '#/components/schemas/SharedDashboardStatus'
13384+
title:
13385+
description: Title of the shared dashboard.
13386+
type: string
13387+
viewing_preferences:
13388+
$ref: '#/components/schemas/ViewingPreferences'
1328613389
type: object
1328713390
SharedDashboardUpdateRequestGlobalTime:
1328813391
description: Timeframe setting for the shared dashboard.
@@ -22710,6 +22813,28 @@ components:
2271022813
example: 0
2271122814
format: int64
2271222815
type: integer
22816+
ViewingPreferences:
22817+
description: The viewing preferences for a shared dashboard.
22818+
properties:
22819+
high_density:
22820+
description: Whether the widgets on the shared dashboard should be displayed
22821+
with high density.
22822+
type: boolean
22823+
theme:
22824+
$ref: '#/components/schemas/ViewingPreferencesTheme'
22825+
type: object
22826+
ViewingPreferencesTheme:
22827+
description: The theme of the shared dashboard view. "system" follows your system's
22828+
default viewing theme.
22829+
enum:
22830+
- system
22831+
- light
22832+
- dark
22833+
type: string
22834+
x-enum-varnames:
22835+
- SYSTEM
22836+
- LIGHT
22837+
- DARK
2271322838
WebhooksIntegration:
2271422839
description: Datadog-Webhooks integration.
2271522840
properties:

features/v1/dashboards.feature

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -936,21 +936,21 @@ Feature: Dashboards
936936
And the response "widgets[0].definition.time.unit" is equal to "minute"
937937
And the response "widgets[0].definition.time.value" is equal to 8
938938

939-
@generated @skip @team:DataDog/dashboards-backend
939+
@generated @skip @team:DataDog/reporting-and-sharing
940940
Scenario: Create a shared dashboard returns "Bad Request" response
941941
Given new "CreatePublicDashboard" request
942-
And body with value {"dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "global_time": {"live_span": "1h"}, "global_time_selectable_enabled": null, "selectable_template_vars": [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}], "share_list": ["test@datadoghq.com", "test2@email.com"], "share_type": "open"}
942+
And body with value {"dashboard_id": "123-abc-456", "dashboard_type": "custom_timeboard", "embeddable_domains": ["https://domain.atlassian.net/", "http://myserver.com/"], "expiration": null, "global_time": {"live_span": "1h"}, "global_time_selectable_enabled": null, "invitees": [{"access_expiration": "2030-01-01T12:00:00.00Z", "email": "test@datadoghq.com"}, {"access_expiration": null, "email": "test2@datadoghq.com"}], "selectable_template_vars": [{"default_value": "*", "name": "exampleVar", "prefix": "test", "visible_tags": ["selectableValue1", "selectableValue2"]}], "share_list": ["test@datadoghq.com", "test2@email.com"], "share_type": "open", "status": "active", "viewing_preferences": {"theme": "system"}}
943943
When the request is sent
944944
Then the response status is 400 Bad Request
945945

946-
@team:DataDog/dashboards-backend
946+
@team:DataDog/reporting-and-sharing
947947
Scenario: Create a shared dashboard returns "Dashboard Not Found" response
948948
Given new "CreatePublicDashboard" request
949949
And body with value {"dashboard_id": "abc-123-def", "dashboard_type": "custom_timeboard", "share_type": "open", "global_time": {"live_span": "1h"}}
950950
When the request is sent
951951
Then the response status is 404 Dashboard Not Found
952952

953-
@team:DataDog/dashboards-backend
953+
@team:DataDog/reporting-and-sharing
954954
Scenario: Create a shared dashboard returns "OK" response
955955
Given there is a valid "dashboard" in the system
956956
And new "CreatePublicDashboard" request
@@ -1023,7 +1023,7 @@ Feature: Dashboards
10231023
Then the response status is 200 OK
10241024
And the response "author_name" is equal to "Frog Account"
10251025

1026-
@team:DataDog/dashboards-backend
1026+
@team:DataDog/reporting-and-sharing
10271027
Scenario: Get a shared dashboard returns "OK" response
10281028
Given there is a valid "dashboard" in the system
10291029
And there is a valid "shared_dashboard" in the system
@@ -1034,7 +1034,7 @@ Feature: Dashboards
10341034
And the response "dashboard_id" has the same value as "dashboard.id"
10351035
And the response "token" has the same value as "shared_dashboard.token"
10361036

1037-
@generated @skip @team:DataDog/dashboards-backend
1037+
@generated @skip @team:DataDog/reporting-and-sharing
10381038
Scenario: Get a shared dashboard returns "Shared Dashboard Not Found" response
10391039
Given new "GetPublicDashboard" request
10401040
And request contains "token" parameter from "REPLACE.ME"
@@ -1059,14 +1059,14 @@ Feature: Dashboards
10591059
Then the response status is 200 OK
10601060
And the response has 3 items
10611061

1062-
@generated @skip @team:DataDog/dashboards-backend
1062+
@generated @skip @team:DataDog/reporting-and-sharing
10631063
Scenario: Get all invitations for a shared dashboard returns "Not Found" response
10641064
Given new "GetPublicDashboardInvitations" request
10651065
And request contains "token" parameter from "REPLACE.ME"
10661066
When the request is sent
10671067
Then the response status is 404 Not Found
10681068

1069-
@team:DataDog/dashboards-backend
1069+
@team:DataDog/reporting-and-sharing
10701070
Scenario: Get all invitations for a shared dashboard returns "OK" response
10711071
Given there is a valid "dashboard" in the system
10721072
And there is a valid "shared_dashboard" in the system
@@ -1110,53 +1110,53 @@ Feature: Dashboards
11101110
When the request is sent
11111111
Then the response status is 204 No Content
11121112

1113-
@generated @skip @team:DataDog/dashboards-backend
1113+
@generated @skip @team:DataDog/reporting-and-sharing
11141114
Scenario: Revoke a shared dashboard URL returns "OK" response
11151115
Given new "DeletePublicDashboard" request
11161116
And request contains "token" parameter from "REPLACE.ME"
11171117
When the request is sent
11181118
Then the response status is 200 OK
11191119

1120-
@generated @skip @team:DataDog/dashboards-backend
1120+
@generated @skip @team:DataDog/reporting-and-sharing
11211121
Scenario: Revoke a shared dashboard URL returns "Shared Dashboard Not Found" response
11221122
Given new "DeletePublicDashboard" request
11231123
And request contains "token" parameter from "REPLACE.ME"
11241124
When the request is sent
11251125
Then the response status is 404 Shared Dashboard Not Found
11261126

1127-
@generated @skip @team:DataDog/dashboards-backend
1127+
@generated @skip @team:DataDog/reporting-and-sharing
11281128
Scenario: Revoke shared dashboard invitations returns "Not Found" response
11291129
Given new "DeletePublicDashboardInvitation" request
11301130
And request contains "token" parameter from "REPLACE.ME"
11311131
And body with value {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]}
11321132
When the request is sent
11331133
Then the response status is 404 Not Found
11341134

1135-
@generated @skip @team:DataDog/dashboards-backend
1135+
@generated @skip @team:DataDog/reporting-and-sharing
11361136
Scenario: Revoke shared dashboard invitations returns "OK" response
11371137
Given new "DeletePublicDashboardInvitation" request
11381138
And request contains "token" parameter from "REPLACE.ME"
11391139
And body with value {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]}
11401140
When the request is sent
11411141
Then the response status is 204 OK
11421142

1143-
@generated @skip @team:DataDog/dashboards-backend
1143+
@generated @skip @team:DataDog/reporting-and-sharing
11441144
Scenario: Send shared dashboard invitation email returns "Bad Request" response
11451145
Given new "SendPublicDashboardInvitation" request
11461146
And request contains "token" parameter from "REPLACE.ME"
11471147
And body with value {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]}
11481148
When the request is sent
11491149
Then the response status is 400 Bad Request
11501150

1151-
@generated @skip @team:DataDog/dashboards-backend
1151+
@generated @skip @team:DataDog/reporting-and-sharing
11521152
Scenario: Send shared dashboard invitation email returns "Not Found" response
11531153
Given new "SendPublicDashboardInvitation" request
11541154
And request contains "token" parameter from "REPLACE.ME"
11551155
And body with value {"data": [{"attributes": {"email": "test@datadoghq.com"}, "type": "public_dashboard_invitation"}]}
11561156
When the request is sent
11571157
Then the response status is 404 Not Found
11581158

1159-
@team:DataDog/dashboards-backend
1159+
@team:DataDog/reporting-and-sharing
11601160
Scenario: Send shared dashboard invitation email returns "OK" response
11611161
Given there is a valid "dashboard" in the system
11621162
And there is a valid "shared_dashboard" in the system
@@ -1204,23 +1204,23 @@ Feature: Dashboards
12041204
Then the response status is 200 OK
12051205
And the response "tags" is equal to ["team:foo", "team:bar"]
12061206

1207-
@generated @skip @team:DataDog/dashboards-backend
1207+
@generated @skip @team:DataDog/reporting-and-sharing
12081208
Scenario: Update a shared dashboard returns "Bad Request" response
12091209
Given new "UpdatePublicDashboard" request
12101210
And request contains "token" parameter from "REPLACE.ME"
12111211
And body with value {"global_time": {"live_span": "1h"}, "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"}
12121212
When the request is sent
12131213
Then the response status is 400 Bad Request
12141214

1215-
@generated @skip @team:DataDog/dashboards-backend
1215+
@generated @skip @team:DataDog/reporting-and-sharing
12161216
Scenario: Update a shared dashboard returns "Item Not Found" response
12171217
Given new "UpdatePublicDashboard" request
12181218
And request contains "token" parameter from "REPLACE.ME"
12191219
And body with value {"global_time": {"live_span": "1h"}, "share_list": ["test@datadoghq.com", "test2@datadoghq.com"], "share_type": "invite"}
12201220
When the request is sent
12211221
Then the response status is 404 Item Not Found
12221222

1223-
@team:DataDog/dashboards-backend
1223+
@team:DataDog/reporting-and-sharing
12241224
Scenario: Update a shared dashboard returns "OK" response
12251225
Given there is a valid "dashboard" in the system
12261226
And there is a valid "shared_dashboard" in the system

0 commit comments

Comments
 (0)