Merge pull request #279 from stackql/feature/provider-docs

snowflake updates

Author: jeffreyaven

docs/snowflake-docs/providers/snowflake/account/accounts/index.md

@@ -228,7 +228,8 @@ SELECT
       description: >-
         A Snowflake object identifier. If the identifier contains spaces or
         special characters, the entire string must be enclosed in double quotes.
-        Identifiers enclosed in double quotes are also case-sensitive.
+        Identifiers enclosed in double quotes are also case-sensitive. (Required
+        parameter for the accounts resource.)
     - name: region_group
       value: string
       description: >-
@@ -245,13 +246,16 @@ SELECT
       value: string
       description: >-
         Snowflake Edition of the account. (valid values: 'STANDARD',
-        'ENTERPRISE', 'BUSINESS_CRITICAL')
+        'ENTERPRISE', 'BUSINESS_CRITICAL') (Required parameter for the accounts
+        resource.)
     - name: comment
       value: string
       description: Optional comment in which to store information related to the account.
     - name: admin_name
       value: string
-      description: Name of the account administrator.
+      description: >-
+        Name of the account administrator. (Required parameter for the accounts
+        resource.)
     - name: admin_password
       value: string
       description: Password for the account administrator.
@@ -269,7 +273,9 @@ SELECT
       description: Last name of the account administrator.
     - name: email
       value: string
-      description: Email address of the account administrator.
+      description: >-
+        Email address of the account administrator. (Required parameter for the
+        accounts resource.)
     - name: must_change_password
       value: boolean
       description: >-

docs/snowflake-docs/providers/snowflake/alert/alerts/index.md

@@ -213,7 +213,7 @@ SELECT
       description: Required parameter for the alerts resource.
     - name: name
       value: string
-      description: Name of the alert
+      description: Name of the alert (Required parameter for the alerts resource.)
     - name: comment
       value: string
       description: user comment associated to an object in the dictionary
@@ -222,17 +222,20 @@ SELECT
         - name: schedule_type
           value: string
           description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE
+      description: Required parameter for the alerts resource.
     - name: warehouse
       value: string
       description: The warehouse the alert runs in
     - name: condition
       value: string
       description: >-
         The SQL statement that must be evaluated to determine whether to trigger
-        the alert
+        the alert (Required parameter for the alerts resource.)
     - name: action
       value: string
