@jurislm/woodpecker-ci-plugin 1.1.9 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,4747 @@
1
+ components:
2
+ schemas:
3
+ Agent:
4
+ properties:
5
+ backend:
6
+ type: string
7
+ capacity:
8
+ type: integer
9
+ created:
10
+ type: integer
11
+ custom_labels:
12
+ additionalProperties:
13
+ type: string
14
+ type: object
15
+ filters:
16
+ additionalProperties:
17
+ type: string
18
+ description: Server side enforced agent filters
19
+ type: object
20
+ id:
21
+ type: integer
22
+ last_contact:
23
+ type: integer
24
+ last_work:
25
+ description: >-
26
+ last time the agent did something, this value is used to determine
27
+ if the agent is still doing work used by the autoscaler
28
+ type: integer
29
+ name:
30
+ type: string
31
+ no_schedule:
32
+ type: boolean
33
+ org_id:
34
+ description: >-
35
+ OrgID is counted as unset if set to -1, this is done to ensure a
36
+ new(Agent) still enforce the OrgID check by default
37
+ type: integer
38
+ owner_id:
39
+ type: integer
40
+ platform:
41
+ type: string
42
+ token:
43
+ type: string
44
+ updated:
45
+ type: integer
46
+ version:
47
+ type: string
48
+ type: object
49
+ CancelInfo:
50
+ properties:
51
+ canceled_by_step:
52
+ type: string
53
+ canceled_by_user:
54
+ type: string
55
+ superseded_by:
56
+ type: integer
57
+ type: object
58
+ Config:
59
+ properties:
60
+ data:
61
+ items:
62
+ type: integer
63
+ type: array
64
+ hash:
65
+ type: string
66
+ name:
67
+ type: string
68
+ type: object
69
+ Cron:
70
+ properties:
71
+ branch:
72
+ type: string
73
+ created:
74
+ type: integer
75
+ creator_id:
76
+ description: 'TODO: drop with next major version'
77
+ type: integer
78
+ enabled:
79
+ type: boolean
80
+ id:
81
+ type: integer
82
+ name:
83
+ type: string
84
+ next_exec:
85
+ type: integer
86
+ repo_id:
87
+ type: integer
88
+ schedule:
89
+ description: "@weekly,\t3min, ..."
90
+ type: string
91
+ timezone:
92
+ type: string
93
+ variables:
94
+ additionalProperties:
95
+ type: string
96
+ type: object
97
+ type: object
98
+ CronPatch:
99
+ properties:
100
+ branch:
101
+ type: string
102
+ enabled:
103
+ type: boolean
104
+ name:
105
+ type: string
106
+ schedule:
107
+ type: string
108
+ timezone:
109
+ type: string
110
+ variables:
111
+ additionalProperties:
112
+ type: string
113
+ type: object
114
+ type: object
115
+ Feed:
116
+ properties:
117
+ author:
118
+ type: string
119
+ author_avatar:
120
+ type: string
121
+ author_email:
122
+ type: string
123
+ branch:
124
+ type: string
125
+ commit:
126
+ type: string
127
+ created:
128
+ type: integer
129
+ event:
130
+ $ref: '#/components/schemas/WebhookEvent'
131
+ finished:
132
+ type: integer
133
+ full_name:
134
+ type: string
135
+ id:
136
+ type: integer
137
+ message:
138
+ description: // Deprecated
139
+ type: string
140
+ number:
141
+ type: integer
142
+ ref:
143
+ type: string
144
+ refspec:
145
+ type: string
146
+ release:
147
+ allOf:
148
+ - $ref: '#/components/schemas/Release'
149
+ description: |-
150
+ Ongoing Work: https://github.com/woodpecker-ci/woodpecker/pull/4626
151
+ // New
152
+ repo_id:
153
+ type: integer
154
+ started:
155
+ type: integer
156
+ status:
157
+ type: string
158
+ tag_title:
159
+ type: string
160
+ title:
161
+ type: string
162
+ type: object
163
+ Forge:
164
+ properties:
165
+ additional_options:
166
+ additionalProperties: {}
167
+ type: object
168
+ client:
169
+ type: string
170
+ id:
171
+ type: integer
172
+ oauth_host:
173
+ description: public url for oauth if different from url
174
+ type: string
175
+ orgs:
176
+ description: >-
177
+ members of those orgs may log in using this forge, in addition to
178
+ the globally allowed ones
179
+ items:
180
+ type: string
181
+ type: array
182
+ skip_verify:
183
+ type: boolean
184
+ type:
185
+ $ref: '#/components/schemas/model.ForgeType'
186
+ url:
187
+ type: string
188
+ type: object
189
+ ForgeWithOAuthClientSecret:
190
+ properties:
191
+ additional_options:
192
+ additionalProperties: {}
193
+ type: object
194
+ client:
195
+ type: string
196
+ id:
197
+ type: integer
198
+ oauth_client_secret:
199
+ type: string
200
+ oauth_host:
201
+ description: public url for oauth if different from url
202
+ type: string
203
+ orgs:
204
+ description: >-
205
+ members of those orgs may log in using this forge, in addition to
206
+ the globally allowed ones
207
+ items:
208
+ type: string
209
+ type: array
210
+ skip_verify:
211
+ type: boolean
212
+ type:
213
+ $ref: '#/components/schemas/model.ForgeType'
214
+ url:
215
+ type: string
216
+ type: object
217
+ LogEntry:
218
+ properties:
219
+ data:
220
+ items:
221
+ type: integer
222
+ type: array
223
+ id:
224
+ type: integer
225
+ line:
226
+ type: integer
227
+ step_id:
228
+ type: integer
229
+ time:
230
+ type: integer
231
+ type:
232
+ $ref: '#/components/schemas/LogEntryType'
233
+ type: object
234
+ LogEntryType:
235
+ enum:
236
+ - 0
237
+ - 1
238
+ - 2
239
+ - 3
240
+ - 4
241
+ type: integer
242
+ x-enum-varnames:
243
+ - LogEntryStdout
244
+ - LogEntryStderr
245
+ - LogEntryExitCode
246
+ - LogEntryMetadata
247
+ - LogEntryProgress
248
+ Org:
249
+ properties:
250
+ forge_id:
251
+ type: integer
252
+ id:
253
+ type: integer
254
+ is_user:
255
+ type: boolean
256
+ name:
257
+ type: string
258
+ type: object
259
+ OrgPerm:
260
+ properties:
261
+ admin:
262
+ type: boolean
263
+ member:
264
+ type: boolean
265
+ type: object
266
+ Perm:
267
+ properties:
268
+ admin:
269
+ type: boolean
270
+ created:
271
+ type: integer
272
+ pull:
273
+ type: boolean
274
+ push:
275
+ type: boolean
276
+ synced:
277
+ type: integer
278
+ updated:
279
+ type: integer
280
+ type: object
281
+ Pipeline:
282
+ properties:
283
+ author:
284
+ description: >-
285
+ TODO: only // The user sending the webhook data or triggering the
286
+ pipeline event
287
+ type: string
288
+ author_avatar:
289
+ description: >-
290
+ TODO: only & rename to AuthorAvatar // Avatar URL of the author of
291
+ the commit
292
+ type: string
293
+ author_email:
294
+ type: string
295
+ branch:
296
+ type: string
297
+ cancel_info:
298
+ $ref: '#/components/schemas/CancelInfo'
299
+ changed_files:
300
+ items:
301
+ type: string
302
+ type: array
303
+ commit:
304
+ type: string
305
+ created:
306
+ type: integer
307
+ cron:
308
+ description: name of the cron job
309
+ type: string
310
+ deploy_task:
311
+ type: string
312
+ deploy_to:
313
+ type: string
314
+ errors:
315
+ items:
316
+ $ref: '#/components/schemas/errors.PipelineError'
317
+ type: array
318
+ event:
319
+ $ref: '#/components/schemas/WebhookEvent'
320
+ event_reason:
321
+ items:
322
+ type: string
323
+ type: array
324
+ finished:
325
+ type: integer
326
+ forge_url:
327
+ type: string
328
+ from_fork:
329
+ type: boolean
330
+ id:
331
+ type: integer
332
+ is_prerelease:
333
+ description: deprecated, use release.is_prerelease instead
334
+ type: boolean
335
+ message:
336
+ type: string
337
+ number:
338
+ type: integer
339
+ parent:
340
+ type: integer
341
+ pr_draft:
342
+ type: boolean
343
+ pr_labels:
344
+ items:
345
+ type: string
346
+ type: array
347
+ pr_milestone:
348
+ type: string
349
+ ref:
350
+ type: string
351
+ refspec:
352
+ type: string
353
+ release:
354
+ allOf:
355
+ - $ref: '#/components/schemas/Release'
356
+ description: |-
357
+ Ongoing Work: https://github.com/woodpecker-ci/woodpecker/pull/4626
358
+ // New
359
+ rerun_count:
360
+ type: integer
361
+ reviewed:
362
+ type: integer
363
+ reviewed_by:
364
+ type: string
365
+ sender:
366
+ description: uses reported user for webhooks and name of cron for cron pipelines
367
+ type: string
368
+ started:
369
+ type: integer
370
+ status:
371
+ $ref: '#/components/schemas/StatusValue'
372
+ tag_title:
373
+ type: string
374
+ timestamp:
375
+ type: integer
376
+ title:
377
+ description: // Deprecated
378
+ type: string
379
+ updated:
380
+ type: integer
381
+ variables:
382
+ additionalProperties:
383
+ type: string
384
+ type: object
385
+ version:
386
+ type: string
387
+ workflows:
388
+ items:
389
+ $ref: '#/components/schemas/model.Workflow'
390
+ type: array
391
+ type: object
392
+ PipelineOptions:
393
+ properties:
394
+ branch:
395
+ type: string
396
+ message:
397
+ type: string
398
+ variables:
399
+ additionalProperties:
400
+ type: string
401
+ type: object
402
+ type: object
403
+ PullRequest:
404
+ properties:
405
+ index:
406
+ type: string
407
+ title:
408
+ type: string
409
+ type: object
410
+ QueueInfo:
411
+ properties:
412
+ paused:
413
+ type: boolean
414
+ pending:
415
+ items:
416
+ $ref: '#/components/schemas/model.QueueTask'
417
+ type: array
418
+ running:
419
+ items:
420
+ $ref: '#/components/schemas/model.QueueTask'
421
+ type: array
422
+ stats:
423
+ properties:
424
+ pending_count:
425
+ type: integer
426
+ running_count:
427
+ type: integer
428
+ waiting_on_deps_count:
429
+ type: integer
430
+ worker_count:
431
+ type: integer
432
+ type: object
433
+ waiting_on_deps:
434
+ items:
435
+ $ref: '#/components/schemas/model.QueueTask'
436
+ type: array
437
+ type: object
438
+ Registry:
439
+ properties:
440
+ address:
441
+ type: string
442
+ id:
443
+ type: integer
444
+ org_id:
445
+ type: integer
446
+ password:
447
+ type: string
448
+ readonly:
449
+ type: boolean
450
+ repo_id:
451
+ type: integer
452
+ username:
453
+ type: string
454
+ type: object
455
+ Release:
456
+ properties:
457
+ is_prerelease:
458
+ type: boolean
459
+ title:
460
+ type: string
461
+ type: object
462
+ Repo:
463
+ properties:
464
+ active:
465
+ type: boolean
466
+ allow_deploy:
467
+ type: boolean
468
+ allow_pr:
469
+ type: boolean
470
+ approval_allowed_users:
471
+ items:
472
+ type: string
473
+ type: array
474
+ avatar_url:
475
+ type: string
476
+ cancel_previous_pipeline_events:
477
+ items:
478
+ $ref: '#/components/schemas/WebhookEvent'
479
+ type: array
480
+ clone_url:
481
+ type: string
482
+ clone_url_ssh:
483
+ type: string
484
+ config_extension_endpoint:
485
+ type: string
486
+ config_extension_exclusive:
487
+ type: boolean
488
+ config_extension_netrc:
489
+ type: boolean
490
+ config_file:
491
+ type: string
492
+ default_branch:
493
+ type: string
494
+ forge_id:
495
+ type: integer
496
+ forge_remote_id:
497
+ description: >-
498
+ ForgeRemoteID is the unique identifier for the repository on the
499
+ forge.
500
+ type: string
501
+ forge_url:
502
+ type: string
503
+ full_name:
504
+ type: string
505
+ has_forge_name_conflict:
506
+ description: >-
507
+ HasForgeNameConflict is true if forge returned a repo with same name
508
+ but different forge remote id
509
+ type: boolean
510
+ has_no_forge_repo:
511
+ description: >-
512
+ HasNoForgeRepo is true if repo only exist in the woodpecker store
513
+ and not at the forge anymore
514
+ type: boolean
515
+ id:
516
+ type: integer
517
+ name:
518
+ type: string
519
+ netrc_trusted:
520
+ items:
521
+ type: string
522
+ type: array
523
+ org_id:
524
+ type: integer
525
+ owner:
526
+ type: string
527
+ pr_enabled:
528
+ type: boolean
529
+ private:
530
+ type: boolean
531
+ registry_extension_endpoint:
532
+ type: string
533
+ registry_extension_netrc:
534
+ type: boolean
535
+ require_approval:
536
+ $ref: '#/components/schemas/model.ApprovalMode'
537
+ secret_extension_endpoint:
538
+ type: string
539
+ secret_extension_netrc:
540
+ type: boolean
541
+ timeout:
542
+ type: integer
543
+ trusted:
544
+ $ref: '#/components/schemas/model.TrustedConfiguration'
545
+ visibility:
546
+ $ref: '#/components/schemas/RepoVisibility'
547
+ type: object
548
+ RepoLastPipeline:
549
+ properties:
550
+ active:
551
+ type: boolean
552
+ allow_deploy:
553
+ type: boolean
554
+ allow_pr:
555
+ type: boolean
556
+ approval_allowed_users:
557
+ items:
558
+ type: string
559
+ type: array
560
+ avatar_url:
561
+ type: string
562
+ cancel_previous_pipeline_events:
563
+ items:
564
+ $ref: '#/components/schemas/WebhookEvent'
565
+ type: array
566
+ clone_url:
567
+ type: string
568
+ clone_url_ssh:
569
+ type: string
570
+ config_extension_endpoint:
571
+ type: string
572
+ config_extension_exclusive:
573
+ type: boolean
574
+ config_extension_netrc:
575
+ type: boolean
576
+ config_file:
577
+ type: string
578
+ default_branch:
579
+ type: string
580
+ forge_id:
581
+ type: integer
582
+ forge_remote_id:
583
+ description: >-
584
+ ForgeRemoteID is the unique identifier for the repository on the
585
+ forge.
586
+ type: string
587
+ forge_url:
588
+ type: string
589
+ full_name:
590
+ type: string
591
+ has_forge_name_conflict:
592
+ description: >-
593
+ HasForgeNameConflict is true if forge returned a repo with same name
594
+ but different forge remote id
595
+ type: boolean
596
+ has_no_forge_repo:
597
+ description: >-
598
+ HasNoForgeRepo is true if repo only exist in the woodpecker store
599
+ and not at the forge anymore
600
+ type: boolean
601
+ id:
602
+ type: integer
603
+ last_pipeline:
604
+ $ref: '#/components/schemas/Pipeline'
605
+ name:
606
+ type: string
607
+ netrc_trusted:
608
+ items:
609
+ type: string
610
+ type: array
611
+ org_id:
612
+ type: integer
613
+ owner:
614
+ type: string
615
+ pr_enabled:
616
+ type: boolean
617
+ private:
618
+ type: boolean
619
+ registry_extension_endpoint:
620
+ type: string
621
+ registry_extension_netrc:
622
+ type: boolean
623
+ require_approval:
624
+ $ref: '#/components/schemas/model.ApprovalMode'
625
+ secret_extension_endpoint:
626
+ type: string
627
+ secret_extension_netrc:
628
+ type: boolean
629
+ timeout:
630
+ type: integer
631
+ trusted:
632
+ $ref: '#/components/schemas/model.TrustedConfiguration'
633
+ visibility:
634
+ $ref: '#/components/schemas/RepoVisibility'
635
+ type: object
636
+ RepoPatch:
637
+ properties:
638
+ allow_deploy:
639
+ type: boolean
640
+ allow_pr:
641
+ type: boolean
642
+ approval_allowed_users:
643
+ items:
644
+ type: string
645
+ type: array
646
+ cancel_previous_pipeline_events:
647
+ items:
648
+ $ref: '#/components/schemas/WebhookEvent'
649
+ type: array
650
+ config_extension_endpoint:
651
+ type: string
652
+ config_extension_exclusive:
653
+ type: boolean
654
+ config_extension_netrc:
655
+ type: boolean
656
+ config_file:
657
+ type: string
658
+ netrc_trusted:
659
+ items:
660
+ type: string
661
+ type: array
662
+ registry_extension_endpoint:
663
+ type: string
664
+ registry_extension_netrc:
665
+ type: boolean
666
+ require_approval:
667
+ type: string
668
+ secret_extension_endpoint:
669
+ type: string
670
+ secret_extension_netrc:
671
+ type: boolean
672
+ timeout:
673
+ type: integer
674
+ trusted:
675
+ $ref: '#/components/schemas/model.TrustedConfigurationPatch'
676
+ visibility:
677
+ type: string
678
+ type: object
679
+ RepoVisibility:
680
+ enum:
681
+ - public
682
+ - private
683
+ - internal
684
+ type: string
685
+ x-enum-varnames:
686
+ - VisibilityPublic
687
+ - VisibilityPrivate
688
+ - VisibilityInternal
689
+ Secret:
690
+ properties:
691
+ events:
692
+ items:
693
+ $ref: '#/components/schemas/WebhookEvent'
694
+ type: array
695
+ id:
696
+ type: integer
697
+ images:
698
+ items:
699
+ type: string
700
+ type: array
701
+ name:
702
+ type: string
703
+ note:
704
+ type: string
705
+ org_id:
706
+ type: integer
707
+ repo_id:
708
+ type: integer
709
+ value:
710
+ type: string
711
+ type: object
712
+ SecretPatch:
713
+ properties:
714
+ events:
715
+ items:
716
+ $ref: '#/components/schemas/WebhookEvent'
717
+ type: array
718
+ images:
719
+ items:
720
+ type: string
721
+ type: array
722
+ name:
723
+ type: string
724
+ note:
725
+ type: string
726
+ value:
727
+ type: string
728
+ type: object
729
+ StatusValue:
730
+ enum:
731
+ - skipped
732
+ - pending
733
+ - running
734
+ - success
735
+ - failure
736
+ - killed
737
+ - canceled
738
+ - error
739
+ - blocked
740
+ - declined
741
+ - created
742
+ type: string
743
+ x-enum-comments:
744
+ StatusBlocked: waiting for approval
745
+ StatusCanceled: canceled but hasn't been started
746
+ StatusCreated: created / internal use only
747
+ StatusDeclined: blocked and declined
748
+ StatusError: error with the config / while parsing / some other system problem
749
+ StatusFailure: failed to finish (exit code != 0)
750
+ StatusKilled: killed by user
751
+ StatusPending: pending to be executed
752
+ StatusRunning: currently running
753
+ StatusSkipped: skipped as per condition of current workflow failed/success state
754
+ StatusSuccess: successfully finished
755
+ x-enum-descriptions:
756
+ - skipped as per condition of current workflow failed/success state
757
+ - pending to be executed
758
+ - currently running
759
+ - successfully finished
760
+ - failed to finish (exit code != 0)
761
+ - killed by user
762
+ - canceled but hasn't been started
763
+ - error with the config / while parsing / some other system problem
764
+ - waiting for approval
765
+ - blocked and declined
766
+ - created / internal use only
767
+ x-enum-varnames:
768
+ - StatusSkipped
769
+ - StatusPending
770
+ - StatusRunning
771
+ - StatusSuccess
772
+ - StatusFailure
773
+ - StatusKilled
774
+ - StatusCanceled
775
+ - StatusError
776
+ - StatusBlocked
777
+ - StatusDeclined
778
+ - StatusCreated
779
+ Step:
780
+ properties:
781
+ error:
782
+ type: string
783
+ exit_code:
784
+ type: integer
785
+ finished:
786
+ type: integer
787
+ id:
788
+ type: integer
789
+ name:
790
+ type: string
791
+ pid:
792
+ type: integer
793
+ pipeline_id:
794
+ type: integer
795
+ ppid:
796
+ type: integer
797
+ started:
798
+ type: integer
799
+ state:
800
+ $ref: '#/components/schemas/StatusValue'
801
+ type:
802
+ $ref: '#/components/schemas/StepType'
803
+ uuid:
804
+ type: string
805
+ type: object
806
+ StepType:
807
+ enum:
808
+ - clone
809
+ - service
810
+ - plugin
811
+ - commands
812
+ - cache
813
+ type: string
814
+ x-enum-varnames:
815
+ - StepTypeClone
816
+ - StepTypeService
817
+ - StepTypePlugin
818
+ - StepTypeCommands
819
+ - StepTypeCache
820
+ Task:
821
+ properties:
822
+ agent_id:
823
+ type: integer
824
+ concurrency_group:
825
+ description: >-
826
+ ConcurrencyGroup identifies tasks that are limited against each
827
+ other.
828
+
829
+ It is empty when no concurrency limit applies.
830
+ type: string
831
+ concurrency_limit:
832
+ description: |-
833
+ ConcurrencyLimit is the maximum number of tasks sharing the same
834
+ ConcurrencyGroup that may run at once. A value <= 0 means unlimited.
835
+ type: integer
836
+ created:
837
+ description: |-
838
+ Created is the unix timestamp the task's pipeline was created at. It
839
+ defines the queue ordering across pipelines.
840
+ type: integer
841
+ dep_status:
842
+ additionalProperties:
843
+ $ref: '#/components/schemas/StatusValue'
844
+ type: object
845
+ dependencies:
846
+ items:
847
+ type: string
848
+ type: array
849
+ id:
850
+ type: string
851
+ labels:
852
+ additionalProperties:
853
+ type: string
854
+ type: object
855
+ name:
856
+ type: string
857
+ pid:
858
+ type: integer
859
+ pipeline_id:
860
+ type: integer
861
+ repo_id:
862
+ type: integer
863
+ run_on:
864
+ items:
865
+ type: string
866
+ type: array
867
+ type: object
868
+ User:
869
+ properties:
870
+ admin:
871
+ description: |-
872
+ Admin indicates the user is a system administrator.
873
+
874
+ NOTE: If the username is part of the WOODPECKER_ADMIN
875
+ environment variable, this value will be set to true on login.
876
+ type: boolean
877
+ admin_env:
878
+ type: boolean
879
+ avatar_url:
880
+ description: the avatar url for this user.
881
+ type: string
882
+ email:
883
+ description: |-
884
+ Email is the email address for this user.
885
+
886
+ required: true
887
+ type: string
888
+ forge_id:
889
+ type: integer
890
+ forge_remote_id:
891
+ type: string
892
+ id:
893
+ description: |-
894
+ the id for this user.
895
+
896
+ required: true
897
+ type: integer
898
+ login:
899
+ description: |-
900
+ Login is the username for this user.
901
+
902
+ required: true
903
+ type: string
904
+ org_id:
905
+ description: OrgID is the of the user as model.Org.
906
+ type: integer
907
+ type: object
908
+ WebhookEvent:
909
+ enum:
910
+ - push
911
+ - pull_request
912
+ - pull_request_closed
913
+ - pull_request_metadata
914
+ - tag
915
+ - release
916
+ - deployment
917
+ - cron
918
+ - manual
919
+ type: string
920
+ x-enum-varnames:
921
+ - EventPush
922
+ - EventPull
923
+ - EventPullClosed
924
+ - EventPullMetadata
925
+ - EventTag
926
+ - EventRelease
927
+ - EventDeploy
928
+ - EventCron
929
+ - EventManual
930
+ errors.PipelineError:
931
+ properties:
932
+ data: {}
933
+ is_warning:
934
+ type: boolean
935
+ message:
936
+ type: string
937
+ type:
938
+ $ref: '#/components/schemas/errors.PipelineErrorType'
939
+ type: object
940
+ errors.PipelineErrorType:
941
+ enum:
942
+ - linter
943
+ - deprecation
944
+ - compiler
945
+ - generic
946
+ - bad_habit
947
+ type: string
948
+ x-enum-comments:
949
+ PipelineErrorTypeBadHabit: some bad-habit error
950
+ PipelineErrorTypeCompiler: some error with the config semantics
951
+ PipelineErrorTypeDeprecation: using some deprecated feature
952
+ PipelineErrorTypeGeneric: some generic error
953
+ PipelineErrorTypeLinter: some error with the config syntax
954
+ x-enum-descriptions:
955
+ - some error with the config syntax
956
+ - using some deprecated feature
957
+ - some error with the config semantics
958
+ - some generic error
959
+ - some bad-habit error
960
+ x-enum-varnames:
961
+ - PipelineErrorTypeLinter
962
+ - PipelineErrorTypeDeprecation
963
+ - PipelineErrorTypeCompiler
964
+ - PipelineErrorTypeGeneric
965
+ - PipelineErrorTypeBadHabit
966
+ metadata.Author:
967
+ properties:
968
+ email:
969
+ type: string
970
+ name:
971
+ type: string
972
+ type: object
973
+ metadata.Commit:
974
+ properties:
975
+ author:
976
+ $ref: '#/components/schemas/metadata.Author'
977
+ branch:
978
+ type: string
979
+ changed_files:
980
+ items:
981
+ type: string
982
+ type: array
983
+ draft:
984
+ type: boolean
985
+ labels:
986
+ items:
987
+ type: string
988
+ type: array
989
+ message:
990
+ type: string
991
+ milestone:
992
+ type: string
993
+ ref:
994
+ type: string
995
+ refspec:
996
+ type: string
997
+ sha:
998
+ type: string
999
+ timestamp:
1000
+ type: integer
1001
+ type: object
1002
+ metadata.Event:
1003
+ enum:
1004
+ - push
1005
+ - pull_request
1006
+ - pull_request_closed
1007
+ - pull_request_metadata
1008
+ - tag
1009
+ - release
1010
+ - deployment
1011
+ - cron
1012
+ - manual
1013
+ type: string
1014
+ x-enum-varnames:
1015
+ - EventPush
1016
+ - EventPull
1017
+ - EventPullClosed
1018
+ - EventPullMetadata
1019
+ - EventTag
1020
+ - EventRelease
1021
+ - EventDeploy
1022
+ - EventCron
1023
+ - EventManual
1024
+ metadata.Forge:
1025
+ properties:
1026
+ type:
1027
+ type: string
1028
+ url:
1029
+ type: string
1030
+ type: object
1031
+ metadata.Metadata:
1032
+ properties:
1033
+ curr:
1034
+ $ref: '#/components/schemas/metadata.Pipeline'
1035
+ forge:
1036
+ $ref: '#/components/schemas/metadata.Forge'
1037
+ id:
1038
+ type: string
1039
+ prev:
1040
+ $ref: '#/components/schemas/metadata.Pipeline'
1041
+ repo:
1042
+ $ref: '#/components/schemas/metadata.Repo'
1043
+ step:
1044
+ $ref: '#/components/schemas/metadata.Step'
1045
+ sys:
1046
+ $ref: '#/components/schemas/metadata.System'
1047
+ workflow:
1048
+ $ref: '#/components/schemas/metadata.Workflow'
1049
+ type: object
1050
+ metadata.Pipeline:
1051
+ properties:
1052
+ author:
1053
+ type: string
1054
+ avatar:
1055
+ type: string
1056
+ commit:
1057
+ $ref: '#/components/schemas/metadata.Commit'
1058
+ created:
1059
+ type: integer
1060
+ cron:
1061
+ type: string
1062
+ event:
1063
+ $ref: '#/components/schemas/metadata.Event'
1064
+ event_reason:
1065
+ items:
1066
+ type: string
1067
+ type: array
1068
+ finished:
1069
+ type: integer
1070
+ forge_url:
1071
+ type: string
1072
+ number:
1073
+ type: integer
1074
+ parent:
1075
+ type: integer
1076
+ release:
1077
+ $ref: '#/components/schemas/metadata.Release'
1078
+ rerun_count:
1079
+ type: integer
1080
+ started:
1081
+ type: integer
1082
+ status:
1083
+ type: string
1084
+ target:
1085
+ type: string
1086
+ task:
1087
+ type: string
1088
+ type: object
1089
+ metadata.Release:
1090
+ properties:
1091
+ is_prerelease:
1092
+ type: boolean
1093
+ title:
1094
+ type: string
1095
+ type: object
1096
+ metadata.Repo:
1097
+ properties:
1098
+ clone_url:
1099
+ type: string
1100
+ clone_url_ssh:
1101
+ type: string
1102
+ default_branch:
1103
+ type: string
1104
+ forge_url:
1105
+ type: string
1106
+ id:
1107
+ type: integer
1108
+ name:
1109
+ type: string
1110
+ org_id:
1111
+ type: integer
1112
+ owner:
1113
+ type: string
1114
+ private:
1115
+ type: boolean
1116
+ remote_id:
1117
+ type: string
1118
+ trusted:
1119
+ $ref: '#/components/schemas/metadata.TrustedConfiguration'
1120
+ type: object
1121
+ metadata.Step:
1122
+ properties:
1123
+ name:
1124
+ type: string
1125
+ number:
1126
+ type: integer
1127
+ type: object
1128
+ metadata.System:
1129
+ properties:
1130
+ arch:
1131
+ type: string
1132
+ host:
1133
+ type: string
1134
+ name:
1135
+ type: string
1136
+ url:
1137
+ type: string
1138
+ version:
1139
+ type: string
1140
+ type: object
1141
+ metadata.TrustedConfiguration:
1142
+ properties:
1143
+ network:
1144
+ type: boolean
1145
+ security:
1146
+ type: boolean
1147
+ volumes:
1148
+ type: boolean
1149
+ type: object
1150
+ metadata.Workflow:
1151
+ properties:
1152
+ matrix:
1153
+ additionalProperties:
1154
+ type: string
1155
+ type: object
1156
+ name:
1157
+ type: string
1158
+ number:
1159
+ type: integer
1160
+ type: object
1161
+ model.ApprovalMode:
1162
+ enum:
1163
+ - none
1164
+ - forks
1165
+ - pull_requests
1166
+ - all_events
1167
+ type: string
1168
+ x-enum-comments:
1169
+ RequireApprovalAllEvents: require approval for all external events
1170
+ RequireApprovalForks: require approval for PRs from forks (default)
1171
+ RequireApprovalNone: require approval for no events
1172
+ RequireApprovalPullRequests: require approval for all PRs
1173
+ x-enum-descriptions:
1174
+ - require approval for no events
1175
+ - require approval for PRs from forks (default)
1176
+ - require approval for all PRs
1177
+ - require approval for all external events
1178
+ x-enum-varnames:
1179
+ - RequireApprovalNone
1180
+ - RequireApprovalForks
1181
+ - RequireApprovalPullRequests
1182
+ - RequireApprovalAllEvents
1183
+ model.ForgeType:
1184
+ enum:
1185
+ - github
1186
+ - gitlab
1187
+ - gitea
1188
+ - forgejo
1189
+ - bitbucket
1190
+ - bitbucket-dc
1191
+ - addon
1192
+ type: string
1193
+ x-enum-varnames:
1194
+ - ForgeTypeGithub
1195
+ - ForgeTypeGitlab
1196
+ - ForgeTypeGitea
1197
+ - ForgeTypeForgejo
1198
+ - ForgeTypeBitbucket
1199
+ - ForgeTypeBitbucketDatacenter
1200
+ - ForgeTypeAddon
1201
+ model.QueueTask:
1202
+ properties:
1203
+ agent_id:
1204
+ type: integer
1205
+ agent_name:
1206
+ type: string
1207
+ concurrency_group:
1208
+ description: >-
1209
+ ConcurrencyGroup identifies tasks that are limited against each
1210
+ other.
1211
+
1212
+ It is empty when no concurrency limit applies.
1213
+ type: string
1214
+ concurrency_limit:
1215
+ description: |-
1216
+ ConcurrencyLimit is the maximum number of tasks sharing the same
1217
+ ConcurrencyGroup that may run at once. A value <= 0 means unlimited.
1218
+ type: integer
1219
+ created:
1220
+ description: |-
1221
+ Created is the unix timestamp the task's pipeline was created at. It
1222
+ defines the queue ordering across pipelines.
1223
+ type: integer
1224
+ dep_status:
1225
+ additionalProperties:
1226
+ $ref: '#/components/schemas/StatusValue'
1227
+ type: object
1228
+ dependencies:
1229
+ items:
1230
+ type: string
1231
+ type: array
1232
+ id:
1233
+ type: string
1234
+ labels:
1235
+ additionalProperties:
1236
+ type: string
1237
+ type: object
1238
+ name:
1239
+ type: string
1240
+ pid:
1241
+ type: integer
1242
+ pipeline_id:
1243
+ type: integer
1244
+ pipeline_number:
1245
+ type: integer
1246
+ repo_id:
1247
+ type: integer
1248
+ run_on:
1249
+ items:
1250
+ type: string
1251
+ type: array
1252
+ type: object
1253
+ model.TrustedConfiguration:
1254
+ properties:
1255
+ network:
1256
+ type: boolean
1257
+ security:
1258
+ type: boolean
1259
+ volumes:
1260
+ type: boolean
1261
+ type: object
1262
+ model.TrustedConfigurationPatch:
1263
+ properties:
1264
+ network:
1265
+ type: boolean
1266
+ security:
1267
+ type: boolean
1268
+ volumes:
1269
+ type: boolean
1270
+ type: object
1271
+ model.Workflow:
1272
+ properties:
1273
+ agent_id:
1274
+ type: integer
1275
+ children:
1276
+ items:
1277
+ $ref: '#/components/schemas/Step'
1278
+ type: array
1279
+ environ:
1280
+ additionalProperties:
1281
+ type: string
1282
+ type: object
1283
+ error:
1284
+ type: string
1285
+ finished:
1286
+ type: integer
1287
+ id:
1288
+ type: integer
1289
+ name:
1290
+ type: string
1291
+ pid:
1292
+ type: integer
1293
+ pipeline_id:
1294
+ type: integer
1295
+ platform:
1296
+ type: string
1297
+ started:
1298
+ type: integer
1299
+ state:
1300
+ $ref: '#/components/schemas/StatusValue'
1301
+ type: object
1302
+ info:
1303
+ contact:
1304
+ name: Woodpecker CI
1305
+ url: https://woodpecker-ci.org/
1306
+ description: >-
1307
+ Woodpecker is a simple, yet powerful CI/CD engine with great extensibility.
1308
+
1309
+ To get a personal access token (PAT) for authentication, please log in your
1310
+ Woodpecker server,
1311
+
1312
+ and go to you personal profile page, by clicking the user icon at the top
1313
+ right.
1314
+ title: Woodpecker CI API
1315
+ version: dev
1316
+ openapi: 3.0.3
1317
+ paths:
1318
+ /agents:
1319
+ get:
1320
+ parameters:
1321
+ - description: Insert your personal access token
1322
+ in: header
1323
+ name: Authorization
1324
+ required: true
1325
+ schema:
1326
+ default: Bearer <personal access token>
1327
+ type: string
1328
+ - description: for response pagination, page offset number
1329
+ in: query
1330
+ name: page
1331
+ schema:
1332
+ default: 1
1333
+ type: integer
1334
+ - description: for response pagination, max items per page
1335
+ in: query
1336
+ name: perPage
1337
+ schema:
1338
+ default: 50
1339
+ type: integer
1340
+ responses:
1341
+ '200':
1342
+ content:
1343
+ application/json:
1344
+ schema:
1345
+ items:
1346
+ $ref: '#/components/schemas/Agent'
1347
+ type: array
1348
+ description: OK
1349
+ summary: List agents
1350
+ tags:
1351
+ - Agents
1352
+ post:
1353
+ description: Creates a new agent with a random token
1354
+ parameters:
1355
+ - description: Insert your personal access token
1356
+ in: header
1357
+ name: Authorization
1358
+ required: true
1359
+ schema:
1360
+ default: Bearer <personal access token>
1361
+ type: string
1362
+ requestBody:
1363
+ content:
1364
+ '*/*':
1365
+ schema:
1366
+ $ref: '#/components/schemas/Agent'
1367
+ description: the agent's data (only 'name', 'no_schedule' and 'filters' are read)
1368
+ required: true
1369
+ x-originalParamName: agent
1370
+ responses:
1371
+ '200':
1372
+ content:
1373
+ application/json:
1374
+ schema:
1375
+ $ref: '#/components/schemas/Agent'
1376
+ description: OK
1377
+ summary: Create a new agent
1378
+ tags:
1379
+ - Agents
1380
+ /agents/{agent_id}:
1381
+ delete:
1382
+ parameters:
1383
+ - description: Insert your personal access token
1384
+ in: header
1385
+ name: Authorization
1386
+ required: true
1387
+ schema:
1388
+ default: Bearer <personal access token>
1389
+ type: string
1390
+ - description: the agent's id
1391
+ in: path
1392
+ name: agent_id
1393
+ required: true
1394
+ schema:
1395
+ type: integer
1396
+ responses:
1397
+ '200':
1398
+ description: OK
1399
+ summary: Delete an agent
1400
+ tags:
1401
+ - Agents
1402
+ get:
1403
+ parameters:
1404
+ - description: Insert your personal access token
1405
+ in: header
1406
+ name: Authorization
1407
+ required: true
1408
+ schema:
1409
+ default: Bearer <personal access token>
1410
+ type: string
1411
+ - description: the agent's id
1412
+ in: path
1413
+ name: agent_id
1414
+ required: true
1415
+ schema:
1416
+ type: integer
1417
+ responses:
1418
+ '200':
1419
+ content:
1420
+ application/json:
1421
+ schema:
1422
+ $ref: '#/components/schemas/Agent'
1423
+ description: OK
1424
+ summary: Get an agent
1425
+ tags:
1426
+ - Agents
1427
+ patch:
1428
+ parameters:
1429
+ - description: Insert your personal access token
1430
+ in: header
1431
+ name: Authorization
1432
+ required: true
1433
+ schema:
1434
+ default: Bearer <personal access token>
1435
+ type: string
1436
+ - description: the agent's id
1437
+ in: path
1438
+ name: agent_id
1439
+ required: true
1440
+ schema:
1441
+ type: integer
1442
+ requestBody:
1443
+ content:
1444
+ '*/*':
1445
+ schema:
1446
+ $ref: '#/components/schemas/Agent'
1447
+ description: the agent's data
1448
+ required: true
1449
+ x-originalParamName: agentData
1450
+ responses:
1451
+ '200':
1452
+ content:
1453
+ application/json:
1454
+ schema:
1455
+ $ref: '#/components/schemas/Agent'
1456
+ description: OK
1457
+ summary: Update an agent
1458
+ tags:
1459
+ - Agents
1460
+ /agents/{agent_id}/tasks:
1461
+ get:
1462
+ parameters:
1463
+ - description: Insert your personal access token
1464
+ in: header
1465
+ name: Authorization
1466
+ required: true
1467
+ schema:
1468
+ default: Bearer <personal access token>
1469
+ type: string
1470
+ - description: the agent's id
1471
+ in: path
1472
+ name: agent_id
1473
+ required: true
1474
+ schema:
1475
+ type: integer
1476
+ responses:
1477
+ '200':
1478
+ content:
1479
+ application/json:
1480
+ schema:
1481
+ items:
1482
+ $ref: '#/components/schemas/Task'
1483
+ type: array
1484
+ description: OK
1485
+ summary: List agent tasks
1486
+ tags:
1487
+ - Agents
1488
+ /badges/{repo_id}/cc.xml:
1489
+ get:
1490
+ description: >-
1491
+ CCMenu displays the pipeline status of projects on a CI server as an
1492
+ item in the Mac's menu bar.
1493
+
1494
+ More details on how to install, you can find at http://ccmenu.org/
1495
+
1496
+ The response format adheres to CCTray v1 Specification,
1497
+ https://cctray.org/v1/
1498
+ parameters:
1499
+ - description: the repository id
1500
+ in: path
1501
+ name: repo_id
1502
+ required: true
1503
+ schema:
1504
+ type: integer
1505
+ responses:
1506
+ '200':
1507
+ description: OK
1508
+ summary: Provide pipeline status information to the CCMenu tool
1509
+ tags:
1510
+ - Badges
1511
+ /badges/{repo_id}/status.svg:
1512
+ get:
1513
+ parameters:
1514
+ - description: the repository id
1515
+ in: path
1516
+ name: repo_id
1517
+ required: true
1518
+ schema:
1519
+ type: integer
1520
+ responses:
1521
+ '200':
1522
+ description: OK
1523
+ summary: Get status of pipeline as SVG badge
1524
+ tags:
1525
+ - Badges
1526
+ /debug/pprof:
1527
+ get:
1528
+ description: Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1529
+ parameters:
1530
+ - description: Insert your personal access token
1531
+ in: header
1532
+ name: Authorization
1533
+ required: true
1534
+ schema:
1535
+ default: Bearer <personal access token>
1536
+ type: string
1537
+ responses:
1538
+ '200':
1539
+ description: OK
1540
+ summary: List available pprof profiles (HTML)
1541
+ tags:
1542
+ - Process profiling and debugging
1543
+ /debug/pprof/block:
1544
+ get:
1545
+ description: Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1546
+ parameters:
1547
+ - description: Insert your personal access token
1548
+ in: header
1549
+ name: Authorization
1550
+ required: true
1551
+ schema:
1552
+ default: Bearer <personal access token>
1553
+ type: string
1554
+ responses:
1555
+ '200':
1556
+ description: OK
1557
+ summary: >-
1558
+ Get pprof stack traces that led to blocking on synchronization
1559
+ primitives
1560
+ tags:
1561
+ - Process profiling and debugging
1562
+ /debug/pprof/cmdline:
1563
+ get:
1564
+ description: Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1565
+ parameters:
1566
+ - description: Insert your personal access token
1567
+ in: header
1568
+ name: Authorization
1569
+ required: true
1570
+ schema:
1571
+ default: Bearer <personal access token>
1572
+ type: string
1573
+ responses:
1574
+ '200':
1575
+ description: OK
1576
+ summary: Get the command line invocation of the current program
1577
+ tags:
1578
+ - Process profiling and debugging
1579
+ /debug/pprof/goroutine:
1580
+ get:
1581
+ description: Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1582
+ parameters:
1583
+ - description: Insert your personal access token
1584
+ in: header
1585
+ name: Authorization
1586
+ required: true
1587
+ schema:
1588
+ default: Bearer <personal access token>
1589
+ type: string
1590
+ - description: >-
1591
+ Use debug=2 as a query parameter to export in the same format as an
1592
+ un-recovered panic
1593
+ in: query
1594
+ name: debug
1595
+ schema:
1596
+ default: 1
1597
+ type: integer
1598
+ responses:
1599
+ '200':
1600
+ description: OK
1601
+ summary: Get pprof stack traces of all current goroutines
1602
+ tags:
1603
+ - Process profiling and debugging
1604
+ /debug/pprof/heap:
1605
+ get:
1606
+ description: Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1607
+ parameters:
1608
+ - description: Insert your personal access token
1609
+ in: header
1610
+ name: Authorization
1611
+ required: true
1612
+ schema:
1613
+ default: Bearer <personal access token>
1614
+ type: string
1615
+ - description: You can specify gc=heap to run GC before taking the heap sample
1616
+ in: query
1617
+ name: gc
1618
+ schema:
1619
+ default: ''
1620
+ type: string
1621
+ responses:
1622
+ '200':
1623
+ description: OK
1624
+ summary: Get pprof heap dump, a sampling of memory allocations of live objects
1625
+ tags:
1626
+ - Process profiling and debugging
1627
+ /debug/pprof/profile:
1628
+ get:
1629
+ description: >-
1630
+ Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1631
+
1632
+ After you get the profile file, use the go tool pprof command to
1633
+ investigate the profile.
1634
+ parameters:
1635
+ - description: Insert your personal access token
1636
+ in: header
1637
+ name: Authorization
1638
+ required: true
1639
+ schema:
1640
+ default: Bearer <personal access token>
1641
+ type: string
1642
+ - description: You can specify the duration in the seconds GET parameter.
1643
+ in: query
1644
+ name: seconds
1645
+ required: true
1646
+ schema:
1647
+ type: integer
1648
+ responses:
1649
+ '200':
1650
+ description: OK
1651
+ summary: Get pprof CPU profile
1652
+ tags:
1653
+ - Process profiling and debugging
1654
+ /debug/pprof/symbol:
1655
+ get:
1656
+ description: >-
1657
+ Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1658
+
1659
+ Looks up the program counters listed in the request,
1660
+
1661
+ responding with a table mapping program counters to function names.
1662
+
1663
+ The requested program counters can be provided via GET + query
1664
+ parameters,
1665
+
1666
+ or POST + body parameters. Program counters shall be space delimited.
1667
+ parameters:
1668
+ - description: Insert your personal access token
1669
+ in: header
1670
+ name: Authorization
1671
+ required: true
1672
+ schema:
1673
+ default: Bearer <personal access token>
1674
+ type: string
1675
+ responses:
1676
+ '200':
1677
+ description: OK
1678
+ summary: Get pprof program counters mapping to function names
1679
+ tags:
1680
+ - Process profiling and debugging
1681
+ post:
1682
+ description: >-
1683
+ Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1684
+
1685
+ Looks up the program counters listed in the request,
1686
+
1687
+ responding with a table mapping program counters to function names.
1688
+
1689
+ The requested program counters can be provided via GET + query
1690
+ parameters,
1691
+
1692
+ or POST + body parameters. Program counters shall be space delimited.
1693
+ parameters:
1694
+ - description: Insert your personal access token
1695
+ in: header
1696
+ name: Authorization
1697
+ required: true
1698
+ schema:
1699
+ default: Bearer <personal access token>
1700
+ type: string
1701
+ responses:
1702
+ '200':
1703
+ description: OK
1704
+ summary: Get pprof program counters mapping to function names
1705
+ tags:
1706
+ - Process profiling and debugging
1707
+ /debug/pprof/threadcreate:
1708
+ get:
1709
+ description: Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1710
+ parameters:
1711
+ - description: Insert your personal access token
1712
+ in: header
1713
+ name: Authorization
1714
+ required: true
1715
+ schema:
1716
+ default: Bearer <personal access token>
1717
+ type: string
1718
+ responses:
1719
+ '200':
1720
+ description: OK
1721
+ summary: Get pprof stack traces that led to the creation of new OS threads
1722
+ tags:
1723
+ - Process profiling and debugging
1724
+ /debug/pprof/trace:
1725
+ get:
1726
+ description: >-
1727
+ Only available, when server was started with WOODPECKER_LOG_LEVEL=debug
1728
+
1729
+ After you get the profile file, use the go tool pprof command to
1730
+ investigate the profile.
1731
+ parameters:
1732
+ - description: Insert your personal access token
1733
+ in: header
1734
+ name: Authorization
1735
+ required: true
1736
+ schema:
1737
+ default: Bearer <personal access token>
1738
+ type: string
1739
+ - description: You can specify the duration in the seconds GET parameter.
1740
+ in: query
1741
+ name: seconds
1742
+ required: true
1743
+ schema:
1744
+ type: integer
1745
+ responses:
1746
+ '200':
1747
+ description: OK
1748
+ summary: Get a trace of execution of the current program
1749
+ tags:
1750
+ - Process profiling and debugging
1751
+ /forges:
1752
+ get:
1753
+ parameters:
1754
+ - description: Insert your personal access token
1755
+ in: header
1756
+ name: Authorization
1757
+ schema:
1758
+ default: Bearer <personal access token>
1759
+ type: string
1760
+ - description: for response pagination, page offset number
1761
+ in: query
1762
+ name: page
1763
+ schema:
1764
+ default: 1
1765
+ type: integer
1766
+ - description: for response pagination, max items per page
1767
+ in: query
1768
+ name: perPage
1769
+ schema:
1770
+ default: 50
1771
+ type: integer
1772
+ responses:
1773
+ '200':
1774
+ content:
1775
+ application/json:
1776
+ schema:
1777
+ items:
1778
+ $ref: '#/components/schemas/Forge'
1779
+ type: array
1780
+ description: OK
1781
+ summary: List forges
1782
+ tags:
1783
+ - Forges
1784
+ post:
1785
+ description: Creates a new forge with a random token
1786
+ parameters:
1787
+ - description: Insert your personal access token
1788
+ in: header
1789
+ name: Authorization
1790
+ required: true
1791
+ schema:
1792
+ default: Bearer <personal access token>
1793
+ type: string
1794
+ requestBody:
1795
+ content:
1796
+ '*/*':
1797
+ schema:
1798
+ $ref: '#/components/schemas/ForgeWithOAuthClientSecret'
1799
+ description: the forge's data (only 'name' and 'no_schedule' are read)
1800
+ required: true
1801
+ x-originalParamName: forge
1802
+ responses:
1803
+ '200':
1804
+ content:
1805
+ application/json:
1806
+ schema:
1807
+ $ref: '#/components/schemas/Forge'
1808
+ description: OK
1809
+ summary: Create a new forge
1810
+ tags:
1811
+ - Forges
1812
+ /forges/{forge_id}:
1813
+ delete:
1814
+ parameters:
1815
+ - description: Insert your personal access token
1816
+ in: header
1817
+ name: Authorization
1818
+ required: true
1819
+ schema:
1820
+ default: Bearer <personal access token>
1821
+ type: string
1822
+ - description: the forge's id
1823
+ in: path
1824
+ name: forge_id
1825
+ required: true
1826
+ schema:
1827
+ type: integer
1828
+ responses:
1829
+ '200':
1830
+ description: OK
1831
+ summary: Delete a forge
1832
+ tags:
1833
+ - Forges
1834
+ get:
1835
+ parameters:
1836
+ - description: Insert your personal access token
1837
+ in: header
1838
+ name: Authorization
1839
+ schema:
1840
+ default: Bearer <personal access token>
1841
+ type: string
1842
+ - description: the forge's id
1843
+ in: path
1844
+ name: forge_id
1845
+ required: true
1846
+ schema:
1847
+ type: integer
1848
+ responses:
1849
+ '200':
1850
+ content:
1851
+ application/json:
1852
+ schema:
1853
+ $ref: '#/components/schemas/Forge'
1854
+ description: OK
1855
+ summary: Get a forge
1856
+ tags:
1857
+ - Forges
1858
+ patch:
1859
+ parameters:
1860
+ - description: Insert your personal access token
1861
+ in: header
1862
+ name: Authorization
1863
+ required: true
1864
+ schema:
1865
+ default: Bearer <personal access token>
1866
+ type: string
1867
+ - description: the forge's id
1868
+ in: path
1869
+ name: forge_id
1870
+ required: true
1871
+ schema:
1872
+ type: integer
1873
+ requestBody:
1874
+ content:
1875
+ '*/*':
1876
+ schema:
1877
+ $ref: '#/components/schemas/ForgeWithOAuthClientSecret'
1878
+ description: the forge's data
1879
+ required: true
1880
+ x-originalParamName: forgeData
1881
+ responses:
1882
+ '200':
1883
+ content:
1884
+ application/json:
1885
+ schema:
1886
+ $ref: '#/components/schemas/Forge'
1887
+ description: OK
1888
+ summary: Update a forge
1889
+ tags:
1890
+ - Forges
1891
+ /healthz:
1892
+ get:
1893
+ description: >-
1894
+ If everything is fine, just a 204 will be returned, a 500 signals server
1895
+ state is unhealthy.
1896
+ responses:
1897
+ '204':
1898
+ description: No Content
1899
+ '500':
1900
+ description: Internal Server Error
1901
+ summary: Health information
1902
+ tags:
1903
+ - System
1904
+ /hook:
1905
+ post:
1906
+ requestBody:
1907
+ content:
1908
+ '*/*':
1909
+ schema:
1910
+ type: object
1911
+ description: the webhook payload; forge is automatically detected
1912
+ required: true
1913
+ x-originalParamName: hook
1914
+ responses:
1915
+ '200':
1916
+ description: OK
1917
+ summary: Incoming webhook from forge
1918
+ tags:
1919
+ - System
1920
+ /log-level:
1921
+ get:
1922
+ description: Endpoint returns the current logging level. Requires admin rights.
1923
+ responses:
1924
+ '200':
1925
+ content:
1926
+ application/json:
1927
+ schema:
1928
+ properties:
1929
+ log-level:
1930
+ type: string
1931
+ type: object
1932
+ description: OK
1933
+ summary: Current log level
1934
+ tags:
1935
+ - System
1936
+ post:
1937
+ description: Endpoint sets the current logging level. Requires admin rights.
1938
+ parameters:
1939
+ - description: Insert your personal access token
1940
+ in: header
1941
+ name: Authorization
1942
+ required: true
1943
+ schema:
1944
+ default: Bearer <personal access token>
1945
+ type: string
1946
+ requestBody:
1947
+ content:
1948
+ '*/*':
1949
+ schema:
1950
+ properties:
1951
+ log-level:
1952
+ type: string
1953
+ type: object
1954
+ description: >-
1955
+ the new log level, one of
1956
+ <debug,trace,info,warn,error,fatal,panic,disabled>
1957
+ required: true
1958
+ x-originalParamName: log-level
1959
+ responses:
1960
+ '200':
1961
+ content:
1962
+ application/json:
1963
+ schema:
1964
+ properties:
1965
+ log-level:
1966
+ type: string
1967
+ type: object
1968
+ description: OK
1969
+ summary: Set log level
1970
+ tags:
1971
+ - System
1972
+ /orgs:
1973
+ get:
1974
+ description: Returns all registered orgs in the system. Requires admin rights.
1975
+ parameters:
1976
+ - description: Insert your personal access token
1977
+ in: header
1978
+ name: Authorization
1979
+ required: true
1980
+ schema:
1981
+ default: Bearer <personal access token>
1982
+ type: string
1983
+ - description: for response pagination, page offset number
1984
+ in: query
1985
+ name: page
1986
+ schema:
1987
+ default: 1
1988
+ type: integer
1989
+ - description: for response pagination, max items per page
1990
+ in: query
1991
+ name: perPage
1992
+ schema:
1993
+ default: 50
1994
+ type: integer
1995
+ responses:
1996
+ '200':
1997
+ content:
1998
+ application/json:
1999
+ schema:
2000
+ items:
2001
+ $ref: '#/components/schemas/Org'
2002
+ type: array
2003
+ description: OK
2004
+ summary: List organizations
2005
+ tags:
2006
+ - Orgs
2007
+ /orgs/lookup/{org_full_name}:
2008
+ get:
2009
+ parameters:
2010
+ - description: Insert your personal access token
2011
+ in: header
2012
+ name: Authorization
2013
+ required: true
2014
+ schema:
2015
+ default: Bearer <personal access token>
2016
+ type: string
2017
+ - description: the organizations full name / slug
2018
+ in: path
2019
+ name: org_full_name
2020
+ required: true
2021
+ schema:
2022
+ type: string
2023
+ responses:
2024
+ '200':
2025
+ content:
2026
+ application/json:
2027
+ schema:
2028
+ $ref: '#/components/schemas/Org'
2029
+ description: OK
2030
+ summary: Lookup an organization by full name
2031
+ tags:
2032
+ - Orgs
2033
+ /orgs/{org_id}:
2034
+ delete:
2035
+ description: Deletes the given org. Requires admin rights.
2036
+ parameters:
2037
+ - description: Insert your personal access token
2038
+ in: header
2039
+ name: Authorization
2040
+ required: true
2041
+ schema:
2042
+ default: Bearer <personal access token>
2043
+ type: string
2044
+ - description: the org's id
2045
+ in: path
2046
+ name: org_id
2047
+ required: true
2048
+ schema:
2049
+ type: string
2050
+ responses:
2051
+ '204':
2052
+ description: No Content
2053
+ summary: Delete an organization
2054
+ tags:
2055
+ - Orgs
2056
+ get:
2057
+ parameters:
2058
+ - description: Insert your personal access token
2059
+ in: header
2060
+ name: Authorization
2061
+ required: true
2062
+ schema:
2063
+ default: Bearer <personal access token>
2064
+ type: string
2065
+ - description: the organization's id
2066
+ in: path
2067
+ name: org_id
2068
+ required: true
2069
+ schema:
2070
+ type: string
2071
+ responses:
2072
+ '200':
2073
+ content:
2074
+ application/json:
2075
+ schema:
2076
+ items:
2077
+ $ref: '#/components/schemas/Org'
2078
+ type: array
2079
+ description: OK
2080
+ summary: Get an organization
2081
+ tags:
2082
+ - Organization
2083
+ /orgs/{org_id}/agents:
2084
+ get:
2085
+ parameters:
2086
+ - description: Insert your personal access token
2087
+ in: header
2088
+ name: Authorization
2089
+ required: true
2090
+ schema:
2091
+ default: Bearer <personal access token>
2092
+ type: string
2093
+ - description: the organization's id
2094
+ in: path
2095
+ name: org_id
2096
+ required: true
2097
+ schema:
2098
+ type: integer
2099
+ - description: for response pagination, page offset number
2100
+ in: query
2101
+ name: page
2102
+ schema:
2103
+ default: 1
2104
+ type: integer
2105
+ - description: for response pagination, max items per page
2106
+ in: query
2107
+ name: perPage
2108
+ schema:
2109
+ default: 50
2110
+ type: integer
2111
+ responses:
2112
+ '200':
2113
+ content:
2114
+ application/json:
2115
+ schema:
2116
+ items:
2117
+ $ref: '#/components/schemas/Agent'
2118
+ type: array
2119
+ description: OK
2120
+ summary: List agents for an organization
2121
+ tags:
2122
+ - Agents
2123
+ post:
2124
+ description: >-
2125
+ Creates a new agent with a random token, scoped to the specified
2126
+ organization
2127
+ parameters:
2128
+ - description: Insert your personal access token
2129
+ in: header
2130
+ name: Authorization
2131
+ required: true
2132
+ schema:
2133
+ default: Bearer <personal access token>
2134
+ type: string
2135
+ - description: the organization's id
2136
+ in: path
2137
+ name: org_id
2138
+ required: true
2139
+ schema:
2140
+ type: integer
2141
+ requestBody:
2142
+ content:
2143
+ '*/*':
2144
+ schema:
2145
+ $ref: '#/components/schemas/Agent'
2146
+ description: the agent's data (only 'name', 'no_schedule' and 'filters' are read)
2147
+ required: true
2148
+ x-originalParamName: agent
2149
+ responses:
2150
+ '200':
2151
+ content:
2152
+ application/json:
2153
+ schema:
2154
+ $ref: '#/components/schemas/Agent'
2155
+ description: OK
2156
+ summary: Create a new organization-scoped agent
2157
+ tags:
2158
+ - Agents
2159
+ /orgs/{org_id}/agents/{agent_id}:
2160
+ delete:
2161
+ parameters:
2162
+ - description: Insert your personal access token
2163
+ in: header
2164
+ name: Authorization
2165
+ required: true
2166
+ schema:
2167
+ default: Bearer <personal access token>
2168
+ type: string
2169
+ - description: the organization's id
2170
+ in: path
2171
+ name: org_id
2172
+ required: true
2173
+ schema:
2174
+ type: integer
2175
+ - description: the agent's id
2176
+ in: path
2177
+ name: agent_id
2178
+ required: true
2179
+ schema:
2180
+ type: integer
2181
+ responses:
2182
+ '204':
2183
+ description: No Content
2184
+ summary: Delete an organization-scoped agent
2185
+ tags:
2186
+ - Agents
2187
+ patch:
2188
+ parameters:
2189
+ - description: Insert your personal access token
2190
+ in: header
2191
+ name: Authorization
2192
+ required: true
2193
+ schema:
2194
+ default: Bearer <personal access token>
2195
+ type: string
2196
+ - description: the organization's id
2197
+ in: path
2198
+ name: org_id
2199
+ required: true
2200
+ schema:
2201
+ type: integer
2202
+ - description: the agent's id
2203
+ in: path
2204
+ name: agent_id
2205
+ required: true
2206
+ schema:
2207
+ type: integer
2208
+ requestBody:
2209
+ content:
2210
+ '*/*':
2211
+ schema:
2212
+ $ref: '#/components/schemas/Agent'
2213
+ description: the agent's updated data
2214
+ required: true
2215
+ x-originalParamName: agent
2216
+ responses:
2217
+ '200':
2218
+ content:
2219
+ application/json:
2220
+ schema:
2221
+ $ref: '#/components/schemas/Agent'
2222
+ description: OK
2223
+ summary: Update an organization-scoped agent
2224
+ tags:
2225
+ - Agents
2226
+ /orgs/{org_id}/permissions:
2227
+ get:
2228
+ parameters:
2229
+ - description: Insert your personal access token
2230
+ in: header
2231
+ name: Authorization
2232
+ required: true
2233
+ schema:
2234
+ default: Bearer <personal access token>
2235
+ type: string
2236
+ - description: the organization's id
2237
+ in: path
2238
+ name: org_id
2239
+ required: true
2240
+ schema:
2241
+ type: string
2242
+ responses:
2243
+ '200':
2244
+ content:
2245
+ application/json:
2246
+ schema:
2247
+ items:
2248
+ $ref: '#/components/schemas/OrgPerm'
2249
+ type: array
2250
+ description: OK
2251
+ summary: >-
2252
+ Get the permissions of the currently authenticated user for the given
2253
+ organization
2254
+ tags:
2255
+ - Organization permissions
2256
+ /orgs/{org_id}/registries:
2257
+ get:
2258
+ parameters:
2259
+ - description: Insert your personal access token
2260
+ in: header
2261
+ name: Authorization
2262
+ required: true
2263
+ schema:
2264
+ default: Bearer <personal access token>
2265
+ type: string
2266
+ - description: the org's id
2267
+ in: path
2268
+ name: org_id
2269
+ required: true
2270
+ schema:
2271
+ type: string
2272
+ - description: for response pagination, page offset number
2273
+ in: query
2274
+ name: page
2275
+ schema:
2276
+ default: 1
2277
+ type: integer
2278
+ - description: for response pagination, max items per page
2279
+ in: query
2280
+ name: perPage
2281
+ schema:
2282
+ default: 50
2283
+ type: integer
2284
+ responses:
2285
+ '200':
2286
+ content:
2287
+ application/json:
2288
+ schema:
2289
+ items:
2290
+ $ref: '#/components/schemas/Registry'
2291
+ type: array
2292
+ description: OK
2293
+ summary: List organization registries
2294
+ tags:
2295
+ - Organization registries
2296
+ post:
2297
+ parameters:
2298
+ - description: Insert your personal access token
2299
+ in: header
2300
+ name: Authorization
2301
+ required: true
2302
+ schema:
2303
+ default: Bearer <personal access token>
2304
+ type: string
2305
+ - description: the org's id
2306
+ in: path
2307
+ name: org_id
2308
+ required: true
2309
+ schema:
2310
+ type: string
2311
+ requestBody:
2312
+ content:
2313
+ '*/*':
2314
+ schema:
2315
+ $ref: '#/components/schemas/Registry'
2316
+ description: the new registry
2317
+ required: true
2318
+ x-originalParamName: registryData
2319
+ responses:
2320
+ '200':
2321
+ content:
2322
+ application/json:
2323
+ schema:
2324
+ $ref: '#/components/schemas/Registry'
2325
+ description: OK
2326
+ summary: Create an organization registry
2327
+ tags:
2328
+ - Organization registries
2329
+ /orgs/{org_id}/registries/{registry}:
2330
+ delete:
2331
+ parameters:
2332
+ - description: Insert your personal access token
2333
+ in: header
2334
+ name: Authorization
2335
+ required: true
2336
+ schema:
2337
+ default: Bearer <personal access token>
2338
+ type: string
2339
+ - description: the org's id
2340
+ in: path
2341
+ name: org_id
2342
+ required: true
2343
+ schema:
2344
+ type: string
2345
+ - description: the registry's name
2346
+ in: path
2347
+ name: registry
2348
+ required: true
2349
+ schema:
2350
+ type: string
2351
+ responses:
2352
+ '204':
2353
+ description: No Content
2354
+ summary: Delete an organization registry by name
2355
+ tags:
2356
+ - Organization registries
2357
+ get:
2358
+ parameters:
2359
+ - description: Insert your personal access token
2360
+ in: header
2361
+ name: Authorization
2362
+ required: true
2363
+ schema:
2364
+ default: Bearer <personal access token>
2365
+ type: string
2366
+ - description: the org's id
2367
+ in: path
2368
+ name: org_id
2369
+ required: true
2370
+ schema:
2371
+ type: string
2372
+ - description: the registry's address
2373
+ in: path
2374
+ name: registry
2375
+ required: true
2376
+ schema:
2377
+ type: string
2378
+ responses:
2379
+ '200':
2380
+ content:
2381
+ application/json:
2382
+ schema:
2383
+ $ref: '#/components/schemas/Registry'
2384
+ description: OK
2385
+ summary: Get a organization registry by address
2386
+ tags:
2387
+ - Organization registries
2388
+ patch:
2389
+ parameters:
2390
+ - description: Insert your personal access token
2391
+ in: header
2392
+ name: Authorization
2393
+ required: true
2394
+ schema:
2395
+ default: Bearer <personal access token>
2396
+ type: string
2397
+ - description: the org's id
2398
+ in: path
2399
+ name: org_id
2400
+ required: true
2401
+ schema:
2402
+ type: string
2403
+ - description: the registry's name
2404
+ in: path
2405
+ name: registry
2406
+ required: true
2407
+ schema:
2408
+ type: string
2409
+ requestBody:
2410
+ content:
2411
+ '*/*':
2412
+ schema:
2413
+ $ref: '#/components/schemas/Registry'
2414
+ description: the update registry data
2415
+ required: true
2416
+ x-originalParamName: registryData
2417
+ responses:
2418
+ '200':
2419
+ content:
2420
+ application/json:
2421
+ schema:
2422
+ $ref: '#/components/schemas/Registry'
2423
+ description: OK
2424
+ summary: Update an organization registry by name
2425
+ tags:
2426
+ - Organization registries
2427
+ /orgs/{org_id}/secrets:
2428
+ get:
2429
+ parameters:
2430
+ - description: Insert your personal access token
2431
+ in: header
2432
+ name: Authorization
2433
+ required: true
2434
+ schema:
2435
+ default: Bearer <personal access token>
2436
+ type: string
2437
+ - description: the org's id
2438
+ in: path
2439
+ name: org_id
2440
+ required: true
2441
+ schema:
2442
+ type: string
2443
+ - description: for response pagination, page offset number
2444
+ in: query
2445
+ name: page
2446
+ schema:
2447
+ default: 1
2448
+ type: integer
2449
+ - description: for response pagination, max items per page
2450
+ in: query
2451
+ name: perPage
2452
+ schema:
2453
+ default: 50
2454
+ type: integer
2455
+ responses:
2456
+ '200':
2457
+ content:
2458
+ application/json:
2459
+ schema:
2460
+ items:
2461
+ $ref: '#/components/schemas/Secret'
2462
+ type: array
2463
+ description: OK
2464
+ summary: List organization secrets
2465
+ tags:
2466
+ - Organization secrets
2467
+ post:
2468
+ parameters:
2469
+ - description: Insert your personal access token
2470
+ in: header
2471
+ name: Authorization
2472
+ required: true
2473
+ schema:
2474
+ default: Bearer <personal access token>
2475
+ type: string
2476
+ - description: the org's id
2477
+ in: path
2478
+ name: org_id
2479
+ required: true
2480
+ schema:
2481
+ type: string
2482
+ requestBody:
2483
+ content:
2484
+ '*/*':
2485
+ schema:
2486
+ $ref: '#/components/schemas/Secret'
2487
+ description: the new secret
2488
+ required: true
2489
+ x-originalParamName: secretData
2490
+ responses:
2491
+ '200':
2492
+ content:
2493
+ application/json:
2494
+ schema:
2495
+ $ref: '#/components/schemas/Secret'
2496
+ description: OK
2497
+ summary: Create an organization secret
2498
+ tags:
2499
+ - Organization secrets
2500
+ /orgs/{org_id}/secrets/{secret}:
2501
+ delete:
2502
+ parameters:
2503
+ - description: Insert your personal access token
2504
+ in: header
2505
+ name: Authorization
2506
+ required: true
2507
+ schema:
2508
+ default: Bearer <personal access token>
2509
+ type: string
2510
+ - description: the org's id
2511
+ in: path
2512
+ name: org_id
2513
+ required: true
2514
+ schema:
2515
+ type: string
2516
+ - description: the secret's name
2517
+ in: path
2518
+ name: secret
2519
+ required: true
2520
+ schema:
2521
+ type: string
2522
+ responses:
2523
+ '204':
2524
+ description: No Content
2525
+ summary: Delete an organization secret by name
2526
+ tags:
2527
+ - Organization secrets
2528
+ get:
2529
+ parameters:
2530
+ - description: Insert your personal access token
2531
+ in: header
2532
+ name: Authorization
2533
+ required: true
2534
+ schema:
2535
+ default: Bearer <personal access token>
2536
+ type: string
2537
+ - description: the org's id
2538
+ in: path
2539
+ name: org_id
2540
+ required: true
2541
+ schema:
2542
+ type: string
2543
+ - description: the secret's name
2544
+ in: path
2545
+ name: secret
2546
+ required: true
2547
+ schema:
2548
+ type: string
2549
+ responses:
2550
+ '200':
2551
+ content:
2552
+ application/json:
2553
+ schema:
2554
+ $ref: '#/components/schemas/Secret'
2555
+ description: OK
2556
+ summary: Get a organization secret by name
2557
+ tags:
2558
+ - Organization secrets
2559
+ patch:
2560
+ parameters:
2561
+ - description: Insert your personal access token
2562
+ in: header
2563
+ name: Authorization
2564
+ required: true
2565
+ schema:
2566
+ default: Bearer <personal access token>
2567
+ type: string
2568
+ - description: the org's id
2569
+ in: path
2570
+ name: org_id
2571
+ required: true
2572
+ schema:
2573
+ type: string
2574
+ - description: the secret's name
2575
+ in: path
2576
+ name: secret
2577
+ required: true
2578
+ schema:
2579
+ type: string
2580
+ requestBody:
2581
+ content:
2582
+ '*/*':
2583
+ schema:
2584
+ $ref: '#/components/schemas/SecretPatch'
2585
+ description: the update secret data
2586
+ required: true
2587
+ x-originalParamName: secretData
2588
+ responses:
2589
+ '200':
2590
+ content:
2591
+ application/json:
2592
+ schema:
2593
+ $ref: '#/components/schemas/Secret'
2594
+ description: OK
2595
+ summary: Update an organization secret by name
2596
+ tags:
2597
+ - Organization secrets
2598
+ /pipelines:
2599
+ get:
2600
+ parameters:
2601
+ - description: Insert your personal access token
2602
+ in: header
2603
+ name: Authorization
2604
+ required: true
2605
+ schema:
2606
+ default: Bearer <personal access token>
2607
+ type: string
2608
+ responses:
2609
+ '200':
2610
+ content:
2611
+ application/json:
2612
+ schema:
2613
+ items:
2614
+ $ref: '#/components/schemas/Feed'
2615
+ type: array
2616
+ description: OK
2617
+ summary: List pipelines in queue
2618
+ tags:
2619
+ - Pipeline queues
2620
+ /queue/info:
2621
+ get:
2622
+ description: Returns pipeline queue information with agent details
2623
+ parameters:
2624
+ - description: Insert your personal access token
2625
+ in: header
2626
+ name: Authorization
2627
+ required: true
2628
+ schema:
2629
+ default: Bearer <personal access token>
2630
+ type: string
2631
+ responses:
2632
+ '200':
2633
+ content:
2634
+ application/json:
2635
+ schema:
2636
+ $ref: '#/components/schemas/QueueInfo'
2637
+ description: OK
2638
+ summary: Get pipeline queue information
2639
+ tags:
2640
+ - Pipeline queues
2641
+ /queue/norunningpipelines:
2642
+ get:
2643
+ parameters:
2644
+ - description: Insert your personal access token
2645
+ in: header
2646
+ name: Authorization
2647
+ required: true
2648
+ schema:
2649
+ default: Bearer <personal access token>
2650
+ type: string
2651
+ responses:
2652
+ '204':
2653
+ description: No Content
2654
+ summary: Block til pipeline queue has a running item
2655
+ tags:
2656
+ - Pipeline queues
2657
+ /queue/pause:
2658
+ post:
2659
+ parameters:
2660
+ - description: Insert your personal access token
2661
+ in: header
2662
+ name: Authorization
2663
+ required: true
2664
+ schema:
2665
+ default: Bearer <personal access token>
2666
+ type: string
2667
+ responses:
2668
+ '204':
2669
+ description: No Content
2670
+ summary: Pause the pipeline queue
2671
+ tags:
2672
+ - Pipeline queues
2673
+ /queue/resume:
2674
+ post:
2675
+ parameters:
2676
+ - description: Insert your personal access token
2677
+ in: header
2678
+ name: Authorization
2679
+ required: true
2680
+ schema:
2681
+ default: Bearer <personal access token>
2682
+ type: string
2683
+ responses:
2684
+ '204':
2685
+ description: No Content
2686
+ summary: Resume the pipeline queue
2687
+ tags:
2688
+ - Pipeline queues
2689
+ /registries:
2690
+ get:
2691
+ parameters:
2692
+ - description: Insert your personal access token
2693
+ in: header
2694
+ name: Authorization
2695
+ required: true
2696
+ schema:
2697
+ default: Bearer <personal access token>
2698
+ type: string
2699
+ - description: for response pagination, page offset number
2700
+ in: query
2701
+ name: page
2702
+ schema:
2703
+ default: 1
2704
+ type: integer
2705
+ - description: for response pagination, max items per page
2706
+ in: query
2707
+ name: perPage
2708
+ schema:
2709
+ default: 50
2710
+ type: integer
2711
+ responses:
2712
+ '200':
2713
+ content:
2714
+ application/json:
2715
+ schema:
2716
+ items:
2717
+ $ref: '#/components/schemas/Registry'
2718
+ type: array
2719
+ description: OK
2720
+ summary: List global registries
2721
+ tags:
2722
+ - Registries
2723
+ post:
2724
+ parameters:
2725
+ - description: Insert your personal access token
2726
+ in: header
2727
+ name: Authorization
2728
+ required: true
2729
+ schema:
2730
+ default: Bearer <personal access token>
2731
+ type: string
2732
+ requestBody:
2733
+ content:
2734
+ '*/*':
2735
+ schema:
2736
+ $ref: '#/components/schemas/Registry'
2737
+ description: the registry object data
2738
+ required: true
2739
+ x-originalParamName: registry
2740
+ responses:
2741
+ '200':
2742
+ content:
2743
+ application/json:
2744
+ schema:
2745
+ $ref: '#/components/schemas/Registry'
2746
+ description: OK
2747
+ summary: Create a global registry
2748
+ tags:
2749
+ - Registries
2750
+ /registries/{registry}:
2751
+ delete:
2752
+ parameters:
2753
+ - description: Insert your personal access token
2754
+ in: header
2755
+ name: Authorization
2756
+ required: true
2757
+ schema:
2758
+ default: Bearer <personal access token>
2759
+ type: string
2760
+ - description: the registry's name
2761
+ in: path
2762
+ name: registry
2763
+ required: true
2764
+ schema:
2765
+ type: string
2766
+ responses:
2767
+ '204':
2768
+ description: No Content
2769
+ summary: Delete a global registry by name
2770
+ tags:
2771
+ - Registries
2772
+ get:
2773
+ parameters:
2774
+ - description: Insert your personal access token
2775
+ in: header
2776
+ name: Authorization
2777
+ required: true
2778
+ schema:
2779
+ default: Bearer <personal access token>
2780
+ type: string
2781
+ - description: the registry's name
2782
+ in: path
2783
+ name: registry
2784
+ required: true
2785
+ schema:
2786
+ type: string
2787
+ responses:
2788
+ '200':
2789
+ content:
2790
+ application/json:
2791
+ schema:
2792
+ $ref: '#/components/schemas/Registry'
2793
+ description: OK
2794
+ summary: Get a global registry by name
2795
+ tags:
2796
+ - Registries
2797
+ patch:
2798
+ parameters:
2799
+ - description: Insert your personal access token
2800
+ in: header
2801
+ name: Authorization
2802
+ required: true
2803
+ schema:
2804
+ default: Bearer <personal access token>
2805
+ type: string
2806
+ - description: the registry's name
2807
+ in: path
2808
+ name: registry
2809
+ required: true
2810
+ schema:
2811
+ type: string
2812
+ requestBody:
2813
+ content:
2814
+ '*/*':
2815
+ schema:
2816
+ $ref: '#/components/schemas/Registry'
2817
+ description: the registry's data
2818
+ required: true
2819
+ x-originalParamName: registryData
2820
+ responses:
2821
+ '200':
2822
+ content:
2823
+ application/json:
2824
+ schema:
2825
+ $ref: '#/components/schemas/Registry'
2826
+ description: OK
2827
+ summary: Update a global registry by name
2828
+ tags:
2829
+ - Registries
2830
+ /repos:
2831
+ get:
2832
+ description: Returns a list of all repositories. Requires admin rights.
2833
+ parameters:
2834
+ - description: Insert your personal access token
2835
+ in: header
2836
+ name: Authorization
2837
+ required: true
2838
+ schema:
2839
+ default: Bearer <personal access token>
2840
+ type: string
2841
+ - description: only list active repos
2842
+ in: query
2843
+ name: active
2844
+ schema:
2845
+ type: boolean
2846
+ - description: for response pagination, page offset number
2847
+ in: query
2848
+ name: page
2849
+ schema:
2850
+ default: 1
2851
+ type: integer
2852
+ - description: for response pagination, max items per page
2853
+ in: query
2854
+ name: perPage
2855
+ schema:
2856
+ default: 50
2857
+ type: integer
2858
+ responses:
2859
+ '200':
2860
+ content:
2861
+ application/json:
2862
+ schema:
2863
+ items:
2864
+ $ref: '#/components/schemas/Repo'
2865
+ type: array
2866
+ description: OK
2867
+ summary: List all repositories on the server
2868
+ tags:
2869
+ - Repositories
2870
+ post:
2871
+ parameters:
2872
+ - description: Insert your personal access token
2873
+ in: header
2874
+ name: Authorization
2875
+ required: true
2876
+ schema:
2877
+ default: Bearer <personal access token>
2878
+ type: string
2879
+ - description: the id of a repository at the forge
2880
+ in: query
2881
+ name: forge_remote_id
2882
+ required: true
2883
+ schema:
2884
+ type: string
2885
+ responses:
2886
+ '200':
2887
+ content:
2888
+ application/json:
2889
+ schema:
2890
+ $ref: '#/components/schemas/Repo'
2891
+ description: OK
2892
+ summary: Activate a repository
2893
+ tags:
2894
+ - Repositories
2895
+ /repos/lookup/{repo_full_name}:
2896
+ get:
2897
+ parameters:
2898
+ - description: Insert your personal access token
2899
+ in: header
2900
+ name: Authorization
2901
+ required: true
2902
+ schema:
2903
+ default: Bearer <personal access token>
2904
+ type: string
2905
+ - description: the repository full name / slug
2906
+ in: path
2907
+ name: repo_full_name
2908
+ required: true
2909
+ schema:
2910
+ type: string
2911
+ responses:
2912
+ '200':
2913
+ content:
2914
+ application/json:
2915
+ schema:
2916
+ $ref: '#/components/schemas/Repo'
2917
+ description: OK
2918
+ summary: Lookup a repository by full name
2919
+ tags:
2920
+ - Repositories
2921
+ /repos/repair:
2922
+ post:
2923
+ description: Executes a repair process on all repositories. Requires admin rights.
2924
+ parameters:
2925
+ - description: Insert your personal access token
2926
+ in: header
2927
+ name: Authorization
2928
+ required: true
2929
+ schema:
2930
+ default: Bearer <personal access token>
2931
+ type: string
2932
+ responses:
2933
+ '204':
2934
+ description: No Content
2935
+ summary: Repair all repositories on the server
2936
+ tags:
2937
+ - Repositories
2938
+ /repos/{repo_id}:
2939
+ delete:
2940
+ parameters:
2941
+ - description: Insert your personal access token
2942
+ in: header
2943
+ name: Authorization
2944
+ required: true
2945
+ schema:
2946
+ default: Bearer <personal access token>
2947
+ type: string
2948
+ - description: the repository id
2949
+ in: path
2950
+ name: repo_id
2951
+ required: true
2952
+ schema:
2953
+ type: integer
2954
+ responses:
2955
+ '200':
2956
+ content:
2957
+ application/json:
2958
+ schema:
2959
+ $ref: '#/components/schemas/Repo'
2960
+ description: OK
2961
+ summary: Delete a repository
2962
+ tags:
2963
+ - Repositories
2964
+ get:
2965
+ parameters:
2966
+ - description: Insert your personal access token
2967
+ in: header
2968
+ name: Authorization
2969
+ required: true
2970
+ schema:
2971
+ default: Bearer <personal access token>
2972
+ type: string
2973
+ - description: the repository id
2974
+ in: path
2975
+ name: repo_id
2976
+ required: true
2977
+ schema:
2978
+ type: integer
2979
+ responses:
2980
+ '200':
2981
+ content:
2982
+ application/json:
2983
+ schema:
2984
+ $ref: '#/components/schemas/Repo'
2985
+ description: OK
2986
+ summary: Get a repository
2987
+ tags:
2988
+ - Repositories
2989
+ patch:
2990
+ parameters:
2991
+ - description: Insert your personal access token
2992
+ in: header
2993
+ name: Authorization
2994
+ required: true
2995
+ schema:
2996
+ default: Bearer <personal access token>
2997
+ type: string
2998
+ - description: the repository id
2999
+ in: path
3000
+ name: repo_id
3001
+ required: true
3002
+ schema:
3003
+ type: integer
3004
+ requestBody:
3005
+ content:
3006
+ '*/*':
3007
+ schema:
3008
+ $ref: '#/components/schemas/RepoPatch'
3009
+ description: the repository's information
3010
+ required: true
3011
+ x-originalParamName: repo
3012
+ responses:
3013
+ '200':
3014
+ content:
3015
+ application/json:
3016
+ schema:
3017
+ $ref: '#/components/schemas/Repo'
3018
+ description: OK
3019
+ summary: Update a repository
3020
+ tags:
3021
+ - Repositories
3022
+ /repos/{repo_id}/branches:
3023
+ get:
3024
+ parameters:
3025
+ - description: Insert your personal access token
3026
+ in: header
3027
+ name: Authorization
3028
+ required: true
3029
+ schema:
3030
+ default: Bearer <personal access token>
3031
+ type: string
3032
+ - description: the repository id
3033
+ in: path
3034
+ name: repo_id
3035
+ required: true
3036
+ schema:
3037
+ type: integer
3038
+ - description: for response pagination, page offset number
3039
+ in: query
3040
+ name: page
3041
+ schema:
3042
+ default: 1
3043
+ type: integer
3044
+ - description: for response pagination, max items per page
3045
+ in: query
3046
+ name: perPage
3047
+ schema:
3048
+ default: 50
3049
+ type: integer
3050
+ responses:
3051
+ '200':
3052
+ content:
3053
+ application/json:
3054
+ schema:
3055
+ items:
3056
+ type: string
3057
+ type: array
3058
+ description: OK
3059
+ summary: Get branches of a repository
3060
+ tags:
3061
+ - Repositories
3062
+ /repos/{repo_id}/chown:
3063
+ post:
3064
+ parameters:
3065
+ - description: Insert your personal access token
3066
+ in: header
3067
+ name: Authorization
3068
+ required: true
3069
+ schema:
3070
+ default: Bearer <personal access token>
3071
+ type: string
3072
+ - description: the repository id
3073
+ in: path
3074
+ name: repo_id
3075
+ required: true
3076
+ schema:
3077
+ type: integer
3078
+ responses:
3079
+ '200':
3080
+ content:
3081
+ application/json:
3082
+ schema:
3083
+ $ref: '#/components/schemas/Repo'
3084
+ description: OK
3085
+ summary: Change a repository's owner to the currently authenticated user
3086
+ tags:
3087
+ - Repositories
3088
+ /repos/{repo_id}/cron:
3089
+ get:
3090
+ parameters:
3091
+ - description: Insert your personal access token
3092
+ in: header
3093
+ name: Authorization
3094
+ required: true
3095
+ schema:
3096
+ default: Bearer <personal access token>
3097
+ type: string
3098
+ - description: the repository id
3099
+ in: path
3100
+ name: repo_id
3101
+ required: true
3102
+ schema:
3103
+ type: integer
3104
+ - description: for response pagination, page offset number
3105
+ in: query
3106
+ name: page
3107
+ schema:
3108
+ default: 1
3109
+ type: integer
3110
+ - description: for response pagination, max items per page
3111
+ in: query
3112
+ name: perPage
3113
+ schema:
3114
+ default: 50
3115
+ type: integer
3116
+ responses:
3117
+ '200':
3118
+ content:
3119
+ application/json:
3120
+ schema:
3121
+ items:
3122
+ $ref: '#/components/schemas/Cron'
3123
+ type: array
3124
+ description: OK
3125
+ summary: List cron jobs
3126
+ tags:
3127
+ - Repository cron jobs
3128
+ post:
3129
+ parameters:
3130
+ - description: Insert your personal access token
3131
+ in: header
3132
+ name: Authorization
3133
+ required: true
3134
+ schema:
3135
+ default: Bearer <personal access token>
3136
+ type: string
3137
+ - description: the repository id
3138
+ in: path
3139
+ name: repo_id
3140
+ required: true
3141
+ schema:
3142
+ type: integer
3143
+ requestBody:
3144
+ content:
3145
+ '*/*':
3146
+ schema:
3147
+ $ref: '#/components/schemas/Cron'
3148
+ description: the new cron job
3149
+ required: true
3150
+ x-originalParamName: cronJob
3151
+ responses:
3152
+ '200':
3153
+ content:
3154
+ application/json:
3155
+ schema:
3156
+ $ref: '#/components/schemas/Cron'
3157
+ description: OK
3158
+ summary: Create a cron job
3159
+ tags:
3160
+ - Repository cron jobs
3161
+ /repos/{repo_id}/cron/{cron}:
3162
+ delete:
3163
+ parameters:
3164
+ - description: Insert your personal access token
3165
+ in: header
3166
+ name: Authorization
3167
+ required: true
3168
+ schema:
3169
+ default: Bearer <personal access token>
3170
+ type: string
3171
+ - description: the repository id
3172
+ in: path
3173
+ name: repo_id
3174
+ required: true
3175
+ schema:
3176
+ type: integer
3177
+ - description: the cron job id
3178
+ in: path
3179
+ name: cron
3180
+ required: true
3181
+ schema:
3182
+ type: string
3183
+ responses:
3184
+ '204':
3185
+ description: No Content
3186
+ summary: Delete a cron job
3187
+ tags:
3188
+ - Repository cron jobs
3189
+ get:
3190
+ parameters:
3191
+ - description: Insert your personal access token
3192
+ in: header
3193
+ name: Authorization
3194
+ required: true
3195
+ schema:
3196
+ default: Bearer <personal access token>
3197
+ type: string
3198
+ - description: the repository id
3199
+ in: path
3200
+ name: repo_id
3201
+ required: true
3202
+ schema:
3203
+ type: integer
3204
+ - description: the cron job id
3205
+ in: path
3206
+ name: cron
3207
+ required: true
3208
+ schema:
3209
+ type: string
3210
+ responses:
3211
+ '200':
3212
+ content:
3213
+ application/json:
3214
+ schema:
3215
+ $ref: '#/components/schemas/Cron'
3216
+ description: OK
3217
+ summary: Get a cron job
3218
+ tags:
3219
+ - Repository cron jobs
3220
+ patch:
3221
+ parameters:
3222
+ - description: Insert your personal access token
3223
+ in: header
3224
+ name: Authorization
3225
+ required: true
3226
+ schema:
3227
+ default: Bearer <personal access token>
3228
+ type: string
3229
+ - description: the repository id
3230
+ in: path
3231
+ name: repo_id
3232
+ required: true
3233
+ schema:
3234
+ type: integer
3235
+ - description: the cron job id
3236
+ in: path
3237
+ name: cron
3238
+ required: true
3239
+ schema:
3240
+ type: string
3241
+ requestBody:
3242
+ content:
3243
+ '*/*':
3244
+ schema:
3245
+ $ref: '#/components/schemas/CronPatch'
3246
+ description: the cron job data
3247
+ required: true
3248
+ x-originalParamName: cronJob
3249
+ responses:
3250
+ '200':
3251
+ content:
3252
+ application/json:
3253
+ schema:
3254
+ $ref: '#/components/schemas/Cron'
3255
+ description: OK
3256
+ summary: Update a cron job
3257
+ tags:
3258
+ - Repository cron jobs
3259
+ post:
3260
+ parameters:
3261
+ - description: Insert your personal access token
3262
+ in: header
3263
+ name: Authorization
3264
+ required: true
3265
+ schema:
3266
+ default: Bearer <personal access token>
3267
+ type: string
3268
+ - description: the repository id
3269
+ in: path
3270
+ name: repo_id
3271
+ required: true
3272
+ schema:
3273
+ type: integer
3274
+ - description: the cron job id
3275
+ in: path
3276
+ name: cron
3277
+ required: true
3278
+ schema:
3279
+ type: string
3280
+ responses:
3281
+ '200':
3282
+ content:
3283
+ application/json:
3284
+ schema:
3285
+ $ref: '#/components/schemas/Pipeline'
3286
+ description: OK
3287
+ summary: Start a cron job now
3288
+ tags:
3289
+ - Repository cron jobs
3290
+ /repos/{repo_id}/logs/{pipeline_number}:
3291
+ delete:
3292
+ parameters:
3293
+ - description: Insert your personal access token
3294
+ in: header
3295
+ name: Authorization
3296
+ required: true
3297
+ schema:
3298
+ default: Bearer <personal access token>
3299
+ type: string
3300
+ - description: the repository id
3301
+ in: path
3302
+ name: repo_id
3303
+ required: true
3304
+ schema:
3305
+ type: integer
3306
+ - description: the number of the pipeline
3307
+ in: path
3308
+ name: pipeline_number
3309
+ required: true
3310
+ schema:
3311
+ type: integer
3312
+ responses:
3313
+ '204':
3314
+ description: No Content
3315
+ summary: Deletes all logs of a pipeline
3316
+ tags:
3317
+ - Pipeline logs
3318
+ /repos/{repo_id}/logs/{pipeline_number}/{step_id}:
3319
+ delete:
3320
+ parameters:
3321
+ - description: Insert your personal access token
3322
+ in: header
3323
+ name: Authorization
3324
+ required: true
3325
+ schema:
3326
+ default: Bearer <personal access token>
3327
+ type: string
3328
+ - description: the repository id
3329
+ in: path
3330
+ name: repo_id
3331
+ required: true
3332
+ schema:
3333
+ type: integer
3334
+ - description: the number of the pipeline
3335
+ in: path
3336
+ name: pipeline_number
3337
+ required: true
3338
+ schema:
3339
+ type: integer
3340
+ - description: the step id
3341
+ in: path
3342
+ name: step_id
3343
+ required: true
3344
+ schema:
3345
+ type: integer
3346
+ responses:
3347
+ '204':
3348
+ description: No Content
3349
+ summary: Delete step logs of a pipeline
3350
+ tags:
3351
+ - Pipeline logs
3352
+ get:
3353
+ parameters:
3354
+ - description: Insert your personal access token
3355
+ in: header
3356
+ name: Authorization
3357
+ required: true
3358
+ schema:
3359
+ default: Bearer <personal access token>
3360
+ type: string
3361
+ - description: the repository id
3362
+ in: path
3363
+ name: repo_id
3364
+ required: true
3365
+ schema:
3366
+ type: integer
3367
+ - description: the number of the pipeline
3368
+ in: path
3369
+ name: pipeline_number
3370
+ required: true
3371
+ schema:
3372
+ type: integer
3373
+ - description: the step id
3374
+ in: path
3375
+ name: step_id
3376
+ required: true
3377
+ schema:
3378
+ type: integer
3379
+ responses:
3380
+ '200':
3381
+ content:
3382
+ application/json:
3383
+ schema:
3384
+ items:
3385
+ $ref: '#/components/schemas/LogEntry'
3386
+ type: array
3387
+ description: OK
3388
+ summary: Get logs for a pipeline step
3389
+ tags:
3390
+ - Pipeline logs
3391
+ /repos/{repo_id}/logs/{pipeline_number}/{step_id}/download:
3392
+ get:
3393
+ parameters:
3394
+ - description: Insert your personal access token
3395
+ in: header
3396
+ name: Authorization
3397
+ required: true
3398
+ schema:
3399
+ default: Bearer <personal access token>
3400
+ type: string
3401
+ - description: the repository id
3402
+ in: path
3403
+ name: repo_id
3404
+ required: true
3405
+ schema:
3406
+ type: integer
3407
+ - description: the number of the pipeline
3408
+ in: path
3409
+ name: pipeline_number
3410
+ required: true
3411
+ schema:
3412
+ type: integer
3413
+ - description: the step id
3414
+ in: path
3415
+ name: step_id
3416
+ required: true
3417
+ schema:
3418
+ type: integer
3419
+ responses:
3420
+ '200':
3421
+ content:
3422
+ text/plain:
3423
+ schema:
3424
+ type: string
3425
+ description: OK
3426
+ summary: Download logs for a pipeline step
3427
+ tags:
3428
+ - Pipeline logs
3429
+ /repos/{repo_id}/move:
3430
+ post:
3431
+ parameters:
3432
+ - description: Insert your personal access token
3433
+ in: header
3434
+ name: Authorization
3435
+ required: true
3436
+ schema:
3437
+ default: Bearer <personal access token>
3438
+ type: string
3439
+ - description: the repository id
3440
+ in: path
3441
+ name: repo_id
3442
+ required: true
3443
+ schema:
3444
+ type: integer
3445
+ - description: the username to move the repository to
3446
+ in: query
3447
+ name: to
3448
+ required: true
3449
+ schema:
3450
+ type: string
3451
+ responses:
3452
+ '204':
3453
+ description: No Content
3454
+ summary: Move a repository to a new owner
3455
+ tags:
3456
+ - Repositories
3457
+ /repos/{repo_id}/permissions:
3458
+ get:
3459
+ description: The repository permission, according to the used access token.
3460
+ parameters:
3461
+ - description: Insert your personal access token
3462
+ in: header
3463
+ name: Authorization
3464
+ required: true
3465
+ schema:
3466
+ default: Bearer <personal access token>
3467
+ type: string
3468
+ - description: the repository id
3469
+ in: path
3470
+ name: repo_id
3471
+ required: true
3472
+ schema:
3473
+ type: integer
3474
+ responses:
3475
+ '200':
3476
+ content:
3477
+ application/json:
3478
+ schema:
3479
+ $ref: '#/components/schemas/Perm'
3480
+ description: OK
3481
+ summary: Check current authenticated users access to the repository
3482
+ tags:
3483
+ - Repositories
3484
+ /repos/{repo_id}/pipelines:
3485
+ get:
3486
+ description: Get a list of pipelines for a repository.
3487
+ parameters:
3488
+ - description: Insert your personal access token
3489
+ in: header
3490
+ name: Authorization
3491
+ required: true
3492
+ schema:
3493
+ default: Bearer <personal access token>
3494
+ type: string
3495
+ - description: the repository id
3496
+ in: path
3497
+ name: repo_id
3498
+ required: true
3499
+ schema:
3500
+ type: integer
3501
+ - description: for response pagination, page offset number
3502
+ in: query
3503
+ name: page
3504
+ schema:
3505
+ default: 1
3506
+ type: integer
3507
+ - description: for response pagination, max items per page
3508
+ in: query
3509
+ name: perPage
3510
+ schema:
3511
+ default: 50
3512
+ type: integer
3513
+ - description: only return pipelines before this RFC3339 date
3514
+ in: query
3515
+ name: before
3516
+ schema:
3517
+ type: string
3518
+ - description: only return pipelines after this RFC3339 date
3519
+ in: query
3520
+ name: after
3521
+ schema:
3522
+ type: string
3523
+ - description: filter pipelines by branch
3524
+ in: query
3525
+ name: branch
3526
+ schema:
3527
+ type: string
3528
+ - description: filter pipelines by webhook events (comma separated)
3529
+ in: query
3530
+ name: event
3531
+ schema:
3532
+ type: string
3533
+ - description: filter pipelines by strings contained in ref
3534
+ in: query
3535
+ name: ref
3536
+ schema:
3537
+ type: string
3538
+ - description: filter pipelines by status
3539
+ in: query
3540
+ name: status
3541
+ schema:
3542
+ type: string
3543
+ responses:
3544
+ '200':
3545
+ content:
3546
+ application/json:
3547
+ schema:
3548
+ items:
3549
+ $ref: '#/components/schemas/Pipeline'
3550
+ type: array
3551
+ description: OK
3552
+ summary: List repository pipelines
3553
+ tags:
3554
+ - Pipelines
3555
+ post:
3556
+ parameters:
3557
+ - description: Insert your personal access token
3558
+ in: header
3559
+ name: Authorization
3560
+ required: true
3561
+ schema:
3562
+ default: Bearer <personal access token>
3563
+ type: string
3564
+ - description: the repository id
3565
+ in: path
3566
+ name: repo_id
3567
+ required: true
3568
+ schema:
3569
+ type: integer
3570
+ requestBody:
3571
+ content:
3572
+ '*/*':
3573
+ schema:
3574
+ $ref: '#/components/schemas/PipelineOptions'
3575
+ description: the options for the pipeline to run
3576
+ required: true
3577
+ x-originalParamName: options
3578
+ responses:
3579
+ '200':
3580
+ content:
3581
+ application/json:
3582
+ schema:
3583
+ $ref: '#/components/schemas/Pipeline'
3584
+ description: OK
3585
+ summary: Trigger a manual pipeline
3586
+ tags:
3587
+ - Pipelines
3588
+ /repos/{repo_id}/pipelines/{pipeline_number}:
3589
+ delete:
3590
+ parameters:
3591
+ - description: Insert your personal access token
3592
+ in: header
3593
+ name: Authorization
3594
+ required: true
3595
+ schema:
3596
+ default: Bearer <personal access token>
3597
+ type: string
3598
+ - description: the repository id
3599
+ in: path
3600
+ name: repo_id
3601
+ required: true
3602
+ schema:
3603
+ type: integer
3604
+ - description: the number of the pipeline
3605
+ in: path
3606
+ name: pipeline_number
3607
+ required: true
3608
+ schema:
3609
+ type: integer
3610
+ responses:
3611
+ '204':
3612
+ description: No Content
3613
+ summary: Delete a pipeline
3614
+ tags:
3615
+ - Pipelines
3616
+ get:
3617
+ parameters:
3618
+ - description: Insert your personal access token
3619
+ in: header
3620
+ name: Authorization
3621
+ required: true
3622
+ schema:
3623
+ default: Bearer <personal access token>
3624
+ type: string
3625
+ - description: the repository id
3626
+ in: path
3627
+ name: repo_id
3628
+ required: true
3629
+ schema:
3630
+ type: integer
3631
+ - description: the number of the pipeline, OR 'latest'
3632
+ in: path
3633
+ name: pipeline_number
3634
+ required: true
3635
+ schema:
3636
+ type: integer
3637
+ responses:
3638
+ '200':
3639
+ content:
3640
+ application/json:
3641
+ schema:
3642
+ $ref: '#/components/schemas/Pipeline'
3643
+ description: OK
3644
+ summary: Get a repositories pipeline
3645
+ tags:
3646
+ - Pipelines
3647
+ post:
3648
+ description: Restarts a pipeline optional with altered event, deploy or environment
3649
+ parameters:
3650
+ - description: Insert your personal access token
3651
+ in: header
3652
+ name: Authorization
3653
+ required: true
3654
+ schema:
3655
+ default: Bearer <personal access token>
3656
+ type: string
3657
+ - description: the repository id
3658
+ in: path
3659
+ name: repo_id
3660
+ required: true
3661
+ schema:
3662
+ type: integer
3663
+ - description: the number of the pipeline
3664
+ in: path
3665
+ name: pipeline_number
3666
+ required: true
3667
+ schema:
3668
+ type: integer
3669
+ - description: override the event type
3670
+ in: query
3671
+ name: event
3672
+ schema:
3673
+ type: string
3674
+ - description: override the target deploy value
3675
+ in: query
3676
+ name: deploy_to
3677
+ schema:
3678
+ type: string
3679
+ responses:
3680
+ '200':
3681
+ content:
3682
+ application/json:
3683
+ schema:
3684
+ $ref: '#/components/schemas/Pipeline'
3685
+ description: OK
3686
+ summary: Restart a pipeline
3687
+ tags:
3688
+ - Pipelines
3689
+ /repos/{repo_id}/pipelines/{pipeline_number}/approve:
3690
+ post:
3691
+ parameters:
3692
+ - description: Insert your personal access token
3693
+ in: header
3694
+ name: Authorization
3695
+ required: true
3696
+ schema:
3697
+ default: Bearer <personal access token>
3698
+ type: string
3699
+ - description: the repository id
3700
+ in: path
3701
+ name: repo_id
3702
+ required: true
3703
+ schema:
3704
+ type: integer
3705
+ - description: the number of the pipeline
3706
+ in: path
3707
+ name: pipeline_number
3708
+ required: true
3709
+ schema:
3710
+ type: integer
3711
+ responses:
3712
+ '200':
3713
+ content:
3714
+ application/json:
3715
+ schema:
3716
+ $ref: '#/components/schemas/Pipeline'
3717
+ description: OK
3718
+ summary: Approve and start a pipeline
3719
+ tags:
3720
+ - Pipelines
3721
+ /repos/{repo_id}/pipelines/{pipeline_number}/cancel:
3722
+ post:
3723
+ parameters:
3724
+ - description: Insert your personal access token
3725
+ in: header
3726
+ name: Authorization
3727
+ required: true
3728
+ schema:
3729
+ default: Bearer <personal access token>
3730
+ type: string
3731
+ - description: the repository id
3732
+ in: path
3733
+ name: repo_id
3734
+ required: true
3735
+ schema:
3736
+ type: integer
3737
+ - description: the number of the pipeline
3738
+ in: path
3739
+ name: pipeline_number
3740
+ required: true
3741
+ schema:
3742
+ type: integer
3743
+ responses:
3744
+ '200':
3745
+ description: OK
3746
+ summary: Cancel a pipeline
3747
+ tags:
3748
+ - Pipelines
3749
+ /repos/{repo_id}/pipelines/{pipeline_number}/config:
3750
+ get:
3751
+ parameters:
3752
+ - description: Insert your personal access token
3753
+ in: header
3754
+ name: Authorization
3755
+ required: true
3756
+ schema:
3757
+ default: Bearer <personal access token>
3758
+ type: string
3759
+ - description: the repository id
3760
+ in: path
3761
+ name: repo_id
3762
+ required: true
3763
+ schema:
3764
+ type: integer
3765
+ - description: the number of the pipeline
3766
+ in: path
3767
+ name: pipeline_number
3768
+ required: true
3769
+ schema:
3770
+ type: integer
3771
+ responses:
3772
+ '200':
3773
+ content:
3774
+ application/json:
3775
+ schema:
3776
+ items:
3777
+ $ref: '#/components/schemas/Config'
3778
+ type: array
3779
+ description: OK
3780
+ summary: Get configuration files for a pipeline
3781
+ tags:
3782
+ - Pipelines
3783
+ /repos/{repo_id}/pipelines/{pipeline_number}/decline:
3784
+ post:
3785
+ parameters:
3786
+ - description: Insert your personal access token
3787
+ in: header
3788
+ name: Authorization
3789
+ required: true
3790
+ schema:
3791
+ default: Bearer <personal access token>
3792
+ type: string
3793
+ - description: the repository id
3794
+ in: path
3795
+ name: repo_id
3796
+ required: true
3797
+ schema:
3798
+ type: integer
3799
+ - description: the number of the pipeline
3800
+ in: path
3801
+ name: pipeline_number
3802
+ required: true
3803
+ schema:
3804
+ type: integer
3805
+ responses:
3806
+ '200':
3807
+ content:
3808
+ application/json:
3809
+ schema:
3810
+ $ref: '#/components/schemas/Pipeline'
3811
+ description: OK
3812
+ summary: Decline a pipeline
3813
+ tags:
3814
+ - Pipelines
3815
+ /repos/{repo_id}/pipelines/{pipeline_number}/metadata:
3816
+ get:
3817
+ parameters:
3818
+ - description: Insert your personal access token
3819
+ in: header
3820
+ name: Authorization
3821
+ required: true
3822
+ schema:
3823
+ default: Bearer <personal access token>
3824
+ type: string
3825
+ - description: the repository id
3826
+ in: path
3827
+ name: repo_id
3828
+ required: true
3829
+ schema:
3830
+ type: integer
3831
+ - description: the number of the pipeline
3832
+ in: path
3833
+ name: pipeline_number
3834
+ required: true
3835
+ schema:
3836
+ type: integer
3837
+ responses:
3838
+ '200':
3839
+ content:
3840
+ application/json:
3841
+ schema:
3842
+ $ref: '#/components/schemas/metadata.Metadata'
3843
+ description: OK
3844
+ summary: >-
3845
+ Get metadata for a pipeline or a specific workflow, including previous
3846
+ pipeline info
3847
+ tags:
3848
+ - Pipelines
3849
+ /repos/{repo_id}/pull_requests:
3850
+ get:
3851
+ parameters:
3852
+ - description: Insert your personal access token
3853
+ in: header
3854
+ name: Authorization
3855
+ required: true
3856
+ schema:
3857
+ default: Bearer <personal access token>
3858
+ type: string
3859
+ - description: the repository id
3860
+ in: path
3861
+ name: repo_id
3862
+ required: true
3863
+ schema:
3864
+ type: integer
3865
+ - description: for response pagination, page offset number
3866
+ in: query
3867
+ name: page
3868
+ schema:
3869
+ default: 1
3870
+ type: integer
3871
+ - description: for response pagination, max items per page
3872
+ in: query
3873
+ name: perPage
3874
+ schema:
3875
+ default: 50
3876
+ type: integer
3877
+ responses:
3878
+ '200':
3879
+ content:
3880
+ application/json:
3881
+ schema:
3882
+ items:
3883
+ $ref: '#/components/schemas/PullRequest'
3884
+ type: array
3885
+ description: OK
3886
+ summary: List active pull requests of a repository
3887
+ tags:
3888
+ - Repositories
3889
+ /repos/{repo_id}/registries:
3890
+ get:
3891
+ parameters:
3892
+ - description: Insert your personal access token
3893
+ in: header
3894
+ name: Authorization
3895
+ required: true
3896
+ schema:
3897
+ default: Bearer <personal access token>
3898
+ type: string
3899
+ - description: the repository id
3900
+ in: path
3901
+ name: repo_id
3902
+ required: true
3903
+ schema:
3904
+ type: integer
3905
+ - description: for response pagination, page offset number
3906
+ in: query
3907
+ name: page
3908
+ schema:
3909
+ default: 1
3910
+ type: integer
3911
+ - description: for response pagination, max items per page
3912
+ in: query
3913
+ name: perPage
3914
+ schema:
3915
+ default: 50
3916
+ type: integer
3917
+ responses:
3918
+ '200':
3919
+ content:
3920
+ application/json:
3921
+ schema:
3922
+ items:
3923
+ $ref: '#/components/schemas/Registry'
3924
+ type: array
3925
+ description: OK
3926
+ summary: List registries
3927
+ tags:
3928
+ - Repository registries
3929
+ post:
3930
+ parameters:
3931
+ - description: Insert your personal access token
3932
+ in: header
3933
+ name: Authorization
3934
+ required: true
3935
+ schema:
3936
+ default: Bearer <personal access token>
3937
+ type: string
3938
+ - description: the repository id
3939
+ in: path
3940
+ name: repo_id
3941
+ required: true
3942
+ schema:
3943
+ type: integer
3944
+ requestBody:
3945
+ content:
3946
+ '*/*':
3947
+ schema:
3948
+ $ref: '#/components/schemas/Registry'
3949
+ description: the new registry data
3950
+ required: true
3951
+ x-originalParamName: registry
3952
+ responses:
3953
+ '200':
3954
+ content:
3955
+ application/json:
3956
+ schema:
3957
+ $ref: '#/components/schemas/Registry'
3958
+ description: OK
3959
+ summary: Create a registry
3960
+ tags:
3961
+ - Repository registries
3962
+ /repos/{repo_id}/registries/{registry}:
3963
+ delete:
3964
+ parameters:
3965
+ - description: Insert your personal access token
3966
+ in: header
3967
+ name: Authorization
3968
+ required: true
3969
+ schema:
3970
+ default: Bearer <personal access token>
3971
+ type: string
3972
+ - description: the repository id
3973
+ in: path
3974
+ name: repo_id
3975
+ required: true
3976
+ schema:
3977
+ type: integer
3978
+ - description: the registry name
3979
+ in: path
3980
+ name: registry
3981
+ required: true
3982
+ schema:
3983
+ type: string
3984
+ responses:
3985
+ '204':
3986
+ description: No Content
3987
+ summary: Delete a registry by name
3988
+ tags:
3989
+ - Repository registries
3990
+ get:
3991
+ parameters:
3992
+ - description: Insert your personal access token
3993
+ in: header
3994
+ name: Authorization
3995
+ required: true
3996
+ schema:
3997
+ default: Bearer <personal access token>
3998
+ type: string
3999
+ - description: the repository id
4000
+ in: path
4001
+ name: repo_id
4002
+ required: true
4003
+ schema:
4004
+ type: integer
4005
+ - description: the registry name
4006
+ in: path
4007
+ name: registry
4008
+ required: true
4009
+ schema:
4010
+ type: string
4011
+ responses:
4012
+ '200':
4013
+ content:
4014
+ application/json:
4015
+ schema:
4016
+ $ref: '#/components/schemas/Registry'
4017
+ description: OK
4018
+ summary: Get a registry by name
4019
+ tags:
4020
+ - Repository registries
4021
+ patch:
4022
+ parameters:
4023
+ - description: Insert your personal access token
4024
+ in: header
4025
+ name: Authorization
4026
+ required: true
4027
+ schema:
4028
+ default: Bearer <personal access token>
4029
+ type: string
4030
+ - description: the repository id
4031
+ in: path
4032
+ name: repo_id
4033
+ required: true
4034
+ schema:
4035
+ type: integer
4036
+ - description: the registry name
4037
+ in: path
4038
+ name: registry
4039
+ required: true
4040
+ schema:
4041
+ type: string
4042
+ requestBody:
4043
+ content:
4044
+ '*/*':
4045
+ schema:
4046
+ $ref: '#/components/schemas/Registry'
4047
+ description: the attributes for the registry
4048
+ required: true
4049
+ x-originalParamName: registryData
4050
+ responses:
4051
+ '200':
4052
+ content:
4053
+ application/json:
4054
+ schema:
4055
+ $ref: '#/components/schemas/Registry'
4056
+ description: OK
4057
+ summary: Update a registry by name
4058
+ tags:
4059
+ - Repository registries
4060
+ /repos/{repo_id}/repair:
4061
+ post:
4062
+ parameters:
4063
+ - description: Insert your personal access token
4064
+ in: header
4065
+ name: Authorization
4066
+ required: true
4067
+ schema:
4068
+ default: Bearer <personal access token>
4069
+ type: string
4070
+ - description: the repository id
4071
+ in: path
4072
+ name: repo_id
4073
+ required: true
4074
+ schema:
4075
+ type: integer
4076
+ responses:
4077
+ '204':
4078
+ description: No Content
4079
+ summary: Repair a repository
4080
+ tags:
4081
+ - Repositories
4082
+ /repos/{repo_id}/secrets:
4083
+ get:
4084
+ parameters:
4085
+ - description: Insert your personal access token
4086
+ in: header
4087
+ name: Authorization
4088
+ required: true
4089
+ schema:
4090
+ default: Bearer <personal access token>
4091
+ type: string
4092
+ - description: the repository id
4093
+ in: path
4094
+ name: repo_id
4095
+ required: true
4096
+ schema:
4097
+ type: integer
4098
+ - description: for response pagination, page offset number
4099
+ in: query
4100
+ name: page
4101
+ schema:
4102
+ default: 1
4103
+ type: integer
4104
+ - description: for response pagination, max items per page
4105
+ in: query
4106
+ name: perPage
4107
+ schema:
4108
+ default: 50
4109
+ type: integer
4110
+ responses:
4111
+ '200':
4112
+ content:
4113
+ application/json:
4114
+ schema:
4115
+ items:
4116
+ $ref: '#/components/schemas/Secret'
4117
+ type: array
4118
+ description: OK
4119
+ summary: List repository secrets
4120
+ tags:
4121
+ - Repository secrets
4122
+ post:
4123
+ parameters:
4124
+ - description: Insert your personal access token
4125
+ in: header
4126
+ name: Authorization
4127
+ required: true
4128
+ schema:
4129
+ default: Bearer <personal access token>
4130
+ type: string
4131
+ - description: the repository id
4132
+ in: path
4133
+ name: repo_id
4134
+ required: true
4135
+ schema:
4136
+ type: integer
4137
+ requestBody:
4138
+ content:
4139
+ '*/*':
4140
+ schema:
4141
+ $ref: '#/components/schemas/Secret'
4142
+ description: the new secret
4143
+ required: true
4144
+ x-originalParamName: secret
4145
+ responses:
4146
+ '200':
4147
+ content:
4148
+ application/json:
4149
+ schema:
4150
+ $ref: '#/components/schemas/Secret'
4151
+ description: OK
4152
+ summary: Create a repository secret
4153
+ tags:
4154
+ - Repository secrets
4155
+ /repos/{repo_id}/secrets/{secretName}:
4156
+ delete:
4157
+ parameters:
4158
+ - description: Insert your personal access token
4159
+ in: header
4160
+ name: Authorization
4161
+ required: true
4162
+ schema:
4163
+ default: Bearer <personal access token>
4164
+ type: string
4165
+ - description: the repository id
4166
+ in: path
4167
+ name: repo_id
4168
+ required: true
4169
+ schema:
4170
+ type: integer
4171
+ - description: the secret name
4172
+ in: path
4173
+ name: secretName
4174
+ required: true
4175
+ schema:
4176
+ type: string
4177
+ responses:
4178
+ '204':
4179
+ description: No Content
4180
+ summary: Delete a repository secret by name
4181
+ tags:
4182
+ - Repository secrets
4183
+ get:
4184
+ parameters:
4185
+ - description: Insert your personal access token
4186
+ in: header
4187
+ name: Authorization
4188
+ required: true
4189
+ schema:
4190
+ default: Bearer <personal access token>
4191
+ type: string
4192
+ - description: the repository id
4193
+ in: path
4194
+ name: repo_id
4195
+ required: true
4196
+ schema:
4197
+ type: integer
4198
+ - description: the secret name
4199
+ in: path
4200
+ name: secretName
4201
+ required: true
4202
+ schema:
4203
+ type: string
4204
+ responses:
4205
+ '200':
4206
+ content:
4207
+ application/json:
4208
+ schema:
4209
+ $ref: '#/components/schemas/Secret'
4210
+ description: OK
4211
+ summary: Get a repository secret by name
4212
+ tags:
4213
+ - Repository secrets
4214
+ patch:
4215
+ parameters:
4216
+ - description: Insert your personal access token
4217
+ in: header
4218
+ name: Authorization
4219
+ required: true
4220
+ schema:
4221
+ default: Bearer <personal access token>
4222
+ type: string
4223
+ - description: the repository id
4224
+ in: path
4225
+ name: repo_id
4226
+ required: true
4227
+ schema:
4228
+ type: integer
4229
+ - description: the secret name
4230
+ in: path
4231
+ name: secretName
4232
+ required: true
4233
+ schema:
4234
+ type: string
4235
+ requestBody:
4236
+ content:
4237
+ '*/*':
4238
+ schema:
4239
+ $ref: '#/components/schemas/SecretPatch'
4240
+ description: the secret itself
4241
+ required: true
4242
+ x-originalParamName: secret
4243
+ responses:
4244
+ '200':
4245
+ content:
4246
+ application/json:
4247
+ schema:
4248
+ $ref: '#/components/schemas/Secret'
4249
+ description: OK
4250
+ summary: Update a repository secret by name
4251
+ tags:
4252
+ - Repository secrets
4253
+ /secrets:
4254
+ get:
4255
+ parameters:
4256
+ - description: Insert your personal access token
4257
+ in: header
4258
+ name: Authorization
4259
+ required: true
4260
+ schema:
4261
+ default: Bearer <personal access token>
4262
+ type: string
4263
+ - description: for response pagination, page offset number
4264
+ in: query
4265
+ name: page
4266
+ schema:
4267
+ default: 1
4268
+ type: integer
4269
+ - description: for response pagination, max items per page
4270
+ in: query
4271
+ name: perPage
4272
+ schema:
4273
+ default: 50
4274
+ type: integer
4275
+ responses:
4276
+ '200':
4277
+ content:
4278
+ application/json:
4279
+ schema:
4280
+ items:
4281
+ $ref: '#/components/schemas/Secret'
4282
+ type: array
4283
+ description: OK
4284
+ summary: List global secrets
4285
+ tags:
4286
+ - Secrets
4287
+ post:
4288
+ parameters:
4289
+ - description: Insert your personal access token
4290
+ in: header
4291
+ name: Authorization
4292
+ required: true
4293
+ schema:
4294
+ default: Bearer <personal access token>
4295
+ type: string
4296
+ requestBody:
4297
+ content:
4298
+ '*/*':
4299
+ schema:
4300
+ $ref: '#/components/schemas/Secret'
4301
+ description: the secret object data
4302
+ required: true
4303
+ x-originalParamName: secret
4304
+ responses:
4305
+ '200':
4306
+ content:
4307
+ application/json:
4308
+ schema:
4309
+ $ref: '#/components/schemas/Secret'
4310
+ description: OK
4311
+ summary: Create a global secret
4312
+ tags:
4313
+ - Secrets
4314
+ /secrets/{secret}:
4315
+ delete:
4316
+ parameters:
4317
+ - description: Insert your personal access token
4318
+ in: header
4319
+ name: Authorization
4320
+ required: true
4321
+ schema:
4322
+ default: Bearer <personal access token>
4323
+ type: string
4324
+ - description: the secret's name
4325
+ in: path
4326
+ name: secret
4327
+ required: true
4328
+ schema:
4329
+ type: string
4330
+ responses:
4331
+ '204':
4332
+ description: No Content
4333
+ summary: Delete a global secret by name
4334
+ tags:
4335
+ - Secrets
4336
+ get:
4337
+ parameters:
4338
+ - description: Insert your personal access token
4339
+ in: header
4340
+ name: Authorization
4341
+ required: true
4342
+ schema:
4343
+ default: Bearer <personal access token>
4344
+ type: string
4345
+ - description: the secret's name
4346
+ in: path
4347
+ name: secret
4348
+ required: true
4349
+ schema:
4350
+ type: string
4351
+ responses:
4352
+ '200':
4353
+ content:
4354
+ application/json:
4355
+ schema:
4356
+ $ref: '#/components/schemas/Secret'
4357
+ description: OK
4358
+ summary: Get a global secret by name
4359
+ tags:
4360
+ - Secrets
4361
+ patch:
4362
+ parameters:
4363
+ - description: Insert your personal access token
4364
+ in: header
4365
+ name: Authorization
4366
+ required: true
4367
+ schema:
4368
+ default: Bearer <personal access token>
4369
+ type: string
4370
+ - description: the secret's name
4371
+ in: path
4372
+ name: secret
4373
+ required: true
4374
+ schema:
4375
+ type: string
4376
+ requestBody:
4377
+ content:
4378
+ '*/*':
4379
+ schema:
4380
+ $ref: '#/components/schemas/SecretPatch'
4381
+ description: the secret's data
4382
+ required: true
4383
+ x-originalParamName: secretData
4384
+ responses:
4385
+ '200':
4386
+ content:
4387
+ application/json:
4388
+ schema:
4389
+ $ref: '#/components/schemas/Secret'
4390
+ description: OK
4391
+ summary: Update a global secret by name
4392
+ tags:
4393
+ - Secrets
4394
+ /signature/public-key:
4395
+ get:
4396
+ parameters:
4397
+ - description: Insert your personal access token
4398
+ in: header
4399
+ name: Authorization
4400
+ required: true
4401
+ schema:
4402
+ default: Bearer <personal access token>
4403
+ type: string
4404
+ responses:
4405
+ '200':
4406
+ description: OK
4407
+ summary: Get server's signature public key
4408
+ tags:
4409
+ - System
4410
+ /stream/events:
4411
+ get:
4412
+ description: With quic and http2 support
4413
+ responses:
4414
+ '200':
4415
+ description: OK
4416
+ summary: Stream events like pipeline updates
4417
+ tags:
4418
+ - Events
4419
+ /stream/logs/{repo_id}/{pipeline}/{step_id}:
4420
+ get:
4421
+ parameters:
4422
+ - description: the repository id
4423
+ in: path
4424
+ name: repo_id
4425
+ required: true
4426
+ schema:
4427
+ type: integer
4428
+ - description: the number of the pipeline
4429
+ in: path
4430
+ name: pipeline
4431
+ required: true
4432
+ schema:
4433
+ type: integer
4434
+ - description: the step id
4435
+ in: path
4436
+ name: step_id
4437
+ required: true
4438
+ schema:
4439
+ type: integer
4440
+ responses:
4441
+ '200':
4442
+ description: OK
4443
+ summary: Stream logs of a pipeline step
4444
+ tags:
4445
+ - Pipeline logs
4446
+ /user:
4447
+ get:
4448
+ parameters:
4449
+ - description: Insert your personal access token
4450
+ in: header
4451
+ name: Authorization
4452
+ required: true
4453
+ schema:
4454
+ default: Bearer <personal access token>
4455
+ type: string
4456
+ responses:
4457
+ '200':
4458
+ content:
4459
+ application/json:
4460
+ schema:
4461
+ $ref: '#/components/schemas/User'
4462
+ description: OK
4463
+ summary: Get the currently authenticated user
4464
+ tags:
4465
+ - User
4466
+ /user/feed:
4467
+ get:
4468
+ description: >-
4469
+ The feed lists the most recent pipeline for the currently authenticated
4470
+ user.
4471
+ parameters:
4472
+ - description: Insert your personal access token
4473
+ in: header
4474
+ name: Authorization
4475
+ required: true
4476
+ schema:
4477
+ default: Bearer <personal access token>
4478
+ type: string
4479
+ responses:
4480
+ '200':
4481
+ content:
4482
+ application/json:
4483
+ schema:
4484
+ items:
4485
+ $ref: '#/components/schemas/Feed'
4486
+ type: array
4487
+ description: OK
4488
+ summary: Get the currently authenticated users pipeline feed
4489
+ tags:
4490
+ - User
4491
+ /user/repos:
4492
+ get:
4493
+ description: Retrieve the currently authenticated User's Repository list
4494
+ parameters:
4495
+ - description: Insert your personal access token
4496
+ in: header
4497
+ name: Authorization
4498
+ required: true
4499
+ schema:
4500
+ default: Bearer <personal access token>
4501
+ type: string
4502
+ - description: query all repos, including inactive ones
4503
+ in: query
4504
+ name: all
4505
+ schema:
4506
+ type: boolean
4507
+ - description: filter repos by name
4508
+ in: query
4509
+ name: name
4510
+ schema:
4511
+ type: string
4512
+ responses:
4513
+ '200':
4514
+ content:
4515
+ application/json:
4516
+ schema:
4517
+ items:
4518
+ $ref: '#/components/schemas/RepoLastPipeline'
4519
+ type: array
4520
+ description: OK
4521
+ summary: Get user's repositories
4522
+ tags:
4523
+ - User
4524
+ /user/token:
4525
+ delete:
4526
+ description: >-
4527
+ Reset's the current personal access token of the user and returns a new
4528
+ one.
4529
+ parameters:
4530
+ - description: Insert your personal access token
4531
+ in: header
4532
+ name: Authorization
4533
+ required: true
4534
+ schema:
4535
+ default: Bearer <personal access token>
4536
+ type: string
4537
+ responses:
4538
+ '200':
4539
+ description: OK
4540
+ summary: Reset a token
4541
+ tags:
4542
+ - User
4543
+ post:
4544
+ parameters:
4545
+ - description: Insert your personal access token
4546
+ in: header
4547
+ name: Authorization
4548
+ required: true
4549
+ schema:
4550
+ default: Bearer <personal access token>
4551
+ type: string
4552
+ responses:
4553
+ '200':
4554
+ description: OK
4555
+ summary: Return the token of the current user as string
4556
+ tags:
4557
+ - User
4558
+ /users:
4559
+ get:
4560
+ description: >-
4561
+ Returns all registered, active users in the system. Requires admin
4562
+ rights.
4563
+ parameters:
4564
+ - description: Insert your personal access token
4565
+ in: header
4566
+ name: Authorization
4567
+ required: true
4568
+ schema:
4569
+ default: Bearer <personal access token>
4570
+ type: string
4571
+ - description: for response pagination, page offset number
4572
+ in: query
4573
+ name: page
4574
+ schema:
4575
+ default: 1
4576
+ type: integer
4577
+ - description: for response pagination, max items per page
4578
+ in: query
4579
+ name: perPage
4580
+ schema:
4581
+ default: 50
4582
+ type: integer
4583
+ responses:
4584
+ '200':
4585
+ content:
4586
+ application/json:
4587
+ schema:
4588
+ items:
4589
+ $ref: '#/components/schemas/User'
4590
+ type: array
4591
+ description: OK
4592
+ summary: List users
4593
+ tags:
4594
+ - Users
4595
+ post:
4596
+ description: >-
4597
+ Creates a new user account with the specified external login. Requires
4598
+ admin rights.
4599
+ parameters:
4600
+ - description: Insert your personal access token
4601
+ in: header
4602
+ name: Authorization
4603
+ required: true
4604
+ schema:
4605
+ default: Bearer <personal access token>
4606
+ type: string
4607
+ requestBody:
4608
+ content:
4609
+ '*/*':
4610
+ schema:
4611
+ $ref: '#/components/schemas/User'
4612
+ description: the user's data
4613
+ required: true
4614
+ x-originalParamName: user
4615
+ responses:
4616
+ '200':
4617
+ content:
4618
+ application/json:
4619
+ schema:
4620
+ $ref: '#/components/schemas/User'
4621
+ description: OK
4622
+ summary: Create a user
4623
+ tags:
4624
+ - Users
4625
+ /users/{login}:
4626
+ delete:
4627
+ description: Deletes the given user. Requires admin rights.
4628
+ parameters:
4629
+ - description: Insert your personal access token
4630
+ in: header
4631
+ name: Authorization
4632
+ required: true
4633
+ schema:
4634
+ default: Bearer <personal access token>
4635
+ type: string
4636
+ - description: the user's login name
4637
+ in: path
4638
+ name: login
4639
+ required: true
4640
+ schema:
4641
+ type: string
4642
+ - description: specify forge (else default will be used)
4643
+ in: query
4644
+ name: forge_id
4645
+ required: true
4646
+ schema:
4647
+ type: string
4648
+ - description: specify user id at forge (else fallback to login)
4649
+ in: query
4650
+ name: forge_remote_id
4651
+ schema:
4652
+ type: string
4653
+ responses:
4654
+ '204':
4655
+ description: No Content
4656
+ summary: Delete a user
4657
+ tags:
4658
+ - Users
4659
+ get:
4660
+ description: Returns a user with the specified login name. Requires admin rights.
4661
+ parameters:
4662
+ - description: Insert your personal access token
4663
+ in: header
4664
+ name: Authorization
4665
+ required: true
4666
+ schema:
4667
+ default: Bearer <personal access token>
4668
+ type: string
4669
+ - description: the user's login name
4670
+ in: path
4671
+ name: login
4672
+ required: true
4673
+ schema:
4674
+ type: string
4675
+ - description: specify forge (else default will be used)
4676
+ in: query
4677
+ name: forge_id
4678
+ required: true
4679
+ schema:
4680
+ type: string
4681
+ - description: specify user id at forge (else fallback to login)
4682
+ in: query
4683
+ name: forge_remote_id
4684
+ schema:
4685
+ type: string
4686
+ responses:
4687
+ '200':
4688
+ content:
4689
+ application/json:
4690
+ schema:
4691
+ $ref: '#/components/schemas/User'
4692
+ description: OK
4693
+ summary: Get a user
4694
+ tags:
4695
+ - Users
4696
+ patch:
4697
+ description: Changes the data of an existing user. Requires admin rights.
4698
+ parameters:
4699
+ - description: Insert your personal access token
4700
+ in: header
4701
+ name: Authorization
4702
+ required: true
4703
+ schema:
4704
+ default: Bearer <personal access token>
4705
+ type: string
4706
+ - description: the user's login name
4707
+ in: path
4708
+ name: login
4709
+ required: true
4710
+ schema:
4711
+ type: string
4712
+ requestBody:
4713
+ content:
4714
+ application/json:
4715
+ schema:
4716
+ $ref: '#/components/schemas/User'
4717
+ description: the user's data
4718
+ required: true
4719
+ x-originalParamName: user
4720
+ responses:
4721
+ '200':
4722
+ content:
4723
+ application/json:
4724
+ schema:
4725
+ $ref: '#/components/schemas/User'
4726
+ description: OK
4727
+ summary: Update a user
4728
+ tags:
4729
+ - Users
4730
+ /version:
4731
+ get:
4732
+ description: Endpoint returns the server version and build information.
4733
+ responses:
4734
+ '200':
4735
+ content:
4736
+ application/json:
4737
+ schema:
4738
+ properties:
4739
+ source:
4740
+ type: string
4741
+ version:
4742
+ type: string
4743
+ type: object
4744
+ description: OK
4745
+ summary: Get version
4746
+ tags:
4747
+ - System