Param¶
The param object is the lowest level building block. It is a simple key/value pair. Each param is a bounded type parameter, and type definition is enforced.
Field | Definition |
---|---|
Description | Description is a string for providing a simple description |
Documentation | Documentation is a string for providing additional in depth information. |
Meta | Meta contains the meta data of the object. The type of this field is a key / value map/dictionary. The key type is string. The value type is also string. The general content of the field is undefined and can be an arbritary store. There are some common known keys: color - The color the UX uses when displaying icon - The icon the UX uses when displaying * title - The UX uses this for additional display information. Often the source of the object. Specific Object types use additional meta data fields. These are described at: https://docs.rackn.io/stable/redirect/?ref=rs_object_metadata |
Name | Name is the name of the param. Params must be uniquely named. required: true |
Schema | Schema must be a valid JSONSchema as of draft v4. required: true |
Secure | Secure implies that any API interactions with this Param will deal with SecureData values. required: true |
Some example types that can be used with Schema:
Type | Description |
---|---|
integer | A numerical value (eg 12 or -3444 ) |
boolean | True or False (true or false ) |
string | Textual string (eg "this is a string!" ) |
array | A series of elements of the same type |
map | A higher-order function that applies a given function to each element of a list, returning a list of results in the same order. |