-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1595 lines (1536 loc) · 50 KB
/
openapi.yaml
File metadata and controls
1595 lines (1536 loc) · 50 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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: h2agent Management API
description: |
REST API to manage h2agent mock behavior for HTTP/2 traffic testing.
All operations are served under the `/admin/v1/` base path on the
management port (default 8074).
version: "1.0"
license:
name: MIT
url: https://opensource.org/licenses/MIT
contact:
name: h2agent
url: https://github.com/testillano/h2agent
servers:
- url: http://localhost:8074
description: Default management endpoint
tags:
- name: schema
description: Validation schemas management
- name: vault
description: Vaults management
- name: files
description: Processed files information
- name: logging
description: Logging configuration
- name: configuration
description: General and server configuration
- name: server-matching
description: Traffic server matching configuration
- name: server-provision
description: Traffic server provision configuration
- name: server-data
description: Traffic server data storage
- name: client-endpoint
description: Client endpoints configuration
- name: client-provision
description: Client provision configuration
- name: client-data
description: Client data storage
paths:
# ===== GENERAL =====
/admin/v1/schema:
post:
tags: [schema]
summary: Load validation schema(s)
description: >
Loads schema(s) for future event validation. Schemas can be
referenced within provision configurations by their string
identifier. Accepts a single object or an array for bulk load.
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/SchemaConfig'
- type: array
items:
$ref: '#/components/schemas/SchemaConfig'
responses:
'201':
description: Schema(s) created
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
get:
tags: [schema]
summary: Retrieve all configured schemas
responses:
'200':
description: Schemas retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SchemaConfig'
'204':
description: No schemas configured
delete:
tags: [schema]
summary: Delete all schemas
responses:
'200':
description: Schemas deleted
'204':
description: No schemas to delete
/admin/v1/schema/schema:
get:
tags: [schema]
summary: Retrieve the schema operation schema
responses:
'200':
description: Schema definition retrieved
content:
application/json:
schema:
type: object
/admin/v1/vault:
post:
tags: [vault]
summary: Load vaults
description: >
Creates or updates vaults. Variables are string-valued
and interpreted as numbers or other types depending on the
transformation involved.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/VaultMap'
responses:
'201':
description: Variables created
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
get:
tags: [vault]
summary: Retrieve vaults
description: >
Without query parameter returns all variables as a JSON object.
With `name` parameter returns the specific variable value as
plain string.
parameters:
- name: name
in: query
description: Variable name to retrieve
schema:
type: string
responses:
'200':
description: Variable(s) retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/VaultMap'
text/plain:
schema:
type: string
description: Single variable value (when name parameter is used)
'204':
description: No variables stored
'400':
description: Bad request (invalid name)
delete:
tags: [vault]
summary: Delete vaults
description: >
Deletes all vaults or a specific one when the `name`
query parameter is provided.
parameters:
- name: name
in: query
description: Variable name to delete
schema:
type: string
responses:
'200':
description: Variable(s) deleted
'204':
description: No variables to delete
'400':
description: Bad request
/admin/v1/vault/schema:
get:
tags: [vault]
summary: Retrieve the vaults schema
responses:
'200':
description: Schema retrieved
content:
application/json:
schema:
type: object
/admin/v1/vault/{key}/wait:
get:
tags: [vault]
summary: Block until a vault changes
description: >
Long-poll endpoint that blocks until the specified vault
changes from its current value (any change) or reaches a specific
target value. Returns immediately if the condition is already met.
parameters:
- name: key
in: path
required: true
description: Vault name to watch
schema:
type: string
- name: value
in: query
description: >
Target value to wait for. When omitted, any change from the
current value triggers return.
schema:
type: string
- name: timeoutMs
in: query
description: Maximum wait time in milliseconds (capped at 300000)
schema:
type: integer
default: 30000
responses:
'200':
description: Condition met
content:
application/json:
schema:
$ref: '#/components/schemas/VaultWaitResponse'
'408':
description: Timeout — condition not met within the specified time
content:
application/json:
schema:
$ref: '#/components/schemas/VaultWaitResponse'
'429':
description: Too many concurrent waiters (max 32)
/admin/v1/files:
get:
tags: [files]
summary: Retrieve processed files list
responses:
'200':
description: Files list retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FileInfo'
'204':
description: No files processed
/admin/v1/logging:
get:
tags: [logging]
summary: Retrieve current logging level
responses:
'200':
description: Current log level
content:
text/plain:
schema:
$ref: '#/components/schemas/LogLevel'
put:
tags: [logging]
summary: Change logging level
parameters:
- name: level
in: query
required: true
schema:
$ref: '#/components/schemas/LogLevel'
responses:
'200':
description: Log level updated
'400':
description: Invalid log level
/admin/v1/health:
get:
tags: [health]
summary: Health check for liveness and readiness probes
responses:
'200':
description: Service is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: healthy
/admin/v1/configuration:
get:
tags: [configuration]
summary: Retrieve general process configuration
responses:
'200':
description: Configuration retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/GeneralConfiguration'
/admin/v1/server/configuration:
put:
tags: [configuration]
summary: Update server configuration
description: >
Controls request body reception and memory pre-reservation.
Useful to optimize server processing when request body content
is not needed by provisions.
parameters:
- name: receiveRequestBody
in: query
schema:
type: boolean
- name: preReserveRequestBody
in: query
schema:
type: boolean
responses:
'200':
description: Configuration updated
'400':
description: Bad request
get:
tags: [configuration]
summary: Retrieve server configuration
responses:
'200':
description: Server configuration retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ServerConfiguration'
# ===== SERVER MOCK =====
/admin/v1/server-matching:
post:
tags: [server-matching]
summary: Configure server matching algorithm
description: >
Defines the matching procedure for incoming receptions.
Three algorithms available: FullMatching (direct key lookup),
FullMatchingRegexReplace (regex transform then lookup),
RegexMatching (sequential regex matching with priority).
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ServerMatching'
responses:
'201':
description: Matching configured
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
get:
tags: [server-matching]
summary: Retrieve current server matching configuration
responses:
'200':
description: Matching configuration retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ServerMatching'
/admin/v1/server-matching/schema:
get:
tags: [server-matching]
summary: Retrieve the server matching schema
responses:
'200':
description: Schema retrieved
content:
application/json:
schema:
type: object
/admin/v1/server-provision:
post:
tags: [server-provision]
summary: Configure server provision(s)
description: >
Defines response behavior for incoming requests matching
conditions (method, uri) with programmable response (headers,
code, body) and optional transformation pipeline. Accepts a
single object or an array for bulk provisioning.
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ServerProvision'
- type: array
items:
$ref: '#/components/schemas/ServerProvision'
responses:
'201':
description: Provision(s) created
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
get:
tags: [server-provision]
summary: Retrieve all server provisions
responses:
'200':
description: Provisions retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServerProvision'
'204':
description: No provisions configured
delete:
tags: [server-provision]
summary: Delete all server provisions
responses:
'200':
description: Provisions deleted
'204':
description: No provisions to delete
/admin/v1/server-provision/schema:
get:
tags: [server-provision]
summary: Retrieve the server provision schema
responses:
'200':
description: Schema retrieved
content:
application/json:
schema:
type: object
/admin/v1/server-provision/unused:
get:
tags: [server-provision]
summary: Retrieve unused server provisions
description: >
Returns provisions that have not been matched yet. Useful for
troubleshooting unnecessary provisions during test development.
responses:
'200':
description: Unused provisions retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ServerProvision'
'204':
description: No unused provisions
/admin/v1/server-data/configuration:
put:
tags: [server-data]
summary: Update server data storage configuration
description: >
Controls event storage behavior. Valid combinations:
discard=true&discardKeyHistory=true (nothing stored),
discard=false&discardKeyHistory=true (last event per key only),
discard=false&discardKeyHistory=false (full history).
disablePurge controls purge execution independently.
parameters:
- name: discard
in: query
schema:
type: boolean
- name: discardKeyHistory
in: query
schema:
type: boolean
- name: disablePurge
in: query
schema:
type: boolean
responses:
'200':
description: Configuration updated
'400':
description: Invalid combination (discard=true with discardKeyHistory=false)
get:
tags: [server-data]
summary: Retrieve server data storage configuration
responses:
'200':
description: Configuration retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/DataStorageConfiguration'
/admin/v1/server-data:
get:
tags: [server-data]
summary: Retrieve server data events
description: >
Returns stored server events. Without parameters returns all data.
Filter by requestMethod+requestUri, optionally narrow with
eventNumber and eventPath. URI parameter may need URL-encoding
if it contains query parameters.
parameters:
- name: requestMethod
in: query
description: HTTP method filter (must be provided with requestUri)
schema:
type: string
enum: [POST, GET, PUT, DELETE, HEAD]
- name: requestUri
in: query
description: Request URI filter (URL-encoded if contains query params)
schema:
type: string
- name: eventNumber
in: query
description: "Event position: 1..N chronological, -1..-N reverse"
schema:
type: integer
- name: eventPath
in: query
description: JSON pointer path within the selected event
schema:
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema: {}
'204':
description: No data found
'400':
description: Bad request (incomplete parameters)
delete:
tags: [server-data]
summary: Delete server data events
description: >
Deletes stored events. Without parameters deletes all.
Filter with requestMethod+requestUri, optionally eventNumber.
parameters:
- name: requestMethod
in: query
schema:
type: string
enum: [POST, GET, PUT, DELETE, HEAD]
- name: requestUri
in: query
schema:
type: string
- name: eventNumber
in: query
schema:
type: integer
responses:
'200':
description: Data deleted
'204':
description: No data to delete
'400':
description: Bad request
/admin/v1/server-data/summary:
get:
tags: [server-data]
summary: Retrieve server data summary
description: >
Returns summary information about stored events including
total keys, total events, and a limited list of displayed keys.
parameters:
- name: maxKeys
in: query
description: Maximum number of keys to display
schema:
type: integer
responses:
'200':
description: Summary retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/ServerDataSummary'
# ===== CLIENT MOCK =====
/admin/v1/client-endpoint:
post:
tags: [client-endpoint]
summary: Define client endpoint(s)
description: >
Defines client endpoint with remote server connection info.
Endpoints connect on creation (unless lazy mode). Accepts a
single object or an array for bulk configuration. Updating
host/port/secure on existing id returns 202 and reconnects.
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientEndpoint'
- type: array
items:
$ref: '#/components/schemas/ClientEndpoint'
responses:
'201':
description: Endpoint(s) created
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'202':
description: Endpoint updated (connection re-created)
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
get:
tags: [client-endpoint]
summary: Retrieve client endpoints
description: >
Returns all configured client endpoints with an additional
status field indicating current connection status.
responses:
'200':
description: Endpoints retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientEndpoint'
'204':
description: No endpoints configured
delete:
tags: [client-endpoint]
summary: Delete all client endpoints
description: All connections will be closed and endpoints removed.
responses:
'200':
description: Endpoints deleted
'204':
description: No endpoints to delete
/admin/v1/client-endpoint/schema:
get:
tags: [client-endpoint]
summary: Retrieve the client endpoint schema
responses:
'200':
description: Schema retrieved
content:
application/json:
schema:
type: object
/admin/v1/client-provision:
post:
tags: [client-provision]
summary: Configure client provision(s)
description: >
Defines client request behavior identified by mandatory `id`
and optional `inState`. Includes request configuration,
transformation pipeline (pre-send and on-response), endpoint
selection, delays and timeouts. Accepts single or array.
requestBody:
required: true
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ClientProvision'
- type: array
items:
$ref: '#/components/schemas/ClientProvision'
responses:
'201':
description: Provision(s) created
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
get:
tags: [client-provision]
summary: Retrieve all client provisions
responses:
'200':
description: Provisions retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientProvision'
'204':
description: No provisions configured
delete:
tags: [client-provision]
summary: Delete all client provisions
responses:
'200':
description: Provisions deleted
'202':
description: Accepted
'204':
description: No provisions to delete
/admin/v1/client-provision/schema:
get:
tags: [client-provision]
summary: Retrieve the client provision schema
responses:
'200':
description: Schema retrieved
content:
application/json:
schema:
type: object
/admin/v1/client-provision/unused:
get:
tags: [client-provision]
summary: Retrieve unused client provisions
description: >
Returns provisions not yet triggered. Useful for troubleshooting.
responses:
'200':
description: Unused provisions retrieved
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ClientProvision'
'204':
description: No unused provisions
/admin/v1/client-provision/{id}:
get:
tags: [client-provision]
summary: Trigger client provision
description: >
Triggers a client provision by its identifier. Without extra
query parameters, sends a single request with sequence=0.
With sequenceBegin/sequenceEnd/cps, triggers multiple requests
at the specified rate for load testing.
parameters:
- name: id
in: path
required: true
description: Client provision identifier
schema:
type: string
- name: inState
in: query
description: Initial state (defaults to "initial")
schema:
type: string
- name: sequence
in: query
description: >
Synchronous single-shot sequence value. Exclusive with
sequenceBegin/sequenceEnd/cps/repeat.
schema:
type: integer
- name: sequenceBegin
in: query
description: Start of sequence range
schema:
type: integer
- name: sequenceEnd
in: query
description: End of sequence range
schema:
type: integer
- name: cps
in: query
description: "Calls per second (0 to stop)"
schema:
type: integer
minimum: 0
- name: repeat
in: query
description: Repeat range once exhausted
schema:
type: boolean
responses:
'200':
description: Single request triggered
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'202':
description: Multiple requests triggered (range mode)
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ResultResponse'
'404':
description: Provision not found
/admin/v1/client-data/configuration:
put:
tags: [client-data]
summary: Update client data storage configuration
description: >
Same storage behavior as server-data configuration. Key includes
clientEndpointId in addition to method and uri. Purge operates
over provision id and current sequence.
parameters:
- name: discard
in: query
schema:
type: boolean
- name: discardKeyHistory
in: query
schema:
type: boolean
- name: disablePurge
in: query
schema:
type: boolean
responses:
'200':
description: Configuration updated
'400':
description: Invalid combination
get:
tags: [client-data]
summary: Retrieve client data storage configuration
responses:
'200':
description: Configuration retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/DataStorageConfiguration'
/admin/v1/client/dispatch-latency:
get:
tags: [client]
summary: Retrieve worker pool dispatch latency statistics
description: >
Returns accumulated statistics about the time between posting work
to the client worker pool and the worker starting execution. This
measures queue wait time + thread wakeup overhead. Useful to detect
pool saturation.
Interpretation:
- avgUs < 50: pool idle, workers waiting for work. Ideal.
- avgUs 100-500: pool busy but healthy. No significant queuing.
- avgUs 1000-5000: pool at capacity. Work queues up. Consider adding workers.
- avgUs > 10000: pool saturated. Workers cannot keep up. Add threads or reduce per-request cost.
responses:
'200':
description: Dispatch latency statistics
content:
application/json:
schema:
type: object
properties:
avgUs:
type: number
description: Average dispatch latency in microseconds
maxUs:
type: integer
description: Maximum dispatch latency in microseconds
count:
type: integer
description: Total number of dispatches measured
pending:
type: integer
description: Current number of dispatches waiting in the pool queue
discarded:
type: integer
description: Total ticks discarded due to pool congestion (--traffic-client-pool-max-pending)
/admin/v1/client-data:
get:
tags: [client-data]
summary: Retrieve client data events
description: >
Returns stored client events. Without parameters returns all.
Filter by clientEndpointId+requestMethod+requestUri (all three
required together), optionally narrow with eventNumber and
eventPath.
parameters:
- name: clientEndpointId
in: query
description: Client endpoint identifier
schema:
type: string
- name: requestMethod
in: query
schema:
type: string
enum: [POST, GET, PUT, DELETE, HEAD]
- name: requestUri
in: query
description: Request URI (URL-encoded if contains query params)
schema:
type: string
- name: eventNumber
in: query
description: "Event position: 1..N chronological, -1..-N reverse"
schema:
type: integer
- name: eventPath
in: query
description: JSON pointer path within the selected event
schema:
type: string
responses:
'200':
description: Data retrieved
content:
application/json:
schema: {}
'204':
description: No data found
'400':
description: Bad request (incomplete parameters)
delete:
tags: [client-data]
summary: Delete client data events
description: >
Deletes stored events. Without parameters deletes all.
Filter with clientEndpointId+requestMethod+requestUri,
optionally eventNumber.
parameters:
- name: clientEndpointId
in: query
schema:
type: string
- name: requestMethod
in: query
schema:
type: string
enum: [POST, GET, PUT, DELETE, HEAD]
- name: requestUri
in: query
schema:
type: string
- name: eventNumber
in: query