Merge pull request #157 from patientsknowbest/feature/PHR-16180-structure-definiton-override-2

Hide StructureDefinition from tf output PHR-16180

Author: adrns

docs/resources/gcp_service_account.md

@@ -7,51 +7,28 @@ description: |-
 ---
 
 # aidbox_gcp_service_account (Resource)
-The `GcpServiceAccount` resource is a proprietary, custom resource used by Aidbox. It stores the email address of a Google Cloud Platform service account, allowing Aidbox to impersonate that account using workload identity.
 
-This resource is most commonly referenced by other resources, such as `aidbox_sdc_config`, to grant Aidbox access to GCP services like Google Cloud Storage buckets.
+Aidbox GcpServiceAccount is a proprietary custom resource used to store Google Cloud Platform service account credentials for workload identity.
 
 ## Example Usage
 
-### Basic Example
-
 ```terraform
-resource "aidbox_gcp_service_account" "sa_account" {
-  name                      = "aidbox-sa"
+resource "aidbox_gcp_service_account" "default_gcp_account" {
+  name                  = "aidbox-rc"
   service_account_email = "sa-email@my-project.iam.gserviceaccount.com"
-  private_key       = "-----BEGIN PRIVATE KEY-----....-----END PRIVATE KEY-----""
+  private_key           = "private-key"
 }
 ```
 
-### Usage with SDCConfig
-
-```terraform
-resource "aidbox_gcp_service_account" "sa_account" {
-  name                      = "aidbox-sa"
-  service_account_email = "sa-email@my-project.iam.gserviceaccount.com"
-  private_key   = "-----BEGIN PRIVATE KEY-----...-----END PRIVATE KEY-----""
-}
-
-resource "aidbox_sdc_config" "default_storage_config" {
-  name    = "forms-storage"
-  default = true
-
-  storage {
-    bucket = "attachment-store-test"
-    account {
-      id = aidbox_gcp_service_account.sa_account.id,
-      resourceType = "GcpServiceAccount"
-    }
-  }
-}
-```
-## Schema 
+<!-- schema generated by tfplugindocs -->
+## Schema
 
 ### Required
-- `name` (String) Computer friendly name of the resource
+
+- `name` (String) Computer friendly name of the GCP Service Account. This must be unique as it is used as the resource's identifier.
+- `private_key` (String, Sensitive) The private key of the GCP service account.
 - `service_account_email` (String) The email address of the GCP service account.
-- `private_key` (String) Private key of the GCP service account.
 
 ### Read-Only
-- `id` (String) The ID of this resource.
 
+- `id` (String) The ID of this resource.

docs/resources/sdc_config.md

@@ -20,10 +20,10 @@ resource "aidbox_sdc_config" "default_storage_config" {
   storage {
     bucket = "attachment-store-rc"
     account {
-      id = "aidbox-rc"
+      id           = "aidbox-rc"
       resourceType = "GcpServiceAccount"
     }
-  } 
+  }
 }
 ```
 

docs/resources/structure_definition.md

@@ -3,12 +3,12 @@
 page_title: "aidbox_structure_definition Resource - terraform-provider-aidbox"
 subcategory: ""
 description: |-
-  FHIR R4 SearchParameter https://hl7.org/fhir/R4/searchparameter.html
+  FHIR R4 StructureDefinition https://hl7.org/fhir/R4/structuredefinition.html Provides limited support to specify custom StructureDefinitions, that express customized rules extending the core FHIR spec, and get evaluated only if the caller specifies the SD's url in the request's meta.profile
 ---
 
 # aidbox_structure_definition (Resource)
 
-FHIR R4 SearchParameter https://hl7.org/fhir/R4/searchparameter.html
+FHIR R4 StructureDefinition https://hl7.org/fhir/R4/structuredefinition.html Provides limited support to specify custom StructureDefinitions, that express customized rules extending the core FHIR spec, and get evaluated only if the caller specifies the SD's url in the request's meta.profile
 
 ## Example Usage
 

docs/resources/structure_definition_override.md

@@ -0,0 +1,26 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "aidbox_structure_definition_override Resource - terraform-provider-aidbox"
+subcategory: ""
+description: |-
+  A specialization of StructureDefinition which allows you to override the default version of StructureDefinitions that are specified inside the core FHIR IG used on the server. This means default rules of resources can be changed without having the client specify a meta.profile in their request.
+---
+
+# aidbox_structure_definition_override (Resource)
+
+A specialization of StructureDefinition which allows you to override the default version of StructureDefinitions that are specified inside the core FHIR IG used on the server. This means default rules of resources can be changed without having the client specify a meta.profile in their request.
+
+
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `structure_definition_override` (String, Sensitive) A customized StructureDefinition, based on the original one from the core FHIR spec
+- `url` (String) Canonical URL that's unique to this StructureDefinition
+
+### Read-Only
+
+- `id` (String) The ID of this resource.
+- `original_structure_definition` (String, Sensitive) Backup of the original StructureDefinition, which will be restored upon deleting the override

examples/resources/aidbox_sdc_config/resource.tf

@@ -5,7 +5,7 @@ resource "aidbox_sdc_config" "default_storage_config" {
   storage {
     bucket = "attachment-store-rc"
     account {
-      id = "aidbox-rc"
+      id           = "aidbox-rc"
       resourceType = "GcpServiceAccount"
     }
   }

internal/provider/resource_structure_definition_override.go

@@ -40,6 +40,7 @@ func resourceSchemaStructureDefinitionOverride() map[string]*schema.Schema {
 			Description:           "A customized StructureDefinition, based on the original one from the core FHIR spec",
 			Type:                  schema.TypeString,
 			Required:              true,
+			Sensitive:             true,
 			DiffSuppressOnRefresh: true,
 			DiffSuppressFunc:      jsonDiffSuppressFunc,
 		},