-
Notifications
You must be signed in to change notification settings - Fork 10
/
GitRestClient.yml
4922 lines (4922 loc) · 185 KB
/
GitRestClient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: GitRestClient
uid: azure-devops-extension-api.GitRestClient
package: azure-devops-extension-api
summary: >-
Base class that should be used (derived from) to make requests to VSS REST
apis
fullName: GitRestClient
remarks: ''
isDeprecated: false
type: class
constructors:
- name: GitRestClient(IVssRestClientOptions)
uid: azure-devops-extension-api.GitRestClient.constructor
package: azure-devops-extension-api
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: 'new GitRestClient(options: IVssRestClientOptions)'
parameters:
- id: options
type: <xref uid="azure-devops-extension-api.IVssRestClientOptions" />
description: ''
properties:
- name: RESOURCE_AREA_ID
uid: azure-devops-extension-api.GitRestClient.RESOURCE_AREA_ID
package: azure-devops-extension-api
summary: ''
fullName: RESOURCE_AREA_ID
remarks: ''
isDeprecated: false
syntax:
content: 'static RESOURCE_AREA_ID: string'
return:
description: ''
type: string
methods:
- name: createAnnotatedTag(GitAnnotatedTag, string, string)
uid: azure-devops-extension-api.GitRestClient.createAnnotatedTag
package: azure-devops-extension-api
summary: Create an annotated tag.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createAnnotatedTag(tagObject: GitAnnotatedTag, project: string,
repositoryId: string): Promise<GitAnnotatedTag>
parameters:
- id: tagObject
type: <xref uid="azure-devops-extension-api.GitAnnotatedTag" />
description: Object containing details of tag to be created.
- id: project
type: string
description: Project ID or project name
- id: repositoryId
type: string
description: ID or name of the repository.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitAnnotatedTag"
/>>
- name: createAttachment(any, string, string, number, string)
uid: azure-devops-extension-api.GitRestClient.createAttachment
package: azure-devops-extension-api
summary: Attach a new file to a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createAttachment(content: any, fileName: string, repositoryId:
string, pullRequestId: number, project?: string): Promise<Attachment>
parameters:
- id: content
type: any
description: Content to upload
- id: fileName
type: string
description: The name of the file.
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.Attachment" />>
- name: createCherryPick(GitAsyncRefOperationParameters, string, string)
uid: azure-devops-extension-api.GitRestClient.createCherryPick
package: azure-devops-extension-api
summary: >-
Cherry pick a specific commit or commits that are associated to a pull
request into a new branch.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createCherryPick(cherryPickToCreate:
GitAsyncRefOperationParameters, project: string, repositoryId: string):
Promise<GitCherryPick>
parameters:
- id: cherryPickToCreate
type: >-
<xref
uid="azure-devops-extension-api.GitAsyncRefOperationParameters" />
description: ''
- id: project
type: string
description: Project ID or project name
- id: repositoryId
type: string
description: ID of the repository.
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.GitCherryPick" />>
- name: createComment(Comment, string, number, number, string)
uid: azure-devops-extension-api.GitRestClient.createComment
package: azure-devops-extension-api
summary: >-
Create a comment on a specific thread in a pull request (up to 500
comments can be created per thread).
remarks: ''
isDeprecated: false
syntax:
content: >-
function createComment(comment: Comment, repositoryId: string,
pullRequestId: number, threadId: number, project?: string):
Promise<Comment>
parameters:
- id: comment
type: <xref uid="azure-devops-extension-api.Comment" />
description: The comment to create. Comments can be up to 150,000 characters.
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: threadId
type: number
description: ID of the thread that the desired comment is in.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.Comment" />>
- name: createCommitStatus(GitStatus, string, string, string)
uid: azure-devops-extension-api.GitRestClient.createCommitStatus
package: azure-devops-extension-api
summary: Create Git commit status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createCommitStatus(gitCommitStatusToCreate: GitStatus,
commitId: string, repositoryId: string, project?: string):
Promise<GitStatus>
parameters:
- id: gitCommitStatusToCreate
type: <xref uid="azure-devops-extension-api.GitStatus" />
description: Git commit status object to create.
- id: commitId
type: string
description: ID of the Git commit.
- id: repositoryId
type: string
description: ID of the repository.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.GitStatus" />>
- name: createFavorite(GitRefFavorite, string)
uid: azure-devops-extension-api.GitRestClient.createFavorite
package: azure-devops-extension-api
summary: Creates a ref favorite
remarks: ''
isDeprecated: false
syntax:
content: >-
function createFavorite(favorite: GitRefFavorite, project: string):
Promise<GitRefFavorite>
parameters:
- id: favorite
type: <xref uid="azure-devops-extension-api.GitRefFavorite" />
description: The ref favorite to create.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitRefFavorite"
/>>
- name: >-
createForkSyncRequest(GitForkSyncRequestParameters, string, string,
boolean)
uid: azure-devops-extension-api.GitRestClient.createForkSyncRequest
package: azure-devops-extension-api
summary: >-
Request that another repository's refs be fetched into this one. It syncs
two existing forks. To create a fork, please see the \<a
href="https://docs.microsoft.com/en-us/rest/api/vsts/git/repositories/create?view=azure-devops-rest-5.1"\>
repositories endpoint\</a\>
remarks: ''
isDeprecated: false
syntax:
content: >-
function createForkSyncRequest(syncParams: GitForkSyncRequestParameters,
repositoryNameOrId: string, project?: string, includeLinks?: boolean):
Promise<GitForkSyncRequest>
parameters:
- id: syncParams
type: >-
<xref uid="azure-devops-extension-api.GitForkSyncRequestParameters"
/>
description: Source repository and ref mapping.
- id: repositoryNameOrId
type: string
description: The name or ID of the repository.
- id: project
type: string
description: Project ID or project name
- id: includeLinks
type: boolean
description: True to include links
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitForkSyncRequest"
/>>
- name: createImportRequest(GitImportRequest, string, string)
uid: azure-devops-extension-api.GitRestClient.createImportRequest
package: azure-devops-extension-api
summary: Create an import request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createImportRequest(importRequest: GitImportRequest, project:
string, repositoryId: string): Promise<GitImportRequest>
parameters:
- id: importRequest
type: <xref uid="azure-devops-extension-api.GitImportRequest" />
description: The import request to create.
- id: project
type: string
description: Project ID or project name
- id: repositoryId
type: string
description: The name or ID of the repository.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitImportRequest"
/>>
- name: createLike(string, number, number, number, string)
uid: azure-devops-extension-api.GitRestClient.createLike
package: azure-devops-extension-api
summary: Add a like on a comment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createLike(repositoryId: string, pullRequestId: number,
threadId: number, commentId: number, project?: string): Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: threadId
type: number
description: The ID of the thread that contains the comment.
- id: commentId
type: number
description: The ID of the comment.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: createMergeRequest(GitMergeParameters, string, string, boolean)
uid: azure-devops-extension-api.GitRestClient.createMergeRequest
package: azure-devops-extension-api
summary: >-
Request a git merge operation. Currently we support merging only 2
commits.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createMergeRequest(mergeParameters: GitMergeParameters,
project: string, repositoryNameOrId: string, includeLinks?: boolean):
Promise<GitMerge>
parameters:
- id: mergeParameters
type: <xref uid="azure-devops-extension-api.GitMergeParameters" />
description: Parents commitIds and merge commit messsage.
- id: project
type: string
description: Project ID or project name
- id: repositoryNameOrId
type: string
description: The name or ID of the repository.
- id: includeLinks
type: boolean
description: True to include links
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.GitMerge" />>
- name: createPullRequest(GitPullRequest, string, string, boolean)
uid: azure-devops-extension-api.GitRestClient.createPullRequest
package: azure-devops-extension-api
summary: Create a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPullRequest(gitPullRequestToCreate: GitPullRequest,
repositoryId: string, project?: string, supportsIterations?: boolean):
Promise<GitPullRequest>
parameters:
- id: gitPullRequestToCreate
type: <xref uid="azure-devops-extension-api.GitPullRequest" />
description: The pull request to create.
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: project
type: string
description: Project ID or project name
- id: supportsIterations
type: boolean
description: >-
If true, subsequent pushes to the pull request will be individually
reviewable. Set this to false for large pull requests for
performance reasons if this functionality is not needed.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitPullRequest"
/>>
- name: >-
createPullRequestIterationStatus(GitPullRequestStatus, string, number,
number, string)
uid: azure-devops-extension-api.GitRestClient.createPullRequestIterationStatus
package: azure-devops-extension-api
summary: >-
Create a pull request status on the iteration. This operation will have
the same result as Create status on pull request with specified iteration
ID in the request body.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPullRequestIterationStatus(status: GitPullRequestStatus,
repositoryId: string, pullRequestId: number, iterationId: number,
project?: string): Promise<GitPullRequestStatus>
parameters:
- id: status
type: <xref uid="azure-devops-extension-api.GitPullRequestStatus" />
description: Pull request status to create.
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: iterationId
type: number
description: ID of the pull request iteration.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitPullRequestStatus"
/>>
- name: >-
createPullRequestLabel(WebApiCreateTagRequestData, string, number, string,
string)
uid: azure-devops-extension-api.GitRestClient.createPullRequestLabel
package: azure-devops-extension-api
summary: >-
Create a tag (if that does not exists yet) and add that as a label (tag)
for a specified pull request. The only required field is the name of the
new label (tag).
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPullRequestLabel(label: WebApiCreateTagRequestData,
repositoryId: string, pullRequestId: number, project?: string,
projectId?: string): Promise<WebApiTagDefinition>
parameters:
- id: label
type: <xref uid="azure-devops-extension-api.WebApiCreateTagRequestData" />
description: Label to assign to the pull request.
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
- id: projectId
type: string
description: Project ID or project name.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.WebApiTagDefinition"
/>>
- name: >-
createPullRequestReviewer(IdentityRefWithVote, string, number, string,
string)
uid: azure-devops-extension-api.GitRestClient.createPullRequestReviewer
package: azure-devops-extension-api
summary: Add a reviewer to a pull request or cast a vote.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPullRequestReviewer(reviewer: IdentityRefWithVote,
repositoryId: string, pullRequestId: number, reviewerId: string,
project?: string): Promise<IdentityRefWithVote>
parameters:
- id: reviewer
type: <xref uid="azure-devops-extension-api.IdentityRefWithVote" />
description: >-
Reviewer's vote.\<br /\>If the reviewer's ID is included here, it
must match the reviewerID parameter.\<br /\>Reviewers can set their
own vote with this method. When adding other reviewers, vote must
be set to zero.
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: reviewerId
type: string
description: ID of the reviewer.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.IdentityRefWithVote"
/>>
- name: createPullRequestReviewers(IdentityRef[], string, number, string)
uid: azure-devops-extension-api.GitRestClient.createPullRequestReviewers
package: azure-devops-extension-api
summary: Add reviewers to a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPullRequestReviewers(reviewers: IdentityRef[],
repositoryId: string, pullRequestId: number, project?: string):
Promise<IdentityRefWithVote[]>
parameters:
- id: reviewers
type: <xref uid="azure-devops-extension-api.IdentityRef" />[]
description: Reviewers to add to the pull request.
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.IdentityRefWithVote"
/>[]>
- name: createPullRequestStatus(GitPullRequestStatus, string, number, string)
uid: azure-devops-extension-api.GitRestClient.createPullRequestStatus
package: azure-devops-extension-api
summary: Create a pull request status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPullRequestStatus(status: GitPullRequestStatus,
repositoryId: string, pullRequestId: number, project?: string):
Promise<GitPullRequestStatus>
parameters:
- id: status
type: <xref uid="azure-devops-extension-api.GitPullRequestStatus" />
description: Pull request status to create.
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitPullRequestStatus"
/>>
- name: createPush(GitPush, string, string)
uid: azure-devops-extension-api.GitRestClient.createPush
package: azure-devops-extension-api
summary: Push changes to the repository.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createPush(push: GitPush, repositoryId: string, project?:
string): Promise<GitPush>
parameters:
- id: push
type: <xref uid="azure-devops-extension-api.GitPush" />
description: ''
- id: repositoryId
type: string
description: The name or ID of the repository.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.GitPush" />>
- name: createRepository(GitRepositoryCreateOptions, string, string)
uid: azure-devops-extension-api.GitRestClient.createRepository
package: azure-devops-extension-api
summary: Create a git repository in a team project.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createRepository(gitRepositoryToCreate:
GitRepositoryCreateOptions, project?: string, sourceRef?: string):
Promise<GitRepository>
parameters:
- id: gitRepositoryToCreate
type: <xref uid="azure-devops-extension-api.GitRepositoryCreateOptions" />
description: >-
Specify the repo name, team project and/or parent repository. Team
project information can be omitted from gitRepositoryToCreate if the
request is project-scoped (i.e., includes project Id).
- id: project
type: string
description: Project ID or project name
- id: sourceRef
type: string
description: '[optional] Specify the source refs to use while creating a fork repo'
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.GitRepository" />>
- name: createRevert(GitAsyncRefOperationParameters, string, string)
uid: azure-devops-extension-api.GitRestClient.createRevert
package: azure-devops-extension-api
summary: >-
Starts the operation to create a new branch which reverts changes
introduced by either a specific commit or commits that are associated to a
pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createRevert(revertToCreate: GitAsyncRefOperationParameters,
project: string, repositoryId: string): Promise<GitRevert>
parameters:
- id: revertToCreate
type: >-
<xref
uid="azure-devops-extension-api.GitAsyncRefOperationParameters" />
description: ''
- id: project
type: string
description: Project ID or project name
- id: repositoryId
type: string
description: ID of the repository.
return:
description: ''
type: Promise<<xref uid="azure-devops-extension-api.GitRevert" />>
- name: createThread(GitPullRequestCommentThread, string, number, string)
uid: azure-devops-extension-api.GitRestClient.createThread
package: azure-devops-extension-api
summary: Create a thread in a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createThread(commentThread: GitPullRequestCommentThread,
repositoryId: string, pullRequestId: number, project?: string):
Promise<GitPullRequestCommentThread>
parameters:
- id: commentThread
type: >-
<xref uid="azure-devops-extension-api.GitPullRequestCommentThread"
/>
description: The thread to create. Thread must contain at least one comment.
- id: repositoryId
type: string
description: Repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref
uid="azure-devops-extension-api.GitPullRequestCommentThread" />>
- name: >-
createUnmaterializedPullRequestReviewer(IdentityRefWithVote, string,
number, string)
uid: >-
azure-devops-extension-api.GitRestClient.createUnmaterializedPullRequestReviewer
package: azure-devops-extension-api
summary: Add an unmaterialized identity to the reviewers of a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function createUnmaterializedPullRequestReviewer(reviewer:
IdentityRefWithVote, repositoryId: string, pullRequestId: number,
project?: string): Promise<IdentityRefWithVote>
parameters:
- id: reviewer
type: <xref uid="azure-devops-extension-api.IdentityRefWithVote" />
description: Reviewer to add to the pull request.
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.IdentityRefWithVote"
/>>
- name: deleteAttachment(string, string, number, string)
uid: azure-devops-extension-api.GitRestClient.deleteAttachment
package: azure-devops-extension-api
summary: Delete a pull request attachment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteAttachment(fileName: string, repositoryId: string,
pullRequestId: number, project?: string): Promise<void>
parameters:
- id: fileName
type: string
description: The name of the attachment to delete.
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deleteComment(string, number, number, number, string)
uid: azure-devops-extension-api.GitRestClient.deleteComment
package: azure-devops-extension-api
summary: Delete a comment associated with a specific thread in a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteComment(repositoryId: string, pullRequestId: number,
threadId: number, commentId: number, project?: string): Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: threadId
type: number
description: ID of the thread that the desired comment is in.
- id: commentId
type: number
description: ID of the comment.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deleteEnablementStatus(boolean, boolean, string[])
uid: azure-devops-extension-api.GitRestClient.deleteEnablementStatus
package: azure-devops-extension-api
summary: >-
DELETE Deletes Enablement status and BillableCommitters data from DB.
Deleting the enablement data will effectively disable it for the
repositories affected.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteEnablementStatus(allProjects: boolean,
includeBillableCommitters?: boolean, projectIds?: string[]):
Promise<void>
parameters:
- id: allProjects
type: boolean
description: ''
- id: includeBillableCommitters
type: boolean
description: ''
- id: projectIds
type: string[]
description: ''
return:
description: ''
type: Promise<void>
- name: deleteLike(string, number, number, number, string)
uid: azure-devops-extension-api.GitRestClient.deleteLike
package: azure-devops-extension-api
summary: Delete a like on a comment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteLike(repositoryId: string, pullRequestId: number,
threadId: number, commentId: number, project?: string): Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: threadId
type: number
description: The ID of the thread that contains the comment.
- id: commentId
type: number
description: The ID of the comment.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deletePullRequestIterationStatus(string, number, number, number, string)
uid: azure-devops-extension-api.GitRestClient.deletePullRequestIterationStatus
package: azure-devops-extension-api
summary: Delete pull request iteration status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deletePullRequestIterationStatus(repositoryId: string,
pullRequestId: number, iterationId: number, statusId: number, project?:
string): Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: iterationId
type: number
description: ID of the pull request iteration.
- id: statusId
type: number
description: ID of the pull request status.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deletePullRequestLabels(string, number, string, string, string)
uid: azure-devops-extension-api.GitRestClient.deletePullRequestLabels
package: azure-devops-extension-api
summary: >-
Removes a label (tag) from the set of those assigned to the pull request.
The tag itself will not be deleted.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deletePullRequestLabels(repositoryId: string, pullRequestId:
number, labelIdOrName: string, project?: string, projectId?: string):
Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: labelIdOrName
type: string
description: The name or ID of the label requested.
- id: project
type: string
description: Project ID or project name
- id: projectId
type: string
description: Project ID or project name.
return:
description: ''
type: Promise<void>
- name: deletePullRequestReviewer(string, number, string, string)
uid: azure-devops-extension-api.GitRestClient.deletePullRequestReviewer
package: azure-devops-extension-api
summary: Remove a reviewer from a pull request.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deletePullRequestReviewer(repositoryId: string, pullRequestId:
number, reviewerId: string, project?: string): Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request's target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: reviewerId
type: string
description: ID of the reviewer to remove.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deletePullRequestStatus(string, number, number, string)
uid: azure-devops-extension-api.GitRestClient.deletePullRequestStatus
package: azure-devops-extension-api
summary: Delete pull request status.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deletePullRequestStatus(repositoryId: string, pullRequestId:
number, statusId: number, project?: string): Promise<void>
parameters:
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: statusId
type: number
description: ID of the pull request status.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deleteRefFavorite(string, number)
uid: azure-devops-extension-api.GitRestClient.deleteRefFavorite
package: azure-devops-extension-api
summary: Deletes the refs favorite specified
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteRefFavorite(project: string, favoriteId: number):
Promise<void>
parameters:
- id: project
type: string
description: Project ID or project name
- id: favoriteId
type: number
description: The Id of the ref favorite to delete.
return:
description: ''
type: Promise<void>
- name: deleteRepository(string, string)
uid: azure-devops-extension-api.GitRestClient.deleteRepository
package: azure-devops-extension-api
summary: Delete a git repository
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteRepository(repositoryId: string, project?: string):
Promise<void>
parameters:
- id: repositoryId
type: string
description: The ID of the repository.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<void>
- name: deleteRepositoryFromRecycleBin(string, string)
uid: azure-devops-extension-api.GitRestClient.deleteRepositoryFromRecycleBin
package: azure-devops-extension-api
summary: Destroy (hard delete) a soft-deleted Git repository.
remarks: ''
isDeprecated: false
syntax:
content: >-
function deleteRepositoryFromRecycleBin(project: string, repositoryId:
string): Promise<void>
parameters:
- id: project
type: string
description: Project ID or project name
- id: repositoryId
type: string
description: The ID of the repository.
return:
description: ''
type: Promise<void>
- name: getAnnotatedTag(string, string, string)
uid: azure-devops-extension-api.GitRestClient.getAnnotatedTag
package: azure-devops-extension-api
summary: Get an annotated tag.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAnnotatedTag(project: string, repositoryId: string,
objectId: string): Promise<GitAnnotatedTag>
parameters:
- id: project
type: string
description: Project ID or project name
- id: repositoryId
type: string
description: ID or name of the repository.
- id: objectId
type: string
description: ObjectId (Sha1Id) of tag to get.
return:
description: ''
type: >-
Promise<<xref uid="azure-devops-extension-api.GitAnnotatedTag"
/>>
- name: getAttachmentContent(string, string, number, string)
uid: azure-devops-extension-api.GitRestClient.getAttachmentContent
package: azure-devops-extension-api
summary: Get the file content of a pull request attachment.
remarks: ''
isDeprecated: false
syntax:
content: >-
function getAttachmentContent(fileName: string, repositoryId: string,
pullRequestId: number, project?: string): Promise<ArrayBuffer>
parameters:
- id: fileName
type: string
description: The name of the attachment.
- id: repositoryId
type: string
description: The repository ID of the pull request’s target branch.
- id: pullRequestId
type: number
description: ID of the pull request.
- id: project
type: string
description: Project ID or project name
return:
description: ''
type: Promise<ArrayBuffer>