From 1004d1c11214856154a4e3f9785cc958ca7a29d9 Mon Sep 17 00:00:00 2001 From: joe miller Date: Sat, 5 Oct 2024 18:32:08 +0000 Subject: [PATCH] regenerate docs --- GNUmakefile | 3 ++- docs/data-sources/backup.md | 2 +- docs/data-sources/backups.md | 2 +- docs/data-sources/user.md | 13 ++++++++++++- docs/resources/backup.md | 26 ++++++++++++++------------ docs/resources/branch.md | 2 -- 6 files changed, 30 insertions(+), 18 deletions(-) diff --git a/GNUmakefile b/GNUmakefile index 46ea9e8..3a28c52 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -12,4 +12,5 @@ testacc: .PHONY: generate generate: bash ./script/update_openapi_spec - bash ./script/generate \ No newline at end of file + bash ./script/generate + go gnenerate ./... \ No newline at end of file diff --git a/docs/data-sources/backup.md b/docs/data-sources/backup.md index c892c01..23bf28b 100644 --- a/docs/data-sources/backup.md +++ b/docs/data-sources/backup.md @@ -40,7 +40,7 @@ output "backup" { - `actor` (Attributes) The actor that created the backup. (see [below for nested schema](#nestedatt--actor)) - `backup_policy` (Attributes) The backup policy being followed. (see [below for nested schema](#nestedatt--backup_policy)) - `created_at` (String) When the backup was created. -- `estimated_storage_cost` (String) The estimated storage cost of the backup. +- `estimated_storage_cost` (Number) The estimated storage cost of the backup. - `name` (String) The name of the backup. - `required` (Boolean) Whether or not the backup policy is required. - `restored_branches` (List of String) Branches that have been restored with this backup. diff --git a/docs/data-sources/backups.md b/docs/data-sources/backups.md index 87227ae..f670acf 100644 --- a/docs/data-sources/backups.md +++ b/docs/data-sources/backups.md @@ -47,7 +47,7 @@ Read-Only: - `branch` (String) The branch this backup belongs to. - `created_at` (String) When the backup was created. - `database` (String) The database this backup belongs to. -- `estimated_storage_cost` (String) The estimated storage cost of the backup. +- `estimated_storage_cost` (Number) The estimated storage cost of the backup. - `id` (String) The ID of the backup. - `name` (String) The name of the backup. - `organization` (String) The organization this backup belongs to. diff --git a/docs/data-sources/user.md b/docs/data-sources/user.md index 9e4487e..e9d31d5 100644 --- a/docs/data-sources/user.md +++ b/docs/data-sources/user.md @@ -34,7 +34,7 @@ output "current_user" { - `avatar_url` (String) The URL source of the user's avatar. - `created_at` (String) When the user was created. -- `default_organization_id` (String) The default organization for the user. +- `default_organization` (Attributes) The default organization for the user. (see [below for nested schema](#nestedatt--default_organization)) - `directory_managed` (Boolean) Whether or not the user is managed by a WorkOS directory. - `display_name` (String) The display name of the user. - `email` (String) The email of the user. @@ -45,3 +45,14 @@ output "current_user" { - `sso` (Boolean) Whether or not the user is managed by WorkOS. - `two_factor_auth_configured` (Boolean) Whether or not the user has configured two factor authentication. - `updated_at` (String) When the user was last updated. + + +### Nested Schema for `default_organization` + +Read-Only: + +- `created_at` (String) When the organization was created. +- `deleted_at` (String) When the organization was last deleted. +- `id` (String) The ID of the organization. +- `name` (String) The name of the organization. +- `updated_at` (String) When the organization was last updated. diff --git a/docs/resources/backup.md b/docs/resources/backup.md index 025e44a..4692bbb 100644 --- a/docs/resources/backup.md +++ b/docs/resources/backup.md @@ -35,17 +35,19 @@ resource "planetscale_backup" "example" { ### Required -- `backup_policy` (Attributes) The policy used by the backup. (see [below for nested schema](#nestedatt--backup_policy)) - `branch` (String) The branch being backed up. - `database` (String) The database to which the branch being backed up belongs to. - `name` (String) The name of the backup. - `organization` (String) The organization in which the database branch being backed up belongs to. +- `retention_unit` (String) The unit for the retention period of the backup policy. +- `retention_value` (Number) A number value for the retention period of the backup policy. ### Read-Only - `actor` (Attributes) . (see [below for nested schema](#nestedatt--actor)) +- `backup_policy` (Attributes) The policy used by the backup. (see [below for nested schema](#nestedatt--backup_policy)) - `created_at` (String) When the backup was created. -- `estimated_storage_cost` (String) The estimated storage cost of the backup. +- `estimated_storage_cost` (Number) The estimated storage cost of the backup. - `id` (String) The ID of the backup. - `required` (Boolean) Whether or not the backup policy is required. - `restored_branches` (List of String) Branches that have been restored with this backup. @@ -53,6 +55,16 @@ resource "planetscale_backup" "example" { - `state` (String) The current state of the backup. - `updated_at` (String) When the backup was last updated. + +### Nested Schema for `actor` + +Read-Only: + +- `avatar_url` (String) The URL of the actor's avatar +- `display_name` (String) The name of the actor +- `id` (String) The ID of the actor + + ### Nested Schema for `backup_policy` @@ -74,13 +86,3 @@ Read-Only: - `schedule_week` (String) Week of the month that the backup is scheduled. - `target` (String) Whether the backup policy is for a production or development database, or for a database branch. - `updated_at` (String) When the backup policy was last updated. - - - -### Nested Schema for `actor` - -Read-Only: - -- `avatar_url` (String) The URL of the actor's avatar -- `display_name` (String) The name of the actor -- `id` (String) The ID of the actor diff --git a/docs/resources/branch.md b/docs/resources/branch.md index 9f94c3b..39c0d6a 100644 --- a/docs/resources/branch.md +++ b/docs/resources/branch.md @@ -37,13 +37,11 @@ resource "planetscale_branch" "example" { ### Read-Only -- `access_host_url` (String) The access host URL for the branch. This is a legacy field, use `mysql_edge_address`. - `actor` (Attributes) The actor who created this branch. (see [below for nested schema](#nestedatt--actor)) - `cluster_rate_name` (String) The SKU representing the branch's cluster size. - `created_at` (String) When the branch was created. - `html_url` (String) Planetscale app URL for the branch. - `id` (String) The ID of the branch. -- `initial_restore_id` (String) The ID of the backup from which the branch was restored. - `mysql_address` (String) The MySQL address for the branch. - `mysql_edge_address` (String) The address of the MySQL provider for the branch. - `ready` (Boolean) Whether or not the branch is ready to serve queries.