-
-
Notifications
You must be signed in to change notification settings - Fork 8
/
swagger.yaml
378 lines (377 loc) · 9.51 KB
/
swagger.yaml
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
openapi: 3.0.0
info:
title: Live Changes API
description: REST API documentation for the JMeter plugin "Live Changes Config". For more info, head over to our [GitHub repository](https://www.github.com/delirius325/jmeter-live-changes-config)
version: 0.1.0
servers:
- url: http://your.host.com/v1
description: This is a test url meant to represent your host. The only valid part in this is the /v1 path
paths:
/healthcheck:
get:
summary: Simple healthcheck endpoint
tags:
- Health
responses:
'200': # status code
description: OK
content:
text/plain:
schema:
type: string
example: "connected"
/threads:
get:
summary: Returns info about all thread groups
tags:
- Threads
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AllThreadsResponse'
/threads/{threadName}:
get:
summary: Get thread group info by name
tags:
- Threads
parameters:
- in: path
name: threadName
schema:
type: string
required: true
description: Name of the thread group to retrieve
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/SingleThreadResponse'
post:
summary: Modify/Update a thread group by its' name
tags:
- Threads
parameters:
- in: path
name: threadName
schema:
type: string
required: true
description: Name of the thread group to modify
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyThreadRequest'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyThreadResponse'
/test/status:
get:
summary: Retrieves the status of the running test (duration, running time, etc.)
tags:
- Test
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestStatus'
/test/end:
get:
summary: Signals JMeter to stop the test
tags:
- Test
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestEnd'
/test/summary:
get:
summary: Returns a summary of the results at the time of query
tags:
- Test
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/TestSummary'
/variables:
get:
summary: Returns all the current variables
tags:
- Variables
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetVariables'
post:
summary: Modifies the variables specified in the request body
tags:
- Variables
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyVariablesReq'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyVariablesRes'
/properties:
get:
summary: Returns all the current properties
tags:
- Properties
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/GetProperties'
post:
summary: Modifies the properties sent in the request body
tags:
- Properties
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyPropertiesReq'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ModifyPropertiesRes'
components:
schemas:
AllThreadsResponse:
type: array
items:
type: object
properties:
threadGroup:
type: object
properties:
scheduler:
type: object
properties:
duration:
type: integer
delay:
type: integer
onErrorStopThread:
type: boolean
isEnabled:
type: boolean
onErrorStopTestNow:
type: boolean
comment:
type: string
onErrorStartNextLoop:
type: boolean
rampUp:
type: integer
SingleThreadResponse:
type: object
properties:
threadGroup:
type: object
properties:
scheduler:
type: object
properties:
duration:
type: integer
delay:
type: integer
onErrorStopThread:
type: boolean
isEnabled:
type: boolean
onErrorStopTestNow:
type: boolean
comment:
type: string
onErrorStartNextLoop:
type: boolean
rampUp:
type: integer
ModifyThreadRequest:
type: object
properties:
threadNum:
type: integer
example: 3
ModifyThreadResponse:
type: object
properties:
description:
type: string
example: "Changed number of active threads."
threadNum:
type: integer
example: 3
info:
type: string
example: "success"
TestStatus:
type: object
properties:
totalThreads:
type: integer
example: 8
startTime:
type: integer
example: 1598550485316
runningTime:
type: integer
example: 30
totalActiveThreads:
type: integer
example: 8
TestEnd:
type: object
properties:
description:
type: string
example: "Threads will gracefully stop."
info:
type: string
example: "success"
TestSummary:
type: array
items:
type: object
properties:
averageLatency:
type: integer
example: 65
averageResponseTime:
type: integer
example: 189
minResponseTime:
type: integer
example: 160
maxResponseTime:
type: integer
example: 503
hitsPerSecond:
type: number
example: 4.98
sentBytesPerSecond:
type: number
example: 1125.41
totalErrors:
type: integer
example: 0
errorPercentage:
type: number
example: 0.0
receivedBytesPerSecond:
type: number
example: 70391.25
90thPercentile:
type: integer
example: 234
totalSamples:
type: integer
example: 162
totalBytes:
type: integer
example: 2289968
averageBytes:
type: number
example: 14135.6
standardDeviation:
type: number
example: 62.85
GetVariables:
type: object
properties:
START.MS:
type: integer
example: 1598550473118
TESTSTART.MS:
type: integer
example: 1598550485316
JMeterThread.last_sample_ok:
type: boolean
example: true
all_other_variables_will_show_here:
type: boolean
example: true
ModifyVariablesReq:
type: object
properties:
my_variable_name:
type: string
example: "my_new_value"
ModifyVariablesRes:
type: object
properties:
description:
type: string
example: "Variables were changed."
my_variable_name:
type: string
example: "my_new_value"
info:
type: string
example: "success"
GetProperties:
type: object
properties:
beanshell.server.file:
type: string
example: "../extras/startup.bsh"
cookies:
type: string
example: "cookies"
all_other_properties_will_show_here:
type: boolean
example: true
ModifyPropertiesReq:
type: object
properties:
my_property_name:
type: string
example: "my_new_value"
ModifyPropertiesRes:
type: object
properties:
description:
type: string
example: "Properties were changed."
my_variable_name:
type: string
example: "my_new_value"
info:
type: string
example: "success"