Skip to content

Commit 01ae41b

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update sharing APIs to match server (#2945)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 24227ad commit 01ae41b

10 files changed

+1178
-61
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:07.230112",
8-
"spec_repo_commit": "b34a35ef"
7+
"regenerated": "2025-02-25 17:19:35.598368",
8+
"spec_repo_commit": "7b09d7dd"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-24 14:19:07.246168",
13-
"spec_repo_commit": "b34a35ef"
12+
"regenerated": "2025-02-25 17:19:35.613826",
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+
13089+
- access_expiration: null
13090+
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+
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
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+
13348+
- access_expiration: null
13349+
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:

api/datadogV1/model_dashboard_share_type.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@ type DashboardShareType string
1717
const (
1818
DASHBOARDSHARETYPE_OPEN DashboardShareType = "open"
1919
DASHBOARDSHARETYPE_INVITE DashboardShareType = "invite"
20+
DASHBOARDSHARETYPE_EMBED DashboardShareType = "embed"
2021
)
2122

2223
var allowedDashboardShareTypeEnumValues = []DashboardShareType{
2324
DASHBOARDSHARETYPE_OPEN,
2425
DASHBOARDSHARETYPE_INVITE,
26+
DASHBOARDSHARETYPE_EMBED,
2527
}
2628

2729
// GetAllowedValues reeturns the list of possible values.

0 commit comments

Comments
 (0)