Documentation fixes for integration resource (#58)

configcat · Aug 12, 2024 · 12c51a7 · 12c51a7
1 parent 6b90dce
commit 12c51a7
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/docs/resources/integration.md b/docs/resources/integration.md
@@ -78,7 +78,7 @@ resource "configcat_integration" "mixpanel_integration" {
   parameters = {
     "serviceAccountUserName" = ""               # Mixpanel Service Account Username.
     "serviceAccountSecret"   = ""               # Mixpanel Service Account Secret.
-    "projectId"              = ""               # Mixpanel Service Account Secret.
+    "projectId"              = ""               # Mixpanel Project ID.
     "server"                 = "StandardServer" # Mixpanel Server. Available values: StandardServer, EUResidencyServer. Default: StandardServer. Read more at https://docs.mixpanel.com/docs/privacy/eu-residency.
   }
 }
@@ -112,7 +112,7 @@ output "slack_integration_id" {
 
 - `configs` (Set of String) List of Config IDs that are connected with this Integration. If the list is empty, all of the Configs are connected.
 - `environments` (Set of String) List of Environment IDs that are connected with this Integration. If the list is empty, all of the Environments are connected.
-- `parameters` (Map of String) Parameters of the integration. The Parameters dictionary differs for each IntegrationType. See available options per integration type at the examples.
+- `parameters` (Map of String) Parameters of the integration. The Parameters dictionary differs for each IntegrationType. See available options per integration type at the [Example usage](#example-usage) section.
 
 ### Read-Only
 

diff --git a/examples/resources/configcat_integration/resource.tf b/examples/resources/configcat_integration/resource.tf
@@ -63,7 +63,7 @@ resource "configcat_integration" "mixpanel_integration" {
   parameters = {
     "serviceAccountUserName" = ""               # Mixpanel Service Account Username.
     "serviceAccountSecret"   = ""               # Mixpanel Service Account Secret.
-    "projectId"              = ""               # Mixpanel Service Account Secret.
+    "projectId"              = ""               # Mixpanel Project ID.
     "server"                 = "StandardServer" # Mixpanel Server. Available values: StandardServer, EUResidencyServer. Default: StandardServer. Read more at https://docs.mixpanel.com/docs/privacy/eu-residency.
   }
 }

diff --git a/internal/configcat/integration_resource.go b/internal/configcat/integration_resource.go
@@ -78,7 +78,7 @@ func (r *integrationResource) Schema(ctx context.Context, req resource.SchemaReq
 			},
 
 			IntegrationParameters: schema.MapAttribute{
-				MarkdownDescription: "Parameters of the integration. The Parameters dictionary differs for each IntegrationType. See available options per integration type at the examples.",
+				MarkdownDescription: "Parameters of the integration. The Parameters dictionary differs for each IntegrationType. See available options per integration type at the [Example usage](#example-usage) section.",
 				Computed:            true,
 				Optional:            true,
 				ElementType:         types.StringType,