Skip to content

Commit

Permalink
(docs) expand more on the "default" field for parameters (#2927)
Browse files Browse the repository at this point in the history
* update document to expand on param defaults

Signed-off-by: schristoff <[email protected]>

* make docs better

Signed-off-by: schristoff <[email protected]>

---------

Signed-off-by: schristoff <[email protected]>
  • Loading branch information
schristoff authored Oct 17, 2023
1 parent 6c5683a commit b63338b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/content/wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ You can also provide any other attributes, as specified by the CNAB [parameters]
default: "wordpress"
```

If you decide to use the default parameter field, you must set it as the empty value.
However, it must be passed in as an empty type. For example, for an empty string, pass in `""` as the default, or for an object use `{}`:

```yaml
- name: command
type: object
default: {}
```

### File Parameters

Porter also enables the use of file parameters in a bundle.
Expand Down

0 comments on commit b63338b

Please sign in to comment.