Skip to content

Commit 483073a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Mark dashboard 'is_read_only' and 'restricted_roles' properties as deprecated (#1476)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 13b1553 commit 483073a

File tree

4 files changed

+29
-10
lines changed

4 files changed

+29
-10
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": "2024-01-12 20:45:32.918266",
8-
"spec_repo_commit": "bdf7d582"
7+
"regenerated": "2024-01-18 22:52:05.205553",
8+
"spec_repo_commit": "4d921fb1"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-01-12 20:45:32.933202",
13-
"spec_repo_commit": "bdf7d582"
12+
"regenerated": "2024-01-18 22:52:05.224476",
13+
"spec_repo_commit": "4d921fb1"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1142,9 +1142,12 @@ components:
11421142
is_read_only:
11431143
default: false
11441144
deprecated: true
1145-
description: Whether this dashboard is read-only. If True, only the author
1146-
and admins can make changes to it. Prefer using `restricted_roles` to
1147-
manage write authorization.
1145+
description: 'Whether this dashboard is read-only. If True, only the author
1146+
and admins can make changes to it.
1147+
1148+
1149+
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/)
1150+
instead to manage write authorization for individual dashboards.'
11481151
example: false
11491152
type: boolean
11501153
layout_type:
@@ -1165,8 +1168,13 @@ components:
11651168
reflow_type:
11661169
$ref: '#/components/schemas/DashboardReflowType'
11671170
restricted_roles:
1168-
description: A list of role identifiers. Only the author and users associated
1171+
deprecated: true
1172+
description: 'A list of role identifiers. Only the author and users associated
11691173
with at least one of these roles can edit this dashboard.
1174+
1175+
1176+
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/)
1177+
instead to manage write authorization for individual dashboards.'
11701178
items:
11711179
description: A role UUID.
11721180
type: string
@@ -1439,8 +1447,13 @@ components:
14391447
description: Dashboard identifier.
14401448
type: string
14411449
is_read_only:
1442-
description: Whether this dashboard is read-only. If True, only the author
1450+
deprecated: true
1451+
description: 'Whether this dashboard is read-only. If True, only the author
14431452
and admins can make changes to it.
1453+
1454+
1455+
This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/)
1456+
instead to manage write authorization for individual dashboards.'
14441457
type: boolean
14451458
layout_type:
14461459
$ref: '#/components/schemas/DashboardLayoutType'

packages/datadog-api-client-v1/models/Dashboard.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,9 @@ export class Dashboard {
3737
*/
3838
"id"?: string;
3939
/**
40-
* Whether this dashboard is read-only. If True, only the author and admins can make changes to it. Prefer using `restricted_roles` to manage write authorization.
40+
* Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
41+
*
42+
* This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
4143
*/
4244
"isReadOnly"?: boolean;
4345
/**
@@ -60,6 +62,8 @@ export class Dashboard {
6062
"reflowType"?: DashboardReflowType;
6163
/**
6264
* A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
65+
*
66+
* This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
6367
*/
6468
"restrictedRoles"?: Array<string>;
6569
/**

packages/datadog-api-client-v1/models/DashboardSummaryDefinition.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ export class DashboardSummaryDefinition {
2929
"id"?: string;
3030
/**
3131
* Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
32+
*
33+
* This property is deprecated; please use the [Restriction Policies API](https://docs.datadoghq.com/api/latest/restriction-policies/) instead to manage write authorization for individual dashboards.
3234
*/
3335
"isReadOnly"?: boolean;
3436
/**

0 commit comments

Comments
 (0)