Add region to examples, and run makedocs

JupiterOne · Aug 9, 2023 · b6cdba8 · b6cdba8
1 parent bd588da
commit b6cdba8
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -57,6 +57,7 @@ $EDITOR jupiterone/internal/client/<query source file>.graphql
 # save the updated schema the first time
 export JUPITERONE_ACCOUNT=:your_account_id
 export JUPITERONE_API_KEY=:your_api_key
+export JUPITERONE_REGION=us
 yarn add graphql
 
 make generate-client
@@ -66,7 +67,7 @@ make generate-client
 
 In order to test the provider, you can simply run `make testacc`. Pre-recorded
 API responses (cassettes) are read in from
-[jupiterone/cassettes/*.yaml](jupiterone/cassettes) files and returned.  When
+[jupiterone/cassettes/\*.yaml](jupiterone/cassettes) files and returned. When
 tests are modified, the cassettes need to be re-recorded.
 
 _Note:_ Recording cassettes creates/updates/destroys real resources. Never run this on
@@ -80,6 +81,7 @@ To re-record _all_ cassettes:
 ```sh
 export JUPITERONE_ACCOUNT_ID=your-account-id
 export JUPITERONE_API_KEY=xxxxxx
+export JUPITERONE_REGION=us
 make cassettes
 ```
 
@@ -91,6 +93,7 @@ functionality.
 ```sh
 export JUPITERONE_ACCOUNT_ID=your-account-id
 export JUPITERONE_API_KEY=xxxxxx
+export JUPITERONE_REGION=us
 rm jupiterone/cassettes/:some-test.yaml
 make testacc
 ```

diff --git a/docs/index.md b/docs/index.md
@@ -13,8 +13,9 @@ The JupiterOne provider provides resources to interact with a JupiterOne API.
 
 ```terraform
 provider "jupiterone" {
-  api_key = "${var.jupiterone_api_key}"
-  account_id = "${var.jupiterone_account}"
+  api_key    = var.jupiterone_api_key
+  account_id = var.jupiterone_account
+  region     = var.jupiterone_region
 }
 ```
 

diff --git a/docs/resources/framework.md b/docs/resources/framework.md
@@ -64,3 +64,5 @@ resource "jupiterone_frameworkitem" "change_control" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+
+
diff --git a/docs/resources/frameworkitem.md b/docs/resources/frameworkitem.md
@@ -31,3 +31,5 @@ A FrameworkItem (Requirement in the web UI) is a control that is part of a frame
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+
+
diff --git a/docs/resources/group.md b/docs/resources/group.md
@@ -32,3 +32,5 @@ Refer to the resource_framework docs for example usage
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+
+
diff --git a/docs/resources/libraryitem.md b/docs/resources/libraryitem.md
@@ -43,3 +43,5 @@ resource "jupiterone_libraryitem" "change_control" {
 ### Read-Only
 
 - `id` (String) The ID of this resource.
+
+
diff --git a/docs/resources/question.md b/docs/resources/question.md
@@ -72,3 +72,5 @@ Optional:
 - `include_deleted` (Boolean)
 - `name` (String)
 - `results_are` (String) Defaults to INFORMATIVE.
+
+
diff --git a/docs/resources/rule.md b/docs/resources/rule.md
@@ -155,3 +155,5 @@ Optional:
 
 - `include_deleted` (Boolean)
 - `name` (String)
+
+
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -1,4 +1,5 @@
 provider "jupiterone" {
-  api_key = "${var.jupiterone_api_key}"
-  account_id = "${var.jupiterone_account}"
-}
+  api_key    = var.jupiterone_api_key
+  account_id = var.jupiterone_account
+  region     = var.jupiterone_region
+}