Skip to content

Commit 6ccbb0a

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Mark dashboard 'is_read_only' and 'restricted_roles' properties as deprecated (#1827)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 42622f6 commit 6ccbb0a

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:42.549804",
8-
"spec_repo_commit": "bdf7d582"
7+
"regenerated": "2024-01-18 22:52:00.053133",
8+
"spec_repo_commit": "4d921fb1"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-01-12 20:45:42.564088",
13-
"spec_repo_commit": "bdf7d582"
12+
"regenerated": "2024-01-18 22:52:00.067802",
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'

src/datadog_api_client/v1/model/dashboard.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,9 @@ def __init__(
126126
:param id: ID of the dashboard.
127127
:type id: str, optional
128128
129-
:param is_read_only: 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. **Deprecated**.
129+
:param is_read_only: Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
130+
131+
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. **Deprecated**.
130132
:type is_read_only: bool, optional
131133
132134
:param layout_type: Layout type of the dashboard.
@@ -144,6 +146,8 @@ def __init__(
144146
:type reflow_type: DashboardReflowType, optional
145147
146148
:param restricted_roles: A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard.
149+
150+
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. **Deprecated**.
147151
:type restricted_roles: [str], optional
148152
149153
:param tags: List of team names representing ownership of a dashboard.

src/datadog_api_client/v1/model/dashboard_summary_definition.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,8 @@ def __init__(
7777
:type id: str, optional
7878
7979
:param is_read_only: Whether this dashboard is read-only. If True, only the author and admins can make changes to it.
80+
81+
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. **Deprecated**.
8082
:type is_read_only: bool, optional
8183
8284
:param layout_type: Layout type of the dashboard.

0 commit comments

Comments
 (0)