mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
38e18970ed
* Introduce format interface and expose to public pkg * fix issues after merge * don't panic * Rename TFString back to String
21 lines
1.8 KiB
Plaintext
21 lines
1.8 KiB
Plaintext
## Inputs
|
|
|
|
| Name | Description | Type | Default |
|
|
|------|-------------|------|---------|
|
|
| unquoted | n/a | `any` | n/a |
|
|
| string-3 | n/a | `string` | `""` |
|
|
| string-2 | It's string number two. | `string` | n/a |
|
|
| string-1 | It's string number one. | `string` | `"bar"` |
|
|
| map-3 | n/a | `map` | `{}` |
|
|
| map-2 | It's map number two. | `map` | n/a |
|
|
| map-1 | It's map number one. | `map` | <pre>{<br> "a": 1,<br> "b": 2,<br> "c": 3<br>}</pre> |
|
|
| list-3 | n/a | `list` | `[]` |
|
|
| list-2 | It's list number two. | `list` | n/a |
|
|
| list-1 | It's list number one. | `list` | <pre>[<br> "a",<br> "b",<br> "c"<br>]</pre> |
|
|
| input_with_underscores | A variable with underscores. | `any` | n/a |
|
|
| input-with-pipe | It includes v1 \| v2 \| v3 | `string` | `"v1"` |
|
|
| input-with-code-block | This is a complicated one. We need a newline.<br>And an example in a code block<pre>default = [<br> "machine rack01:neptune"<br>]</pre> | `list` | <pre>[<br> "name rack:location"<br>]</pre> |
|
|
| long_type | This description is itself markdown.<br><br>It spans over multiple lines. | <pre>object({<br> name = string,<br> foo = object({ foo = string, bar = string }),<br> bar = object({ foo = string, bar = string }),<br> fizz = list(string),<br> buzz = list(string)<br> })</pre> | <pre>{<br> "bar": {<br> "bar": "bar",<br> "foo": "bar"<br> },<br> "buzz": [<br> "fizz",<br> "buzz"<br> ],<br> "fizz": [],<br> "foo": {<br> "bar": "foo",<br> "foo": "foo"<br> },<br> "name": "hello"<br>}</pre> |
|
|
| no-escape-default-value | The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'. | `string` | `"VALUE_WITH_UNDERSCORE"` |
|
|
| with-url | The description contains url. https://www.domain.com/foo/bar_baz.html | `string` | `""` |
|