gitabu 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (104) hide show
  1. checksums.yaml +7 -0
  2. data/.rspec +3 -0
  3. data/.rubocop.yml +33 -0
  4. data/CHANGELOG.md +3 -0
  5. data/Gemfile +10 -0
  6. data/Gemfile.lock +65 -0
  7. data/LICENSE.txt +21 -0
  8. data/README.md +42 -0
  9. data/Rakefile +12 -0
  10. data/gitabu.gemspec +41 -0
  11. data/lib/gitabu/api/v3/actions.rb +3724 -0
  12. data/lib/gitabu/api/v3/activity.rb +835 -0
  13. data/lib/gitabu/api/v3/apps.rb +961 -0
  14. data/lib/gitabu/api/v3/billing.rb +217 -0
  15. data/lib/gitabu/api/v3/branches.rb +1098 -0
  16. data/lib/gitabu/api/v3/checks.rb +384 -0
  17. data/lib/gitabu/api/v3/code_scanning.rb +315 -0
  18. data/lib/gitabu/api/v3/codes_of_conduct.rb +92 -0
  19. data/lib/gitabu/api/v3/codespaces.rb +650 -0
  20. data/lib/gitabu/api/v3/collaborators.rb +341 -0
  21. data/lib/gitabu/api/v3/commits.rb +428 -0
  22. data/lib/gitabu/api/v3/dependabot.rb +419 -0
  23. data/lib/gitabu/api/v3/deploy_keys.rb +152 -0
  24. data/lib/gitabu/api/v3/deployments.rb +356 -0
  25. data/lib/gitabu/api/v3/emojis.rb +67 -0
  26. data/lib/gitabu/api/v3/enterprise_admin.rb +495 -0
  27. data/lib/gitabu/api/v3/gists.rb +552 -0
  28. data/lib/gitabu/api/v3/git.rb +409 -0
  29. data/lib/gitabu/api/v3/gitignore.rb +92 -0
  30. data/lib/gitabu/api/v3/interactions.rb +275 -0
  31. data/lib/gitabu/api/v3/issues.rb +1119 -0
  32. data/lib/gitabu/api/v3/licenses.rb +118 -0
  33. data/lib/gitabu/api/v3/markdown.rb +94 -0
  34. data/lib/gitabu/api/v3/meta.rb +142 -0
  35. data/lib/gitabu/api/v3/metrics.rb +302 -0
  36. data/lib/gitabu/api/v3/migrations.rb +631 -0
  37. data/lib/gitabu/api/v3/orgs.rb +1291 -0
  38. data/lib/gitabu/api/v3/packages.rb +686 -0
  39. data/lib/gitabu/api/v3/pages.rb +282 -0
  40. data/lib/gitabu/api/v3/projects.rb +693 -0
  41. data/lib/gitabu/api/v3/pulls.rb +816 -0
  42. data/lib/gitabu/api/v3/rate_limit.rb +67 -0
  43. data/lib/gitabu/api/v3/reactions.rb +734 -0
  44. data/lib/gitabu/api/v3/releases.rb +411 -0
  45. data/lib/gitabu/api/v3/repos.rb +1136 -0
  46. data/lib/gitabu/api/v3/scim.rb +214 -0
  47. data/lib/gitabu/api/v3/search.rb +217 -0
  48. data/lib/gitabu/api/v3/secret_scanning.rb +201 -0
  49. data/lib/gitabu/api/v3/teams.rb +1963 -0
  50. data/lib/gitabu/api/v3/users.rb +851 -0
  51. data/lib/gitabu/api/v3/webhooks.rb +379 -0
  52. data/lib/gitabu/builder.rb +37 -0
  53. data/lib/gitabu/client.rb +8 -0
  54. data/lib/gitabu/generator.rb +75 -0
  55. data/lib/gitabu/http_client.rb +96 -0
  56. data/lib/gitabu/items.rb +110 -0
  57. data/lib/gitabu/public/api/v3/actions.json +5779 -0
  58. data/lib/gitabu/public/api/v3/activity.json +1248 -0
  59. data/lib/gitabu/public/api/v3/apps.json +1174 -0
  60. data/lib/gitabu/public/api/v3/billing.json +183 -0
  61. data/lib/gitabu/public/api/v3/branches.json +1886 -0
  62. data/lib/gitabu/public/api/v3/checks.json +856 -0
  63. data/lib/gitabu/public/api/v3/code_scanning.json +666 -0
  64. data/lib/gitabu/public/api/v3/codes_of_conduct.json +41 -0
  65. data/lib/gitabu/public/api/v3/codespaces.json +884 -0
  66. data/lib/gitabu/public/api/v3/collaborators.json +464 -0
  67. data/lib/gitabu/public/api/v3/commits.json +830 -0
  68. data/lib/gitabu/public/api/v3/dependabot.json +596 -0
  69. data/lib/gitabu/public/api/v3/deploy_keys.json +195 -0
  70. data/lib/gitabu/public/api/v3/deployments.json +698 -0
  71. data/lib/gitabu/public/api/v3/emojis.json +18 -0
  72. data/lib/gitabu/public/api/v3/enterprise_admin.json +881 -0
  73. data/lib/gitabu/public/api/v3/gists.json +689 -0
  74. data/lib/gitabu/public/api/v3/git.json +735 -0
  75. data/lib/gitabu/public/api/v3/gitignore.json +41 -0
  76. data/lib/gitabu/public/api/v3/interactions.json +265 -0
  77. data/lib/gitabu/public/api/v3/issues.json +2359 -0
  78. data/lib/gitabu/public/api/v3/licenses.json +100 -0
  79. data/lib/gitabu/public/api/v3/markdown.json +59 -0
  80. data/lib/gitabu/public/api/v3/meta.json +69 -0
  81. data/lib/gitabu/public/api/v3/metrics.json +342 -0
  82. data/lib/gitabu/public/api/v3/migrations.json +960 -0
  83. data/lib/gitabu/public/api/v3/orgs.json +1989 -0
  84. data/lib/gitabu/public/api/v3/packages.json +1078 -0
  85. data/lib/gitabu/public/api/v3/pages.json +373 -0
  86. data/lib/gitabu/public/api/v3/projects.json +966 -0
  87. data/lib/gitabu/public/api/v3/pulls.json +1768 -0
  88. data/lib/gitabu/public/api/v3/rate_limit.json +18 -0
  89. data/lib/gitabu/public/api/v3/reactions.json +1425 -0
  90. data/lib/gitabu/public/api/v3/releases.json +753 -0
  91. data/lib/gitabu/public/api/v3/repos.json +2314 -0
  92. data/lib/gitabu/public/api/v3/scim.json +412 -0
  93. data/lib/gitabu/public/api/v3/search.json +408 -0
  94. data/lib/gitabu/public/api/v3/secret_scanning.json +385 -0
  95. data/lib/gitabu/public/api/v3/teams.json +3126 -0
  96. data/lib/gitabu/public/api/v3/users.json +956 -0
  97. data/lib/gitabu/public/api/v3/webhooks.json +667 -0
  98. data/lib/gitabu/run.rb +237 -0
  99. data/lib/gitabu/scraper.rb +86 -0
  100. data/lib/gitabu/templates/template.rb.erb +70 -0
  101. data/lib/gitabu/version.rb +6 -0
  102. data/lib/gitabu.rb +57 -0
  103. data/sig/gitabu.rbs +4 -0
  104. metadata +177 -0
