Skip to content

Commit

Permalink
Update sharing APIs to match server (#2945)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <[email protected]>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec authored Feb 25, 2025
1 parent 24227ad commit 01ae41b
Show file tree
Hide file tree
Showing 10 changed files with 1,178 additions and 61 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2025-02-24 14:19:07.230112",
"spec_repo_commit": "b34a35ef"
"regenerated": "2025-02-25 17:19:35.598368",
"spec_repo_commit": "7b09d7dd"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2025-02-24 14:19:07.246168",
"spec_repo_commit": "b34a35ef"
"regenerated": "2025-02-25 17:19:35.613826",
"spec_repo_commit": "7b09d7dd"
}
}
}
131 changes: 128 additions & 3 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1451,11 +1451,13 @@ components:
enum:
- open
- invite
- embed
nullable: true
type: string
x-enum-varnames:
- OPEN
- INVITE
- EMBED
DashboardSummary:
description: Dashboard summary response.
properties:
Expand Down Expand Up @@ -13047,7 +13049,7 @@ components:
properties:
author:
$ref: '#/components/schemas/SharedDashboardAuthor'
created_at:
created:
description: Date the dashboard was shared.
format: date-time
readOnly: true
Expand All @@ -13058,13 +13060,44 @@ components:
type: string
dashboard_type:
$ref: '#/components/schemas/DashboardType'
embeddable_domains:
description: The `SharedDashboard` `embeddable_domains`.
example:
- https://domain.atlassian.net/
- http://myserver.com/
items:
description: The allowlisted referrers for an EMBED shared dashboard.
type: string
type: array
expiration:
description: The time when an OPEN shared dashboard becomes publicly unavailable.
format: date-time
nullable: true
type: string
global_time:
$ref: '#/components/schemas/DashboardGlobalTime'
global_time_selectable_enabled:
description: Whether to allow viewers to select a different global time
setting for the shared dashboard.
nullable: true
type: boolean
invitees:
description: The `SharedDashboard` `invitees`.
example:
- access_expiration: '2030-01-01T12:00:00.00Z'
email: [email protected]
- access_expiration: null
email: [email protected]
items:
$ref: '#/components/schemas/SharedDashboardInviteesItems'
type: array
last_accessed:
description: The last time the shared dashboard was accessed. Null if never
accessed.
format: date-time
nullable: true
readOnly: true
type: string
public_url:
description: URL of the shared dashboard.
readOnly: true
Expand All @@ -13084,6 +13117,7 @@ components:
nullable: true
type: array
share_list:
deprecated: true
description: List of email addresses that can receive an invitation to access
to the shared dashboard.
example:
Expand All @@ -13097,10 +13131,17 @@ components:
type: array
share_type:
$ref: '#/components/schemas/DashboardShareType'
status:
$ref: '#/components/schemas/SharedDashboardStatus'
title:
description: Title of the shared dashboard.
type: string
token:
description: A unique token assigned to the shared dashboard.
readOnly: true
type: string
viewing_preferences:
$ref: '#/components/schemas/ViewingPreferences'
required:
- dashboard_id
- dashboard_type
Expand All @@ -13120,6 +13161,27 @@ components:
type: string
readOnly: true
type: object
SharedDashboardInviteesItems:
description: The allowlisted invitees for an INVITE-only shared dashboard.
properties:
access_expiration:
description: Time of the invitee expiration. Null means the invite will
not expire.
format: date-time
nullable: true
type: string
created_at:
description: Time that the invitee was created.
format: date-time
readOnly: true
type: string
email:
description: Email of the invitee.
example: [email protected]
type: string
required:
- email
type: object
SharedDashboardInvites:
description: Invitations data and metadata that exists for a shared dashboard
returned by the API.
Expand Down Expand Up @@ -13236,6 +13298,17 @@ components:
format: int64
type: integer
type: object
SharedDashboardStatus:
description: Active means the dashboard is publicly available. Paused means
the dashboard is not publicly available.
enum:
- active
- paused
example: active
type: string
x-enum-varnames:
- ACTIVE
- PAUSED
SharedDashboardUpdateRequest:
description: Update a shared dashboard's settings.
example:
Expand All @@ -13246,13 +13319,37 @@ components:
- [email protected]
share_type: invite
properties:
embeddable_domains:
description: The `SharedDashboard` `embeddable_domains`.
example:
- https://domain.atlassian.net/
- http://myserver.com/
items:
description: The allowlisted referrers for an EMBED shared dashboard.
type: string
type: array
expiration:
description: The time when an OPEN shared dashboard becomes publicly unavailable.
format: date-time
nullable: true
type: string
global_time:
$ref: '#/components/schemas/SharedDashboardUpdateRequestGlobalTime'
global_time_selectable_enabled:
description: Whether to allow viewers to select a different global time
setting for the shared dashboard.
nullable: true
type: boolean
invitees:
description: The `SharedDashboard` `invitees`.
example:
- access_expiration: '2030-01-01T12:00:00.00Z'
email: [email protected]
- access_expiration: null
email: [email protected]
items:
$ref: '#/components/schemas/SharedDashboardInviteesItems'
type: array
selectable_template_vars:
description: List of objects representing template variables on the shared
dashboard which can have selectable values.
Expand All @@ -13268,6 +13365,7 @@ components:
nullable: true
type: array
share_list:
deprecated: true
description: List of email addresses that can be given access to the shared
dashboard.
example:
Expand All @@ -13281,8 +13379,13 @@ components:
type: array
share_type:
$ref: '#/components/schemas/DashboardShareType'
required:
- global_time
status:
$ref: '#/components/schemas/SharedDashboardStatus'
title:
description: Title of the shared dashboard.
type: string
viewing_preferences:
$ref: '#/components/schemas/ViewingPreferences'
type: object
SharedDashboardUpdateRequestGlobalTime:
description: Timeframe setting for the shared dashboard.
Expand Down Expand Up @@ -22710,6 +22813,28 @@ components:
example: 0
format: int64
type: integer
ViewingPreferences:
description: The viewing preferences for a shared dashboard.
properties:
high_density:
description: Whether the widgets on the shared dashboard should be displayed
with high density.
type: boolean
theme:
$ref: '#/components/schemas/ViewingPreferencesTheme'
type: object
ViewingPreferencesTheme:
description: The theme of the shared dashboard view. "system" follows your system's
default viewing theme.
enum:
- system
- light
- dark
type: string
x-enum-varnames:
- SYSTEM
- LIGHT
- DARK
WebhooksIntegration:
description: Datadog-Webhooks integration.
properties:
Expand Down
2 changes: 2 additions & 0 deletions api/datadogV1/model_dashboard_share_type.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,13 @@ type DashboardShareType string
const (
DASHBOARDSHARETYPE_OPEN DashboardShareType = "open"
DASHBOARDSHARETYPE_INVITE DashboardShareType = "invite"
DASHBOARDSHARETYPE_EMBED DashboardShareType = "embed"
)

var allowedDashboardShareTypeEnumValues = []DashboardShareType{
DASHBOARDSHARETYPE_OPEN,
DASHBOARDSHARETYPE_INVITE,
DASHBOARDSHARETYPE_EMBED,
}

// GetAllowedValues reeturns the list of possible values.
Expand Down
Loading

0 comments on commit 01ae41b

Please sign in to comment.