1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
# Forms Schema
Since MongoDB has no set schema, we document it here to document what our objects should look like. If you add new properties or remove them from objects **make sure to update them here**.
In this document:
- [Form structure](#form-structure)
- [Form features](#form-features)
- [Form question](#form-question)
## Form structure
| Field | Type | Description | Example |
| ----------- | ---------------------------------------- | ----------------------------------------------------------------------------------------- | --------------------------- |
| `id` | Unique identifier | A user selected, unique, descriptive identifier (used in URL routes, so no spaces) | `"ban-appeals"` |
| `features` | List of [form features](#form-features) | A list of features to change the behaviour of the form, described in the features section | `["OPEN", "COLLECT_EMAIL"]` |
| `questions` | List of [form questions](#form-question) | The list of questions to render on a specific form | Too long! See below |
| | | | |
### Form features
| Flag | Description |
| ------------------ | ----------------------------------------------------------------------------- |
| `DISCOVERABLE` | The form should be displayed on the homepage of the forms application. |
| `REQUIRES_LOGIN` | Requires the user to authenticate with Discord before completing the form. |
| `OPEN` | The form is currently accepting responses. |
| `COLLECT_EMAIL` | The form should collect the email from submissions. Requires `REQUIRES_LOGIN` |
| `DISABLE_ANTISPAM` | Disable the anti-spam checks from running on a form submission. |
### Form question
| Field | Type | Description | Example |
| ------ | ---------------------------------------- | ------------------------------------------------ | -------------------- |
| `id` | string | Unique identifier of the question | `"aabbcc"` |
| `name` | string | Name of the question | `"What's the time?"` |
| `type` | one of [Question types](#question-types) | The type of input for this question | `"radio"` |
| `data` | [Question specific data](#question-data) | Any specific data for the question type selected | Documented below |
#### Question types
| Name | Description |
| ------------ | --------------------------------------------------------- |
| `radio` | Radio buttons |
| `checkbox` | Checkbox toggle |
| `select` | Dropdown list |
| `short_text` | One line input field |
| `textarea` | Long text input |
| `code` | Syntax highlighted code input |
| `range` | Horizontal drag slider |
| `section` | Not an input, just a section of text to explain something |
#### Question data
Different questions require different input data to render. All data is in an object with keys and values as defined in the below tables. **All fields are required unless stated otherwise**.
##### `radio`
```js
{
// Option list for radio buttons
"options": [
"Spam",
"Eggs",
"Ham"
]
}
```
##### `checkbox`
Checkboxes require no additional configuration
##### `select`
```js
{
// Option list for select dropdown
"options": [
"United Kingdom",
"United States"
]
}
```
##### `short_text`
Short text fields require no additional configuration.
##### `textarea`
Textareas require no additional configuration.
##### `code`
```js
{
// A supported language from https://prismjs.com/#supported-languages
"language": "python"
}
```
##### `range`
```js
{
// A list of options to put on the range, from left to right
"options": [
"Not at all",
"Not much",
"A little",
"A lot"
]
}
```
##### `section`
```js
{
// OPTIONAL: Additional text to place below the section header
"text": "This section will quiz you on A, B and C"
}
```
|
