Bump tfplugindocs

paultyng · Jan 7, 2021 · 69e6fda · 69e6fda
1 parent 40a95a1
commit 69e6fda
Show file tree

Hide file tree

Showing 6 changed files with 30 additions and 18 deletions.
diff --git a/docs/data-sources/query.md b/docs/data-sources/query.md
@@ -1,4 +1,5 @@
 ---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "sql_query Data Source - terraform-provider-sql"
 subcategory: ""
 description: |-
@@ -27,15 +28,16 @@ output "math" {
 }
 ```
 
+<!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **query** (String, Required) The query to execute. The types in this query will be reflected in the typing of the `result` attribute.
+- **query** (String) The query to execute. The types in this query will be reflected in the typing of the `result` attribute.
 
 ### Read-only
 
-- **id** (String, Read-only, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
-- **result** (List of Dynamic, Read-only) The result of the query. This will be a list of objects. Each object will have attributes with names that match column names and types that match column types. The exact translation of types is dependent upon the database driver.
+- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
+- **result** (List of Dynamic) The result of the query. This will be a list of objects. Each object will have attributes with names that match column names and types that match column types. The exact translation of types is dependent upon the database driver.
 
 
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,5 @@
 ---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "sql Provider"
 subcategory: ""
 description: |-
@@ -38,10 +39,11 @@ provider "sql" {
 }
 ```
 
+<!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
 
-- **max_idle_conns** (Number, Optional) Sets the maximum number of connections in the idle connection pool. Default is `2`. See Go's documentation on [DB.SetMaxIdleConns](https://golang.org/pkg/database/sql/#DB.SetMaxIdleConns).
-- **max_open_conns** (Number, Optional) Sets the maximum number of open connections to the database. Default is `0` (unlimited). See Go's documentation on [DB.SetMaxOpenConns](https://golang.org/pkg/database/sql/#DB.SetMaxOpenConns).
-- **url** (String, Optional) Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form: `dbdriver://username:password@host:port/dbname?param1=true&param2=false`. You can optionally set the `SQL_URL` environment variable instead.
+- **max_idle_conns** (Number) Sets the maximum number of connections in the idle connection pool. Default is `2`. See Go's documentation on [DB.SetMaxIdleConns](https://golang.org/pkg/database/sql/#DB.SetMaxIdleConns).
+- **max_open_conns** (Number) Sets the maximum number of open connections to the database. Default is `0` (unlimited). See Go's documentation on [DB.SetMaxOpenConns](https://golang.org/pkg/database/sql/#DB.SetMaxOpenConns).
+- **url** (String) Database connection strings are specified via URLs. The URL format is driver dependent but generally has the form: `dbdriver://username:password@host:port/dbname?param1=true&param2=false`. You can optionally set the `SQL_URL` environment variable instead.
diff --git a/docs/resources/migrate.md b/docs/resources/migrate.md
@@ -1,4 +1,5 @@
 ---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "sql_migrate Resource - terraform-provider-sql"
 subcategory: ""
 description: |-
@@ -43,6 +44,7 @@ output "rowcount" {
 }
 ```
 
+<!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Optional
@@ -51,22 +53,24 @@ output "rowcount" {
 
 ### Read-only
 
-- **complete_migrations** (List of Object, Read-only) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
-- **id** (String, Read-only, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
+- **complete_migrations** (List of Object) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
+- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
 
 <a id="nestedblock--migration"></a>
 ### Nested Schema for `migration`
 
 Required:
 
-- **down** (String, Required) The query to run when undoing this migration.
-- **id** (String, Required) Identifier can be any string to help identifying the migration in the source.
-- **up** (String, Required) The query to run when applying this migration.
+- **down** (String) The query to run when undoing this migration.
+- **id** (String) Identifier can be any string to help identifying the migration in the source.
+- **up** (String) The query to run when applying this migration.
 
 
 <a id="nestedatt--complete_migrations"></a>
 ### Nested Schema for `complete_migrations`
 
+Read-only:
+
 - **down** (String)
 - **id** (String)
 - **up** (String)

diff --git a/docs/resources/migrate_directory.md b/docs/resources/migrate_directory.md
@@ -1,4 +1,5 @@
 ---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
 page_title: "sql_migrate_directory Resource - terraform-provider-sql"
 subcategory: ""
 description: |-
@@ -29,24 +30,27 @@ output "rowcount" {
 }
 ```
 
