Skip to content

Commit 3f2c1af

Browse files
Gary JamesGary James
authored andcommitted
add docs
1 parent f6e3463 commit 3f2c1af

6 files changed

Lines changed: 42 additions & 25 deletions

File tree

docs/data-sources/dbt_cloud_project.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@ description: |-
2525

2626
### Read-Only
2727

28+
- **connection_id** (Number) ID of the connection associated with the project
2829
- **name** (String) Given name for project
30+
- **repository_id** (Number) ID of the repository associated with the project
2931
- **state** (Number) Project state should be 1 = active, as 2 = deleted
3032

3133

docs/index.md

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,16 @@ description: |-
66
77
---
88

9-
# DBT Cloud Provider
9+
# dbt-cloud Provider
10+
1011

11-
This is a terraform provider plugin for managing [DBT Cloud](https://cloud.getdbt.com/) accounts.
12-
Given the current capabilities of the API we focus on the management of job definitions.
1312

14-
## Example Provider Configuration
1513

16-
```terraform
17-
provider "dbt" {
18-
// required
19-
account_id = ...
20-
token = "..."
21-
}
22-
```
2314

2415
<!-- schema generated by tfplugindocs -->
2516
## Schema
2617

27-
### Required
18+
### Optional
2819

2920
- **account_id** (Number) Account identifier for your DBT Cloud implementation
3021
- **token** (String) API token for your DBT Cloud

docs/resources/dbt_cloud_job.md

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,9 @@ description: |-
88

99
# dbt_cloud_job (Resource)
1010

11-
## Example Usage
12-
13-
```terraform
14-
resource "dbt_cloud_job" "test" {
15-
project_id = 101
16-
environment_id = 1
17-
name = "Test job"
18-
execute_steps = [
19-
"dbt run",
20-
"dbt test"
21-
]
22-
}
23-
```
11+
12+
13+
2414

2515
<!-- schema generated by tfplugindocs -->
2616
## Schema
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "dbt_cloud_project Resource - terraform-provider-dbt-cloud"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# dbt_cloud_project (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- **name** (String) Project name
21+
22+
### Optional
23+
24+
- **connection_id** (Number) Connection ID
25+
- **dbt_project_subdirectory** (String) DBT project subdirectory path
26+
- **id** (String) The ID of this resource.
27+
- **repository_id** (Number) Repository ID
28+
29+

go.mod

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ require (
66
github.com/apparentlymart/go-cidr v1.1.0 // indirect
77
github.com/aws/aws-sdk-go v1.37.0 // indirect
88
github.com/hashicorp/hcl/v2 v2.8.2 // indirect
9+
github.com/hashicorp/terraform-plugin-docs v0.5.0 // indirect
910
github.com/hashicorp/terraform-plugin-sdk/v2 v2.7.1
1011
github.com/mattn/go-colorable v0.1.8 // indirect
1112
github.com/zclconf/go-cty v1.9.1 // indirect

go.sum

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ github.com/hashicorp/terraform-exec v0.14.0 h1:UQoUcxKTZZXhyyK68Cwn4mApT4mnFPmEX
214214
github.com/hashicorp/terraform-exec v0.14.0/go.mod h1:qrAASDq28KZiMPDnQ02sFS9udcqEkRly002EA2izXTA=
215215
github.com/hashicorp/terraform-json v0.12.0 h1:8czPgEEWWPROStjkWPUnTQDXmpmZPlkQAwYYLETaTvw=
216216
github.com/hashicorp/terraform-json v0.12.0/go.mod h1:pmbq9o4EuL43db5+0ogX10Yofv1nozM+wskr/bGFJpI=
217+
github.com/hashicorp/terraform-plugin-docs v0.5.0 h1:Rso/yNznoGl7KVb/Z5RefiHsLJaGTbok9sEnad+V1t4=
218+
github.com/hashicorp/terraform-plugin-docs v0.5.0/go.mod h1:Z4q6unfv05W7fjpEy8ZC+nFijZmcm64Iag6I2HKRMSA=
217219
github.com/hashicorp/terraform-plugin-go v0.3.0 h1:AJqYzP52JFYl9NABRI7smXI1pNjgR5Q/y2WyVJ/BOZA=
218220
github.com/hashicorp/terraform-plugin-go v0.3.0/go.mod h1:dFHsQMaTLpON2gWhVWT96fvtlc/MF1vSy3OdMhWBzdM=
219221
github.com/hashicorp/terraform-plugin-sdk/v2 v2.7.1 h1:vpzKKP2dIFb9n89AG8Wxl758/5JSZWZH0OuKdlq0M38=
@@ -307,6 +309,8 @@ github.com/posener/complete v1.1.1 h1:ccV59UEOTzVDnDUEFdT95ZzHVZ+5+158q8+SJb2QV5
307309
github.com/posener/complete v1.1.1/go.mod h1:em0nMJCgc9GFtwrmVmEMR/ZL6WyhyjMBndrE9hABlRI=
308310
github.com/prometheus/client_model v0.0.0-20190812154241-14fe0d1b01d4/go.mod h1:xMI15A0UPsDsEKsMN9yxemIoYk6Tm2C1GtYGdfGttqA=
309311
github.com/rogpeppe/go-internal v1.3.0/go.mod h1:M8bDsm7K2OlrFYOpmOWEs/qY81heoFRclV5y23lUDJ4=
312+
github.com/russross/blackfriday v1.6.0 h1:KqfZb0pUVN2lYqZUYRddxF4OR8ZMURnJIG5Y3VRLtww=
313+
github.com/russross/blackfriday v1.6.0/go.mod h1:ti0ldHuxg49ri4ksnFxlkCfN+hvslNlmVHqNRXXJNAY=
310314
github.com/sebdah/goldie v1.0.0/go.mod h1:jXP4hmWywNEwZzhMuv2ccnqTSFpuq8iyQhtQdkkZBH4=
311315
github.com/sergi/go-diff v1.0.0/go.mod h1:0CfEIISq7TuYL3j771MWULgwwjU+GofnZX9QAmXWZgo=
312316
github.com/sergi/go-diff v1.1.0/go.mod h1:STckp+ISIX8hZLjrqAeVduY0gWCT9IjLuqbuNXdaHfM=

0 commit comments

Comments
 (0)