Add guide for annotations in cedar terraform provider (#7)

* Add guide for annotations in cedar terraform provider * go generate * change back auto formatted Note * Correctly change the doc source * nit
common-fate · Aug 27, 2024 · 966d96c · 966d96c
1 parent da5be76
commit 966d96c
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,6 +7,11 @@ data "cedar_policyset" "example" {
   policy {
     effect = "permit"
 
+    annotation {
+      name = "advice"
+      value = "Allow admins to read public resources unless owned by Alice"
+    }
+
     principal_in = {
       type = "Group"
       id   = "admins"
@@ -30,6 +35,7 @@ data "cedar_policyset" "example" {
 The `data.cedar_policyset.example.text` output will be:
 
 ```
+@advice("Allow admins to read public resources unless owned by Alice")
 permit (
     principal in Group::"admins",
     action == Action::"Read",

diff --git a/docs/index.md b/docs/index.md
@@ -11,6 +11,11 @@ data "cedar_policyset" "example" {
   policy {
     effect = "permit"
 
+    annotation {
+      name = "advice"
+      value = "Allow admins to read public resources unless owned by Alice"
+    }
+
     principal_in = {
       type = "Group"
       id   = "admins"
@@ -34,6 +39,7 @@ data "cedar_policyset" "example" {
 The `data.cedar_policyset.example.text` output will be:
 
 ```
+@advice("Allow admins to read public resources unless owned by Alice")
 permit (
     principal in Group::"admins",
     action == Action::"Read",

diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl
@@ -11,6 +11,11 @@ data "cedar_policyset" "example" {
   policy {
     effect = "permit"
 
+    annotation {
+      name = "advice"
+      value = "Allow admins to read public resources unless owned by Alice"
+    }
+
     principal_in = {
       type = "Group"
       id   = "admins"
@@ -34,6 +39,7 @@ data "cedar_policyset" "example" {
 The `data.cedar_policyset.example.text` output will be:
 
 ```
+@advice("Allow admins to read public resources unless owned by Alice")
 permit (
     principal in Group::"admins",
     action == Action::"Read",