Skip to content

Commit

Permalink
feat: add docs for type string with options
Browse files Browse the repository at this point in the history
  • Loading branch information
ansgarschulte committed Aug 19, 2024
1 parent 2bf5649 commit 9c1be8b
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
Binary file added docs/img/parameters/string_with_options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/parameter-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,28 @@ Strings are the most fundamental parameter type. They represent arbitrary charac
}
```

### Example with options to represent a drop down field

```json
{
"name": "fullName",
"label": "Full Name",
"type": "string",
"options": [
{
"label": "Jane Doe",
"value": "Jane Doe"
},
{
"label": "Admiral Ackbar",
"value": "Admiral Ackbar"
}
]
}
```

<img src="img/parameters/string_with_options.png" width="512" alt="Screenshot showing what the Steadybit user interface element for a string parameter with options looks like. Depicting a textual label and a text input." />

#### Configuration Value Received in `prepare` Call of Actions

##### With a Value
Expand Down
4 changes: 2 additions & 2 deletions go/action_kit_api/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@
## Releasing

1. Update `CHANGELOG.md`
2. Set the tag: `git tag -a go/action_kit_api/v2.0.2 -m go/action_kit_api/v2.0.2`
3. Push the tag: `git push go/action_kit_api/v2.0.2`
2. Set the tag: `git tag -a go/action_kit_api/v2.9.1 -m go/action_kit_api/v2.9.1`
3. Push the tag: `git push go/action_kit_api/v2.9.1`

0 comments on commit 9c1be8b

Please sign in to comment.