diff options
| author | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-12-23 16:14:25 +0100 |
|---|---|---|
| committer | Elena ``of Valhalla'' Grandi <valhalla@trueelena.org> | 2021-12-23 16:14:25 +0100 |
| commit | 81d91de68170396e12d75525a96439a280f95aa7 (patch) | |
| tree | c3dde3749f71a9f0784fcc260db0d95931d7c0b2 | |
| parent | f37ef6193eaf8c02272c656314e615e6d3ae0a02 (diff) | |
Document the values property
| -rw-r--r-- | CHANGELOG.rst | 2 | ||||
| -rw-r--r-- | docs/source/user/settings.rst | 10 |
2 files changed, 12 insertions, 0 deletions
diff --git a/CHANGELOG.rst b/CHANGELOG.rst index c01bd47..4f51190 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -20,6 +20,8 @@ Unreleased first 12 entries (possibly according to a default sorting setting). * New collection example: ticket_tracker. * Add support for bash autocompletion via argcomplete, if installed. +* Add support for the ``values`` property in the settings, to limit the + contents of a field. Bugfixes -------- diff --git a/docs/source/user/settings.rst b/docs/source/user/settings.rst index e951621..565ae73 100644 --- a/docs/source/user/settings.rst +++ b/docs/source/user/settings.rst @@ -108,3 +108,13 @@ Some field types may add other custom properties. Other clients may decide to use a different workflow. +``values`` +---------- + +The ``string``, ``text``, ``list`` and numeric types can have a property +``value`` with a list of valid values for that field. + +An empty value is always allowed. + +For the ``list`` type, each element of the list is checked, not the +whole list. |