-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_v1.yaml
1168 lines (1166 loc) · 36 KB
/
api_v1.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
openapi: "3.0.2"
info:
description: >
Cachito is a service that stores application sources and their dependencies.
license:
name: "GPL-3.0"
title: Cachito API
version: "1.0"
servers:
- url: /api/v1
paths:
/status:
get:
summary: Get Cachito status
description: >
Return status of Cachito workers and services that Cachito depends on.
Includes information about which package managers can currently be processed.
responses:
"200":
description: Status information (as JSON)
content:
application/json:
schema:
type: object
properties:
can_process:
type: object
additionalProperties:
type: boolean
description: Requests with this package manager can be processed
example: { "git-submodule": false, "gomod": false, "npm": false, "pip": false, "yarn": false }
services:
type: array
items:
type: object
properties:
name:
type: string
description: Name of service
example: nexus
ok:
type: boolean
description: Service seems to be working
example: false
reason:
type: string
description: Reason why service is not working
example: "503: Service Unavailable"
required:
- name
- ok
workers:
type: array
items:
type: object
properties:
name:
type: string
description: Name of worker
example: celery@5ed43ee7bba5
ok:
type: boolean
description: Worker seems to be functional
example: false
reason:
type: string
description: Reason why worker is not functional
example: Node did not respond to ping
required:
- name
- ok
required:
- can_process
- services
- workers
/status/short:
get:
summary: Get Cachito status (short)
description: >
If everything is working correctly (i.e. all package managers can be processed),
return 200. Otherwise, return 503.
responses:
"200":
description: Everything is working correctly
content:
application/json:
example: { "ok": true }
"503":
description: Some issues were found, at least one package manager cannot be processed
content:
application/json:
example: { "ok": false, "reason": "no workers are available" }
/requests:
get:
summary: List Cachito requests
description: Return all the Cachito requests
parameters:
- name: page
in: query
description: The specific page to view
schema:
type: integer
example: 1
default: 1
- name: per_page
in: query
description: The number of requests to show per page
schema:
type: integer
example: 10
default: 10
- name: state
in: query
description: The state to filter requests by
schema:
type: string
example: in_progress
default: null
- name: verbose
in: query
description: Shows the same view as /requests/{id}
schema:
type: boolean
example: true
default: false
- name: repo
in: query
description: A full repository URL to filter request by
schema:
type: string
example: https://github.com/release-engineering/retrodep.git
default: null
- name: ref
in: query
description: A git ref to filter request by
schema:
type: string
example: bc9767a71ede6e0084ae4a9e01dcd8b81c30b741
default: null
- name: pkg_manager
in: query
description: >
Filter requests by the given pkg_manager. This argument
can be specified multiple times, that will filter all
requests that have the specified pkg_managers.
schema:
type: string
example: gomod
default: null
- name: created_from
in: query
description: >
Filter requests by the given date or datetime (inclusive).
This argument filters all requests created after the
specified date or datetime.
schema:
type: string
example: "2019-09-17T18:52:57.577851"
default: null
- name: created_to
in: query
description: >
Filter requests by the given date or datetime (inclusive).
This argument filters all requests created before the
specified date or datetime.
schema:
type: string
example: "2019-09-17T18:52:57.577851"
default: null
- name: error_origin
in: query
description: Filter requests by the given request error origin
schema:
type: string
example: "client"
default: null
- name: error_type
in: query
description: Filter requests by the given request error type
schema:
type: string
example: "InvalidRequestData"
default: null
responses:
"200":
description: A list of requests
content:
application/json:
schema:
type: object
properties:
items:
type: array
items:
$ref: "#/components/schemas/Request"
meta:
$ref: "#/components/schemas/Pagination"
"400":
description: The query parameters are invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "awesome is not a valid request state. Valid states are: complete, failed, in_progress, stale"
"404":
description: No requests were found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
post:
summary: Create a Cachito request
description: Create a new Cachito request
requestBody:
description: The request to create
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestNew'
security:
- negotiateAuth: []
responses:
"201":
description: The request was initiated
content:
application/json:
schema:
$ref: "#/components/schemas/RequestVerbose"
"400":
description: The input is invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "The \"ref\" parameter must be a 40 character hex string"
"403":
description: The user is not allowed to create a request with this input
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: You are not authorized to create a request on behalf of another user
"/requests/{id}":
get:
summary: Get a Cachito request
description: Return a specific Cachito request
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to retrieve
schema:
type: integer
responses:
"200":
description: The requested Cachito request
content:
application/json:
schema:
$ref: "#/components/schemas/RequestVerbose"
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
patch:
summary: Update a Cachito request
description: Update a Cachito request (requires special authorization)
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to update
schema:
type: integer
responses:
"200":
description: The request was updated
"403":
description: The requester is not allowed to modify a request
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: This API endpoint is restricted to Cachito workers
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
"400":
description: The input is invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The input data must be a JSON object
requestBody:
description: The keys to update
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/RequestUpdate'
security:
- negotiateAuth: []
"/requests/{id}/configuration-files":
get:
summary: List configuration files of a request
description: Return the configuration files of a Cachito request
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to retrieve the configuration files for
schema:
type: integer
responses:
"200":
description: The configuration files of the Cachito request
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/RequestConfiguration"
"403":
description: The requester is not allowed to add configuration files for a request
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: This API endpoint is restricted to Cachito workers
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
post:
summary: Add configuration files to a request
description: Add configuration files to the Cachito request (requires special authorization)
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to update
schema:
type: integer
responses:
"204":
description: The request's configuration files were updated
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
"400":
description: The input is invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The input data must be a JSON object
requestBody:
description: The configuration files
required: true
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/RequestConfiguration"
security:
- negotiateAuth: []
"/requests/{id}/content-manifest":
get:
summary: Get the content manifest of a request
description: Return the content manifest of a request
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to retrieve the content manifest for
schema:
type: integer
responses:
"200":
description: The content manifest of the Cachito request
content:
application/json:
schema:
$ref: "#/components/schemas/ContentManifest"
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
"400":
description: The input is invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Content manifests are only available for requests in the \"complete\" or \"stale\" states"
"/requests/{id}/environment-variables":
get:
summary: List environment variables of a request
description: Return information about the environment variables of a Cachito request
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to retrieve the environment variables for
schema:
type: integer
responses:
"200":
description: The environment variables of the Cachito request
content:
application/json:
schema:
type: object
properties:
NAME:
$ref: "#/components/schemas/EnvironmentVariableInfo"
example:
GOCACHE:
value: deps/gomod
kind: path
GOPATH:
value: deps/gomod
kind: path
GOSUMDB:
value: off
kind: literal
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
"/requests/{id}/download":
get:
summary: Download a Cachito request bundle
description: Download a Cachito request bundle
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request
schema:
type: integer
responses:
"200":
description: Downloads the bundle
headers:
Digest:
schema:
type: string
description: The base64 encoded sha256 digest of the bundle. For example, sha-256=X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=
content:
application/gzip: {}
"404":
description: The request wasn't found
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
"400":
description: The input is invalid
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "The request must be in the \"complete\" state before downloading the archive"
"/requests/{id}/logs":
get:
summary: Get Cachito request logs
description: Return the logs for a specific Cachito request
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request to retrieve the logs for
schema:
type: integer
responses:
'200':
description: The logs for the Cachito request
content:
text/plain:
schema:
type: string
example: |-
Processing Cachito request 1...
Processing request...
Done processing Cachito request 1
'404':
description: Either logs for Cachito requests are not enabled in Cachito, Cachito can't find the request, or the log file is missing
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The requested resource was not found
'410':
description: The logs for the Cachito request have been removed due to the request being in the stale state
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: The logs for the Cachito request 1 no longer exist
"/requests/{id}/packages":
get:
summary: List packages and dependencies for a request
description: Return the packages and dependencies for a request
parameters:
- name: id
in: path
required: true
description: The ID of the Cachito request
schema:
type: integer
responses:
"200":
description: Lists packages and dependencies
content:
application/json:
schema:
type: object
properties:
dependencies:
type: array
items:
$ref: "#/components/schemas/PackageWithReplaces"
packages:
type: array
items:
allOf:
- $ref: "#/components/schemas/Package"
- type: object
properties:
dependencies:
type: array
items:
$ref: "#/components/schemas/PackageWithReplaces"
"404":
description: The request does not exist or the packages file is not present
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "The packages file is not present for request"
"500":
description: Request is at invalid state. The packages file is not present.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Invalid state: packages file was not found."
"/content-manifest":
get:
summary: Get the content manifest of multiple requests
description: Return the content manifest of the specified Cachito requests
parameters:
- name: requests
in: query
required: false
description: The comma separated IDs of the Cachito requests to retrieve the content manifest for
schema:
type: string
example: [1,2,3]
responses:
"200":
description: The content manifest of the Cachito requests
content:
application/json:
schema:
$ref: "#/components/schemas/ContentManifest"
"400":
description: Any of the input Cachito request id is invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: "Request 1 is in state in_progress, not complete or stale."
"/request-metrics":
get:
summary: List requests with a final state information
description: Return a list of Cachito requests with a final state information
parameters:
- name: finished_from
description: The earliest possible date/time of request end (date, datetime or timestamp format)
in: query
required: false
schema:
type: string
examples:
date:
value: "2021-12-01"
datetime:
value: "2021-12-01T12:00:00"
timestamp:
value: "1623456789"
- name: finished_to
description: The latest possible date/time of request end (date, datetime or timestamp format)
in: query
required: false
schema:
type: string
examples:
date:
value: "2021-12-31"
datetime:
value: "2021-12-31T12:00:00"
timestamp:
value: "1633456789"
- name: error_origin
description: The origin of a request error ("client" or "server")
in: query
required: false
schema:
type: string
- name: error_type
description: The type of a request error
in: query
required: false
schema:
type: string
responses:
"200":
description: List of requests with corresponding metrics
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/RequestMetrics"
"400":
description: Validation error
content:
application/json:
schema:
type: object
properties:
errors:
type: object
additionalProperties:
type: string
example:
finished_from: invalid date format
finished_to: invalid date format
"/request-metrics/summary":
get:
summary: Get a summary of requests
description: Return a summary about number and duration of Cachito requests
parameters:
- name: finished_from
description: The earliest possible date/time of request end (date, datetime or timestamp format)
in: query
required: true
schema:
type: string
example: "2021-12-01"
- name: finished_to
description: The latest possible date/time of request end (date, datetime or timestamp format)
in: query
required: true
schema:
type: string
example: "2021-12-31"
responses:
"200":
description: Aggregated data about all requests of the given period
content:
application/json:
schema:
$ref: "#/components/schemas/RequestMetricsSummary"
"400":
description: Validation error
content:
application/json:
schema:
type: object
properties:
errors:
type: object
additionalProperties:
type: string
example:
finished_from: invalid date format
finished_to: invalid date format
components:
schemas:
Package:
type: object
example:
name: github.com/op/go-logging
type: gomod
version: "v0.1.1"
properties:
name:
type: string
example: github.com/op/go-logging
type:
type: string
example: gomod
version:
type: string
nullable: true
example: "v0.1.1"
PackageWithReplaces:
allOf:
- $ref: "#/components/schemas/Package"
- type: object
properties:
replaces:
$ref: "#/components/schemas/Package"
required:
- name
- type
- version
PackageReplacement:
allOf:
- type: object
properties:
new_name:
type: string
example: gitlab.com/op/go-logging
required:
- name
- type
- version
- $ref: "#/components/schemas/Package"
EnvironmentVariable:
type: object
additionalProperties:
type: string
example:
GOCACHE: deps/gomod
GOPATH: deps/gomod
EnvironmentVariableInfo:
type: object
properties:
value:
type: string
description: The value of the environment variable
example: "deps/gomod"
kind:
type: string
description: The kind of the environment variable, e.g. "path" or "literal"
example: "path"
required:
- kind
- value
Pagination:
type: object
properties:
first:
type: string
example: "https://cachito.domain.local/api/v1/requests?page=1&per_page=20&verbose=False"
last:
type: string
example: "https://cachito.domain.local/api/v1/requests?page=3&per_page=20&verbose=False"
next:
type: string
example: "https://cachito.domain.local/api/v1/requests?page=1&per_page=20&verbose=False"
page:
type: integer
example: 1
pages:
type: integer
example: 3
per_page:
type: integer
example: 20
previous:
type: string
example: null
total:
type: integer
example: 45
Purl:
type: string
example: "pkg:golang/github.com%2Frelease-engineering%2Fretrodep%2Fv2@v2.0.2"
RequestBase:
type: object
properties:
environment_variables:
$ref: "#/components/schemas/EnvironmentVariable"
flags:
type: array
items:
type: string
example:
- some_feature
- some_other_feature
id:
type: integer
example: 1
pkg_managers:
type: array
items:
type: string
example:
- gomod
ref:
type: string
example: "a7ac8d4c0b7fe90d51fb911511cbf6939655c877"
repo:
type: string
example: "https://github.com/kubernetes/kubernetes.git"
state:
type: string
example: complete
state_reason:
type: string
example: Completed successfully
updated:
type: string
example: "2019-09-17T19:42:47.149979"
user:
type: string
example: tbrady@DOMAIN.LOCAL
created:
type: string
example: "2019-09-17T18:52:57.577851"
Request:
allOf:
- type: object
properties:
dependencies:
type: integer
example: 309
packages:
type: integer
example: 1
submitted_by:
type: string
example: osbs@DOMAIN.LOCAL
- $ref: "#/components/schemas/RequestBase"
RequestConfiguration:
type: object
properties:
content:
type: string
description: Configuration file as base64 encoded string
example: IlNodXQgdXAgYnJhaW4gb3IgSSdsbCBzdGFiIHlvdSB3aXRoIGEgUS1UaXAiIC0gSG9tZXIgSi4gU2ltcHNvbg==
path:
type: string
description: The relative path in the bundle that the configuration should be created at
example: app/.npmrc
type:
type: string
description: The type of the configuration file content (currently only "base64" is supported)
example: base64
required:
- content
- path
- type
RequestMetrics:
type: object
properties:
id:
type: integer
example: 1234
final_state:
type: string
example: "complete"
final_state_reason:
type: string
example: "Completed successfully"
finished:
type: string
format: date-time
example: "2021-12-31T12:34:56.789012"
duration:
type: number
format: float
example: 4.321
time_in_queue:
type: number
format: float
example: 0.234
RequestMetricsSummary:
type: object
properties:
duration_avg:
type: number
format: float
example: 2.345
duration_50:
type: number
format: float
example: 2.109
duration_95:
type: number
format: float
example: 4.321
time_in_queue_avg:
type: number
format: float
example: 0.321
time_in_queue_95:
type: number
format: float
example: 0.987
client_errors:
type: number
format: integer
example: 7
server_errors:
type: number
format: integer
example: 2
total:
type: integer
RequestNew:
type: object