Skip to content

Commit c9f8082

Browse files
authored
Merge pull request #117 from spinframework/update-variables-docs
Update manifest variable schema
2 parents 93b1c92 + 6d3d74d commit c9f8082

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

content/v3/manifest-reference.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,13 @@ The keys of the `variables` table are user-defined. The value of each key is an
106106
>
107107
> ```toml
108108
> [variables]
109-
> vessel = { default = "teapot" }
109+
> vessel = { description = "I'm a little teapot!", default = "teapot" }
110110
> token = { required = true, secret = true }
111111
> ```
112112
113113
| Name | Required? | Type | Value | Example |
114114
|-------------------------|------------|-------------|----------|-----------|
115+
| `description` | Optional | String | A brief description of the variable | `This a variable!` |
115116
| `default` | Optional | String | The value of the variable if no value is supplied at runtime. If specified, the value must be a string. If not specified, `required` must be `true`. | `"teapot"` |
116117
| `required` | Optional | Boolean | Whether a value must be supplied at runtime. If not specified, `required` defaults to `false`, and `default` must be provided | `false` |
117118
| `secret` | Optional | Boolean | If set, this variable should be treated as sensitive. | `false` |

0 commit comments

Comments
 (0)