-      description: The SQL statement to execute when the alert is triggered
+      description: >-
+        The SQL statement to execute when the alert is triggered (Required
+        parameter for the alerts resource.)
 ```
 </TabItem>
 </Tabs>

docs/snowflake-docs/providers/snowflake/api_integration/api_integrations/index.md

@@ -176,27 +176,32 @@ SELECT
       description: Required parameter for the api_integrations resource.
     - name: name
       value: string
-      description: Name of the API integration.
+      description: >-
+        Name of the API integration. (Required parameter for the
+        api_integrations resource.)
     - name: api_hook
       value:
         - name: type
           value: string
           description: >-
             Type of ApiHook, can be AWS, AZURE, GC or GIT. (valid values: 'AWS',
             'AZURE', 'GC', 'GIT')
+      description: Required parameter for the api_integrations resource.
     - name: api_allowed_prefixes
       value: array
       description: >-
         A comma-separated list of endpoints and resources that Snowflake can
-        access.
+        access. (Required parameter for the api_integrations resource.)
     - name: api_blocked_prefixes
       value: array
       description: >-
         A comma-separated list of endpoints and resources that are not allowed
         to be called from Snowflake.
     - name: enabled
       value: boolean
-      description: Whether the API integration is enabled.
+      description: >-
+        Whether the API integration is enabled. (Required parameter for the
+        api_integrations resource.)
     - name: comment
       value: string
       description: Comment for the API integration.

docs/snowflake-docs/providers/snowflake/catalog_integration/catalog_integrations/index.md

@@ -176,20 +176,27 @@ SELECT
       description: Required parameter for the catalog_integrations resource.
     - name: name
       value: string
-      description: Name of the catalog integration.
+      description: >-
+        Name of the catalog integration. (Required parameter for the
+        catalog_integrations resource.)
     - name: catalog
       value:
         - name: catalog_source
           value: string
           description: >-
             Type of external catalog (valid values: 'GLUE', 'OBJECT_STORE',
             'POLARIS')
+      description: Required parameter for the catalog_integrations resource.
     - name: table_format
       value: string
-      description: 'Table format of the catalog. (valid values: ''ICEBERG'')'
+      description: >-
+        Table format of the catalog. (valid values: 'ICEBERG') (Required
+        parameter for the catalog_integrations resource.)
     - name: enabled
       value: boolean
-      description: whether this catalog integration is available to use for Iceberg tables.
+      description: >-
+        whether this catalog integration is available to use for Iceberg tables.
+        (Required parameter for the catalog_integrations resource.)
     - name: comment
       value: string
       description: Comment.

docs/snowflake-docs/providers/snowflake/compute_pool/compute_pools/index.md

@@ -233,16 +233,23 @@ SELECT
       description: >-
         A Snowflake object identifier. If the identifier contains spaces or
         special characters, the entire string must be enclosed in double quotes.
-        Identifiers enclosed in double quotes are also case-sensitive.
+        Identifiers enclosed in double quotes are also case-sensitive. (Required
+        parameter for the compute_pools resource.)
     - name: min_nodes
       value: integer
-      description: Minimum number of nodes for the compute pool.
+      description: >-
+        Minimum number of nodes for the compute pool. (Required parameter for
+        the compute_pools resource.)
     - name: max_nodes
       value: integer
-      description: Maximum number of nodes for the compute pool.
+      description: >-
+        Maximum number of nodes for the compute pool. (Required parameter for
+        the compute_pools resource.)
     - name: instance_family
       value: string
-      description: Instance family for the compute pool.
+      description: >-
+        Instance family for the compute pool. (Required parameter for the
+        compute_pools resource.)
     - name: auto_resume
       value: boolean
       description: >-

docs/snowflake-docs/providers/snowflake/database/databases/index.md

@@ -253,7 +253,8 @@ SELECT
       description: >-
         A Snowflake object identifier. If the identifier contains spaces or
         special characters, the entire string must be enclosed in double quotes.
-        Identifiers enclosed in double quotes are also case-sensitive.
+        Identifiers enclosed in double quotes are also case-sensitive. (Required
+        parameter for the databases resource.)
     - name: kind
       value: string
       description: >-

docs/snowflake-docs/providers/snowflake/database_role/database_roles/index.md

@@ -144,7 +144,9 @@ SELECT
       description: Required parameter for the database_roles resource.
     - name: name
       value: string
-      description: Name of the database role
+      description: >-
+        Name of the database role (Required parameter for the database_roles
+        resource.)
     - name: comment
       value: string
       description: User comment associated to an object in the dictionary

docs/snowflake-docs/providers/snowflake/database_role/future_grants/index.md

@@ -174,7 +174,9 @@ SELECT
           description: Schema name of the securable scope if applicable.
     - name: securable_type
       value: string
-      description: Type of the securable to be granted.
+      description: >-
+        Type of the securable to be granted. (Required parameter for the
+        future_grants resource.)
     - name: grant_option
       value: boolean
       description: >-

docs/snowflake-docs/providers/snowflake/database_role/grants/index.md

@@ -174,7 +174,9 @@ SELECT
           description: Schema name of the securable scope if applicable.
     - name: securable_type
       value: string
-      description: Type of the securable to be granted.
+      description: >-
+        Type of the securable to be granted. (Required parameter for the grants
+        resource.)
     - name: grant_option
       value: boolean
       description: >-

docs/snowflake-docs/providers/snowflake/dynamic_table/dynamic_tables/index.md

@@ -267,7 +267,8 @@ SELECT
       value: string
       description: >-
         Specifies the name for the dynamic table, must be unique for the schema
-        in which the dynamic table is created
+        in which the dynamic table is created (Required parameter for the
+        dynamic_tables resource.)
     - name: kind
       value: string
       description: >-
@@ -290,7 +291,9 @@ SELECT
         - name: type
           value: string
           description: Type of lag, can be either USER_DEFINED or DOWNSTREAM.
-      description: Specifies the schedule for periodically refreshing the dynamic table.
+      description: >-
+        Specifies the schedule for periodically refreshing the dynamic table.
+        (Required parameter for the dynamic_tables resource.)
     - name: refresh_mode
       value: string
       description: >-
@@ -305,15 +308,18 @@ SELECT
       value: string
       description: >-
         Specifies the name of the warehouse that provides the compute resources
-        for refreshing the dynamic table
+        for refreshing the dynamic table (Required parameter for the
+        dynamic_tables resource.)
     - name: cluster_by
       value: array
       description: >-
         Specifies one or more columns or column expressions in the dynamic table
         as the clustering key
     - name: query
       value: string
-      description: Specifies the query whose results the dynamic table should contain
+      description: >-
+        Specifies the query whose results the dynamic table should contain
+        (Required parameter for the dynamic_tables resource.)
     - name: data_retention_time_in_days
       value: integer
       description: >-

docs/snowflake-docs/providers/snowflake/event_table/event_tables/index.md

@@ -230,7 +230,9 @@ SELECT
       description: Required parameter for the event_tables resource.
     - name: name
       value: string
-      description: Name of the event table
+      description: >-
+        Name of the event table (Required parameter for the event_tables
+        resource.)
     - name: cluster_by
       value: array
       description: Cluster key column(s) or expression

docs/snowflake-docs/providers/snowflake/external_volume/external_volumes/index.md

@@ -170,7 +170,8 @@ SELECT
       value: string
       description: >-
         String that specifies the identifier (the name) for the external volume;
-        must be unique in your account.
+        must be unique in your account. (Required parameter for the
+        external_volumes resource.)
     - name: storage_locations
       value:
         - name: name
@@ -182,7 +183,8 @@ SELECT
             (valid values: 'S3', 'S3GOV', 'GCS', 'AZURE')
       description: >-
         Set of named cloud storage locations in different regions and,
-        optionally, cloud platforms.
+        optionally, cloud platforms. (Required parameter for the
+        external_volumes resource.)
     - name: allow_writes
       value: boolean
       description: >-

docs/snowflake-docs/providers/snowflake/function/functions/index.md

@@ -207,7 +207,8 @@ SELECT
       value: string
       description: >-
         Specifies the name for the function, must be unique for the schema in
-        which the function is created
+        which the function is created (Required parameter for the functions
+        resource.)
     - name: arguments
       value:
         - name: name
@@ -223,6 +224,7 @@ SELECT
         - name: value
           value: string
           description: Argument's value
+      description: Required parameter for the functions resource.
     - name: returns
       value: string
       description: >-

docs/snowflake-docs/providers/snowflake/iceberg_table/iceberg_tables/index.md

@@ -283,7 +283,9 @@ SELECT
       description: Required parameter for the iceberg_tables resource.
     - name: name
       value: string
-      description: Name of the iceberg table
+      description: >-
+        Name of the iceberg table (Required parameter for the iceberg_tables
+        resource.)
     - name: comment
       value: string
       description: user comment associated to an object in the dictionary

docs/snowflake-docs/providers/snowflake/image_repository/image_repositories/index.md

@@ -182,7 +182,8 @@ SELECT
       description: >-
         A Snowflake object identifier. If the identifier contains spaces or
         special characters, the entire string must be enclosed in double quotes.
-        Identifiers enclosed in double quotes are also case-sensitive.
+        Identifiers enclosed in double quotes are also case-sensitive. (Required
+        parameter for the image_repositories resource.)
     - name: database_name
       value: string
       description: >-

docs/snowflake-docs/providers/snowflake/managed_account/managed_accounts/index.md

@@ -152,19 +152,26 @@ SELECT
       description: >-
         A Snowflake object identifier. If the identifier contains spaces or
         special characters, the entire string must be enclosed in double quotes.
-        Identifiers enclosed in double quotes are also case-sensitive.
+        Identifiers enclosed in double quotes are also case-sensitive. (Required
+        parameter for the managed_accounts resource.)
     - name: comment
       value: string
       description: Optional comment in which to store information related to the account.
     - name: admin_name
       value: string
-      description: Name of the account administrator.
+      description: >-
+        Name of the account administrator. (Required parameter for the
+        managed_accounts resource.)
     - name: admin_password
       value: string
-      description: Password for the account administrator.
+      description: >-
+        Password for the account administrator. (Required parameter for the
+        managed_accounts resource.)
     - name: account_type
       value: string
-      description: 'Type of the account. (valid values: ''READER'')'
+      description: >-
+        Type of the account. (valid values: 'READER') (Required parameter for
+        the managed_accounts resource.)
       default: READER
 ```
 </TabItem>

