Skip to content

Commit

Permalink
update description
Browse files Browse the repository at this point in the history
  • Loading branch information
obs-gh-abhinavpappu committed Dec 4, 2024
1 parent bacc2da commit a449b2d
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
15 changes: 10 additions & 5 deletions docs/resources/resource_grants.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,20 @@ page_title: "observe_resource_grants Resource - terraform-provider-observe"
subcategory: ""
description: |-
NOTE: This feature is still under development. It is not meant for customer use yet.
Authoritative. Manages the complete set of grants for a given resource, replacing
any existing ones. If no grants are specified, only admins will have access.
Authoritative. Should not be used together with any observe_grants targeting the
same resource as they will conflict.
Manages the complete set of grants for a given resource, replacing any existing ones.
If no grants are specified, only admins will have access.
---
# observe_resource_grants

NOTE: This feature is still under development. It is not meant for customer use yet.

Authoritative. Manages the complete set of grants for a given resource, replacing
any existing ones. If no grants are specified, only admins will have access.
Authoritative. Should not be used together with any `observe_grant`s targeting the
same resource as they will conflict.

Manages the complete set of grants for a given resource, replacing any existing ones.
If no grants are specified, only admins will have access.
## Example Usage
```terraform
data "observe_workspace" "default" {
Expand All @@ -38,7 +43,7 @@ data "observe_dataset" "example2" {
}
// Allow group engineering to edit and Everyone to view dataset Engineering Logs.
// Ensures there are no other statements targeting this dataset,
// Ensures there are no other grants targeting this dataset,
// so no one else (except admins) can view or edit it.
resource "observe_resource_grants" "example" {
oid = data.observe_dataset.example.oid
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/observe_resource_grants/resource.tf
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ data "observe_dataset" "example2" {
}

// Allow group engineering to edit and Everyone to view dataset Engineering Logs.
// Ensures there are no other statements targeting this dataset,
// Ensures there are no other grants targeting this dataset,
// so no one else (except admins) can view or edit it.
resource "observe_resource_grants" "example" {
oid = data.observe_dataset.example.oid
Expand Down
8 changes: 6 additions & 2 deletions observe/descriptions/resource_grants.yaml
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
description: |
NOTE: This feature is still under development. It is not meant for customer use yet.
Authoritative. Manages the complete set of grants for a given resource, replacing
any existing ones. If no grants are specified, only admins will have access.
Authoritative. Should not be used together with any `observe_grant`s targeting the
same resource as they will conflict.
Manages the complete set of grants for a given resource, replacing any existing ones.
If no grants are specified, only admins will have access.
schema:
oid: |
The OID of the resource to manage grants for.
Expand Down

0 comments on commit a449b2d

Please sign in to comment.