-
Notifications
You must be signed in to change notification settings - Fork 51
/
rbaskets-openapi.yaml
901 lines (865 loc) · 30.2 KB
/
rbaskets-openapi.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
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
############################################
# Request Baskets service API
#
openapi: '3.0.3'
info:
version: '1.0.0'
title: Request Baskets API
description: |
[Request Baskets](https://rbaskets.in) service REST API.
Request Baskets is an open source project of a service to collect HTTP requests and inspect them via RESTful
API or web UI.
Check out the [project page](https://github.com/darklynx/request-baskets) for more detailed description.
contact:
name: darklynx
url: https://github.com/darklynx
license:
name: MIT
url: https://github.com/darklynx/request-baskets/blob/master/LICENSE
x-logo:
url: https://raw.githubusercontent.com/darklynx/request-baskets/master/doc/logo.svg
servers:
- url: https://rbaskets.in
# Groups and their descriptions
tags:
- name: Service
description: Service information
- name: Baskets
description: Manage baskets
- name: Responses
description: Configure basket HTTP responses
- name: Requests
description: Manage HTTP requests collected by basket
- name: Deprecated API
description: |
Deprecated API end-points that preceded the stable API of version `1.0.0`. Every deprecated
API operation has its own counterpart under `/api` path with backwards compatible syntax
and can be easily replaced.
# URL patterns
paths:
/api/version:
get:
tags:
- Service
summary: Get service version
description: Get service version.
operationId: getServiceVersion
responses:
'200':
description: OK. Returns service version.
content:
application/json:
schema:
$ref: '#/components/schemas/Version'
/api/stats:
get:
tags:
- Baskets
summary: Get baskets statistics
description: Get service statistics about baskets and collected HTTP requests. Require master token.
operationId: getBasketsStats
parameters:
- $ref: '#/components/parameters/query_max_stats'
responses:
'200':
description: OK. Returns service statistics.
content:
application/json:
schema:
$ref: '#/components/schemas/ServiceStats'
'401':
description: Unauthorized. Invalid or missing master token
security:
- service_token: []
/api/baskets:
get:
tags:
- Baskets
summary: Get baskets
description: Fetches a list of basket names managed by service. Require master token.
operationId: getBasketNames
parameters:
- $ref: '#/components/parameters/query_max_items'
- $ref: '#/components/parameters/query_skip_items'
- $ref: '#/components/parameters/query_q_items'
responses:
'200':
description: OK. Returns list of available baskets.
content:
application/json:
schema:
$ref: '#/components/schemas/Baskets'
'204':
description: No Content. No baskets available for specified limits
'401':
description: Unauthorized. Invalid or missing master token
security:
- service_token: []
/api/baskets/{name}:
post:
tags:
- Baskets
summary: Create new basket
description: Creates a new basket with this name.
operationId: createBasket
parameters:
- $ref: '#/components/parameters/path_basket_name'
requestBody:
$ref: '#/components/requestBodies/body_basket_config'
responses:
'201':
description: Created. Indicates that basket is successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
'400':
description: Bad Request. Failed to parse JSON into basket configuration object.
'403':
description: Forbidden. Indicates that basket name conflicts with reserved paths; e.g. `baskets`, `web`, etc.
'409':
description: Conflict. Indicates that basket with such name already exists
'422':
description: Unprocessable Entity. Basket configuration is not valid.
get:
tags:
- Baskets
summary: Get basket settings
description: Retrieves configuration settings of this basket.
operationId: getBasketConfig
parameters:
- $ref: '#/components/parameters/path_basket_name'
responses:
'200':
description: OK. Returns basket configuration
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
put:
tags:
- Baskets
summary: Update basket settings
description: |
Updates configuration settings of this basket.
Special configuration parameters for request forwarding:
* `insecure_tls` controls certificate verification when forwarding requests. Setting this parameter to `true`
allows to forward collected HTTP requests via HTTPS protocol even if the forward end-point is configured with
self-signed TLS/SSL certificate. **Warning:** enabling this feature has known security implications.
* `expand_path` changes the logic of constructing target URL when forwarding requests. If this parameter is
set to `true` the forward URL path will be expanded when original HTTP request contains compound path. For
example, a basket with name **server1** is configured to forward all requests to `http://server1.intranet:8001/myservice`
and it has received an HTTP request like `GET http://baskets.example.com/server1/component/123/events?status=OK`
then depending on `expand_path` settings the request will be forwarded to:
* `true` => `GET http://server1.intranet:8001/myservice/component/123/events?status=OK`
* `false` => `GET http://server1.intranet:8001/myservice?status=OK`
operationId: updateBasketConfig
parameters:
- $ref: '#/components/parameters/path_basket_name'
requestBody:
$ref: '#/components/requestBodies/body_basket_config_update'
responses:
'204':
description: No Content. Basket configuration is updated
'400':
description: Bad Request. Failed to parse JSON into basket configuration object.
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
'422':
description: Unprocessable Entity. Basket configuration is not valid.
security:
- basket_token: []
delete:
tags:
- Baskets
summary: Delete basket
description: Permanently deletes this basket and all collected requests.
operationId: deleteBasket
parameters:
- $ref: '#/components/parameters/path_basket_name'
responses:
'204':
description: No Content. Basket is deleted
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
/api/baskets/{name}/responses/{method}:
get:
tags:
- Responses
summary: Get response settings
description: |
Retrieves information about configured response of the basket. Service will reply with this response to any
HTTP request sent to the basket with appropriate HTTP method.
If nothing is configured, the default response is HTTP 200 - OK with empty content.
operationId: getBasketResponseConfig
parameters:
- $ref: '#/components/parameters/path_basket_name'
- $ref: '#/components/parameters/path_http_method'
responses:
'200':
description: OK. Returns configured response information
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
put:
tags:
- Responses
summary: Update response settings
description: |
Allows to configure HTTP response of this basket. The service will reply with configured response to any HTTP
request sent to the basket with appropriate HTTP method.
If nothing is configured, the default response is HTTP 200 - OK with empty content.
operationId: updateBasketResponseConfig
parameters:
- $ref: '#/components/parameters/path_basket_name'
- $ref: '#/components/parameters/path_http_method'
requestBody:
$ref: '#/components/requestBodies/body_response_config'
responses:
'204':
description: No Content. Response configuration is updated
'400':
description: Bad Request. Failed to parse JSON into response configuration object.
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
'422':
description: Unprocessable Entity. Response configuration is not valid.
security:
- basket_token: []
/api/baskets/{name}/requests:
get:
tags:
- Requests
summary: Get collected requests
description: Fetches collection of requests collected by this basket.
operationId: getCollectedRequests
parameters:
- $ref: '#/components/parameters/path_basket_name'
- $ref: '#/components/parameters/query_max_items'
- $ref: '#/components/parameters/query_skip_items'
- $ref: '#/components/parameters/query_q_items'
- $ref: '#/components/parameters/query_in_items'
responses:
'200':
description: OK. Returns list of basket requests.
content:
application/json:
schema:
$ref: '#/components/schemas/Requests'
'204':
description: No Content. No requests found for specified limits
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
delete:
tags:
- Requests
summary: Delete all requests
description: Deletes all requests collected by this basket.
operationId: deleteCollectedRequests
parameters:
- $ref: '#/components/parameters/path_basket_name'
responses:
'204':
description: No Content. Basket requests are cleared
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
/baskets:
get:
tags:
- Deprecated API
summary: Get baskets
description: Fetches a list of basket names managed by service. Require master token.
operationId: getBasketNamesOld
deprecated: true
parameters:
- $ref: '#/components/parameters/query_max_items'
- $ref: '#/components/parameters/query_skip_items'
- $ref: '#/components/parameters/query_q_items'
responses:
'200':
description: OK. Returns list of available baskets.
content:
application/json:
schema:
$ref: '#/components/schemas/Baskets'
'204':
description: No Content. No baskets available for specified limits
'401':
description: Unauthorized. Invalid or missing master token
security:
- service_token: []
/baskets/{name}:
post:
tags:
- Deprecated API
summary: Create new basket
description: Creates a new basket with this name.
operationId: createBasketOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
requestBody:
$ref: '#/components/requestBodies/body_basket_config'
responses:
'201':
description: Created. Indicates that basket is successfully created
content:
application/json:
schema:
$ref: '#/components/schemas/Token'
'400':
description: Bad Request. Failed to parse JSON into basket configuration object.
'403':
description: Forbidden. Indicates that basket name conflicts with reserved paths; e.g. `baskets`, `web`, etc.
'409':
description: Conflict. Indicates that basket with such name already exists
'422':
description: Unprocessable Entity. Basket configuration is not valid.
get:
tags:
- Deprecated API
summary: Get basket settings
description: Retrieves configuration settings of this basket.
operationId: getBasketConfigOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
responses:
'200':
description: OK. Returns basket configuration
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
put:
tags:
- Deprecated API
summary: Update basket settings
description: |
Updates configuration settings of this basket.
Special configuration parameters for request forwarding:
* `insecure_tls` controls certificate verification when forwarding requests. Setting this parameter to `true`
allows to forward collected HTTP requests via HTTPS protocol even if the forward end-point is configured with
self-signed TLS/SSL certificate. **Warning:** enabling this feature has known security implications.
* `expand_path` changes the logic of constructing target URL when forwarding requests. If this parameter is
set to `true` the forward URL path will be expanded when original HTTP request contains compound path. For
example, a basket with name **server1** is configured to forward all requests to `http://server1.intranet:8001/myservice`
and it has received an HTTP request like `GET http://baskets.example.com/server1/component/123/events?status=OK`
then depending on `expand_path` settings the request will be forwarded to:
* `true` => `GET http://server1.intranet:8001/myservice/component/123/events?status=OK`
* `false` => `GET http://server1.intranet:8001/myservice?status=OK`
operationId: updateBasketConfigOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
requestBody:
$ref: '#/components/requestBodies/body_basket_config_update'
responses:
'204':
description: No Content. Basket configuration is updated
'400':
description: Bad Request. Failed to parse JSON into basket configuration object.
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
'422':
description: Unprocessable Entity. Basket configuration is not valid.
security:
- basket_token: []
delete:
tags:
- Deprecated API
summary: Delete basket
description: Permanently deletes this basket and all collected requests.
operationId: deleteBasketOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
responses:
'204':
description: No Content. Basket is deleted
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
/baskets/{name}/responses/{method}:
get:
tags:
- Deprecated API
summary: Get response settings
description: |
Retrieves information about configured response of the basket. Service will reply with this response to any
HTTP request sent to the basket with appropriate HTTP method.
If nothing is configured, the default response is HTTP 200 - OK with empty content.
operationId: getBasketResponseConfigOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
- $ref: '#/components/parameters/path_http_method'
responses:
'200':
description: OK. Returns configured response information
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
put:
tags:
- Deprecated API
summary: Update response settings
description: |
Allows to configure HTTP response of this basket. The service will reply with configured response to any HTTP
request sent to the basket with appropriate HTTP method.
If nothing is configured, the default response is HTTP 200 - OK with empty content.
operationId: updateBasketResponseConfigOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
- $ref: '#/components/parameters/path_http_method'
requestBody:
$ref: '#/components/requestBodies/body_response_config'
responses:
'204':
description: No Content. Response configuration is updated
'400':
description: Bad Request. Failed to parse JSON into response configuration object.
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
'422':
description: Unprocessable Entity. Response configuration is not valid.
security:
- basket_token: []
/baskets/{name}/requests:
get:
tags:
- Deprecated API
summary: Get collected requests
description: Fetches collection of requests collected by this basket.
operationId: getCollectedRequestsOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
- $ref: '#/components/parameters/query_max_items'
- $ref: '#/components/parameters/query_skip_items'
- $ref: '#/components/parameters/query_q_items'
- $ref: '#/components/parameters/query_in_items'
responses:
'200':
description: OK. Returns list of basket requests.
content:
application/json:
schema:
$ref: '#/components/schemas/Requests'
'204':
description: No Content. No requests found for specified limits
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
delete:
tags:
- Deprecated API
summary: Delete all requests
description: Deletes all requests collected by this basket.
operationId: deleteCollectedRequestsOld
deprecated: true
parameters:
- $ref: '#/components/parameters/path_basket_name'
responses:
'204':
description: No Content. Basket requests are cleared
'401':
description: Unauthorized. Invalid or missing basket token
'404':
description: Not Found. No basket with such name
security:
- basket_token: []
components:
securitySchemes:
basket_token:
description: Basket assigned secure token
type: apiKey
name: Authorization
in: header
service_token:
description: Service master token
type: apiKey
name: Authorization
in: header
parameters:
path_basket_name:
name: name
in: path
description: The basket name
required: true
schema:
type: string
pattern: '^[\w\d\-_\.]{1,250}$'
path_http_method:
name: method
in: path
required: true
description: The HTTP method of response configuration
schema:
type: string
enum:
- GET
- HEAD
- POST
- PUT
- PATCH
- DELETE
- CONNECT
- OPTIONS
- TRACE
query_max_stats:
name: max
in: query
description: Maximum number of baskets stats to return
required: false
schema:
type: integer
default: 5
query_max_items:
name: max
in: query
description: Maximum number of items to return (a page)
required: false
schema:
type: integer
default: 20
query_skip_items:
name: skip
in: query
description: Number of items to skip (for pagination)
required: false
schema:
type: integer
default: 0
query_q_items:
name: q
in: query
description: Query string to filter result, only those items that match this query will be included in the response
required: false
schema:
type: string
query_in_items:
name: in
in: query
description: |
Defines what is taken into account when filtering is applied:
* `body` - search in content body of collected requests
* `query` - search among query parameters of collected requests
* `headers` - search among request header values
* `any` - search anywhere
required: false
schema:
type: string
default: any
enum:
- any
- body
- query
- headers
requestBodies:
body_basket_config:
description: New basket configuration
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
body_basket_config_update:
description: Basket configuration
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Config'
body_response_config:
description: HTTP response configuration
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Response'
schemas:
Version:
type: object
properties:
name:
type: string
description: Service name
example: request-baskets
version:
type: string
description: Service version
example: v1.0.0
commit:
type: string
description: Git commit this service is build from
example: 4cc08434223ff04fbe2e45f2f6eeb9b0a39a279e
commit_short:
type: string
description: Short form of git commit this service is build from
example: 4cc0843
source_code:
type: string
description: URL of the source code repository
example: https://github.com/darklynx/request-baskets
ServiceStats:
type: object
properties:
baskets_count:
type: integer
description: Total number of baskets managed by service
example: 28
empty_baskets_count:
type: integer
description: Number of empty baskets
example: 12
requests_count:
type: integer
description: Number of HTTP requests currently stored by service
example: 5120
requests_total_count:
type: integer
description: Total number of HTTP requests processed by service
example: 21847
max_basket_size:
type: integer
description: Size of the biggest basket that processed the top most number of HTTP requests
example: 1027
avg_basket_size:
type: integer
description: Average size of a basket in the system, empty baskets are not taken into account
example: 217
top_baskets_size:
type: array
description: Collection of top basket by size
items:
$ref: '#/components/schemas/BasketInfo'
top_baskets_recent:
type: array
description: Collection of top baskets recently active
items:
$ref: '#/components/schemas/BasketInfo'
BasketInfo:
type: object
properties:
name:
type: string
description: Basket name
example: basket22
requests_count:
type: integer
description: Current number of collected HTTP requests held by basket
example: 62
requests_total_count:
type: integer
description: Total number of all HTTP requests passed through this basket
example: 315
last_request_date:
type: integer
format: int64
description: |
Date and time of last request processed through this basket in Unix time ms.
format (number of milliseconds elapsed since January 1, 1970 UTC).
If no requests were collected by this basket `0` is returned.
example: 1550106301288
Baskets:
type: object
required:
- names
- has_more
properties:
names:
type: array
description: Collection of basket names
items:
type: string
example:
- basket22
- mybasket
- test123
count:
type: integer
description: Total number of baskets in the system; not present if query is applied
example: 118
has_more:
type: boolean
description: Indicates if there are more baskets to fetch
example: true
Config:
type: object
properties:
forward_url:
type: string
description: URL to forward all incoming requests of the basket, `empty` value disables forwarding
example: https://myservice.example.com/events-collector
proxy_response:
type: boolean
description: |
If set to `true` this basket behaves as a full proxy: responses from underlying service configured in `forward_url`
are passed back to clients of original requests. The configuration of basket responses is ignored in this case.
example: false
insecure_tls:
type: boolean
description: |
If set to `true` the certificate verification will be disabled if forward URL indicates HTTPS scheme.
**Warning:** enabling this feature has known security implications.
example: false
expand_path:
type: boolean
description: If set to `true` the forward URL path will be expanded when original HTTP request contains compound path.
example: true
capacity:
type: integer
description: Baskets capacity, defines maximum number of requests to store
example: 250
Token:
type: object
required:
- token
properties:
token:
type: string
description: Secure token to manage the basket, generated by system
example: MJeIzgE1D6aze...
Requests:
type: object
required:
- requests
- has_more
properties:
requests:
type: array
description: Collection of collected requests
items:
$ref: '#/components/schemas/Request'
count:
type: integer
description: Current number of collected requests hold by basket; not present if query is applied
example: 200
total_count:
type: integer
description: Total number of all requests passed through this basket; not present if query is applied
example: 3023
has_more:
type: boolean
description: Indicates if there are more requests collected by basket to fetch
example: true
Request:
type: object
properties:
date:
type: integer
format: int64
description: Date and time of request in Unix time ms. format (number of milliseconds elapsed since January 1, 1970 UTC)
example: 1550300604712
headers:
$ref: '#/components/schemas/Headers'
content_length:
type: integer
description: Content length of request
example: 24
body:
type: string
description: Content of request body
example: user=abc_test&status=200
method:
type: string
description: HTTP method of request
example: POST
path:
type: string
description: URL path of request
example: /basket1/data
query:
type: string
description: Query parameters of request
example: name=basket1&version=12
Headers:
type: object
description: Map of HTTP headers, key represents name, value is array of values
additionalProperties:
type: array
description: Collection of header values
items:
type: string
example:
Content-Type:
- application/json
Accept:
- application/json
- application/xml
Connection:
- close
Response:
type: object
properties:
status:
type: integer
description: The HTTP status code to reply with
example: 200
headers:
$ref: '#/components/schemas/Headers'
body:
type: string
description: Content of response body
example: Success
is_template:
type: boolean
description: |
If set to `true` the body is treated as [HTML template](https://golang.org/pkg/html/template) that accepts
input from request parameters.
example: false
default: false