-
Notifications
You must be signed in to change notification settings - Fork 0
/
assets.swgg.swagger.json
3857 lines (3857 loc) · 325 KB
/
assets.swgg.swagger.json
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
{
"basePath": "/",
"definitions": {},
"info": {
"title": "swgg-github-scim",
"version": "2018.4.21",
"x-swgg-description": "this zero-dependency package will provide a (nodejs-compatible) swagger-client for github-scim's web-apis, with a working web-demo",
"x-swgg-homepage": "https://github.com/kaizhu256/node-swgg-github-scim"
},
"parameters": {
"github-all.key": {
"default": "xxxxxxxx",
"in": "query",
"name": "access_token",
"type": "string",
"x-swgg-apiKey": true,
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/#authentication",
"",
"OAuth2 token (sent as a parameter)"
]
},
"github-all.user-agent": {
"default": "Awesome-Octocat-App",
"in": "header",
"name": "user-agent",
"required": true,
"type": "string",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/index.html#user-agent-required",
"",
"All API requests MUST include a valid ```User-Agent``` header. Requests with no ```User-Agent``` header will be rejected. We request that you use your GitHub username, or the name of your application, for the ```User-Agent``` header value. This allows us to contact you if there are problems."
]
}
},
"paths": {
"/scim/v2/organizations/{organization}/Users": {
"get": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
},
{
"in": "query",
"name": "startIndex",
"type": "integer",
"x-swgg-descriptionLineList": [
"Used for pagination: the index of the first result to return"
]
},
{
"in": "query",
"name": "count",
"type": "integer",
"x-swgg-descriptionLineList": [
"Used for pagination: the number of results to return"
]
},
{
"in": "query",
"name": "filter",
"type": "string",
"x-swgg-descriptionLineList": [
"Only ```eq``` type filters are supported"
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#get-a-list-of-provisioned-identities) - Get a list of provisioned identities"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#get-a-list-of-provisioned-identities) - Get a list of provisioned identities",
"x-swgg-tags0": "github-scim"
},
"post": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_20POST",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#provision-and-invite-users) - Provision and invite users",
"",
"Provision organization membership for and send activation emails to a list of email addresses."
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#provision-and-invite-users) - Provision and invite users",
"x-swgg-tags0": "github-scim"
}
},
"/scim/v2/organizations/{organization}/Users/{id}": {
"delete": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20DELETE",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#remove-a-user-from-the-organization) - Remove a user from the organization"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#remove-a-user-from-the-organization) - Remove a user from the organization",
"x-swgg-tags0": "github-scim"
},
"get": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string",
"x-swgg-descriptionLineList": [
"Identifier generated by the GitHub SCIM endpoint"
]
},
{
"in": "query",
"name": "userName",
"type": "string",
"x-swgg-descriptionLineList": [
"The username for the user"
]
},
{
"in": "query",
"name": "name.givenName",
"type": "string",
"x-swgg-descriptionLineList": [
"User first name"
]
},
{
"in": "query",
"name": "name.lastName",
"type": "string",
"x-swgg-descriptionLineList": [
"User last name"
]
},
{
"in": "query",
"items": {
"type": "string"
},
"name": "emails",
"type": "array",
"x-swgg-descriptionLineList": [
"List of user emails"
]
},
{
"in": "query",
"name": "externalId",
"type": "string",
"x-swgg-descriptionLineList": [
"External identifier (generated by the SAML SSO provider)"
]
},
{
"in": "query",
"name": "active",
"type": "boolean",
"x-swgg-descriptionLineList": [
"Used to indicate whether the identity is active (true) or should be deprovisioned (false)"
]
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#supported-scim-user-attributes) - Supported SCIM User attributes",
"",
"Name Type Description ```userName``` ```string``` The username for the user ```name.givenName``` ```string``` User first name ```name.lastName``` ```string``` User last name ```emails``` ```array``` List of user emails ```externalId``` ```string``` External identifier (generated by the SAML SSO provider) ```id``` ```string``` Identifier generated by the GitHub SCIM endpoint ```active``` ```boolean``` Used to indicate whether the identity is active (true) or should be deprovisioned (false)",
"",
"Note: Endpoints for the SCIM API are case sensitive: the first letter in the ```Users``` endpoint must be capitalized. For example:"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#supported-scim-user-attributes) - Supported SCIM User attributes",
"x-swgg-tags0": "github-scim"
},
"patch": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20PATCH",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#update-a-user-attribute) - Update a user attribute"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#update-a-user-attribute) - Update a user attribute",
"x-swgg-tags0": "github-scim"
},
"put": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_20PUT",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#update-a-provisioned-organization-membership) - Update a provisioned organization membership"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#update-a-provisioned-organization-membership) - Update a provisioned organization membership",
"x-swgg-tags0": "github-scim"
}
},
"/scim/v2/organizations/{organization}/Users/{id}#1": {
"get": {
"operationId": "_2Fscim_2Fv2_2Forganizations_2F_7Borganization_7D_2FUsers_2F_7Bid_7D_231_20GET",
"parameters": [
{
"$ref": "#/parameters/github-all.key"
},
{
"$ref": "#/parameters/github-all.user-agent"
},
{
"collectionFormat": "csv",
"default": [
"application/vnd.github.cloud-9-preview+json+scim"
],
"enum": [
"application/vnd.github.cloud-9-preview+json+scim",
"application/vnd.github.v3+json"
],
"in": "header",
"items": {
"type": "string"
},
"name": "accept",
"required": true,
"type": "array",
"x-swgg-descriptionLineList": [
"https://developer.github.com/v3/media/",
"",
"Custom media types are used in the API to let consumers choose the format of the data they wish to receive. This is done by adding one or more of the following types to the ```Accept``` header when you make a request. Media types are specific to resources, allowing them to change independently and support formats that other resources don't."
]
},
{
"default": "organization",
"in": "path",
"name": "organization",
"required": true,
"type": "string"
},
{
"default": "id",
"in": "path",
"name": "id",
"required": true,
"type": "string"
}
],
"responses": {
"default": {
"description": "default response"
}
},
"tags": [
"github-scim"
],
"x-swgg-descriptionLineList": [
"[SCIM](https://developer.github.com/v3/scim/#get-provisioning-details-for-a-single-user) - Get provisioning details for a single user"
],
"x-swgg-host": "api.github.com",
"x-swgg-schemes": [
"https"
],
"x-swgg-sortValue": "[SCIM](https://developer.github.com/v3/scim/#get-provisioning-details-for-a-single-user) - Get provisioning details for a single user",
"x-swgg-tags0": "github-scim"
}
}
},
"schemes": [
"https"
],
"swagger": "2.0",
"tags": [
{
"name": "github-activity",
"x-swgg-descriptionLineList": [
"# [Activity](https://developer.github.com/v3/activity/)",
"",
"Serving up the 'social' in Social Coding, the Activity APIs provide access to notifications, subscriptions, and timelines.",
"",
"# [Event Types & Payloads](https://developer.github.com/v3/activity/events/types/)",
"",
"Each event has a similar JSON schema, but a unique ```payload``` object that is determined by its event type.",
"",
"Event names are used by [repository webhooks](https://developer.github.com/v3/repos/hooks/) to specify which events the webhook should receive. The included payloads below are from webhook deliveries but match events returned by the [Events API](https://developer.github.com/v3/activity/events/) (except where noted). The Events API uses the CamelCased name (e.g. ```CommitCommentEvent```) in the ```type``` field of an event object and does not include the ```repository``` or ```sender``` fields in the event payload object.",
"",
"**Note:** Some of these events may not be rendered in timelines, they're only created for various internal and webhook purposes.",
"- [CommitCommentEvent](https://developer.github.com/v3/activity/events/types/#commitcommentevent)",
"- [CreateEvent](https://developer.github.com/v3/activity/events/types/#createevent)",
"- [DeleteEvent](https://developer.github.com/v3/activity/events/types/#deleteevent)",
"- [DeploymentEvent](https://developer.github.com/v3/activity/events/types/#deploymentevent)",
"- [DeploymentStatusEvent](https://developer.github.com/v3/activity/events/types/#deploymentstatusevent)",
"- [DownloadEvent](https://developer.github.com/v3/activity/events/types/#downloadevent)",
"- [FollowEvent](https://developer.github.com/v3/activity/events/types/#followevent)",
"- [ForkEvent](https://developer.github.com/v3/activity/events/types/#forkevent)",
"- [ForkApplyEvent](https://developer.github.com/v3/activity/events/types/#forkapplyevent)",
"- [GistEvent](https://developer.github.com/v3/activity/events/types/#gistevent)",
"- [GollumEvent](https://developer.github.com/v3/activity/events/types/#gollumevent)",
"- [InstallationEvent](https://developer.github.com/v3/activity/events/types/#installationevent)",
"- [InstallationRepositoriesEvent](https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent)",
"- [IssueCommentEvent](https://developer.github.com/v3/activity/events/types/#issuecommentevent)",
"- [IssuesEvent](https://developer.github.com/v3/activity/events/types/#issuesevent)",
"- [LabelEvent](https://developer.github.com/v3/activity/events/types/#labelevent)",
"- [MarketplacePurchaseEvent](https://developer.github.com/v3/activity/events/types/#marketplacepurchaseevent)",
"- [MemberEvent](https://developer.github.com/v3/activity/events/types/#memberevent)",
"- [MembershipEvent](https://developer.github.com/v3/activity/events/types/#membershipevent)",
"- [MilestoneEvent](https://developer.github.com/v3/activity/events/types/#milestoneevent)",
"- [OrganizationEvent](https://developer.github.com/v3/activity/events/types/#organizationevent)",
"- [OrgBlockEvent](https://developer.github.com/v3/activity/events/types/#orgblockevent)",
"- [PageBuildEvent](https://developer.github.com/v3/activity/events/types/#pagebuildevent)",
"- [ProjectCardEvent](https://developer.github.com/v3/activity/events/types/#projectcardevent)",
"- [ProjectColumnEvent](https://developer.github.com/v3/activity/events/types/#projectcolumnevent)",
"- [ProjectEvent](https://developer.github.com/v3/activity/events/types/#projectevent)",
"- [PublicEvent](https://developer.github.com/v3/activity/events/types/#publicevent)",
"- [PullRequestEvent](https://developer.github.com/v3/activity/events/types/#pullrequestevent)",
"- [PullRequestReviewEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent)",
"- [PullRequestReviewCommentEvent](https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent)",
"- [PushEvent](https://developer.github.com/v3/activity/events/types/#pushevent)",
"- [ReleaseEvent](https://developer.github.com/v3/activity/events/types/#releaseevent)",
"- [RepositoryEvent](https://developer.github.com/v3/activity/events/types/#repositoryevent)",
"- [StatusEvent](https://developer.github.com/v3/activity/events/types/#statusevent)",
"- [TeamEvent](https://developer.github.com/v3/activity/events/types/#teamevent)",
"- [TeamAddEvent](https://developer.github.com/v3/activity/events/types/#teamaddevent)",
"- [WatchEvent](https://developer.github.com/v3/activity/events/types/#watchevent)",
"",
"# [Events](https://developer.github.com/v3/activity/events/)",
"",
"This is a read-only API to the GitHub events. These events power the various activity streams on the site.",
"- [List public events](https://developer.github.com/v3/activity/events/#list-public-events)",
"- [List repository events](https://developer.github.com/v3/activity/events/#list-repository-events)",
"- [List issue events for a repository](https://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository)",
"- [List public events for a network of repositories](https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories)",
"- [List public events for an organization](https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization)",
"- [List events that a user has received](https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received)",
"- [List public events that a user has received](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)",
"- [List events performed by a user](https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user)",
"- [List public events performed by a user](https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user)",
"- [List events for an organization](https://developer.github.com/v3/activity/events/#list-events-for-an-organization)",
"",
"Events are optimized for polling with the \"ETag\" header. If no new events have been triggered, you will see a \"304 Not Modified\" response, and your current rate limit will be untouched. There is also an \"X-Poll-Interval\" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.",
"```",
"curl -I https://api.github.com/users/tater/events",
"HTTP/1.1 200 OK",
"X-Poll-Interval: 60",
"ETag: \"a18c3bded88eb5dbb5c849a489412bf3\"",
"# The quotes around the ETag value are important",
"curl -I https://api.github.com/users/tater/events \\",
" -H 'If-None-Match: \"a18c3bded88eb5dbb5c849a489412bf3\"'",
"HTTP/1.1 304 Not Modified",
"X-Poll-Interval: 60",
"```",
"",
"",
"Events support [pagination](https://developer.github.com/v3/#pagination), however the ```per_page``` option is unsupported. The fixed page size is 30 items. Fetching up to ten pages is supported, for a total of 300 events.",
"",
"Only events created within the past 90 days will be included in timelines. Events older than 90 days will not be included (even if the total number of events in the timeline is less than 300).",
"",
"All Events have the same response format:",
"```",
"Status: 200 OK",
"Link: <https://api.github.com/resource?page=2>; rel=\"next\",",
" <https://api.github.com/resource?page=5>; rel=\"last\"",
"```",
"",
"```",
"[",
" {",
" \"type\": \"Event\",",
" \"public\": true,",
" \"payload\": {",
" },",
" \"repo\": {",
" \"id\": 3,",
" \"name\": \"octocat/Hello-World\",",
" \"url\": \"https://api.github.com/repos/octocat/Hello-World\"",
" },",
" \"actor\": {",
" \"id\": 1,",
" \"login\": \"octocat\",",
" \"gravatar_id\": \"\",",
" \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",",
" \"url\": \"https://api.github.com/users/octocat\"",
" },",
" \"org\": {",
" \"id\": 1,",
" \"login\": \"github\",",
" \"gravatar_id\": \"\",",
" \"url\": \"https://api.github.com/orgs/github\",",
" \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\"",
" },",
" \"created_at\": \"2011-09-06T17:26:27Z\",",
" \"id\": \"12345\"",
" }",
"]",
"```",
"",
"# [Feeds](https://developer.github.com/v3/activity/feeds/)",
"",
"no description",
"",
"# [Notifications](https://developer.github.com/v3/activity/notifications/)",
"",
"Users receive notifications for conversations in repositories they watch including:",
"- Issues and their comments",
"- Pull Requests and their comments",
"- Comments on any commits",
"",
"Notifications are also sent for conversations in unwatched repositories when the user is involved including:",
"- **@mentions**",
"- Issue assignments",
"- Commits the user authors or commits",
"- Any discussion in which the user actively participates",
"",
"All Notification API calls require the ```notifications``` or ```repo``` API scopes. Doing this will give read-only access to some Issue/Commit content. You will still need the \"repo\" scope to access Issues and Commits from their respective endpoints.",
"",
"Notifications come back as \"threads\". A Thread contains information about the current discussion of an Issue/PullRequest/Commit.",
"",
"Notifications are optimized for polling with the \"Last-Modified\" header. If there are no new notifications, you will see a \"304 Not Modified\" response, leaving your current rate limit untouched. There is an \"X-Poll-Interval\" header that specifies how often (in seconds) you are allowed to poll. In times of high server load, the time may increase. Please obey the header.",
"```",
"# Add authentication to your requests",
"curl -I https://api.github.com/notifications",
"HTTP/1.1 200 OK",
"Last-Modified: Thu, 25 Oct 2012 15:16:27 GMT",
"X-Poll-Interval: 60",
"# Pass the Last-Modified header exactly",
"curl -I https://api.github.com/notifications",
" -H \"If-Modified-Since: Thu, 25 Oct 2012 15:16:27 GMT\"",
"HTTP/1.1 304 Not Modified",
"X-Poll-Interval: 60",
"```",
"",
"# [Starring](https://developer.github.com/v3/activity/starring/)",
"",
"Repository Starring is a feature that lets users bookmark repositories. Stars are shown next to repositories to show an approximate level of interest. Stars have no effect on notifications or the activity feed. For that, see [Repository Watching](https://developer.github.com/v3/activity/watching).",
"",
"#### Starring vs. Watching",
"",
"In August 2012, we [changed the way watching works](https://github.com/blog/1204-notifications-stars) on GitHub. Many API client applications may be using the original \"watcher\" endpoints for accessing this data. You can now start using the \"star\" endpoints instead (described below). Check out the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) for more details.",
"",
"# [Watching](https://developer.github.com/v3/activity/watching/)",
"",
"Watching a Repository registers the user to receive notifications on new discussions, as well as events in the user's activity feed. See [Repository Starring](https://developer.github.com/v3/activity/starring) for simple repository bookmarks.",
"",
"#### Watching vs. Starring",
"",
"In August 2012, we [changed the way watching works](https://github.com/blog/1204-notifications-stars) on GitHub. At the time of that change, many API clients were already using the existing \"watcher\" endpoints to access starring data. To avoid breaking those applications, the legacy \"watcher\" endpoints continue to provide starring data.",
"",
"To provide access to watching data, the v3 Watcher API uses the \"subscription\" endpoints described below. Check out the [Watcher API Change post](https://developer.github.com/changes/2012-09-05-watcher-api/) for more details."
]
},
{
"name": "github-apps",
"x-swgg-descriptionLineList": [
"# [GitHub Apps](https://developer.github.com/v3/apps/)",
"",
"For information on how to authenticate as a GitHub App, see \"[Authentication Options for GitHub Apps](https://developer.github.com/apps/building-github-apps/authentication-options-for-github-apps#authenticating-as-a-github-app).\"",
"",
"**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.",
"",
"```",
"application/vnd.github.machine-man-preview+json",
"```",
"",
"# [GitHub App Permissions](https://developer.github.com/v3/apps/permissions/)",
"",
"**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.",
"",
"```",
"application/vnd.github.machine-man-preview+json",
"```",
"",
"GitHub Apps are created with a set of permissions. These define what resources the GitHub App can access via the API. For more information, see \"[Permissions for GitHub Apps](https://developer.github.com/apps/building-github-apps/permissions-for-github-apps/).\"",
"",
"# [GitHub Apps: Available Endpoints](https://developer.github.com/v3/apps/available-endpoints/)",
"",
"**Note:** To access the API with your integration, you must provide a custom [media type](https://developer.github.com/v3/media) in the ```Accept``` Header for your requests.",
"",
"```",
"application/vnd.github.machine-man-preview+json",
"```",
"",
"The following endpoints are available for use by GitHub Apps. For more information, see \"[GitHub Apps](https://developer.github.com/apps/building-github-apps/).\"",
"",
"#### Users",
"- [Get a single user](https://developer.github.com/v3/users/#get-a-single-user)",
"- [Get all users](https://developer.github.com/v3/users/#get-all-users)",
"",
"#### Miscellaneous",
"- [Emojis](https://developer.github.com/v3/misc/#emojis)",
"",
"#### Rate Limit",
"- [Get your current rate limit status](https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status)",
"",
"#### Public Keys",
"- [List public keys for a user](https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user)",
"",
"#### GPG Keys",
"- [List GPG keys for a user](https://developer.github.com/v3/users/gpg_keys/#list-gpg-keys-for-a-user)",
"",
"#### Followers",
"- [List followers of a user](https://developer.github.com/v3/users/followers/#list-followers-of-a-user)",
"- [List users followed by another user](https://developer.github.com/v3/users/followers/#list-users-followed-by-another-user)",
"- [Check if one user follows another](https://developer.github.com/v3/users/followers/#check-if-one-user-follows-another)",
"",
"#### Reactions",
"- [List reactions for a commit comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment)",
"- [List reactions for an issue](https://developer.github.com/v3/reactions/#list-reactions-for-an-issue)",
"- [List reactions for an issue comment](https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment)",
"- [List reactions for a pull request review comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment)",
"- [List reactions for a team discussion](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion)",
"- [List reactions for a team discussion comment](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment)",
"",
"#### Codes of Conduct",
"- [List all codes of conduct](https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct)",
"- [Get an individual code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct)",
"- [Get a repository's code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-a-repositorys-code-of-conduct)",
"- [Get the contents of a repository's code of conduct](https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct)",
"",
"#### Watching",
"- [List watchers](https://developer.github.com/v3/activity/watching/#list-watchers)",
"",
"#### Feeds",
"- [List Feeds](https://developer.github.com/v3/activity/feeds/#list-feeds)",
"",
"#### Starring",
"- [List Stargazers](https://developer.github.com/v3/activity/starring/#list-stargazers)",
"",
"#### Events",
"- [List public events](https://developer.github.com/v3/activity/events/#list-public-events)",
"- [List repository events](https://developer.github.com/v3/activity/events/#list-repository-events)",
"- [List public events for a network of repositories](https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories)",
"- [List public events for an organization](https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization)",
"- [List events that a user has received](https://developer.github.com/v3/activity/events/#list-events-that-a-user-has-received)",
"- [List public events that a user has received](https://developer.github.com/v3/activity/events/#list-public-events-that-a-user-has-received)",
"- [List events performed by a user](https://developer.github.com/v3/activity/events/#list-events-performed-by-a-user)",
"- [List public events performed by a user](https://developer.github.com/v3/activity/events/#list-public-events-performed-by-a-user)",
"- [List events for an issue](https://developer.github.com/v3/issues/events/#list-events-for-an-issue)",
"- [List events for a repository](https://developer.github.com/v3/issues/events/#list-events-for-a-repository)",
"- [Get a single event](https://developer.github.com/v3/issues/events/#get-a-single-event)",
"",
"#### Overview",
"- [Root endpoint](https://developer.github.com/v3/#root-endpoint)",
"",
"#### Pull Requests",
"- [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)",
"- [Get a single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request)",
"- [Create a pull request](https://developer.github.com/v3/pulls/#create-a-pull-request)",
"- [Update a pull request](https://developer.github.com/v3/pulls/#update-a-pull-request)",
"- [List commits on a pull request](https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request)",
"- [List pull requests files](https://developer.github.com/v3/pulls/#list-pull-requests-files)",
"- [Get if a pull request has been merged](https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged)",
"- [Merge a pull request (Merge Button)](https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button)",
"",
"#### Emojis",
"- [Emojis](https://developer.github.com/v3/emojis/#emojis)",
"",
"#### Milestones",
"- [List milestones for a repository](https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository)",
"- [Get a single milestone](https://developer.github.com/v3/issues/milestones/#get-a-single-milestone)",
"- [Create a milestone](https://developer.github.com/v3/issues/milestones/#create-a-milestone)",
"- [Update a milestone](https://developer.github.com/v3/issues/milestones/#update-a-milestone)",
"- [Delete a milestone](https://developer.github.com/v3/issues/milestones/#delete-a-milestone)",
"",
"#### Assignees",
"- [List assignees](https://developer.github.com/v3/issues/assignees/#list-assignees)",
"- [Check assignee](https://developer.github.com/v3/issues/assignees/#check-assignee)",
"- [Add assignees to an issue](https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue)",
"- [Remove assignees from an issue](https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue)",
"",
"#### Timeline",
"- [List events for an issue](https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue)",
"",
"#### Comments",
"- [List comments on an issue](https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue)",
"- [List comments in a repository](https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository)",
"- [Get a single comment](https://developer.github.com/v3/issues/comments/#get-a-single-comment)",
"- [Create a comment](https://developer.github.com/v3/issues/comments/#create-a-comment)",
"- [Edit a comment](https://developer.github.com/v3/issues/comments/#edit-a-comment)",
"- [Delete a comment](https://developer.github.com/v3/issues/comments/#delete-a-comment)",
"- [List commit comments for a repository](https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository)",
"- [List comments for a single commit](https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit)",
"- [Create a commit comment](https://developer.github.com/v3/repos/comments/#create-a-commit-comment)",
"- [Get a single commit comment](https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment)",
"- [Update a commit comment](https://developer.github.com/v3/repos/comments/#update-a-commit-comment)",
"- [Delete a commit comment](https://developer.github.com/v3/repos/comments/#delete-a-commit-comment)",
"",
"#### Labels",
"- [List all labels for this repository](https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository)",
"- [Get a single label](https://developer.github.com/v3/issues/labels/#get-a-single-label)",
"- [Create a label](https://developer.github.com/v3/issues/labels/#create-a-label)",
"- [Update a label](https://developer.github.com/v3/issues/labels/#update-a-label)",
"- [Delete a label](https://developer.github.com/v3/issues/labels/#delete-a-label)",
"- [List labels on an issue](https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue)",
"- [Add labels to an issue](https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue)",
"- [Remove a label from an issue](https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue)",
"- [Replace all labels for an issue](https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue)",
"- [Remove all labels from an issue](https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue)",
"- [Get labels for every issue in a milestone](https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone)",
"",
"#### Source Imports",
"- [Start an import](https://developer.github.com/v3/migration/source_imports/#start-an-import)",
"- [Get import progress](https://developer.github.com/v3/migration/source_imports/#get-import-progress)",
"- [Update existing import](https://developer.github.com/v3/migration/source_imports/#update-existing-import)",
"- [Get commit authors](https://developer.github.com/v3/migration/source_imports/#get-commit-authors)",
"- [Map a commit author](https://developer.github.com/v3/migration/source_imports/#map-a-commit-author)",
"- [Set Git LFS preference](https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference)",
"- [Get large files](https://developer.github.com/v3/migration/source_imports/#get-large-files)",
"- [Cancel an import](https://developer.github.com/v3/migration/source_imports/#cancel-an-import)",
"",
"#### Teams",
"- [List teams](https://developer.github.com/v3/teams/#list-teams)",
"- [Get team](https://developer.github.com/v3/teams/#get-team)",
"- [Create team](https://developer.github.com/v3/teams/#create-team)",
"- [Edit team](https://developer.github.com/v3/teams/#edit-team)",
"- [Delete team](https://developer.github.com/v3/teams/#delete-team)",
"- [List child teams](https://developer.github.com/v3/teams/#list-child-teams)",
"- [List team repos](https://developer.github.com/v3/teams/#list-team-repos)",
"- [Check if a team manages a repository](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository)",
"",
"#### Markdown",
"- [Render an arbitrary Markdown document](https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document)",
"- [Render a Markdown document in raw mode](https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode)",
"",
"#### Meta",
"- [Meta](https://developer.github.com/v3/meta/#meta)",
"",
"#### Review Requests",
"- [List review requests](https://developer.github.com/v3/pulls/review_requests/#list-review-requests)",
"- [Create a review request](https://developer.github.com/v3/pulls/review_requests/#create-a-review-request)",
"- [Delete a review request](https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request)",
"",
"#### Reviews",
"- [List reviews on a pull request](https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request)",
"- [Get a single review](https://developer.github.com/v3/pulls/reviews/#get-a-single-review)",
"- [Delete a pending review](https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review)",
"- [Get comments for a single review](https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review)",
"- [Create a pull request review](https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review)",
"- [Submit a pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review)",
"- [Dismiss a pull request review](https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review)",
"",
"#### Review Comments",
"- [List comments on a pull request](https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request)",
"- [List comments in a repository](https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository)",
"- [Get a single comment](https://developer.github.com/v3/pulls/comments/#get-a-single-comment)",
"- [Create a comment](https://developer.github.com/v3/pulls/comments/#create-a-comment)",
"- [Edit a comment](https://developer.github.com/v3/pulls/comments/#edit-a-comment)",
"- [Delete a comment](https://developer.github.com/v3/pulls/comments/#delete-a-comment)",
"",
"#### GitHub Apps",
"- [Get a single GitHub App](https://developer.github.com/v3/apps/#get-a-single-github-app)",
"- [Get the authenticated GitHub App](https://developer.github.com/v3/apps/#get-the-authenticated-github-app)",
"- [Find installations](https://developer.github.com/v3/apps/#find-installations)",
"- [Get a single installation](https://developer.github.com/v3/apps/#get-a-single-installation)",
"- [Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)",
"",
"#### Installations",
"- [List repositories](https://developer.github.com/v3/apps/installations/#list-repositories)",
"",
"#### Repositories",
"- [List user repositories](https://developer.github.com/v3/repos/#list-user-repositories)",
"- [List organization repositories](https://developer.github.com/v3/repos/#list-organization-repositories)",
"- [List all public repositories](https://developer.github.com/v3/repos/#list-all-public-repositories)",
"- [Create](https://developer.github.com/v3/repos/#create)",
"- [Get](https://developer.github.com/v3/repos/#get)",
"- [Edit](https://developer.github.com/v3/repos/#edit)",
"- [List all topics for a repository](https://developer.github.com/v3/repos/#list-all-topics-for-a-repository)",
"- [Replace all topics for a repository](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository)",
"- [List contributors](https://developer.github.com/v3/repos/#list-contributors)",
"- [List languages](https://developer.github.com/v3/repos/#list-languages)",
"- [List teams](https://developer.github.com/v3/repos/#list-teams)",
"- [List tags](https://developer.github.com/v3/repos/#list-tags)",
"- [Delete a repository](https://developer.github.com/v3/repos/#delete-a-repository)",
"",
"#### Git Commits",
"- [Get a commit](https://developer.github.com/v3/git/commits/#get-a-commit)",
"- [Create a commit](https://developer.github.com/v3/git/commits/#create-a-commit)",
"",
"#### Git Blobs",
"- [Get a blob](https://developer.github.com/v3/git/blobs/#get-a-blob)",
"- [Create a blob](https://developer.github.com/v3/git/blobs/#create-a-blob)",
"",
"#### Git Tags",
"- [Get a tag](https://developer.github.com/v3/git/tags/#get-a-tag)",
"- [Create a tag object](https://developer.github.com/v3/git/tags/#create-a-tag-object)",
"",
"#### Git Trees",
"- [Get a tree](https://developer.github.com/v3/git/trees/#get-a-tree)",
"- [Create a tree](https://developer.github.com/v3/git/trees/#create-a-tree)",
"",
"#### Git References",
"- [Get a reference](https://developer.github.com/v3/git/refs/#get-a-reference)",
"- [Get all references](https://developer.github.com/v3/git/refs/#get-all-references)",
"- [Create a reference](https://developer.github.com/v3/git/refs/#create-a-reference)",
"- [Update a reference](https://developer.github.com/v3/git/refs/#update-a-reference)",
"- [Delete a reference](https://developer.github.com/v3/git/refs/#delete-a-reference)",
"",
"#### Gitignore",
"- [Listing available templates](https://developer.github.com/v3/gitignore/#listing-available-templates)",
"- [Get a single template](https://developer.github.com/v3/gitignore/#get-a-single-template)",
"",
"#### Projects",
"- [List repository projects](https://developer.github.com/v3/projects/#list-repository-projects)",
"- [List organization projects](https://developer.github.com/v3/projects/#list-organization-projects)",
"- [Get a project](https://developer.github.com/v3/projects/#get-a-project)",
"- [Create a repository project](https://developer.github.com/v3/projects/#create-a-repository-project)",
"- [Create an organization project](https://developer.github.com/v3/projects/#create-an-organization-project)",
"- [Update a project](https://developer.github.com/v3/projects/#update-a-project)",