docs(data_source/*_query): Added examples for queries (#16)

Author: mauriceackel

docs/data-sources/authorization_model_document.md

@@ -26,6 +26,10 @@ data "openfga_authorization_model_document" "dsl" {
   dsl = file("path/to/model.fga")
 }
 
+data "openfga_authorization_model_document" "mod" {
+  mod_file_path = "path/to/fga.mod"
+}
+
 data "openfga_authorization_model_document" "json" {
   json = file("path/to/model.json")
 }

docs/data-sources/check_query.md

@@ -10,7 +10,37 @@ description: |-
 
 A 'check' query can be performed to establish whether a particular user has a specific relationship with a particular object.
 
-
+## Example Usage
+
+```terraform
+data "openfga_check_query" "basic" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  object   = "document:document-1"
+}
+
+data "openfga_check_query" "advanced" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  object   = "document:document-1"
+
+  contextual_tuples = [
+    {
+      user     = "user:user-1"
+      relation = "viewer"
+      object   = "document:document-1"
+    }
+  ]
+
+  context_json = jsonencode({
+    time = timestamp()
+  })
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/list_objects_query.md

@@ -10,7 +10,37 @@ description: |-
 
 A 'list objects' query can be performed to establish which objects a particular user has a specific relationship.
 
-
+## Example Usage
+
+```terraform
+data "openfga_list_objects_query" "basic" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  type     = "document"
+}
+
+data "openfga_list_objects_query" "advanced" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  type     = "document"
+
+  contextual_tuples = [
+    {
+      user     = "user:user-1"
+      relation = "viewer"
+      object   = "document:document-1"
+    }
+  ]
+
+  context_json = jsonencode({
+    time = timestamp()
+  })
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

docs/data-sources/list_users_query.md

@@ -10,7 +10,37 @@ description: |-
 
 A 'list users' query can be performed to establish which users have a specific relationship with a particular object.
 
-
+## Example Usage
+
+```terraform
+data "openfga_list_users_query" "basic" {
+  store_id = "example_store_id"
+
+  type     = "user"
+  relation = "viewer"
+  object   = "document:document-1"
+}
+
+data "openfga_list_users_query" "advanced" {
+  store_id = "example_store_id"
+
+  type     = "user"
+  relation = "viewer"
+  object   = "document:document-1"
+
+  contextual_tuples = [
+    {
+      user     = "user:user-1"
+      relation = "viewer"
+      object   = "document:document-1"
+    }
+  ]
+
+  context_json = jsonencode({
+    time = timestamp()
+  })
+}
+```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema

examples/data-sources/openfga_authorization_model_document/data-source.tf

@@ -2,6 +2,10 @@ data "openfga_authorization_model_document" "dsl" {
   dsl = file("path/to/model.fga")
 }
 
+data "openfga_authorization_model_document" "mod" {
+  mod_file_path = "path/to/fga.mod"
+}
+
 data "openfga_authorization_model_document" "json" {
   json = file("path/to/model.json")
 }

examples/data-sources/openfga_check_query/data-source.tf

@@ -0,0 +1,27 @@
+data "openfga_check_query" "basic" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  object   = "document:document-1"
+}
+
+data "openfga_check_query" "advanced" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  object   = "document:document-1"
+
+  contextual_tuples = [
+    {
+      user     = "user:user-1"
+      relation = "viewer"
+      object   = "document:document-1"
+    }
+  ]
+
+  context_json = jsonencode({
+    time = timestamp()
+  })
+}

examples/data-sources/openfga_list_objects_query/data-source.tf

@@ -0,0 +1,27 @@
+data "openfga_list_objects_query" "basic" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  type     = "document"
+}
+
+data "openfga_list_objects_query" "advanced" {
+  store_id = "example_store_id"
+
+  user     = "user:user-1"
+  relation = "viewer"
+  type     = "document"
+
+  contextual_tuples = [
+    {
+      user     = "user:user-1"
+      relation = "viewer"
+      object   = "document:document-1"
+    }
+  ]
+
+  context_json = jsonencode({
+    time = timestamp()
+  })
+}

examples/data-sources/openfga_list_users_query/data-source.tf

@@ -0,0 +1,27 @@
+data "openfga_list_users_query" "basic" {
+  store_id = "example_store_id"
+
+  type     = "user"
+  relation = "viewer"
+  object   = "document:document-1"
+}
+
+data "openfga_list_users_query" "advanced" {
+  store_id = "example_store_id"
+
+  type     = "user"
+  relation = "viewer"
+  object   = "document:document-1"
+
+  contextual_tuples = [
+    {
+      user     = "user:user-1"
+      relation = "viewer"
+      object   = "document:document-1"
+    }
+  ]
+
+  context_json = jsonencode({
+    time = timestamp()
+  })
+}