Skip to content

Update property descriptions for Dashboard RBAC release #1171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 27, 2021
Merged

Update property descriptions for Dashboard RBAC release #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d94c0e
Regenerate client from commit 0b58986 of spec repo
Oct 27, 2021
6a0e323
Merge branch 'master' into datadog-api-spec/generated/1221
api-clients-generation-pipeline[bot] Oct 27, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.5.1.dev2",
"regenerated": "2021-10-27 09:02:23.595735",
"spec_repo_commit": "5f2ff0f"
"regenerated": "2021-10-27 12:49:52.775829",
"spec_repo_commit": "0b58986"
},
"v2": {
"apigentools_version": "1.5.1.dev2",
"regenerated": "2021-10-27 09:02:23.615194",
"spec_repo_commit": "5f2ff0f"
"regenerated": "2021-10-27 12:49:52.790161",
"spec_repo_commit": "0b58986"
}
}
}
8 changes: 4 additions & 4 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,8 +907,10 @@ components:
type: string
is_read_only:
default: false
deprecated: true
description: Whether this dashboard is read-only. If True, only the author
and admins can make changes to it.
and admins can make changes to it. Prefer using `restricted_roles` to
manage write authorization.
example: false
type: boolean
layout_type:
Expand All @@ -930,9 +932,7 @@ components:
$ref: '#/components/schemas/DashboardReflowType'
restricted_roles:
description: A list of role identifiers. Only the author and users associated
with at least one of these roles can edit this dashboard. Overrides the
`is_read_only` property if both are present. **This feature is currently
in beta.**
with at least one of these roles can edit this dashboard.
items:
description: A role UUID.
type: string
Expand Down
8 changes: 4 additions & 4 deletions api/v1/datadog/api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11814,8 +11814,10 @@ components:
type: string
is_read_only:
default: false
deprecated: true
description: Whether this dashboard is read-only. If True, only the author
and admins can make changes to it.
and admins can make changes to it. Prefer using `restricted_roles` to
manage write authorization.
example: false
type: boolean
layout_type:
Expand All @@ -11837,9 +11839,7 @@ components:
$ref: '#/components/schemas/DashboardReflowType'
restricted_roles:
description: A list of role identifiers. Only the author and users associated
with at least one of these roles can edit this dashboard. Overrides the
`is_read_only` property if both are present. **This feature is currently
in beta.**
with at least one of these roles can edit this dashboard.
items:
description: A role UUID.
type: string
Expand Down
4 changes: 2 additions & 2 deletions api/v1/datadog/docs/Dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ Name | Type | Description | Notes
**CreatedAt** | Pointer to **time.Time** | Creation date of the dashboard. | [optional] [readonly]
**Description** | Pointer to **NullableString** | Description of the dashboard. | [optional]
**Id** | Pointer to **string** | ID of the dashboard. | [optional] [readonly]
**IsReadOnly** | Pointer to **bool** | Whether this dashboard is read-only. If True, only the author and admins can make changes to it. | [optional] [default to false]
**IsReadOnly** | Pointer to **bool** | 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. | [optional] [default to false]
**LayoutType** | [**DashboardLayoutType**](DashboardLayoutType.md) | |
**ModifiedAt** | Pointer to **time.Time** | Modification date of the dashboard. | [optional] [readonly]
**NotifyList** | Pointer to **[]string** | List of handles of users to notify when changes are made to this dashboard. | [optional]
**ReflowType** | Pointer to [**DashboardReflowType**](DashboardReflowType.md) | | [optional]
**RestrictedRoles** | Pointer to **[]string** | A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. Overrides the `is_read_only` property if both are present. **This feature is currently in beta.** | [optional]
**RestrictedRoles** | Pointer to **[]string** | A list of role identifiers. Only the author and users associated with at least one of these roles can edit this dashboard. | [optional]
**TemplateVariablePresets** | Pointer to [**[]DashboardTemplateVariablePreset**](DashboardTemplateVariablePreset.md) | Array of template variables saved views. | [optional]
**TemplateVariables** | Pointer to [**[]DashboardTemplateVariable**](DashboardTemplateVariable.md) | List of template variables for this dashboard. | [optional]
**Title** | **string** | Title of the dashboard. |
Expand Down
8 changes: 6 additions & 2 deletions api/v1/datadog/model_dashboard.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.