+<!-- schema generated by tfplugindocs -->
 ## Schema
 
 ### Required
 
-- **path** (String, Required) The path of the SQL migration files. For a path relative to the current module, use `path.module`.
+- **path** (String) The path of the SQL migration files. For a path relative to the current module, use `path.module`.
 
 ### Optional
 
-- **single_file_split** (String, Optional) Set this to a value if your migration up and down are in a single file, split on some constant string (ie. in the case of [shmig](https://github.com/mbucc/shmig) you would use `-- ==== DOWN ====`).
+- **single_file_split** (String) Set this to a value if your migration up and down are in a single file, split on some constant string (ie. in the case of [shmig](https://github.com/mbucc/shmig) you would use `-- ==== DOWN ====`).
 
 ### Read-only
 
-- **complete_migrations** (List of Object, Read-only) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
-- **id** (String, Read-only, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
+- **complete_migrations** (List of Object) The completed migrations that have been run against your database. This list is used as storage to migrate down or as a trigger for downstream dependencies. (see [below for nested schema](#nestedatt--complete_migrations))
+- **id** (String, Deprecated) This attribute is only present for some compatibility issues and should not be used. It will be removed in a future version.
 
 <a id="nestedatt--complete_migrations"></a>
 ### Nested Schema for `complete_migrations`
 
+Read-only:
+
 - **down** (String)
 - **id** (String)
 - **up** (String)

diff --git a/go.mod b/go.mod
@@ -10,7 +10,7 @@ require (
 	github.com/google/go-cmp v0.5.4
 	github.com/hashicorp/go-argmapper v0.0.0-20200721221215-04ae500ede3b
 	github.com/hashicorp/go-plugin v1.4.0
-	github.com/hashicorp/terraform-plugin-docs v0.3.0
+	github.com/hashicorp/terraform-plugin-docs v0.3.1-0.20210107204619-bf524a84dc08
 	github.com/hashicorp/terraform-plugin-go v0.1.1-0.20201117024036-b9d161518a6d
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.4.0
 	github.com/jackc/pgx/v4 v4.10.1

diff --git a/go.sum b/go.sum
@@ -239,8 +239,8 @@ github.com/hashicorp/terraform-json v0.5.0 h1:7TV3/F3y7QVSuN4r9BEXqnWqrAyeOtON8f
 github.com/hashicorp/terraform-json v0.5.0/go.mod h1:eAbqb4w0pSlRmdvl8fOyHAi/+8jnkVYN28gJkSJrLhU=
 github.com/hashicorp/terraform-json v0.8.0 h1:XObQ3PgqU52YLQKEaJ08QtUshAfN3yu4u8ebSW0vztc=
 github.com/hashicorp/terraform-json v0.8.0/go.mod h1:3defM4kkMfttwiE7VakJDwCd4R+umhSQnvJwORXbprE=
-github.com/hashicorp/terraform-plugin-docs v0.3.0 h1:q9qVsL8LYLVDRhS5nqxubCzWtRZ61Y6GLlphk9YIqR0=
-github.com/hashicorp/terraform-plugin-docs v0.3.0/go.mod h1:4jopztPjeyZAr51wPzX4b8Ld8bFQKQ9dbF40JbCQIts=
+github.com/hashicorp/terraform-plugin-docs v0.3.1-0.20210107204619-bf524a84dc08 h1:gVEbALFfOCsAscHV9/Xz188pfdG32/GzR4O5RVcwjUw=
+github.com/hashicorp/terraform-plugin-docs v0.3.1-0.20210107204619-bf524a84dc08/go.mod h1:4jopztPjeyZAr51wPzX4b8Ld8bFQKQ9dbF40JbCQIts=
 github.com/hashicorp/terraform-plugin-go v0.1.0/go.mod h1:10V6F3taeDWVAoLlkmArKttR3IULlRWFAGtQIQTIDr4=
 github.com/hashicorp/terraform-plugin-go v0.1.1-0.20201117024036-b9d161518a6d h1:iiRI4FfqpX+hFEUvf+t7wMJmxKsmm395vjaKLOLD4ds=
 github.com/hashicorp/terraform-plugin-go v0.1.1-0.20201117024036-b9d161518a6d/go.mod h1:10V6F3taeDWVAoLlkmArKttR3IULlRWFAGtQIQTIDr4=