.maybe adding it into the resource.tf can get this through doc autoge…

…neration and validation
Snowflake-Labs · Dec 26, 2024 · 6dc4b60 · 6dc4b60
1 parent f21c49c
commit 6dc4b60
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/docs/resources/stage.md b/docs/resources/stage.md
@@ -25,11 +25,6 @@ resource "snowflake_stage" "example_stage" {
 
 -> **Note** Instead of using fully_qualified_name, you can reference objects managed outside Terraform by constructing a correct ID, consult [identifiers guide](https://registry.terraform.io/providers/Snowflake-Labs/snowflake/latest/docs/guides/identifiers#new-computed-fully-qualified-name-field-in-resources).
 <!-- TODO(SNOW-1634854): include an example showing both methods-->
--> **Examples of usage for `file_format`:**
-* with hardcoding value: `file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME"`
-* from dynamic value: `file_format = "FORMAT_NAME = ${snowflake_database.mydb.name}.${snowflake_schema.myschema.name}.${snowflake_file_format.myfileformat.name}"`
-* from expression: `file_format = format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name)`
-  (Reference: [#265](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/265))
 <!-- schema generated by tfplugindocs -->
 ## Schema
 

diff --git a/examples/resources/snowflake_stage/resource.tf b/examples/resources/snowflake_stage/resource.tf
@@ -6,3 +6,10 @@ resource "snowflake_stage" "example_stage" {
   schema      = "EXAMPLE_SCHEMA"
   credentials = "AWS_KEY_ID='${var.example_aws_key_id}' AWS_SECRET_KEY='${var.example_aws_secret_key}'"
 }
+/*
+  * Examples of usage for `file_format`:
+    * with hardcoding value: `file_format="FORMAT_NAME = DB.SCHEMA.FORMATNAME"`
+    * from dynamic value: `file_format = "FORMAT_NAME = ${snowflake_database.mydb.name}.${snowflake_schema.myschema.name}.${snowflake_file_format.myfileformat.name}"`
+    * from expression: `file_format = format("FORMAT_NAME =%s.%s.MYFILEFORMAT", var.db_name, each.value.schema_name)`
+  * Reference: [#265](https://github.com/Snowflake-Labs/terraform-provider-snowflake/issues/265)
+*/