-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Expand file tree
/
Copy pathexamples.json
More file actions
398 lines (398 loc) · 69.1 KB
/
Copy pathexamples.json
File metadata and controls
398 lines (398 loc) · 69.1 KB
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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
{
"GetOnDemandConcurrencyCap": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"on_demand_concurrency_cap": "number"
},
"type": "string"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>On-demand concurrency cap.</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>On-demand concurrency cap attributes.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">on_demand_concurrency_cap</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Value of the on-demand concurrency cap.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>On-demand concurrency cap type. \nAllowed enum values: <code>on_demand_concurrency_cap</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {},
"json": {},
"html": ""
}
},
"SetOnDemandConcurrencyCap": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"on_demand_concurrency_cap": "number"
},
"type": "string"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>On-demand concurrency cap.</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>On-demand concurrency cap attributes.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">on_demand_concurrency_cap</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Value of the on-demand concurrency cap.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>On-demand concurrency cap type. \nAllowed enum values: <code>on_demand_concurrency_cap</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {},
"json": {
"on_demand_concurrency_cap": "number"
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">on_demand_concurrency_cap</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Value of the on-demand concurrency cap.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"CreateSyntheticsSuite": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {
"alerting_threshold": "number"
},
"public_id": "123-abc-456",
"tags": [
"env:production"
],
"tests": [
{
"alerting_criticality": "critical",
"public_id": ""
}
],
"type": "suite"
}
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Synthetics suite response data</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object containing details about a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">message [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Notification message associated with the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">name [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Name of the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> options [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object describing the extra options for a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_threshold</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Percentage of critical tests failure needed for a suite to fail.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The public ID for the test.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of tags attached to the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tests [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_criticality</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Alerting criticality for each the test. \nAllowed enum values: <code>ignore,critical</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type of the Synthetic suite, <code>suite</code>. \nAllowed enum values: <code>suite</code></p><p>default: <code>suite</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div>\n </div>\n </div></div>"
},
"400": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {},
"tests": [
{
"public_id": ""
}
],
"type": "suite"
},
"type": "suites"
}
},
"json": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {
"alerting_threshold": "number"
},
"tags": [
"env:production"
],
"tests": [
{
"alerting_criticality": "critical",
"public_id": ""
}
],
"type": "suite"
},
"type": "suites"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object containing details about a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">message [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Notification message associated with the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">name [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Name of the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> options [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object describing the extra options for a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_threshold</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Percentage of critical tests failure needed for a suite to fail.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The public ID for the test.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of tags attached to the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tests [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_criticality</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Alerting criticality for each the test. \nAllowed enum values: <code>ignore,critical</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type of the Synthetic suite, <code>suite</code>. \nAllowed enum values: <code>suite</code></p><p>default: <code>suite</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type for the Synthetics suites responses, <code>suites</code>. \nAllowed enum values: <code>suites</code></p><p>default: <code>suites</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
}
},
"DeleteSyntheticsSuites": {
"responses": {
"200": {
"json": {
"data": [
{
"attributes": {
"deleted_at": "string",
"public_id": "string"
},
"id": "string",
"type": "suites"
}
]
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">deleted_at</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Deletion timestamp of the Synthetic suite ID.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The Synthetic suite ID deleted.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type for the Synthetics suites responses, <code>suites</code>. \nAllowed enum values: <code>suites</code></p><p>default: <code>suites</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"400": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {
"data": {
"attributes": {
"public_ids": [
""
]
}
}
},
"json": {
"data": {
"attributes": {
"force_delete_dependencies": false,
"public_ids": [
""
]
},
"id": "string",
"type": "delete_suites_request"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">force_delete_dependencies</p>\n </div>\n <div class=\"col-2 column\"><p>boolean</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_ids [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>default: <code>delete_suites_request</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
}
},
"SearchSuites": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"suites": [
{
"message": "Notification message",
"name": "Example suite name",
"options": {
"alerting_threshold": "number"
},
"public_id": "123-abc-456",
"tags": [
"env:production"
],
"tests": [
{
"alerting_criticality": "critical",
"public_id": ""
}
],
"type": "suite"
}
],
"total": "integer"
},
"id": "string",
"type": "suites_search"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Synthetics suite search response data</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Synthetics suite search response data attributes</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> suites</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">message [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Notification message associated with the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">name [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Name of the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> options [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object describing the extra options for a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_threshold</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Percentage of critical tests failure needed for a suite to fail.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The public ID for the test.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of tags attached to the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tests [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_criticality</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Alerting criticality for each the test. \nAllowed enum values: <code>ignore,critical</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type of the Synthetic suite, <code>suite</code>. \nAllowed enum values: <code>suite</code></p><p>default: <code>suite</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">total</p>\n </div>\n <div class=\"col-2 column\"><p>int32</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">id</p>\n </div>\n <div class=\"col-2 column\"><p>uuid</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>default: <code>suites_search</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
},
"400": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {},
"json": {},
"html": ""
}
},
"GetSyntheticsSuite": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {
"alerting_threshold": "number"
},
"public_id": "123-abc-456",
"tags": [
"env:production"
],
"tests": [
{
"alerting_criticality": "critical",
"public_id": ""
}
],
"type": "suite"
}
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Synthetics suite response data</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object containing details about a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">message [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Notification message associated with the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">name [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Name of the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> options [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object describing the extra options for a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_threshold</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Percentage of critical tests failure needed for a suite to fail.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The public ID for the test.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of tags attached to the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tests [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_criticality</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Alerting criticality for each the test. \nAllowed enum values: <code>ignore,critical</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type of the Synthetic suite, <code>suite</code>. \nAllowed enum values: <code>suite</code></p><p>default: <code>suite</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div>\n </div>\n </div></div>"
},
"404": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {},
"json": {},
"html": ""
}
},
"EditSyntheticsSuite": {
"responses": {
"200": {
"json": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {
"alerting_threshold": "number"
},
"public_id": "123-abc-456",
"tags": [
"env:production"
],
"tests": [
{
"alerting_criticality": "critical",
"public_id": ""
}
],
"type": "suite"
}
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Synthetics suite response data</p></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object containing details about a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">message [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Notification message associated with the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">name [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Name of the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> options [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object describing the extra options for a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_threshold</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Percentage of critical tests failure needed for a suite to fail.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The public ID for the test.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of tags attached to the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tests [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_criticality</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Alerting criticality for each the test. \nAllowed enum values: <code>ignore,critical</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type of the Synthetic suite, <code>suite</code>. \nAllowed enum values: <code>suite</code></p><p>default: <code>suite</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div>\n </div>\n </div></div>"
},
"400": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
},
"429": {
"json": {
"errors": [
"Bad Request"
]
},
"html": "<div class=\"\"><div class=\"row \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">errors [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>A list of errors.</p></div>\n </div>\n \n </div>\n </div></div>"
}
},
"request": {
"json_curl": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {},
"tests": [
{
"public_id": ""
}
],
"type": "suite"
},
"type": "suites"
}
},
"json": {
"data": {
"attributes": {
"message": "Notification message",
"name": "Example suite name",
"options": {
"alerting_threshold": "number"
},
"tags": [
"env:production"
],
"tests": [
{
"alerting_criticality": "critical",
"public_id": ""
}
],
"type": "suite"
},
"type": "suites"
}
},
"html": "<div class=\"\"><div class=\"row hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> data [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> attributes [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object containing details about a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">message [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Notification message associated with the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">name [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>Name of the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> options [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>object</p></div>\n <div class=\"col-6 column\"><p>Object describing the extra options for a Synthetic suite.</p></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_threshold</p>\n </div>\n <div class=\"col-2 column\"><p>double</p></div>\n <div class=\"col-6 column\"><p>Percentage of critical tests failure needed for a suite to fail.</p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none isReadOnly\">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row isReadOnly\">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"><p>The public ID for the test.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">tags</p>\n </div>\n <div class=\"col-2 column\"><p>[string]</p></div>\n <div class=\"col-6 column\"><p>Array of tags attached to the suite.</p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none hasChildData \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row js-collapse-trigger collapse-trigger \">\n <div class=\"col-4 column\">\n <p class=\"key\"><span class=\"toggle-arrow\"><svg width=\"6\" height=\"9\" viewBox=\"0 0 6 9\" fill=\"none\" xmlns=\"http://www.w3.org/2000/svg\"><path d=\"M4.7294 4.45711L0.733399 7.82311L1.1294 8.29111L5.6654 4.45711L1.1294 0.641113L0.751398 1.12711L4.7294 4.45711Z\" fill=\"black\"/></svg></span> tests [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>[object]</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n <div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">alerting_criticality</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Alerting criticality for each the test. \nAllowed enum values: <code>ignore,critical</code></p></div>\n </div>\n \n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">public_id [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>string</p></div>\n <div class=\"col-6 column\"></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type of the Synthetic suite, <code>suite</code>. \nAllowed enum values: <code>suite</code></p><p>default: <code>suite</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div><div class=\"row isNested d-none \">\n <div class=\"col-12 first-column\">\n <div class=\"row first-row \">\n <div class=\"col-4 column\">\n <p class=\"key\">type [<em>required</em>]</p>\n </div>\n <div class=\"col-2 column\"><p>enum</p></div>\n <div class=\"col-6 column\"><p>Type for the Synthetics suites responses, <code>suites</code>. \nAllowed enum values: <code>suites</code></p><p>default: <code>suites</code></p></div>\n </div>\n \n </div>\n </div>\n </div>\n </div></div>"
}
}
}