forked from zalando-zmon/service-level-reporting
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
1110 lines (1050 loc) · 27.9 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
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
swagger: "2.0"
info:
title: ZMON service level reporting
version: "0.3"
basePath: /api
consumes:
- application/json
produces:
- application/json
securityDefinitions:
oauth2:
type: oauth2
flow: password
tokenUrl: ""
scopes:
uid: Unique identifier of the user accessing the service.
security:
# enable OAuth protection for all REST endpoints
# (only active if the HTTP_TOKENINFO_URL environment variable is set)
- oauth2: [uid]
definitions:
Meta:
properties:
next_uri:
type: string
readOnly: true
description: Pagination next URI
previous_uri:
type: string
readOnly: true
description: Pagination previous URI
count:
type: number
readOnly: true
description: Total number of resources
APIRoot:
properties:
health_uri:
type: string
readOnly: true
description: Health resource URI
session_uri:
type: string
readOnly: true
description: Session resource URI. Info about logged in user.
product_groups_uri:
type: string
readOnly: true
description: Product Groups URI
products_uri:
type: string
readOnly: true
description: Products URI
ProductGroupList:
properties:
_meta:
$ref: '#/definitions/Meta'
data:
type: array
items:
$ref: '#/definitions/ProductGroup'
ProductGroup:
properties:
name:
type: string
description: The actual name for the product group.
department:
type: string
description: The department of the product group.
slug:
type: string
description: Product group slug.
readOnly: true
username:
type: string
readOnly: true
description: User name created the resource.
created:
type: string
readOnly: true
description: Created datetime.
updated:
type: string
readOnly: true
description: Updated datetime.
uri:
type: string
readOnly: true
description: Self reference URI (e.g /product-groups/110)
ProductList:
properties:
_meta:
$ref: '#/definitions/Meta'
data:
type: array
items:
$ref: '#/definitions/Product'
Product:
properties:
name:
type: string
description: Product name.
email:
type: ["string", "null"]
description: Product owner email. This could be used in notifications.
product_group_uri:
type: string
description: Product Group URI (e.g. /product-groups/110)
slug:
type: string
readOnly: true
description: Product slug.
product_group_name:
type: string
readOnly: true
description: Product Group name.
username:
type: string
readOnly: true
description: User name created the resource.
created:
type: string
readOnly: true
description: Created datetime.
updated:
type: string
readOnly: true
description: Updated datetime.
uri:
type: string
readOnly: true
description: Self reference URI (e.g /products/3)
product_sli_uri:
type: string
readOnly: true
description: Product SLI URI (e.g /products/3/sli)
product_slo_uri:
type: string
readOnly: true
description: Product SLO URI (e.g /products/3/slo)
product_reports_uri:
type: string
readOnly: true
description: Product Reports URI (e.g /products/3/reports)
product_reports_weekly_uri:
type: string
readOnly: true
description: Product Reports URI (e.g /products/3/reports/weekly)
SLIList:
properties:
_meta:
$ref: '#/definitions/Meta'
data:
type: array
items:
$ref: '#/definitions/SLI'
SLI:
properties:
name:
type: string
description: SLI name.
source:
type: object
description: |
{
"check_id": 2017,
"aggregation": {"type": "average"},
"keys": ["latency.p99", "requests_count"],
"tags": {"application_id": ["app-1"]}
}
unit:
type: string
description: SLI unit (s, ms, %).
aggregation:
type: string
readOnly: true
description: Aggregation type (retrieved from source for convenience)
product_name:
type: string
readOnly: true
description: Product name
slug:
type: string
readOnly: true
description: SLI slug.
username:
type: string
readOnly: true
description: User name created the resource.
created:
type: string
readOnly: true
description: Created datetime.
updated:
type: string
readOnly: true
description: Updated datetime.
uri:
type: string
readOnly: true
description: Self reference URI (e.g /products/3/sli/33)
sli_values_uri:
type: string
readOnly: true
description: Product SLI URI (e.g /products/3/sli/33/values)
sli_query_uri:
type: string
readOnly: true
description: Product SLO URI (e.g /products/3/sli/33/query)
SLOList:
properties:
_meta:
$ref: '#/definitions/Meta'
data:
type: array
items:
$ref: '#/definitions/SLO'
SLO:
properties:
title:
type: string
description: SLO title.
description:
type: string
description: SLO description.
id:
type: integer
readOnly: true
description: SLO ID.
username:
type: string
readOnly: true
description: User name created the resource.
created:
type: string
readOnly: true
description: Created datetime.
updated:
type: string
readOnly: true
description: Updated datetime.
uri:
type: string
readOnly: true
description: Self reference URI (e.g /products/3/slo/333)
slo_targets_uri:
type: string
readOnly: true
description: Product SLO targets URI (e.g /products/3/slo/333/targets)
targets:
type: array
items:
$ref: '#/definitions/Target'
readOnly: true
description: SLO Targets
product_name:
type: string
readOnly: true
description: Product name
TargetList:
properties:
_meta:
$ref: '#/definitions/Meta'
data:
type: array
items:
$ref: '#/definitions/Target'
Target:
properties:
from:
type: ["number", "null"]
description: SLO target lower bound.
to:
type: ["number", "null"]
description: SLO target upper bound.
sli_uri:
type: string
description: Product SLI URI (e.g /products/3/sli/33).
sli_name:
type: string
readOnly: true
description: Product SLI name
product_name:
type: string
readOnly: true
description: Product name
username:
type: string
readOnly: true
description: User name created the resource.
created:
type: string
readOnly: true
description: Created datetime.
updated:
type: string
readOnly: true
description: Updated datetime.
uri:
type: string
readOnly: true
description: Self reference URI (e.g /products/3/slo/333/targets/3333).
Report:
properties:
product_name:
type: string
description: Product name
product_group_name:
type: string
description: Product Group name
department:
type: string
description: Product group department
slo:
type: array
items:
$ref: '#/definitions/ReportSLO'
ReportSLO:
properties:
days:
type: object
readOnly: true
description: |
{
"2017-02-16T00:00:00": {
"sli-name-1": {"min": 10, "max": 100, "avg": 88.9, "count": 19000, "breaches": 1, "unit": "ms", "aggregation": "average"},
"sli-name-2": {"min": 19090, "max": 20110, "avg": 15558, "count": 19000, "breaches": 0, "unit": "", "aggregation": "max"}
}
}
title:
type: string
readOnly: true
description: 99.5 of requests succeed
slo_uri:
type: string
readOnly: true
targets:
type: array
readOnly: true
items:
$ref: '#/definitions/Target'
parameters:
ResourceId:
name: id
type: integer
in: path
required: true
description: Resource ID.
ProductId:
name: product_id
type: string
in: path
required: true
description: Product ID.
SLOId:
name: slo_id
type: string
in: path
required: true
description: SLO ID.
From:
name: from
type: integer
in: query
description: Relative start minutes
To:
name: to
type: integer
in: query
description: Relative end minutes
Offset:
name: page
type: integer
in: query
description: Pagination page.
Limit:
name: page_size
type: integer
in: query
description: Pagination page size limit.
paths:
/:
get:
tags: [API Root]
operationId: app.resources.APIRoot.get
summary: Root API entry point
responses:
200:
description: OK
schema:
$ref: '#/definitions/APIRoot'
/health:
get:
tags: [System]
operationId: app.resources.APIRoot.health
summary: Return health
responses:
200:
description: Health is OK
/session:
get:
tags: [System]
operationId: app.resources.APIRoot.session
summary: Return session info
responses:
200:
description: OK
schema:
properties:
username:
type: string
readOnly: true
description: Current username
last_login:
type: string
readOnly: true
description: Login datetime
/product-groups:
get:
tags: [Product Group]
operationId: app.resources.ProductGroupResource.list
parameters:
- name: name
type: string
in: query
description: Filter product groups by name.
- $ref: '#/parameters/Limit'
- $ref: '#/parameters/Offset'
responses:
200:
description: List of Product Groups
schema:
$ref: '#/definitions/ProductGroupList'
401:
description: UNAUTHORIZED
post:
tags: [Product Group]
operationId: app.resources.ProductGroupResource.create
summary: Create a Product Group
description: Create a product group.
parameters:
- name: product_group
in: body
required: true
schema:
type: object
properties:
name:
type: string
description: The name for the new Product Group
example: Recommendations Platform
department:
type: string
description: The department of the Product Group
example: Personalization
required:
- name
responses:
201:
description: CREATED
schema:
$ref: '#/definitions/ProductGroup'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
/product-groups/{id}:
get:
tags: [Product Group]
summary: Retrieve a Product Group
operationId: app.resources.ProductGroupResource.get
parameters:
- $ref: '#/parameters/ResourceId'
responses:
200:
description: OK.
schema:
$ref: '#/definitions/ProductGroup'
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
put:
tags: [Product Group]
operationId: app.resources.ProductGroupResource.update
summary: Update a Product Group
parameters:
- $ref: '#/parameters/ResourceId'
- name: product_group
in: body
required: true
schema:
$ref: '#/definitions/ProductGroup'
responses:
200:
description: OK
schema:
$ref: '#/definitions/ProductGroup'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
delete:
tags: [Product Group]
summary: Delete a Product Group
operationId: app.resources.ProductGroupResource.delete
parameters:
- $ref: '#/parameters/ResourceId'
responses:
204:
description: NO CONTENT.
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
/products:
get:
tags: [Product]
operationId: app.resources.ProductResource.list
parameters:
- name: name
type: string
in: query
description: Filter products by name.
- name: product_group
type: string
in: query
description: Filter by product group name.
- $ref: '#/parameters/Limit'
- $ref: '#/parameters/Offset'
responses:
200:
description: List of Products
schema:
$ref: '#/definitions/ProductList'
401:
description: UNAUTHORIZED
post:
tags: [Product]
operationId: app.resources.ProductResource.create
description: Create a new Product
parameters:
- name: product
in: body
required: true
schema:
type: object
properties:
name:
type: string
description: The name for the new Product
example: ZMON
product_group_uri:
type: string
description: Product Group URI
example: /product-groups/110
required:
- name
- product_group_uri
responses:
201:
description: CREATED
schema:
$ref: '#/definitions/Product'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product group does not exist)
/products/{id}:
get:
tags: [Product]
summary: Retrieve a Product
operationId: app.resources.ProductResource.get
parameters:
- $ref: '#/parameters/ResourceId'
responses:
200:
description: OK.
schema:
$ref: '#/definitions/Product'
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
put:
tags: [Product]
operationId: app.resources.ProductResource.update
summary: Update a Product
parameters:
- $ref: '#/parameters/ResourceId'
- name: product
in: body
required: true
schema:
$ref: '#/definitions/Product'
responses:
200:
description: OK
schema:
$ref: '#/definitions/Product'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
404:
description: NOT FOUND
delete:
tags: [Product]
summary: Delete a Product
operationId: app.resources.ProductResource.delete
parameters:
- $ref: '#/parameters/ResourceId'
responses:
204:
description: NO CONTENT.
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
/products/{product_id}/sli:
get:
tags: [SLI]
description: Get list of Product SLIs
operationId: app.resources.SLIResource.list
parameters:
- $ref: '#/parameters/ProductId'
- name: name
type: string
in: query
description: Filter SLI by name.
- $ref: '#/parameters/Limit'
- $ref: '#/parameters/Offset'
responses:
200:
description: List of Product SLIs
schema:
$ref: '#/definitions/SLIList'
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
post:
tags: [SLI]
operationId: app.resources.SLIResource.create
description: Create a new Product SLI
parameters:
- $ref: '#/parameters/ProductId'
- name: sli
in: body
required: true
schema:
type: object
properties:
name:
type: string
description: The SLI name
example: latency_p99
unit:
type: string
description: SLI unit (s, ms, %).
source:
type: object
description: SLI data source
example: |
{
"check_id": 2017,
"aggregation": {"type": "average"},
"keys": ["latency.p99", "requests_count"],
"tags": {"application_id": ["app-1"]}
}
required:
- name
- source
- unit
responses:
201:
description: CREATED
schema:
$ref: '#/definitions/SLI'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
/products/{product_id}/sli/{id}:
get:
tags: [SLI]
summary: Retrieve a SLI
operationId: app.resources.SLIResource.get
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
responses:
200:
description: OK.
schema:
$ref: '#/definitions/SLI'
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
put:
tags: [SLI]
operationId: app.resources.SLIResource.update
summary: Update a Product SLI
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
- name: sli
in: body
required: true
schema:
$ref: '#/definitions/SLI'
responses:
200:
description: OK
schema:
$ref: '#/definitions/SLI'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
404:
description: NOT FOUND
delete:
tags: [SLI]
summary: Delete a Product SLI
operationId: app.resources.SLIResource.delete
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
responses:
204:
description: NO CONTENT.
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
/products/{product_id}/sli/{id}/values:
get:
tags: [SLI]
description: Get list of Product SLIs values
operationId: app.resources.SLIValueResource.list
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
- $ref: '#/parameters/From'
- $ref: '#/parameters/To'
- $ref: '#/parameters/Limit'
- $ref: '#/parameters/Offset'
responses:
200:
description: List of SLI values
schema:
properties:
_meta:
type: object
properties:
count:
type: number
description: Total number of values
data:
type: array
items:
type: object
properties:
timestamp:
type: string
value:
type: number
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
/products/{product_id}/sli/{id}/query:
post:
tags: [SLI]
description: Update Product SLI values
operationId: app.resources.SLIQueryResource.create
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
- name: duration
in: body
required: true
schema:
type: object
properties:
start:
type: integer
description: Relative start minutes
example: 1440
end:
type: integer
description: Relative end minutes
required:
- start
responses:
200:
description: List of SLI values
schema:
type: object
properties:
count:
type: integer
description: Number of points updated for this SLI
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
/products/{product_id}/slo:
get:
tags: [SLO]
description: Get list of Product SLOs
operationId: app.resources.SLOResource.list
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/Limit'
- $ref: '#/parameters/Offset'
- name: id
type: integer
in: query
description: Filter SLO by ID.
responses:
200:
description: List of Product SLOs
schema:
$ref: '#/definitions/SLOList'
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
post:
tags: [SLO]
operationId: app.resources.SLOResource.create
description: Create a new Product SLO
parameters:
- $ref: '#/parameters/ProductId'
- name: slo
in: body
required: true
schema:
type: object
properties:
title:
type: string
description: The SLO title
example: "99.5% of the requests succeed in less than 500 ms"
required:
- title
responses:
201:
description: CREATED
schema:
$ref: '#/definitions/SLO'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
/products/{product_id}/slo/{id}:
get:
tags: [SLO]
summary: Retrieve a SLO
operationId: app.resources.SLOResource.get
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
responses:
200:
description: OK.
schema:
$ref: '#/definitions/SLO'
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
put:
tags: [SLO]
operationId: app.resources.SLOResource.update
summary: Update a Product SLO
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
- name: slo
in: body
required: true
schema:
$ref: '#/definitions/SLO'
responses:
200:
description: OK
schema:
$ref: '#/definitions/SLO'
400:
description: BAD REQUEST
401:
description: UNAUTHORIZED
404:
description: NOT FOUND
delete:
tags: [SLO]
summary: Delete a Product SLO
operationId: app.resources.SLOResource.delete
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/ResourceId'
responses:
204:
description: NO CONTENT.
401:
description: UNAUTHORIZED.
404:
description: NOT FOUND.
/products/{product_id}/slo/{slo_id}/targets:
get:
tags: [Target]
description: Get list of SLO targets
operationId: app.resources.TargetResource.list
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/SLOId'
- $ref: '#/parameters/Limit'
- $ref: '#/parameters/Offset'
responses:
200:
description: List of Product SLO targets
schema:
$ref: '#/definitions/TargetList'
401:
description: UNAUTHORIZED
404:
description: NOT FOUND (Product does not exist)
post:
tags: [Target]
operationId: app.resources.TargetResource.create
description: Create a new Product SLO target
parameters:
- $ref: '#/parameters/ProductId'
- $ref: '#/parameters/SLOId'