@itentialopensource/adapter-azure_devops 0.1.1

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.
Files changed (68) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/CHANGELOG.md +9 -0
  5. package/CODE_OF_CONDUCT.md +48 -0
  6. package/CONTRIBUTING.md +158 -0
  7. package/LICENSE +201 -0
  8. package/README.md +687 -0
  9. package/adapter.js +1606 -0
  10. package/adapterBase.js +1028 -0
  11. package/entities/.generic/action.json +109 -0
  12. package/entities/.generic/schema.json +23 -0
  13. package/entities/.system/action.json +50 -0
  14. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  15. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  16. package/entities/.system/schema.json +19 -0
  17. package/entities/.system/schemaTokenReq.json +53 -0
  18. package/entities/.system/schemaTokenResp.json +53 -0
  19. package/entities/Artifacts/action.json +25 -0
  20. package/entities/Artifacts/mockdatafiles/artifactsGet-default.json +5 -0
  21. package/entities/Artifacts/schema.json +41 -0
  22. package/entities/Logs/action.json +46 -0
  23. package/entities/Logs/mockdatafiles/logsGet-default.json +11 -0
  24. package/entities/Logs/mockdatafiles/logsList-default.json +119 -0
  25. package/entities/Logs/schema.json +42 -0
  26. package/entities/Pipelines/action.json +66 -0
  27. package/entities/Pipelines/mockdatafiles/pipelinesCreate-default.json +6 -0
  28. package/entities/Pipelines/mockdatafiles/pipelinesGet-default.json +6 -0
  29. package/entities/Pipelines/mockdatafiles/pipelinesList-default.json +26 -0
  30. package/entities/Pipelines/schema.json +43 -0
  31. package/entities/Preview/action.json +24 -0
  32. package/entities/Preview/mockdatafiles/previewPreview-default.json +3 -0
  33. package/entities/Preview/schema.json +30 -0
  34. package/entities/Runs/action.json +66 -0
  35. package/entities/Runs/mockdatafiles/runsGet-default.json +4 -0
  36. package/entities/Runs/mockdatafiles/runsList-default.json +18 -0
  37. package/entities/Runs/mockdatafiles/runsRunPipeline-default.json +4 -0
  38. package/entities/Runs/schema.json +32 -0
  39. package/error.json +184 -0
  40. package/package.json +85 -0
  41. package/pronghorn.json +2488 -0
  42. package/propertiesSchema.json +840 -0
  43. package/refs?service=git-upload-pack +0 -0
  44. package/report/ado.json +1382 -0
  45. package/report/creationReport.json +228 -0
  46. package/report/updateReport1639421539710.json +95 -0
  47. package/sampleProperties.json +106 -0
  48. package/test/integration/adapterTestBasicGet.js +85 -0
  49. package/test/integration/adapterTestConnectivity.js +93 -0
  50. package/test/integration/adapterTestIntegration.js +751 -0
  51. package/test/unit/adapterBaseTestUnit.js +944 -0
  52. package/test/unit/adapterTestUnit.js +2192 -0
  53. package/utils/addAuth.js +94 -0
  54. package/utils/artifactize.js +146 -0
  55. package/utils/basicGet.js +50 -0
  56. package/utils/checkMigrate.js +63 -0
  57. package/utils/entitiesToDB.js +224 -0
  58. package/utils/findPath.js +74 -0
  59. package/utils/modify.js +154 -0
  60. package/utils/packModificationScript.js +35 -0
  61. package/utils/pre-commit.sh +27 -0
  62. package/utils/removeHooks.js +20 -0
  63. package/utils/setup.js +33 -0
  64. package/utils/tbScript.js +169 -0
  65. package/utils/tbUtils.js +445 -0
  66. package/utils/testRunner.js +298 -0
  67. package/utils/troubleshootingAdapter.js +190 -0
  68. package/workflows/README.md +3 -0
