mirror of
https://github.com/terraform-docs/terraform-docs.git
synced 2026-03-27 12:58:35 +07:00
253 lines
7.3 KiB
Plaintext
253 lines
7.3 KiB
Plaintext
<module>
|
|
<header></header>
|
|
<footer></footer>
|
|
<inputs>
|
|
<input>
|
|
<name>unquoted</name>
|
|
<type>any</type>
|
|
<description xsi:nil="true"></description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>bool-3</name>
|
|
<type>bool</type>
|
|
<description xsi:nil="true"></description>
|
|
<default>true</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>bool-2</name>
|
|
<type>bool</type>
|
|
<description>It's bool number two.</description>
|
|
<default>false</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>bool-1</name>
|
|
<type>bool</type>
|
|
<description>It's bool number one.</description>
|
|
<default>true</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>string-3</name>
|
|
<type>string</type>
|
|
<description xsi:nil="true"></description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>string-2</name>
|
|
<type>string</type>
|
|
<description>It's string number two.</description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>string-1</name>
|
|
<type>string</type>
|
|
<description>It's string number one.</description>
|
|
<default>bar</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>string-special-chars</name>
|
|
<type>string</type>
|
|
<description xsi:nil="true"></description>
|
|
<default>\.<>[]{}_-</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>number-3</name>
|
|
<type>number</type>
|
|
<description xsi:nil="true"></description>
|
|
<default>19</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>number-4</name>
|
|
<type>number</type>
|
|
<description xsi:nil="true"></description>
|
|
<default>15.75</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>number-2</name>
|
|
<type>number</type>
|
|
<description>It's number number two.</description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>number-1</name>
|
|
<type>number</type>
|
|
<description>It's number number one.</description>
|
|
<default>42</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>map-3</name>
|
|
<type>map</type>
|
|
<description xsi:nil="true"></description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>map-2</name>
|
|
<type>map</type>
|
|
<description>It's map number two.</description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>map-1</name>
|
|
<type>map</type>
|
|
<description>It's map number one.</description>
|
|
<default>
|
|
<a>1</a>
|
|
<b>2</b>
|
|
<c>3</c>
|
|
</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>list-3</name>
|
|
<type>list</type>
|
|
<description xsi:nil="true"></description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>list-2</name>
|
|
<type>list</type>
|
|
<description>It's list number two.</description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>list-1</name>
|
|
<type>list</type>
|
|
<description>It's list number one.</description>
|
|
<default>
|
|
<item>a</item>
|
|
<item>b</item>
|
|
<item>c</item>
|
|
</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>input_with_underscores</name>
|
|
<type>any</type>
|
|
<description>A variable with underscores.</description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>input-with-pipe</name>
|
|
<type>string</type>
|
|
<description>It includes v1 | v2 | v3</description>
|
|
<default>v1</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>input-with-code-block</name>
|
|
<type>list</type>
|
|
<description>This is a complicated one. We need a newline. 
And an example in a code block
```
default = [
 "machine rack01:neptune"
]
```
</description>
|
|
<default>
|
|
<item>name rack:location</item>
|
|
</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>long_type</name>
|
|
<type>object({
 name = string,
 foo = object({ foo = string, bar = string }),
 bar = object({ foo = string, bar = string }),
 fizz = list(string),
 buzz = list(string)
 })</type>
|
|
<description>This description is itself markdown.

It spans over multiple lines.
</description>
|
|
<default>
|
|
<bar>
|
|
<bar>bar</bar>
|
|
<foo>bar</foo>
|
|
</bar>
|
|
<buzz>
|
|
<item>fizz</item>
|
|
<item>buzz</item>
|
|
</buzz>
|
|
<fizz></fizz>
|
|
<foo>
|
|
<bar>foo</bar>
|
|
<foo>foo</foo>
|
|
</foo>
|
|
<name>hello</name>
|
|
</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>no-escape-default-value</name>
|
|
<type>string</type>
|
|
<description>The description contains `something_with_underscore`. Defaults to 'VALUE_WITH_UNDERSCORE'.</description>
|
|
<default>VALUE_WITH_UNDERSCORE</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>with-url</name>
|
|
<type>string</type>
|
|
<description>The description contains url. https://www.domain.com/foo/bar_baz.html</description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>string_default_empty</name>
|
|
<type>string</type>
|
|
<description xsi:nil="true"></description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>string_default_null</name>
|
|
<type>string</type>
|
|
<description xsi:nil="true"></description>
|
|
<default xsi:nil="true"></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>string_no_default</name>
|
|
<type>string</type>
|
|
<description xsi:nil="true"></description>
|
|
<default xsi:nil="true"></default>
|
|
<required>true</required>
|
|
</input>
|
|
<input>
|
|
<name>number_default_zero</name>
|
|
<type>number</type>
|
|
<description xsi:nil="true"></description>
|
|
<default>0</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>bool_default_false</name>
|
|
<type>bool</type>
|
|
<description xsi:nil="true"></description>
|
|
<default>false</default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>list_default_empty</name>
|
|
<type>list(string)</type>
|
|
<description xsi:nil="true"></description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
<input>
|
|
<name>object_default_empty</name>
|
|
<type>object({})</type>
|
|
<description xsi:nil="true"></description>
|
|
<default></default>
|
|
<required>false</required>
|
|
</input>
|
|
</inputs>
|
|
<modules></modules>
|
|
<outputs></outputs>
|
|
<providers></providers>
|
|
<requirements></requirements>
|
|
<resources></resources>
|
|
</module> |