docs/snowflake-docs/providers/snowflake/network_policy/network_policies/index.md

@@ -174,7 +174,9 @@ SELECT
       description: Required parameter for the network_policies resource.
     - name: name
       value: string
-      description: Name of the network policy
+      description: >-
+        Name of the network policy (Required parameter for the network_policies
+        resource.)
     - name: allowed_network_rule_list
       value: array
       description: List of names of allowed network rules in a network policy

docs/snowflake-docs/providers/snowflake/notebook/notebooks/index.md

@@ -263,7 +263,7 @@ SELECT
       description: Required parameter for the notebooks resource.
     - name: name
       value: string
-      description: Name of the notebook
+      description: Name of the notebook (Required parameter for the notebooks resource.)
     - name: version
       value: string
       description: User specified version alias

docs/snowflake-docs/providers/snowflake/notification_integration/notification_integrations/index.md

@@ -161,7 +161,9 @@ SELECT
       description: Required parameter for the notification_integrations resource.
     - name: name
       value: string
-      description: Name of the notification.
+      description: >-
+        Name of the notification. (Required parameter for the
+        notification_integrations resource.)
     - name: enabled
       value: boolean
       description: Whether the notification integration is enabled.
@@ -177,6 +179,7 @@ SELECT
             values: 'EMAIL', 'WEBHOOK', 'QUEUE_AWS_SNS_OUTBOUND',
             'QUEUE_AZURE_EVENT_GRID_OUTBOUND', 'QUEUE_GCP_PUBSUB_OUTBOUND',
             'QUEUE_AZURE_EVENT_GRID_INBOUND', 'QUEUE_GCP_PUBSUB_INBOUND')
+      description: Required parameter for the notification_integrations resource.
 ```
 </TabItem>
 </Tabs>