Skip to content

Commit 9ce6bac

Browse files
committed
RFC-002: update
- specify "link" for all entities - allow giving forced values for properties - rename datainfo "members" to "dataprops"
1 parent 797fc96 commit 9ce6bac

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

rfcs/RFC-002-schemata.rst

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,10 @@ Each entity has a few common fields:
6161
The entity's unique name.
6262
``version``
6363
The version of the definition, as a simple integer.
64+
``link``
65+
A URL linking to the description of the entity. Optional.
6466
``description``
65-
A human-readable description. Optional.
67+
A human-readable description.
6668

6769
Then, depending on the ``kind``, different keys can be present:
6870

@@ -121,14 +123,17 @@ SECoP extensions".
121123
Specification of the property's `JSON type`_.
122124
``optional``
123125
Boolean, if the property is by default optional.
126+
``value``
127+
If present, forces the property's value to be this - this is mainly
128+
useful for Systems.
124129

125130
**For datainfos:**
126131

127132
``dataty``
128133
Specification of the datainfo's `JSON type`_ (i.e. transport layer).
129-
``members``
130-
A dictionary of members of the datainfo specification. Each member can have
131-
the following properties:
134+
``dataprops``
135+
A dictionary of data properties of the datainfo specification. Each one
136+
can have the following properties:
132137

133138
``dataty``
134139
Specification of the datainfo property's `JSON type`_.
@@ -319,7 +324,7 @@ Datainfo
319324

320325
``datainfo`` entries are either strings (the name of the datainfo entity) or
321326
dictionaries with a key ``type`` (the name of the datainfo entity) and all
322-
members of the respective datainfo.
327+
dataprops of the respective datainfo.
323328

324329
``"any"`` is allowed for unspecified datainfos.
325330

0 commit comments

Comments
 (0)