package/pronghorn.json ADDED
@@ -0,0 +1,2488 @@
1
+ {
2
+ "id": "@itentialopensource/adapter-azure_devops",
3
+ "type": "Adapter",
4
+ "export": "AzureDevops",
5
+ "title": "Azure_devops",
6
+ "src": "adapter.js",
7
+ "roles": [
8
+ "admin"
9
+ ],
10
+ "methods": [
11
+ {
12
+ "name": "updateAdapterConfiguration",
13
+ "summary": "Updates the adapter configuration",
14
+ "description": "Updates the adapter configuration file with the provided changes",
15
+ "input": [
16
+ {
17
+ "name": "configFile",
18
+ "type": "string",
19
+ "info": "The name of the file to change",
20
+ "required": true,
21
+ "schema": {
22
+ "title": "configFile",
23
+ "type": "string"
24
+ }
25
+ },
26
+ {
27
+ "name": "changes",
28
+ "type": "object",
29
+ "info": "JSON object containing the configuration changes",
30
+ "required": true,
31
+ "schema": {
32
+ "title": "changes",
33
+ "type": "object"
34
+ }
35
+ },
36
+ {
37
+ "name": "entity",
38
+ "type": "string",
39
+ "info": "The entity in which the changes are being made",
40
+ "required": false,
41
+ "schema": {
42
+ "title": "entity",
43
+ "type": "string"
44
+ }
45
+ },
46
+ {
47
+ "name": "type",
48
+ "type": "string",
49
+ "info": "The type of file to change - action, schema, or mock",
50
+ "required": false,
51
+ "schema": {
52
+ "title": "type",
53
+ "type": "string"
54
+ }
55
+ },
56
+ {
57
+ "name": "action",
58
+ "type": "string",
59
+ "info": "The action to be changed",
60
+ "required": false,
61
+ "schema": {
62
+ "title": "action",
63
+ "type": "string"
64
+ }
65
+ }
66
+ ],
67
+ "output": {
68
+ "name": "result",
69
+ "type": "object",
70
+ "description": "A JSON Object containing status, code and the result",
71
+ "schema": {
72
+ "title": "result",
73
+ "type": "object"
74
+ }
75
+ },
76
+ "roles": [
77
+ "admin"
78
+ ],
79
+ "route": {
80
+ "verb": "POST",
81
+ "path": "/updateAdapterConfiguration"
82
+ },
83
+ "task": true
84
+ },
85
+ {
86
+ "name": "findPath",
87
+ "summary": "Provides the ability to see if a particular API path is supported by the adapter",
88
+ "description": "Provides the ability to see if a particular API path is supported by the adapter",
89
+ "input": [
90
+ {
91
+ "name": "apiPath",
92
+ "type": "string",
93
+ "info": "The API Path you want to check - make sure to not include base path and version",
94
+ "description": "The API Path you want to check - make sure to not include base path and version",
95
+ "schema": {
96
+ "title": "apiPath",
97
+ "type": "string"
98
+ },
99
+ "required": true
100
+ }
101
+ ],
102
+ "output": {
103
+ "name": "result",
104
+ "type": "object",
105
+ "description": "A JSON Object containing the result",
106
+ "schema": {
107
+ "title": "result",
108
+ "type": "object"
109
+ }
110
+ },
111
+ "roles": [
112
+ "admin"
113
+ ],
114
+ "route": {
115
+ "verb": "POST",
116
+ "path": "/findPath"
117
+ },
118
+ "task": true
119
+ },
120
+ {
121
+ "name": "troubleshoot",
122
+ "summary": "Runs troubleshoot script for adapter",
123
+ "description": "Runs troubleshoot script for adapter",
124
+ "input": [
125
+ {
126
+ "name": "props",
127
+ "type": "object",
128
+ "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}",
129
+ "required": true,
130
+ "schema": {
131
+ "title": "props",
132
+ "type": "object"
133
+ }
134
+ },
135
+ {
136
+ "name": "persistFlag",
137
+ "type": "boolean",
138
+ "info": "Whether the input properties should be saved",
139
+ "required": true
140
+ }
141
+ ],
142
+ "output": {
143
+ "name": "result",
144
+ "type": "object",
145
+ "description": "A JSON Object containing the test results",
146
+ "schema": {
147
+ "title": "result",
148
+ "type": "object"
149
+ }
150
+ },
151
+ "roles": [
152
+ "admin"
153
+ ],
154
+ "route": {
155
+ "verb": "POST",
156
+ "path": "/troubleshoot"
157
+ },
158
+ "task": true
159
+ },
160
+ {
161
+ "name": "runHealthcheck",
162
+ "summary": "Runs healthcheck script for adapter",
163
+ "description": "Runs healthcheck script for adapter",
164
+ "input": [],
165
+ "output": {
166
+ "name": "result",
167
+ "type": "boolean",
168
+ "description": "Whether healthcheck passed or failed"
169
+ },
170
+ "roles": [
171
+ "admin"
172
+ ],
173
+ "route": {
174
+ "verb": "POST",
175
+ "path": "/runHealthcheck"
176
+ },
177
+ "task": true
178
+ },
179
+ {
180
+ "name": "runConnectivity",
181
+ "summary": "Runs connectivity check script for adapter",
182
+ "description": "Runs connectivity check script for adapter",
183
+ "input": [],
184
+ "output": {
185
+ "name": "result",
186
+ "type": "object",
187
+ "description": "A JSON Object containing the test results",
188
+ "schema": {
189
+ "title": "result",
190
+ "type": "object"
191
+ }
192
+ },
193
+ "roles": [
194
+ "admin"
195
+ ],
196
+ "route": {
197
+ "verb": "POST",
198
+ "path": "/runConnectivity"
199
+ },
200
+ "task": true
201
+ },
202
+ {
203
+ "name": "runBasicGet",
204
+ "summary": "Runs basicGet script for adapter",
205
+ "description": "Runs basicGet script for adapter",
206
+ "input": [],
207
+ "output": {
208
+ "name": "result",
209
+ "type": "object",
210
+ "description": "A JSON Object containing the test results",
211
+ "schema": {
212
+ "title": "result",
213
+ "type": "object"
214
+ }
215
+ },
216
+ "roles": [
217
+ "admin"
218
+ ],
219
+ "route": {
220
+ "verb": "POST",
221
+ "path": "/runBasicGet"
222
+ },
223
+ "task": true
224
+ },
225
+ {
226
+ "name": "suspend",
227
+ "summary": "Suspends the adapter",
228
+ "description": "Suspends the adapter",
229
+ "input": [
230
+ {
231
+ "name": "mode",
232
+ "type": "enum",
233
+ "enumerals": [
234
+ "pause",
235
+ "error"
236
+ ],
237
+ "info": "How incoming requests are handled. Defaults to 'pause'",
238
+ "description": "How incoming requests are handled. Defaults to 'pause'",
239
+ "schema": {
240
+ "title": "mode",
241
+ "type": "string"
242
+ },
243
+ "required": false
244
+ }
245
+ ],
246
+ "output": {
247
+ "name": "result",
248
+ "type": "object",
249
+ "description": "A JSON Object containing the adapter suspended status",
250
+ "schema": {
251
+ "title": "result",
252
+ "type": "object"
253
+ }
254
+ },
255
+ "roles": [
256
+ "admin"
257
+ ],
258
+ "route": {
259
+ "verb": "POST",
260
+ "path": "/suspend"
261
+ },
262
+ "task": true
263
+ },
264
+ {
265
+ "name": "unsuspend",
266
+ "summary": "Unsuspends the adapter",
267
+ "description": "Unsuspends the adapter",
268
+ "input": [],
269
+ "output": {
270
+ "name": "result",
271
+ "type": "object",
272
+ "description": "A JSON Object containing the adapter suspended status",
273
+ "schema": {
274
+ "title": "result",
275
+ "type": "object"
276
+ }
277
+ },
278
+ "roles": [
279
+ "admin"
280
+ ],
281
+ "route": {
282
+ "verb": "POST",
283
+ "path": "/unsuspend"
284
+ },
285
+ "task": true
286
+ },
287
+ {
288
+ "name": "getQueue",
289
+ "summary": "Return the requests that are waiting in the queue if throttling is enabled",
290
+ "description": "Return the requests that are waiting in the queue if throttling is enabled",
291
+ "input": [],
292
+ "output": {
293
+ "name": "result",
294
+ "type": "object",
295
+ "description": "A JSON Object containing the adapter queue",
296
+ "schema": {
297
+ "title": "result",
298
+ "type": "object"
299
+ }
300
+ },
301
+ "roles": [
302
+ "admin"
303
+ ],
304
+ "route": {
305
+ "verb": "POST",
306
+ "path": "/getQueue"
307
+ },
308
+ "task": true
309
+ },
310
+ {
311
+ "name": "genericAdapterRequest",
312
+ "summary": "Makes the requested generic call",
313
+ "description": "Makes the requested generic call",
314
+ "input": [
315
+ {
316
+ "name": "uriPath",
317
+ "type": "string",
318
+ "info": "the path of the api call - do not include the host, port, base path or version",
319
+ "description": "the path of the api call",
320
+ "schema": {
321
+ "title": "uriPath",
322
+ "type": "string"
323
+ },
324
+ "required": true
325
+ },
326
+ {
327
+ "name": "restMethod",
328
+ "type": "string",
329
+ "info": "the rest method (GET, POST, PUT, PATCH, DELETE)",
330
+ "description": "the rest method (GET, POST, PUT, PATCH, DELETE)",
331
+ "schema": {
332
+ "title": "restMethod",
333
+ "type": "string"
334
+ },
335
+ "required": true
336
+ },
337
+ {
338
+ "name": "queryData",
339
+ "type": "object",
340
+ "info": "the query parameters to be put on the url (optional)",
341
+ "description": "the query parameters to be put on the url (optional)",
342
+ "schema": {
343
+ "title": "queryData",
344
+ "type": "object"
345
+ },
346
+ "required": false
347
+ },
348
+ {
349
+ "name": "requestBody",
350
+ "type": "object",
351
+ "info": "the payload to be sent with the request (optional)",
352
+ "description": "the payload to be sent with the request (optional)",
353
+ "schema": {
354
+ "title": "requestBody",
355
+ "type": "object"
356
+ },
357
+ "required": false
358
+ },
359
+ {
360
+ "name": "addlHeaders",
361
+ "type": "object",
362
+ "info": "additional headers to be put on the call (optional)",
363
+ "description": "additional headers to be put on the call (optional)",
364
+ "schema": {
365
+ "title": "addlHeaders",
366
+ "type": "object"
367
+ },
368
+ "required": false
369
+ }
370
+ ],
371
+ "output": {
372
+ "name": "result",
373
+ "type": "object",
374
+ "description": "A JSON Object containing status, code and the result",
375
+ "schema": {
376
+ "title": "result",
377
+ "type": "object"
378
+ }
379
+ },
380
+ "roles": [
381
+ "admin"
382
+ ],
383
+ "route": {
384
+ "verb": "POST",
385
+ "path": "/genericAdapterRequest"
386
+ },
387
+ "task": true
388
+ },
389
+ {
390
+ "name": "pipelinesCreate",
391
+ "summary": "Create a pipeline.",
392
+ "description": "Create a pipeline.",
393
+ "input": [
394
+ {
395
+ "name": "organization",
396
+ "type": "string",
397
+ "info": "The name of the Azure DevOps organization.: string",
398
+ "required": true,
399
+ "schema": {
400
+ "title": "organization",
401
+ "type": "string"
402
+ }
403
+ },
404
+ {
405
+ "name": "body",
406
+ "type": "object",
407
+ "info": "Input parameters.: {\"configuration\": \"undefined\", \"folder\": \"string\", \"name\": \"string\"}",
408
+ "required": true,
409
+ "schema": {
410
+ "description": "Parameters to create a pipeline.",
411
+ "type": "object",
412
+ "properties": {
413
+ "configuration": {
414
+ "description": "Configuration parameters of the pipeline.",
415
+ "body": {
416
+ "description": "Configuration parameters of the pipeline.",
417
+ "type": "object",
418
+ "properties": {
419
+ "type": {
420
+ "description": "Type of configuration.",
421
+ "enum": [
422
+ "unknown",
423
+ "yaml",
424
+ "designerJson",
425
+ "justInTime",
426
+ "designerHyphenJson"
427
+ ],
428
+ "x-ms-enum": {
429
+ "name": "ConfigurationType",
430
+ "values": [
431
+ {
432
+ "value": "unknown",
433
+ "description": "Unknown type."
434
+ },
435
+ {
436
+ "value": "yaml",
437
+ "description": "YAML."
438
+ },
439
+ {
440
+ "value": "designerJson",
441
+ "description": "Designer JSON."
442
+ },
443
+ {
444
+ "value": "justInTime",
445
+ "description": "Just-in-time."
446
+ },
447
+ {
448
+ "value": "designerHyphenJson",
449
+ "description": "Designer-JSON."
450
+ }
451
+ ]
452
+ }
453
+ }
454
+ }
455
+ }
456
+ },
457
+ "folder": {
458
+ "description": "Folder of the pipeline.",
459
+ "type": "string"
460
+ },
461
+ "name": {
462
+ "description": "Name of the pipeline.",
463
+ "type": "string"
464
+ }
465
+ }
466
+ }
467
+ },
468
+ {
469
+ "name": "project",
470
+ "type": "string",
471
+ "info": "Project ID or project name: string",
472
+ "required": true,
473
+ "schema": {
474
+ "title": "project",
475
+ "type": "string"
476
+ }
477
+ },
478
+ {
479
+ "name": "apiVersion",
480
+ "type": "string",
481
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
482
+ "required": true,
483
+ "schema": {
484
+ "title": "apiVersion",
485
+ "type": "string"
486
+ }
487
+ }
488
+ ],
489
+ "output": {
490
+ "name": "result",
491
+ "type": "object",
492
+ "description": "A JSON Object containing status, code and the result",
493
+ "schema": {
494
+ "description": "Definition of a pipeline.",
495
+ "type": "object",
496
+ "allOf": [
497
+ {
498
+ "description": "",
499
+ "type": "object",
500
+ "properties": {
501
+ "folder": {
502
+ "description": "Pipeline folder",
503
+ "type": "string"
504
+ },
505
+ "id": {
506
+ "description": "Pipeline ID",
507
+ "type": "integer"
508
+ },
509
+ "name": {
510
+ "description": "Pipeline name",
511
+ "type": "string"
512
+ },
513
+ "revision": {
514
+ "description": "Revision number",
515
+ "type": "integer"
516
+ }
517
+ }
518
+ }
519
+ ],
520
+ "properties": {
521
+ "_links": {
522
+ "description": "The class to represent a collection of REST reference links.",
523
+ "type": "object",
524
+ "properties": {
525
+ "links": {
526
+ "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.",
527
+ "type": "object",
528
+ "additionalProperties": {
529
+ "type": "object"
530
+ }
531
+ }
532
+ }
533
+ },
534
+ "configuration": {
535
+ "description": "",
536
+ "type": "object",
537
+ "properties": {
538
+ "type": {
539
+ "enum": [
540
+ "unknown",
541
+ "yaml",
542
+ "designerJson",
543
+ "justInTime",
544
+ "designerHyphenJson"
545
+ ],
546
+ "x-ms-enum": {
547
+ "name": "ConfigurationType",
548
+ "values": [
549
+ {
550
+ "value": "unknown",
551
+ "description": "Unknown type."
552
+ },
553
+ {
554
+ "value": "yaml",
555
+ "description": "YAML."
556
+ },
557
+ {
558
+ "value": "designerJson",
559
+ "description": "Designer JSON."
560
+ },
561
+ {
562
+ "value": "justInTime",
563
+ "description": "Just-in-time."
564
+ },
565
+ {
566
+ "value": "designerHyphenJson",
567
+ "description": "Designer-JSON."
568
+ }
569
+ ]
570
+ }
571
+ }
572
+ }
573
+ },
574
+ "url": {
575
+ "description": "URL of the pipeline",
576
+ "type": "string"
577
+ }
578
+ }
579
+ }
580
+ },
581
+ "roles": [
582
+ "admin"
583
+ ],
584
+ "route": {
585
+ "verb": "POST",
586
+ "path": "/pipelinesCreate"
587
+ },
588
+ "task": true
589
+ },
590
+ {
591
+ "name": "pipelinesList",
592
+ "summary": "Get a list of pipelines.",
593
+ "description": "Get a list of pipelines.",
594
+ "input": [
595
+ {
596
+ "name": "organization",
597
+ "type": "string",
598
+ "info": "The name of the Azure DevOps organization.: string",
599
+ "required": true,
600
+ "schema": {
601
+ "title": "organization",
602
+ "type": "string"
603
+ }
604
+ },
605
+ {
606
+ "name": "project",
607
+ "type": "string",
608
+ "info": "Project ID or project name: string",
609
+ "required": true,
610
+ "schema": {
611
+ "title": "project",
612
+ "type": "string"
613
+ }
614
+ },
615
+ {
616
+ "name": "orderBy",
617
+ "type": "string",
618
+ "info": "A sort expression. Defaults to \"name asc\": string",
619
+ "required": false,
620
+ "schema": {
621
+ "title": "orderBy",
622
+ "type": "string"
623
+ }
624
+ },
625
+ {
626
+ "name": "top",
627
+ "type": "number",
628
+ "info": "The maximum number of pipelines to return: 123",
629
+ "required": false,
630
+ "schema": {
631
+ "title": "top",
632
+ "type": "number"
633
+ }
634
+ },
635
+ {
636
+ "name": "continuationToken",
637
+ "type": "string",
638
+ "info": "A continuation token from a previous request, to retrieve the next page of results: string",
639
+ "required": false,
640
+ "schema": {
641
+ "title": "continuationToken",
642
+ "type": "string"
643
+ }
644
+ },
645
+ {
646
+ "name": "apiVersion",
647
+ "type": "string",
648
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
649
+ "required": true,
650
+ "schema": {
651
+ "title": "apiVersion",
652
+ "type": "string"
653
+ }
654
+ }
655
+ ],
656
+ "output": {
657
+ "name": "result",
658
+ "type": "object",
659
+ "description": "A JSON Object containing status, code and the result",
660
+ "schema": {
661
+ "type": "array",
662
+ "items": {
663
+ "description": "Definition of a pipeline.",
664
+ "type": "object",
665
+ "allOf": [
666
+ {
667
+ "description": "",
668
+ "type": "object",
669
+ "properties": {
670
+ "folder": {
671
+ "description": "Pipeline folder",
672
+ "type": "string"
673
+ },
674
+ "id": {
675
+ "description": "Pipeline ID",
676
+ "type": "integer"
677
+ },
678
+ "name": {
679
+ "description": "Pipeline name",
680
+ "type": "string"
681
+ },
682
+ "revision": {
683
+ "description": "Revision number",
684
+ "type": "integer"
685
+ }
686
+ }
687
+ }
688
+ ],
689
+ "properties": {
690
+ "_links": {
691
+ "description": "The class to represent a collection of REST reference links.",
692
+ "type": "object",
693
+ "properties": {
694
+ "links": {
695
+ "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.",
696
+ "type": "object",
697
+ "additionalProperties": {
698
+ "type": "object"
699
+ }
700
+ }
701
+ }
702
+ },
703
+ "configuration": {
704
+ "description": "",
705
+ "type": "object",
706
+ "properties": {
707
+ "type": {
708
+ "enum": [
709
+ "unknown",
710
+ "yaml",
711
+ "designerJson",
712
+ "justInTime",
713
+ "designerHyphenJson"
714
+ ],
715
+ "x-ms-enum": {
716
+ "name": "ConfigurationType",
717
+ "values": [
718
+ {
719
+ "value": "unknown",
720
+ "description": "Unknown type."
721
+ },
722
+ {
723
+ "value": "yaml",
724
+ "description": "YAML."
725
+ },
726
+ {
727
+ "value": "designerJson",
728
+ "description": "Designer JSON."
729
+ },
730
+ {
731
+ "value": "justInTime",
732
+ "description": "Just-in-time."
733
+ },
734
+ {
735
+ "value": "designerHyphenJson",
736
+ "description": "Designer-JSON."
737
+ }
738
+ ]
739
+ }
740
+ }
741
+ }
742
+ },
743
+ "url": {
744
+ "description": "URL of the pipeline",
745
+ "type": "string"
746
+ }
747
+ }
748
+ }
749
+ }
750
+ },
751
+ "roles": [
752
+ "admin"
753
+ ],
754
+ "route": {
755
+ "verb": "POST",
756
+ "path": "/pipelinesList"
757
+ },
758
+ "task": true
759
+ },
760
+ {
761
+ "name": "pipelinesGet",
762
+ "summary": "Gets a pipeline, optionally at the specified version",
763
+ "description": "Gets a pipeline, optionally at the specified version",
764
+ "input": [
765
+ {
766
+ "name": "organization",
767
+ "type": "string",
768
+ "info": "The name of the Azure DevOps organization.: string",
769
+ "required": true,
770
+ "schema": {
771
+ "title": "organization",
772
+ "type": "string"
773
+ }
774
+ },
775
+ {
776
+ "name": "project",
777
+ "type": "string",
778
+ "info": "Project ID or project name: string",
779
+ "required": true,
780
+ "schema": {
781
+ "title": "project",
782
+ "type": "string"
783
+ }
784
+ },
785
+ {
786
+ "name": "pipelineId",
787
+ "type": "number",
788
+ "info": "The pipeline ID: 123",
789
+ "required": true,
790
+ "schema": {
791
+ "title": "pipelineId",
792
+ "type": "number"
793
+ }
794
+ },
795
+ {
796
+ "name": "pipelineVersion",
797
+ "type": "number",
798
+ "info": "The pipeline version: 123",
799
+ "required": false,
800
+ "schema": {
801
+ "title": "pipelineVersion",
802
+ "type": "number"
803
+ }
804
+ },
805
+ {
806
+ "name": "apiVersion",
807
+ "type": "string",
808
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
809
+ "required": true,
810
+ "schema": {
811
+ "title": "apiVersion",
812
+ "type": "string"
813
+ }
814
+ }
815
+ ],
816
+ "output": {
817
+ "name": "result",
818
+ "type": "object",
819
+ "description": "A JSON Object containing status, code and the result",
820
+ "schema": {
821
+ "description": "Definition of a pipeline.",
822
+ "type": "object",
823
+ "allOf": [
824
+ {
825
+ "description": "",
826
+ "type": "object",
827
+ "properties": {
828
+ "folder": {
829
+ "description": "Pipeline folder",
830
+ "type": "string"
831
+ },
832
+ "id": {
833
+ "description": "Pipeline ID",
834
+ "type": "integer"
835
+ },
836
+ "name": {
837
+ "description": "Pipeline name",
838
+ "type": "string"
839
+ },
840
+ "revision": {
841
+ "description": "Revision number",
842
+ "type": "integer"
843
+ }
844
+ }
845
+ }
846
+ ],
847
+ "properties": {
848
+ "_links": {
849
+ "description": "The class to represent a collection of REST reference links.",
850
+ "type": "object",
851
+ "properties": {
852
+ "links": {
853
+ "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.",
854
+ "type": "object",
855
+ "additionalProperties": {
856
+ "type": "object"
857
+ }
858
+ }
859
+ }
860
+ },
861
+ "configuration": {
862
+ "description": "",
863
+ "type": "object",
864
+ "properties": {
865
+ "type": {
866
+ "enum": [
867
+ "unknown",
868
+ "yaml",
869
+ "designerJson",
870
+ "justInTime",
871
+ "designerHyphenJson"
872
+ ],
873
+ "x-ms-enum": {
874
+ "name": "ConfigurationType",
875
+ "values": [
876
+ {
877
+ "value": "unknown",
878
+ "description": "Unknown type."
879
+ },
880
+ {
881
+ "value": "yaml",
882
+ "description": "YAML."
883
+ },
884
+ {
885
+ "value": "designerJson",
886
+ "description": "Designer JSON."
887
+ },
888
+ {
889
+ "value": "justInTime",
890
+ "description": "Just-in-time."
891
+ },
892
+ {
893
+ "value": "designerHyphenJson",
894
+ "description": "Designer-JSON."
895
+ }
896
+ ]
897
+ }
898
+ }
899
+ }
900
+ },
901
+ "url": {
902
+ "description": "URL of the pipeline",
903
+ "type": "string"
904
+ }
905
+ }
906
+ }
907
+ },
908
+ "roles": [
909
+ "admin"
910
+ ],
911
+ "route": {
912
+ "verb": "POST",
913
+ "path": "/pipelinesGet"
914
+ },
915
+ "task": true
916
+ },
917
+ {
918
+ "name": "previewPreview",
919
+ "summary": "Queues a dry run of the pipeline and returns an object containing the final yaml.",
920
+ "description": "Queues a dry run of the pipeline and returns an object containing the final yaml.",
921
+ "input": [
922
+ {
923
+ "name": "organization",
924
+ "type": "string",
925
+ "info": "The name of the Azure DevOps organization.: string",
926
+ "required": true,
927
+ "schema": {
928
+ "title": "organization",
929
+ "type": "string"
930
+ }
931
+ },
932
+ {
933
+ "name": "body",
934
+ "type": "object",
935
+ "info": "Optional additional parameters for this run.: {\"previewRun\": \"boolean\", \"resources\": \"undefined\", \"stagesToSkip\": \"array\", \"templateParameters\": \"object\", \"variables\": \"object\", \"yamlOverride\": \"string\"}",
936
+ "required": true,
937
+ "schema": {
938
+ "description": "Settings which influence pipeline runs.",
939
+ "type": "object",
940
+ "properties": {
941
+ "previewRun": {
942
+ "description": "If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.",
943
+ "type": "boolean"
944
+ },
945
+ "resources": {
946
+ "description": "The resources the run requires.",
947
+ "body": {
948
+ "description": "",
949
+ "type": "object",
950
+ "properties": {
951
+ "builds": {
952
+ "type": "object",
953
+ "additionalProperties": {
954
+ "description": "",
955
+ "type": "object",
956
+ "properties": {
957
+ "version": {
958
+ "type": "string"
959
+ }
960
+ }
961
+ }
962
+ },
963
+ "containers": {
964
+ "type": "object",
965
+ "additionalProperties": {
966
+ "description": "",
967
+ "type": "object",
968
+ "properties": {
969
+ "version": {
970
+ "type": "string"
971
+ }
972
+ }
973
+ }
974
+ },
975
+ "packages": {
976
+ "type": "object",
977
+ "additionalProperties": {
978
+ "description": "",
979
+ "type": "object",
980
+ "properties": {
981
+ "version": {
982
+ "type": "string"
983
+ }
984
+ }
985
+ }
986
+ },
987
+ "pipelines": {
988
+ "type": "object",
989
+ "additionalProperties": {
990
+ "description": "",
991
+ "type": "object",
992
+ "properties": {
993
+ "version": {
994
+ "type": "string"
995
+ }
996
+ }
997
+ }
998
+ },
999
+ "repositories": {
1000
+ "type": "object",
1001
+ "additionalProperties": {
1002
+ "description": "",
1003
+ "type": "object",
1004
+ "properties": {
1005
+ "refName": {
1006
+ "type": "string"
1007
+ },
1008
+ "token": {
1009
+ "description": "This is the security token to use when connecting to the repository.",
1010
+ "type": "string"
1011
+ },
1012
+ "tokenType": {
1013
+ "description": "Optional. This is the type of the token given. If not provided, a type of \"Bearer\" is assumed. Note: Use \"Basic\" for a PAT token.",
1014
+ "type": "string"
1015
+ },
1016
+ "version": {
1017
+ "type": "string"
1018
+ }
1019
+ }
1020
+ }
1021
+ }
1022
+ }
1023
+ }
1024
+ },
1025
+ "stagesToSkip": {
1026
+ "type": "array",
1027
+ "items": {
1028
+ "type": "string"
1029
+ }
1030
+ },
1031
+ "templateParameters": {
1032
+ "type": "object",
1033
+ "additionalProperties": {
1034
+ "type": "string"
1035
+ }
1036
+ },
1037
+ "variables": {
1038
+ "type": "object",
1039
+ "additionalProperties": {
1040
+ "description": "",
1041
+ "type": "object",
1042
+ "properties": {
1043
+ "isSecret": {
1044
+ "type": "boolean"
1045
+ },
1046
+ "value": {
1047
+ "type": "string"
1048
+ }
1049
+ }
1050
+ }
1051
+ },
1052
+ "yamlOverride": {
1053
+ "description": "If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.",
1054
+ "type": "string"
1055
+ }
1056
+ }
1057
+ }
1058
+ },
1059
+ {
1060
+ "name": "project",
1061
+ "type": "string",
1062
+ "info": "Project ID or project name: string",
1063
+ "required": true,
1064
+ "schema": {
1065
+ "title": "project",
1066
+ "type": "string"
1067
+ }
1068
+ },
1069
+ {
1070
+ "name": "pipelineId",
1071
+ "type": "number",
1072
+ "info": "The pipeline ID.: 123",
1073
+ "required": true,
1074
+ "schema": {
1075
+ "title": "pipelineId",
1076
+ "type": "number"
1077
+ }
1078
+ },
1079
+ {
1080
+ "name": "pipelineVersion",
1081
+ "type": "number",
1082
+ "info": "The pipeline version.: 123",
1083
+ "required": false,
1084
+ "schema": {
1085
+ "title": "pipelineVersion",
1086
+ "type": "number"
1087
+ }
1088
+ },
1089
+ {
1090
+ "name": "apiVersion",
1091
+ "type": "string",
1092
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
1093
+ "required": true,
1094
+ "schema": {
1095
+ "title": "apiVersion",
1096
+ "type": "string"
1097
+ }
1098
+ }
1099
+ ],
1100
+ "output": {
1101
+ "name": "result",
1102
+ "type": "object",
1103
+ "description": "A JSON Object containing status, code and the result",
1104
+ "schema": {
1105
+ "description": "",
1106
+ "type": "object",
1107
+ "properties": {
1108
+ "finalYaml": {
1109
+ "type": "string"
1110
+ }
1111
+ }
1112
+ }
1113
+ },
1114
+ "roles": [
1115
+ "admin"
1116
+ ],
1117
+ "route": {
1118
+ "verb": "POST",
1119
+ "path": "/previewPreview"
1120
+ },
1121
+ "task": true
1122
+ },
1123
+ {
1124
+ "name": "runsList",
1125
+ "summary": "Gets top 10000 runs for a particular pipeline.",
1126
+ "description": "Gets top 10000 runs for a particular pipeline.",
1127
+ "input": [
1128
+ {
1129
+ "name": "organization",
1130
+ "type": "string",
1131
+ "info": "The name of the Azure DevOps organization.: string",
1132
+ "required": true,
1133
+ "schema": {
1134
+ "title": "organization",
1135
+ "type": "string"
1136
+ }
1137
+ },
1138
+ {
1139
+ "name": "project",
1140
+ "type": "string",
1141
+ "info": "Project ID or project name: string",
1142
+ "required": true,
1143
+ "schema": {
1144
+ "title": "project",
1145
+ "type": "string"
1146
+ }
1147
+ },
1148
+ {
1149
+ "name": "pipelineId",
1150
+ "type": "number",
1151
+ "info": "The pipeline id: 123",
1152
+ "required": true,
1153
+ "schema": {
1154
+ "title": "pipelineId",
1155
+ "type": "number"
1156
+ }
1157
+ },
1158
+ {
1159
+ "name": "apiVersion",
1160
+ "type": "string",
1161
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
1162
+ "required": true,
1163
+ "schema": {
1164
+ "title": "apiVersion",
1165
+ "type": "string"
1166
+ }
1167
+ }
1168
+ ],
1169
+ "output": {
1170
+ "name": "result",
1171
+ "type": "object",
1172
+ "description": "A JSON Object containing status, code and the result",
1173
+ "schema": {
1174
+ "type": "array",
1175
+ "items": {
1176
+ "description": "",
1177
+ "type": "object",
1178
+ "allOf": [
1179
+ {
1180
+ "description": "",
1181
+ "type": "object",
1182
+ "properties": {
1183
+ "id": {
1184
+ "type": "integer"
1185
+ },
1186
+ "name": {
1187
+ "type": "string"
1188
+ }
1189
+ }
1190
+ }
1191
+ ],
1192
+ "properties": {
1193
+ "_links": {
1194
+ "description": "The class to represent a collection of REST reference links.",
1195
+ "type": "object",
1196
+ "properties": {
1197
+ "links": {
1198
+ "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.",
1199
+ "type": "object",
1200
+ "additionalProperties": {
1201
+ "type": "object"
1202
+ }
1203
+ }
1204
+ }
1205
+ },
1206
+ "createdDate": {
1207
+ "type": "string"
1208
+ },
1209
+ "finalYaml": {
1210
+ "type": "string"
1211
+ },
1212
+ "finishedDate": {
1213
+ "type": "string"
1214
+ },
1215
+ "pipeline": {
1216
+ "description": "A reference to a Pipeline.",
1217
+ "type": "object",
1218
+ "allOf": [
1219
+ {
1220
+ "description": "",
1221
+ "type": "object",
1222
+ "properties": {
1223
+ "folder": {
1224
+ "description": "Pipeline folder",
1225
+ "type": "string"
1226
+ },
1227
+ "id": {
1228
+ "description": "Pipeline ID",
1229
+ "type": "integer"
1230
+ },
1231
+ "name": {
1232
+ "description": "Pipeline name",
1233
+ "type": "string"
1234
+ },
1235
+ "revision": {
1236
+ "description": "Revision number",
1237
+ "type": "integer"
1238
+ }
1239
+ }
1240
+ }
1241
+ ],
1242
+ "properties": {
1243
+ "url": {
1244
+ "type": "string"
1245
+ }
1246
+ }
1247
+ },
1248
+ "resources": {
1249
+ "description": "",
1250
+ "type": "object",
1251
+ "properties": {
1252
+ "repositories": {
1253
+ "type": "object",
1254
+ "additionalProperties": {
1255
+ "description": "",
1256
+ "type": "object",
1257
+ "properties": {
1258
+ "refName": {
1259
+ "type": "string"
1260
+ },
1261
+ "repository": {
1262
+ "description": "",
1263
+ "type": "object",
1264
+ "properties": {
1265
+ "type": {
1266
+ "enum": [
1267
+ "unknown",
1268
+ "gitHub",
1269
+ "azureReposGit",
1270
+ "gitHubEnterprise",
1271
+ "azureReposGitHyphenated"
1272
+ ],
1273
+ "x-ms-enum": {
1274
+ "name": "RepositoryType",
1275
+ "values": [
1276
+ {
1277
+ "value": "unknown",
1278
+ "description": ""
1279
+ },
1280
+ {
1281
+ "value": "gitHub",
1282
+ "description": ""
1283
+ },
1284
+ {
1285
+ "value": "azureReposGit",
1286
+ "description": ""
1287
+ },
1288
+ {
1289
+ "value": "gitHubEnterprise",
1290
+ "description": ""
1291
+ },
1292
+ {
1293
+ "value": "azureReposGitHyphenated",
1294
+ "description": ""
1295
+ }
1296
+ ]
1297
+ }
1298
+ }
1299
+ }
1300
+ },
1301
+ "version": {
1302
+ "type": "string"
1303
+ }
1304
+ }
1305
+ }
1306
+ }
1307
+ }
1308
+ },
1309
+ "result": {
1310
+ "enum": [
1311
+ "unknown",
1312
+ "succeeded",
1313
+ "failed",
1314
+ "canceled"
1315
+ ],
1316
+ "x-ms-enum": {
1317
+ "name": "RunResult",
1318
+ "values": [
1319
+ {
1320
+ "value": "unknown",
1321
+ "description": ""
1322
+ },
1323
+ {
1324
+ "value": "succeeded",
1325
+ "description": ""
1326
+ },
1327
+ {
1328
+ "value": "failed",
1329
+ "description": ""
1330
+ },
1331
+ {
1332
+ "value": "canceled",
1333
+ "description": ""
1334
+ }
1335
+ ]
1336
+ }
1337
+ },
1338
+ "state": {
1339
+ "enum": [
1340
+ "unknown",
1341
+ "inProgress",
1342
+ "canceling",
1343
+ "completed"
1344
+ ],
1345
+ "x-ms-enum": {
1346
+ "name": "RunState",
1347
+ "values": [
1348
+ {
1349
+ "value": "unknown",
1350
+ "description": ""
1351
+ },
1352
+ {
1353
+ "value": "inProgress",
1354
+ "description": ""
1355
+ },
1356
+ {
1357
+ "value": "canceling",
1358
+ "description": ""
1359
+ },
1360
+ {
1361
+ "value": "completed",
1362
+ "description": ""
1363
+ }
1364
+ ]
1365
+ }
1366
+ },
1367
+ "url": {
1368
+ "type": "string"
1369
+ },
1370
+ "variables": {
1371
+ "type": "object",
1372
+ "additionalProperties": {
1373
+ "description": "",
1374
+ "type": "object",
1375
+ "properties": {
1376
+ "isSecret": {
1377
+ "type": "boolean"
1378
+ },
1379
+ "value": {
1380
+ "type": "string"
1381
+ }
1382
+ }
1383
+ }
1384
+ }
1385
+ }
1386
+ }
1387
+ }
1388
+ },
1389
+ "roles": [
1390
+ "admin"
1391
+ ],
1392
+ "route": {
1393
+ "verb": "POST",
1394
+ "path": "/runsList"
1395
+ },
1396
+ "task": true
1397
+ },
1398
+ {
1399
+ "name": "runsRunPipeline",
1400
+ "summary": "Runs a pipeline.",
1401
+ "description": "Runs a pipeline.",
1402
+ "input": [
1403
+ {
1404
+ "name": "organization",
1405
+ "type": "string",
1406
+ "info": "The name of the Azure DevOps organization.: string",
1407
+ "required": true,
1408
+ "schema": {
1409
+ "title": "organization",
1410
+ "type": "string"
1411
+ }
1412
+ },
1413
+ {
1414
+ "name": "body",
1415
+ "type": "object",
1416
+ "info": "Optional additional parameters for this run.: {\"previewRun\": \"boolean\", \"resources\": \"undefined\", \"stagesToSkip\": \"array\", \"templateParameters\": \"object\", \"variables\": \"object\", \"yamlOverride\": \"string\"}",
1417
+ "required": true,
1418
+ "schema": {
1419
+ "description": "Settings which influence pipeline runs.",
1420
+ "type": "object",
1421
+ "properties": {
1422
+ "previewRun": {
1423
+ "description": "If true, don't actually create a new run. Instead, return the final YAML document after parsing templates.",
1424
+ "type": "boolean"
1425
+ },
1426
+ "resources": {
1427
+ "description": "The resources the run requires.",
1428
+ "body": {
1429
+ "description": "",
1430
+ "type": "object",
1431
+ "properties": {
1432
+ "builds": {
1433
+ "type": "object",
1434
+ "additionalProperties": {
1435
+ "description": "",
1436
+ "type": "object",
1437
+ "properties": {
1438
+ "version": {
1439
+ "type": "string"
1440
+ }
1441
+ }
1442
+ }
1443
+ },
1444
+ "containers": {
1445
+ "type": "object",
1446
+ "additionalProperties": {
1447
+ "description": "",
1448
+ "type": "object",
1449
+ "properties": {
1450
+ "version": {
1451
+ "type": "string"
1452
+ }
1453
+ }
1454
+ }
1455
+ },
1456
+ "packages": {
1457
+ "type": "object",
1458
+ "additionalProperties": {
1459
+ "description": "",
1460
+ "type": "object",
1461
+ "properties": {
1462
+ "version": {
1463
+ "type": "string"
1464
+ }
1465
+ }
1466
+ }
1467
+ },
1468
+ "pipelines": {
1469
+ "type": "object",
1470
+ "additionalProperties": {
1471
+ "description": "",
1472
+ "type": "object",
1473
+ "properties": {
1474
+ "version": {
1475
+ "type": "string"
1476
+ }
1477
+ }
1478
+ }
1479
+ },
1480
+ "repositories": {
1481
+ "type": "object",
1482
+ "additionalProperties": {
1483
+ "description": "",
1484
+ "type": "object",
1485
+ "properties": {
1486
+ "refName": {
1487
+ "type": "string"
1488
+ },
1489
+ "token": {
1490
+ "description": "This is the security token to use when connecting to the repository.",
1491
+ "type": "string"
1492
+ },
1493
+ "tokenType": {
1494
+ "description": "Optional. This is the type of the token given. If not provided, a type of \"Bearer\" is assumed. Note: Use \"Basic\" for a PAT token.",
1495
+ "type": "string"
1496
+ },
1497
+ "version": {
1498
+ "type": "string"
1499
+ }
1500
+ }
1501
+ }
1502
+ }
1503
+ }
1504
+ }
1505
+ },
1506
+ "stagesToSkip": {
1507
+ "type": "array",
1508
+ "items": {
1509
+ "type": "string"
1510
+ }
1511
+ },
1512
+ "templateParameters": {
1513
+ "type": "object",
1514
+ "additionalProperties": {
1515
+ "type": "string"
1516
+ }
1517
+ },
1518
+ "variables": {
1519
+ "type": "object",
1520
+ "additionalProperties": {
1521
+ "description": "",
1522
+ "type": "object",
1523
+ "properties": {
1524
+ "isSecret": {
1525
+ "type": "boolean"
1526
+ },
1527
+ "value": {
1528
+ "type": "string"
1529
+ }
1530
+ }
1531
+ }
1532
+ },
1533
+ "yamlOverride": {
1534
+ "description": "If you use the preview run option, you may optionally supply different YAML. This allows you to preview the final YAML document without committing a changed file.",
1535
+ "type": "string"
1536
+ }
1537
+ }
1538
+ }
1539
+ },
1540
+ {
1541
+ "name": "project",
1542
+ "type": "string",
1543
+ "info": "Project ID or project name: string",
1544
+ "required": true,
1545
+ "schema": {
1546
+ "title": "project",
1547
+ "type": "string"
1548
+ }
1549
+ },
1550
+ {
1551
+ "name": "pipelineId",
1552
+ "type": "number",
1553
+ "info": "The pipeline ID.: 123",
1554
+ "required": true,
1555
+ "schema": {
1556
+ "title": "pipelineId",
1557
+ "type": "number"
1558
+ }
1559
+ },
1560
+ {
1561
+ "name": "pipelineVersion",
1562
+ "type": "number",
1563
+ "info": "The pipeline version.: 123",
1564
+ "required": false,
1565
+ "schema": {
1566
+ "title": "pipelineVersion",
1567
+ "type": "number"
1568
+ }
1569
+ },
1570
+ {
1571
+ "name": "apiVersion",
1572
+ "type": "string",
1573
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
1574
+ "required": true,
1575
+ "schema": {
1576
+ "title": "apiVersion",
1577
+ "type": "string"
1578
+ }
1579
+ }
1580
+ ],
1581
+ "output": {
1582
+ "name": "result",
1583
+ "type": "object",
1584
+ "description": "A JSON Object containing status, code and the result",
1585
+ "schema": {
1586
+ "description": "",
1587
+ "type": "object",
1588
+ "allOf": [
1589
+ {
1590
+ "description": "",
1591
+ "type": "object",
1592
+ "properties": {
1593
+ "id": {
1594
+ "type": "integer"
1595
+ },
1596
+ "name": {
1597
+ "type": "string"
1598
+ }
1599
+ }
1600
+ }
1601
+ ],
1602
+ "properties": {
1603
+ "_links": {
1604
+ "description": "The class to represent a collection of REST reference links.",
1605
+ "type": "object",
1606
+ "properties": {
1607
+ "links": {
1608
+ "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.",
1609
+ "type": "object",
1610
+ "additionalProperties": {
1611
+ "type": "object"
1612
+ }
1613
+ }
1614
+ }
1615
+ },
1616
+ "createdDate": {
1617
+ "type": "string"
1618
+ },
1619
+ "finalYaml": {
1620
+ "type": "string"
1621
+ },
1622
+ "finishedDate": {
1623
+ "type": "string"
1624
+ },
1625
+ "pipeline": {
1626
+ "description": "A reference to a Pipeline.",
1627
+ "type": "object",
1628
+ "allOf": [
1629
+ {
1630
+ "description": "",
1631
+ "type": "object",
1632
+ "properties": {
1633
+ "folder": {
1634
+ "description": "Pipeline folder",
1635
+ "type": "string"
1636
+ },
1637
+ "id": {
1638
+ "description": "Pipeline ID",
1639
+ "type": "integer"
1640
+ },
1641
+ "name": {
1642
+ "description": "Pipeline name",
1643
+ "type": "string"
1644
+ },
1645
+ "revision": {
1646
+ "description": "Revision number",
1647
+ "type": "integer"
1648
+ }
1649
+ }
1650
+ }
1651
+ ],
1652
+ "properties": {
1653
+ "url": {
1654
+ "type": "string"
1655
+ }
1656
+ }
1657
+ },
1658
+ "resources": {
1659
+ "description": "",
1660
+ "type": "object",
1661
+ "properties": {
1662
+ "repositories": {
1663
+ "type": "object",
1664
+ "additionalProperties": {
1665
+ "description": "",
1666
+ "type": "object",
1667
+ "properties": {
1668
+ "refName": {
1669
+ "type": "string"
1670
+ },
1671
+ "repository": {
1672
+ "description": "",
1673
+ "type": "object",
1674
+ "properties": {
1675
+ "type": {
1676
+ "enum": [
1677
+ "unknown",
1678
+ "gitHub",
1679
+ "azureReposGit",
1680
+ "gitHubEnterprise",
1681
+ "azureReposGitHyphenated"
1682
+ ],
1683
+ "x-ms-enum": {
1684
+ "name": "RepositoryType",
1685
+ "values": [
1686
+ {
1687
+ "value": "unknown",
1688
+ "description": ""
1689
+ },
1690
+ {
1691
+ "value": "gitHub",
1692
+ "description": ""
1693
+ },
1694
+ {
1695
+ "value": "azureReposGit",
1696
+ "description": ""
1697
+ },
1698
+ {
1699
+ "value": "gitHubEnterprise",
1700
+ "description": ""
1701
+ },
1702
+ {
1703
+ "value": "azureReposGitHyphenated",
1704
+ "description": ""
1705
+ }
1706
+ ]
1707
+ }
1708
+ }
1709
+ }
1710
+ },
1711
+ "version": {
1712
+ "type": "string"
1713
+ }
1714
+ }
1715
+ }
1716
+ }
1717
+ }
1718
+ },
1719
+ "result": {
1720
+ "enum": [
1721
+ "unknown",
1722
+ "succeeded",
1723
+ "failed",
1724
+ "canceled"
1725
+ ],
1726
+ "x-ms-enum": {
1727
+ "name": "RunResult",
1728
+ "values": [
1729
+ {
1730
+ "value": "unknown",
1731
+ "description": ""
1732
+ },
1733
+ {
1734
+ "value": "succeeded",
1735
+ "description": ""
1736
+ },
1737
+ {
1738
+ "value": "failed",
1739
+ "description": ""
1740
+ },
1741
+ {
1742
+ "value": "canceled",
1743
+ "description": ""
1744
+ }
1745
+ ]
1746
+ }
1747
+ },
1748
+ "state": {
1749
+ "enum": [
1750
+ "unknown",
1751
+ "inProgress",
1752
+ "canceling",
1753
+ "completed"
1754
+ ],
1755
+ "x-ms-enum": {
1756
+ "name": "RunState",
1757
+ "values": [
1758
+ {
1759
+ "value": "unknown",
1760
+ "description": ""
1761
+ },
1762
+ {
1763
+ "value": "inProgress",
1764
+ "description": ""
1765
+ },
1766
+ {
1767
+ "value": "canceling",
1768
+ "description": ""
1769
+ },
1770
+ {
1771
+ "value": "completed",
1772
+ "description": ""
1773
+ }
1774
+ ]
1775
+ }
1776
+ },
1777
+ "url": {
1778
+ "type": "string"
1779
+ },
1780
+ "variables": {
1781
+ "type": "object",
1782
+ "additionalProperties": {
1783
+ "description": "",
1784
+ "type": "object",
1785
+ "properties": {
1786
+ "isSecret": {
1787
+ "type": "boolean"
1788
+ },
1789
+ "value": {
1790
+ "type": "string"
1791
+ }
1792
+ }
1793
+ }
1794
+ }
1795
+ }
1796
+ }
1797
+ },
1798
+ "roles": [
1799
+ "admin"
1800
+ ],
1801
+ "route": {
1802
+ "verb": "POST",
1803
+ "path": "/runsRunPipeline"
1804
+ },
1805
+ "task": true
1806
+ },
1807
+ {
1808
+ "name": "runsGet",
1809
+ "summary": "Gets a run for a particular pipeline.",
1810
+ "description": "Gets a run for a particular pipeline.",
1811
+ "input": [
1812
+ {
1813
+ "name": "organization",
1814
+ "type": "string",
1815
+ "info": "The name of the Azure DevOps organization.: string",
1816
+ "required": true,
1817
+ "schema": {
1818
+ "title": "organization",
1819
+ "type": "string"
1820
+ }
1821
+ },
1822
+ {
1823
+ "name": "project",
1824
+ "type": "string",
1825
+ "info": "Project ID or project name: string",
1826
+ "required": true,
1827
+ "schema": {
1828
+ "title": "project",
1829
+ "type": "string"
1830
+ }
1831
+ },
1832
+ {
1833
+ "name": "pipelineId",
1834
+ "type": "number",
1835
+ "info": "The pipeline id: 123",
1836
+ "required": true,
1837
+ "schema": {
1838
+ "title": "pipelineId",
1839
+ "type": "number"
1840
+ }
1841
+ },
1842
+ {
1843
+ "name": "runId",
1844
+ "type": "number",
1845
+ "info": "The run id: 123",
1846
+ "required": true,
1847
+ "schema": {
1848
+ "title": "runId",
1849
+ "type": "number"
1850
+ }
1851
+ },
1852
+ {
1853
+ "name": "apiVersion",
1854
+ "type": "string",
1855
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
1856
+ "required": true,
1857
+ "schema": {
1858
+ "title": "apiVersion",
1859
+ "type": "string"
1860
+ }
1861
+ }
1862
+ ],
1863
+ "output": {
1864
+ "name": "result",
1865
+ "type": "object",
1866
+ "description": "A JSON Object containing status, code and the result",
1867
+ "schema": {
1868
+ "description": "",
1869
+ "type": "object",
1870
+ "allOf": [
1871
+ {
1872
+ "description": "",
1873
+ "type": "object",
1874
+ "properties": {
1875
+ "id": {
1876
+ "type": "integer"
1877
+ },
1878
+ "name": {
1879
+ "type": "string"
1880
+ }
1881
+ }
1882
+ }
1883
+ ],
1884
+ "properties": {
1885
+ "_links": {
1886
+ "description": "The class to represent a collection of REST reference links.",
1887
+ "type": "object",
1888
+ "properties": {
1889
+ "links": {
1890
+ "description": "The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.",
1891
+ "type": "object",
1892
+ "additionalProperties": {
1893
+ "type": "object"
1894
+ }
1895
+ }
1896
+ }
1897
+ },
1898
+ "createdDate": {
1899
+ "type": "string"
1900
+ },
1901
+ "finalYaml": {
1902
+ "type": "string"
1903
+ },
1904
+ "finishedDate": {
1905
+ "type": "string"
1906
+ },
1907
+ "pipeline": {
1908
+ "description": "A reference to a Pipeline.",
1909
+ "type": "object",
1910
+ "allOf": [
1911
+ {
1912
+ "description": "",
1913
+ "type": "object",
1914
+ "properties": {
1915
+ "folder": {
1916
+ "description": "Pipeline folder",
1917
+ "type": "string"
1918
+ },
1919
+ "id": {
1920
+ "description": "Pipeline ID",
1921
+ "type": "integer"
1922
+ },
1923
+ "name": {
1924
+ "description": "Pipeline name",
1925
+ "type": "string"
1926
+ },
1927
+ "revision": {
1928
+ "description": "Revision number",
1929
+ "type": "integer"
1930
+ }
1931
+ }
1932
+ }
1933
+ ],
1934
+ "properties": {
1935
+ "url": {
1936
+ "type": "string"
1937
+ }
1938
+ }
1939
+ },
1940
+ "resources": {
1941
+ "description": "",
1942
+ "type": "object",
1943
+ "properties": {
1944
+ "repositories": {
1945
+ "type": "object",
1946
+ "additionalProperties": {
1947
+ "description": "",
1948
+ "type": "object",
1949
+ "properties": {
1950
+ "refName": {
1951
+ "type": "string"
1952
+ },
1953
+ "repository": {
1954
+ "description": "",
1955
+ "type": "object",
1956
+ "properties": {
1957
+ "type": {
1958
+ "enum": [
1959
+ "unknown",
1960
+ "gitHub",
1961
+ "azureReposGit",
1962
+ "gitHubEnterprise",
1963
+ "azureReposGitHyphenated"
1964
+ ],
1965
+ "x-ms-enum": {
1966
+ "name": "RepositoryType",
1967
+ "values": [
1968
+ {
1969
+ "value": "unknown",
1970
+ "description": ""
1971
+ },
1972
+ {
1973
+ "value": "gitHub",
1974
+ "description": ""
1975
+ },
1976
+ {
1977
+ "value": "azureReposGit",
1978
+ "description": ""
1979
+ },
1980
+ {
1981
+ "value": "gitHubEnterprise",
1982
+ "description": ""
1983
+ },
1984
+ {
1985
+ "value": "azureReposGitHyphenated",
1986
+ "description": ""
1987
+ }
1988
+ ]
1989
+ }
1990
+ }
1991
+ }
1992
+ },
1993
+ "version": {
1994
+ "type": "string"
1995
+ }
1996
+ }
1997
+ }
1998
+ }
1999
+ }
2000
+ },
2001
+ "result": {
2002
+ "enum": [
2003
+ "unknown",
2004
+ "succeeded",
2005
+ "failed",
2006
+ "canceled"
2007
+ ],
2008
+ "x-ms-enum": {
2009
+ "name": "RunResult",
2010
+ "values": [
2011
+ {
2012
+ "value": "unknown",
2013
+ "description": ""
2014
+ },
2015
+ {
2016
+ "value": "succeeded",
2017
+ "description": ""
2018
+ },
2019
+ {
2020
+ "value": "failed",
2021
+ "description": ""
2022
+ },
2023
+ {
2024
+ "value": "canceled",
2025
+ "description": ""
2026
+ }
2027
+ ]
2028
+ }
2029
+ },
2030
+ "state": {
2031
+ "enum": [
2032
+ "unknown",
2033
+ "inProgress",
2034
+ "canceling",
2035
+ "completed"
2036
+ ],
2037
+ "x-ms-enum": {
2038
+ "name": "RunState",
2039
+ "values": [
2040
+ {
2041
+ "value": "unknown",
2042
+ "description": ""
2043
+ },
2044
+ {
2045
+ "value": "inProgress",
2046
+ "description": ""
2047
+ },
2048
+ {
2049
+ "value": "canceling",
2050
+ "description": ""
2051
+ },
2052
+ {
2053
+ "value": "completed",
2054
+ "description": ""
2055
+ }
2056
+ ]
2057
+ }
2058
+ },
2059
+ "url": {
2060
+ "type": "string"
2061
+ },
2062
+ "variables": {
2063
+ "type": "object",
2064
+ "additionalProperties": {
2065
+ "description": "",
2066
+ "type": "object",
2067
+ "properties": {
2068
+ "isSecret": {
2069
+ "type": "boolean"
2070
+ },
2071
+ "value": {
2072
+ "type": "string"
2073
+ }
2074
+ }
2075
+ }
2076
+ }
2077
+ }
2078
+ }
2079
+ },
2080
+ "roles": [
2081
+ "admin"
2082
+ ],
2083
+ "route": {
2084
+ "verb": "POST",
2085
+ "path": "/runsGet"
2086
+ },
2087
+ "task": true
2088
+ },
2089
+ {
2090
+ "name": "artifactsGet",
2091
+ "summary": "Get a specific artifact from a pipeline run",
2092
+ "description": "Get a specific artifact from a pipeline run",
2093
+ "input": [
2094
+ {
2095
+ "name": "organization",
2096
+ "type": "string",
2097
+ "info": "The name of the Azure DevOps organization.: string",
2098
+ "required": true,
2099
+ "schema": {
2100
+ "title": "organization",
2101
+ "type": "string"
2102
+ }
2103
+ },
2104
+ {
2105
+ "name": "project",
2106
+ "type": "string",
2107
+ "info": "Project ID or project name: string",
2108
+ "required": true,
2109
+ "schema": {
2110
+ "title": "project",
2111
+ "type": "string"
2112
+ }
2113
+ },
2114
+ {
2115
+ "name": "pipelineId",
2116
+ "type": "number",
2117
+ "info": "ID of the pipeline.: 123",
2118
+ "required": true,
2119
+ "schema": {
2120
+ "title": "pipelineId",
2121
+ "type": "number"
2122
+ }
2123
+ },
2124
+ {
2125
+ "name": "runId",
2126
+ "type": "number",
2127
+ "info": "ID of the run of that pipeline.: 123",
2128
+ "required": true,
2129
+ "schema": {
2130
+ "title": "runId",
2131
+ "type": "number"
2132
+ }
2133
+ },
2134
+ {
2135
+ "name": "artifactName",
2136
+ "type": "string",
2137
+ "info": "Name of the artifact.: string",
2138
+ "required": true,
2139
+ "schema": {
2140
+ "title": "artifactName",
2141
+ "type": "string"
2142
+ }
2143
+ },
2144
+ {
2145
+ "name": "expand",
2146
+ "type": "string",
2147
+ "info": "Expand options. Default is None.: Must be one of [none, signedContent]",
2148
+ "required": false,
2149
+ "schema": {
2150
+ "title": "expand",
2151
+ "type": "string"
2152
+ }
2153
+ },
2154
+ {
2155
+ "name": "apiVersion",
2156
+ "type": "string",
2157
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
2158
+ "required": true,
2159
+ "schema": {
2160
+ "title": "apiVersion",
2161
+ "type": "string"
2162
+ }
2163
+ }
2164
+ ],
2165
+ "output": {
2166
+ "name": "result",
2167
+ "type": "object",
2168
+ "description": "A JSON Object containing status, code and the result",
2169
+ "schema": {
2170
+ "description": "Artifacts are collections of files produced by a pipeline. Use artifacts to share files between stages in a pipeline or between different pipelines.",
2171
+ "type": "object",
2172
+ "properties": {
2173
+ "name": {
2174
+ "description": "The name of the artifact.",
2175
+ "type": "string"
2176
+ },
2177
+ "signedContent": {
2178
+ "description": "Signed url for downloading this artifact",
2179
+ "body": {
2180
+ "description": "A signed url allowing limited-time anonymous access to private resources.",
2181
+ "type": "object",
2182
+ "properties": {
2183
+ "signatureExpires": {
2184
+ "description": "Timestamp when access expires.",
2185
+ "type": "string"
2186
+ },
2187
+ "url": {
2188
+ "description": "The URL to allow access to.",
2189
+ "type": "string"
2190
+ }
2191
+ }
2192
+ }
2193
+ },
2194
+ "url": {
2195
+ "description": "Self-referential url",
2196
+ "type": "string"
2197
+ }
2198
+ }
2199
+ }
2200
+ },
2201
+ "roles": [
2202
+ "admin"
2203
+ ],
2204
+ "route": {
2205
+ "verb": "POST",
2206
+ "path": "/artifactsGet"
2207
+ },
2208
+ "task": true
2209
+ },
2210
+ {
2211
+ "name": "logsList",
2212
+ "summary": "Get a list of logs from a pipeline run.",
2213
+ "description": "Get a list of logs from a pipeline run.",
2214
+ "input": [
2215
+ {
2216
+ "name": "organization",
2217
+ "type": "string",
2218
+ "info": "The name of the Azure DevOps organization.: string",
2219
+ "required": true,
2220
+ "schema": {
2221
+ "title": "organization",
2222
+ "type": "string"
2223
+ }
2224
+ },
2225
+ {
2226
+ "name": "project",
2227
+ "type": "string",
2228
+ "info": "Project ID or project name: string",
2229
+ "required": true,
2230
+ "schema": {
2231
+ "title": "project",
2232
+ "type": "string"
2233
+ }
2234
+ },
2235
+ {
2236
+ "name": "pipelineId",
2237
+ "type": "number",
2238
+ "info": "ID of the pipeline.: 123",
2239
+ "required": true,
2240
+ "schema": {
2241
+ "title": "pipelineId",
2242
+ "type": "number"
2243
+ }
2244
+ },
2245
+ {
2246
+ "name": "runId",
2247
+ "type": "number",
2248
+ "info": "ID of the run of that pipeline.: 123",
2249
+ "required": true,
2250
+ "schema": {
2251
+ "title": "runId",
2252
+ "type": "number"
2253
+ }
2254
+ },
2255
+ {
2256
+ "name": "expand",
2257
+ "type": "string",
2258
+ "info": "Expand options. Default is None.: Must be one of [none, signedContent]",
2259
+ "required": false,
2260
+ "schema": {
2261
+ "title": "expand",
2262
+ "type": "string"
2263
+ }
2264
+ },
2265
+ {
2266
+ "name": "apiVersion",
2267
+ "type": "string",
2268
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
2269
+ "required": true,
2270
+ "schema": {
2271
+ "title": "apiVersion",
2272
+ "type": "string"
2273
+ }
2274
+ }
2275
+ ],
2276
+ "output": {
2277
+ "name": "result",
2278
+ "type": "object",
2279
+ "description": "A JSON Object containing status, code and the result",
2280
+ "schema": {
2281
+ "description": "A collection of logs.",
2282
+ "type": "object",
2283
+ "properties": {
2284
+ "logs": {
2285
+ "description": "The list of logs.",
2286
+ "type": "array",
2287
+ "items": {
2288
+ "description": "Log for a pipeline.",
2289
+ "type": "object",
2290
+ "properties": {
2291
+ "createdOn": {
2292
+ "description": "The date and time the log was created.",
2293
+ "type": "string"
2294
+ },
2295
+ "id": {
2296
+ "description": "The ID of the log.",
2297
+ "type": "integer"
2298
+ },
2299
+ "lastChangedOn": {
2300
+ "description": "The date and time the log was last changed.",
2301
+ "type": "string"
2302
+ },
2303
+ "lineCount": {
2304
+ "description": "The number of lines in the log.",
2305
+ "type": "integer"
2306
+ },
2307
+ "signedContent": {
2308
+ "description": "A signed url allowing limited-time anonymous access to private resources.",
2309
+ "type": "object",
2310
+ "properties": {
2311
+ "signatureExpires": {
2312
+ "description": "Timestamp when access expires.",
2313
+ "type": "string"
2314
+ },
2315
+ "url": {
2316
+ "description": "The URL to allow access to.",
2317
+ "type": "string"
2318
+ }
2319
+ }
2320
+ },
2321
+ "url": {
2322
+ "type": "string"
2323
+ }
2324
+ }
2325
+ }
2326
+ },
2327
+ "signedContent": {
2328
+ "description": "A signed url allowing limited-time anonymous access to private resources.",
2329
+ "type": "object",
2330
+ "properties": {
2331
+ "signatureExpires": {
2332
+ "description": "Timestamp when access expires.",
2333
+ "type": "string"
2334
+ },
2335
+ "url": {
2336
+ "description": "The URL to allow access to.",
2337
+ "type": "string"
2338
+ }
2339
+ }
2340
+ },
2341
+ "url": {
2342
+ "description": "URL of the log.",
2343
+ "type": "string"
2344
+ }
2345
+ }
2346
+ }
2347
+ },
2348
+ "roles": [
2349
+ "admin"
2350
+ ],
2351
+ "route": {
2352
+ "verb": "POST",
2353
+ "path": "/logsList"
2354
+ },
2355
+ "task": true
2356
+ },
2357
+ {
2358
+ "name": "logsGet",
2359
+ "summary": "Get a specific log from a pipeline run",
2360
+ "description": "Get a specific log from a pipeline run",
2361
+ "input": [
2362
+ {
2363
+ "name": "organization",
2364
+ "type": "string",
2365
+ "info": "The name of the Azure DevOps organization.: string",
2366
+ "required": true,
2367
+ "schema": {
2368
+ "title": "organization",
2369
+ "type": "string"
2370
+ }
2371
+ },
2372
+ {
2373
+ "name": "project",
2374
+ "type": "string",
2375
+ "info": "Project ID or project name: string",
2376
+ "required": true,
2377
+ "schema": {
2378
+ "title": "project",
2379
+ "type": "string"
2380
+ }
2381
+ },
2382
+ {
2383
+ "name": "pipelineId",
2384
+ "type": "number",
2385
+ "info": "ID of the pipeline.: 123",
2386
+ "required": true,
2387
+ "schema": {
2388
+ "title": "pipelineId",
2389
+ "type": "number"
2390
+ }
2391
+ },
2392
+ {
2393
+ "name": "runId",
2394
+ "type": "number",
2395
+ "info": "ID of the run of that pipeline.: 123",
2396
+ "required": true,
2397
+ "schema": {
2398
+ "title": "runId",
2399
+ "type": "number"
2400
+ }
2401
+ },
2402
+ {
2403
+ "name": "logId",
2404
+ "type": "number",
2405
+ "info": "ID of the log.: 123",
2406
+ "required": true,
2407
+ "schema": {
2408
+ "title": "logId",
2409
+ "type": "number"
2410
+ }
2411
+ },
2412
+ {
2413
+ "name": "expand",
2414
+ "type": "string",
2415
+ "info": "Expand options. Default is None.: Must be one of [none, signedContent]",
2416
+ "required": false,
2417
+ "schema": {
2418
+ "title": "expand",
2419
+ "type": "string"
2420
+ }
2421
+ },
2422
+ {
2423
+ "name": "apiVersion",
2424
+ "type": "string",
2425
+ "info": "Version of the API to use. This should be set to '6.1-preview.1' to use this version of the api.: string",
2426
+ "required": true,
2427
+ "schema": {
2428
+ "title": "apiVersion",
2429
+ "type": "string"
2430
+ }
2431
+ }
2432
+ ],
2433
+ "output": {
2434
+ "name": "result",
2435
+ "type": "object",
2436
+ "description": "A JSON Object containing status, code and the result",
2437
+ "schema": {
2438
+ "description": "Log for a pipeline.",
2439
+ "type": "object",
2440
+ "properties": {
2441
+ "createdOn": {
2442
+ "description": "The date and time the log was created.",
2443
+ "type": "string"
2444
+ },
2445
+ "id": {
2446
+ "description": "The ID of the log.",
2447
+ "type": "integer"
2448
+ },
2449
+ "lastChangedOn": {
2450
+ "description": "The date and time the log was last changed.",
2451
+ "type": "string"
2452
+ },
2453
+ "lineCount": {
2454
+ "description": "The number of lines in the log.",
2455
+ "type": "integer"
2456
+ },
2457
+ "signedContent": {
2458
+ "description": "A signed url allowing limited-time anonymous access to private resources.",
2459
+ "type": "object",
2460
+ "properties": {
2461
+ "signatureExpires": {
2462
+ "description": "Timestamp when access expires.",
2463
+ "type": "string"
2464
+ },
2465
+ "url": {
2466
+ "description": "The URL to allow access to.",
2467
+ "type": "string"
2468
+ }
2469
+ }
2470
+ },
2471
+ "url": {
2472
+ "type": "string"
2473
+ }
2474
+ }
2475
+ }
2476
+ },
2477
+ "roles": [
2478
+ "admin"
2479
+ ],
2480
+ "route": {
2481
+ "verb": "POST",
2482
+ "path": "/logsGet"
2483
+ },
2484
+ "task": true
2485
+ }
2486
+ ],
2487
+ "views": []
2488
+ }