8
8
| [ ** river** ] ( #river ) | ` object ` | Config is the configuration for the river server<br />||
9
9
10
10
** Additional Properties:** not allowed
11
+ ** Example**
12
+
13
+ ``` json
14
+ {
15
+ "river" : {
16
+ "queues" : [
17
+ {}
18
+ ],
19
+ "workers" : {
20
+ "emailWorker" : {
21
+ "config" : {}
22
+ },
23
+ "databaseWorker" : {
24
+ "config" : {}
25
+ },
26
+ "createCustomDomainWorker" : {
27
+ "config" : {}
28
+ },
29
+ "validateCustomDomainWorker" : {
30
+ "Config" : {}
31
+ },
32
+ "deleteCustomDomainWorker" : {
33
+ "config" : {}
34
+ },
35
+ "exportContentWorker" : {
36
+ "config" : {}
37
+ },
38
+ "deleteExportContentWorker" : {
39
+ "config" : {}
40
+ }
41
+ }
42
+ }
43
+ }
44
+ ```
45
+
11
46
<a name =" river " ></a >
12
47
## river: object
13
48
@@ -23,11 +58,52 @@ Config is the configuration for the river server
23
58
| [ ** workers** ] ( #riverworkers ) | ` object ` | Workers that will be enabled on the server<br />||
24
59
25
60
** Additional Properties:** not allowed
61
+ ** Example**
62
+
63
+ ``` json
64
+ {
65
+ "queues" : [
66
+ {}
67
+ ],
68
+ "workers" : {
69
+ "emailWorker" : {
70
+ "config" : {}
71
+ },
72
+ "databaseWorker" : {
73
+ "config" : {}
74
+ },
75
+ "createCustomDomainWorker" : {
76
+ "config" : {}
77
+ },
78
+ "validateCustomDomainWorker" : {
79
+ "Config" : {}
80
+ },
81
+ "deleteCustomDomainWorker" : {
82
+ "config" : {}
83
+ },
84
+ "exportContentWorker" : {
85
+ "config" : {}
86
+ },
87
+ "deleteExportContentWorker" : {
88
+ "config" : {}
89
+ }
90
+ }
91
+ }
92
+ ```
93
+
26
94
<a name =" riverqueues " ></a >
27
95
### river\. queues: array
28
96
29
97
** Items**
30
98
99
+ ** Example**
100
+
101
+ ``` json
102
+ [
103
+ {}
104
+ ]
105
+ ```
106
+
31
107
<a name =" riverworkers " ></a >
32
108
### river\. workers: object
33
109
@@ -47,6 +123,34 @@ Workers that will be enabled on the server
47
123
| [ ** deleteExportContentWorker** ] ( #riverworkersdeleteexportcontentworker ) | ` object ` |||
48
124
49
125
** Additional Properties:** not allowed
126
+ ** Example**
127
+
128
+ ``` json
129
+ {
130
+ "emailWorker" : {
131
+ "config" : {}
132
+ },
133
+ "databaseWorker" : {
134
+ "config" : {}
135
+ },
136
+ "createCustomDomainWorker" : {
137
+ "config" : {}
138
+ },
139
+ "validateCustomDomainWorker" : {
140
+ "Config" : {}
141
+ },
142
+ "deleteCustomDomainWorker" : {
143
+ "config" : {}
144
+ },
145
+ "exportContentWorker" : {
146
+ "config" : {}
147
+ },
148
+ "deleteExportContentWorker" : {
149
+ "config" : {}
150
+ }
151
+ }
152
+ ```
153
+
50
154
<a name =" riverworkersemailworker " ></a >
51
155
#### river\. workers\. emailWorker: object
52
156
@@ -60,6 +164,14 @@ EmailWorker is a worker to send emails using the resend email provider the confi
60
164
| [ ** config** ] ( #riverworkersemailworkerconfig ) | ` object ` | EmailConfig contains the configuration for the email worker<br />||
61
165
62
166
** Additional Properties:** not allowed
167
+ ** Example**
168
+
169
+ ``` json
170
+ {
171
+ "config" : {}
172
+ }
173
+ ```
174
+
63
175
<a name =" riverworkersemailworkerconfig " ></a >
64
176
##### river\. workers\. emailWorker\. config: object
65
177
@@ -89,6 +201,14 @@ DatabaseWorker is a worker to create a dedicated database for an organization
89
201
| [ ** config** ] ( #riverworkersdatabaseworkerconfig ) | ` object ` |||
90
202
91
203
** Additional Properties:** not allowed
204
+ ** Example**
205
+
206
+ ``` json
207
+ {
208
+ "config" : {}
209
+ }
210
+ ```
211
+
92
212
<a name =" riverworkersdatabaseworkerconfig " ></a >
93
213
##### river\. workers\. databaseWorker\. config: object
94
214
@@ -109,16 +229,25 @@ DatabaseWorker is a worker to create a dedicated database for an organization
109
229
110
230
| Name| Type| Description| Required|
111
231
| ----| ----| -----------| --------|
112
- | [ ** Config ** ] ( #riverworkerscreatecustomdomainworkerconfig ) | ` object ` |||
232
+ | [ ** config ** ] ( #riverworkerscreatecustomdomainworkerconfig ) | ` object ` |||
113
233
114
234
** Additional Properties:** not allowed
235
+ ** Example**
236
+
237
+ ``` json
238
+ {
239
+ "config" : {}
240
+ }
241
+ ```
242
+
115
243
<a name =" riverworkerscreatecustomdomainworkerconfig " ></a >
116
- ##### river\. workers\. createCustomDomainWorker\. Config : object
244
+ ##### river\. workers\. createCustomDomainWorker\. config : object
117
245
118
246
** Properties**
119
247
120
248
| Name| Type| Description| Required|
121
249
| ----| ----| -----------| --------|
250
+ | ** enabled** | ` boolean ` |||
122
251
| ** cloudflareApiKey** | ` string ` |||
123
252
| ** openlaneAPIHost** | ` string ` |||
124
253
| ** openlaneAPIToken** | ` string ` |||
@@ -135,13 +264,22 @@ DatabaseWorker is a worker to create a dedicated database for an organization
135
264
| [ ** Config** ] ( #riverworkersvalidatecustomdomainworkerconfig ) | ` object ` |||
136
265
137
266
** Additional Properties:** not allowed
267
+ ** Example**
268
+
269
+ ``` json
270
+ {
271
+ "Config" : {}
272
+ }
273
+ ```
274
+
138
275
<a name =" riverworkersvalidatecustomdomainworkerconfig " ></a >
139
276
##### river\. workers\. validateCustomDomainWorker\. Config: object
140
277
141
278
** Properties**
142
279
143
280
| Name| Type| Description| Required|
144
281
| ----| ----| -----------| --------|
282
+ | ** enabled** | ` boolean ` |||
145
283
| ** cloudflareApiKey** | ` string ` |||
146
284
| ** openlaneAPIHost** | ` string ` |||
147
285
| ** openlaneAPIToken** | ` string ` |||
@@ -155,16 +293,25 @@ DatabaseWorker is a worker to create a dedicated database for an organization
155
293
156
294
| Name| Type| Description| Required|
157
295
| ----| ----| -----------| --------|
158
- | [ ** Config ** ] ( #riverworkersdeletecustomdomainworkerconfig ) | ` object ` |||
296
+ | [ ** config ** ] ( #riverworkersdeletecustomdomainworkerconfig ) | ` object ` |||
159
297
160
298
** Additional Properties:** not allowed
299
+ ** Example**
300
+
301
+ ``` json
302
+ {
303
+ "config" : {}
304
+ }
305
+ ```
306
+
161
307
<a name =" riverworkersdeletecustomdomainworkerconfig " ></a >
162
- ##### river\. workers\. deleteCustomDomainWorker\. Config : object
308
+ ##### river\. workers\. deleteCustomDomainWorker\. config : object
163
309
164
310
** Properties**
165
311
166
312
| Name| Type| Description| Required|
167
313
| ----| ----| -----------| --------|
314
+ | ** enabled** | ` boolean ` |||
168
315
| ** cloudflareApiKey** | ` string ` |||
169
316
| ** openlaneAPIHost** | ` string ` |||
170
317
| ** openlaneAPIToken** | ` string ` |||
@@ -181,13 +328,22 @@ DatabaseWorker is a worker to create a dedicated database for an organization
181
328
| [ ** config** ] ( #riverworkersexportcontentworkerconfig ) | ` object ` |||
182
329
183
330
** Additional Properties:** not allowed
331
+ ** Example**
332
+
333
+ ``` json
334
+ {
335
+ "config" : {}
336
+ }
337
+ ```
338
+
184
339
<a name =" riverworkersexportcontentworkerconfig " ></a >
185
340
##### river\. workers\. exportContentWorker\. config: object
186
341
187
342
** Properties**
188
343
189
344
| Name| Type| Description| Required|
190
345
| ----| ----| -----------| --------|
346
+ | ** enabled** | ` boolean ` |||
191
347
| ** openlaneAPIHost** | ` string ` |||
192
348
| ** openlaneAPIToken** | ` string ` |||
193
349
@@ -202,13 +358,23 @@ DatabaseWorker is a worker to create a dedicated database for an organization
202
358
| [ ** config** ] ( #riverworkersdeleteexportcontentworkerconfig ) | ` object ` || yes|
203
359
204
360
** Additional Properties:** not allowed
361
+ ** Example**
362
+
363
+ ``` json
364
+ {
365
+ "config" : {}
366
+ }
367
+ ```
368
+
205
369
<a name =" riverworkersdeleteexportcontentworkerconfig " ></a >
206
370
##### river\. workers\. deleteExportContentWorker\. config: object
207
371
208
372
** Properties**
209
373
210
374
| Name| Type| Description| Required|
211
375
| ----| ----| -----------| --------|
376
+ | ** enabled** | ` boolean ` || no|
377
+ | ** interval** | ` integer ` || yes|
212
378
| ** openlaneAPIHost** | ` string ` || no|
213
379
| ** openlaneAPIToken** | ` string ` || no|
214
380
| ** cutoffDuration** | ` integer ` || yes|
0 commit comments