Merge pull request #228 from JupiterOne/no-card-update-docs

Update resource_permission docs to remove typos.
JupiterOne · Jan 15, 2025 · ed8148a · ed8148a
2 parents 5d46caf + 5f70880
commit ed8148a
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 25 deletions.
diff --git a/docs/resources/resource_permission.md b/docs/resources/resource_permission.md
@@ -39,33 +39,32 @@ resource "jupiterone_user_group" "engineering" {
   description = "This group can view and manage all dashboards in the Engineering resource group as well as view the Key Insights dashboard."
 }
 
-resource "jupiterone_resource_permission" "engineering_compliance" {
+resource "jupiterone_resource_permission" "engineering_dashboard_engineering_resource_group" {
   subject_type  = "group"
   subject_id    = jupiterone_user_group.engineering.id
   resource_area = "dashboard"
   resource_type = "resource_group"
-  resource_id   = "*"
-  canCreate     = true
-  canRead       = true
-  canUpdate     = true
-  canDelete     = true
+  resource_id   = jupiterone_resource_group.engineering.id
+  can_create    = true
+  can_read      = true
+  can_update    = true
+  can_delete    = true
 }
 
-resource "jupiterone_resource_permission" "engineering_compliance" {
+resource "jupiterone_resource_permission" "engineering_dashboard_key_insights" {
   subject_type  = "group"
   subject_id    = jupiterone_user_group.engineering.id
   resource_area = "dashboard"
   resource_type = "dashboard"
   resource_id   = jupiterone_dashboard.key_insights.id
-  canCreate     = false
-  canRead       = true
-  canUpdate     = false
-  canDelete     = false
+  can_create    = false
+  can_read      = true
+  can_update    = false
+  can_delete    = false
 }
 ```
 
 <!-- schema generated by tfplugindocs -->
-
 ## Schema
 
 ### Required
@@ -75,11 +74,13 @@ resource "jupiterone_resource_permission" "engineering_compliance" {
 - `can_read` (Boolean) Whether the subject can read the resource.
 - `can_update` (Boolean) Whether the subject can update the resource.
 - `resource_area` (String) The resource area that these permissions will be applied to. Possible values: rule, dashboard, integration, collector.
-- `resource_id` (String) The ID of the resource that these permissions will be applied to (e.g. rule ID, resource group ID, \*).
-- `resource_type` (String) The resource type that these permissions will be applied to. Possible values: resource_group, \*, rule, dashboard, integration, collector.
+- `resource_id` (String) The ID of the resource that these permissions will be applied to (e.g. rule ID, resource group ID, *).
+- `resource_type` (String) The resource type that these permissions will be applied to. Possible values: resource_group, *, rule, dashboard, integration, collector.
 - `subject_id` (String) The ID of the subject that the resource permissions will be applied to (e.g. group ID).
 - `subject_type` (String) The type of the subject that the resource permissions will be applied to. Possible values: group, token.
 
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+
+
diff --git a/examples/resources/jupiterone_resource_permission/resource.tf b/examples/resources/jupiterone_resource_permission/resource.tf
@@ -24,26 +24,26 @@ resource "jupiterone_user_group" "engineering" {
   description = "This group can view and manage all dashboards in the Engineering resource group as well as view the Key Insights dashboard."
 }
 
-resource "jupiterone_resource_permission" "engineering_compliance" {
+resource "jupiterone_resource_permission" "engineering_dashboard_engineering_resource_group" {
   subject_type  = "group"
   subject_id    = jupiterone_user_group.engineering.id
   resource_area = "dashboard"
   resource_type = "resource_group"
-  resource_id   = "*"
-  canCreate     = true
-  canRead       = true
-  canUpdate     = true
-  canDelete     = true
+  resource_id   = jupiterone_resource_group.engineering.id
+  can_create    = true
+  can_read      = true
+  can_update    = true
+  can_delete    = true
 }
 
-resource "jupiterone_resource_permission" "engineering_compliance" {
+resource "jupiterone_resource_permission" "engineering_dashboard_key_insights" {
   subject_type  = "group"
   subject_id    = jupiterone_user_group.engineering.id
   resource_area = "dashboard"
   resource_type = "dashboard"
   resource_id   = jupiterone_dashboard.key_insights.id
-  canCreate     = false
-  canRead       = true
-  canUpdate     = false
-  canDelete     = false
+  can_create    = false
+  can_read      = true
+  can_update    = false
+  can_delete    = false
 }