@@ -0,0 +1,1989 @@
1
+ {
2
+ "result": [
3
+ {
4
+ "namespace_description": "List organizations",
5
+ "method": "get",
6
+ "endpoint": "/organizations",
7
+ "field_0": {
8
+ "field_type": "header",
9
+ "fields": {
10
+ "name": "accept",
11
+ "type": "string",
12
+ "in": "header",
13
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
14
+ }
15
+ },
16
+ "field_1": {
17
+ "field_type": "query",
18
+ "fields": {
19
+ "name": "since",
20
+ "type": "integer",
21
+ "in": "query",
22
+ "description": "An organization ID. Only return organizations with an ID greater than this ID."
23
+ }
24
+ },
25
+ "field_2": {
26
+ "field_type": "query",
27
+ "fields": {
28
+ "name": "per_page",
29
+ "type": "integer",
30
+ "in": "query",
31
+ "description": "Results per page (max 100)Default: 30"
32
+ }
33
+ }
34
+ },
35
+ {
36
+ "namespace_description": "Get an organization",
37
+ "method": "get",
38
+ "endpoint": "/orgs/{org}",
39
+ "field_0": {
40
+ "field_type": "header",
41
+ "fields": {
42
+ "name": "accept",
43
+ "type": "string",
44
+ "in": "header",
45
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
46
+ }
47
+ },
48
+ "field_1": {
49
+ "field_type": "path",
50
+ "fields": {
51
+ "name": "org",
52
+ "type": "string",
53
+ "in": "path",
54
+ "description": ""
55
+ }
56
+ }
57
+ },
58
+ {
59
+ "namespace_description": "Update an organization",
60
+ "method": "patch",
61
+ "endpoint": "/orgs/{org}",
62
+ "field_0": {
63
+ "field_type": "header",
64
+ "fields": {
65
+ "name": "accept",
66
+ "type": "string",
67
+ "in": "header",
68
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
69
+ }
70
+ },
71
+ "field_1": {
72
+ "field_type": "path",
73
+ "fields": {
74
+ "name": "org",
75
+ "type": "string",
76
+ "in": "path",
77
+ "description": ""
78
+ }
79
+ },
80
+ "field_2": {
81
+ "field_type": "body",
82
+ "fields": {
83
+ "name": "billing_email",
84
+ "type": "string",
85
+ "in": "body",
86
+ "description": "Billing email address. This address is not publicized."
87
+ }
88
+ },
89
+ "field_3": {
90
+ "field_type": "body",
91
+ "fields": {
92
+ "name": "company",
93
+ "type": "string",
94
+ "in": "body",
95
+ "description": "The company name."
96
+ }
97
+ },
98
+ "field_4": {
99
+ "field_type": "body",
100
+ "fields": {
101
+ "name": "email",
102
+ "type": "string",
103
+ "in": "body",
104
+ "description": "The publicly visible email address."
105
+ }
106
+ },
107
+ "field_5": {
108
+ "field_type": "body",
109
+ "fields": {
110
+ "name": "twitter_username",
111
+ "type": "string",
112
+ "in": "body",
113
+ "description": "The Twitter username of the company."
114
+ }
115
+ },
116
+ "field_6": {
117
+ "field_type": "body",
118
+ "fields": {
119
+ "name": "location",
120
+ "type": "string",
121
+ "in": "body",
122
+ "description": "The location."
123
+ }
124
+ },
125
+ "field_7": {
126
+ "field_type": "body",
127
+ "fields": {
128
+ "name": "name",
129
+ "type": "string",
130
+ "in": "body",
131
+ "description": "The shorthand name of the company."
132
+ }
133
+ },
134
+ "field_8": {
135
+ "field_type": "body",
136
+ "fields": {
137
+ "name": "description",
138
+ "type": "string",
139
+ "in": "body",
140
+ "description": "The description of the company."
141
+ }
142
+ },
143
+ "field_9": {
144
+ "field_type": "body",
145
+ "fields": {
146
+ "name": "has_organization_projects",
147
+ "type": "boolean",
148
+ "in": "body",
149
+ "description": "Toggles whether an organization can use organization projects."
150
+ }
151
+ },
152
+ "field_10": {
153
+ "field_type": "body",
154
+ "fields": {
155
+ "name": "has_repository_projects",
156
+ "type": "boolean",
157
+ "in": "body",
158
+ "description": "Toggles whether repositories that belong to the organization can use repository projects."
159
+ }
160
+ },
161
+ "field_11": {
162
+ "field_type": "body",
163
+ "fields": {
164
+ "name": "default_repository_permission",
165
+ "type": "string",
166
+ "in": "body",
167
+ "description": "Default permission level members have for organization repositories:\n* read - can pull, but not push to or administer this repository.\n* write - can pull and push, but not administer this repository.\n* admin - can pull, push, and administer this repository.\n* none - no permissions granted by default.Default: read"
168
+ }
169
+ },
170
+ "field_12": {
171
+ "field_type": "body",
172
+ "fields": {
173
+ "name": "members_can_create_repositories",
174
+ "type": "boolean",
175
+ "in": "body",
176
+ "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of:\n* true - all organization members can create repositories.\n* false - only organization owners can create repositories.\nDefault: true\nNote: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.Default: "
177
+ }
178
+ },
179
+ "field_13": {
180
+ "field_type": "body",
181
+ "fields": {
182
+ "name": "members_can_create_internal_repositories",
183
+ "type": "boolean",
184
+ "in": "body",
185
+ "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:\n* true - all organization members can create internal repositories.\n* false - only organization owners can create internal repositories.\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation."
186
+ }
187
+ },
188
+ "field_14": {
189
+ "field_type": "body",
190
+ "fields": {
191
+ "name": "members_can_create_private_repositories",
192
+ "type": "boolean",
193
+ "in": "body",
194
+ "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:\n* true - all organization members can create private repositories.\n* false - only organization owners can create private repositories.\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation."
195
+ }
196
+ },
197
+ "field_15": {
198
+ "field_type": "body",
199
+ "fields": {
200
+ "name": "members_can_create_public_repositories",
201
+ "type": "boolean",
202
+ "in": "body",
203
+ "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:\n* true - all organization members can create public repositories.\n* false - only organization owners can create public repositories.\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation."
204
+ }
205
+ },
206
+ "field_16": {
207
+ "field_type": "body",
208
+ "fields": {
209
+ "name": "members_allowed_repository_creation_type",
210
+ "type": "string",
211
+ "in": "body",
212
+ "description": "Specifies which types of repositories non-admin organization members can create. Can be one of:\n* all - all organization members can create public and private repositories.\n* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.\n* none - only admin members can create repositories.\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details."
213
+ }
214
+ },
215
+ "field_17": {
216
+ "field_type": "body",
217
+ "fields": {
218
+ "name": "members_can_create_pages",
219
+ "type": "boolean",
220
+ "in": "body",
221
+ "description": "Toggles whether organization members can create GitHub Pages sites. Can be one of:\n* true - all organization members can create GitHub Pages sites.\n* false - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.Default: "
222
+ }
223
+ },
224
+ "field_18": {
225
+ "field_type": "body",
226
+ "fields": {
227
+ "name": "members_can_create_public_pages",
228
+ "type": "boolean",
229
+ "in": "body",
230
+ "description": "Toggles whether organization members can create public GitHub Pages sites. Can be one of:\n* true - all organization members can create public GitHub Pages sites.\n* false - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.Default: "
231
+ }
232
+ },
233
+ "field_19": {
234
+ "field_type": "body",
235
+ "fields": {
236
+ "name": "members_can_create_private_pages",
237
+ "type": "boolean",
238
+ "in": "body",
239
+ "description": "Toggles whether organization members can create private GitHub Pages sites. Can be one of:\n* true - all organization members can create private GitHub Pages sites.\n* false - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.Default: "
240
+ }
241
+ },
242
+ "field_20": {
243
+ "field_type": "body",
244
+ "fields": {
245
+ "name": "members_can_fork_private_repositories",
246
+ "type": "boolean",
247
+ "in": "body",
248
+ "description": "Toggles whether organization members can fork private organization repositories. Can be one of:\n* true - all organization members can fork private repositories within the organization.\n* false - no organization members can fork private repositories within the organization."
249
+ }
250
+ },
251
+ "field_21": {
252
+ "field_type": "body",
253
+ "fields": {
254
+ "name": "blog",
255
+ "type": "string",
256
+ "in": "body",
257
+ "description": ""
258
+ }
259
+ }
260
+ },
261
+ {
262
+ "namespace_description": "Get the audit log for an organization",
263
+ "method": "get",
264
+ "endpoint": "/orgs/{org}/audit-log",
265
+ "field_0": {
266
+ "field_type": "header",
267
+ "fields": {
268
+ "name": "accept",
269
+ "type": "string",
270
+ "in": "header",
271
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
272
+ }
273
+ },
274
+ "field_1": {
275
+ "field_type": "path",
276
+ "fields": {
277
+ "name": "org",
278
+ "type": "string",
279
+ "in": "path",
280
+ "description": ""
281
+ }
282
+ },
283
+ "field_2": {
284
+ "field_type": "query",
285
+ "fields": {
286
+ "name": "phrase",
287
+ "type": "string",
288
+ "in": "query",
289
+ "description": "A search phrase. For more information, see Searching the audit log."
290
+ }
291
+ },
292
+ "field_3": {
293
+ "field_type": "query",
294
+ "fields": {
295
+ "name": "include",
296
+ "type": "string",
297
+ "in": "query",
298
+ "description": "The event types to include:\n\nweb - returns web (non-Git) events.\ngit - returns Git events.\nall - returns both web and Git events.\n\nThe default is web."
299
+ }
300
+ },
301
+ "field_4": {
302
+ "field_type": "query",
303
+ "fields": {
304
+ "name": "after",
305
+ "type": "string",
306
+ "in": "query",
307
+ "description": "A cursor, as given in the Link header. If specified, the query only searches for events after this cursor."
308
+ }
309
+ },
310
+ "field_5": {
311
+ "field_type": "query",
312
+ "fields": {
313
+ "name": "before",
314
+ "type": "string",
315
+ "in": "query",
316
+ "description": "A cursor, as given in the Link header. If specified, the query only searches for events before this cursor."
317
+ }
318
+ },
319
+ "field_6": {
320
+ "field_type": "query",
321
+ "fields": {
322
+ "name": "order",
323
+ "type": "string",
324
+ "in": "query",
325
+ "description": "The order of audit log events. To list newest events first, specify desc. To list oldest events first, specify asc.\nThe default is desc."
326
+ }
327
+ },
328
+ "field_7": {
329
+ "field_type": "query",
330
+ "fields": {
331
+ "name": "per_page",
332
+ "type": "integer",
333
+ "in": "query",
334
+ "description": "Results per page (max 100)Default: 30"
335
+ }
336
+ }
337
+ },
338
+ {
339
+ "namespace_description": "List SAML SSO authorizations for an organization",
340
+ "method": "get",
341
+ "endpoint": "/orgs/{org}/credential-authorizations",
342
+ "field_0": {
343
+ "field_type": "header",
344
+ "fields": {
345
+ "name": "accept",
346
+ "type": "string",
347
+ "in": "header",
348
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
349
+ }
350
+ },
351
+ "field_1": {
352
+ "field_type": "path",
353
+ "fields": {
354
+ "name": "org",
355
+ "type": "string",
356
+ "in": "path",
357
+ "description": ""
358
+ }
359
+ },
360
+ "field_2": {
361
+ "field_type": "query",
362
+ "fields": {
363
+ "name": "per_page",
364
+ "type": "integer",
365
+ "in": "query",
366
+ "description": "Results per page (max 100)Default: 30"
367
+ }
368
+ },
369
+ "field_3": {
370
+ "field_type": "query",
371
+ "fields": {
372
+ "name": "page",
373
+ "type": "integer",
374
+ "in": "query",
375
+ "description": "Page token"
376
+ }
377
+ },
378
+ "field_4": {
379
+ "field_type": "query",
380
+ "fields": {
381
+ "name": "login",
382
+ "type": "string",
383
+ "in": "query",
384
+ "description": "Limits the list of credentials authorizations for an organization to a specific login"
385
+ }
386
+ }
387
+ },
388
+ {
389
+ "namespace_description": "Remove a SAML SSO authorization for an organization",
390
+ "method": "delete",
391
+ "endpoint": "/orgs/{org}/credential-authorizations/{credential_id}",
392
+ "field_0": {
393
+ "field_type": "header",
394
+ "fields": {
395
+ "name": "accept",
396
+ "type": "string",
397
+ "in": "header",
398
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
399
+ }
400
+ },
401
+ "field_1": {
402
+ "field_type": "path",
403
+ "fields": {
404
+ "name": "org",
405
+ "type": "string",
406
+ "in": "path",
407
+ "description": ""
408
+ }
409
+ },
410
+ "field_2": {
411
+ "field_type": "path",
412
+ "fields": {
413
+ "name": "credential_id",
414
+ "type": "integer",
415
+ "in": "path",
416
+ "description": ""
417
+ }
418
+ }
419
+ },
420
+ {
421
+ "namespace_description": "List app installations for an organization",
422
+ "method": "get",
423
+ "endpoint": "/orgs/{org}/installations",
424
+ "field_0": {
425
+ "field_type": "header",
426
+ "fields": {
427
+ "name": "accept",
428
+ "type": "string",
429
+ "in": "header",
430
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
431
+ }
432
+ },
433
+ "field_1": {
434
+ "field_type": "path",
435
+ "fields": {
436
+ "name": "org",
437
+ "type": "string",
438
+ "in": "path",
439
+ "description": ""
440
+ }
441
+ },
442
+ "field_2": {
443
+ "field_type": "query",
444
+ "fields": {
445
+ "name": "per_page",
446
+ "type": "integer",
447
+ "in": "query",
448
+ "description": "Results per page (max 100)Default: 30"
449
+ }
450
+ },
451
+ "field_3": {
452
+ "field_type": "query",
453
+ "fields": {
454
+ "name": "page",
455
+ "type": "integer",
456
+ "in": "query",
457
+ "description": "Page number of the results to fetch.Default: 1"
458
+ }
459
+ }
460
+ },
461
+ {
462
+ "namespace_description": "List organizations for the authenticated user",
463
+ "method": "get",
464
+ "endpoint": "/user/orgs",
465
+ "field_0": {
466
+ "field_type": "header",
467
+ "fields": {
468
+ "name": "accept",
469
+ "type": "string",
470
+ "in": "header",
471
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
472
+ }
473
+ },
474
+ "field_1": {
475
+ "field_type": "query",
476
+ "fields": {
477
+ "name": "per_page",
478
+ "type": "integer",
479
+ "in": "query",
480
+ "description": "Results per page (max 100)Default: 30"
481
+ }
482
+ },
483
+ "field_2": {
484
+ "field_type": "query",
485
+ "fields": {
486
+ "name": "page",
487
+ "type": "integer",
488
+ "in": "query",
489
+ "description": "Page number of the results to fetch.Default: 1"
490
+ }
491
+ }
492
+ },
493
+ {
494
+ "namespace_description": "List organizations for a user",
495
+ "method": "get",
496
+ "endpoint": "/users/{username}/orgs",
497
+ "field_0": {
498
+ "field_type": "header",
499
+ "fields": {
500
+ "name": "accept",
501
+ "type": "string",
502
+ "in": "header",
503
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
504
+ }
505
+ },
506
+ "field_1": {
507
+ "field_type": "path",
508
+ "fields": {
509
+ "name": "username",
510
+ "type": "string",
511
+ "in": "path",
512
+ "description": ""
513
+ }
514
+ },
515
+ "field_2": {
516
+ "field_type": "query",
517
+ "fields": {
518
+ "name": "per_page",
519
+ "type": "integer",
520
+ "in": "query",
521
+ "description": "Results per page (max 100)Default: 30"
522
+ }
523
+ },
524
+ "field_3": {
525
+ "field_type": "query",
526
+ "fields": {
527
+ "name": "page",
528
+ "type": "integer",
529
+ "in": "query",
530
+ "description": "Page number of the results to fetch.Default: 1"
531
+ }
532
+ }
533
+ },
534
+ {
535
+ "namespace_description": "List users blocked by an organization",
536
+ "method": "get",
537
+ "endpoint": "/orgs/{org}/blocks",
538
+ "field_0": {
539
+ "field_type": "header",
540
+ "fields": {
541
+ "name": "accept",
542
+ "type": "string",
543
+ "in": "header",
544
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
545
+ }
546
+ },
547
+ "field_1": {
548
+ "field_type": "path",
549
+ "fields": {
550
+ "name": "org",
551
+ "type": "string",
552
+ "in": "path",
553
+ "description": ""
554
+ }
555
+ }
556
+ },
557
+ {
558
+ "namespace_description": "Check if a user is blocked by an organization",
559
+ "method": "get",
560
+ "endpoint": "/orgs/{org}/blocks/{username}",
561
+ "field_0": {
562
+ "field_type": "header",
563
+ "fields": {
564
+ "name": "accept",
565
+ "type": "string",
566
+ "in": "header",
567
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
568
+ }
569
+ },
570
+ "field_1": {
571
+ "field_type": "path",
572
+ "fields": {
573
+ "name": "org",
574
+ "type": "string",
575
+ "in": "path",
576
+ "description": ""
577
+ }
578
+ },
579
+ "field_2": {
580
+ "field_type": "path",
581
+ "fields": {
582
+ "name": "username",
583
+ "type": "string",
584
+ "in": "path",
585
+ "description": ""
586
+ }
587
+ }
588
+ },
589
+ {
590
+ "namespace_description": "Block a user from an organization",
591
+ "method": "put",
592
+ "endpoint": "/orgs/{org}/blocks/{username}",
593
+ "field_0": {
594
+ "field_type": "header",
595
+ "fields": {
596
+ "name": "accept",
597
+ "type": "string",
598
+ "in": "header",
599
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
600
+ }
601
+ },
602
+ "field_1": {
603
+ "field_type": "path",
604
+ "fields": {
605
+ "name": "org",
606
+ "type": "string",
607
+ "in": "path",
608
+ "description": ""
609
+ }
610
+ },
611
+ "field_2": {
612
+ "field_type": "path",
613
+ "fields": {
614
+ "name": "username",
615
+ "type": "string",
616
+ "in": "path",
617
+ "description": ""
618
+ }
619
+ }
620
+ },
621
+ {
622
+ "namespace_description": "Unblock a user from an organization",
623
+ "method": "delete",
624
+ "endpoint": "/orgs/{org}/blocks/{username}",
625
+ "field_0": {
626
+ "field_type": "header",
627
+ "fields": {
628
+ "name": "accept",
629
+ "type": "string",
630
+ "in": "header",
631
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
632
+ }
633
+ },
634
+ "field_1": {
635
+ "field_type": "path",
636
+ "fields": {
637
+ "name": "org",
638
+ "type": "string",
639
+ "in": "path",
640
+ "description": ""
641
+ }
642
+ },
643
+ "field_2": {
644
+ "field_type": "path",
645
+ "fields": {
646
+ "name": "username",
647
+ "type": "string",
648
+ "in": "path",
649
+ "description": ""
650
+ }
651
+ }
652
+ },
653
+ {
654
+ "namespace_description": "List custom repository roles in an organization",
655
+ "method": "get",
656
+ "endpoint": "/organizations/{organization_id}/custom_roles",
657
+ "field_0": {
658
+ "field_type": "header",
659
+ "fields": {
660
+ "name": "accept",
661
+ "type": "string",
662
+ "in": "header",
663
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
664
+ }
665
+ },
666
+ "field_1": {
667
+ "field_type": "path",
668
+ "fields": {
669
+ "name": "organization_id",
670
+ "type": "string",
671
+ "in": "path",
672
+ "description": ""
673
+ }
674
+ }
675
+ },
676
+ {
677
+ "namespace_description": "List failed organization invitations",
678
+ "method": "get",
679
+ "endpoint": "/orgs/{org}/failed_invitations",
680
+ "field_0": {
681
+ "field_type": "header",
682
+ "fields": {
683
+ "name": "accept",
684
+ "type": "string",
685
+ "in": "header",
686
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
687
+ }
688
+ },
689
+ "field_1": {
690
+ "field_type": "path",
691
+ "fields": {
692
+ "name": "org",
693
+ "type": "string",
694
+ "in": "path",
695
+ "description": ""
696
+ }
697
+ },
698
+ "field_2": {
699
+ "field_type": "query",
700
+ "fields": {
701
+ "name": "per_page",
702
+ "type": "integer",
703
+ "in": "query",
704
+ "description": "Results per page (max 100)Default: 30"
705
+ }
706
+ },
707
+ "field_3": {
708
+ "field_type": "query",
709
+ "fields": {
710
+ "name": "page",
711
+ "type": "integer",
712
+ "in": "query",
713
+ "description": "Page number of the results to fetch.Default: 1"
714
+ }
715
+ }
716
+ },
717
+ {
718
+ "namespace_description": "List pending organization invitations",
719
+ "method": "get",
720
+ "endpoint": "/orgs/{org}/invitations",
721
+ "field_0": {
722
+ "field_type": "header",
723
+ "fields": {
724
+ "name": "accept",
725
+ "type": "string",
726
+ "in": "header",
727
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
728
+ }
729
+ },
730
+ "field_1": {
731
+ "field_type": "path",
732
+ "fields": {
733
+ "name": "org",
734
+ "type": "string",
735
+ "in": "path",
736
+ "description": ""
737
+ }
738
+ },
739
+ "field_2": {
740
+ "field_type": "query",
741
+ "fields": {
742
+ "name": "per_page",
743
+ "type": "integer",
744
+ "in": "query",
745
+ "description": "Results per page (max 100)Default: 30"
746
+ }
747
+ },
748
+ "field_3": {
749
+ "field_type": "query",
750
+ "fields": {
751
+ "name": "page",
752
+ "type": "integer",
753
+ "in": "query",
754
+ "description": "Page number of the results to fetch.Default: 1"
755
+ }
756
+ }
757
+ },
758
+ {
759
+ "namespace_description": "Create an organization invitation",
760
+ "method": "post",
761
+ "endpoint": "/orgs/{org}/invitations",
762
+ "field_0": {
763
+ "field_type": "header",
764
+ "fields": {
765
+ "name": "accept",
766
+ "type": "string",
767
+ "in": "header",
768
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
769
+ }
770
+ },
771
+ "field_1": {
772
+ "field_type": "path",
773
+ "fields": {
774
+ "name": "org",
775
+ "type": "string",
776
+ "in": "path",
777
+ "description": ""
778
+ }
779
+ },
780
+ "field_2": {
781
+ "field_type": "body",
782
+ "fields": {
783
+ "name": "invitee_id",
784
+ "type": "integer",
785
+ "in": "body",
786
+ "description": "Required unless you provide email. GitHub user ID for the person you are inviting."
787
+ }
788
+ },
789
+ "field_3": {
790
+ "field_type": "body",
791
+ "fields": {
792
+ "name": "email",
793
+ "type": "string",
794
+ "in": "body",
795
+ "description": "Required unless you provide invitee_id. Email address of the person you are inviting, which can be an existing GitHub user."
796
+ }
797
+ },
798
+ "field_4": {
799
+ "field_type": "body",
800
+ "fields": {
801
+ "name": "role",
802
+ "type": "string",
803
+ "in": "body",
804
+ "description": "Specify role for new member. Can be one of:\n* admin - Organization owners with full administrative rights to the organization and complete access to all repositories and teams.\n* direct_member - Non-owner organization members with ability to see other members and join teams by invitation.\n* billing_manager - Non-owner organization members with ability to manage the billing settings of your organization.Default: direct_member"
805
+ }
806
+ },
807
+ "field_5": {
808
+ "field_type": "body",
809
+ "fields": {
810
+ "name": "team_ids",
811
+ "type": "array of integers",
812
+ "in": "body",
813
+ "description": "Specify IDs for the teams you want to invite new members to."
814
+ }
815
+ }
816
+ },
817
+ {
818
+ "namespace_description": "Cancel an organization invitation",
819
+ "method": "delete",
820
+ "endpoint": "/orgs/{org}/invitations/{invitation_id}",
821
+ "field_0": {
822
+ "field_type": "header",
823
+ "fields": {
824
+ "name": "accept",
825
+ "type": "string",
826
+ "in": "header",
827
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
828
+ }
829
+ },
830
+ "field_1": {
831
+ "field_type": "path",
832
+ "fields": {
833
+ "name": "org",
834
+ "type": "string",
835
+ "in": "path",
836
+ "description": ""
837
+ }
838
+ },
839
+ "field_2": {
840
+ "field_type": "path",
841
+ "fields": {
842
+ "name": "invitation_id",
843
+ "type": "integer",
844
+ "in": "path",
845
+ "description": "invitation_id parameter"
846
+ }
847
+ }
848
+ },
849
+ {
850
+ "namespace_description": "List organization invitation teams",
851
+ "method": "get",
852
+ "endpoint": "/orgs/{org}/invitations/{invitation_id}/teams",
853
+ "field_0": {
854
+ "field_type": "header",
855
+ "fields": {
856
+ "name": "accept",
857
+ "type": "string",
858
+ "in": "header",
859
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
860
+ }
861
+ },
862
+ "field_1": {
863
+ "field_type": "path",
864
+ "fields": {
865
+ "name": "org",
866
+ "type": "string",
867
+ "in": "path",
868
+ "description": ""
869
+ }
870
+ },
871
+ "field_2": {
872
+ "field_type": "path",
873
+ "fields": {
874
+ "name": "invitation_id",
875
+ "type": "integer",
876
+ "in": "path",
877
+ "description": "invitation_id parameter"
878
+ }
879
+ },
880
+ "field_3": {
881
+ "field_type": "query",
882
+ "fields": {
883
+ "name": "per_page",
884
+ "type": "integer",
885
+ "in": "query",
886
+ "description": "Results per page (max 100)Default: 30"
887
+ }
888
+ },
889
+ "field_4": {
890
+ "field_type": "query",
891
+ "fields": {
892
+ "name": "page",
893
+ "type": "integer",
894
+ "in": "query",
895
+ "description": "Page number of the results to fetch.Default: 1"
896
+ }
897
+ }
898
+ },
899
+ {
900
+ "namespace_description": "List organization members",
901
+ "method": "get",
902
+ "endpoint": "/orgs/{org}/members",
903
+ "field_0": {
904
+ "field_type": "header",
905
+ "fields": {
906
+ "name": "accept",
907
+ "type": "string",
908
+ "in": "header",
909
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
910
+ }
911
+ },
912
+ "field_1": {
913
+ "field_type": "path",
914
+ "fields": {
915
+ "name": "org",
916
+ "type": "string",
917
+ "in": "path",
918
+ "description": ""
919
+ }
920
+ },
921
+ "field_2": {
922
+ "field_type": "query",
923
+ "fields": {
924
+ "name": "filter",
925
+ "type": "string",
926
+ "in": "query",
927
+ "description": "Filter members returned in the list. Can be one of:\n* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.\n* all - All members the authenticated user can see.Default: all"
928
+ }
929
+ },
930
+ "field_3": {
931
+ "field_type": "query",
932
+ "fields": {
933
+ "name": "role",
934
+ "type": "string",
935
+ "in": "query",
936
+ "description": "Filter members returned by their role. Can be one of:\n* all - All members of the organization, regardless of role.\n* admin - Organization owners.\n* member - Non-owner organization members.Default: all"
937
+ }
938
+ },
939
+ "field_4": {
940
+ "field_type": "query",
941
+ "fields": {
942
+ "name": "per_page",
943
+ "type": "integer",
944
+ "in": "query",
945
+ "description": "Results per page (max 100)Default: 30"
946
+ }
947
+ },
948
+ "field_5": {
949
+ "field_type": "query",
950
+ "fields": {
951
+ "name": "page",
952
+ "type": "integer",
953
+ "in": "query",
954
+ "description": "Page number of the results to fetch.Default: 1"
955
+ }
956
+ }
957
+ },
958
+ {
959
+ "namespace_description": "Check organization membership for a user",
960
+ "method": "get",
961
+ "endpoint": "/orgs/{org}/members/{username}",
962
+ "field_0": {
963
+ "field_type": "header",
964
+ "fields": {
965
+ "name": "accept",
966
+ "type": "string",
967
+ "in": "header",
968
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
969
+ }
970
+ },
971
+ "field_1": {
972
+ "field_type": "path",
973
+ "fields": {
974
+ "name": "org",
975
+ "type": "string",
976
+ "in": "path",
977
+ "description": ""
978
+ }
979
+ },
980
+ "field_2": {
981
+ "field_type": "path",
982
+ "fields": {
983
+ "name": "username",
984
+ "type": "string",
985
+ "in": "path",
986
+ "description": ""
987
+ }
988
+ }
989
+ },
990
+ {
991
+ "namespace_description": "Remove an organization member",
992
+ "method": "delete",
993
+ "endpoint": "/orgs/{org}/members/{username}",
994
+ "field_0": {
995
+ "field_type": "header",
996
+ "fields": {
997
+ "name": "accept",
998
+ "type": "string",
999
+ "in": "header",
1000
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1001
+ }
1002
+ },
1003
+ "field_1": {
1004
+ "field_type": "path",
1005
+ "fields": {
1006
+ "name": "org",
1007
+ "type": "string",
1008
+ "in": "path",
1009
+ "description": ""
1010
+ }
1011
+ },
1012
+ "field_2": {
1013
+ "field_type": "path",
1014
+ "fields": {
1015
+ "name": "username",
1016
+ "type": "string",
1017
+ "in": "path",
1018
+ "description": ""
1019
+ }
1020
+ }
1021
+ },
1022
+ {
1023
+ "namespace_description": "Get organization membership for a user",
1024
+ "method": "get",
1025
+ "endpoint": "/orgs/{org}/memberships/{username}",
1026
+ "field_0": {
1027
+ "field_type": "header",
1028
+ "fields": {
1029
+ "name": "accept",
1030
+ "type": "string",
1031
+ "in": "header",
1032
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1033
+ }
1034
+ },
1035
+ "field_1": {
1036
+ "field_type": "path",
1037
+ "fields": {
1038
+ "name": "org",
1039
+ "type": "string",
1040
+ "in": "path",
1041
+ "description": ""
1042
+ }
1043
+ },
1044
+ "field_2": {
1045
+ "field_type": "path",
1046
+ "fields": {
1047
+ "name": "username",
1048
+ "type": "string",
1049
+ "in": "path",
1050
+ "description": ""
1051
+ }
1052
+ }
1053
+ },
1054
+ {
1055
+ "namespace_description": "Set organization membership for a user",
1056
+ "method": "put",
1057
+ "endpoint": "/orgs/{org}/memberships/{username}",
1058
+ "field_0": {
1059
+ "field_type": "header",
1060
+ "fields": {
1061
+ "name": "accept",
1062
+ "type": "string",
1063
+ "in": "header",
1064
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1065
+ }
1066
+ },
1067
+ "field_1": {
1068
+ "field_type": "path",
1069
+ "fields": {
1070
+ "name": "org",
1071
+ "type": "string",
1072
+ "in": "path",
1073
+ "description": ""
1074
+ }
1075
+ },
1076
+ "field_2": {
1077
+ "field_type": "path",
1078
+ "fields": {
1079
+ "name": "username",
1080
+ "type": "string",
1081
+ "in": "path",
1082
+ "description": ""
1083
+ }
1084
+ },
1085
+ "field_3": {
1086
+ "field_type": "body",
1087
+ "fields": {
1088
+ "name": "role",
1089
+ "type": "string",
1090
+ "in": "body",
1091
+ "description": "The role to give the user in the organization. Can be one of:\n* admin - The user will become an owner of the organization.\n* member - The user will become a non-owner member of the organization.Default: member"
1092
+ }
1093
+ }
1094
+ },
1095
+ {
1096
+ "namespace_description": "Remove organization membership for a user",
1097
+ "method": "delete",
1098
+ "endpoint": "/orgs/{org}/memberships/{username}",
1099
+ "field_0": {
1100
+ "field_type": "header",
1101
+ "fields": {
1102
+ "name": "accept",
1103
+ "type": "string",
1104
+ "in": "header",
1105
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1106
+ }
1107
+ },
1108
+ "field_1": {
1109
+ "field_type": "path",
1110
+ "fields": {
1111
+ "name": "org",
1112
+ "type": "string",
1113
+ "in": "path",
1114
+ "description": ""
1115
+ }
1116
+ },
1117
+ "field_2": {
1118
+ "field_type": "path",
1119
+ "fields": {
1120
+ "name": "username",
1121
+ "type": "string",
1122
+ "in": "path",
1123
+ "description": ""
1124
+ }
1125
+ }
1126
+ },
1127
+ {
1128
+ "namespace_description": "List public organization members",
1129
+ "method": "get",
1130
+ "endpoint": "/orgs/{org}/public_members",
1131
+ "field_0": {
1132
+ "field_type": "header",
1133
+ "fields": {
1134
+ "name": "accept",
1135
+ "type": "string",
1136
+ "in": "header",
1137
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1138
+ }
1139
+ },
1140
+ "field_1": {
1141
+ "field_type": "path",
1142
+ "fields": {
1143
+ "name": "org",
1144
+ "type": "string",
1145
+ "in": "path",
1146
+ "description": ""
1147
+ }
1148
+ },
1149
+ "field_2": {
1150
+ "field_type": "query",
1151
+ "fields": {
1152
+ "name": "per_page",
1153
+ "type": "integer",
1154
+ "in": "query",
1155
+ "description": "Results per page (max 100)Default: 30"
1156
+ }
1157
+ },
1158
+ "field_3": {
1159
+ "field_type": "query",
1160
+ "fields": {
1161
+ "name": "page",
1162
+ "type": "integer",
1163
+ "in": "query",
1164
+ "description": "Page number of the results to fetch.Default: 1"
1165
+ }
1166
+ }
1167
+ },
1168
+ {
1169
+ "namespace_description": "Check public organization membership for a user",
1170
+ "method": "get",
1171
+ "endpoint": "/orgs/{org}/public_members/{username}",
1172
+ "field_0": {
1173
+ "field_type": "header",
1174
+ "fields": {
1175
+ "name": "accept",
1176
+ "type": "string",
1177
+ "in": "header",
1178
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1179
+ }
1180
+ },
1181
+ "field_1": {
1182
+ "field_type": "path",
1183
+ "fields": {
1184
+ "name": "org",
1185
+ "type": "string",
1186
+ "in": "path",
1187
+ "description": ""
1188
+ }
1189
+ },
1190
+ "field_2": {
1191
+ "field_type": "path",
1192
+ "fields": {
1193
+ "name": "username",
1194
+ "type": "string",
1195
+ "in": "path",
1196
+ "description": ""
1197
+ }
1198
+ }
1199
+ },
1200
+ {
1201
+ "namespace_description": "Set public organization membership for the authenticated user",
1202
+ "method": "put",
1203
+ "endpoint": "/orgs/{org}/public_members/{username}",
1204
+ "field_0": {
1205
+ "field_type": "header",
1206
+ "fields": {
1207
+ "name": "accept",
1208
+ "type": "string",
1209
+ "in": "header",
1210
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1211
+ }
1212
+ },
1213
+ "field_1": {
1214
+ "field_type": "path",
1215
+ "fields": {
1216
+ "name": "org",
1217
+ "type": "string",
1218
+ "in": "path",
1219
+ "description": ""
1220
+ }
1221
+ },
1222
+ "field_2": {
1223
+ "field_type": "path",
1224
+ "fields": {
1225
+ "name": "username",
1226
+ "type": "string",
1227
+ "in": "path",
1228
+ "description": ""
1229
+ }
1230
+ }
1231
+ },
1232
+ {
1233
+ "namespace_description": "Remove public organization membership for the authenticated user",
1234
+ "method": "delete",
1235
+ "endpoint": "/orgs/{org}/public_members/{username}",
1236
+ "field_0": {
1237
+ "field_type": "header",
1238
+ "fields": {
1239
+ "name": "accept",
1240
+ "type": "string",
1241
+ "in": "header",
1242
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1243
+ }
1244
+ },
1245
+ "field_1": {
1246
+ "field_type": "path",
1247
+ "fields": {
1248
+ "name": "org",
1249
+ "type": "string",
1250
+ "in": "path",
1251
+ "description": ""
1252
+ }
1253
+ },
1254
+ "field_2": {
1255
+ "field_type": "path",
1256
+ "fields": {
1257
+ "name": "username",
1258
+ "type": "string",
1259
+ "in": "path",
1260
+ "description": ""
1261
+ }
1262
+ }
1263
+ },
1264
+ {
1265
+ "namespace_description": "List organization memberships for the authenticated user",
1266
+ "method": "get",
1267
+ "endpoint": "/user/memberships/orgs",
1268
+ "field_0": {
1269
+ "field_type": "header",
1270
+ "fields": {
1271
+ "name": "accept",
1272
+ "type": "string",
1273
+ "in": "header",
1274
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1275
+ }
1276
+ },
1277
+ "field_1": {
1278
+ "field_type": "query",
1279
+ "fields": {
1280
+ "name": "state",
1281
+ "type": "string",
1282
+ "in": "query",
1283
+ "description": "Indicates the state of the memberships to return. Can be either active or pending. If not specified, the API returns both active and pending memberships."
1284
+ }
1285
+ },
1286
+ "field_2": {
1287
+ "field_type": "query",
1288
+ "fields": {
1289
+ "name": "per_page",
1290
+ "type": "integer",
1291
+ "in": "query",
1292
+ "description": "Results per page (max 100)Default: 30"
1293
+ }
1294
+ },
1295
+ "field_3": {
1296
+ "field_type": "query",
1297
+ "fields": {
1298
+ "name": "page",
1299
+ "type": "integer",
1300
+ "in": "query",
1301
+ "description": "Page number of the results to fetch.Default: 1"
1302
+ }
1303
+ }
1304
+ },
1305
+ {
1306
+ "namespace_description": "Get an organization membership for the authenticated user",
1307
+ "method": "get",
1308
+ "endpoint": "/user/memberships/orgs/{org}",
1309
+ "field_0": {
1310
+ "field_type": "header",
1311
+ "fields": {
1312
+ "name": "accept",
1313
+ "type": "string",
1314
+ "in": "header",
1315
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1316
+ }
1317
+ },
1318
+ "field_1": {
1319
+ "field_type": "path",
1320
+ "fields": {
1321
+ "name": "org",
1322
+ "type": "string",
1323
+ "in": "path",
1324
+ "description": ""
1325
+ }
1326
+ }
1327
+ },
1328
+ {
1329
+ "namespace_description": "Update an organization membership for the authenticated user",
1330
+ "method": "patch",
1331
+ "endpoint": "/user/memberships/orgs/{org}",
1332
+ "field_0": {
1333
+ "field_type": "header",
1334
+ "fields": {
1335
+ "name": "accept",
1336
+ "type": "string",
1337
+ "in": "header",
1338
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1339
+ }
1340
+ },
1341
+ "field_1": {
1342
+ "field_type": "path",
1343
+ "fields": {
1344
+ "name": "org",
1345
+ "type": "string",
1346
+ "in": "path",
1347
+ "description": ""
1348
+ }
1349
+ },
1350
+ "field_2": {
1351
+ "field_type": "body",
1352
+ "fields": {
1353
+ "name": "state",
1354
+ "type": "string",
1355
+ "in": "body",
1356
+ "description": "Required. The state that the membership should be in. Only \"active\" will be accepted."
1357
+ }
1358
+ }
1359
+ },
1360
+ {
1361
+ "namespace_description": "List outside collaborators for an organization",
1362
+ "method": "get",
1363
+ "endpoint": "/orgs/{org}/outside_collaborators",
1364
+ "field_0": {
1365
+ "field_type": "header",
1366
+ "fields": {
1367
+ "name": "accept",
1368
+ "type": "string",
1369
+ "in": "header",
1370
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1371
+ }
1372
+ },
1373
+ "field_1": {
1374
+ "field_type": "path",
1375
+ "fields": {
1376
+ "name": "org",
1377
+ "type": "string",
1378
+ "in": "path",
1379
+ "description": ""
1380
+ }
1381
+ },
1382
+ "field_2": {
1383
+ "field_type": "query",
1384
+ "fields": {
1385
+ "name": "filter",
1386
+ "type": "string",
1387
+ "in": "query",
1388
+ "description": "Filter the list of outside collaborators. Can be one of:\n* 2fa_disabled: Outside collaborators without two-factor authentication enabled.\n* all: All outside collaborators.Default: all"
1389
+ }
1390
+ },
1391
+ "field_3": {
1392
+ "field_type": "query",
1393
+ "fields": {
1394
+ "name": "per_page",
1395
+ "type": "integer",
1396
+ "in": "query",
1397
+ "description": "Results per page (max 100)Default: 30"
1398
+ }
1399
+ },
1400
+ "field_4": {
1401
+ "field_type": "query",
1402
+ "fields": {
1403
+ "name": "page",
1404
+ "type": "integer",
1405
+ "in": "query",
1406
+ "description": "Page number of the results to fetch.Default: 1"
1407
+ }
1408
+ }
1409
+ },
1410
+ {
1411
+ "namespace_description": "Convert an organization member to outside collaborator",
1412
+ "method": "put",
1413
+ "endpoint": "/orgs/{org}/outside_collaborators/{username}",
1414
+ "field_0": {
1415
+ "field_type": "header",
1416
+ "fields": {
1417
+ "name": "accept",
1418
+ "type": "string",
1419
+ "in": "header",
1420
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1421
+ }
1422
+ },
1423
+ "field_1": {
1424
+ "field_type": "path",
1425
+ "fields": {
1426
+ "name": "org",
1427
+ "type": "string",
1428
+ "in": "path",
1429
+ "description": ""
1430
+ }
1431
+ },
1432
+ "field_2": {
1433
+ "field_type": "path",
1434
+ "fields": {
1435
+ "name": "username",
1436
+ "type": "string",
1437
+ "in": "path",
1438
+ "description": ""
1439
+ }
1440
+ }
1441
+ },
1442
+ {
1443
+ "namespace_description": "Remove outside collaborator from an organization",
1444
+ "method": "delete",
1445
+ "endpoint": "/orgs/{org}/outside_collaborators/{username}",
1446
+ "field_0": {
1447
+ "field_type": "header",
1448
+ "fields": {
1449
+ "name": "accept",
1450
+ "type": "string",
1451
+ "in": "header",
1452
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1453
+ }
1454
+ },
1455
+ "field_1": {
1456
+ "field_type": "path",
1457
+ "fields": {
1458
+ "name": "org",
1459
+ "type": "string",
1460
+ "in": "path",
1461
+ "description": ""
1462
+ }
1463
+ },
1464
+ "field_2": {
1465
+ "field_type": "path",
1466
+ "fields": {
1467
+ "name": "username",
1468
+ "type": "string",
1469
+ "in": "path",
1470
+ "description": ""
1471
+ }
1472
+ }
1473
+ },
1474
+ {
1475
+ "namespace_description": "List organization webhooks",
1476
+ "method": "get",
1477
+ "endpoint": "/orgs/{org}/hooks",
1478
+ "field_0": {
1479
+ "field_type": "header",
1480
+ "fields": {
1481
+ "name": "accept",
1482
+ "type": "string",
1483
+ "in": "header",
1484
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1485
+ }
1486
+ },
1487
+ "field_1": {
1488
+ "field_type": "path",
1489
+ "fields": {
1490
+ "name": "org",
1491
+ "type": "string",
1492
+ "in": "path",
1493
+ "description": ""
1494
+ }
1495
+ },
1496
+ "field_2": {
1497
+ "field_type": "query",
1498
+ "fields": {
1499
+ "name": "per_page",
1500
+ "type": "integer",
1501
+ "in": "query",
1502
+ "description": "Results per page (max 100)Default: 30"
1503
+ }
1504
+ },
1505
+ "field_3": {
1506
+ "field_type": "query",
1507
+ "fields": {
1508
+ "name": "page",
1509
+ "type": "integer",
1510
+ "in": "query",
1511
+ "description": "Page number of the results to fetch.Default: 1"
1512
+ }
1513
+ }
1514
+ },
1515
+ {
1516
+ "namespace_description": "Create an organization webhook",
1517
+ "method": "post",
1518
+ "endpoint": "/orgs/{org}/hooks",
1519
+ "field_0": {
1520
+ "field_type": "header",
1521
+ "fields": {
1522
+ "name": "accept",
1523
+ "type": "string",
1524
+ "in": "header",
1525
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1526
+ }
1527
+ },
1528
+ "field_1": {
1529
+ "field_type": "path",
1530
+ "fields": {
1531
+ "name": "org",
1532
+ "type": "string",
1533
+ "in": "path",
1534
+ "description": ""
1535
+ }
1536
+ },
1537
+ "field_2": {
1538
+ "field_type": "body",
1539
+ "fields": {
1540
+ "name": "name",
1541
+ "type": "string",
1542
+ "in": "body",
1543
+ "description": "Required. Must be passed as \"web\"."
1544
+ }
1545
+ },
1546
+ "field_3": {
1547
+ "field_type": "body",
1548
+ "fields": {
1549
+ "name": "config",
1550
+ "type": "object",
1551
+ "in": "body",
1552
+ "description": "Required. Key/value pairs to provide settings for this webhook. These are defined below."
1553
+ }
1554
+ },
1555
+ "field_4": {
1556
+ "field_type": null,
1557
+ "fields": {
1558
+ "name": "Properties of theconfigobjectName (Type)Descriptionurl (string)Required. The URL to which the payloads will be delivered.content_type (string)The media type used to serialize the payloads. Supported values include json and form. The default is form.secret (string)If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.insecure_ssl (string or number or )Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.username (string)password (string)",
1559
+ "type": null,
1560
+ "in": null,
1561
+ "description": null
1562
+ }
1563
+ },
1564
+ "field_5": {
1565
+ "field_type": "body",
1566
+ "fields": {
1567
+ "name": "events",
1568
+ "type": "array of strings",
1569
+ "in": "body",
1570
+ "description": "Determines what events the hook is triggered for.Default: push"
1571
+ }
1572
+ },
1573
+ "field_6": {
1574
+ "field_type": "body",
1575
+ "fields": {
1576
+ "name": "active",
1577
+ "type": "boolean",
1578
+ "in": "body",
1579
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.Default: "
1580
+ }
1581
+ }
1582
+ },
1583
+ {
1584
+ "namespace_description": "Get an organization webhook",
1585
+ "method": "get",
1586
+ "endpoint": "/orgs/{org}/hooks/{hook_id}",
1587
+ "field_0": {
1588
+ "field_type": "header",
1589
+ "fields": {
1590
+ "name": "accept",
1591
+ "type": "string",
1592
+ "in": "header",
1593
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1594
+ }
1595
+ },
1596
+ "field_1": {
1597
+ "field_type": "path",
1598
+ "fields": {
1599
+ "name": "org",
1600
+ "type": "string",
1601
+ "in": "path",
1602
+ "description": ""
1603
+ }
1604
+ },
1605
+ "field_2": {
1606
+ "field_type": "path",
1607
+ "fields": {
1608
+ "name": "hook_id",
1609
+ "type": "integer",
1610
+ "in": "path",
1611
+ "description": ""
1612
+ }
1613
+ }
1614
+ },
1615
+ {
1616
+ "namespace_description": "Update an organization webhook",
1617
+ "method": "patch",
1618
+ "endpoint": "/orgs/{org}/hooks/{hook_id}",
1619
+ "field_0": {
1620
+ "field_type": "header",
1621
+ "fields": {
1622
+ "name": "accept",
1623
+ "type": "string",
1624
+ "in": "header",
1625
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1626
+ }
1627
+ },
1628
+ "field_1": {
1629
+ "field_type": "path",
1630
+ "fields": {
1631
+ "name": "org",
1632
+ "type": "string",
1633
+ "in": "path",
1634
+ "description": ""
1635
+ }
1636
+ },
1637
+ "field_2": {
1638
+ "field_type": "path",
1639
+ "fields": {
1640
+ "name": "hook_id",
1641
+ "type": "integer",
1642
+ "in": "path",
1643
+ "description": ""
1644
+ }
1645
+ },
1646
+ "field_3": {
1647
+ "field_type": "body",
1648
+ "fields": {
1649
+ "name": "config",
1650
+ "type": "object",
1651
+ "in": "body",
1652
+ "description": "Key/value pairs to provide settings for this webhook. These are defined below."
1653
+ }
1654
+ },
1655
+ "field_4": {
1656
+ "field_type": null,
1657
+ "fields": {
1658
+ "name": "Properties of theconfigobjectName (Type)Descriptionurl (string)Required. The URL to which the payloads will be delivered.content_type (string)The media type used to serialize the payloads. Supported values include json and form. The default is form.secret (string)If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.insecure_ssl (string or number or )Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.",
1659
+ "type": null,
1660
+ "in": null,
1661
+ "description": null
1662
+ }
1663
+ },
1664
+ "field_5": {
1665
+ "field_type": "body",
1666
+ "fields": {
1667
+ "name": "events",
1668
+ "type": "array of strings",
1669
+ "in": "body",
1670
+ "description": "Determines what events the hook is triggered for.Default: push"
1671
+ }
1672
+ },
1673
+ "field_6": {
1674
+ "field_type": "body",
1675
+ "fields": {
1676
+ "name": "active",
1677
+ "type": "boolean",
1678
+ "in": "body",
1679
+ "description": "Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.Default: "
1680
+ }
1681
+ },
1682
+ "field_7": {
1683
+ "field_type": "body",
1684
+ "fields": {
1685
+ "name": "name",
1686
+ "type": "string",
1687
+ "in": "body",
1688
+ "description": ""
1689
+ }
1690
+ }
1691
+ },
1692
+ {
1693
+ "namespace_description": "Delete an organization webhook",
1694
+ "method": "delete",
1695
+ "endpoint": "/orgs/{org}/hooks/{hook_id}",
1696
+ "field_0": {
1697
+ "field_type": "header",
1698
+ "fields": {
1699
+ "name": "accept",
1700
+ "type": "string",
1701
+ "in": "header",
1702
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1703
+ }
1704
+ },
1705
+ "field_1": {
1706
+ "field_type": "path",
1707
+ "fields": {
1708
+ "name": "org",
1709
+ "type": "string",
1710
+ "in": "path",
1711
+ "description": ""
1712
+ }
1713
+ },
1714
+ "field_2": {
1715
+ "field_type": "path",
1716
+ "fields": {
1717
+ "name": "hook_id",
1718
+ "type": "integer",
1719
+ "in": "path",
1720
+ "description": ""
1721
+ }
1722
+ }
1723
+ },
1724
+ {
1725
+ "namespace_description": "Get a webhook configuration for an organization",
1726
+ "method": "get",
1727
+ "endpoint": "/orgs/{org}/hooks/{hook_id}/config",
1728
+ "field_0": {
1729
+ "field_type": "header",
1730
+ "fields": {
1731
+ "name": "accept",
1732
+ "type": "string",
1733
+ "in": "header",
1734
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1735
+ }
1736
+ },
1737
+ "field_1": {
1738
+ "field_type": "path",
1739
+ "fields": {
1740
+ "name": "org",
1741
+ "type": "string",
1742
+ "in": "path",
1743
+ "description": ""
1744
+ }
1745
+ },
1746
+ "field_2": {
1747
+ "field_type": "path",
1748
+ "fields": {
1749
+ "name": "hook_id",
1750
+ "type": "integer",
1751
+ "in": "path",
1752
+ "description": ""
1753
+ }
1754
+ }
1755
+ },
1756
+ {
1757
+ "namespace_description": "Update a webhook configuration for an organization",
1758
+ "method": "patch",
1759
+ "endpoint": "/orgs/{org}/hooks/{hook_id}/config",
1760
+ "field_0": {
1761
+ "field_type": "header",
1762
+ "fields": {
1763
+ "name": "accept",
1764
+ "type": "string",
1765
+ "in": "header",
1766
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1767
+ }
1768
+ },
1769
+ "field_1": {
1770
+ "field_type": "path",
1771
+ "fields": {
1772
+ "name": "org",
1773
+ "type": "string",
1774
+ "in": "path",
1775
+ "description": ""
1776
+ }
1777
+ },
1778
+ "field_2": {
1779
+ "field_type": "path",
1780
+ "fields": {
1781
+ "name": "hook_id",
1782
+ "type": "integer",
1783
+ "in": "path",
1784
+ "description": ""
1785
+ }
1786
+ },
1787
+ "field_3": {
1788
+ "field_type": "body",
1789
+ "fields": {
1790
+ "name": "url",
1791
+ "type": "string",
1792
+ "in": "body",
1793
+ "description": "The URL to which the payloads will be delivered."
1794
+ }
1795
+ },
1796
+ "field_4": {
1797
+ "field_type": "body",
1798
+ "fields": {
1799
+ "name": "content_type",
1800
+ "type": "string",
1801
+ "in": "body",
1802
+ "description": "The media type used to serialize the payloads. Supported values include json and form. The default is form."
1803
+ }
1804
+ },
1805
+ "field_5": {
1806
+ "field_type": "body",
1807
+ "fields": {
1808
+ "name": "secret",
1809
+ "type": "string",
1810
+ "in": "body",
1811
+ "description": "If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers."
1812
+ }
1813
+ },
1814
+ "field_6": {
1815
+ "field_type": "body",
1816
+ "fields": {
1817
+ "name": "insecure_ssl",
1818
+ "type": "string or number or ",
1819
+ "in": "body",
1820
+ "description": "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks."
1821
+ }
1822
+ }
1823
+ },
1824
+ {
1825
+ "namespace_description": "List deliveries for an organization webhook",
1826
+ "method": "get",
1827
+ "endpoint": "/orgs/{org}/hooks/{hook_id}/deliveries",
1828
+ "field_0": {
1829
+ "field_type": "header",
1830
+ "fields": {
1831
+ "name": "accept",
1832
+ "type": "string",
1833
+ "in": "header",
1834
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1835
+ }
1836
+ },
1837
+ "field_1": {
1838
+ "field_type": "path",
1839
+ "fields": {
1840
+ "name": "org",
1841
+ "type": "string",
1842
+ "in": "path",
1843
+ "description": ""
1844
+ }
1845
+ },
1846
+ "field_2": {
1847
+ "field_type": "path",
1848
+ "fields": {
1849
+ "name": "hook_id",
1850
+ "type": "integer",
1851
+ "in": "path",
1852
+ "description": ""
1853
+ }
1854
+ },
1855
+ "field_3": {
1856
+ "field_type": "query",
1857
+ "fields": {
1858
+ "name": "per_page",
1859
+ "type": "integer",
1860
+ "in": "query",
1861
+ "description": "Results per page (max 100)Default: 30"
1862
+ }
1863
+ },
1864
+ "field_4": {
1865
+ "field_type": "query",
1866
+ "fields": {
1867
+ "name": "cursor",
1868
+ "type": "string",
1869
+ "in": "query",
1870
+ "description": "Used for pagination: the starting delivery from which the page of deliveries is fetched. Refer to the link header for the next and previous page cursors."
1871
+ }
1872
+ }
1873
+ },
1874
+ {
1875
+ "namespace_description": "Get a webhook delivery for an organization webhook",
1876
+ "method": "get",
1877
+ "endpoint": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}",
1878
+ "field_0": {
1879
+ "field_type": "header",
1880
+ "fields": {
1881
+ "name": "accept",
1882
+ "type": "string",
1883
+ "in": "header",
1884
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1885
+ }
1886
+ },
1887
+ "field_1": {
1888
+ "field_type": "path",
1889
+ "fields": {
1890
+ "name": "org",
1891
+ "type": "string",
1892
+ "in": "path",
1893
+ "description": ""
1894
+ }
1895
+ },
1896
+ "field_2": {
1897
+ "field_type": "path",
1898
+ "fields": {
1899
+ "name": "hook_id",
1900
+ "type": "integer",
1901
+ "in": "path",
1902
+ "description": ""
1903
+ }
1904
+ },
1905
+ "field_3": {
1906
+ "field_type": "path",
1907
+ "fields": {
1908
+ "name": "delivery_id",
1909
+ "type": "integer",
1910
+ "in": "path",
1911
+ "description": ""
1912
+ }
1913
+ }
1914
+ },
1915
+ {
1916
+ "namespace_description": "Redeliver a delivery for an organization webhook",
1917
+ "method": "post",
1918
+ "endpoint": "/orgs/{org}/hooks/{hook_id}/deliveries/{delivery_id}/attempts",
1919
+ "field_0": {
1920
+ "field_type": "header",
1921
+ "fields": {
1922
+ "name": "accept",
1923
+ "type": "string",
1924
+ "in": "header",
1925
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1926
+ }
1927
+ },
1928
+ "field_1": {
1929
+ "field_type": "path",
1930
+ "fields": {
1931
+ "name": "org",
1932
+ "type": "string",
1933
+ "in": "path",
1934
+ "description": ""
1935
+ }
1936
+ },
1937
+ "field_2": {
1938
+ "field_type": "path",
1939
+ "fields": {
1940
+ "name": "hook_id",
1941
+ "type": "integer",
1942
+ "in": "path",
1943
+ "description": ""
1944
+ }
1945
+ },
1946
+ "field_3": {
1947
+ "field_type": "path",
1948
+ "fields": {
1949
+ "name": "delivery_id",
1950
+ "type": "integer",
1951
+ "in": "path",
1952
+ "description": ""
1953
+ }
1954
+ }
1955
+ },
1956
+ {
1957
+ "namespace_description": "Ping an organization webhook",
1958
+ "method": "post",
1959
+ "endpoint": "/orgs/{org}/hooks/{hook_id}/pings",
1960
+ "field_0": {
1961
+ "field_type": "header",
1962
+ "fields": {
1963
+ "name": "accept",
1964
+ "type": "string",
1965
+ "in": "header",
1966
+ "description": "Setting toapplication/vnd.github.v3+json is recommended."
1967
+ }
1968
+ },
1969
+ "field_1": {
1970
+ "field_type": "path",
1971
+ "fields": {
1972
+ "name": "org",
1973
+ "type": "string",
1974
+ "in": "path",
1975
+ "description": ""
1976
+ }
1977
+ },
1978
+ "field_2": {
1979
+ "field_type": "path",
1980
+ "fields": {
1981
+ "name": "hook_id",
1982
+ "type": "integer",
1983
+ "in": "path",
1984
+ "description": ""
1985
+ }
1986
+ }
1987
+ }
1988
+ ]
1989
+ }