chore: example of custom content: escape dollar symbols, point at stream discovery module

.gitignore

@@ -2,4 +2,6 @@
 .terraform*
 *.tfstate*
 .DS_Store
-*.tfvars
+*.tfvars
+*.iml
+airbyte_overlayed.yaml

Makefile

@@ -1,8 +1,11 @@
-.PHONY: all docs
+.PHONY: all docs speakeasy
 all: speakeasy docs
 
-speakeasy:
-	speakeasy generate sdk --lang terraform -o . -s airbyte.yaml
+speakeasy: airbyte_overlayed.yaml
+	speakeasy generate sdk --lang terraform -o . -s airbyte_overlayed.yaml
+
+airbyte_overlayed.yaml: overlay.yaml airbyte.yaml
+	speakeasy overlay apply -o ./overlay.yaml -s airbyte.yaml > airbyte_overlayed.yaml
 
 docs:
 	go generate ./...

docs/resources/connection.md

@@ -1,5 +1,4 @@
 ---
-# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "airbyte_connection Resource - terraform-provider-airbyte"
 subcategory: ""
 description: |-
@@ -47,6 +46,36 @@ resource "airbyte_connection" "my_connection" {
 }
 ```
 
+Example using [Stream Module](#nestedatt--stream-module)
+
+```terraform
+module "source_postgres_streams" {
+  source = "airbytehq/stream-discovery/airbyte"
+  airbyte_api_token = var.airbyte_api_token
+  source_id = airbyte_source_postgres.my_source_postgres.source_id
+  destination_id = airbyte_destination_bigquery.my_destination_bigquery.destination_id
+}
+locals {
+  full_refresh_streams = [for stream in module.source_postgres_streams.streams : 
+    { 
+      name = stream.streamName
+      sync_mode = "full_refresh_overwrite"
+    }
+  ]
+}
+resource "airbyte_connection" "postgres_to_bigquery_full_refresh" {
+  name           = "Postgres to BigQuery Full Refresh"
+  source_id = airbyte_source_postgres.my_source_postgres.source_id
+  destination_id = airbyte_destination_bigquery.my_destination_bigquery.destination_id
+  schedule = {
+    schedule_type = "manual"
+  }
+  configurations = {
+    streams = local.full_refresh_streams
+  }
+}
+```
+
 <!-- schema generated by tfplugindocs -->
 ## Schema
 
@@ -111,5 +140,3 @@ Optional:
 Read-Only:
 
 - `basic_timing` (String)
-
-

docs/resources/destination_s3.md

@@ -31,7 +31,7 @@ resource "airbyte_destination_s3" "my_destination_s3" {
     s3_bucket_path    = "data_sync/test"
     s3_bucket_region  = "ap-southeast-1"
     s3_endpoint       = "http://localhost:9000"
-    s3_path_format    = "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
+    s3_path_format    = "$${NAMESPACE}/$${STREAM_NAME}/$${YEAR}_$${MONTH}_$${DAY}_$${EPOCH}_"
     secret_access_key = "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
   }
   definition_id = "b1d5b002-89a0-4dc0-a329-a5cae9f38884"

examples/resources/airbyte_destination_s3/resource.tf

@@ -16,7 +16,7 @@ resource "airbyte_destination_s3" "my_destination_s3" {
     s3_bucket_path    = "data_sync/test"
     s3_bucket_region  = "ap-southeast-1"
     s3_endpoint       = "http://localhost:9000"
-    s3_path_format    = "${NAMESPACE}/${STREAM_NAME}/${YEAR}_${MONTH}_${DAY}_${EPOCH}_"
+    s3_path_format    = "$${NAMESPACE}/$${STREAM_NAME}/$${YEAR}_$${MONTH}_$${DAY}_$${EPOCH}_"
     secret_access_key = "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
   }
   definition_id = "b1d5b002-89a0-4dc0-a329-a5cae9f38884"

overlay.yaml

@@ -0,0 +1,8 @@
+overlay: 1.0.0
+info:
+  title: AirByte Overlay
+  version: 0.1
+actions:
+  - target: $.components.schemas["destination-s3"].properties.s3_path_format.examples[0]
+    update:
+      "$${NAMESPACE}/$${STREAM_NAME}/$${YEAR}_$${MONTH}_$${DAY}_$${EPOCH}_"

templates/resources/connection.md.tmpl

@@ -0,0 +1,48 @@
+---
+page_title: "{{.Name}} {{.Type}} - {{.ProviderName}}"
+subcategory: ""
+description: |-
+{{ .Description | plainmarkdown | trimspace | prefixlines "  " }}
+---
+
+# {{.Name}} ({{.Type}})
+
+{{ .Description | trimspace }}
+
+{{ if .HasExample -}}
+## Example Usage
+
+{{ tffile "examples/resources/airbyte_connection/resource.tf" }}
+{{- end }}
+
+Example using [Stream Module](#nestedatt--stream-module)
+
+```terraform
+module "source_postgres_streams" {
+  source = "airbytehq/stream-discovery/airbyte"
+  airbyte_api_token = var.airbyte_api_token
+  source_id = airbyte_source_postgres.my_source_postgres.source_id
+  destination_id = airbyte_destination_bigquery.my_destination_bigquery.destination_id
+}
+locals {
+  full_refresh_streams = [for stream in module.source_postgres_streams.streams : 
+    { 
+      name = stream.streamName
+      sync_mode = "full_refresh_overwrite"
+    }
+  ]
+}
+resource "airbyte_connection" "postgres_to_bigquery_full_refresh" {
+  name           = "Postgres to BigQuery Full Refresh"
+  source_id = airbyte_source_postgres.my_source_postgres.source_id
+  destination_id = airbyte_destination_bigquery.my_destination_bigquery.destination_id
+  schedule = {
+    schedule_type = "manual"
+  }
+  configurations = {
+    streams = local.full_refresh_streams
+  }
+}
+```
+
+{{ .SchemaMarkdown | trimspace }}