Skip to content

Commit 7aa85df

Browse files
jhuckabyjhuckaby
committed
Docs: Change array formatting to not use any HTML metacharacters.
1 parent f016141 commit 7aa85df

5 files changed

Lines changed: 35 additions & 29 deletions

File tree

‎docs/actions.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Parameters:
9090

9191
| Name | Type | Required | Description |
9292
|------|------|----------|-------------|
93-
| `users` | Array<String> | Optional | Array of [User.username](data.md#user-username) values to email. |
93+
| `users` | Array(String) | Optional | Array of [User.username](data.md#user-username) values to email. |
9494
| `email` | String | Optional | One or more additional recipients, comma-separated. |
9595
| `body` | String | Optional | Optionally customize the email subject and body using Markdown (see [Custom Email](#custom-email) below). |
9696

@@ -323,8 +323,8 @@ Parameters:
323323
| Name | Type | Required | Description |
324324
|------|------|----------|-------------|
325325
| `ticket_type` | String | Yes | See [Ticket.type](data.md#ticket-type) (e.g., `issue`, `task`, etc.). |
326-
| `ticket_assignees` | Array<String> | Yes | Array of [User.username](data.md#user-username) assignees. |
327-
| `ticket_tags` | Array<String> | Optional | Array of [Tag.id](data.md#tag-id) values. |
326+
| `ticket_assignees` | Array(String) | Yes | Array of [User.username](data.md#user-username) assignees. |
327+
| `ticket_tags` | Array(String) | Optional | Array of [Tag.id](data.md#tag-id) values. |
328328

329329
Example (job error):
330330

@@ -399,7 +399,7 @@ Parameters:
399399

400400
| Name | Type | Required | Description |
401401
|------|------|----------|-------------|
402-
| `users` | Array<String> | Optional | Array of [User.username](data.md#user-username) values to email. |
402+
| `users` | Array(String) | Optional | Array of [User.username](data.md#user-username) values to email. |
403403
| `email` | String | Optional | One or more additional recipients, comma-separated. |
404404
| `web_hook` | String | Optional | [WebHook.id](data.md#webhook-id) to fire on suspension. |
405405
| `text` | String | Optional | Extra text appended to the suspension web hook message. |

‎docs/api.md‎

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -709,7 +709,7 @@ Parameters:
709709

710710
| Property Name | Type | Description |
711711
|---------------|------|-------------|
712-
| `items` | Array<Object> | **(Required)** Array of objects, each with an `id` and the new `sort_order`. |
712+
| `items` | Array(Object) | **(Required)** Array of objects, each with an `id` and the new `sort_order`. |
713713

714714
Example request:
715715

@@ -1681,7 +1681,7 @@ Parameters:
16811681

16821682
| Property Name | Type | Description |
16831683
|---------------|------|-------------|
1684-
| `items` | Array<Object> | **(Required)** Array of objects, each with an `id` and the new `sort_order`. |
1684+
| `items` | Array(Object) | **(Required)** Array of objects, each with an `id` and the new `sort_order`. |
16851685

16861686
Example request:
16871687

@@ -1908,7 +1908,7 @@ Parameters:
19081908

19091909
| Property Name | Type | Description |
19101910
|---------------|------|-------------|
1911-
| `ids` | Array<String> | **(Required)** Array of [Job.id](data.md#job-id) values. |
1911+
| `ids` | Array(String) | **(Required)** Array of [Job.id](data.md#job-id) values. |
19121912
| `verbose` | Boolean | Optional. If `true`, includes heavy fields; otherwise they are pruned. |
19131913

19141914
Example request:
@@ -2170,7 +2170,7 @@ Parameters:
21702170
| Property Name | Type | Description |
21712171
|---------------|------|-------------|
21722172
| `id` | String | **(Required)** The [Job.id](data.md#job-id). |
2173-
| `tags` | Array<String> | **(Required)** Full replacement list of tags for the job. |
2173+
| `tags` | Array(String) | **(Required)** Full replacement list of tags for the job. |
21742174

21752175
Example request:
21762176

@@ -2482,7 +2482,7 @@ Parameters:
24822482

24832483
| Property Name | Type | Description |
24842484
|---------------|------|-------------|
2485-
| `items` | Array<Object> | **(Required)** Array of objects, each with an `id` and the new `sort_order`. |
2485+
| `items` | Array(Object) | **(Required)** Array of objects, each with an `id` and the new `sort_order`. |
24862486

24872487
Example request:
24882488

@@ -3355,6 +3355,10 @@ Example response:
33553355

33563356
In addition to the [Standard Response Format](#standard-response-format), this will include an `items` array containing per-day records with `epoch`, human-readable `date`, and the selected `data` subtree, plus a `list` object containing list metadata.
33573357

3358+
### bulk_search_export
3359+
3360+
3361+
33583362
### marketplace
33593363

33603364
```
@@ -5282,10 +5286,10 @@ Parameters (choose either the high-level selectors or a custom `items` array):
52825286

52835287
| Property Name | Type | Description |
52845288
|---------------|------|-------------|
5285-
| `lists` | Array<String> or String | List IDs from `config.ui.list_list` or the literal string `"all"`. Each exports the corresponding `global/NAME` list and pages. |
5286-
| `indexes` | Array<String> or String | Database index IDs from `config.ui.database_list` or `"all"`. Exports matching DB records (newest to oldest). |
5287-
| `extras` | Array<String> or String | Optional extras or `"all"`. Supported: `user_avatars`, `job_files`, `job_logs`, `monitor_data`, `stat_data`. |
5288-
| `items` | Array<Object> | Advanced mode. Array of export items such as `{ type: "list", key }`, `{ type: "index", index, query?, max_rows? }`, `{ type: "users", avatars? }`, `{ type: "jobFiles", query?, max_rows?, max_size?, logs?, files? }`, `{ type: "monitorData", query? }`, `{ type: "bucketData" }`, `{ type: "bucketFiles", max_size? }`, `{ type: "secretData" }`. |
5289+
| `lists` | Array(String) or String | List IDs from `config.ui.list_list` or the literal string `"all"`. Each exports the corresponding `global/NAME` list and pages. |
5290+
| `indexes` | Array(String) or String | Database index IDs from `config.ui.database_list` or `"all"`. Exports matching DB records (newest to oldest). |
5291+
| `extras` | Array(String) or String | Optional extras or `"all"`. Supported: `user_avatars`, `job_files`, `job_logs`, `monitor_data`, `stat_data`. |
5292+
| `items` | Array(Object) | Advanced mode. Array of export items such as `{ type: "list", key }`, `{ type: "index", index, query?, max_rows? }`, `{ type: "users", avatars? }`, `{ type: "jobFiles", query?, max_rows?, max_size?, logs?, files? }`, `{ type: "monitorData", query? }`, `{ type: "bucketData" }`, `{ type: "bucketFiles", max_size? }`, `{ type: "secretData" }`. |
52895293
| `token` | String | Single-use token from [get_transfer_token](#get_transfer_token). When present, parameters from the token are applied and the token is invalidated. |
52905294

52915295
Response: A `200 OK` streaming gzip file. The content is NDJSON containing a mix of:
@@ -5312,7 +5316,7 @@ Parameters:
53125316

53135317
| Property Name | Type | Description |
53145318
|---------------|------|-------------|
5315-
| `items` | Array<Object> | **(Required)** Array of delete actions. Supported types: `{ type: "list", key }`, `{ type: "index", index, query? }`, `{ type: "users" }`, `{ type: "bucketData" }`, `{ type: "bucketFiles" }`, `{ type: "secretData" }`. |
5319+
| `items` | Array(Object) | **(Required)** Array of delete actions. Supported types: `{ type: "list", key }`, `{ type: "index", index, query? }`, `{ type: "users" }`, `{ type: "bucketData" }`, `{ type: "bucketFiles" }`, `{ type: "secretData" }`. |
53165320

53175321
Example request:
53185322

‎docs/limits.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ Parameters:
7373
|------|------|----------|-------------|
7474
| `type` | String | Yes | Set to `time` for max run time. |
7575
| `duration` | Number | Yes | Maximum runtime in seconds. |
76-
| `tags` | Array<String> | Optional | Apply these [Tag.id](data.md#tag-id) values when exceeded. |
77-
| `users` | Array<String> | Optional | Email these [User.username](data.md#user-username) users. |
76+
| `tags` | Array(String) | Optional | Apply these [Tag.id](data.md#tag-id) values when exceeded. |
77+
| `users` | Array(String) | Optional | Email these [User.username](data.md#user-username) users. |
7878
| `email` | String | Optional | Additional comma-separated email addresses. |
7979
| `web_hook` | String | Optional | Fire this [WebHook.id](data.md#webhook-id) when exceeded. |
8080
| `text` | String | Optional | Custom text appended to the web hook message. |
@@ -134,8 +134,8 @@ Parameters:
134134
|------|------|----------|-------------|
135135
| `type` | String | Yes | Set to `log` for max output size. |
136136
| `amount` | Number | Yes | Maximum bytes of output/log content. |
137-
| `tags` | Array<String> | Optional | Apply these tags when exceeded. |
138-
| `users` | Array<String> | Optional | Email these users. |
137+
| `tags` | Array(String) | Optional | Apply these tags when exceeded. |
138+
| `users` | Array(String) | Optional | Email these users. |
139139
| `email` | String | Optional | Additional comma-separated email addresses. |
140140
| `web_hook` | String | Optional | Fire this web hook. |
141141
| `text` | String | Optional | Custom text appended to the web hook message. |
@@ -165,8 +165,8 @@ Parameters:
165165
| `type` | String | Yes | Set to `mem` for max memory limit. |
166166
| `amount` | Number | Yes | Maximum memory in bytes. |
167167
| `duration` | Number | Yes | Sustain time in seconds over the limit before triggering. |
168-
| `tags` | Array<String> | Optional | Apply these tags when exceeded. |
169-
| `users` | Array<String> | Optional | Email these users. |
168+
| `tags` | Array(String) | Optional | Apply these tags when exceeded. |
169+
| `users` | Array(String) | Optional | Email these users. |
170170
| `email` | String | Optional | Additional comma-separated email addresses. |
171171
| `web_hook` | String | Optional | Fire this web hook. |
172172
| `text` | String | Optional | Custom text appended to the web hook message. |
@@ -198,8 +198,8 @@ Parameters:
198198
| `type` | String | Yes | Set to `cpu` for max CPU limit. |
199199
| `amount` | Number | Yes | CPU percentage, where `100` equals one core fully utilized. |
200200
| `duration` | Number | Yes | Sustain time in seconds over the limit before triggering. |
201-
| `tags` | Array<String> | Optional | Apply these tags when exceeded. |
202-
| `users` | Array<String> | Optional | Email these users. |
201+
| `tags` | Array(String) | Optional | Apply these tags when exceeded. |
202+
| `users` | Array(String) | Optional | Email these users. |
203203
| `email` | String | Optional | Additional comma-separated email addresses. |
204204
| `web_hook` | String | Optional | Fire this web hook. |
205205
| `text` | String | Optional | Custom text appended to the web hook message. |

‎docs/triggers.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ Parameters:
8686

8787
| Name | Type | Required | Description |
8888
|------|------|----------|-------------|
89-
| `years` | Array<Number> | Optional | One or more years in YYYY format. |
90-
| `months` | Array<Number> | Optional | Months 1-12 (Jan=1 ... Dec=12). |
91-
| `days` | Array<Number> | Optional | Month days 1-31, or reverse month days −1 to −7 (−1 = last day, −2 = second-to-last, etc.). |
92-
| `weekdays` | Array<Number> | Optional | Weekdays 0-6 (Sun=0 ... Sat=6). |
93-
| `hours` | Array<Number> | Optional | Hours 0-23 (24-hour clock). |
94-
| `minutes` | Array<Number> | Optional | Minutes 0-59. |
89+
| `years` | Array(Number) | Optional | One or more years in YYYY format. |
90+
| `months` | Array(Number) | Optional | Months 1-12 (Jan=1 ... Dec=12). |
91+
| `days` | Array(Number) | Optional | Month days 1-31, or reverse month days −1 to −7 (−1 = last day, −2 = second-to-last, etc.). |
92+
| `weekdays` | Array(Number) | Optional | Weekdays 0-6 (Sun=0 ... Sat=6). |
93+
| `hours` | Array(Number) | Optional | Hours 0-23 (24-hour clock). |
94+
| `minutes` | Array(Number) | Optional | Minutes 0-59. |
9595
| `timezone` | String | Optional | IANA timezone for evaluating the schedule (defaults to server timezone). |
9696

9797
Notes:
@@ -323,7 +323,7 @@ Parameters:
323323

324324
| Name | Type | Required | Description |
325325
|------|------|----------|-------------|
326-
| `seconds` | Array<Number> | Yes | One or more second offsets within 0-59. |
326+
| `seconds` | Array(Number) | Yes | One or more second offsets within 0-59. |
327327

328328
Notes:
329329

‎htdocs/css/style.css‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1015,6 +1015,8 @@ body.dark div.box_unit {
10151015

10161016
/* Misc */
10171017

1018+
object { display: none; }
1019+
10181020
div.header_title.error {
10191021
font-size: 27px;
10201022
color: var(--red);

0 commit comments

Comments
 (0)