Skip to content

Commit 141d601

Browse files
authored
Add 'enum' property to doc with sample (#354)
* Add 'enum' property with sample * Update schema.md
1 parent 9f2d628 commit 141d601

File tree

2 files changed

+17
-0
lines changed

2 files changed

+17
-0
lines changed

docs/images/enum-property-ui.png

3.55 KB
Loading

docs/schema.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -223,6 +223,23 @@ Explanation of what the property is or what is used for. Be mindful of good expl
223223

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

226+
### enum
227+
228+
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.
229+
230+
```yaml
231+
some.property:
232+
type: string
233+
title: Test property
234+
description: My Test Property
235+
enum:
236+
- 'Value 1'
237+
- 'Value 2'
238+
- 'Value 3'
239+
```
240+
241+
![Enum property UI](images/enum-property-ui.png)
242+
226243
### minimum
227244

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

0 commit comments

Comments
 (0)