Skip to content

Commit

Permalink
Add 'enum' property to doc with sample (#354)
Browse files Browse the repository at this point in the history
* Add 'enum' property with sample

* Update schema.md
  • Loading branch information
jprzychodzen authored May 22, 2019
1 parent 9f2d628 commit 141d601
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
Binary file added docs/images/enum-property-ui.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 17 additions & 0 deletions docs/schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,23 @@ Explanation of what the property is or what is used for. Be mindful of good expl

If user does not provide a value, `default` will be used.

### enum

Specifies a list of values, which will be rendered as a dropdown list in the UI form, for the user to select from. Only values in this list are considered valid for this property.

```yaml
some.property:
type: string
title: Test property
description: My Test Property
enum:
- 'Value 1'
- 'Value 2'
- 'Value 3'
```

![Enum property UI](images/enum-property-ui.png)

### minimum

The value has to be greater or equal than `minimum`.
Expand Down

0 comments on commit 141d601

Please sign in to comment.