Skip to content

Commit 7d5ff6e

Browse files
ecmadaoecmadao
committed
chore: update docs
1 parent 4383773 commit 7d5ff6e

File tree

10 files changed

+237
-9
lines changed

10 files changed

+237
-9
lines changed

‎docs/data-sources/policy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ The policy data source.
2121

2222
### Optional
2323

24-
- `masking_exception_policy` (Block List) (see [below for nested schema](#nestedblock--masking_exception_policy))
25-
- `masking_policy` (Block List) (see [below for nested schema](#nestedblock--masking_policy))
24+
- `masking_exception_policy` (Block List, Max: 1) (see [below for nested schema](#nestedblock--masking_exception_policy))
25+
- `masking_policy` (Block List, Max: 1) (see [below for nested schema](#nestedblock--masking_policy))
2626
- `parent` (String) The policy parent name for the policy, support projects/{resource id}, environments/{resource id}, instances/{resource id}, or instances/{resource id}/databases/{database name}
2727

2828
### Read-Only

‎docs/data-sources/vcs_connector.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "bytebase_vcs_connector Data Source - terraform-provider-bytebase"
4+
subcategory: ""
5+
description: |-
6+
The vcs connector data source.
7+
---
8+
9+
# bytebase_vcs_connector (Data Source)
10+
11+
The vcs connector data source.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `project` (String) The project name in projects/{resource id} format.
21+
- `resource_id` (String) The vcs connector unique resource id.
22+
23+
### Optional
24+
25+
- `database_group` (String) Apply changes to the database group.
26+
27+
### Read-Only
28+
29+
- `create_time` (String) The vcs connector create time in YYYY-MM-DDThh:mm:ss.000Z format
30+
- `creator` (String) The vcs connector creator in users/{email} format.
31+
- `id` (String) The ID of this resource.
32+
- `name` (String) The vcs connector full name in projects/{project}/vcsConnector/{resource id} format.
33+
- `repository_branch` (String) The connected repository branch in vcs provider.
34+
- `repository_directory` (String) The connected repository directory in vcs provider.
35+
- `repository_id` (String) The connected repository id in vcs provider.
36+
- `repository_path` (String) The connected repository path in vcs provider.
37+
- `repository_url` (String) The connected repository url in vcs provider.
38+
- `title` (String) The vcs connector title.
39+
- `update_time` (String) The vcs connector update time in YYYY-MM-DDThh:mm:ss.000Z format
40+
- `updater` (String) The vcs connector updater in users/{email} format.
41+
- `vcs_provider` (String) The vcs provider full name in vcsProviders/{resource id} format.
42+
43+

‎docs/data-sources/vcs_connector_list.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "bytebase_vcs_connector_list Data Source - terraform-provider-bytebase"
4+
subcategory: ""
5+
description: |-
6+
The vcs connector data source list.
7+
---
8+
9+
# bytebase_vcs_connector_list (Data Source)
10+
11+
The vcs connector data source list.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `project` (String) The project name in projects/{resource id} format.
21+
22+
### Read-Only
23+
24+
- `id` (String) The ID of this resource.
25+
- `vcs_connectors` (List of Object) (see [below for nested schema](#nestedatt--vcs_connectors))
26+
27+
<a id="nestedatt--vcs_connectors"></a>
28+
### Nested Schema for `vcs_connectors`
29+
30+
Read-Only:
31+
32+
- `create_time` (String)
33+
- `creator` (String)
34+
- `database_group` (String)
35+
- `name` (String)
36+
- `project` (String)
37+
- `repository_branch` (String)
38+
- `repository_directory` (String)
39+
- `repository_id` (String)
40+
- `repository_path` (String)
41+
- `repository_url` (String)
42+
- `resource_id` (String)
43+
- `title` (String)
44+
- `update_time` (String)
45+
- `updater` (String)
46+
- `vcs_provider` (String)
47+
48+

‎docs/data-sources/vcs_provider.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "bytebase_vcs_provider Data Source - terraform-provider-bytebase"
4+
subcategory: ""
5+
description: |-
6+
The vcs provider data source.
7+
---
8+
9+
# bytebase_vcs_provider (Data Source)
10+
11+
The vcs provider data source.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `resource_id` (String) The vcs provider unique resource id.
21+
22+
### Read-Only
23+
24+
- `id` (String) The ID of this resource.
25+
- `name` (String) The vcs provider full name in vcsProviders/{resource id} format.
26+
- `title` (String) The vcs provider title.
27+
- `type` (String) The vcs provider type.
28+
- `url` (String) The vcs provider url.
29+
30+

‎docs/data-sources/vcs_provider_list.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "bytebase_vcs_provider_list Data Source - terraform-provider-bytebase"
4+
subcategory: ""
5+
description: |-
6+
The vcs provider data source list.
7+
---
8+
9+
# bytebase_vcs_provider_list (Data Source)
10+
11+
The vcs provider data source list.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Read-Only
19+
20+
- `id` (String) The ID of this resource.
21+
- `vcs_providers` (List of Object) (see [below for nested schema](#nestedatt--vcs_providers))
22+
23+
<a id="nestedatt--vcs_providers"></a>
24+
### Nested Schema for `vcs_providers`
25+
26+
Read-Only:
27+
28+
- `name` (String)
29+
- `resource_id` (String)
30+
- `title` (String)
31+
- `type` (String)
32+
- `url` (String)
33+
34+

‎docs/resources/environment.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The environment resource.
2020
- `environment_tier_policy` (String) If marked as PROTECTED, developers cannot execute any query on this environment's databases using SQL Editor by default.
2121
- `order` (Number) The environment sorting order.
2222
- `resource_id` (String) The environment unique resource id.
23-
- `title` (String) The environment unique name.
23+
- `title` (String) The environment title.
2424

2525
### Read-Only
2626

‎docs/resources/policy.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ The policy resource.
2424

2525
- `enforce` (Boolean) Decide if the policy is enforced.
2626
- `inherit_from_parent` (Boolean) Decide if the policy should inherit from the parent.
27-
- `masking_exception_policy` (Block List) (see [below for nested schema](#nestedblock--masking_exception_policy))
28-
- `masking_policy` (Block List) (see [below for nested schema](#nestedblock--masking_policy))
27+
- `masking_exception_policy` (Block List, Max: 1) (see [below for nested schema](#nestedblock--masking_exception_policy))
28+
- `masking_policy` (Block List, Max: 1) (see [below for nested schema](#nestedblock--masking_policy))
2929

3030
### Read-Only
3131

‎docs/resources/vcs_connector.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "bytebase_vcs_connector Resource - terraform-provider-bytebase"
4+
subcategory: ""
5+
description: |-
6+
The vcs connector resource.
7+
---
8+
9+
# bytebase_vcs_connector (Resource)
10+
11+
The vcs connector resource.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `project` (String) The project name in projects/{resource id} format.
21+
- `repository_branch` (String) The connected repository branch in vcs provider.
22+
- `repository_directory` (String) The connected repository directory in vcs provider.
23+
- `repository_id` (String) The connected repository id in vcs provider.
24+
- `repository_path` (String) The connected repository path in vcs provider.
25+
- `repository_url` (String) The connected repository url in vcs provider.
26+
- `resource_id` (String) The vcs connector unique resource id.
27+
- `title` (String) The vcs connector title.
28+
- `vcs_provider` (String) The vcs provider full name in vcsProviders/{resource id} format.
29+
30+
### Optional
31+
32+
- `database_group` (String) Apply changes to the database group.
33+
34+
### Read-Only
35+
36+
- `create_time` (String) The vcs connector create time in YYYY-MM-DDThh:mm:ss.000Z format
37+
- `creator` (String) The vcs connector creator in users/{email} format.
38+
- `id` (String) The ID of this resource.
39+
- `name` (String) The vcs connector full name in projects/{project}/vcsConnector/{resource id} format.
40+
- `update_time` (String) The vcs connector update time in YYYY-MM-DDThh:mm:ss.000Z format
41+
- `updater` (String) The vcs connector updater in users/{email} format.
42+
43+

‎docs/resources/vcs_provider.md‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "bytebase_vcs_provider Resource - terraform-provider-bytebase"
4+
subcategory: ""
5+
description: |-
6+
The vcs provider resource.
7+
---
8+
9+
# bytebase_vcs_provider (Resource)
10+
11+
The vcs provider resource.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `access_token` (String, Sensitive) The vcs provider token. Check the docs https://bytebase.cc/docs/vcs-integration/add-git-provider for details.
21+
- `resource_id` (String) The vcs provider unique resource id.
22+
- `title` (String) The vcs provider title.
23+
- `type` (String) The vcs provider type.
24+
25+
### Optional
26+
27+
- `url` (String) The vcs provider url. You need to provide the url if you're using the self-host GitLab or self-host GitHub.
28+
29+
### Read-Only
30+
31+
- `id` (String) The ID of this resource.
32+
- `name` (String) The vcs provider full name in vcsProviders/{resource id} format.
33+
34+

‎provider/data_source_setting.go‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,6 @@ func getExternalApprovalSetting(computed bool) *schema.Schema {
4141
Computed: computed,
4242
Optional: true,
4343
Default: nil,
44-
MinItems: 0,
45-
MaxItems: 1,
4644
Type: schema.TypeList,
4745
Elem: &schema.Resource{
4846
Schema: map[string]*schema.Schema{
@@ -84,8 +82,6 @@ func getWorkspaceApprovalSetting(computed bool) *schema.Schema {
8482
Optional: true,
8583
Default: nil,
8684
Type: schema.TypeList,
87-
MinItems: 0,
88-
MaxItems: 1,
8985
Elem: &schema.Resource{
9086
Schema: map[string]*schema.Schema{
9187
"rules": {

0 commit comments

Comments
 (0)