fix: resolve comments

Author: Md Anam Raihan

ibm_catalog.json

@@ -232,8 +232,8 @@
 						{
 							"key": "existing_secrets_endpoint_type",
 							"type": "string",
-							"default_value": "__NULL__",
-							"description": "The endpoint type to use if existing_secrets_manager_crn is specified.",
+							"default_value": "private",
+							"description": "The endpoint type to use if `existing_secrets_manager_crn` is specified.",
 							"required": false
 						},
 						{
@@ -264,21 +264,21 @@
 							"key": "secret_manager_public_engine_enabled",
 							"type": "boolean",
 							"default_value": false,
-							"description": "Set this to true to configure a Secrets Manager public certificate engine for an existing Secrets Manager instance. If set to false, no public certificate engine will be configured for your instance.",
+							"description": "Whether to configure a Secrets Manager public certificate engine for an existing Secrets Manager instance. If `false`, no public certificate engine is configured for your instance.",
 							"required": false
 						},
 						{
 							"key": "cis_id",
 							"type": "string",
 							"default_value": "__NULL__",
-							"description": "Cloud Internet Service ID.",
+							"description": "Cloud Internet Service ID. Required if secret_manager_public_engine_enabled is set to true",
 							"required": false
 						},
 						{
 							"key": "ca_name",
 							"type": "string",
 							"default_value": "cert-auth",
-							"description": "The name of the certificate authority for Secrets Manager.",
+							"description": "The name of the certificate authority for Secrets Manager. Required if secret_manager_public_engine_enabled is set to true",
 							"required": false
 						},
 						{
@@ -292,8 +292,9 @@
 							"key": "acme_letsencrypt_private_key",
 							"type": "string",
 							"default_value": "__NULL__",
-							"description": "The private key generated by the ACME account creation tool.",
-							"required": false
+							"description": "The private key generated by the ACME account creation tool. For more information, see [documentation](https://cloud.ibm.com/docs/secrets-manager?topic=secrets-manager-prepare-order-certificates)",
+							"required": false,
+							"sensitive": true
 						},
 						{
 							"key": "scc_service_plan",

stack_definition.json

@@ -93,7 +93,7 @@
 		"required": false,
 		"type": "string",
 		"hidden": false,
-		"default": "__NULL__",
+		"default": "private",
     "custom_config": {}
   },
   {

tests/pr_test.go

@@ -28,6 +28,8 @@ const yamlLocation = "../common-dev-assets/common-go-assets/common-permanent-res
 
 var permanentResources map[string]interface{}
 
+var acme_letsencrypt_private_key *string
+
 // Current supported regions
 var validRegions = []string{
 	"us-south",
@@ -39,6 +41,13 @@ func TestMain(m *testing.M) {
 	// Read the YAML file contents
 	var err error
 	permanentResources, err = common.LoadMapFromYaml(yamlLocation)
+
+	acme_letsencrypt_private_key = GetSecretsManagerKey( // pragma: allowlist secret
+		permanentResources["acme_letsencrypt_private_key_sm_id"].(string),
+		permanentResources["acme_letsencrypt_private_key_sm_region"].(string),
+		permanentResources["acme_letsencrypt_private_key_secret_id"].(string),
+	)
+
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -49,12 +58,6 @@ func TestMain(m *testing.M) {
 func TestProjectsFullTest(t *testing.T) {
 	t.Parallel()
 
-	acme_letsencrypt_private_key := GetSecretsManagerKey( // pragma: allowlist secret
-		permanentResources["acme_letsencrypt_private_key_sm_id"].(string),
-		permanentResources["acme_letsencrypt_private_key_sm_region"].(string),
-		permanentResources["acme_letsencrypt_private_key_secret_id"].(string),
-	)
-
 	options := testprojects.TestProjectOptionsDefault(&testprojects.TestProjectsOptions{
 		Testing:        t,
 		Prefix:         "cs", // setting prefix here gets a random string appended to it
@@ -111,12 +114,6 @@ func GetSecretsManagerKey(sm_id string, sm_region string, sm_key_id string) *str
 func TestProjectsExistingResourcesTest(t *testing.T) {
 	t.Parallel()
 
-	acme_letsencrypt_private_key := GetSecretsManagerKey( // pragma: allowlist secret
-		permanentResources["acme_letsencrypt_private_key_sm_id"].(string),
-		permanentResources["acme_letsencrypt_private_key_sm_region"].(string),
-		permanentResources["acme_letsencrypt_private_key_secret_id"].(string),
-	)
-
 	// ------------------------------------------------------------------------------------
 	// Provision RG, EN and SM
 	// ------------------------------------------------------------------------------------