Skip to content

Commit ba2f605

Browse files
committed
Data Structures Doc: Indicate that IDs must be lowercase alphanumeric.
1 parent 41312f0 commit ba2f605

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

docs/data.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ An alert definition is a trigger that specifies conditions under which the alert
2828

2929
### Alert.id
3030

31-
A unique alphanumeric ID for the alert.
31+
A unique lowercase alphanumeric ID for the alert.
3232

3333
### Alert.title
3434

@@ -114,7 +114,7 @@ An API Key is a unique identifier used to authenticate requests. Here is an API
114114

115115
### APIKey.id
116116

117-
A unique alphanumeric ID for the API Key.
117+
A unique lowercase alphanumeric ID for the API Key.
118118

119119
### APIKey.key
120120

@@ -182,7 +182,7 @@ Note that the bucket user data and files are stored separately, outside of the b
182182

183183
### Bucket.id
184184

185-
A unique alphanumeric ID for the bucket.
185+
A unique lowercase alphanumeric ID for the bucket.
186186

187187
### Bucket.title
188188

@@ -248,7 +248,7 @@ A category is a way to group related events together. Each event can belong to
248248

249249
### Category.id
250250

251-
A unique alphanumeric ID for the category.
251+
A unique lowercase alphanumeric ID for the category.
252252

253253
### Category.enabled
254254

@@ -326,7 +326,7 @@ A notification channel is a way to send notifications to a group of users, and t
326326

327327
### Channel.id
328328

329-
A unique alphanumeric ID for the channel.
329+
A unique lowercase alphanumeric ID for the channel.
330330

331331
### Channel.title
332332

@@ -434,7 +434,7 @@ Events have the following properties:
434434

435435
### Event.id
436436

437-
A unique alphanumeric ID for the event.
437+
A unique lowercase alphanumeric ID for the event.
438438

439439
### Event.title
440440

@@ -534,7 +534,7 @@ A server group is a collection of servers, usually auto-matched by hostname, but
534534

535535
### Group.id
536536

537-
A unique alphanumeric ID for the group.
537+
A unique lowercase alphanumeric ID for the group.
538538

539539
### Group.title
540540

@@ -582,7 +582,7 @@ And these additions:
582582

583583
### Job.id
584584

585-
An auto-generated, unique, alphanumeric ID for the job, which will always start with a `j`.
585+
An auto-generated, unique, lowercase alphanumeric ID for the job, which will always start with a `j`.
586586

587587
### Job.type
588588

@@ -893,7 +893,7 @@ A monitor keeps track on a specific numeric server metric. These are graphed in
893893

894894
### Monitor.id
895895

896-
A unique alphanumeric ID for the monitor.
896+
A unique lowercase alphanumeric ID for the monitor.
897897

898898
### Monitor.title
899899

@@ -998,7 +998,7 @@ Plugins are used to extend xyOps in a variety of ways, including custom event ac
998998

999999
### Plugin.id
10001000

1001-
A unique alphanumeric ID for the plugin.
1001+
A unique lowercase alphanumeric ID for the plugin.
10021002

10031003
### Plugin.title
10041004

@@ -1030,7 +1030,7 @@ A set of custom parameters to pass to the plugin when it is executed (for non-mo
10301030

10311031
| Property Name | Type | Description |
10321032
|---------------|------|-------------|
1033-
| `id` | String | A lower-case alphanumeric ID for the parameter (can also contain underscores). |
1033+
| `id` | String | A lowercase alphanumeric ID for the parameter (can also contain underscores). |
10341034
| `title` | String | A visual title for the parameter, displayed in the UI. |
10351035
| `type` | String | The parameter type ID, which should be one of: `text`, `textarea`, `code`, `checkbox`, `select`, `hidden`, or `toolset`. |
10361036
| `variant` | String | For `text` type controls, you can optionally set a UI input variant: `color`, `date`, `datetime-local`, `email`, `number`, `password`, `text`, `time`, `tel` or `url`. |
@@ -1106,7 +1106,7 @@ A user role is a set of privileges assigned to a user within the system. A user
11061106

11071107
### Role.id
11081108

1109-
A unique alphanumeric ID for the role.
1109+
A unique lowercase alphanumeric ID for the role.
11101110

11111111
### Role.title
11121112

@@ -1185,7 +1185,7 @@ A secret is a collection of key/value pairs which are all stored using strong en
11851185

11861186
### Secret.id
11871187

1188-
A unique alphanumeric ID for the secret.
1188+
A unique lowercase alphanumeric ID for the secret.
11891189

11901190
### Secret.title
11911191

@@ -1560,7 +1560,7 @@ This array contains a list of all the changes made to the ticket, including thin
15601560

15611561
| Property Name | Type | Description |
15621562
|---------------|------|-------------|
1563-
| `id` | String | A unique alphanumeric ID for the change. |
1563+
| `id` | String | A unique lowercase alphanumeric ID for the change. |
15641564
| `type` | String | The change type, which should be one of: `change` or `comment`. |
15651565
| `username` | String | The username of the user who made the change. |
15661566
| `date` | Number | The Unix timestamp of the change. |
@@ -1893,7 +1893,7 @@ Each activity type (denoted by the `action` property) may have different custom
18931893

18941894
### Activity.id
18951895

1896-
A unique alphanumeric ID which is automatically assigned when the activity is logged.
1896+
A unique lowercase alphanumeric ID which is automatically assigned when the activity is logged.
18971897

18981898
### Activity.action
18991899

@@ -2550,7 +2550,7 @@ A snapshot is a record of everything happening on a server for a specific instan
25502550

25512551
### Snapshot.id
25522552

2553-
A unique alphanumeric ID automatically generated for the snapshot.
2553+
A unique lowercase alphanumeric ID automatically generated for the snapshot.
25542554

25552555
### Snapshot.type
25562556

@@ -2610,7 +2610,7 @@ Snapshots may be taken of entire server groups, which uses the following structu
26102610

26112611
### GroupSnapshot.id
26122612

2613-
A unique alphanumeric ID automatically generated for the snapshot.
2613+
A unique lowercase alphanumeric ID automatically generated for the snapshot.
26142614

26152615
### GroupSnapshot.type
26162616

@@ -3092,7 +3092,7 @@ A workflow node is an object which represents an event, an ad-hoc job, a trigger
30923092

30933093
#### WorkflowNode.id
30943094

3095-
A unique alphanumeric ID for the node, which is automatically assigned when created. Workflow Node IDs will always start with `n`.
3095+
A unique lowercase alphanumeric ID for the node, which is automatically assigned when created. Workflow Node IDs will always start with `n`.
30963096

30973097
#### WorkflowNode.type
30983098

@@ -3145,7 +3145,7 @@ A workflow connection object represents a connection between two nodes (rendered
31453145

31463146
#### WorkflowConnection.id
31473147

3148-
A unique alphanumeric ID for the connection, which is automatically assigned when created. Workflow Connection IDs will always start with `c`.
3148+
A unique lowercase alphanumeric ID for the connection, which is automatically assigned when created. Workflow Connection IDs will always start with `c`.
31493149

31503150
#### WorkflowConnection.source
31513151

0 commit comments

Comments
 (0)