upstream/opnsense-docs
1
0
Fork 0
mirror of https://github.com/opnsense/docs.git synced 2026-05-28 04:02:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Development: Frontend: add documentation for DescriptionField and IPPortField types

Browse source
This commit is contained in:
Stephan de Wit 2024-01-11 16:05:55 +01:00
parent a10e5962e6
commit ca43be6a7c
1 changed files with 31 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
source/development/frontend/models_fieldtypes.rst
View file

@ -188,6 +188,19 @@ Select and validate countries in the world.
"AddInverted", "Y,N", "Add 'inverted'/excluded countries to the list, copies contry codes prefixes an :code:`!` (e.g. :code:`!NL`)"
DescriptionField
------------------------------------
Validate if the input contains a valid description, meaning it should be a string of 1 to 255 characters.
.. csv-table:: DescriptionField
:header: "Parameter", "Options", "Purpose"
:widths: 30, 20, 40
"default", ":code:`text`", "Default value for new attributes"
"Required", "Y,N", "Mark field as required"
"ValidationMessage", ":code:`text`", "Error message on validation failure"
EmailField
------------------------------------
@ -272,6 +285,24 @@ should be. It defaults to :code:`lan`
</interfaces>
IPPortField
------------------------------------
Validates an IP:port combination (e.g. :code:`192.168.1.1:22`). Can be used to validate a single item or a list of items and can optionally
enforce either ipv4 or ipv6 addresses.
.. csv-table:: IPPortField
:header: "Parameter", "Options", "Purpose"
:widths: 30, 20, 40
"default", ":code:`text`", "Default value for new attributes"
"Required", "Y,N", "Mark field as required"
"ValidationMessage", ":code:`text`", "Error message on validation failure"
"AsList", "Y,N", "Field type should return list items"
"FieldSeparator", ":code:`text`", "Separator character to use"
"AddressFamily", ":code:`ipv4`, :code:`ipv6`", "Which address family to use, blank means ipv4+ipv6"
JsonKeyValueStoreField
------------------------------------