diff --git a/API.md b/API.md index ac707cd..e9b9a06 100644 --- a/API.md +++ b/API.md @@ -978,7 +978,7 @@ const dashboard: Dashboard = { ... } | createdAt | Date | Creation date of the dashboard. | | description | string | Description of the dashboard. | | id | string | ID of the dashboard. | -| isReadOnly | boolean | Whether this dashboard is read-only. | +| isReadOnly | boolean | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. | | modifiedAt | Date | Modification date of the dashboard. | | notifyList | string[] | List of handles of users to notify when changes are made to this dashboard. | | reflowType | UnparsedObject \| string | Reflow type for a **new dashboard layout** dashboard. | @@ -1094,9 +1094,9 @@ public readonly isReadOnly: boolean; - *Type:* boolean -Whether this dashboard is read-only. +Whether this dashboard is read-only. If True, only the author and admins can make changes to it. -If True, only the author and admins can make changes to it. Prefer using `restricted_roles` to manage write authorization. +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. --- @@ -1152,6 +1152,8 @@ A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. +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. + --- ##### `tags`Optional diff --git a/src/Dashboard.generated.ts b/src/Dashboard.generated.ts index 62937c8..d9da094 100644 --- a/src/Dashboard.generated.ts +++ b/src/Dashboard.generated.ts @@ -9,7 +9,11 @@ export interface Dashboard { readonly "description"?: string; /** ID of the dashboard. */ readonly "id"?: string; - /** 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. */ + /** + * Whether this dashboard is read-only. If True, only the author and admins can make changes to it. + * + * 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. + */ readonly "isReadOnly"?: boolean; /** Layout type of the dashboard. */ readonly "layoutType": "ordered" | "free" | UnparsedObject; @@ -23,7 +27,11 @@ export interface Dashboard { * widgets should not have layouts. */ readonly "reflowType"?: "auto" | "fixed" | UnparsedObject; - /** A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. */ + /** + * A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. + * + * 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. + */ readonly "restrictedRoles"?: string[]; /** List of team names representing ownership of a dashboard. */ readonly "tags"?: string[];