Skip to content

Commit c5a0e81

Browse files
jasondamourjasondamour
committed
chore: docs
1 parent 50b9cdd commit c5a0e81

2 files changed

Lines changed: 230 additions & 54 deletions

File tree

‎docs/generators/terraform-provider.md‎

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
1+
---
2+
title: Documentation for the terraform-provider Generator
3+
---
4+
5+
## METADATA
6+
7+
| Property | Value | Notes |
8+
| -------- | ----- | ----- |
9+
| generator name | terraform-provider | pass this to the generate command after -g |
10+
| generator stability | EXPERIMENTAL | |
11+
| generator type | CLIENT | |
12+
| generator language | Go | |
13+
| generator default templating engine | mustache | |
14+
| helpTxt | Generates a Terraform provider (Go, using HashiCorp Plugin Framework). | |
15+
16+
## CONFIG OPTIONS
17+
These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details.
18+
19+
| Option | Description | Values | Default |
20+
| ------ | ----------- | ------ | ------- |
21+
|hideGenerationTimestamp|Hides the generation timestamp when files are generated.| |true|
22+
|packageName|Go package name (convention: lowercase).| |openapi|
23+
|packageVersion|Go package version.| |1.0.0|
24+
|providerAddress|Terraform provider registry address| |registry.terraform.io/example/example|
25+
|providerName|Terraform provider name (e.g. 'petstore')| |example|
26+
|providerVersion|Terraform provider version| |0.1.0|
27+
28+
## IMPORT MAPPING
29+
30+
| Type/Alias | Imports |
31+
| ---------- | ------- |
32+
33+
34+
## INSTANTIATION TYPES
35+
36+
| Type/Alias | Instantiated By |
37+
| ---------- | --------------- |
38+
39+
40+
## LANGUAGE PRIMITIVES
41+
42+
<ul class="column-ul">
43+
<li>bool</li>
44+
<li>byte</li>
45+
<li>complex128</li>
46+
<li>complex64</li>
47+
<li>float32</li>
48+
<li>float64</li>
49+
<li>int</li>
50+
<li>int32</li>
51+
<li>int64</li>
52+
<li>interface{}</li>
53+
<li>map[string]interface{}</li>
54+
<li>rune</li>
55+
<li>string</li>
56+
<li>uint</li>
57+
<li>uint32</li>
58+
<li>uint64</li>
59+
</ul>
60+
61+
## RESERVED WORDS
62+
63+
<ul class="column-ul">
64+
<li>bool</li>
65+
<li>break</li>
66+
<li>byte</li>
67+
<li>case</li>
68+
<li>chan</li>
69+
<li>complex128</li>
70+
<li>complex64</li>
71+
<li>const</li>
72+
<li>continue</li>
73+
<li>default</li>
74+
<li>defer</li>
75+
<li>else</li>
76+
<li>error</li>
77+
<li>fallthrough</li>
78+
<li>float32</li>
79+
<li>float64</li>
80+
<li>for</li>
81+
<li>func</li>
82+
<li>go</li>
83+
<li>goto</li>
84+
<li>if</li>
85+
<li>import</li>
86+
<li>int</li>
87+
<li>int16</li>
88+
<li>int32</li>
89+
<li>int64</li>
90+
<li>int8</li>
91+
<li>interface</li>
92+
<li>map</li>
93+
<li>nil</li>
94+
<li>package</li>
95+
<li>range</li>
96+
<li>return</li>
97+
<li>rune</li>
98+
<li>select</li>
99+
<li>string</li>
100+
<li>struct</li>
101+
<li>switch</li>
102+
<li>type</li>
103+
<li>uint</li>
104+
<li>uint16</li>
105+
<li>uint32</li>
106+
<li>uint64</li>
107+
<li>uint8</li>
108+
<li>uintptr</li>
109+
<li>var</li>
110+
</ul>
111+
112+
## FEATURE SET
113+
114+
115+
### Client Modification Feature
116+
| Name | Supported | Defined By |
117+
| ---- | --------- | ---------- |
118+
|BasePath|✗|ToolingExtension
119+
|Authorizations|✗|ToolingExtension
120+
|UserAgent|✗|ToolingExtension
121+
|MockServer|✗|ToolingExtension
122+
123+
### Data Type Feature
124+
| Name | Supported | Defined By |
125+
| ---- | --------- | ---------- |
126+
|Custom|✗|OAS2,OAS3
127+
|Int32|✓|OAS2,OAS3
128+
|Int64|✓|OAS2,OAS3
129+
|Float|✓|OAS2,OAS3
130+
|Double|✓|OAS2,OAS3
131+
|Decimal|✓|ToolingExtension
132+
|String|✓|OAS2,OAS3
133+
|Byte|✓|OAS2,OAS3
134+
|Binary|✓|OAS2,OAS3
135+
|Boolean|✓|OAS2,OAS3
136+
|Date|✓|OAS2,OAS3
137+
|DateTime|✓|OAS2,OAS3
138+
|Password|✓|OAS2,OAS3
139+
|File|✓|OAS2
140+
|Uuid|✗|
141+
|Array|✓|OAS2,OAS3
142+
|Null|✗|OAS3
143+
|AnyType|✗|OAS2,OAS3
144+
|Object|✓|OAS2,OAS3
145+
|Maps|✓|ToolingExtension
146+
|CollectionFormat|✓|OAS2
147+
|CollectionFormatMulti|✓|OAS2
148+
|Enum|✓|OAS2,OAS3
149+
|ArrayOfEnum|✓|ToolingExtension
150+
|ArrayOfModel|✓|ToolingExtension
151+
|ArrayOfCollectionOfPrimitives|✓|ToolingExtension
152+
|ArrayOfCollectionOfModel|✓|ToolingExtension
153+
|ArrayOfCollectionOfEnum|✓|ToolingExtension
154+
|MapOfEnum|✓|ToolingExtension
155+
|MapOfModel|✓|ToolingExtension
156+
|MapOfCollectionOfPrimitives|✓|ToolingExtension
157+
|MapOfCollectionOfModel|✓|ToolingExtension
158+
|MapOfCollectionOfEnum|✓|ToolingExtension
159+
160+
### Documentation Feature
161+
| Name | Supported | Defined By |
162+
| ---- | --------- | ---------- |
163+
|Readme|✓|ToolingExtension
164+
|Model|✓|ToolingExtension
165+
|Api|✓|ToolingExtension
166+
167+
### Global Feature
168+
| Name | Supported | Defined By |
169+
| ---- | --------- | ---------- |
170+
|Host|✓|OAS2,OAS3
171+
|BasePath|✓|OAS2,OAS3
172+
|Info|✓|OAS2,OAS3
173+
|Schemes|✗|OAS2,OAS3
174+
|PartialSchemes|✓|OAS2,OAS3
175+
|Consumes|✓|OAS2
176+
|Produces|✓|OAS2
177+
|ExternalDocumentation|✓|OAS2,OAS3
178+
|Examples|✓|OAS2,OAS3
179+
|XMLStructureDefinitions|✗|OAS2,OAS3
180+
|MultiServer|✗|OAS3
181+
|ParameterizedServer|✗|OAS3
182+
|ParameterStyling|✗|OAS3
183+
|Callbacks|✗|OAS3
184+
|LinkObjects|✗|OAS3
185+
186+
### Parameter Feature
187+
| Name | Supported | Defined By |
188+
| ---- | --------- | ---------- |
189+
|Path|✓|OAS2,OAS3
190+
|Query|✓|OAS2,OAS3
191+
|Header|✓|OAS2,OAS3
192+
|Body|✓|OAS2
193+
|FormUnencoded|✓|OAS2
194+
|FormMultipart|✓|OAS2
195+
|Cookie|✓|OAS3
196+
197+
### Schema Support Feature
198+
| Name | Supported | Defined By |
199+
| ---- | --------- | ---------- |
200+
|Simple|✓|OAS2,OAS3
201+
|Composite|✓|OAS2,OAS3
202+
|Polymorphism|✗|OAS2,OAS3
203+
|Union|✗|OAS3
204+
|allOf|✗|OAS2,OAS3
205+
|anyOf|✗|OAS3
206+
|oneOf|✗|OAS3
207+
|not|✗|OAS3
208+
209+
### Security Feature
210+
| Name | Supported | Defined By |
211+
| ---- | --------- | ---------- |
212+
|BasicAuth|✓|OAS2,OAS3
213+
|ApiKey|✓|OAS2,OAS3
214+
|OpenIDConnect|✗|OAS3
215+
|BearerToken|✓|OAS3
216+
|OAuth2_Implicit|✗|OAS2,OAS3
217+
|OAuth2_Password|✗|OAS2,OAS3
218+
|OAuth2_ClientCredentials|✗|OAS2,OAS3
219+
|OAuth2_AuthorizationCode|✗|OAS2,OAS3
220+
|SignatureAuth|✗|OAS3
221+
|AWSV4Signature|✗|ToolingExtension
222+
223+
### Wire Format Feature
224+
| Name | Supported | Defined By |
225+
| ---- | --------- | ---------- |
226+
|JSON|✓|OAS2,OAS3
227+
|XML|✗|OAS2,OAS3
228+
|PROTOBUF|✗|ToolingExtension
229+
|Custom|✗|OAS2,OAS3

