Skip to content

Update manifest variable schema #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update manifest variable schema #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion content/v3/manifest-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,12 +106,13 @@ The keys of the `variables` table are user-defined. The value of each key is an
>
> ```toml
> [variables]
> vessel = { default = "teapot" }
> vessel = { description = "I'm a little teapot!", default = "teapot" }
> token = { required = true, secret = true }
> ```

| Name | Required? | Type | Value | Example |
|-------------------------|------------|-------------|----------|-----------|
| `description` | Optional | String | A brief description of the variable | `This a variable!` |
| `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"` |
| `required` | Optional | Boolean | Whether a value must be supplied at runtime. If not specified, `required` defaults to `false`, and `default` must be provided | `false` |
| `secret` | Optional | Boolean | If set, this variable should be treated as sensitive. | `false` |
Expand Down