/
nested_id_attribute.txtar
381 lines (314 loc) · 15.1 KB
/
nested_id_attribute.txtar
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
# Copyright (c) HashiCorp, Inc.
# SPDX-License-Identifier: MPL-2.0
# Ensure only root level id attribute receives automatic description
[!unix] skip
exec tfplugindocs --provider-name=terraform-provider-scaffolding --providers-schema=schema.json
cmp stdout expected-output.txt
cmp docs/index.md expected-index.md
cmp docs/resources/example.md expected-resource.md
-- expected-output.txt --
rendering website for provider "terraform-provider-scaffolding" (as "terraform-provider-scaffolding")
exporting schema from JSON file
getting provider schema
generating missing templates
generating missing resource content
generating new template for "scaffolding_example"
generating missing data source content
generating missing function content
generating missing provider content
generating new template for "terraform-provider-scaffolding"
rendering static website
cleaning rendered website dir
rendering templated website to static markdown
rendering "index.md.tmpl"
rendering "resources/example.md.tmpl"
-- expected-index.md --
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding Provider"
subcategory: ""
description: |-
Example provider
---
# scaffolding Provider
Example provider
<!-- schema generated by tfplugindocs -->
## Schema
### Optional
- `endpoint` (String) Example provider attribute
-- expected-resource.md --
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "scaffolding_example Resource - terraform-provider-scaffolding"
subcategory: ""
description: |-
example resource
---
# scaffolding_example (Resource)
example resource
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `required_object_attribute` (Object) example required object attribute (see [below for nested schema](#nestedatt--required_object_attribute))
### Optional
- `list_nested_block_optional_id` (Block List) example list nested block with optional id attribute (see [below for nested schema](#nestedblock--list_nested_block_optional_id))
- `list_nested_block_required_id` (Block List) example list nested block with required id attribute (see [below for nested schema](#nestedblock--list_nested_block_required_id))
- `optional_object_attribute` (Object) example optional object attribute (see [below for nested schema](#nestedatt--optional_object_attribute))
- `set_nested_block_optional_id` (Block Set) example set nested block with optional id attribute (see [below for nested schema](#nestedblock--set_nested_block_optional_id))
- `set_nested_block_required_id` (Block Set) example set nested block with required id attribute (see [below for nested schema](#nestedblock--set_nested_block_required_id))
- `single_nested_block_optional_id` (Block, Optional) example single nested block with optional id attribute (see [below for nested schema](#nestedblock--single_nested_block_optional_id))
- `single_nested_block_required_id` (Block, Optional) example single nested block with required id attribute (see [below for nested schema](#nestedblock--single_nested_block_required_id))
### Read-Only
- `computed_object_attribute` (Object) example computed object attribute (see [below for nested schema](#nestedatt--computed_object_attribute))
- `id` (String) The ID of this resource.
- `list_nested_block_computed_id` (Block List) example list nested block with computed id attribute (see [below for nested schema](#nestedblock--list_nested_block_computed_id))
- `set_nested_block_computed_id` (Block Set) example set nested block with computed id attribute (see [below for nested schema](#nestedblock--set_nested_block_computed_id))
- `single_nested_block_computed_id` (Block, Read-only) example single nested block with computed id attribute (see [below for nested schema](#nestedblock--single_nested_block_computed_id))
<a id="nestedatt--required_object_attribute"></a>
### Nested Schema for `required_object_attribute`
Required:
- `id` (String)
<a id="nestedblock--list_nested_block_optional_id"></a>
### Nested Schema for `list_nested_block_optional_id`
Optional:
- `id` (String)
<a id="nestedblock--list_nested_block_required_id"></a>
### Nested Schema for `list_nested_block_required_id`
Required:
- `id` (String)
<a id="nestedatt--optional_object_attribute"></a>
### Nested Schema for `optional_object_attribute`
Optional:
- `id` (String)
<a id="nestedblock--set_nested_block_optional_id"></a>
### Nested Schema for `set_nested_block_optional_id`
Optional:
- `id` (String)
<a id="nestedblock--set_nested_block_required_id"></a>
### Nested Schema for `set_nested_block_required_id`
Required:
- `id` (String)
<a id="nestedblock--single_nested_block_optional_id"></a>
### Nested Schema for `single_nested_block_optional_id`
Optional:
- `id` (String)
<a id="nestedblock--single_nested_block_required_id"></a>
### Nested Schema for `single_nested_block_required_id`
Required:
- `id` (String)
<a id="nestedatt--computed_object_attribute"></a>
### Nested Schema for `computed_object_attribute`
Read-Only:
- `id` (String)
<a id="nestedblock--list_nested_block_computed_id"></a>
### Nested Schema for `list_nested_block_computed_id`
Read-Only:
- `id` (String)
<a id="nestedblock--set_nested_block_computed_id"></a>
### Nested Schema for `set_nested_block_computed_id`
Read-Only:
- `id` (String)
<a id="nestedblock--single_nested_block_computed_id"></a>
### Nested Schema for `single_nested_block_computed_id`
Read-Only:
- `id` (String)
-- schema.json --
{
"format_version": "1.0",
"provider_schemas": {
"registry.terraform.io/hashicorp/scaffolding": {
"provider": {
"version": 0,
"block": {
"attributes": {
"endpoint": {
"type": "string",
"description": "Example provider attribute",
"description_kind": "plain",
"optional": true
}
},
"description": "Example provider",
"description_kind": "plain"
}
},
"resource_schemas": {
"scaffolding_example": {
"version": 0,
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"computed": true
},
"computed_object_attribute": {
"type": [
"object",
{
"id": "string"
}
],
"description": "example computed object attribute",
"description_kind": "plain",
"computed": true
},
"optional_object_attribute": {
"type": [
"object",
{
"id": "string"
}
],
"description": "example optional object attribute",
"description_kind": "plain",
"optional": true
},
"required_object_attribute": {
"type": [
"object",
{
"id": "string"
}
],
"description": "example required object attribute",
"description_kind": "plain",
"required": true
}
},
"block_types": {
"list_nested_block_computed_id": {
"nesting_mode": "list",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"computed": true
}
},
"description": "example list nested block with computed id attribute",
"description_kind": "plain"
}
},
"list_nested_block_optional_id": {
"nesting_mode": "list",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"optional": true
}
},
"description": "example list nested block with optional id attribute",
"description_kind": "plain"
}
},
"list_nested_block_required_id": {
"nesting_mode": "list",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"required": true
}
},
"description": "example list nested block with required id attribute",
"description_kind": "plain"
}
},
"set_nested_block_computed_id": {
"nesting_mode": "set",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"computed": true
}
},
"description": "example set nested block with computed id attribute",
"description_kind": "plain"
}
},
"set_nested_block_optional_id": {
"nesting_mode": "set",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"optional": true
}
},
"description": "example set nested block with optional id attribute",
"description_kind": "plain"
}
},
"set_nested_block_required_id": {
"nesting_mode": "set",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"required": true
}
},
"description": "example set nested block with required id attribute",
"description_kind": "plain"
}
},
"single_nested_block_computed_id": {
"nesting_mode": "single",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"computed": true
}
},
"description": "example single nested block with computed id attribute",
"description_kind": "plain"
}
},
"single_nested_block_optional_id": {
"nesting_mode": "single",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"optional": true
}
},
"description": "example single nested block with optional id attribute",
"description_kind": "plain"
}
},
"single_nested_block_required_id": {
"nesting_mode": "single",
"block": {
"attributes": {
"id": {
"type": "string",
"description_kind": "plain",
"required": true
}
},
"description": "example single nested block with required id attribute",
"description_kind": "plain"
}
}
},
"description": "example resource",
"description_kind": "plain"
}
}
}
}
}
}