From 81d91de68170396e12d75525a96439a280f95aa7 Mon Sep 17 00:00:00 2001 From: Elena ``of Valhalla'' Grandi Date: Thu, 23 Dec 2021 16:14:25 +0100 Subject: Document the values property --- CHANGELOG.rst | 2 ++ docs/source/user/settings.rst | 10 ++++++++++ 2 files changed, 12 insertions(+) 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. -- cgit v1.2.3