diff options
Diffstat (limited to 'anastasis.rst')
-rw-r--r-- | anastasis.rst | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/anastasis.rst b/anastasis.rst index caa491d5..94a0d182 100644 --- a/anastasis.rst +++ b/anastasis.rst @@ -1260,27 +1260,27 @@ that must be provided includes: - **type**: The type of the attribute, for now only ``string`` and ``date`` are supported. - - **name**: the name of the attribute, this is the key under which the + - **name**: The name of the attribute, this is the key under which the attribute value must be provided later. The name must be unique per response. - - **label**: a human-readable description of the attribute in English. + - **label**: A human-readable description of the attribute in English. Translated descriptions may be provided under **label_i18n**. - - **uuid**: a UUID that uniquely identifies identical attributes across + - **uuid**: A UUID that uniquely identifies identical attributes across different countries. Useful to preserve values should the user enter some attributes, and then switch to another country. Note that attributes must not be preserved if they merely have the same **name**, only the **uuid** will be identical if the semantics is identicial. - - **widget**: an optional name of a widget that is known to nicely render + - **widget**: An optional name of a widget that is known to nicely render the attribute entry in user interfaces where named widgets are supported. - - **validation-regex**: an optional extended POSIX regular expression + - **validation-regex**: An optional extended POSIX regular expression that is to be used to validate (string) inputs to ensure they are well-formed. - - **validation-logic**: optional name of a function that should be called + - **validation-logic**: Optional name of a function that should be called to validate the input. If the function is not known to the particular client, the respective validation can be skipped (at the expense of typos by users not being detected, possibly rendering secrets irrecoverable). - - **optional**: optional boolean field that, if ``true``, indicates that + - **optional**: Optional boolean field that, if ``true``, indicates that this attribute is not actually required but optional and users MAY leave it blank in case they do not have the requested information. Used for common fields that apply to some large part of the population but are |