nx3/registry
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

chore: Format repo

Browse Source
This commit is contained in:
Brett Bender
2024-11-28 12:01:47 -06:00
parent ed6719a224
commit 888274bcdb
34 changed files with 58 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
data/schema/SCHEMA-SCHEMA
View File

@@ -23,39 +23,30 @@ mnt-by: NX3-MNT
source: NX3 source: NX3
remarks: # option descriptions remarks: # option descriptions
Attribute names must match /[a-zA-Z]([a-zA-Z0-9_\-]*[a-zA-Z0-9])?/. Attribute names must match /[a-zA-Z]([a-zA-Z0-9_\-]*[a-zA-Z0-9])?/.
+
required required
: object required to have at least one : object required to have at least one
optional optional
: object not required to have at least one : object not required to have at least one
+
single single
: only one of this type allowed : only one of this type allowed
multiple multiple
: more than one of this type allowed : more than one of this type allowed
+
primary primary
: use field as lookup key for lookup : use field as lookup key for lookup
* only one allowed per schema * only one allowed per schema
* does not allow newlines * does not allow newlines
+
schema schema
: use field name as the name of the schema : use field name as the name of the schema
* only one allowed per schema * only one allowed per schema
* does not allow newlines * does not allow newlines
+
lookup lookup
: schema match to use for related record : schema match to use for related record
+
\> option specs \> option specs
: defines the option specifications for the key. : defines the option specifications for the key.
* must come last in option list * must come last in option list
+
[label] string value. A positional string argument required. [label] string value. A positional string argument required.
Text inside brackets represent a label for the string and must match the same rules as attribute names. Text inside brackets represent a label for the string and must match the same rules as attribute names.
If follwed by '...' values are gathered as an array. If follwed by '...' values are gathered as an array.
+
{enum1|enum2|} enumeration. One option in pipe('|') deliniation is allowed. {enum1|enum2|} enumeration. One option in pipe('|') deliniation is allowed.
If there is a trailing pipe it means the enum is optional. Enum values must match the same rules as attribute names. If there is a trailing pipe it means the enum is optional. Enum values must match the same rules as attribute names.
+
'literal' Literal value. literal text value which must not contain any whitespace or single quotes. 'literal' Literal value. literal text value which must not contain any whitespace or single quotes.