-
Notifications
You must be signed in to change notification settings - Fork 41
/
github.txt
1008 lines (737 loc) · 34.1 KB
/
github.txt
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
*github.txt* Implement Github API via viml
Wang Shidong *github*
==============================================================================
CONTENTS *github-contents*
1. Configuration.............................................|github-config|
2. Functions..............................................|github-functions|
==============================================================================
CONFIGURATION *github-config*
*g:githubapi_root_url*
Github api root url:
default : https://api.github.com/
*g:githubapi_verbose*
set githubapi verbose when run shell command. By default it is 0.
*g:githubapi_curl_exe*
Specific the path for curl, by default it is 'curl', in windows you can use
>
let g:githubapi_curl_exe = 'D:\Program Files\Neovim\bin\curl.exe'
<
==============================================================================
FUNCTIONS *github-functions*
github#ListAllOrgs({since}) *github#ListAllOrgs()*
List all orgs in github,{since} is the integer ID of the last Organization
that you've seen.
Github API : GET /organizations
github#api#activity#List_events() *github#api#activity#List_events()*
List public events
Github API : GET /events
github#api#activity#List_repo_events({owner}, {repo})
*github#api#activity#List_repo_events()*
List repository events
Github API : GET /repos/:owner/:repo/events
github#api#activity#List_net_events({owner}, {repo})
*github#api#activity#List_net_events()*
List public events for a network of repositories
Github API : GET /networks/:owner/:repo/events
github#api#activity#List_org_events({org})
*github#api#activity#List_org_events()*
List public events for an organization
Github API : GET /orgs/:org/events
github#api#activity#List_user_events({user})
*github#api#activity#List_user_events()*
List events that a user has received
These are events that you've received by watching repos and following users.
If you are authenticated as the given user, you will see private events.
Otherwise, you'll only see public events.
Github API : GET /users/:username/received_events
github#api#activity#List_public_user_events({user})
*github#api#activity#List_public_user_events()*
List public events that a user has received
Github API : GET /users/:username/received_events/public
github#api#activity#Performed_events({user})
*github#api#activity#Performed_events()*
List events performed by a user
If you are authenticated as the given user, you will see your private
events. Otherwise, you'll only see public events.
Github API : GET /users/:username/events
github#api#activity#Performed_public_events({user})
*github#api#activity#Performed_public_events()*
List public events performed by a user
Github API : GET /users/:username/events/public
github#api#activity#List_user_org_events({user}, {org}, {password})
*github#api#activity#List_user_org_events()*
List events for an organization
NOTE:This is the user's organization dashboard. You must be authenticated as
the user to view this.
Github API : GET /users/:username/events/orgs/:org
github#api#activity#List_notifications({user}, {password})
*github#api#activity#List_notifications()*
List your notifications
Github API : /notifications
github#api#activity#List_notifications_for_repo({onwer}, {repo}, {user},
{password}) *github#api#activity#List_notifications_for_repo()*
List your notifications in a repository
Github API : GET /repos/:owner/:repo/notifications
github#api#activity#Mark_All_as_read({user}, {password}, {last_read_at})
*github#api#activity#Mark_All_as_read()*
Mark as read,you need use {last_read_at} as args. This is a timestamp in ISO
8601 format: YYYY-MM-DDTHH:MM:SSZ. Default: Time.now
Github API : PUT /notifications
github#api#activity#Mark_All_as_read_for_repo({owner}, {repo}, {user},
{password}, {last_read_at})
*github#api#activity#Mark_All_as_read_for_repo()*
Mark notifications as read in a repository
Github API : PUT /repos/:owner/:repo/notifications
github#api#activity#Get_thread({id}, {user}, {password})
*github#api#activity#Get_thread()*
View a single thread
Github API : GET /notifications/threads/:id
github#api#activity#Mark_thread({id}, {user}, {password})
*github#api#activity#Mark_thread()*
Mark a thread as read
Github API : PATCH /notifications/threads/:id
github#api#activity#Get_thread_sub({id}, {user}, {password})
*github#api#activity#Get_thread_sub()*
Get a Thread Subscription
Github API : GET /notifications/threads/:id/subscription
github#api#activity#Set_thread_sub({id}, {user}, {password}, {subscribed},
{ignored}) *github#api#activity#Set_thread_sub()*
Set a Thread Subscription
This lets you subscribe or unsubscribe from a conversation. Unsubscribing
from a conversation mutes all future notifications (until you comment or get
@mentioned once more).
Github API : PUT /notifications/threads/:id/subscription
github#api#activity#Del_thread_sub({id}, {user}, {password})
*github#api#activity#Del_thread_sub()*
Delete a Thread Subscription
Github API : DELETE /notifications/threads/:id/subscription
github#api#activity#List_stargazers({owner}, {repo})
*github#api#activity#List_stargazers()*
List stargazers of the repo
Github API : GET /repos/:owner/:repo/stargazers
github#api#activity#List_all_stargazers({owner}, {repo})
*github#api#activity#List_all_stargazers()*
List all stargazers of the repo
Github API : GET /repos/:owner/:repo/stargazers
github#api#activity#CheckStarred({owner}, {repo}, {user}, {password})
*github#api#activity#CheckStarred()*
Check starred
Github API : GET /user/starred/:owner/:repo
github#api#activity#Star({owner}, {repo}, {user}, {password})
*github#api#activity#Star()*
Star a repository
Github API : PUT /user/starred/:owner/:repo
github#api#activity#Unstar({owner}, {repo}, {user}, {password})
*github#api#activity#Unstar()*
Unstar a repository
Github API : DELETE /user/starred/:owner/:repo
github#api#activity#List_watchers({owner}, {repo})
*github#api#activity#List_watchers()*
List watchers
Github API : GET /repos/:owner/:repo/subscribers
github#api#activity#List_watched_repo({user})
*github#api#activity#List_watched_repo()*
List repositories being watched by a user.
Github API : GET /users/:username/subscriptions
github#api#activity#List_auth_watched_repo({user}, {password})
*github#api#activity#List_auth_watched_repo()*
List repositories being watched by the authenticated user.
Github API : GET /user/subscriptions
github#api#activity#Check_repo_Sub({owner}, {repo}, {user}, {password})
*github#api#activity#Check_repo_Sub()*
Get a Repository Subscription
Github API : GET /repos/:owner/:repo/subscription
github#api#activity#Set_repo_sub({owner}, {repo}, {user}, {password}, {sub},
{ignore}) *github#api#activity#Set_repo_sub()*
Set a Repository Subscription
If you would like to watch a repository, set {sub} to 1. If you would like
to ignore notifications made within a repository, set {ignore} to 1. If you
would like to stop watching a repository, delete the repository's
subscription completely.
Github API : PUT /repos/:owner/:repo/subscription
github#api#activity#Del_repo_sub({owner}, {repo}, {user}, {password})
*github#api#activity#Del_repo_sub()*
Delete a Repository Subscription
Github API : DELETE /repos/:owner/:repo/subscription
github#api#gist#List({user}) *github#api#gist#List()*
List public gists for the specified user:
GET /users/:username/gists
github#api#gist#ListAll({user}, {password}) *github#api#gist#ListAll()*
List the authenticated user's gists or if called anonymously, this will
return all public gists:
GET /gists
github#api#gist#ListPublic({since}) *github#api#gist#ListPublic()*
List all public gists
Get /gists/public
github#api#gist#ListStarred({user}, {password}, {since})
*github#api#gist#ListStarred()*
List starred gists,{since}A timestamp in ISO 8601 format:
YYYY-MM-DDTHH:MM:SSZ. Only gists updated at or after this time are returned.
GET /gists/starred
github#api#gist#GetSingle({id}) *github#api#gist#GetSingle()*
Get a single gist
Github API : GET /gists/:id
github#api#gist#GetSingleSha({id}, {sha}) *github#api#gist#GetSingleSha()*
Get a specific revision of a gist
Github API : GET /gists/:id/:sha
github#api#gist#Create({desc}, {filename}, {content}, {public}, {user},
{password}) *github#api#gist#Create()*
Create a gist
Input:
>
{
"description": "the description for this gist",
"public": true,
"files": {
"file1.txt": {
"content": "String file contents"
}
}
}
<
POST : /gists
github#api#gist#Edit({desc}, {filename}, {content}, {public}, {user},
{password}, {id}) *github#api#gist#Edit()*
Edit a gist
Input:
>
{
"description": "the description for this gist",
"files": {
"file1.txt": {
"content": "updated file contents"
},
"old_name.txt": {
"filename": "new_name.txt",
"content": "modified contents"
},
"new_file.txt": {
"content": "a new file"
},
"delete_this_file.txt": null
}
}
<
PATCH : /gists/:id Note: All files from the previous version of the gist are
carried over by default if not included in the object. Deletes can be
performed by including the filename with a null object.
github#api#gist#ListCommits({id}) *github#api#gist#ListCommits()*
List gist commits
Github API : GET /gists/:id/commits
github#api#gist#Star({user}, {password}, {id}) *github#api#gist#Star()*
Star a gist
Github API : PUT /gists/:id/star
github#api#gist#Unstar({user}, {password}, {id}) *github#api#gist#Unstar()*
Unstar a gist
Github API : DELETE /gists/:id/star
github#api#gist#CheckStar({user}, {password}, {id})
*github#api#gist#CheckStar()*
Check if a gist is starred
Github API : GET /gists/:id/star
github#api#gist#Fork({user}, {password}, {id}) *github#api#gist#Fork()*
Fork a gist
Github API : POST /gists/:id/forks
github#api#gist#ListFork({user}, {password}, {id})
*github#api#gist#ListFork()*
List Fork of a gist
Github API : GET /gists/:id/forks
github#api#gist#Del({user}, {password}, {id}) *github#api#gist#Del()*
Delete a gist
Github API : DELETE /gists/:id
github#api#gist#ListComments({id}) *github#api#gist#ListComments()*
List comments on a gist
Github API : GET /gists/:gist_id/comments
github#api#gist#GetComment({gistid}, {commentid})
*github#api#gist#GetComment()*
Get a single comment
Github API : GET /gists/:gist_id/comments/:id
github#api#gist#CreateComment({id}, {user}, {password}, {body})
*github#api#gist#CreateComment()*
Create a comment
Github API : POST /gists/:gist_id/comments
github#api#gist#EditComment({id}, {user}, {password}, {body})
*github#api#gist#EditComment()*
Edit a comment
Github API : PATCH /gists/:gist_id/comments
github#api#gist#DelComment({gistid}, {id}, {user}, {password})
*github#api#gist#DelComment()*
Delete a comment
Github API : DELETE /gists/:gist_id/comments/:id
github#api#issues#List_All({user}, {password}) *github#api#issues#List_All()*
List issues List all issues assigned to the authenticated user across all
visible repositories including owned repositories, member repositories, and
organization repositories:
Github API : GET /issues
github#api#issues#List_All_for_User({user}, {password})
*github#api#issues#List_All_for_User()*
List all issues across owned and member repositories assigned to the
authenticated user:
Github API : GET /user/issues
github#api#issues#List_All_for_User_In_Org({org}, {user}, {password})
*github#api#issues#List_All_for_User_In_Org()*
List all issues for a given organization assigned to the authenticated user:
Github API : GET /orgs/:org/issues
github#api#issues#Get_issue({owner}, {repo}, {num})
*github#api#issues#Get_issue()*
Get a single issue GET /repos/:owner/:repo/issues/:number
github#api#issues#Create({owner}, {repo}, {user}, {password}, {issue})
*github#api#issues#Create()*
Create an issue
Input:
>
{
"title": "Found a bug",
"body": "I'm having a problem with this.",
"assignee": "octocat",
"milestone": 1,
"labels": [
"bug"
]
}
<
Github API : POST /repos/:owner/:repo/issues
github#api#issues#Lock({owner}, {repo}, {num}, {user}, {password})
*github#api#issues#Lock()*
Lock an issue
Github APi : PUT /repos/:owner/:repo/issues/:number/lock
github#api#issues#Unlock({owner}, {repo}, {num}, {user}, {password})
*github#api#issues#Unlock()*
Unlock an issue
Github API : DELETE /repos/:owner/:repo/issues/:number/lock
github#api#issues#List_assignees({owner}, {repo})
*github#api#issues#List_assignees()*
Lists all the available assignees to which issues may be assigned.
Github API : GET /repos/:owner/:repo/assignees
github#api#issues#Check_assignee({owner}, {repo}, {assignee})
*github#api#issues#Check_assignee()*
Check assignee
Github API : GET /repos/:owner/:repo/assignees/:assignee
github#api#issues#Addassignee({owner}, {repo}, {num}, {assignees}, {user},
{password}) *github#api#issues#Addassignee()*
Add assignees to an Issue
Input:
>
{
"assignees": [
"hubot",
"other_assignee"
]
}
<
Github API : POST /repos/:owner/:repo/issues/:number/assignees
NOTE: need `Accep:application/vnd.github.cerberus-preview+json`
github#api#issues#Removeassignee({owner}, {repo}, {num}, {assignees}, {user},
{password}) *github#api#issues#Removeassignee()*
Remove assignees from an Issue
Input:
>
{
"assignees": [
"hubot",
"other_assignee"
]
}
<
DELETE /repos/:owner/:repo/issues/:number/assignees
NOTE: need `Accep:application/vnd.github.cerberus-preview+json`
github#api#issues#List_comments({owner}, {repo}, {num}, {since})
*github#api#issues#List_comments()*
List comments on an issue, updated at or after {since} . {since} :
YYYY-MM-DDTHH:MM:SSZ
Github API : GET /repos/:owner/:repo/issues/:number/comments
github#api#issues#List_All_comments({owner}, {repo}, {sort}, {desc}, {since})
*github#api#issues#List_All_comments()*
List comments in a repository
Github API : GET /repos/:owner/:repo/issues/comments
github#api#issues#Get_comment({owner}, {repo}, {id})
*github#api#issues#Get_comment()*
Get a single comment
Github API : GET /repos/:owner/:repo/issues/comments/:id
github#api#issues#Create_comment({owner}, {repo}, {num}, {json}, {user},
{password}) *github#api#issues#Create_comment()*
Create a comment
Input:
>
{
"body": "Me too"
}
<
Github API : POST /repos/:owner/:repo/issues/:number/comments
github#api#issues#Edit_comment({owner}, {repo}, {id}, {json}, {user},
{password}) *github#api#issues#Edit_comment()*
Edit a comment
Input:
>
{
"body": "Me too"
}
<
Github API : PATCH /repos/:owner/:repo/issues/comments/:id
github#api#issues#Delete_comment({owner}, {repo}, {id}, {user}, {password})
*github#api#issues#Delete_comment()*
Delete a comment
Github API : ELETE /repos/:owner/:repo/issues/comments/:id
github#api#issues#List_events({owner}, {repo}, {num})
*github#api#issues#List_events()*
List events for an issue Github API : GET
/repos/:owner/:repo/issues/:issue_number/events
github#api#issues#List_events_for_repo({owner}, {repo})
*github#api#issues#List_events_for_repo()*
List events for a repository
Github API : GET /repos/:owner/:repo/issues/events
github#api#issues#Get_event({owner}, {repo}, {id})
*github#api#issues#Get_event()*
Get a single event
Github API : GET /repos/:owner/:repo/issues/events/:id
github#api#issues#ListAllMilestones({owner}, {repo}, {state}, {sort},
{direction}) *github#api#issues#ListAllMilestones()*
List milestones for a repository
Github API : GET /repos/:owner/:repo/milestones Parameters
>
Name Type Description
state string The state of the milestone. Either open, closed, or all.
Default: open
sort string What to sort results by. Either due_on or completeness.
Default: due_on
direction string The direction of the sort. Either asc or desc.
Default: asc
<
github#api#issues#GetSingleMilestone({owner}, {repo}, {num})
*github#api#issues#GetSingleMilestone()*
Get a single milestone
Github API : GET /repos/:owner/:repo/milestones/:number
github#api#issues#CreateMilestone({owner}, {repo}, {milestone}, {user},
{password}) *github#api#issues#CreateMilestone()*
Create a milestone
Input
>
{
"title": "v1.0",
"state": "open",
"description": "Tracking milestone for version 1.0",
"due_on": "2012-10-09T23:39:01Z"
}
<
Github API : POST /repos/:owner/:repo/milestones
github#api#issues#UpdateMilestone({owner}, {repo}, {num}, {milestone}, {user},
{password}) *github#api#issues#UpdateMilestone()*
Update a milestone
Github API : PATCH /repos/:owner/:repo/milestones/:number
github#api#issues#DeleteMilestone({owner}, {repo}, {num}, {user}, {password})
*github#api#issues#DeleteMilestone()*
Delete a milestone
Github API : DELETE /repos/:owner/:repo/milestones/:number
github#api#labels#GetAll({owner}, {repo}) *github#api#labels#GetAll()*
List all labels for this repository
Github API : GET /repos/:owner/:repo/labels
github#api#labels#Get({owner}, {repo}, {name}) *github#api#labels#Get()*
Get a single label
Github API : GET /repos/:owner/:repo/labels/:name
github#api#labels#Create({owner}, {repo}, {user}, {password}, {label})
*github#api#labels#Create()*
Create a label
Input:
>
{
"name": "bug",
"color": "f29513"
}
<
Github API : POST /repos/:owner/:repo/labels
github#api#labels#Update({owner}, {repo}, {user}, {password}, {label})
*github#api#labels#Update()*
Update a label
Input:
>
{
"name": "bug",
"color": "f29513"
}
<
Github API : PATCH /repos/:owner/:repo/labels/:name
github#api#labels#Delete({owner}, {repo}, {name}, {user}, {password})
*github#api#labels#Delete()*
Delete a label
Github API : DELETE /repos/:owner/:repo/labels/:name
github#api#labels#List({owner}, {repo}, {num}) *github#api#labels#List()*
List labels on an issue
Github API : GET /repos/:owner/:repo/issues/:number/labels
github#api#labels#Add({owner}, {repo}, {num}, {labels}, {user}, {password})
*github#api#labels#Add()*
Add labels to an issue
Input:
>
[
"Label1",
"Label2"
]
<
Github API : POST /repos/:owner/:repo/issues/:number/labels
github#api#labels#Remove({owner}, {repo}, {num}, {name}, {user}, {password})
*github#api#labels#Remove()*
Remove a label from an issue
Github API : DELETE /repos/:owner/:repo/issues/:number/labels/:name
github#api#labels#Replace({owner}, {repo}, {num}, {labels}, {user},
{password}) *github#api#labels#Replace()*
Replace all labels for an issue
Input:
>
[
"Label1",
"Label2"
]
<
Github API : PUT /repos/:owner/:repo/issues/:number/labels
github#api#labels#RemoveAll({owner}, {repo}, {num}, {user}, {password})
*github#api#labels#RemoveAll()*
Remove all label from an issue
Github API : DELETE /repos/:owner/:repo/issues/:number/labels
github#api#labels#ListAllinMilestone({owner}, {repo}, {num})
*github#api#labels#ListAllinMilestone()*
Get labels for every issue in a milestone
Github API : GET /repos/:owner/:repo/milestones/:number/labels
github#api#orgs#Get({org}) *github#api#orgs#Get()*
Get an organization
Github API : GET /orgs/:org
github#api#orgs#Edit({org}, {orgdata}, {user}, {password})
*github#api#orgs#Edit()*
Edit an organization
Input:
>
{
"billing_email": "support@github.com",
"blog": "https://github.com/blog",
"company": "GitHub",
"email": "support@github.com",
"location": "San Francisco",
"name": "github",
"description": "GitHub, the company."
}
<
Github API : PATCH /orgs/:org
github#api#orgs#ListMembers({org}, {filter}, {role})
*github#api#orgs#ListMembers()*
List all users who are members of an organization.
{filter}Filter members returned in the list. Can be one of:
* 2fa_disabled: Members without two-factor authentication enabled.
Available for organization owners.
* all: All members the authenticated user can see.
* Default: all.
{role}Filter members returned by their role. Can be one of:
* all: All members of the organization, regardless of role.
* admin: Organization owners.
* member: Non-owner organization members.
* Default: all.
Github API : GET /orgs/:org/members
github#api#orgs#CheckMembership({org}, {username}, {user}, {password})
*github#api#orgs#CheckMembership()*
Check if a user is, publicly or privately, a member of the organization.
Status:
* 204: requester is an organization member and user is a member
* 404: requester is an organization member and user is not a member,
requester is not an organization member and is inquiring about
themselves
* 302: requester is not an organization member
Github API : GET /orgs/:org/members/:username
github#api#orgs#DeleteMember({org}, {username}, {user}, {password})
*github#api#orgs#DeleteMember()*
Remove a member
Github API : DELETE /orgs/:org/members/:username
github#api#orgs#ListPublicMembers({org}) *github#api#orgs#ListPublicMembers()*
List public members of an org
Github API : GET /orgs/:org/public_members
github#api#orgs#CheckPublicMembership({org}, {username})
*github#api#orgs#CheckPublicMembership()*
Check public membership
Github API : GET /orgs/:org/public_members/:username
github#api#orgs#Publicize({org}, {user}, {password})
*github#api#orgs#Publicize()*
Publicize a user's membership The user can publicize their own membership.
(A user cannot publicize the membership for another user.)
Github API : PUT /orgs/:org/public_members/:username
github#api#orgs#ConcealUser({org}, {user}, {password})
*github#api#orgs#ConcealUser()*
Conceal a user's membership
Github API : DELETE /orgs/:org/public_members/:username
github#api#orgs#GetMemberships({org}, {username}, {user}, {password})
*github#api#orgs#GetMemberships()*
Get organization membership
Github API : GET /orgs/:org/memberships/:username
github#api#orgs#UpdateMembership({org}, {username}, {user}, {password},
{role}) *github#api#orgs#UpdateMembership()*
Add or update organization membership,use admin or member for {role}
Github API : PUT /orgs/:org/memberships/:username
github#api#orgs#RemoveMembership({org}, {username}, {user}, {password})
*github#api#orgs#RemoveMembership()*
Remove organization membership
Github API : DELETE /orgs/:org/memberships/:username
github#api#pulls#ListAllPRs({owner}, {repo}) *github#api#pulls#ListAllPRs()*
List all the PRs of a repo.
Github API : GET /repos/:owner/:repo/pulls
github#api#pulls#Get({owner}, {repo}, {number}) *github#api#pulls#Get()*
Get a single pull request
Github API : GET /repos/:owner/:repo/pulls/:number
github#api#pulls#create({owner}, {repo}, {user}, {password}, {pull})
*github#api#pulls#create()*
Create a pull request
Input:
>
{
"title": "Amazing new feature",
"body": "Please pull this in!",
"head": "octocat:new-feature",
"base": "master"
}
<
or:
>
{
"issue": 5,
"head": "octocat:new-feature",
"base": "master"
}
<
Github API : POST /repos/:owner/:repo/pulls
github#api#pulls#update({owner}, {repo}, {number}, {pull}, {user}, {password})
*github#api#pulls#update()*
Update a pull request
Input:
>
{
"title": "new title",
"body": "updated body",
"state": "open"
}
<
Github API : PATCH /repos/:owner/:repo/pulls/:number
github#api#pulls#ListCommits({owner}, {repo}, {number})
*github#api#pulls#ListCommits()*
List commits on a pull request
Github API : GET /repos/:owner/:repo/pulls/:number/commits
github#api#pulls#ListFiles({owner}, {repo}, {number})
*github#api#pulls#ListFiles()*
List pull requests files
Github API : GET /repos/:owner/:repo/pulls/:number/files
github#api#pulls#CheckMerged({owner}, {repo}, {number})
*github#api#pulls#CheckMerged()*
Get if a pull request has been merged
Github API : GET /repos/:owner/:repo/pulls/:number/merge
github#api#pulls#Merge({owner}, {repo}, {number}, {msg}, {user}, {password})
*github#api#pulls#Merge()*
Merge a pull request (Merge Button)
Github API : PUT /repos/:owner/:repo/pulls/:number/merge
github#api#repos#get_repo({owner}, {repo}) *github#api#repos#get_repo()*
Get a single repository GET /repos/:owner/:repo
github#api#repos#releases#Create({owner}, {repo}, {user}, {password},
{release}) *github#api#repos#releases#Create()*
Create an release
Input:
>
<
{ "tag_name": "v1.0.0", "target_commitish": "master", "name": "v1.0.0",
"body": "Description of the release", "draft": false, "prerelease": false
} < Github API: POST /repos/:owner/:repo/releases
github#api#repos#releases#latest({owner}, {repo})
*github#api#repos#releases#latest()*
Get the latest release
Github API: GET /repos/:owner/:repo/releases/latest
github#api#repos#releases#list_assets({owner}, {repo}, {release_id})
*github#api#repos#releases#list_assets()*
List assets for a release
Github API: GET /repos/:owner/:repo/releases/:id/assets
github#api#search#SearchRepos({q}, {sort}, {order})
*github#api#search#SearchRepos()*
Search for repos, for how to {sort} result, you can use `stars`,`forks` and
`updated`. and for {order} you can use `asc` and `desc`.for {q} see: Input:
>
{
'in' : 'name,description',
'size' : '',
'forks' : '',
'fork' : '',
'created' : '',
'pushed' : '',
'user' : '',
'language' : '',
'stars' : '',
'keywords' : ''
}
<
Github API : GET /search/repositories
github#api#user#GetFollowers({user}, {password})
*github#api#user#GetFollowers()*
List the authenticated user's followers:
Github API : GET /user/followers
github#api#user#CheckFollowing({username}, {user}, {password})
*github#api#user#CheckFollowing()*
Check if you are following a user
Github API : GET /user/following/:username
github#api#user#Follow({username}, {user}, {password})
*github#api#user#Follow()*
follow a user
Github API : PUT /user/following/:username
github#api#user#ListOrgs({auth}) *github#api#user#ListOrgs()*
List all orgs for the auth user.
Github API : GET /user/orgs
github#api#user#GetOrgMembership({user}, {password}, {org})
*github#api#user#GetOrgMembership()*
Get your organization membership
Github API : GET /user/memberships/orgs/:org
github#api#user#EditOrgMembership({org}, {state}, {user}, {password})
*github#api#user#EditOrgMembership()*
Edit your organization membership
Input:
>
{
"state": "active"
}
<
Github API : PATCH /user/memberships/orgs/:org
github#api#user#UpdateUser({data}, {user}, {password})
*github#api#user#UpdateUser()*
Update the authenticated user
Input
>
{
"name": "monalisa octocat",
"email": "octocat@github.com",
"blog": "https://github.com/blog",
"company": "GitHub",
"location": "San Francisco",
"hireable": true,
"bio": "There once..."
}
<
Github API : PATCH /user
github#api#user#ListEmails({user}, {password}) *github#api#user#ListEmails()*
List emails for a user
Github API : GET /user/emails
github#api#user#AddEmails({user}, {password}, {emails})
*github#api#user#AddEmails()*
Add email address(es)
Github API : POST /user/emails
github#api#user#DeleteEmails({user}, {password}, {emails})
*github#api#user#DeleteEmails()*
Delete email address(es)
Github API : DELETE /user/emails
github#api#user#UnFollow({username}, {user}, {password})
*github#api#user#UnFollow()*
Unfollow a user
Github API : DELETE /user/following/:username
github#api#users#GetAllUsers() *github#api#users#GetAllUsers()*
Get all users
Github API : GET /users
github#api#users#ListAllOrgs({user}) *github#api#users#ListAllOrgs()*
List orgs of a specified user.
Github API : /users/:username/orgs
github#api#users#CheckTargetFollow({username}, {target})
*github#api#users#CheckTargetFollow()*
Check if one user follows another
Github API : GET /users/:username/following/:target_user
github#api#util#Get_current_time() *github#api#util#Get_current_time()*
Get current time in a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ
github#api#util#GetLog() *github#api#util#GetLog()*