‎samples/client/petstore/terraform/go.mod‎

Lines changed: 1 addition & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,11 @@
11
module github.com/example/terraform-provider-petstore
22

3-
go 1.24.0
3+
go 1.22
44

55
toolchain go1.24.4
66

77
require (
88
github.com/hashicorp/terraform-plugin-framework v1.17.0
9-
github.com/hashicorp/terraform-plugin-go v0.29.0
109
github.com/hashicorp/terraform-plugin-log v0.10.0
1110
github.com/hashicorp/terraform-plugin-testing v1.14.0
1211
)
13-
14-
require (
15-
github.com/ProtonMail/go-crypto v1.1.6 // indirect
16-
github.com/agext/levenshtein v1.2.2 // indirect
17-
github.com/apparentlymart/go-textseg/v15 v15.0.0 // indirect
18-
github.com/cloudflare/circl v1.6.1 // indirect
19-
github.com/fatih/color v1.16.0 // indirect
20-
github.com/golang/protobuf v1.5.4 // indirect
21-
github.com/google/go-cmp v0.7.0 // indirect
22-
github.com/hashicorp/errwrap v1.0.0 // indirect
23-
github.com/hashicorp/go-checkpoint v0.5.0 // indirect
24-
github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
25-
github.com/hashicorp/go-cty v1.5.0 // indirect
26-
github.com/hashicorp/go-hclog v1.6.3 // indirect
27-
github.com/hashicorp/go-multierror v1.1.1 // indirect
28-
github.com/hashicorp/go-plugin v1.7.0 // indirect
29-
github.com/hashicorp/go-retryablehttp v0.7.7 // indirect
30-
github.com/hashicorp/go-uuid v1.0.3 // indirect
31-
github.com/hashicorp/go-version v1.7.0 // indirect
32-
github.com/hashicorp/hc-install v0.9.2 // indirect
33-
github.com/hashicorp/hcl/v2 v2.24.0 // indirect
34-
github.com/hashicorp/logutils v1.0.0 // indirect
35-
github.com/hashicorp/terraform-exec v0.24.0 // indirect
36-
github.com/hashicorp/terraform-json v0.27.2 // indirect
37-
github.com/hashicorp/terraform-plugin-sdk/v2 v2.38.1 // indirect
38-
github.com/hashicorp/terraform-registry-address v0.4.0 // indirect
39-
github.com/hashicorp/terraform-svchost v0.1.1 // indirect
40-
github.com/hashicorp/yamux v0.1.2 // indirect
41-
github.com/mattn/go-colorable v0.1.13 // indirect
42-
github.com/mattn/go-isatty v0.0.20 // indirect
43-
github.com/mitchellh/copystructure v1.2.0 // indirect
44-
github.com/mitchellh/go-testing-interface v1.14.1 // indirect
45-
github.com/mitchellh/go-wordwrap v1.0.1 // indirect
46-
github.com/mitchellh/mapstructure v1.5.0 // indirect
47-
github.com/mitchellh/reflectwalk v1.0.2 // indirect
48-
github.com/oklog/run v1.1.0 // indirect
49-
github.com/vmihailenco/msgpack v4.0.4+incompatible // indirect
50-
github.com/vmihailenco/msgpack/v5 v5.4.1 // indirect
51-
github.com/vmihailenco/tagparser/v2 v2.0.0 // indirect
52-
github.com/zclconf/go-cty v1.17.0 // indirect
53-
golang.org/x/crypto v0.45.0 // indirect
54-
golang.org/x/mod v0.29.0 // indirect
55-
golang.org/x/net v0.47.0 // indirect
56-
golang.org/x/sync v0.18.0 // indirect
57-
golang.org/x/sys v0.38.0 // indirect
58-
golang.org/x/text v0.31.0 // indirect
59-
golang.org/x/tools v0.38.0 // indirect
60-
google.golang.org/appengine v1.6.8 // indirect
61-
google.golang.org/genproto/googleapis/rpc v0.0.0-20250707201910-8d1bb00bc6a7 // indirect
62-
google.golang.org/grpc v1.75.1 // indirect
63-
google.golang.org/protobuf v1.36.9 // indirect
64-
)

0 commit comments

Comments
 (0)