1 | {
|
2 | "activity": {
|
3 | "checkStarringRepo": {
|
4 | "method": "GET",
|
5 | "params": {
|
6 | "owner": { "required": true, "type": "string" },
|
7 | "repo": { "required": true, "type": "string" }
|
8 | },
|
9 | "url": "/user/starred/:owner/:repo"
|
10 | },
|
11 | "deleteRepoSubscription": {
|
12 | "method": "DELETE",
|
13 | "params": {
|
14 | "owner": { "required": true, "type": "string" },
|
15 | "repo": { "required": true, "type": "string" }
|
16 | },
|
17 | "url": "/repos/:owner/:repo/subscription"
|
18 | },
|
19 | "deleteThreadSubscription": {
|
20 | "method": "DELETE",
|
21 | "params": { "thread_id": { "required": true, "type": "integer" } },
|
22 | "url": "/notifications/threads/:thread_id/subscription"
|
23 | },
|
24 | "getRepoSubscription": {
|
25 | "method": "GET",
|
26 | "params": {
|
27 | "owner": { "required": true, "type": "string" },
|
28 | "repo": { "required": true, "type": "string" }
|
29 | },
|
30 | "url": "/repos/:owner/:repo/subscription"
|
31 | },
|
32 | "getThread": {
|
33 | "method": "GET",
|
34 | "params": { "thread_id": { "required": true, "type": "integer" } },
|
35 | "url": "/notifications/threads/:thread_id"
|
36 | },
|
37 | "getThreadSubscription": {
|
38 | "method": "GET",
|
39 | "params": { "thread_id": { "required": true, "type": "integer" } },
|
40 | "url": "/notifications/threads/:thread_id/subscription"
|
41 | },
|
42 | "listEventsForOrg": {
|
43 | "method": "GET",
|
44 | "params": {
|
45 | "org": { "required": true, "type": "string" },
|
46 | "page": { "type": "integer" },
|
47 | "per_page": { "type": "integer" },
|
48 | "username": { "required": true, "type": "string" }
|
49 | },
|
50 | "url": "/users/:username/events/orgs/:org"
|
51 | },
|
52 | "listEventsForUser": {
|
53 | "method": "GET",
|
54 | "params": {
|
55 | "page": { "type": "integer" },
|
56 | "per_page": { "type": "integer" },
|
57 | "username": { "required": true, "type": "string" }
|
58 | },
|
59 | "url": "/users/:username/events"
|
60 | },
|
61 | "listFeeds": { "method": "GET", "params": {}, "url": "/feeds" },
|
62 | "listNotifications": {
|
63 | "method": "GET",
|
64 | "params": {
|
65 | "all": { "type": "boolean" },
|
66 | "before": { "type": "string" },
|
67 | "page": { "type": "integer" },
|
68 | "participating": { "type": "boolean" },
|
69 | "per_page": { "type": "integer" },
|
70 | "since": { "type": "string" }
|
71 | },
|
72 | "url": "/notifications"
|
73 | },
|
74 | "listNotificationsForRepo": {
|
75 | "method": "GET",
|
76 | "params": {
|
77 | "all": { "type": "boolean" },
|
78 | "before": { "type": "string" },
|
79 | "owner": { "required": true, "type": "string" },
|
80 | "page": { "type": "integer" },
|
81 | "participating": { "type": "boolean" },
|
82 | "per_page": { "type": "integer" },
|
83 | "repo": { "required": true, "type": "string" },
|
84 | "since": { "type": "string" }
|
85 | },
|
86 | "url": "/repos/:owner/:repo/notifications"
|
87 | },
|
88 | "listPublicEvents": {
|
89 | "method": "GET",
|
90 | "params": {
|
91 | "page": { "type": "integer" },
|
92 | "per_page": { "type": "integer" }
|
93 | },
|
94 | "url": "/events"
|
95 | },
|
96 | "listPublicEventsForOrg": {
|
97 | "method": "GET",
|
98 | "params": {
|
99 | "org": { "required": true, "type": "string" },
|
100 | "page": { "type": "integer" },
|
101 | "per_page": { "type": "integer" }
|
102 | },
|
103 | "url": "/orgs/:org/events"
|
104 | },
|
105 | "listPublicEventsForRepoNetwork": {
|
106 | "method": "GET",
|
107 | "params": {
|
108 | "owner": { "required": true, "type": "string" },
|
109 | "page": { "type": "integer" },
|
110 | "per_page": { "type": "integer" },
|
111 | "repo": { "required": true, "type": "string" }
|
112 | },
|
113 | "url": "/networks/:owner/:repo/events"
|
114 | },
|
115 | "listPublicEventsForUser": {
|
116 | "method": "GET",
|
117 | "params": {
|
118 | "page": { "type": "integer" },
|
119 | "per_page": { "type": "integer" },
|
120 | "username": { "required": true, "type": "string" }
|
121 | },
|
122 | "url": "/users/:username/events/public"
|
123 | },
|
124 | "listReceivedEventsForUser": {
|
125 | "method": "GET",
|
126 | "params": {
|
127 | "page": { "type": "integer" },
|
128 | "per_page": { "type": "integer" },
|
129 | "username": { "required": true, "type": "string" }
|
130 | },
|
131 | "url": "/users/:username/received_events"
|
132 | },
|
133 | "listReceivedPublicEventsForUser": {
|
134 | "method": "GET",
|
135 | "params": {
|
136 | "page": { "type": "integer" },
|
137 | "per_page": { "type": "integer" },
|
138 | "username": { "required": true, "type": "string" }
|
139 | },
|
140 | "url": "/users/:username/received_events/public"
|
141 | },
|
142 | "listRepoEvents": {
|
143 | "method": "GET",
|
144 | "params": {
|
145 | "owner": { "required": true, "type": "string" },
|
146 | "page": { "type": "integer" },
|
147 | "per_page": { "type": "integer" },
|
148 | "repo": { "required": true, "type": "string" }
|
149 | },
|
150 | "url": "/repos/:owner/:repo/events"
|
151 | },
|
152 | "listReposStarredByAuthenticatedUser": {
|
153 | "method": "GET",
|
154 | "params": {
|
155 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
156 | "page": { "type": "integer" },
|
157 | "per_page": { "type": "integer" },
|
158 | "sort": { "enum": ["created", "updated"], "type": "string" }
|
159 | },
|
160 | "url": "/user/starred"
|
161 | },
|
162 | "listReposStarredByUser": {
|
163 | "method": "GET",
|
164 | "params": {
|
165 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
166 | "page": { "type": "integer" },
|
167 | "per_page": { "type": "integer" },
|
168 | "sort": { "enum": ["created", "updated"], "type": "string" },
|
169 | "username": { "required": true, "type": "string" }
|
170 | },
|
171 | "url": "/users/:username/starred"
|
172 | },
|
173 | "listReposWatchedByUser": {
|
174 | "method": "GET",
|
175 | "params": {
|
176 | "page": { "type": "integer" },
|
177 | "per_page": { "type": "integer" },
|
178 | "username": { "required": true, "type": "string" }
|
179 | },
|
180 | "url": "/users/:username/subscriptions"
|
181 | },
|
182 | "listStargazersForRepo": {
|
183 | "method": "GET",
|
184 | "params": {
|
185 | "owner": { "required": true, "type": "string" },
|
186 | "page": { "type": "integer" },
|
187 | "per_page": { "type": "integer" },
|
188 | "repo": { "required": true, "type": "string" }
|
189 | },
|
190 | "url": "/repos/:owner/:repo/stargazers"
|
191 | },
|
192 | "listWatchedReposForAuthenticatedUser": {
|
193 | "method": "GET",
|
194 | "params": {
|
195 | "page": { "type": "integer" },
|
196 | "per_page": { "type": "integer" }
|
197 | },
|
198 | "url": "/user/subscriptions"
|
199 | },
|
200 | "listWatchersForRepo": {
|
201 | "method": "GET",
|
202 | "params": {
|
203 | "owner": { "required": true, "type": "string" },
|
204 | "page": { "type": "integer" },
|
205 | "per_page": { "type": "integer" },
|
206 | "repo": { "required": true, "type": "string" }
|
207 | },
|
208 | "url": "/repos/:owner/:repo/subscribers"
|
209 | },
|
210 | "markAsRead": {
|
211 | "method": "PUT",
|
212 | "params": { "last_read_at": { "type": "string" } },
|
213 | "url": "/notifications"
|
214 | },
|
215 | "markNotificationsAsReadForRepo": {
|
216 | "method": "PUT",
|
217 | "params": {
|
218 | "last_read_at": { "type": "string" },
|
219 | "owner": { "required": true, "type": "string" },
|
220 | "repo": { "required": true, "type": "string" }
|
221 | },
|
222 | "url": "/repos/:owner/:repo/notifications"
|
223 | },
|
224 | "markThreadAsRead": {
|
225 | "method": "PATCH",
|
226 | "params": { "thread_id": { "required": true, "type": "integer" } },
|
227 | "url": "/notifications/threads/:thread_id"
|
228 | },
|
229 | "setRepoSubscription": {
|
230 | "method": "PUT",
|
231 | "params": {
|
232 | "ignored": { "type": "boolean" },
|
233 | "owner": { "required": true, "type": "string" },
|
234 | "repo": { "required": true, "type": "string" },
|
235 | "subscribed": { "type": "boolean" }
|
236 | },
|
237 | "url": "/repos/:owner/:repo/subscription"
|
238 | },
|
239 | "setThreadSubscription": {
|
240 | "method": "PUT",
|
241 | "params": {
|
242 | "ignored": { "type": "boolean" },
|
243 | "thread_id": { "required": true, "type": "integer" }
|
244 | },
|
245 | "url": "/notifications/threads/:thread_id/subscription"
|
246 | },
|
247 | "starRepo": {
|
248 | "method": "PUT",
|
249 | "params": {
|
250 | "owner": { "required": true, "type": "string" },
|
251 | "repo": { "required": true, "type": "string" }
|
252 | },
|
253 | "url": "/user/starred/:owner/:repo"
|
254 | },
|
255 | "unstarRepo": {
|
256 | "method": "DELETE",
|
257 | "params": {
|
258 | "owner": { "required": true, "type": "string" },
|
259 | "repo": { "required": true, "type": "string" }
|
260 | },
|
261 | "url": "/user/starred/:owner/:repo"
|
262 | }
|
263 | },
|
264 | "apps": {
|
265 | "addRepoToInstallation": {
|
266 | "headers": {
|
267 | "accept": "application/vnd.github.machine-man-preview+json"
|
268 | },
|
269 | "method": "PUT",
|
270 | "params": {
|
271 | "installation_id": { "required": true, "type": "integer" },
|
272 | "repository_id": { "required": true, "type": "integer" }
|
273 | },
|
274 | "url": "/user/installations/:installation_id/repositories/:repository_id"
|
275 | },
|
276 | "createContentAttachment": {
|
277 | "headers": { "accept": "application/vnd.github.corsair-preview+json" },
|
278 | "method": "POST",
|
279 | "params": {
|
280 | "body": { "required": true, "type": "string" },
|
281 | "content_reference_id": { "required": true, "type": "integer" },
|
282 | "title": { "required": true, "type": "string" }
|
283 | },
|
284 | "url": "/content_references/:content_reference_id/attachments"
|
285 | },
|
286 | "createFromManifest": {
|
287 | "headers": { "accept": "application/vnd.github.fury-preview+json" },
|
288 | "method": "POST",
|
289 | "params": { "code": { "required": true, "type": "string" } },
|
290 | "url": "/app-manifests/:code/conversions"
|
291 | },
|
292 | "createInstallationToken": {
|
293 | "headers": {
|
294 | "accept": "application/vnd.github.machine-man-preview+json"
|
295 | },
|
296 | "method": "POST",
|
297 | "params": {
|
298 | "installation_id": { "required": true, "type": "integer" },
|
299 | "permissions": { "type": "object" },
|
300 | "repository_ids": { "type": "integer[]" }
|
301 | },
|
302 | "url": "/app/installations/:installation_id/access_tokens"
|
303 | },
|
304 | "deleteInstallation": {
|
305 | "headers": {
|
306 | "accept": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
|
307 | },
|
308 | "method": "DELETE",
|
309 | "params": { "installation_id": { "required": true, "type": "integer" } },
|
310 | "url": "/app/installations/:installation_id"
|
311 | },
|
312 | "findOrgInstallation": {
|
313 | "deprecated": "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)",
|
314 | "headers": {
|
315 | "accept": "application/vnd.github.machine-man-preview+json"
|
316 | },
|
317 | "method": "GET",
|
318 | "params": { "org": { "required": true, "type": "string" } },
|
319 | "url": "/orgs/:org/installation"
|
320 | },
|
321 | "findRepoInstallation": {
|
322 | "deprecated": "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)",
|
323 | "headers": {
|
324 | "accept": "application/vnd.github.machine-man-preview+json"
|
325 | },
|
326 | "method": "GET",
|
327 | "params": {
|
328 | "owner": { "required": true, "type": "string" },
|
329 | "repo": { "required": true, "type": "string" }
|
330 | },
|
331 | "url": "/repos/:owner/:repo/installation"
|
332 | },
|
333 | "findUserInstallation": {
|
334 | "deprecated": "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)",
|
335 | "headers": {
|
336 | "accept": "application/vnd.github.machine-man-preview+json"
|
337 | },
|
338 | "method": "GET",
|
339 | "params": { "username": { "required": true, "type": "string" } },
|
340 | "url": "/users/:username/installation"
|
341 | },
|
342 | "getAuthenticated": {
|
343 | "headers": {
|
344 | "accept": "application/vnd.github.machine-man-preview+json"
|
345 | },
|
346 | "method": "GET",
|
347 | "params": {},
|
348 | "url": "/app"
|
349 | },
|
350 | "getBySlug": {
|
351 | "headers": {
|
352 | "accept": "application/vnd.github.machine-man-preview+json"
|
353 | },
|
354 | "method": "GET",
|
355 | "params": { "app_slug": { "required": true, "type": "string" } },
|
356 | "url": "/apps/:app_slug"
|
357 | },
|
358 | "getInstallation": {
|
359 | "headers": {
|
360 | "accept": "application/vnd.github.machine-man-preview+json"
|
361 | },
|
362 | "method": "GET",
|
363 | "params": { "installation_id": { "required": true, "type": "integer" } },
|
364 | "url": "/app/installations/:installation_id"
|
365 | },
|
366 | "getOrgInstallation": {
|
367 | "headers": {
|
368 | "accept": "application/vnd.github.machine-man-preview+json"
|
369 | },
|
370 | "method": "GET",
|
371 | "params": { "org": { "required": true, "type": "string" } },
|
372 | "url": "/orgs/:org/installation"
|
373 | },
|
374 | "getRepoInstallation": {
|
375 | "headers": {
|
376 | "accept": "application/vnd.github.machine-man-preview+json"
|
377 | },
|
378 | "method": "GET",
|
379 | "params": {
|
380 | "owner": { "required": true, "type": "string" },
|
381 | "repo": { "required": true, "type": "string" }
|
382 | },
|
383 | "url": "/repos/:owner/:repo/installation"
|
384 | },
|
385 | "getUserInstallation": {
|
386 | "headers": {
|
387 | "accept": "application/vnd.github.machine-man-preview+json"
|
388 | },
|
389 | "method": "GET",
|
390 | "params": { "username": { "required": true, "type": "string" } },
|
391 | "url": "/users/:username/installation"
|
392 | },
|
393 | "listInstallationReposForAuthenticatedUser": {
|
394 | "headers": {
|
395 | "accept": "application/vnd.github.machine-man-preview+json"
|
396 | },
|
397 | "method": "GET",
|
398 | "params": {
|
399 | "installation_id": { "required": true, "type": "integer" },
|
400 | "page": { "type": "integer" },
|
401 | "per_page": { "type": "integer" }
|
402 | },
|
403 | "url": "/user/installations/:installation_id/repositories"
|
404 | },
|
405 | "listInstallations": {
|
406 | "headers": {
|
407 | "accept": "application/vnd.github.machine-man-preview+json"
|
408 | },
|
409 | "method": "GET",
|
410 | "params": {
|
411 | "page": { "type": "integer" },
|
412 | "per_page": { "type": "integer" }
|
413 | },
|
414 | "url": "/app/installations"
|
415 | },
|
416 | "listInstallationsForAuthenticatedUser": {
|
417 | "headers": {
|
418 | "accept": "application/vnd.github.machine-man-preview+json"
|
419 | },
|
420 | "method": "GET",
|
421 | "params": {
|
422 | "page": { "type": "integer" },
|
423 | "per_page": { "type": "integer" }
|
424 | },
|
425 | "url": "/user/installations"
|
426 | },
|
427 | "listRepos": {
|
428 | "headers": {
|
429 | "accept": "application/vnd.github.machine-man-preview+json"
|
430 | },
|
431 | "method": "GET",
|
432 | "params": {
|
433 | "page": { "type": "integer" },
|
434 | "per_page": { "type": "integer" }
|
435 | },
|
436 | "url": "/installation/repositories"
|
437 | },
|
438 | "removeRepoFromInstallation": {
|
439 | "headers": {
|
440 | "accept": "application/vnd.github.machine-man-preview+json"
|
441 | },
|
442 | "method": "DELETE",
|
443 | "params": {
|
444 | "installation_id": { "required": true, "type": "integer" },
|
445 | "repository_id": { "required": true, "type": "integer" }
|
446 | },
|
447 | "url": "/user/installations/:installation_id/repositories/:repository_id"
|
448 | }
|
449 | },
|
450 | "checks": {
|
451 | "create": {
|
452 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
453 | "method": "POST",
|
454 | "params": {
|
455 | "actions": { "type": "object[]" },
|
456 | "actions[].description": { "required": true, "type": "string" },
|
457 | "actions[].identifier": { "required": true, "type": "string" },
|
458 | "actions[].label": { "required": true, "type": "string" },
|
459 | "completed_at": { "type": "string" },
|
460 | "conclusion": {
|
461 | "enum": [
|
462 | "success",
|
463 | "failure",
|
464 | "neutral",
|
465 | "cancelled",
|
466 | "timed_out",
|
467 | "action_required"
|
468 | ],
|
469 | "type": "string"
|
470 | },
|
471 | "details_url": { "type": "string" },
|
472 | "external_id": { "type": "string" },
|
473 | "head_sha": { "required": true, "type": "string" },
|
474 | "name": { "required": true, "type": "string" },
|
475 | "output": { "type": "object" },
|
476 | "output.annotations": { "type": "object[]" },
|
477 | "output.annotations[].annotation_level": {
|
478 | "enum": ["notice", "warning", "failure"],
|
479 | "required": true,
|
480 | "type": "string"
|
481 | },
|
482 | "output.annotations[].end_column": { "type": "integer" },
|
483 | "output.annotations[].end_line": {
|
484 | "required": true,
|
485 | "type": "integer"
|
486 | },
|
487 | "output.annotations[].message": { "required": true, "type": "string" },
|
488 | "output.annotations[].path": { "required": true, "type": "string" },
|
489 | "output.annotations[].raw_details": { "type": "string" },
|
490 | "output.annotations[].start_column": { "type": "integer" },
|
491 | "output.annotations[].start_line": {
|
492 | "required": true,
|
493 | "type": "integer"
|
494 | },
|
495 | "output.annotations[].title": { "type": "string" },
|
496 | "output.images": { "type": "object[]" },
|
497 | "output.images[].alt": { "required": true, "type": "string" },
|
498 | "output.images[].caption": { "type": "string" },
|
499 | "output.images[].image_url": { "required": true, "type": "string" },
|
500 | "output.summary": { "required": true, "type": "string" },
|
501 | "output.text": { "type": "string" },
|
502 | "output.title": { "required": true, "type": "string" },
|
503 | "owner": { "required": true, "type": "string" },
|
504 | "repo": { "required": true, "type": "string" },
|
505 | "started_at": { "type": "string" },
|
506 | "status": {
|
507 | "enum": ["queued", "in_progress", "completed"],
|
508 | "type": "string"
|
509 | }
|
510 | },
|
511 | "url": "/repos/:owner/:repo/check-runs"
|
512 | },
|
513 | "createSuite": {
|
514 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
515 | "method": "POST",
|
516 | "params": {
|
517 | "head_sha": { "required": true, "type": "string" },
|
518 | "owner": { "required": true, "type": "string" },
|
519 | "repo": { "required": true, "type": "string" }
|
520 | },
|
521 | "url": "/repos/:owner/:repo/check-suites"
|
522 | },
|
523 | "get": {
|
524 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
525 | "method": "GET",
|
526 | "params": {
|
527 | "check_run_id": { "required": true, "type": "integer" },
|
528 | "owner": { "required": true, "type": "string" },
|
529 | "repo": { "required": true, "type": "string" }
|
530 | },
|
531 | "url": "/repos/:owner/:repo/check-runs/:check_run_id"
|
532 | },
|
533 | "getSuite": {
|
534 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
535 | "method": "GET",
|
536 | "params": {
|
537 | "check_suite_id": { "required": true, "type": "integer" },
|
538 | "owner": { "required": true, "type": "string" },
|
539 | "repo": { "required": true, "type": "string" }
|
540 | },
|
541 | "url": "/repos/:owner/:repo/check-suites/:check_suite_id"
|
542 | },
|
543 | "listAnnotations": {
|
544 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
545 | "method": "GET",
|
546 | "params": {
|
547 | "check_run_id": { "required": true, "type": "integer" },
|
548 | "owner": { "required": true, "type": "string" },
|
549 | "page": { "type": "integer" },
|
550 | "per_page": { "type": "integer" },
|
551 | "repo": { "required": true, "type": "string" }
|
552 | },
|
553 | "url": "/repos/:owner/:repo/check-runs/:check_run_id/annotations"
|
554 | },
|
555 | "listForRef": {
|
556 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
557 | "method": "GET",
|
558 | "params": {
|
559 | "check_name": { "type": "string" },
|
560 | "filter": { "enum": ["latest", "all"], "type": "string" },
|
561 | "owner": { "required": true, "type": "string" },
|
562 | "page": { "type": "integer" },
|
563 | "per_page": { "type": "integer" },
|
564 | "ref": { "required": true, "type": "string" },
|
565 | "repo": { "required": true, "type": "string" },
|
566 | "status": {
|
567 | "enum": ["queued", "in_progress", "completed"],
|
568 | "type": "string"
|
569 | }
|
570 | },
|
571 | "url": "/repos/:owner/:repo/commits/:ref/check-runs"
|
572 | },
|
573 | "listForSuite": {
|
574 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
575 | "method": "GET",
|
576 | "params": {
|
577 | "check_name": { "type": "string" },
|
578 | "check_suite_id": { "required": true, "type": "integer" },
|
579 | "filter": { "enum": ["latest", "all"], "type": "string" },
|
580 | "owner": { "required": true, "type": "string" },
|
581 | "page": { "type": "integer" },
|
582 | "per_page": { "type": "integer" },
|
583 | "repo": { "required": true, "type": "string" },
|
584 | "status": {
|
585 | "enum": ["queued", "in_progress", "completed"],
|
586 | "type": "string"
|
587 | }
|
588 | },
|
589 | "url": "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"
|
590 | },
|
591 | "listSuitesForRef": {
|
592 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
593 | "method": "GET",
|
594 | "params": {
|
595 | "app_id": { "type": "integer" },
|
596 | "check_name": { "type": "string" },
|
597 | "owner": { "required": true, "type": "string" },
|
598 | "page": { "type": "integer" },
|
599 | "per_page": { "type": "integer" },
|
600 | "ref": { "required": true, "type": "string" },
|
601 | "repo": { "required": true, "type": "string" }
|
602 | },
|
603 | "url": "/repos/:owner/:repo/commits/:ref/check-suites"
|
604 | },
|
605 | "rerequestSuite": {
|
606 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
607 | "method": "POST",
|
608 | "params": {
|
609 | "check_suite_id": { "required": true, "type": "integer" },
|
610 | "owner": { "required": true, "type": "string" },
|
611 | "repo": { "required": true, "type": "string" }
|
612 | },
|
613 | "url": "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"
|
614 | },
|
615 | "setSuitesPreferences": {
|
616 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
617 | "method": "PATCH",
|
618 | "params": {
|
619 | "auto_trigger_checks": { "type": "object[]" },
|
620 | "auto_trigger_checks[].app_id": { "required": true, "type": "integer" },
|
621 | "auto_trigger_checks[].setting": {
|
622 | "required": true,
|
623 | "type": "boolean"
|
624 | },
|
625 | "owner": { "required": true, "type": "string" },
|
626 | "repo": { "required": true, "type": "string" }
|
627 | },
|
628 | "url": "/repos/:owner/:repo/check-suites/preferences"
|
629 | },
|
630 | "update": {
|
631 | "headers": { "accept": "application/vnd.github.antiope-preview+json" },
|
632 | "method": "PATCH",
|
633 | "params": {
|
634 | "actions": { "type": "object[]" },
|
635 | "actions[].description": { "required": true, "type": "string" },
|
636 | "actions[].identifier": { "required": true, "type": "string" },
|
637 | "actions[].label": { "required": true, "type": "string" },
|
638 | "check_run_id": { "required": true, "type": "integer" },
|
639 | "completed_at": { "type": "string" },
|
640 | "conclusion": {
|
641 | "enum": [
|
642 | "success",
|
643 | "failure",
|
644 | "neutral",
|
645 | "cancelled",
|
646 | "timed_out",
|
647 | "action_required"
|
648 | ],
|
649 | "type": "string"
|
650 | },
|
651 | "details_url": { "type": "string" },
|
652 | "external_id": { "type": "string" },
|
653 | "name": { "type": "string" },
|
654 | "output": { "type": "object" },
|
655 | "output.annotations": { "type": "object[]" },
|
656 | "output.annotations[].annotation_level": {
|
657 | "enum": ["notice", "warning", "failure"],
|
658 | "required": true,
|
659 | "type": "string"
|
660 | },
|
661 | "output.annotations[].end_column": { "type": "integer" },
|
662 | "output.annotations[].end_line": {
|
663 | "required": true,
|
664 | "type": "integer"
|
665 | },
|
666 | "output.annotations[].message": { "required": true, "type": "string" },
|
667 | "output.annotations[].path": { "required": true, "type": "string" },
|
668 | "output.annotations[].raw_details": { "type": "string" },
|
669 | "output.annotations[].start_column": { "type": "integer" },
|
670 | "output.annotations[].start_line": {
|
671 | "required": true,
|
672 | "type": "integer"
|
673 | },
|
674 | "output.annotations[].title": { "type": "string" },
|
675 | "output.images": { "type": "object[]" },
|
676 | "output.images[].alt": { "required": true, "type": "string" },
|
677 | "output.images[].caption": { "type": "string" },
|
678 | "output.images[].image_url": { "required": true, "type": "string" },
|
679 | "output.summary": { "required": true, "type": "string" },
|
680 | "output.text": { "type": "string" },
|
681 | "output.title": { "type": "string" },
|
682 | "owner": { "required": true, "type": "string" },
|
683 | "repo": { "required": true, "type": "string" },
|
684 | "started_at": { "type": "string" },
|
685 | "status": {
|
686 | "enum": ["queued", "in_progress", "completed"],
|
687 | "type": "string"
|
688 | }
|
689 | },
|
690 | "url": "/repos/:owner/:repo/check-runs/:check_run_id"
|
691 | }
|
692 | },
|
693 | "codesOfConduct": {
|
694 | "getConductCode": {
|
695 | "headers": {
|
696 | "accept": "application/vnd.github.scarlet-witch-preview+json"
|
697 | },
|
698 | "method": "GET",
|
699 | "params": { "key": { "required": true, "type": "string" } },
|
700 | "url": "/codes_of_conduct/:key"
|
701 | },
|
702 | "getForRepo": {
|
703 | "headers": {
|
704 | "accept": "application/vnd.github.scarlet-witch-preview+json"
|
705 | },
|
706 | "method": "GET",
|
707 | "params": {
|
708 | "owner": { "required": true, "type": "string" },
|
709 | "repo": { "required": true, "type": "string" }
|
710 | },
|
711 | "url": "/repos/:owner/:repo/community/code_of_conduct"
|
712 | },
|
713 | "listConductCodes": {
|
714 | "headers": {
|
715 | "accept": "application/vnd.github.scarlet-witch-preview+json"
|
716 | },
|
717 | "method": "GET",
|
718 | "params": {},
|
719 | "url": "/codes_of_conduct"
|
720 | }
|
721 | },
|
722 | "emojis": { "get": { "method": "GET", "params": {}, "url": "/emojis" } },
|
723 | "enterpriseAdmin": {
|
724 | "addAuthorizedSshKey": {
|
725 | "method": "POST",
|
726 | "params": { "authorized_key": { "required": true, "type": "string" } },
|
727 | "url": "/setup/api/settings/authorized-keys"
|
728 | },
|
729 | "checkConfigurationStatus": {
|
730 | "method": "GET",
|
731 | "params": {},
|
732 | "url": "/setup/api/configcheck"
|
733 | },
|
734 | "checkMaintenanceStatus": {
|
735 | "method": "GET",
|
736 | "params": {},
|
737 | "url": "/setup/api/maintenance"
|
738 | },
|
739 | "createGlobalHook": {
|
740 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
741 | "method": "POST",
|
742 | "params": {
|
743 | "active": { "type": "boolean" },
|
744 | "config": { "required": true, "type": "object" },
|
745 | "config.content_type": { "type": "string" },
|
746 | "config.insecure_ssl": { "type": "string" },
|
747 | "config.secret": { "type": "string" },
|
748 | "config.url": { "required": true, "type": "string" },
|
749 | "events": { "type": "string[]" },
|
750 | "name": { "required": true, "type": "string" }
|
751 | },
|
752 | "url": "/admin/hooks"
|
753 | },
|
754 | "createImpersonationOAuthToken": {
|
755 | "method": "POST",
|
756 | "params": {
|
757 | "scopes": { "type": "string[]" },
|
758 | "username": { "required": true, "type": "string" }
|
759 | },
|
760 | "url": "/admin/users/:username/authorizations"
|
761 | },
|
762 | "createOrg": {
|
763 | "method": "POST",
|
764 | "params": {
|
765 | "admin": { "required": true, "type": "string" },
|
766 | "login": { "required": true, "type": "string" },
|
767 | "profile_name": { "type": "string" }
|
768 | },
|
769 | "url": "/admin/organizations"
|
770 | },
|
771 | "createPreReceiveEnvironment": {
|
772 | "method": "POST",
|
773 | "params": {
|
774 | "image_url": { "required": true, "type": "string" },
|
775 | "name": { "required": true, "type": "string" }
|
776 | },
|
777 | "url": "/admin/pre-receive-environments"
|
778 | },
|
779 | "createPreReceiveHook": {
|
780 | "method": "POST",
|
781 | "params": {
|
782 | "allow_downstream_configuration": { "type": "boolean" },
|
783 | "enforcement": { "type": "string" },
|
784 | "environment": { "required": true, "type": "object" },
|
785 | "name": { "required": true, "type": "string" },
|
786 | "script": { "required": true, "type": "string" },
|
787 | "script_repository": { "required": true, "type": "object" }
|
788 | },
|
789 | "url": "/admin/pre-receive-hooks"
|
790 | },
|
791 | "createUser": {
|
792 | "method": "POST",
|
793 | "params": {
|
794 | "email": { "type": "string" },
|
795 | "login": { "required": true, "type": "string" }
|
796 | },
|
797 | "url": "/admin/users"
|
798 | },
|
799 | "deleteGlobalHook": {
|
800 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
801 | "method": "DELETE",
|
802 | "params": { "hook_id": { "required": true, "type": "integer" } },
|
803 | "url": "/admin/hooks/:hook_id"
|
804 | },
|
805 | "deleteImpersonationOAuthToken": {
|
806 | "method": "DELETE",
|
807 | "params": { "username": { "required": true, "type": "string" } },
|
808 | "url": "/admin/users/:username/authorizations"
|
809 | },
|
810 | "deletePersonalAccessToken": {
|
811 | "method": "DELETE",
|
812 | "params": { "token_id": { "required": true, "type": "integer" } },
|
813 | "url": "/admin/tokens/:token_id"
|
814 | },
|
815 | "deletePreReceiveEnvironment": {
|
816 | "method": "DELETE",
|
817 | "params": {
|
818 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
819 | },
|
820 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
|
821 | },
|
822 | "deletePreReceiveHook": {
|
823 | "method": "DELETE",
|
824 | "params": {
|
825 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
826 | },
|
827 | "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
|
828 | },
|
829 | "deletePublicKey": {
|
830 | "method": "DELETE",
|
831 | "params": { "key_ids": { "required": true, "type": "string" } },
|
832 | "url": "/admin/keys/:key_ids"
|
833 | },
|
834 | "deleteUser": {
|
835 | "method": "DELETE",
|
836 | "params": { "username": { "required": true, "type": "string" } },
|
837 | "url": "/admin/users/:username"
|
838 | },
|
839 | "demoteSiteAdministratorToOrdinaryUser": {
|
840 | "method": "DELETE",
|
841 | "params": { "username": { "required": true, "type": "string" } },
|
842 | "url": "/users/:username/site_admin"
|
843 | },
|
844 | "enableOrDisableMaintenanceMode": {
|
845 | "method": "POST",
|
846 | "params": { "maintenance": { "required": true, "type": "string" } },
|
847 | "url": "/setup/api/maintenance"
|
848 | },
|
849 | "getGlobalHook": {
|
850 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
851 | "method": "GET",
|
852 | "params": { "hook_id": { "required": true, "type": "integer" } },
|
853 | "url": "/admin/hooks/:hook_id"
|
854 | },
|
855 | "getLicenseInformation": {
|
856 | "method": "GET",
|
857 | "params": {},
|
858 | "url": "/enterprise/settings/license"
|
859 | },
|
860 | "getPreReceiveEnvironment": {
|
861 | "method": "GET",
|
862 | "params": {
|
863 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
864 | },
|
865 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
|
866 | },
|
867 | "getPreReceiveEnvironmentDownloadStatus": {
|
868 | "method": "GET",
|
869 | "params": {
|
870 | "downloaded_at": { "type": "string" },
|
871 | "message": { "type": "string" },
|
872 | "pre_receive_environment_id": { "required": true, "type": "integer" },
|
873 | "state": { "type": "string" }
|
874 | },
|
875 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest"
|
876 | },
|
877 | "getPreReceiveHook": {
|
878 | "method": "GET",
|
879 | "params": {
|
880 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
881 | },
|
882 | "url": "/admin/pre-receive-hooks/:pre_receive_hook_id"
|
883 | },
|
884 | "getPreReceiveHookForOrg": {
|
885 | "method": "GET",
|
886 | "params": {
|
887 | "org": { "required": true, "type": "string" },
|
888 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
889 | },
|
890 | "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
|
891 | },
|
892 | "getPreReceiveHookForRepo": {
|
893 | "method": "GET",
|
894 | "params": {
|
895 | "owner": { "required": true, "type": "string" },
|
896 | "pre_receive_hook_id": { "required": true, "type": "integer" },
|
897 | "repo": { "required": true, "type": "string" }
|
898 | },
|
899 | "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
|
900 | },
|
901 | "getTypeStats": {
|
902 | "method": "GET",
|
903 | "params": { "type": { "required": true, "type": "string" } },
|
904 | "url": "/enterprise/stats/:type"
|
905 | },
|
906 | "listGlobalHooks": {
|
907 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
908 | "method": "GET",
|
909 | "params": {
|
910 | "page": { "type": "integer" },
|
911 | "per_page": { "type": "integer" }
|
912 | },
|
913 | "url": "/admin/hooks"
|
914 | },
|
915 | "listPersonalAccessTokens": {
|
916 | "method": "GET",
|
917 | "params": {
|
918 | "page": { "type": "integer" },
|
919 | "per_page": { "type": "integer" }
|
920 | },
|
921 | "url": "/admin/tokens"
|
922 | },
|
923 | "listPreReceiveEnvironments": {
|
924 | "method": "GET",
|
925 | "params": {
|
926 | "page": { "type": "integer" },
|
927 | "per_page": { "type": "integer" }
|
928 | },
|
929 | "url": "/admin/pre-receive-environments"
|
930 | },
|
931 | "listPreReceiveHooks": {
|
932 | "method": "GET",
|
933 | "params": {
|
934 | "page": { "type": "integer" },
|
935 | "per_page": { "type": "integer" }
|
936 | },
|
937 | "url": "/admin/pre-receive-hooks"
|
938 | },
|
939 | "listPreReceiveHooksForOrg": {
|
940 | "method": "GET",
|
941 | "params": {
|
942 | "org": { "required": true, "type": "string" },
|
943 | "page": { "type": "integer" },
|
944 | "per_page": { "type": "integer" }
|
945 | },
|
946 | "url": "/orgs/:org/pre-receive-hooks"
|
947 | },
|
948 | "listPreReceiveHooksForRepo": {
|
949 | "method": "GET",
|
950 | "params": {
|
951 | "owner": { "required": true, "type": "string" },
|
952 | "page": { "type": "integer" },
|
953 | "per_page": { "type": "integer" },
|
954 | "repo": { "required": true, "type": "string" }
|
955 | },
|
956 | "url": "/repos/:owner/:repo/pre-receive-hooks"
|
957 | },
|
958 | "modifySettings": {
|
959 | "method": "PUT",
|
960 | "params": { "settings": { "required": true, "type": "string" } },
|
961 | "url": "/setup/api/settings"
|
962 | },
|
963 | "pingGlobalHook": {
|
964 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
965 | "method": "POST",
|
966 | "params": { "hook_id": { "required": true, "type": "integer" } },
|
967 | "url": "/admin/hooks/:hook_id/pings"
|
968 | },
|
969 | "promoteOrdinaryUserToSiteAdministrator": {
|
970 | "method": "PUT",
|
971 | "params": { "username": { "required": true, "type": "string" } },
|
972 | "url": "/users/:username/site_admin"
|
973 | },
|
974 | "queueIndexingJob": {
|
975 | "method": "POST",
|
976 | "params": { "target": { "required": true, "type": "string" } },
|
977 | "url": "/staff/indexing_jobs"
|
978 | },
|
979 | "removeAuthorizedSshKey": {
|
980 | "method": "DELETE",
|
981 | "params": { "authorized_key": { "required": true, "type": "string" } },
|
982 | "url": "/setup/api/settings/authorized-keys"
|
983 | },
|
984 | "removeEnforcementOverridesForPreReceiveHookForOrg": {
|
985 | "method": "DELETE",
|
986 | "params": {
|
987 | "org": { "required": true, "type": "string" },
|
988 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
989 | },
|
990 | "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
|
991 | },
|
992 | "removeEnforcementOverridesForPreReceiveHookForRepo": {
|
993 | "method": "DELETE",
|
994 | "params": {
|
995 | "owner": { "required": true, "type": "string" },
|
996 | "pre_receive_hook_id": { "required": true, "type": "integer" },
|
997 | "repo": { "required": true, "type": "string" }
|
998 | },
|
999 | "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
|
1000 | },
|
1001 | "renameOrg": {
|
1002 | "method": "PATCH",
|
1003 | "params": {
|
1004 | "login": { "required": true, "type": "string" },
|
1005 | "org": { "required": true, "type": "string" }
|
1006 | },
|
1007 | "url": "/admin/organizations/:org"
|
1008 | },
|
1009 | "renameUser": {
|
1010 | "method": "PATCH",
|
1011 | "params": {
|
1012 | "login": { "required": true, "type": "string" },
|
1013 | "username": { "required": true, "type": "string" }
|
1014 | },
|
1015 | "url": "/admin/users/:username"
|
1016 | },
|
1017 | "retrieveAuthorizedSshKeys": {
|
1018 | "method": "GET",
|
1019 | "params": {},
|
1020 | "url": "/setup/api/settings/authorized-keys"
|
1021 | },
|
1022 | "retrieveSettings": {
|
1023 | "method": "GET",
|
1024 | "params": {},
|
1025 | "url": "/setup/api/settings"
|
1026 | },
|
1027 | "startConfigurationProcess": {
|
1028 | "method": "POST",
|
1029 | "params": {},
|
1030 | "url": "/setup/api/configure"
|
1031 | },
|
1032 | "suspendUser": {
|
1033 | "method": "PUT",
|
1034 | "params": {
|
1035 | "reason": { "type": "string" },
|
1036 | "username": { "required": true, "type": "string" }
|
1037 | },
|
1038 | "url": "/users/:username/suspended"
|
1039 | },
|
1040 | "syncLdapMappingForTeam": {
|
1041 | "method": "POST",
|
1042 | "params": { "team_id": { "required": true, "type": "integer" } },
|
1043 | "url": "/admin/ldap/teams/:team_id/sync"
|
1044 | },
|
1045 | "syncLdapMappingForUser": {
|
1046 | "method": "POST",
|
1047 | "params": { "username": { "required": true, "type": "string" } },
|
1048 | "url": "/admin/ldap/users/:username/sync"
|
1049 | },
|
1050 | "triggerPreReceiveEnvironmentDownload": {
|
1051 | "method": "POST",
|
1052 | "params": {
|
1053 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
1054 | },
|
1055 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads"
|
1056 | },
|
1057 | "unsuspendUser": {
|
1058 | "method": "DELETE",
|
1059 | "params": {
|
1060 | "reason": { "type": "string" },
|
1061 | "username": { "required": true, "type": "string" }
|
1062 | },
|
1063 | "url": "/users/:username/suspended"
|
1064 | },
|
1065 | "updateGlobalHook": {
|
1066 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
1067 | "method": "PATCH",
|
1068 | "params": {
|
1069 | "active": { "type": "boolean" },
|
1070 | "config": { "type": "object" },
|
1071 | "config.content_type": { "type": "string" },
|
1072 | "config.insecure_ssl": { "type": "string" },
|
1073 | "config.secret": { "type": "string" },
|
1074 | "config.url": { "required": true, "type": "string" },
|
1075 | "events": { "type": "string[]" },
|
1076 | "hook_id": { "required": true, "type": "integer" }
|
1077 | },
|
1078 | "url": "/admin/hooks/:hook_id"
|
1079 | },
|
1080 | "updateLdapMappingForTeam": {
|
1081 | "method": "PATCH",
|
1082 | "params": {
|
1083 | "ldap_dn": { "type": "string" },
|
1084 | "team_id": { "required": true, "type": "integer" }
|
1085 | },
|
1086 | "url": "/admin/ldap/teams/:team_id/mapping"
|
1087 | },
|
1088 | "updateLdapMappingForUser": {
|
1089 | "method": "PATCH",
|
1090 | "params": {
|
1091 | "ldap_dn": { "type": "string" },
|
1092 | "username": { "required": true, "type": "string" }
|
1093 | },
|
1094 | "url": "/admin/ldap/users/:username/mapping"
|
1095 | },
|
1096 | "updatePreReceiveEnvironment": {
|
1097 | "method": "PATCH",
|
1098 | "params": {
|
1099 | "image_url": { "type": "string" },
|
1100 | "name": { "type": "string" },
|
1101 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
1102 | },
|
1103 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
|
1104 | },
|
1105 | "updatePreReceiveHook": {
|
1106 | "method": "PATCH",
|
1107 | "params": {
|
1108 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
1109 | },
|
1110 | "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
|
1111 | },
|
1112 | "updatePreReceiveHookEnforcementForOrg": {
|
1113 | "method": "PATCH",
|
1114 | "params": {
|
1115 | "org": { "required": true, "type": "string" },
|
1116 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
1117 | },
|
1118 | "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
|
1119 | },
|
1120 | "updatePreReceiveHookEnforcementForRepo": {
|
1121 | "method": "PATCH",
|
1122 | "params": {
|
1123 | "owner": { "required": true, "type": "string" },
|
1124 | "pre_receive_hook_id": { "required": true, "type": "integer" },
|
1125 | "repo": { "required": true, "type": "string" }
|
1126 | },
|
1127 | "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
|
1128 | },
|
1129 | "upgradeLicense": {
|
1130 | "method": "POST",
|
1131 | "params": { "license": { "type": "string" } },
|
1132 | "url": "/setup/api/upgrade"
|
1133 | },
|
1134 | "uploadLicenseForFirstTime": {
|
1135 | "method": "POST",
|
1136 | "params": {
|
1137 | "license": { "required": true, "type": "string" },
|
1138 | "password": { "type": "string" },
|
1139 | "settings": { "type": "string" }
|
1140 | },
|
1141 | "url": "/setup/api/start"
|
1142 | }
|
1143 | },
|
1144 | "gists": {
|
1145 | "checkIsStarred": {
|
1146 | "method": "GET",
|
1147 | "params": { "gist_id": { "required": true, "type": "string" } },
|
1148 | "url": "/gists/:gist_id/star"
|
1149 | },
|
1150 | "create": {
|
1151 | "method": "POST",
|
1152 | "params": {
|
1153 | "description": { "type": "string" },
|
1154 | "files": { "required": true, "type": "object" },
|
1155 | "files.content": { "type": "string" },
|
1156 | "public": { "type": "boolean" }
|
1157 | },
|
1158 | "url": "/gists"
|
1159 | },
|
1160 | "createComment": {
|
1161 | "method": "POST",
|
1162 | "params": {
|
1163 | "body": { "required": true, "type": "string" },
|
1164 | "gist_id": { "required": true, "type": "string" }
|
1165 | },
|
1166 | "url": "/gists/:gist_id/comments"
|
1167 | },
|
1168 | "delete": {
|
1169 | "method": "DELETE",
|
1170 | "params": { "gist_id": { "required": true, "type": "string" } },
|
1171 | "url": "/gists/:gist_id"
|
1172 | },
|
1173 | "deleteComment": {
|
1174 | "method": "DELETE",
|
1175 | "params": {
|
1176 | "comment_id": { "required": true, "type": "integer" },
|
1177 | "gist_id": { "required": true, "type": "string" }
|
1178 | },
|
1179 | "url": "/gists/:gist_id/comments/:comment_id"
|
1180 | },
|
1181 | "fork": {
|
1182 | "method": "POST",
|
1183 | "params": { "gist_id": { "required": true, "type": "string" } },
|
1184 | "url": "/gists/:gist_id/forks"
|
1185 | },
|
1186 | "get": {
|
1187 | "method": "GET",
|
1188 | "params": { "gist_id": { "required": true, "type": "string" } },
|
1189 | "url": "/gists/:gist_id"
|
1190 | },
|
1191 | "getComment": {
|
1192 | "method": "GET",
|
1193 | "params": {
|
1194 | "comment_id": { "required": true, "type": "integer" },
|
1195 | "gist_id": { "required": true, "type": "string" }
|
1196 | },
|
1197 | "url": "/gists/:gist_id/comments/:comment_id"
|
1198 | },
|
1199 | "getRevision": {
|
1200 | "method": "GET",
|
1201 | "params": {
|
1202 | "gist_id": { "required": true, "type": "string" },
|
1203 | "sha": { "required": true, "type": "string" }
|
1204 | },
|
1205 | "url": "/gists/:gist_id/:sha"
|
1206 | },
|
1207 | "list": {
|
1208 | "method": "GET",
|
1209 | "params": {
|
1210 | "page": { "type": "integer" },
|
1211 | "per_page": { "type": "integer" },
|
1212 | "since": { "type": "string" }
|
1213 | },
|
1214 | "url": "/gists"
|
1215 | },
|
1216 | "listComments": {
|
1217 | "method": "GET",
|
1218 | "params": {
|
1219 | "gist_id": { "required": true, "type": "string" },
|
1220 | "page": { "type": "integer" },
|
1221 | "per_page": { "type": "integer" }
|
1222 | },
|
1223 | "url": "/gists/:gist_id/comments"
|
1224 | },
|
1225 | "listCommits": {
|
1226 | "method": "GET",
|
1227 | "params": {
|
1228 | "gist_id": { "required": true, "type": "string" },
|
1229 | "page": { "type": "integer" },
|
1230 | "per_page": { "type": "integer" }
|
1231 | },
|
1232 | "url": "/gists/:gist_id/commits"
|
1233 | },
|
1234 | "listForks": {
|
1235 | "method": "GET",
|
1236 | "params": {
|
1237 | "gist_id": { "required": true, "type": "string" },
|
1238 | "page": { "type": "integer" },
|
1239 | "per_page": { "type": "integer" }
|
1240 | },
|
1241 | "url": "/gists/:gist_id/forks"
|
1242 | },
|
1243 | "listPublic": {
|
1244 | "method": "GET",
|
1245 | "params": {
|
1246 | "page": { "type": "integer" },
|
1247 | "per_page": { "type": "integer" },
|
1248 | "since": { "type": "string" }
|
1249 | },
|
1250 | "url": "/gists/public"
|
1251 | },
|
1252 | "listPublicForUser": {
|
1253 | "method": "GET",
|
1254 | "params": {
|
1255 | "page": { "type": "integer" },
|
1256 | "per_page": { "type": "integer" },
|
1257 | "since": { "type": "string" },
|
1258 | "username": { "required": true, "type": "string" }
|
1259 | },
|
1260 | "url": "/users/:username/gists"
|
1261 | },
|
1262 | "listStarred": {
|
1263 | "method": "GET",
|
1264 | "params": {
|
1265 | "page": { "type": "integer" },
|
1266 | "per_page": { "type": "integer" },
|
1267 | "since": { "type": "string" }
|
1268 | },
|
1269 | "url": "/gists/starred"
|
1270 | },
|
1271 | "star": {
|
1272 | "method": "PUT",
|
1273 | "params": { "gist_id": { "required": true, "type": "string" } },
|
1274 | "url": "/gists/:gist_id/star"
|
1275 | },
|
1276 | "unstar": {
|
1277 | "method": "DELETE",
|
1278 | "params": { "gist_id": { "required": true, "type": "string" } },
|
1279 | "url": "/gists/:gist_id/star"
|
1280 | },
|
1281 | "update": {
|
1282 | "method": "PATCH",
|
1283 | "params": {
|
1284 | "description": { "type": "string" },
|
1285 | "files": { "type": "object" },
|
1286 | "files.content": { "type": "string" },
|
1287 | "files.filename": { "type": "string" },
|
1288 | "gist_id": { "required": true, "type": "string" }
|
1289 | },
|
1290 | "url": "/gists/:gist_id"
|
1291 | },
|
1292 | "updateComment": {
|
1293 | "method": "PATCH",
|
1294 | "params": {
|
1295 | "body": { "required": true, "type": "string" },
|
1296 | "comment_id": { "required": true, "type": "integer" },
|
1297 | "gist_id": { "required": true, "type": "string" }
|
1298 | },
|
1299 | "url": "/gists/:gist_id/comments/:comment_id"
|
1300 | }
|
1301 | },
|
1302 | "git": {
|
1303 | "createBlob": {
|
1304 | "method": "POST",
|
1305 | "params": {
|
1306 | "content": { "required": true, "type": "string" },
|
1307 | "encoding": { "type": "string" },
|
1308 | "owner": { "required": true, "type": "string" },
|
1309 | "repo": { "required": true, "type": "string" }
|
1310 | },
|
1311 | "url": "/repos/:owner/:repo/git/blobs"
|
1312 | },
|
1313 | "createCommit": {
|
1314 | "method": "POST",
|
1315 | "params": {
|
1316 | "author": { "type": "object" },
|
1317 | "author.date": { "type": "string" },
|
1318 | "author.email": { "type": "string" },
|
1319 | "author.name": { "type": "string" },
|
1320 | "committer": { "type": "object" },
|
1321 | "committer.date": { "type": "string" },
|
1322 | "committer.email": { "type": "string" },
|
1323 | "committer.name": { "type": "string" },
|
1324 | "message": { "required": true, "type": "string" },
|
1325 | "owner": { "required": true, "type": "string" },
|
1326 | "parents": { "required": true, "type": "string[]" },
|
1327 | "repo": { "required": true, "type": "string" },
|
1328 | "signature": { "type": "string" },
|
1329 | "tree": { "required": true, "type": "string" }
|
1330 | },
|
1331 | "url": "/repos/:owner/:repo/git/commits"
|
1332 | },
|
1333 | "createRef": {
|
1334 | "method": "POST",
|
1335 | "params": {
|
1336 | "owner": { "required": true, "type": "string" },
|
1337 | "ref": { "required": true, "type": "string" },
|
1338 | "repo": { "required": true, "type": "string" },
|
1339 | "sha": { "required": true, "type": "string" }
|
1340 | },
|
1341 | "url": "/repos/:owner/:repo/git/refs"
|
1342 | },
|
1343 | "createTag": {
|
1344 | "method": "POST",
|
1345 | "params": {
|
1346 | "message": { "required": true, "type": "string" },
|
1347 | "object": { "required": true, "type": "string" },
|
1348 | "owner": { "required": true, "type": "string" },
|
1349 | "repo": { "required": true, "type": "string" },
|
1350 | "tag": { "required": true, "type": "string" },
|
1351 | "tagger": { "type": "object" },
|
1352 | "tagger.date": { "type": "string" },
|
1353 | "tagger.email": { "type": "string" },
|
1354 | "tagger.name": { "type": "string" },
|
1355 | "type": {
|
1356 | "enum": ["commit", "tree", "blob"],
|
1357 | "required": true,
|
1358 | "type": "string"
|
1359 | }
|
1360 | },
|
1361 | "url": "/repos/:owner/:repo/git/tags"
|
1362 | },
|
1363 | "createTree": {
|
1364 | "method": "POST",
|
1365 | "params": {
|
1366 | "base_tree": { "type": "string" },
|
1367 | "owner": { "required": true, "type": "string" },
|
1368 | "repo": { "required": true, "type": "string" },
|
1369 | "tree": { "required": true, "type": "object[]" },
|
1370 | "tree[].content": { "type": "string" },
|
1371 | "tree[].mode": {
|
1372 | "enum": ["100644", "100755", "040000", "160000", "120000"],
|
1373 | "type": "string"
|
1374 | },
|
1375 | "tree[].path": { "type": "string" },
|
1376 | "tree[].sha": { "allowNull": true, "type": "string" },
|
1377 | "tree[].type": { "enum": ["blob", "tree", "commit"], "type": "string" }
|
1378 | },
|
1379 | "url": "/repos/:owner/:repo/git/trees"
|
1380 | },
|
1381 | "deleteRef": {
|
1382 | "method": "DELETE",
|
1383 | "params": {
|
1384 | "owner": { "required": true, "type": "string" },
|
1385 | "ref": { "required": true, "type": "string" },
|
1386 | "repo": { "required": true, "type": "string" }
|
1387 | },
|
1388 | "url": "/repos/:owner/:repo/git/refs/:ref"
|
1389 | },
|
1390 | "getBlob": {
|
1391 | "method": "GET",
|
1392 | "params": {
|
1393 | "file_sha": { "required": true, "type": "string" },
|
1394 | "owner": { "required": true, "type": "string" },
|
1395 | "repo": { "required": true, "type": "string" }
|
1396 | },
|
1397 | "url": "/repos/:owner/:repo/git/blobs/:file_sha"
|
1398 | },
|
1399 | "getCommit": {
|
1400 | "method": "GET",
|
1401 | "params": {
|
1402 | "commit_sha": { "required": true, "type": "string" },
|
1403 | "owner": { "required": true, "type": "string" },
|
1404 | "repo": { "required": true, "type": "string" }
|
1405 | },
|
1406 | "url": "/repos/:owner/:repo/git/commits/:commit_sha"
|
1407 | },
|
1408 | "getRef": {
|
1409 | "method": "GET",
|
1410 | "params": {
|
1411 | "owner": { "required": true, "type": "string" },
|
1412 | "ref": { "required": true, "type": "string" },
|
1413 | "repo": { "required": true, "type": "string" }
|
1414 | },
|
1415 | "url": "/repos/:owner/:repo/git/refs/:ref"
|
1416 | },
|
1417 | "getTag": {
|
1418 | "method": "GET",
|
1419 | "params": {
|
1420 | "owner": { "required": true, "type": "string" },
|
1421 | "repo": { "required": true, "type": "string" },
|
1422 | "tag_sha": { "required": true, "type": "string" }
|
1423 | },
|
1424 | "url": "/repos/:owner/:repo/git/tags/:tag_sha"
|
1425 | },
|
1426 | "getTree": {
|
1427 | "method": "GET",
|
1428 | "params": {
|
1429 | "owner": { "required": true, "type": "string" },
|
1430 | "recursive": { "enum": ["1"], "type": "integer" },
|
1431 | "repo": { "required": true, "type": "string" },
|
1432 | "tree_sha": { "required": true, "type": "string" }
|
1433 | },
|
1434 | "url": "/repos/:owner/:repo/git/trees/:tree_sha"
|
1435 | },
|
1436 | "listRefs": {
|
1437 | "method": "GET",
|
1438 | "params": {
|
1439 | "namespace": { "type": "string" },
|
1440 | "owner": { "required": true, "type": "string" },
|
1441 | "page": { "type": "integer" },
|
1442 | "per_page": { "type": "integer" },
|
1443 | "repo": { "required": true, "type": "string" }
|
1444 | },
|
1445 | "url": "/repos/:owner/:repo/git/refs/:namespace"
|
1446 | },
|
1447 | "updateRef": {
|
1448 | "method": "PATCH",
|
1449 | "params": {
|
1450 | "force": { "type": "boolean" },
|
1451 | "owner": { "required": true, "type": "string" },
|
1452 | "ref": { "required": true, "type": "string" },
|
1453 | "repo": { "required": true, "type": "string" },
|
1454 | "sha": { "required": true, "type": "string" }
|
1455 | },
|
1456 | "url": "/repos/:owner/:repo/git/refs/:ref"
|
1457 | }
|
1458 | },
|
1459 | "gitignore": {
|
1460 | "getTemplate": {
|
1461 | "method": "GET",
|
1462 | "params": { "name": { "required": true, "type": "string" } },
|
1463 | "url": "/gitignore/templates/:name"
|
1464 | },
|
1465 | "listTemplates": {
|
1466 | "method": "GET",
|
1467 | "params": {},
|
1468 | "url": "/gitignore/templates"
|
1469 | }
|
1470 | },
|
1471 | "issues": {
|
1472 | "addAssignees": {
|
1473 | "method": "POST",
|
1474 | "params": {
|
1475 | "assignees": { "type": "string[]" },
|
1476 | "issue_number": { "required": true, "type": "integer" },
|
1477 | "number": {
|
1478 | "alias": "issue_number",
|
1479 | "deprecated": true,
|
1480 | "type": "integer"
|
1481 | },
|
1482 | "owner": { "required": true, "type": "string" },
|
1483 | "repo": { "required": true, "type": "string" }
|
1484 | },
|
1485 | "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
|
1486 | },
|
1487 | "addLabels": {
|
1488 | "method": "POST",
|
1489 | "params": {
|
1490 | "issue_number": { "required": true, "type": "integer" },
|
1491 | "labels": { "required": true, "type": "string[]" },
|
1492 | "number": {
|
1493 | "alias": "issue_number",
|
1494 | "deprecated": true,
|
1495 | "type": "integer"
|
1496 | },
|
1497 | "owner": { "required": true, "type": "string" },
|
1498 | "repo": { "required": true, "type": "string" }
|
1499 | },
|
1500 | "url": "/repos/:owner/:repo/issues/:issue_number/labels"
|
1501 | },
|
1502 | "checkAssignee": {
|
1503 | "method": "GET",
|
1504 | "params": {
|
1505 | "assignee": { "required": true, "type": "string" },
|
1506 | "owner": { "required": true, "type": "string" },
|
1507 | "repo": { "required": true, "type": "string" }
|
1508 | },
|
1509 | "url": "/repos/:owner/:repo/assignees/:assignee"
|
1510 | },
|
1511 | "create": {
|
1512 | "method": "POST",
|
1513 | "params": {
|
1514 | "assignee": { "type": "string" },
|
1515 | "assignees": { "type": "string[]" },
|
1516 | "body": { "type": "string" },
|
1517 | "labels": { "type": "string[]" },
|
1518 | "milestone": { "type": "integer" },
|
1519 | "owner": { "required": true, "type": "string" },
|
1520 | "repo": { "required": true, "type": "string" },
|
1521 | "title": { "required": true, "type": "string" }
|
1522 | },
|
1523 | "url": "/repos/:owner/:repo/issues"
|
1524 | },
|
1525 | "createComment": {
|
1526 | "method": "POST",
|
1527 | "params": {
|
1528 | "body": { "required": true, "type": "string" },
|
1529 | "issue_number": { "required": true, "type": "integer" },
|
1530 | "number": {
|
1531 | "alias": "issue_number",
|
1532 | "deprecated": true,
|
1533 | "type": "integer"
|
1534 | },
|
1535 | "owner": { "required": true, "type": "string" },
|
1536 | "repo": { "required": true, "type": "string" }
|
1537 | },
|
1538 | "url": "/repos/:owner/:repo/issues/:issue_number/comments"
|
1539 | },
|
1540 | "createLabel": {
|
1541 | "method": "POST",
|
1542 | "params": {
|
1543 | "color": { "required": true, "type": "string" },
|
1544 | "description": { "type": "string" },
|
1545 | "name": { "required": true, "type": "string" },
|
1546 | "owner": { "required": true, "type": "string" },
|
1547 | "repo": { "required": true, "type": "string" }
|
1548 | },
|
1549 | "url": "/repos/:owner/:repo/labels"
|
1550 | },
|
1551 | "createMilestone": {
|
1552 | "method": "POST",
|
1553 | "params": {
|
1554 | "description": { "type": "string" },
|
1555 | "due_on": { "type": "string" },
|
1556 | "owner": { "required": true, "type": "string" },
|
1557 | "repo": { "required": true, "type": "string" },
|
1558 | "state": { "enum": ["open", "closed"], "type": "string" },
|
1559 | "title": { "required": true, "type": "string" }
|
1560 | },
|
1561 | "url": "/repos/:owner/:repo/milestones"
|
1562 | },
|
1563 | "deleteComment": {
|
1564 | "method": "DELETE",
|
1565 | "params": {
|
1566 | "comment_id": { "required": true, "type": "integer" },
|
1567 | "owner": { "required": true, "type": "string" },
|
1568 | "repo": { "required": true, "type": "string" }
|
1569 | },
|
1570 | "url": "/repos/:owner/:repo/issues/comments/:comment_id"
|
1571 | },
|
1572 | "deleteLabel": {
|
1573 | "method": "DELETE",
|
1574 | "params": {
|
1575 | "name": { "required": true, "type": "string" },
|
1576 | "owner": { "required": true, "type": "string" },
|
1577 | "repo": { "required": true, "type": "string" }
|
1578 | },
|
1579 | "url": "/repos/:owner/:repo/labels/:name"
|
1580 | },
|
1581 | "deleteMilestone": {
|
1582 | "method": "DELETE",
|
1583 | "params": {
|
1584 | "milestone_number": { "required": true, "type": "integer" },
|
1585 | "number": {
|
1586 | "alias": "milestone_number",
|
1587 | "deprecated": true,
|
1588 | "type": "integer"
|
1589 | },
|
1590 | "owner": { "required": true, "type": "string" },
|
1591 | "repo": { "required": true, "type": "string" }
|
1592 | },
|
1593 | "url": "/repos/:owner/:repo/milestones/:milestone_number"
|
1594 | },
|
1595 | "get": {
|
1596 | "method": "GET",
|
1597 | "params": {
|
1598 | "issue_number": { "required": true, "type": "integer" },
|
1599 | "number": {
|
1600 | "alias": "issue_number",
|
1601 | "deprecated": true,
|
1602 | "type": "integer"
|
1603 | },
|
1604 | "owner": { "required": true, "type": "string" },
|
1605 | "repo": { "required": true, "type": "string" }
|
1606 | },
|
1607 | "url": "/repos/:owner/:repo/issues/:issue_number"
|
1608 | },
|
1609 | "getComment": {
|
1610 | "method": "GET",
|
1611 | "params": {
|
1612 | "comment_id": { "required": true, "type": "integer" },
|
1613 | "owner": { "required": true, "type": "string" },
|
1614 | "page": { "type": "integer" },
|
1615 | "per_page": { "type": "integer" },
|
1616 | "repo": { "required": true, "type": "string" }
|
1617 | },
|
1618 | "url": "/repos/:owner/:repo/issues/comments/:comment_id"
|
1619 | },
|
1620 | "getEvent": {
|
1621 | "method": "GET",
|
1622 | "params": {
|
1623 | "event_id": { "required": true, "type": "integer" },
|
1624 | "owner": { "required": true, "type": "string" },
|
1625 | "repo": { "required": true, "type": "string" }
|
1626 | },
|
1627 | "url": "/repos/:owner/:repo/issues/events/:event_id"
|
1628 | },
|
1629 | "getLabel": {
|
1630 | "method": "GET",
|
1631 | "params": {
|
1632 | "name": { "required": true, "type": "string" },
|
1633 | "owner": { "required": true, "type": "string" },
|
1634 | "repo": { "required": true, "type": "string" }
|
1635 | },
|
1636 | "url": "/repos/:owner/:repo/labels/:name"
|
1637 | },
|
1638 | "getMilestone": {
|
1639 | "method": "GET",
|
1640 | "params": {
|
1641 | "milestone_number": { "required": true, "type": "integer" },
|
1642 | "number": {
|
1643 | "alias": "milestone_number",
|
1644 | "deprecated": true,
|
1645 | "type": "integer"
|
1646 | },
|
1647 | "owner": { "required": true, "type": "string" },
|
1648 | "repo": { "required": true, "type": "string" }
|
1649 | },
|
1650 | "url": "/repos/:owner/:repo/milestones/:milestone_number"
|
1651 | },
|
1652 | "list": {
|
1653 | "method": "GET",
|
1654 | "params": {
|
1655 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
1656 | "filter": {
|
1657 | "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
|
1658 | "type": "string"
|
1659 | },
|
1660 | "labels": { "type": "string" },
|
1661 | "page": { "type": "integer" },
|
1662 | "per_page": { "type": "integer" },
|
1663 | "since": { "type": "string" },
|
1664 | "sort": {
|
1665 | "enum": ["created", "updated", "comments"],
|
1666 | "type": "string"
|
1667 | },
|
1668 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
1669 | },
|
1670 | "url": "/issues"
|
1671 | },
|
1672 | "listAssignees": {
|
1673 | "method": "GET",
|
1674 | "params": {
|
1675 | "owner": { "required": true, "type": "string" },
|
1676 | "page": { "type": "integer" },
|
1677 | "per_page": { "type": "integer" },
|
1678 | "repo": { "required": true, "type": "string" }
|
1679 | },
|
1680 | "url": "/repos/:owner/:repo/assignees"
|
1681 | },
|
1682 | "listComments": {
|
1683 | "method": "GET",
|
1684 | "params": {
|
1685 | "issue_number": { "required": true, "type": "integer" },
|
1686 | "number": {
|
1687 | "alias": "issue_number",
|
1688 | "deprecated": true,
|
1689 | "type": "integer"
|
1690 | },
|
1691 | "owner": { "required": true, "type": "string" },
|
1692 | "page": { "type": "integer" },
|
1693 | "per_page": { "type": "integer" },
|
1694 | "repo": { "required": true, "type": "string" },
|
1695 | "since": { "type": "string" }
|
1696 | },
|
1697 | "url": "/repos/:owner/:repo/issues/:issue_number/comments"
|
1698 | },
|
1699 | "listCommentsForRepo": {
|
1700 | "method": "GET",
|
1701 | "params": {
|
1702 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
1703 | "owner": { "required": true, "type": "string" },
|
1704 | "repo": { "required": true, "type": "string" },
|
1705 | "since": { "type": "string" },
|
1706 | "sort": { "enum": ["created", "updated"], "type": "string" }
|
1707 | },
|
1708 | "url": "/repos/:owner/:repo/issues/comments"
|
1709 | },
|
1710 | "listEvents": {
|
1711 | "method": "GET",
|
1712 | "params": {
|
1713 | "issue_number": { "required": true, "type": "integer" },
|
1714 | "number": {
|
1715 | "alias": "issue_number",
|
1716 | "deprecated": true,
|
1717 | "type": "integer"
|
1718 | },
|
1719 | "owner": { "required": true, "type": "string" },
|
1720 | "page": { "type": "integer" },
|
1721 | "per_page": { "type": "integer" },
|
1722 | "repo": { "required": true, "type": "string" }
|
1723 | },
|
1724 | "url": "/repos/:owner/:repo/issues/:issue_number/events"
|
1725 | },
|
1726 | "listEventsForRepo": {
|
1727 | "method": "GET",
|
1728 | "params": {
|
1729 | "owner": { "required": true, "type": "string" },
|
1730 | "page": { "type": "integer" },
|
1731 | "per_page": { "type": "integer" },
|
1732 | "repo": { "required": true, "type": "string" }
|
1733 | },
|
1734 | "url": "/repos/:owner/:repo/issues/events"
|
1735 | },
|
1736 | "listEventsForTimeline": {
|
1737 | "headers": {
|
1738 | "accept": "application/vnd.github.mockingbird-preview+json"
|
1739 | },
|
1740 | "method": "GET",
|
1741 | "params": {
|
1742 | "issue_number": { "required": true, "type": "integer" },
|
1743 | "number": {
|
1744 | "alias": "issue_number",
|
1745 | "deprecated": true,
|
1746 | "type": "integer"
|
1747 | },
|
1748 | "owner": { "required": true, "type": "string" },
|
1749 | "page": { "type": "integer" },
|
1750 | "per_page": { "type": "integer" },
|
1751 | "repo": { "required": true, "type": "string" }
|
1752 | },
|
1753 | "url": "/repos/:owner/:repo/issues/:issue_number/timeline"
|
1754 | },
|
1755 | "listForAuthenticatedUser": {
|
1756 | "method": "GET",
|
1757 | "params": {
|
1758 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
1759 | "filter": {
|
1760 | "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
|
1761 | "type": "string"
|
1762 | },
|
1763 | "labels": { "type": "string" },
|
1764 | "page": { "type": "integer" },
|
1765 | "per_page": { "type": "integer" },
|
1766 | "since": { "type": "string" },
|
1767 | "sort": {
|
1768 | "enum": ["created", "updated", "comments"],
|
1769 | "type": "string"
|
1770 | },
|
1771 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
1772 | },
|
1773 | "url": "/user/issues"
|
1774 | },
|
1775 | "listForOrg": {
|
1776 | "method": "GET",
|
1777 | "params": {
|
1778 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
1779 | "filter": {
|
1780 | "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
|
1781 | "type": "string"
|
1782 | },
|
1783 | "labels": { "type": "string" },
|
1784 | "org": { "required": true, "type": "string" },
|
1785 | "page": { "type": "integer" },
|
1786 | "per_page": { "type": "integer" },
|
1787 | "since": { "type": "string" },
|
1788 | "sort": {
|
1789 | "enum": ["created", "updated", "comments"],
|
1790 | "type": "string"
|
1791 | },
|
1792 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
1793 | },
|
1794 | "url": "/orgs/:org/issues"
|
1795 | },
|
1796 | "listForRepo": {
|
1797 | "method": "GET",
|
1798 | "params": {
|
1799 | "assignee": { "type": "string" },
|
1800 | "creator": { "type": "string" },
|
1801 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
1802 | "labels": { "type": "string" },
|
1803 | "mentioned": { "type": "string" },
|
1804 | "milestone": { "type": "string" },
|
1805 | "owner": { "required": true, "type": "string" },
|
1806 | "page": { "type": "integer" },
|
1807 | "per_page": { "type": "integer" },
|
1808 | "repo": { "required": true, "type": "string" },
|
1809 | "since": { "type": "string" },
|
1810 | "sort": {
|
1811 | "enum": ["created", "updated", "comments"],
|
1812 | "type": "string"
|
1813 | },
|
1814 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
1815 | },
|
1816 | "url": "/repos/:owner/:repo/issues"
|
1817 | },
|
1818 | "listLabelsForMilestone": {
|
1819 | "method": "GET",
|
1820 | "params": {
|
1821 | "milestone_number": { "required": true, "type": "integer" },
|
1822 | "number": {
|
1823 | "alias": "milestone_number",
|
1824 | "deprecated": true,
|
1825 | "type": "integer"
|
1826 | },
|
1827 | "owner": { "required": true, "type": "string" },
|
1828 | "page": { "type": "integer" },
|
1829 | "per_page": { "type": "integer" },
|
1830 | "repo": { "required": true, "type": "string" }
|
1831 | },
|
1832 | "url": "/repos/:owner/:repo/milestones/:milestone_number/labels"
|
1833 | },
|
1834 | "listLabelsForRepo": {
|
1835 | "method": "GET",
|
1836 | "params": {
|
1837 | "owner": { "required": true, "type": "string" },
|
1838 | "page": { "type": "integer" },
|
1839 | "per_page": { "type": "integer" },
|
1840 | "repo": { "required": true, "type": "string" }
|
1841 | },
|
1842 | "url": "/repos/:owner/:repo/labels"
|
1843 | },
|
1844 | "listLabelsOnIssue": {
|
1845 | "method": "GET",
|
1846 | "params": {
|
1847 | "issue_number": { "required": true, "type": "integer" },
|
1848 | "number": {
|
1849 | "alias": "issue_number",
|
1850 | "deprecated": true,
|
1851 | "type": "integer"
|
1852 | },
|
1853 | "owner": { "required": true, "type": "string" },
|
1854 | "page": { "type": "integer" },
|
1855 | "per_page": { "type": "integer" },
|
1856 | "repo": { "required": true, "type": "string" }
|
1857 | },
|
1858 | "url": "/repos/:owner/:repo/issues/:issue_number/labels"
|
1859 | },
|
1860 | "listMilestonesForRepo": {
|
1861 | "method": "GET",
|
1862 | "params": {
|
1863 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
1864 | "owner": { "required": true, "type": "string" },
|
1865 | "page": { "type": "integer" },
|
1866 | "per_page": { "type": "integer" },
|
1867 | "repo": { "required": true, "type": "string" },
|
1868 | "sort": { "enum": ["due_on", "completeness"], "type": "string" },
|
1869 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
1870 | },
|
1871 | "url": "/repos/:owner/:repo/milestones"
|
1872 | },
|
1873 | "lock": {
|
1874 | "method": "PUT",
|
1875 | "params": {
|
1876 | "issue_number": { "required": true, "type": "integer" },
|
1877 | "lock_reason": {
|
1878 | "enum": ["off-topic", "too heated", "resolved", "spam"],
|
1879 | "type": "string"
|
1880 | },
|
1881 | "number": {
|
1882 | "alias": "issue_number",
|
1883 | "deprecated": true,
|
1884 | "type": "integer"
|
1885 | },
|
1886 | "owner": { "required": true, "type": "string" },
|
1887 | "repo": { "required": true, "type": "string" }
|
1888 | },
|
1889 | "url": "/repos/:owner/:repo/issues/:issue_number/lock"
|
1890 | },
|
1891 | "removeAssignees": {
|
1892 | "method": "DELETE",
|
1893 | "params": {
|
1894 | "assignees": { "type": "string[]" },
|
1895 | "issue_number": { "required": true, "type": "integer" },
|
1896 | "number": {
|
1897 | "alias": "issue_number",
|
1898 | "deprecated": true,
|
1899 | "type": "integer"
|
1900 | },
|
1901 | "owner": { "required": true, "type": "string" },
|
1902 | "repo": { "required": true, "type": "string" }
|
1903 | },
|
1904 | "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
|
1905 | },
|
1906 | "removeLabel": {
|
1907 | "method": "DELETE",
|
1908 | "params": {
|
1909 | "issue_number": { "required": true, "type": "integer" },
|
1910 | "name": { "required": true, "type": "string" },
|
1911 | "number": {
|
1912 | "alias": "issue_number",
|
1913 | "deprecated": true,
|
1914 | "type": "integer"
|
1915 | },
|
1916 | "owner": { "required": true, "type": "string" },
|
1917 | "repo": { "required": true, "type": "string" }
|
1918 | },
|
1919 | "url": "/repos/:owner/:repo/issues/:issue_number/labels/:name"
|
1920 | },
|
1921 | "removeLabels": {
|
1922 | "method": "DELETE",
|
1923 | "params": {
|
1924 | "issue_number": { "required": true, "type": "integer" },
|
1925 | "number": {
|
1926 | "alias": "issue_number",
|
1927 | "deprecated": true,
|
1928 | "type": "integer"
|
1929 | },
|
1930 | "owner": { "required": true, "type": "string" },
|
1931 | "repo": { "required": true, "type": "string" }
|
1932 | },
|
1933 | "url": "/repos/:owner/:repo/issues/:issue_number/labels"
|
1934 | },
|
1935 | "replaceLabels": {
|
1936 | "method": "PUT",
|
1937 | "params": {
|
1938 | "issue_number": { "required": true, "type": "integer" },
|
1939 | "labels": { "type": "string[]" },
|
1940 | "number": {
|
1941 | "alias": "issue_number",
|
1942 | "deprecated": true,
|
1943 | "type": "integer"
|
1944 | },
|
1945 | "owner": { "required": true, "type": "string" },
|
1946 | "repo": { "required": true, "type": "string" }
|
1947 | },
|
1948 | "url": "/repos/:owner/:repo/issues/:issue_number/labels"
|
1949 | },
|
1950 | "unlock": {
|
1951 | "method": "DELETE",
|
1952 | "params": {
|
1953 | "issue_number": { "required": true, "type": "integer" },
|
1954 | "number": {
|
1955 | "alias": "issue_number",
|
1956 | "deprecated": true,
|
1957 | "type": "integer"
|
1958 | },
|
1959 | "owner": { "required": true, "type": "string" },
|
1960 | "repo": { "required": true, "type": "string" }
|
1961 | },
|
1962 | "url": "/repos/:owner/:repo/issues/:issue_number/lock"
|
1963 | },
|
1964 | "update": {
|
1965 | "method": "PATCH",
|
1966 | "params": {
|
1967 | "assignee": { "type": "string" },
|
1968 | "assignees": { "type": "string[]" },
|
1969 | "body": { "type": "string" },
|
1970 | "issue_number": { "required": true, "type": "integer" },
|
1971 | "labels": { "type": "string[]" },
|
1972 | "milestone": { "allowNull": true, "type": "integer" },
|
1973 | "number": {
|
1974 | "alias": "issue_number",
|
1975 | "deprecated": true,
|
1976 | "type": "integer"
|
1977 | },
|
1978 | "owner": { "required": true, "type": "string" },
|
1979 | "repo": { "required": true, "type": "string" },
|
1980 | "state": { "enum": ["open", "closed"], "type": "string" },
|
1981 | "title": { "type": "string" }
|
1982 | },
|
1983 | "url": "/repos/:owner/:repo/issues/:issue_number"
|
1984 | },
|
1985 | "updateComment": {
|
1986 | "method": "PATCH",
|
1987 | "params": {
|
1988 | "body": { "required": true, "type": "string" },
|
1989 | "comment_id": { "required": true, "type": "integer" },
|
1990 | "owner": { "required": true, "type": "string" },
|
1991 | "repo": { "required": true, "type": "string" }
|
1992 | },
|
1993 | "url": "/repos/:owner/:repo/issues/comments/:comment_id"
|
1994 | },
|
1995 | "updateLabel": {
|
1996 | "method": "PATCH",
|
1997 | "params": {
|
1998 | "color": { "type": "string" },
|
1999 | "current_name": { "required": true, "type": "string" },
|
2000 | "description": { "type": "string" },
|
2001 | "name": { "type": "string" },
|
2002 | "owner": { "required": true, "type": "string" },
|
2003 | "repo": { "required": true, "type": "string" }
|
2004 | },
|
2005 | "url": "/repos/:owner/:repo/labels/:current_name"
|
2006 | },
|
2007 | "updateMilestone": {
|
2008 | "method": "PATCH",
|
2009 | "params": {
|
2010 | "description": { "type": "string" },
|
2011 | "due_on": { "type": "string" },
|
2012 | "milestone_number": { "required": true, "type": "integer" },
|
2013 | "number": {
|
2014 | "alias": "milestone_number",
|
2015 | "deprecated": true,
|
2016 | "type": "integer"
|
2017 | },
|
2018 | "owner": { "required": true, "type": "string" },
|
2019 | "repo": { "required": true, "type": "string" },
|
2020 | "state": { "enum": ["open", "closed"], "type": "string" },
|
2021 | "title": { "type": "string" }
|
2022 | },
|
2023 | "url": "/repos/:owner/:repo/milestones/:milestone_number"
|
2024 | }
|
2025 | },
|
2026 | "licenses": {
|
2027 | "get": {
|
2028 | "method": "GET",
|
2029 | "params": { "license": { "required": true, "type": "string" } },
|
2030 | "url": "/licenses/:license"
|
2031 | },
|
2032 | "getForRepo": {
|
2033 | "method": "GET",
|
2034 | "params": {
|
2035 | "owner": { "required": true, "type": "string" },
|
2036 | "repo": { "required": true, "type": "string" }
|
2037 | },
|
2038 | "url": "/repos/:owner/:repo/license"
|
2039 | },
|
2040 | "list": {
|
2041 | "deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
|
2042 | "method": "GET",
|
2043 | "params": {},
|
2044 | "url": "/licenses"
|
2045 | },
|
2046 | "listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" }
|
2047 | },
|
2048 | "markdown": {
|
2049 | "render": {
|
2050 | "method": "POST",
|
2051 | "params": {
|
2052 | "context": { "type": "string" },
|
2053 | "mode": { "enum": ["markdown", "gfm"], "type": "string" },
|
2054 | "text": { "required": true, "type": "string" }
|
2055 | },
|
2056 | "url": "/markdown"
|
2057 | },
|
2058 | "renderRaw": {
|
2059 | "headers": { "content-type": "text/plain; charset=utf-8" },
|
2060 | "method": "POST",
|
2061 | "params": {
|
2062 | "data": { "mapTo": "data", "required": true, "type": "string" }
|
2063 | },
|
2064 | "url": "/markdown/raw"
|
2065 | }
|
2066 | },
|
2067 | "meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } },
|
2068 | "oauthAuthorizations": {
|
2069 | "checkAuthorization": {
|
2070 | "method": "GET",
|
2071 | "params": {
|
2072 | "access_token": { "required": true, "type": "string" },
|
2073 | "client_id": { "required": true, "type": "string" }
|
2074 | },
|
2075 | "url": "/applications/:client_id/tokens/:access_token"
|
2076 | },
|
2077 | "createAuthorization": {
|
2078 | "method": "POST",
|
2079 | "params": {
|
2080 | "client_id": { "type": "string" },
|
2081 | "client_secret": { "type": "string" },
|
2082 | "fingerprint": { "type": "string" },
|
2083 | "note": { "required": true, "type": "string" },
|
2084 | "note_url": { "type": "string" },
|
2085 | "scopes": { "type": "string[]" }
|
2086 | },
|
2087 | "url": "/authorizations"
|
2088 | },
|
2089 | "deleteAuthorization": {
|
2090 | "method": "DELETE",
|
2091 | "params": { "authorization_id": { "required": true, "type": "integer" } },
|
2092 | "url": "/authorizations/:authorization_id"
|
2093 | },
|
2094 | "deleteGrant": {
|
2095 | "method": "DELETE",
|
2096 | "params": { "grant_id": { "required": true, "type": "integer" } },
|
2097 | "url": "/applications/grants/:grant_id"
|
2098 | },
|
2099 | "getAuthorization": {
|
2100 | "method": "GET",
|
2101 | "params": { "authorization_id": { "required": true, "type": "integer" } },
|
2102 | "url": "/authorizations/:authorization_id"
|
2103 | },
|
2104 | "getGrant": {
|
2105 | "method": "GET",
|
2106 | "params": { "grant_id": { "required": true, "type": "integer" } },
|
2107 | "url": "/applications/grants/:grant_id"
|
2108 | },
|
2109 | "getOrCreateAuthorizationForApp": {
|
2110 | "method": "PUT",
|
2111 | "params": {
|
2112 | "client_id": { "required": true, "type": "string" },
|
2113 | "client_secret": { "required": true, "type": "string" },
|
2114 | "fingerprint": { "type": "string" },
|
2115 | "note": { "type": "string" },
|
2116 | "note_url": { "type": "string" },
|
2117 | "scopes": { "type": "string[]" }
|
2118 | },
|
2119 | "url": "/authorizations/clients/:client_id"
|
2120 | },
|
2121 | "getOrCreateAuthorizationForAppAndFingerprint": {
|
2122 | "method": "PUT",
|
2123 | "params": {
|
2124 | "client_id": { "required": true, "type": "string" },
|
2125 | "client_secret": { "required": true, "type": "string" },
|
2126 | "fingerprint": { "required": true, "type": "string" },
|
2127 | "note": { "type": "string" },
|
2128 | "note_url": { "type": "string" },
|
2129 | "scopes": { "type": "string[]" }
|
2130 | },
|
2131 | "url": "/authorizations/clients/:client_id/:fingerprint"
|
2132 | },
|
2133 | "getOrCreateAuthorizationForAppFingerprint": {
|
2134 | "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
|
2135 | "method": "PUT",
|
2136 | "params": {
|
2137 | "client_id": { "required": true, "type": "string" },
|
2138 | "client_secret": { "required": true, "type": "string" },
|
2139 | "fingerprint": { "required": true, "type": "string" },
|
2140 | "note": { "type": "string" },
|
2141 | "note_url": { "type": "string" },
|
2142 | "scopes": { "type": "string[]" }
|
2143 | },
|
2144 | "url": "/authorizations/clients/:client_id/:fingerprint"
|
2145 | },
|
2146 | "listAuthorizations": {
|
2147 | "method": "GET",
|
2148 | "params": {
|
2149 | "page": { "type": "integer" },
|
2150 | "per_page": { "type": "integer" }
|
2151 | },
|
2152 | "url": "/authorizations"
|
2153 | },
|
2154 | "listGrants": {
|
2155 | "method": "GET",
|
2156 | "params": {
|
2157 | "page": { "type": "integer" },
|
2158 | "per_page": { "type": "integer" }
|
2159 | },
|
2160 | "url": "/applications/grants"
|
2161 | },
|
2162 | "resetAuthorization": {
|
2163 | "method": "POST",
|
2164 | "params": {
|
2165 | "access_token": { "required": true, "type": "string" },
|
2166 | "client_id": { "required": true, "type": "string" }
|
2167 | },
|
2168 | "url": "/applications/:client_id/tokens/:access_token"
|
2169 | },
|
2170 | "revokeAuthorizationForApplication": {
|
2171 | "method": "DELETE",
|
2172 | "params": {
|
2173 | "access_token": { "required": true, "type": "string" },
|
2174 | "client_id": { "required": true, "type": "string" }
|
2175 | },
|
2176 | "url": "/applications/:client_id/tokens/:access_token"
|
2177 | },
|
2178 | "revokeGrantForApplication": {
|
2179 | "method": "DELETE",
|
2180 | "params": {
|
2181 | "access_token": { "required": true, "type": "string" },
|
2182 | "client_id": { "required": true, "type": "string" }
|
2183 | },
|
2184 | "url": "/applications/:client_id/grants/:access_token"
|
2185 | },
|
2186 | "updateAuthorization": {
|
2187 | "method": "PATCH",
|
2188 | "params": {
|
2189 | "add_scopes": { "type": "string[]" },
|
2190 | "authorization_id": { "required": true, "type": "integer" },
|
2191 | "fingerprint": { "type": "string" },
|
2192 | "note": { "type": "string" },
|
2193 | "note_url": { "type": "string" },
|
2194 | "remove_scopes": { "type": "string[]" },
|
2195 | "scopes": { "type": "string[]" }
|
2196 | },
|
2197 | "url": "/authorizations/:authorization_id"
|
2198 | }
|
2199 | },
|
2200 | "orgs": {
|
2201 | "addOrUpdateMembership": {
|
2202 | "method": "PUT",
|
2203 | "params": {
|
2204 | "org": { "required": true, "type": "string" },
|
2205 | "role": { "enum": ["admin", "member"], "type": "string" },
|
2206 | "username": { "required": true, "type": "string" }
|
2207 | },
|
2208 | "url": "/orgs/:org/memberships/:username"
|
2209 | },
|
2210 | "checkMembership": {
|
2211 | "method": "GET",
|
2212 | "params": {
|
2213 | "org": { "required": true, "type": "string" },
|
2214 | "username": { "required": true, "type": "string" }
|
2215 | },
|
2216 | "url": "/orgs/:org/members/:username"
|
2217 | },
|
2218 | "checkPublicMembership": {
|
2219 | "method": "GET",
|
2220 | "params": {
|
2221 | "org": { "required": true, "type": "string" },
|
2222 | "username": { "required": true, "type": "string" }
|
2223 | },
|
2224 | "url": "/orgs/:org/public_members/:username"
|
2225 | },
|
2226 | "concealMembership": {
|
2227 | "method": "DELETE",
|
2228 | "params": {
|
2229 | "org": { "required": true, "type": "string" },
|
2230 | "username": { "required": true, "type": "string" }
|
2231 | },
|
2232 | "url": "/orgs/:org/public_members/:username"
|
2233 | },
|
2234 | "convertMemberToOutsideCollaborator": {
|
2235 | "method": "PUT",
|
2236 | "params": {
|
2237 | "org": { "required": true, "type": "string" },
|
2238 | "username": { "required": true, "type": "string" }
|
2239 | },
|
2240 | "url": "/orgs/:org/outside_collaborators/:username"
|
2241 | },
|
2242 | "createHook": {
|
2243 | "method": "POST",
|
2244 | "params": {
|
2245 | "active": { "type": "boolean" },
|
2246 | "config": { "required": true, "type": "object" },
|
2247 | "config.content_type": { "type": "string" },
|
2248 | "config.insecure_ssl": { "type": "string" },
|
2249 | "config.secret": { "type": "string" },
|
2250 | "config.url": { "required": true, "type": "string" },
|
2251 | "events": { "type": "string[]" },
|
2252 | "name": { "required": true, "type": "string" },
|
2253 | "org": { "required": true, "type": "string" }
|
2254 | },
|
2255 | "url": "/orgs/:org/hooks"
|
2256 | },
|
2257 | "deleteHook": {
|
2258 | "method": "DELETE",
|
2259 | "params": {
|
2260 | "hook_id": { "required": true, "type": "integer" },
|
2261 | "org": { "required": true, "type": "string" }
|
2262 | },
|
2263 | "url": "/orgs/:org/hooks/:hook_id"
|
2264 | },
|
2265 | "get": {
|
2266 | "method": "GET",
|
2267 | "params": { "org": { "required": true, "type": "string" } },
|
2268 | "url": "/orgs/:org"
|
2269 | },
|
2270 | "getHook": {
|
2271 | "method": "GET",
|
2272 | "params": {
|
2273 | "hook_id": { "required": true, "type": "integer" },
|
2274 | "org": { "required": true, "type": "string" }
|
2275 | },
|
2276 | "url": "/orgs/:org/hooks/:hook_id"
|
2277 | },
|
2278 | "getMembership": {
|
2279 | "method": "GET",
|
2280 | "params": {
|
2281 | "org": { "required": true, "type": "string" },
|
2282 | "username": { "required": true, "type": "string" }
|
2283 | },
|
2284 | "url": "/orgs/:org/memberships/:username"
|
2285 | },
|
2286 | "getMembershipForAuthenticatedUser": {
|
2287 | "method": "GET",
|
2288 | "params": { "org": { "required": true, "type": "string" } },
|
2289 | "url": "/user/memberships/orgs/:org"
|
2290 | },
|
2291 | "list": {
|
2292 | "method": "GET",
|
2293 | "params": {
|
2294 | "page": { "type": "integer" },
|
2295 | "per_page": { "type": "integer" },
|
2296 | "since": { "type": "string" }
|
2297 | },
|
2298 | "url": "/organizations"
|
2299 | },
|
2300 | "listForAuthenticatedUser": {
|
2301 | "method": "GET",
|
2302 | "params": {
|
2303 | "page": { "type": "integer" },
|
2304 | "per_page": { "type": "integer" }
|
2305 | },
|
2306 | "url": "/user/orgs"
|
2307 | },
|
2308 | "listForUser": {
|
2309 | "method": "GET",
|
2310 | "params": {
|
2311 | "page": { "type": "integer" },
|
2312 | "per_page": { "type": "integer" },
|
2313 | "username": { "required": true, "type": "string" }
|
2314 | },
|
2315 | "url": "/users/:username/orgs"
|
2316 | },
|
2317 | "listHooks": {
|
2318 | "method": "GET",
|
2319 | "params": {
|
2320 | "org": { "required": true, "type": "string" },
|
2321 | "page": { "type": "integer" },
|
2322 | "per_page": { "type": "integer" }
|
2323 | },
|
2324 | "url": "/orgs/:org/hooks"
|
2325 | },
|
2326 | "listMembers": {
|
2327 | "method": "GET",
|
2328 | "params": {
|
2329 | "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
|
2330 | "org": { "required": true, "type": "string" },
|
2331 | "page": { "type": "integer" },
|
2332 | "per_page": { "type": "integer" },
|
2333 | "role": { "enum": ["all", "admin", "member"], "type": "string" }
|
2334 | },
|
2335 | "url": "/orgs/:org/members"
|
2336 | },
|
2337 | "listMemberships": {
|
2338 | "method": "GET",
|
2339 | "params": {
|
2340 | "page": { "type": "integer" },
|
2341 | "per_page": { "type": "integer" },
|
2342 | "state": { "enum": ["active", "pending"], "type": "string" }
|
2343 | },
|
2344 | "url": "/user/memberships/orgs"
|
2345 | },
|
2346 | "listOutsideCollaborators": {
|
2347 | "method": "GET",
|
2348 | "params": {
|
2349 | "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
|
2350 | "org": { "required": true, "type": "string" },
|
2351 | "page": { "type": "integer" },
|
2352 | "per_page": { "type": "integer" }
|
2353 | },
|
2354 | "url": "/orgs/:org/outside_collaborators"
|
2355 | },
|
2356 | "listPublicMembers": {
|
2357 | "method": "GET",
|
2358 | "params": {
|
2359 | "org": { "required": true, "type": "string" },
|
2360 | "page": { "type": "integer" },
|
2361 | "per_page": { "type": "integer" }
|
2362 | },
|
2363 | "url": "/orgs/:org/public_members"
|
2364 | },
|
2365 | "pingHook": {
|
2366 | "method": "POST",
|
2367 | "params": {
|
2368 | "hook_id": { "required": true, "type": "integer" },
|
2369 | "org": { "required": true, "type": "string" }
|
2370 | },
|
2371 | "url": "/orgs/:org/hooks/:hook_id/pings"
|
2372 | },
|
2373 | "publicizeMembership": {
|
2374 | "method": "PUT",
|
2375 | "params": {
|
2376 | "org": { "required": true, "type": "string" },
|
2377 | "username": { "required": true, "type": "string" }
|
2378 | },
|
2379 | "url": "/orgs/:org/public_members/:username"
|
2380 | },
|
2381 | "removeMember": {
|
2382 | "method": "DELETE",
|
2383 | "params": {
|
2384 | "org": { "required": true, "type": "string" },
|
2385 | "username": { "required": true, "type": "string" }
|
2386 | },
|
2387 | "url": "/orgs/:org/members/:username"
|
2388 | },
|
2389 | "removeMembership": {
|
2390 | "method": "DELETE",
|
2391 | "params": {
|
2392 | "org": { "required": true, "type": "string" },
|
2393 | "username": { "required": true, "type": "string" }
|
2394 | },
|
2395 | "url": "/orgs/:org/memberships/:username"
|
2396 | },
|
2397 | "removeOutsideCollaborator": {
|
2398 | "method": "DELETE",
|
2399 | "params": {
|
2400 | "org": { "required": true, "type": "string" },
|
2401 | "username": { "required": true, "type": "string" }
|
2402 | },
|
2403 | "url": "/orgs/:org/outside_collaborators/:username"
|
2404 | },
|
2405 | "update": {
|
2406 | "method": "PATCH",
|
2407 | "params": {
|
2408 | "billing_email": { "type": "string" },
|
2409 | "company": { "type": "string" },
|
2410 | "default_repository_permission": {
|
2411 | "enum": ["read", "write", "admin", "none"],
|
2412 | "type": "string"
|
2413 | },
|
2414 | "description": { "type": "string" },
|
2415 | "email": { "type": "string" },
|
2416 | "has_organization_projects": { "type": "boolean" },
|
2417 | "has_repository_projects": { "type": "boolean" },
|
2418 | "location": { "type": "string" },
|
2419 | "members_allowed_repository_creation_type": {
|
2420 | "enum": ["all", "private", "none"],
|
2421 | "type": "string"
|
2422 | },
|
2423 | "members_can_create_repositories": { "type": "boolean" },
|
2424 | "name": { "type": "string" },
|
2425 | "org": { "required": true, "type": "string" }
|
2426 | },
|
2427 | "url": "/orgs/:org"
|
2428 | },
|
2429 | "updateHook": {
|
2430 | "method": "PATCH",
|
2431 | "params": {
|
2432 | "active": { "type": "boolean" },
|
2433 | "config": { "type": "object" },
|
2434 | "config.content_type": { "type": "string" },
|
2435 | "config.insecure_ssl": { "type": "string" },
|
2436 | "config.secret": { "type": "string" },
|
2437 | "config.url": { "required": true, "type": "string" },
|
2438 | "events": { "type": "string[]" },
|
2439 | "hook_id": { "required": true, "type": "integer" },
|
2440 | "org": { "required": true, "type": "string" }
|
2441 | },
|
2442 | "url": "/orgs/:org/hooks/:hook_id"
|
2443 | },
|
2444 | "updateMembership": {
|
2445 | "method": "PATCH",
|
2446 | "params": {
|
2447 | "org": { "required": true, "type": "string" },
|
2448 | "state": { "enum": ["active"], "required": true, "type": "string" }
|
2449 | },
|
2450 | "url": "/user/memberships/orgs/:org"
|
2451 | }
|
2452 | },
|
2453 | "projects": {
|
2454 | "addCollaborator": {
|
2455 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2456 | "method": "PUT",
|
2457 | "params": {
|
2458 | "permission": { "enum": ["read", "write", "admin"], "type": "string" },
|
2459 | "project_id": { "required": true, "type": "integer" },
|
2460 | "username": { "required": true, "type": "string" }
|
2461 | },
|
2462 | "url": "/projects/:project_id/collaborators/:username"
|
2463 | },
|
2464 | "createCard": {
|
2465 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2466 | "method": "POST",
|
2467 | "params": {
|
2468 | "column_id": { "required": true, "type": "integer" },
|
2469 | "content_id": { "type": "integer" },
|
2470 | "content_type": { "type": "string" },
|
2471 | "note": { "type": "string" }
|
2472 | },
|
2473 | "url": "/projects/columns/:column_id/cards"
|
2474 | },
|
2475 | "createColumn": {
|
2476 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2477 | "method": "POST",
|
2478 | "params": {
|
2479 | "name": { "required": true, "type": "string" },
|
2480 | "project_id": { "required": true, "type": "integer" }
|
2481 | },
|
2482 | "url": "/projects/:project_id/columns"
|
2483 | },
|
2484 | "createForAuthenticatedUser": {
|
2485 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2486 | "method": "POST",
|
2487 | "params": {
|
2488 | "body": { "type": "string" },
|
2489 | "name": { "required": true, "type": "string" }
|
2490 | },
|
2491 | "url": "/user/projects"
|
2492 | },
|
2493 | "createForOrg": {
|
2494 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2495 | "method": "POST",
|
2496 | "params": {
|
2497 | "body": { "type": "string" },
|
2498 | "name": { "required": true, "type": "string" },
|
2499 | "org": { "required": true, "type": "string" }
|
2500 | },
|
2501 | "url": "/orgs/:org/projects"
|
2502 | },
|
2503 | "createForRepo": {
|
2504 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2505 | "method": "POST",
|
2506 | "params": {
|
2507 | "body": { "type": "string" },
|
2508 | "name": { "required": true, "type": "string" },
|
2509 | "owner": { "required": true, "type": "string" },
|
2510 | "repo": { "required": true, "type": "string" }
|
2511 | },
|
2512 | "url": "/repos/:owner/:repo/projects"
|
2513 | },
|
2514 | "delete": {
|
2515 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2516 | "method": "DELETE",
|
2517 | "params": { "project_id": { "required": true, "type": "integer" } },
|
2518 | "url": "/projects/:project_id"
|
2519 | },
|
2520 | "deleteCard": {
|
2521 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2522 | "method": "DELETE",
|
2523 | "params": { "card_id": { "required": true, "type": "integer" } },
|
2524 | "url": "/projects/columns/cards/:card_id"
|
2525 | },
|
2526 | "deleteColumn": {
|
2527 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2528 | "method": "DELETE",
|
2529 | "params": { "column_id": { "required": true, "type": "integer" } },
|
2530 | "url": "/projects/columns/:column_id"
|
2531 | },
|
2532 | "get": {
|
2533 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2534 | "method": "GET",
|
2535 | "params": {
|
2536 | "page": { "type": "integer" },
|
2537 | "per_page": { "type": "integer" },
|
2538 | "project_id": { "required": true, "type": "integer" }
|
2539 | },
|
2540 | "url": "/projects/:project_id"
|
2541 | },
|
2542 | "getCard": {
|
2543 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2544 | "method": "GET",
|
2545 | "params": { "card_id": { "required": true, "type": "integer" } },
|
2546 | "url": "/projects/columns/cards/:card_id"
|
2547 | },
|
2548 | "getColumn": {
|
2549 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2550 | "method": "GET",
|
2551 | "params": { "column_id": { "required": true, "type": "integer" } },
|
2552 | "url": "/projects/columns/:column_id"
|
2553 | },
|
2554 | "listCards": {
|
2555 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2556 | "method": "GET",
|
2557 | "params": {
|
2558 | "archived_state": {
|
2559 | "enum": ["all", "archived", "not_archived"],
|
2560 | "type": "string"
|
2561 | },
|
2562 | "column_id": { "required": true, "type": "integer" },
|
2563 | "page": { "type": "integer" },
|
2564 | "per_page": { "type": "integer" }
|
2565 | },
|
2566 | "url": "/projects/columns/:column_id/cards"
|
2567 | },
|
2568 | "listCollaborators": {
|
2569 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2570 | "method": "GET",
|
2571 | "params": {
|
2572 | "affiliation": {
|
2573 | "enum": ["outside", "direct", "all"],
|
2574 | "type": "string"
|
2575 | },
|
2576 | "page": { "type": "integer" },
|
2577 | "per_page": { "type": "integer" },
|
2578 | "project_id": { "required": true, "type": "integer" }
|
2579 | },
|
2580 | "url": "/projects/:project_id/collaborators"
|
2581 | },
|
2582 | "listColumns": {
|
2583 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2584 | "method": "GET",
|
2585 | "params": {
|
2586 | "page": { "type": "integer" },
|
2587 | "per_page": { "type": "integer" },
|
2588 | "project_id": { "required": true, "type": "integer" }
|
2589 | },
|
2590 | "url": "/projects/:project_id/columns"
|
2591 | },
|
2592 | "listForOrg": {
|
2593 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2594 | "method": "GET",
|
2595 | "params": {
|
2596 | "org": { "required": true, "type": "string" },
|
2597 | "page": { "type": "integer" },
|
2598 | "per_page": { "type": "integer" },
|
2599 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
2600 | },
|
2601 | "url": "/orgs/:org/projects"
|
2602 | },
|
2603 | "listForRepo": {
|
2604 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2605 | "method": "GET",
|
2606 | "params": {
|
2607 | "owner": { "required": true, "type": "string" },
|
2608 | "page": { "type": "integer" },
|
2609 | "per_page": { "type": "integer" },
|
2610 | "repo": { "required": true, "type": "string" },
|
2611 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
2612 | },
|
2613 | "url": "/repos/:owner/:repo/projects"
|
2614 | },
|
2615 | "listForUser": {
|
2616 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2617 | "method": "GET",
|
2618 | "params": {
|
2619 | "page": { "type": "integer" },
|
2620 | "per_page": { "type": "integer" },
|
2621 | "state": { "enum": ["open", "closed", "all"], "type": "string" },
|
2622 | "username": { "required": true, "type": "string" }
|
2623 | },
|
2624 | "url": "/users/:username/projects"
|
2625 | },
|
2626 | "moveCard": {
|
2627 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2628 | "method": "POST",
|
2629 | "params": {
|
2630 | "card_id": { "required": true, "type": "integer" },
|
2631 | "column_id": { "type": "integer" },
|
2632 | "position": {
|
2633 | "required": true,
|
2634 | "type": "string",
|
2635 | "validation": "^(top|bottom|after:\\d+)$"
|
2636 | }
|
2637 | },
|
2638 | "url": "/projects/columns/cards/:card_id/moves"
|
2639 | },
|
2640 | "moveColumn": {
|
2641 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2642 | "method": "POST",
|
2643 | "params": {
|
2644 | "column_id": { "required": true, "type": "integer" },
|
2645 | "position": {
|
2646 | "required": true,
|
2647 | "type": "string",
|
2648 | "validation": "^(first|last|after:\\d+)$"
|
2649 | }
|
2650 | },
|
2651 | "url": "/projects/columns/:column_id/moves"
|
2652 | },
|
2653 | "removeCollaborator": {
|
2654 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2655 | "method": "DELETE",
|
2656 | "params": {
|
2657 | "project_id": { "required": true, "type": "integer" },
|
2658 | "username": { "required": true, "type": "string" }
|
2659 | },
|
2660 | "url": "/projects/:project_id/collaborators/:username"
|
2661 | },
|
2662 | "reviewUserPermissionLevel": {
|
2663 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2664 | "method": "GET",
|
2665 | "params": {
|
2666 | "project_id": { "required": true, "type": "integer" },
|
2667 | "username": { "required": true, "type": "string" }
|
2668 | },
|
2669 | "url": "/projects/:project_id/collaborators/:username/permission"
|
2670 | },
|
2671 | "update": {
|
2672 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2673 | "method": "PATCH",
|
2674 | "params": {
|
2675 | "body": { "type": "string" },
|
2676 | "name": { "type": "string" },
|
2677 | "organization_permission": { "type": "string" },
|
2678 | "private": { "type": "boolean" },
|
2679 | "project_id": { "required": true, "type": "integer" },
|
2680 | "state": { "enum": ["open", "closed"], "type": "string" }
|
2681 | },
|
2682 | "url": "/projects/:project_id"
|
2683 | },
|
2684 | "updateCard": {
|
2685 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2686 | "method": "PATCH",
|
2687 | "params": {
|
2688 | "archived": { "type": "boolean" },
|
2689 | "card_id": { "required": true, "type": "integer" },
|
2690 | "note": { "type": "string" }
|
2691 | },
|
2692 | "url": "/projects/columns/cards/:card_id"
|
2693 | },
|
2694 | "updateColumn": {
|
2695 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
2696 | "method": "PATCH",
|
2697 | "params": {
|
2698 | "column_id": { "required": true, "type": "integer" },
|
2699 | "name": { "required": true, "type": "string" }
|
2700 | },
|
2701 | "url": "/projects/columns/:column_id"
|
2702 | }
|
2703 | },
|
2704 | "pulls": {
|
2705 | "checkIfMerged": {
|
2706 | "method": "GET",
|
2707 | "params": {
|
2708 | "number": {
|
2709 | "alias": "pull_number",
|
2710 | "deprecated": true,
|
2711 | "type": "integer"
|
2712 | },
|
2713 | "owner": { "required": true, "type": "string" },
|
2714 | "pull_number": { "required": true, "type": "integer" },
|
2715 | "repo": { "required": true, "type": "string" }
|
2716 | },
|
2717 | "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
|
2718 | },
|
2719 | "create": {
|
2720 | "method": "POST",
|
2721 | "params": {
|
2722 | "base": { "required": true, "type": "string" },
|
2723 | "body": { "type": "string" },
|
2724 | "draft": { "type": "boolean" },
|
2725 | "head": { "required": true, "type": "string" },
|
2726 | "maintainer_can_modify": { "type": "boolean" },
|
2727 | "owner": { "required": true, "type": "string" },
|
2728 | "repo": { "required": true, "type": "string" },
|
2729 | "title": { "required": true, "type": "string" }
|
2730 | },
|
2731 | "url": "/repos/:owner/:repo/pulls"
|
2732 | },
|
2733 | "createComment": {
|
2734 | "method": "POST",
|
2735 | "params": {
|
2736 | "body": { "required": true, "type": "string" },
|
2737 | "commit_id": { "required": true, "type": "string" },
|
2738 | "in_reply_to": {
|
2739 | "deprecated": true,
|
2740 | "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.",
|
2741 | "type": "integer"
|
2742 | },
|
2743 | "number": {
|
2744 | "alias": "pull_number",
|
2745 | "deprecated": true,
|
2746 | "type": "integer"
|
2747 | },
|
2748 | "owner": { "required": true, "type": "string" },
|
2749 | "path": { "required": true, "type": "string" },
|
2750 | "position": { "required": true, "type": "integer" },
|
2751 | "pull_number": { "required": true, "type": "integer" },
|
2752 | "repo": { "required": true, "type": "string" }
|
2753 | },
|
2754 | "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
|
2755 | },
|
2756 | "createCommentReply": {
|
2757 | "deprecated": "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)",
|
2758 | "method": "POST",
|
2759 | "params": {
|
2760 | "body": { "required": true, "type": "string" },
|
2761 | "commit_id": { "required": true, "type": "string" },
|
2762 | "in_reply_to": {
|
2763 | "deprecated": true,
|
2764 | "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.",
|
2765 | "type": "integer"
|
2766 | },
|
2767 | "number": {
|
2768 | "alias": "pull_number",
|
2769 | "deprecated": true,
|
2770 | "type": "integer"
|
2771 | },
|
2772 | "owner": { "required": true, "type": "string" },
|
2773 | "path": { "required": true, "type": "string" },
|
2774 | "position": { "required": true, "type": "integer" },
|
2775 | "pull_number": { "required": true, "type": "integer" },
|
2776 | "repo": { "required": true, "type": "string" }
|
2777 | },
|
2778 | "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
|
2779 | },
|
2780 | "createFromIssue": {
|
2781 | "deprecated": "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request",
|
2782 | "method": "POST",
|
2783 | "params": {
|
2784 | "base": { "required": true, "type": "string" },
|
2785 | "head": { "required": true, "type": "string" },
|
2786 | "issue": { "required": true, "type": "integer" },
|
2787 | "maintainer_can_modify": { "type": "boolean" },
|
2788 | "owner": { "required": true, "type": "string" },
|
2789 | "repo": { "required": true, "type": "string" }
|
2790 | },
|
2791 | "url": "/repos/:owner/:repo/pulls"
|
2792 | },
|
2793 | "createReview": {
|
2794 | "method": "POST",
|
2795 | "params": {
|
2796 | "body": { "type": "string" },
|
2797 | "comments": { "type": "object[]" },
|
2798 | "comments[].body": { "required": true, "type": "string" },
|
2799 | "comments[].path": { "required": true, "type": "string" },
|
2800 | "comments[].position": { "required": true, "type": "integer" },
|
2801 | "commit_id": { "type": "string" },
|
2802 | "event": {
|
2803 | "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
|
2804 | "type": "string"
|
2805 | },
|
2806 | "number": {
|
2807 | "alias": "pull_number",
|
2808 | "deprecated": true,
|
2809 | "type": "integer"
|
2810 | },
|
2811 | "owner": { "required": true, "type": "string" },
|
2812 | "pull_number": { "required": true, "type": "integer" },
|
2813 | "repo": { "required": true, "type": "string" }
|
2814 | },
|
2815 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
|
2816 | },
|
2817 | "createReviewCommentReply": {
|
2818 | "method": "POST",
|
2819 | "params": {
|
2820 | "body": { "required": true, "type": "string" },
|
2821 | "comment_id": { "required": true, "type": "integer" },
|
2822 | "owner": { "required": true, "type": "string" },
|
2823 | "pull_number": { "required": true, "type": "integer" },
|
2824 | "repo": { "required": true, "type": "string" }
|
2825 | },
|
2826 | "url": "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"
|
2827 | },
|
2828 | "createReviewRequest": {
|
2829 | "method": "POST",
|
2830 | "params": {
|
2831 | "number": {
|
2832 | "alias": "pull_number",
|
2833 | "deprecated": true,
|
2834 | "type": "integer"
|
2835 | },
|
2836 | "owner": { "required": true, "type": "string" },
|
2837 | "pull_number": { "required": true, "type": "integer" },
|
2838 | "repo": { "required": true, "type": "string" },
|
2839 | "reviewers": { "type": "string[]" },
|
2840 | "team_reviewers": { "type": "string[]" }
|
2841 | },
|
2842 | "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
|
2843 | },
|
2844 | "deleteComment": {
|
2845 | "method": "DELETE",
|
2846 | "params": {
|
2847 | "comment_id": { "required": true, "type": "integer" },
|
2848 | "owner": { "required": true, "type": "string" },
|
2849 | "repo": { "required": true, "type": "string" }
|
2850 | },
|
2851 | "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
|
2852 | },
|
2853 | "deletePendingReview": {
|
2854 | "method": "DELETE",
|
2855 | "params": {
|
2856 | "number": {
|
2857 | "alias": "pull_number",
|
2858 | "deprecated": true,
|
2859 | "type": "integer"
|
2860 | },
|
2861 | "owner": { "required": true, "type": "string" },
|
2862 | "pull_number": { "required": true, "type": "integer" },
|
2863 | "repo": { "required": true, "type": "string" },
|
2864 | "review_id": { "required": true, "type": "integer" }
|
2865 | },
|
2866 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
|
2867 | },
|
2868 | "deleteReviewRequest": {
|
2869 | "method": "DELETE",
|
2870 | "params": {
|
2871 | "number": {
|
2872 | "alias": "pull_number",
|
2873 | "deprecated": true,
|
2874 | "type": "integer"
|
2875 | },
|
2876 | "owner": { "required": true, "type": "string" },
|
2877 | "pull_number": { "required": true, "type": "integer" },
|
2878 | "repo": { "required": true, "type": "string" },
|
2879 | "reviewers": { "type": "string[]" },
|
2880 | "team_reviewers": { "type": "string[]" }
|
2881 | },
|
2882 | "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
|
2883 | },
|
2884 | "dismissReview": {
|
2885 | "method": "PUT",
|
2886 | "params": {
|
2887 | "message": { "required": true, "type": "string" },
|
2888 | "number": {
|
2889 | "alias": "pull_number",
|
2890 | "deprecated": true,
|
2891 | "type": "integer"
|
2892 | },
|
2893 | "owner": { "required": true, "type": "string" },
|
2894 | "pull_number": { "required": true, "type": "integer" },
|
2895 | "repo": { "required": true, "type": "string" },
|
2896 | "review_id": { "required": true, "type": "integer" }
|
2897 | },
|
2898 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"
|
2899 | },
|
2900 | "get": {
|
2901 | "method": "GET",
|
2902 | "params": {
|
2903 | "number": {
|
2904 | "alias": "pull_number",
|
2905 | "deprecated": true,
|
2906 | "type": "integer"
|
2907 | },
|
2908 | "owner": { "required": true, "type": "string" },
|
2909 | "pull_number": { "required": true, "type": "integer" },
|
2910 | "repo": { "required": true, "type": "string" }
|
2911 | },
|
2912 | "url": "/repos/:owner/:repo/pulls/:pull_number"
|
2913 | },
|
2914 | "getComment": {
|
2915 | "method": "GET",
|
2916 | "params": {
|
2917 | "comment_id": { "required": true, "type": "integer" },
|
2918 | "owner": { "required": true, "type": "string" },
|
2919 | "repo": { "required": true, "type": "string" }
|
2920 | },
|
2921 | "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
|
2922 | },
|
2923 | "getCommentsForReview": {
|
2924 | "method": "GET",
|
2925 | "params": {
|
2926 | "number": {
|
2927 | "alias": "pull_number",
|
2928 | "deprecated": true,
|
2929 | "type": "integer"
|
2930 | },
|
2931 | "owner": { "required": true, "type": "string" },
|
2932 | "page": { "type": "integer" },
|
2933 | "per_page": { "type": "integer" },
|
2934 | "pull_number": { "required": true, "type": "integer" },
|
2935 | "repo": { "required": true, "type": "string" },
|
2936 | "review_id": { "required": true, "type": "integer" }
|
2937 | },
|
2938 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"
|
2939 | },
|
2940 | "getReview": {
|
2941 | "method": "GET",
|
2942 | "params": {
|
2943 | "number": {
|
2944 | "alias": "pull_number",
|
2945 | "deprecated": true,
|
2946 | "type": "integer"
|
2947 | },
|
2948 | "owner": { "required": true, "type": "string" },
|
2949 | "pull_number": { "required": true, "type": "integer" },
|
2950 | "repo": { "required": true, "type": "string" },
|
2951 | "review_id": { "required": true, "type": "integer" }
|
2952 | },
|
2953 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
|
2954 | },
|
2955 | "list": {
|
2956 | "method": "GET",
|
2957 | "params": {
|
2958 | "base": { "type": "string" },
|
2959 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
2960 | "head": { "type": "string" },
|
2961 | "owner": { "required": true, "type": "string" },
|
2962 | "page": { "type": "integer" },
|
2963 | "per_page": { "type": "integer" },
|
2964 | "repo": { "required": true, "type": "string" },
|
2965 | "sort": {
|
2966 | "enum": ["created", "updated", "popularity", "long-running"],
|
2967 | "type": "string"
|
2968 | },
|
2969 | "state": { "enum": ["open", "closed", "all"], "type": "string" }
|
2970 | },
|
2971 | "url": "/repos/:owner/:repo/pulls"
|
2972 | },
|
2973 | "listComments": {
|
2974 | "method": "GET",
|
2975 | "params": {
|
2976 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
2977 | "number": {
|
2978 | "alias": "pull_number",
|
2979 | "deprecated": true,
|
2980 | "type": "integer"
|
2981 | },
|
2982 | "owner": { "required": true, "type": "string" },
|
2983 | "page": { "type": "integer" },
|
2984 | "per_page": { "type": "integer" },
|
2985 | "pull_number": { "required": true, "type": "integer" },
|
2986 | "repo": { "required": true, "type": "string" },
|
2987 | "since": { "type": "string" },
|
2988 | "sort": { "enum": ["created", "updated"], "type": "string" }
|
2989 | },
|
2990 | "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
|
2991 | },
|
2992 | "listCommentsForRepo": {
|
2993 | "method": "GET",
|
2994 | "params": {
|
2995 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
2996 | "owner": { "required": true, "type": "string" },
|
2997 | "page": { "type": "integer" },
|
2998 | "per_page": { "type": "integer" },
|
2999 | "repo": { "required": true, "type": "string" },
|
3000 | "since": { "type": "string" },
|
3001 | "sort": { "enum": ["created", "updated"], "type": "string" }
|
3002 | },
|
3003 | "url": "/repos/:owner/:repo/pulls/comments"
|
3004 | },
|
3005 | "listCommits": {
|
3006 | "method": "GET",
|
3007 | "params": {
|
3008 | "number": {
|
3009 | "alias": "pull_number",
|
3010 | "deprecated": true,
|
3011 | "type": "integer"
|
3012 | },
|
3013 | "owner": { "required": true, "type": "string" },
|
3014 | "page": { "type": "integer" },
|
3015 | "per_page": { "type": "integer" },
|
3016 | "pull_number": { "required": true, "type": "integer" },
|
3017 | "repo": { "required": true, "type": "string" }
|
3018 | },
|
3019 | "url": "/repos/:owner/:repo/pulls/:pull_number/commits"
|
3020 | },
|
3021 | "listFiles": {
|
3022 | "method": "GET",
|
3023 | "params": {
|
3024 | "number": {
|
3025 | "alias": "pull_number",
|
3026 | "deprecated": true,
|
3027 | "type": "integer"
|
3028 | },
|
3029 | "owner": { "required": true, "type": "string" },
|
3030 | "page": { "type": "integer" },
|
3031 | "per_page": { "type": "integer" },
|
3032 | "pull_number": { "required": true, "type": "integer" },
|
3033 | "repo": { "required": true, "type": "string" }
|
3034 | },
|
3035 | "url": "/repos/:owner/:repo/pulls/:pull_number/files"
|
3036 | },
|
3037 | "listReviewRequests": {
|
3038 | "method": "GET",
|
3039 | "params": {
|
3040 | "number": {
|
3041 | "alias": "pull_number",
|
3042 | "deprecated": true,
|
3043 | "type": "integer"
|
3044 | },
|
3045 | "owner": { "required": true, "type": "string" },
|
3046 | "page": { "type": "integer" },
|
3047 | "per_page": { "type": "integer" },
|
3048 | "pull_number": { "required": true, "type": "integer" },
|
3049 | "repo": { "required": true, "type": "string" }
|
3050 | },
|
3051 | "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
|
3052 | },
|
3053 | "listReviews": {
|
3054 | "method": "GET",
|
3055 | "params": {
|
3056 | "number": {
|
3057 | "alias": "pull_number",
|
3058 | "deprecated": true,
|
3059 | "type": "integer"
|
3060 | },
|
3061 | "owner": { "required": true, "type": "string" },
|
3062 | "page": { "type": "integer" },
|
3063 | "per_page": { "type": "integer" },
|
3064 | "pull_number": { "required": true, "type": "integer" },
|
3065 | "repo": { "required": true, "type": "string" }
|
3066 | },
|
3067 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
|
3068 | },
|
3069 | "merge": {
|
3070 | "method": "PUT",
|
3071 | "params": {
|
3072 | "commit_message": { "type": "string" },
|
3073 | "commit_title": { "type": "string" },
|
3074 | "merge_method": {
|
3075 | "enum": ["merge", "squash", "rebase"],
|
3076 | "type": "string"
|
3077 | },
|
3078 | "number": {
|
3079 | "alias": "pull_number",
|
3080 | "deprecated": true,
|
3081 | "type": "integer"
|
3082 | },
|
3083 | "owner": { "required": true, "type": "string" },
|
3084 | "pull_number": { "required": true, "type": "integer" },
|
3085 | "repo": { "required": true, "type": "string" },
|
3086 | "sha": { "type": "string" }
|
3087 | },
|
3088 | "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
|
3089 | },
|
3090 | "submitReview": {
|
3091 | "method": "POST",
|
3092 | "params": {
|
3093 | "body": { "type": "string" },
|
3094 | "event": {
|
3095 | "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
|
3096 | "required": true,
|
3097 | "type": "string"
|
3098 | },
|
3099 | "number": {
|
3100 | "alias": "pull_number",
|
3101 | "deprecated": true,
|
3102 | "type": "integer"
|
3103 | },
|
3104 | "owner": { "required": true, "type": "string" },
|
3105 | "pull_number": { "required": true, "type": "integer" },
|
3106 | "repo": { "required": true, "type": "string" },
|
3107 | "review_id": { "required": true, "type": "integer" }
|
3108 | },
|
3109 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"
|
3110 | },
|
3111 | "update": {
|
3112 | "method": "PATCH",
|
3113 | "params": {
|
3114 | "base": { "type": "string" },
|
3115 | "body": { "type": "string" },
|
3116 | "maintainer_can_modify": { "type": "boolean" },
|
3117 | "number": {
|
3118 | "alias": "pull_number",
|
3119 | "deprecated": true,
|
3120 | "type": "integer"
|
3121 | },
|
3122 | "owner": { "required": true, "type": "string" },
|
3123 | "pull_number": { "required": true, "type": "integer" },
|
3124 | "repo": { "required": true, "type": "string" },
|
3125 | "state": { "enum": ["open", "closed"], "type": "string" },
|
3126 | "title": { "type": "string" }
|
3127 | },
|
3128 | "url": "/repos/:owner/:repo/pulls/:pull_number"
|
3129 | },
|
3130 | "updateBranch": {
|
3131 | "headers": { "accept": "application/vnd.github.lydian-preview+json" },
|
3132 | "method": "PUT",
|
3133 | "params": {
|
3134 | "expected_head_sha": { "type": "string" },
|
3135 | "owner": { "required": true, "type": "string" },
|
3136 | "pull_number": { "required": true, "type": "integer" },
|
3137 | "repo": { "required": true, "type": "string" }
|
3138 | },
|
3139 | "url": "/repos/:owner/:repo/pulls/:pull_number/update-branch"
|
3140 | },
|
3141 | "updateComment": {
|
3142 | "method": "PATCH",
|
3143 | "params": {
|
3144 | "body": { "required": true, "type": "string" },
|
3145 | "comment_id": { "required": true, "type": "integer" },
|
3146 | "owner": { "required": true, "type": "string" },
|
3147 | "repo": { "required": true, "type": "string" }
|
3148 | },
|
3149 | "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
|
3150 | },
|
3151 | "updateReview": {
|
3152 | "method": "PUT",
|
3153 | "params": {
|
3154 | "body": { "required": true, "type": "string" },
|
3155 | "number": {
|
3156 | "alias": "pull_number",
|
3157 | "deprecated": true,
|
3158 | "type": "integer"
|
3159 | },
|
3160 | "owner": { "required": true, "type": "string" },
|
3161 | "pull_number": { "required": true, "type": "integer" },
|
3162 | "repo": { "required": true, "type": "string" },
|
3163 | "review_id": { "required": true, "type": "integer" }
|
3164 | },
|
3165 | "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
|
3166 | }
|
3167 | },
|
3168 | "rateLimit": {
|
3169 | "get": { "method": "GET", "params": {}, "url": "/rate_limit" }
|
3170 | },
|
3171 | "reactions": {
|
3172 | "createForCommitComment": {
|
3173 | "headers": {
|
3174 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3175 | },
|
3176 | "method": "POST",
|
3177 | "params": {
|
3178 | "comment_id": { "required": true, "type": "integer" },
|
3179 | "content": {
|
3180 | "enum": [
|
3181 | "+1",
|
3182 | "-1",
|
3183 | "laugh",
|
3184 | "confused",
|
3185 | "heart",
|
3186 | "hooray",
|
3187 | "rocket",
|
3188 | "eyes"
|
3189 | ],
|
3190 | "required": true,
|
3191 | "type": "string"
|
3192 | },
|
3193 | "owner": { "required": true, "type": "string" },
|
3194 | "repo": { "required": true, "type": "string" }
|
3195 | },
|
3196 | "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
|
3197 | },
|
3198 | "createForIssue": {
|
3199 | "headers": {
|
3200 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3201 | },
|
3202 | "method": "POST",
|
3203 | "params": {
|
3204 | "content": {
|
3205 | "enum": [
|
3206 | "+1",
|
3207 | "-1",
|
3208 | "laugh",
|
3209 | "confused",
|
3210 | "heart",
|
3211 | "hooray",
|
3212 | "rocket",
|
3213 | "eyes"
|
3214 | ],
|
3215 | "required": true,
|
3216 | "type": "string"
|
3217 | },
|
3218 | "issue_number": { "required": true, "type": "integer" },
|
3219 | "number": {
|
3220 | "alias": "issue_number",
|
3221 | "deprecated": true,
|
3222 | "type": "integer"
|
3223 | },
|
3224 | "owner": { "required": true, "type": "string" },
|
3225 | "repo": { "required": true, "type": "string" }
|
3226 | },
|
3227 | "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
|
3228 | },
|
3229 | "createForIssueComment": {
|
3230 | "headers": {
|
3231 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3232 | },
|
3233 | "method": "POST",
|
3234 | "params": {
|
3235 | "comment_id": { "required": true, "type": "integer" },
|
3236 | "content": {
|
3237 | "enum": [
|
3238 | "+1",
|
3239 | "-1",
|
3240 | "laugh",
|
3241 | "confused",
|
3242 | "heart",
|
3243 | "hooray",
|
3244 | "rocket",
|
3245 | "eyes"
|
3246 | ],
|
3247 | "required": true,
|
3248 | "type": "string"
|
3249 | },
|
3250 | "owner": { "required": true, "type": "string" },
|
3251 | "repo": { "required": true, "type": "string" }
|
3252 | },
|
3253 | "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
|
3254 | },
|
3255 | "createForPullRequestReviewComment": {
|
3256 | "headers": {
|
3257 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3258 | },
|
3259 | "method": "POST",
|
3260 | "params": {
|
3261 | "comment_id": { "required": true, "type": "integer" },
|
3262 | "content": {
|
3263 | "enum": [
|
3264 | "+1",
|
3265 | "-1",
|
3266 | "laugh",
|
3267 | "confused",
|
3268 | "heart",
|
3269 | "hooray",
|
3270 | "rocket",
|
3271 | "eyes"
|
3272 | ],
|
3273 | "required": true,
|
3274 | "type": "string"
|
3275 | },
|
3276 | "owner": { "required": true, "type": "string" },
|
3277 | "repo": { "required": true, "type": "string" }
|
3278 | },
|
3279 | "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
|
3280 | },
|
3281 | "createForTeamDiscussion": {
|
3282 | "headers": {
|
3283 | "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
|
3284 | },
|
3285 | "method": "POST",
|
3286 | "params": {
|
3287 | "content": {
|
3288 | "enum": [
|
3289 | "+1",
|
3290 | "-1",
|
3291 | "laugh",
|
3292 | "confused",
|
3293 | "heart",
|
3294 | "hooray",
|
3295 | "rocket",
|
3296 | "eyes"
|
3297 | ],
|
3298 | "required": true,
|
3299 | "type": "string"
|
3300 | },
|
3301 | "discussion_number": { "required": true, "type": "integer" },
|
3302 | "team_id": { "required": true, "type": "integer" }
|
3303 | },
|
3304 | "url": "/teams/:team_id/discussions/:discussion_number/reactions"
|
3305 | },
|
3306 | "createForTeamDiscussionComment": {
|
3307 | "headers": {
|
3308 | "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
|
3309 | },
|
3310 | "method": "POST",
|
3311 | "params": {
|
3312 | "comment_number": { "required": true, "type": "integer" },
|
3313 | "content": {
|
3314 | "enum": [
|
3315 | "+1",
|
3316 | "-1",
|
3317 | "laugh",
|
3318 | "confused",
|
3319 | "heart",
|
3320 | "hooray",
|
3321 | "rocket",
|
3322 | "eyes"
|
3323 | ],
|
3324 | "required": true,
|
3325 | "type": "string"
|
3326 | },
|
3327 | "discussion_number": { "required": true, "type": "integer" },
|
3328 | "team_id": { "required": true, "type": "integer" }
|
3329 | },
|
3330 | "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
|
3331 | },
|
3332 | "delete": {
|
3333 | "headers": {
|
3334 | "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
|
3335 | },
|
3336 | "method": "DELETE",
|
3337 | "params": { "reaction_id": { "required": true, "type": "integer" } },
|
3338 | "url": "/reactions/:reaction_id"
|
3339 | },
|
3340 | "listForCommitComment": {
|
3341 | "headers": {
|
3342 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3343 | },
|
3344 | "method": "GET",
|
3345 | "params": {
|
3346 | "comment_id": { "required": true, "type": "integer" },
|
3347 | "content": {
|
3348 | "enum": [
|
3349 | "+1",
|
3350 | "-1",
|
3351 | "laugh",
|
3352 | "confused",
|
3353 | "heart",
|
3354 | "hooray",
|
3355 | "rocket",
|
3356 | "eyes"
|
3357 | ],
|
3358 | "type": "string"
|
3359 | },
|
3360 | "owner": { "required": true, "type": "string" },
|
3361 | "page": { "type": "integer" },
|
3362 | "per_page": { "type": "integer" },
|
3363 | "repo": { "required": true, "type": "string" }
|
3364 | },
|
3365 | "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
|
3366 | },
|
3367 | "listForIssue": {
|
3368 | "headers": {
|
3369 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3370 | },
|
3371 | "method": "GET",
|
3372 | "params": {
|
3373 | "content": {
|
3374 | "enum": [
|
3375 | "+1",
|
3376 | "-1",
|
3377 | "laugh",
|
3378 | "confused",
|
3379 | "heart",
|
3380 | "hooray",
|
3381 | "rocket",
|
3382 | "eyes"
|
3383 | ],
|
3384 | "type": "string"
|
3385 | },
|
3386 | "issue_number": { "required": true, "type": "integer" },
|
3387 | "number": {
|
3388 | "alias": "issue_number",
|
3389 | "deprecated": true,
|
3390 | "type": "integer"
|
3391 | },
|
3392 | "owner": { "required": true, "type": "string" },
|
3393 | "page": { "type": "integer" },
|
3394 | "per_page": { "type": "integer" },
|
3395 | "repo": { "required": true, "type": "string" }
|
3396 | },
|
3397 | "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
|
3398 | },
|
3399 | "listForIssueComment": {
|
3400 | "headers": {
|
3401 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3402 | },
|
3403 | "method": "GET",
|
3404 | "params": {
|
3405 | "comment_id": { "required": true, "type": "integer" },
|
3406 | "content": {
|
3407 | "enum": [
|
3408 | "+1",
|
3409 | "-1",
|
3410 | "laugh",
|
3411 | "confused",
|
3412 | "heart",
|
3413 | "hooray",
|
3414 | "rocket",
|
3415 | "eyes"
|
3416 | ],
|
3417 | "type": "string"
|
3418 | },
|
3419 | "owner": { "required": true, "type": "string" },
|
3420 | "page": { "type": "integer" },
|
3421 | "per_page": { "type": "integer" },
|
3422 | "repo": { "required": true, "type": "string" }
|
3423 | },
|
3424 | "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
|
3425 | },
|
3426 | "listForPullRequestReviewComment": {
|
3427 | "headers": {
|
3428 | "accept": "application/vnd.github.squirrel-girl-preview+json"
|
3429 | },
|
3430 | "method": "GET",
|
3431 | "params": {
|
3432 | "comment_id": { "required": true, "type": "integer" },
|
3433 | "content": {
|
3434 | "enum": [
|
3435 | "+1",
|
3436 | "-1",
|
3437 | "laugh",
|
3438 | "confused",
|
3439 | "heart",
|
3440 | "hooray",
|
3441 | "rocket",
|
3442 | "eyes"
|
3443 | ],
|
3444 | "type": "string"
|
3445 | },
|
3446 | "owner": { "required": true, "type": "string" },
|
3447 | "page": { "type": "integer" },
|
3448 | "per_page": { "type": "integer" },
|
3449 | "repo": { "required": true, "type": "string" }
|
3450 | },
|
3451 | "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
|
3452 | },
|
3453 | "listForTeamDiscussion": {
|
3454 | "headers": {
|
3455 | "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
|
3456 | },
|
3457 | "method": "GET",
|
3458 | "params": {
|
3459 | "content": {
|
3460 | "enum": [
|
3461 | "+1",
|
3462 | "-1",
|
3463 | "laugh",
|
3464 | "confused",
|
3465 | "heart",
|
3466 | "hooray",
|
3467 | "rocket",
|
3468 | "eyes"
|
3469 | ],
|
3470 | "type": "string"
|
3471 | },
|
3472 | "discussion_number": { "required": true, "type": "integer" },
|
3473 | "page": { "type": "integer" },
|
3474 | "per_page": { "type": "integer" },
|
3475 | "team_id": { "required": true, "type": "integer" }
|
3476 | },
|
3477 | "url": "/teams/:team_id/discussions/:discussion_number/reactions"
|
3478 | },
|
3479 | "listForTeamDiscussionComment": {
|
3480 | "headers": {
|
3481 | "accept": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
|
3482 | },
|
3483 | "method": "GET",
|
3484 | "params": {
|
3485 | "comment_number": { "required": true, "type": "integer" },
|
3486 | "content": {
|
3487 | "enum": [
|
3488 | "+1",
|
3489 | "-1",
|
3490 | "laugh",
|
3491 | "confused",
|
3492 | "heart",
|
3493 | "hooray",
|
3494 | "rocket",
|
3495 | "eyes"
|
3496 | ],
|
3497 | "type": "string"
|
3498 | },
|
3499 | "discussion_number": { "required": true, "type": "integer" },
|
3500 | "page": { "type": "integer" },
|
3501 | "per_page": { "type": "integer" },
|
3502 | "team_id": { "required": true, "type": "integer" }
|
3503 | },
|
3504 | "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
|
3505 | }
|
3506 | },
|
3507 | "repos": {
|
3508 | "acceptInvitation": {
|
3509 | "method": "PATCH",
|
3510 | "params": { "invitation_id": { "required": true, "type": "integer" } },
|
3511 | "url": "/user/repository_invitations/:invitation_id"
|
3512 | },
|
3513 | "addCollaborator": {
|
3514 | "method": "PUT",
|
3515 | "params": {
|
3516 | "owner": { "required": true, "type": "string" },
|
3517 | "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
|
3518 | "repo": { "required": true, "type": "string" },
|
3519 | "username": { "required": true, "type": "string" }
|
3520 | },
|
3521 | "url": "/repos/:owner/:repo/collaborators/:username"
|
3522 | },
|
3523 | "addDeployKey": {
|
3524 | "method": "POST",
|
3525 | "params": {
|
3526 | "key": { "required": true, "type": "string" },
|
3527 | "owner": { "required": true, "type": "string" },
|
3528 | "read_only": { "type": "boolean" },
|
3529 | "repo": { "required": true, "type": "string" },
|
3530 | "title": { "type": "string" }
|
3531 | },
|
3532 | "url": "/repos/:owner/:repo/keys"
|
3533 | },
|
3534 | "addProtectedBranchAdminEnforcement": {
|
3535 | "method": "POST",
|
3536 | "params": {
|
3537 | "branch": { "required": true, "type": "string" },
|
3538 | "owner": { "required": true, "type": "string" },
|
3539 | "repo": { "required": true, "type": "string" }
|
3540 | },
|
3541 | "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
|
3542 | },
|
3543 | "addProtectedBranchRequiredSignatures": {
|
3544 | "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
|
3545 | "method": "POST",
|
3546 | "params": {
|
3547 | "branch": { "required": true, "type": "string" },
|
3548 | "owner": { "required": true, "type": "string" },
|
3549 | "repo": { "required": true, "type": "string" }
|
3550 | },
|
3551 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
|
3552 | },
|
3553 | "addProtectedBranchRequiredStatusChecksContexts": {
|
3554 | "method": "POST",
|
3555 | "params": {
|
3556 | "branch": { "required": true, "type": "string" },
|
3557 | "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
|
3558 | "owner": { "required": true, "type": "string" },
|
3559 | "repo": { "required": true, "type": "string" }
|
3560 | },
|
3561 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
|
3562 | },
|
3563 | "addProtectedBranchTeamRestrictions": {
|
3564 | "method": "POST",
|
3565 | "params": {
|
3566 | "branch": { "required": true, "type": "string" },
|
3567 | "owner": { "required": true, "type": "string" },
|
3568 | "repo": { "required": true, "type": "string" },
|
3569 | "teams": { "mapTo": "data", "required": true, "type": "string[]" }
|
3570 | },
|
3571 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
|
3572 | },
|
3573 | "addProtectedBranchUserRestrictions": {
|
3574 | "method": "POST",
|
3575 | "params": {
|
3576 | "branch": { "required": true, "type": "string" },
|
3577 | "owner": { "required": true, "type": "string" },
|
3578 | "repo": { "required": true, "type": "string" },
|
3579 | "users": { "mapTo": "data", "required": true, "type": "string[]" }
|
3580 | },
|
3581 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
|
3582 | },
|
3583 | "checkCollaborator": {
|
3584 | "method": "GET",
|
3585 | "params": {
|
3586 | "owner": { "required": true, "type": "string" },
|
3587 | "repo": { "required": true, "type": "string" },
|
3588 | "username": { "required": true, "type": "string" }
|
3589 | },
|
3590 | "url": "/repos/:owner/:repo/collaborators/:username"
|
3591 | },
|
3592 | "compareCommits": {
|
3593 | "method": "GET",
|
3594 | "params": {
|
3595 | "base": { "required": true, "type": "string" },
|
3596 | "head": { "required": true, "type": "string" },
|
3597 | "owner": { "required": true, "type": "string" },
|
3598 | "repo": { "required": true, "type": "string" }
|
3599 | },
|
3600 | "url": "/repos/:owner/:repo/compare/:base...:head"
|
3601 | },
|
3602 | "createCommitComment": {
|
3603 | "method": "POST",
|
3604 | "params": {
|
3605 | "body": { "required": true, "type": "string" },
|
3606 | "commit_sha": { "required": true, "type": "string" },
|
3607 | "line": { "type": "integer" },
|
3608 | "owner": { "required": true, "type": "string" },
|
3609 | "path": { "type": "string" },
|
3610 | "position": { "type": "integer" },
|
3611 | "repo": { "required": true, "type": "string" },
|
3612 | "sha": { "alias": "commit_sha", "deprecated": true, "type": "string" }
|
3613 | },
|
3614 | "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
|
3615 | },
|
3616 | "createDeployment": {
|
3617 | "method": "POST",
|
3618 | "params": {
|
3619 | "auto_merge": { "type": "boolean" },
|
3620 | "description": { "type": "string" },
|
3621 | "environment": { "type": "string" },
|
3622 | "owner": { "required": true, "type": "string" },
|
3623 | "payload": { "type": "string" },
|
3624 | "production_environment": { "type": "boolean" },
|
3625 | "ref": { "required": true, "type": "string" },
|
3626 | "repo": { "required": true, "type": "string" },
|
3627 | "required_contexts": { "type": "string[]" },
|
3628 | "task": { "type": "string" },
|
3629 | "transient_environment": { "type": "boolean" }
|
3630 | },
|
3631 | "url": "/repos/:owner/:repo/deployments"
|
3632 | },
|
3633 | "createDeploymentStatus": {
|
3634 | "method": "POST",
|
3635 | "params": {
|
3636 | "auto_inactive": { "type": "boolean" },
|
3637 | "deployment_id": { "required": true, "type": "integer" },
|
3638 | "description": { "type": "string" },
|
3639 | "environment": {
|
3640 | "enum": ["production", "staging", "qa"],
|
3641 | "type": "string"
|
3642 | },
|
3643 | "environment_url": { "type": "string" },
|
3644 | "log_url": { "type": "string" },
|
3645 | "owner": { "required": true, "type": "string" },
|
3646 | "repo": { "required": true, "type": "string" },
|
3647 | "state": {
|
3648 | "enum": [
|
3649 | "error",
|
3650 | "failure",
|
3651 | "inactive",
|
3652 | "in_progress",
|
3653 | "queued",
|
3654 | "pending",
|
3655 | "success"
|
3656 | ],
|
3657 | "required": true,
|
3658 | "type": "string"
|
3659 | },
|
3660 | "target_url": { "type": "string" }
|
3661 | },
|
3662 | "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
|
3663 | },
|
3664 | "createFile": {
|
3665 | "deprecated": "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
|
3666 | "method": "PUT",
|
3667 | "params": {
|
3668 | "author": { "type": "object" },
|
3669 | "author.email": { "required": true, "type": "string" },
|
3670 | "author.name": { "required": true, "type": "string" },
|
3671 | "branch": { "type": "string" },
|
3672 | "committer": { "type": "object" },
|
3673 | "committer.email": { "required": true, "type": "string" },
|
3674 | "committer.name": { "required": true, "type": "string" },
|
3675 | "content": { "required": true, "type": "string" },
|
3676 | "message": { "required": true, "type": "string" },
|
3677 | "owner": { "required": true, "type": "string" },
|
3678 | "path": { "required": true, "type": "string" },
|
3679 | "repo": { "required": true, "type": "string" },
|
3680 | "sha": { "type": "string" }
|
3681 | },
|
3682 | "url": "/repos/:owner/:repo/contents/:path"
|
3683 | },
|
3684 | "createForAuthenticatedUser": {
|
3685 | "method": "POST",
|
3686 | "params": {
|
3687 | "allow_merge_commit": { "type": "boolean" },
|
3688 | "allow_rebase_merge": { "type": "boolean" },
|
3689 | "allow_squash_merge": { "type": "boolean" },
|
3690 | "auto_init": { "type": "boolean" },
|
3691 | "description": { "type": "string" },
|
3692 | "gitignore_template": { "type": "string" },
|
3693 | "has_issues": { "type": "boolean" },
|
3694 | "has_projects": { "type": "boolean" },
|
3695 | "has_wiki": { "type": "boolean" },
|
3696 | "homepage": { "type": "string" },
|
3697 | "is_template": { "type": "boolean" },
|
3698 | "license_template": { "type": "string" },
|
3699 | "name": { "required": true, "type": "string" },
|
3700 | "private": { "type": "boolean" },
|
3701 | "team_id": { "type": "integer" }
|
3702 | },
|
3703 | "url": "/user/repos"
|
3704 | },
|
3705 | "createFork": {
|
3706 | "method": "POST",
|
3707 | "params": {
|
3708 | "organization": { "type": "string" },
|
3709 | "owner": { "required": true, "type": "string" },
|
3710 | "repo": { "required": true, "type": "string" }
|
3711 | },
|
3712 | "url": "/repos/:owner/:repo/forks"
|
3713 | },
|
3714 | "createHook": {
|
3715 | "method": "POST",
|
3716 | "params": {
|
3717 | "active": { "type": "boolean" },
|
3718 | "config": { "required": true, "type": "object" },
|
3719 | "config.content_type": { "type": "string" },
|
3720 | "config.insecure_ssl": { "type": "string" },
|
3721 | "config.secret": { "type": "string" },
|
3722 | "config.url": { "required": true, "type": "string" },
|
3723 | "events": { "type": "string[]" },
|
3724 | "name": { "type": "string" },
|
3725 | "owner": { "required": true, "type": "string" },
|
3726 | "repo": { "required": true, "type": "string" }
|
3727 | },
|
3728 | "url": "/repos/:owner/:repo/hooks"
|
3729 | },
|
3730 | "createInOrg": {
|
3731 | "method": "POST",
|
3732 | "params": {
|
3733 | "allow_merge_commit": { "type": "boolean" },
|
3734 | "allow_rebase_merge": { "type": "boolean" },
|
3735 | "allow_squash_merge": { "type": "boolean" },
|
3736 | "auto_init": { "type": "boolean" },
|
3737 | "description": { "type": "string" },
|
3738 | "gitignore_template": { "type": "string" },
|
3739 | "has_issues": { "type": "boolean" },
|
3740 | "has_projects": { "type": "boolean" },
|
3741 | "has_wiki": { "type": "boolean" },
|
3742 | "homepage": { "type": "string" },
|
3743 | "is_template": { "type": "boolean" },
|
3744 | "license_template": { "type": "string" },
|
3745 | "name": { "required": true, "type": "string" },
|
3746 | "org": { "required": true, "type": "string" },
|
3747 | "private": { "type": "boolean" },
|
3748 | "team_id": { "type": "integer" }
|
3749 | },
|
3750 | "url": "/orgs/:org/repos"
|
3751 | },
|
3752 | "createOrUpdateFile": {
|
3753 | "method": "PUT",
|
3754 | "params": {
|
3755 | "author": { "type": "object" },
|
3756 | "author.email": { "required": true, "type": "string" },
|
3757 | "author.name": { "required": true, "type": "string" },
|
3758 | "branch": { "type": "string" },
|
3759 | "committer": { "type": "object" },
|
3760 | "committer.email": { "required": true, "type": "string" },
|
3761 | "committer.name": { "required": true, "type": "string" },
|
3762 | "content": { "required": true, "type": "string" },
|
3763 | "message": { "required": true, "type": "string" },
|
3764 | "owner": { "required": true, "type": "string" },
|
3765 | "path": { "required": true, "type": "string" },
|
3766 | "repo": { "required": true, "type": "string" },
|
3767 | "sha": { "type": "string" }
|
3768 | },
|
3769 | "url": "/repos/:owner/:repo/contents/:path"
|
3770 | },
|
3771 | "createRelease": {
|
3772 | "method": "POST",
|
3773 | "params": {
|
3774 | "body": { "type": "string" },
|
3775 | "draft": { "type": "boolean" },
|
3776 | "name": { "type": "string" },
|
3777 | "owner": { "required": true, "type": "string" },
|
3778 | "prerelease": { "type": "boolean" },
|
3779 | "repo": { "required": true, "type": "string" },
|
3780 | "tag_name": { "required": true, "type": "string" },
|
3781 | "target_commitish": { "type": "string" }
|
3782 | },
|
3783 | "url": "/repos/:owner/:repo/releases"
|
3784 | },
|
3785 | "createStatus": {
|
3786 | "method": "POST",
|
3787 | "params": {
|
3788 | "context": { "type": "string" },
|
3789 | "description": { "type": "string" },
|
3790 | "owner": { "required": true, "type": "string" },
|
3791 | "repo": { "required": true, "type": "string" },
|
3792 | "sha": { "required": true, "type": "string" },
|
3793 | "state": {
|
3794 | "enum": ["error", "failure", "pending", "success"],
|
3795 | "required": true,
|
3796 | "type": "string"
|
3797 | },
|
3798 | "target_url": { "type": "string" }
|
3799 | },
|
3800 | "url": "/repos/:owner/:repo/statuses/:sha"
|
3801 | },
|
3802 | "createUsingTemplate": {
|
3803 | "headers": { "accept": "application/vnd.github.baptiste-preview+json" },
|
3804 | "method": "POST",
|
3805 | "params": {
|
3806 | "description": { "type": "string" },
|
3807 | "name": { "required": true, "type": "string" },
|
3808 | "owner": { "type": "string" },
|
3809 | "private": { "type": "boolean" },
|
3810 | "template_owner": { "required": true, "type": "string" },
|
3811 | "template_repo": { "required": true, "type": "string" }
|
3812 | },
|
3813 | "url": "/repos/:template_owner/:template_repo/generate"
|
3814 | },
|
3815 | "declineInvitation": {
|
3816 | "method": "DELETE",
|
3817 | "params": { "invitation_id": { "required": true, "type": "integer" } },
|
3818 | "url": "/user/repository_invitations/:invitation_id"
|
3819 | },
|
3820 | "delete": {
|
3821 | "method": "DELETE",
|
3822 | "params": {
|
3823 | "owner": { "required": true, "type": "string" },
|
3824 | "repo": { "required": true, "type": "string" }
|
3825 | },
|
3826 | "url": "/repos/:owner/:repo"
|
3827 | },
|
3828 | "deleteCommitComment": {
|
3829 | "method": "DELETE",
|
3830 | "params": {
|
3831 | "comment_id": { "required": true, "type": "integer" },
|
3832 | "owner": { "required": true, "type": "string" },
|
3833 | "repo": { "required": true, "type": "string" }
|
3834 | },
|
3835 | "url": "/repos/:owner/:repo/comments/:comment_id"
|
3836 | },
|
3837 | "deleteDownload": {
|
3838 | "method": "DELETE",
|
3839 | "params": {
|
3840 | "download_id": { "required": true, "type": "integer" },
|
3841 | "owner": { "required": true, "type": "string" },
|
3842 | "repo": { "required": true, "type": "string" }
|
3843 | },
|
3844 | "url": "/repos/:owner/:repo/downloads/:download_id"
|
3845 | },
|
3846 | "deleteFile": {
|
3847 | "method": "DELETE",
|
3848 | "params": {
|
3849 | "author": { "type": "object" },
|
3850 | "author.email": { "type": "string" },
|
3851 | "author.name": { "type": "string" },
|
3852 | "branch": { "type": "string" },
|
3853 | "committer": { "type": "object" },
|
3854 | "committer.email": { "type": "string" },
|
3855 | "committer.name": { "type": "string" },
|
3856 | "message": { "required": true, "type": "string" },
|
3857 | "owner": { "required": true, "type": "string" },
|
3858 | "path": { "required": true, "type": "string" },
|
3859 | "repo": { "required": true, "type": "string" },
|
3860 | "sha": { "required": true, "type": "string" }
|
3861 | },
|
3862 | "url": "/repos/:owner/:repo/contents/:path"
|
3863 | },
|
3864 | "deleteHook": {
|
3865 | "method": "DELETE",
|
3866 | "params": {
|
3867 | "hook_id": { "required": true, "type": "integer" },
|
3868 | "owner": { "required": true, "type": "string" },
|
3869 | "repo": { "required": true, "type": "string" }
|
3870 | },
|
3871 | "url": "/repos/:owner/:repo/hooks/:hook_id"
|
3872 | },
|
3873 | "deleteInvitation": {
|
3874 | "method": "DELETE",
|
3875 | "params": {
|
3876 | "invitation_id": { "required": true, "type": "integer" },
|
3877 | "owner": { "required": true, "type": "string" },
|
3878 | "repo": { "required": true, "type": "string" }
|
3879 | },
|
3880 | "url": "/repos/:owner/:repo/invitations/:invitation_id"
|
3881 | },
|
3882 | "deleteRelease": {
|
3883 | "method": "DELETE",
|
3884 | "params": {
|
3885 | "owner": { "required": true, "type": "string" },
|
3886 | "release_id": { "required": true, "type": "integer" },
|
3887 | "repo": { "required": true, "type": "string" }
|
3888 | },
|
3889 | "url": "/repos/:owner/:repo/releases/:release_id"
|
3890 | },
|
3891 | "deleteReleaseAsset": {
|
3892 | "method": "DELETE",
|
3893 | "params": {
|
3894 | "asset_id": { "required": true, "type": "integer" },
|
3895 | "owner": { "required": true, "type": "string" },
|
3896 | "repo": { "required": true, "type": "string" }
|
3897 | },
|
3898 | "url": "/repos/:owner/:repo/releases/assets/:asset_id"
|
3899 | },
|
3900 | "disablePagesSite": {
|
3901 | "headers": { "accept": "application/vnd.github.switcheroo-preview+json" },
|
3902 | "method": "DELETE",
|
3903 | "params": {
|
3904 | "owner": { "required": true, "type": "string" },
|
3905 | "repo": { "required": true, "type": "string" }
|
3906 | },
|
3907 | "url": "/repos/:owner/:repo/pages"
|
3908 | },
|
3909 | "disableVulnerabilityAlerts": {
|
3910 | "headers": { "accept": "application/vnd.github.dorian-preview+json" },
|
3911 | "method": "DELETE",
|
3912 | "params": {
|
3913 | "owner": { "required": true, "type": "string" },
|
3914 | "repo": { "required": true, "type": "string" }
|
3915 | },
|
3916 | "url": "/repos/:owner/:repo/vulnerability-alerts"
|
3917 | },
|
3918 | "enablePagesSite": {
|
3919 | "headers": { "accept": "application/vnd.github.switcheroo-preview+json" },
|
3920 | "method": "POST",
|
3921 | "params": {
|
3922 | "owner": { "required": true, "type": "string" },
|
3923 | "repo": { "required": true, "type": "string" },
|
3924 | "source": { "type": "object" },
|
3925 | "source.branch": { "enum": ["master", "gh-pages"], "type": "string" },
|
3926 | "source.path": { "type": "string" }
|
3927 | },
|
3928 | "url": "/repos/:owner/:repo/pages"
|
3929 | },
|
3930 | "enableVulnerabilityAlerts": {
|
3931 | "headers": { "accept": "application/vnd.github.dorian-preview+json" },
|
3932 | "method": "PUT",
|
3933 | "params": {
|
3934 | "owner": { "required": true, "type": "string" },
|
3935 | "repo": { "required": true, "type": "string" }
|
3936 | },
|
3937 | "url": "/repos/:owner/:repo/vulnerability-alerts"
|
3938 | },
|
3939 | "get": {
|
3940 | "method": "GET",
|
3941 | "params": {
|
3942 | "owner": { "required": true, "type": "string" },
|
3943 | "repo": { "required": true, "type": "string" }
|
3944 | },
|
3945 | "url": "/repos/:owner/:repo"
|
3946 | },
|
3947 | "getArchiveLink": {
|
3948 | "method": "GET",
|
3949 | "params": {
|
3950 | "archive_format": { "required": true, "type": "string" },
|
3951 | "owner": { "required": true, "type": "string" },
|
3952 | "ref": { "required": true, "type": "string" },
|
3953 | "repo": { "required": true, "type": "string" }
|
3954 | },
|
3955 | "url": "/repos/:owner/:repo/:archive_format/:ref"
|
3956 | },
|
3957 | "getBranch": {
|
3958 | "method": "GET",
|
3959 | "params": {
|
3960 | "branch": { "required": true, "type": "string" },
|
3961 | "owner": { "required": true, "type": "string" },
|
3962 | "repo": { "required": true, "type": "string" }
|
3963 | },
|
3964 | "url": "/repos/:owner/:repo/branches/:branch"
|
3965 | },
|
3966 | "getBranchProtection": {
|
3967 | "method": "GET",
|
3968 | "params": {
|
3969 | "branch": { "required": true, "type": "string" },
|
3970 | "owner": { "required": true, "type": "string" },
|
3971 | "repo": { "required": true, "type": "string" }
|
3972 | },
|
3973 | "url": "/repos/:owner/:repo/branches/:branch/protection"
|
3974 | },
|
3975 | "getCodeFrequencyStats": {
|
3976 | "method": "GET",
|
3977 | "params": {
|
3978 | "owner": { "required": true, "type": "string" },
|
3979 | "repo": { "required": true, "type": "string" }
|
3980 | },
|
3981 | "url": "/repos/:owner/:repo/stats/code_frequency"
|
3982 | },
|
3983 | "getCollaboratorPermissionLevel": {
|
3984 | "method": "GET",
|
3985 | "params": {
|
3986 | "owner": { "required": true, "type": "string" },
|
3987 | "repo": { "required": true, "type": "string" },
|
3988 | "username": { "required": true, "type": "string" }
|
3989 | },
|
3990 | "url": "/repos/:owner/:repo/collaborators/:username/permission"
|
3991 | },
|
3992 | "getCombinedStatusForRef": {
|
3993 | "method": "GET",
|
3994 | "params": {
|
3995 | "owner": { "required": true, "type": "string" },
|
3996 | "ref": { "required": true, "type": "string" },
|
3997 | "repo": { "required": true, "type": "string" }
|
3998 | },
|
3999 | "url": "/repos/:owner/:repo/commits/:ref/status"
|
4000 | },
|
4001 | "getCommit": {
|
4002 | "method": "GET",
|
4003 | "params": {
|
4004 | "commit_sha": { "alias": "ref", "deprecated": true, "type": "string" },
|
4005 | "owner": { "required": true, "type": "string" },
|
4006 | "ref": { "required": true, "type": "string" },
|
4007 | "repo": { "required": true, "type": "string" },
|
4008 | "sha": { "alias": "ref", "deprecated": true, "type": "string" }
|
4009 | },
|
4010 | "url": "/repos/:owner/:repo/commits/:ref"
|
4011 | },
|
4012 | "getCommitActivityStats": {
|
4013 | "method": "GET",
|
4014 | "params": {
|
4015 | "owner": { "required": true, "type": "string" },
|
4016 | "repo": { "required": true, "type": "string" }
|
4017 | },
|
4018 | "url": "/repos/:owner/:repo/stats/commit_activity"
|
4019 | },
|
4020 | "getCommitComment": {
|
4021 | "method": "GET",
|
4022 | "params": {
|
4023 | "comment_id": { "required": true, "type": "integer" },
|
4024 | "owner": { "required": true, "type": "string" },
|
4025 | "repo": { "required": true, "type": "string" }
|
4026 | },
|
4027 | "url": "/repos/:owner/:repo/comments/:comment_id"
|
4028 | },
|
4029 | "getCommitRefSha": {
|
4030 | "deprecated": "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit",
|
4031 | "headers": { "accept": "application/vnd.github.v3.sha" },
|
4032 | "method": "GET",
|
4033 | "params": {
|
4034 | "owner": { "required": true, "type": "string" },
|
4035 | "ref": { "required": true, "type": "string" },
|
4036 | "repo": { "required": true, "type": "string" }
|
4037 | },
|
4038 | "url": "/repos/:owner/:repo/commits/:ref"
|
4039 | },
|
4040 | "getContents": {
|
4041 | "method": "GET",
|
4042 | "params": {
|
4043 | "owner": { "required": true, "type": "string" },
|
4044 | "path": { "required": true, "type": "string" },
|
4045 | "ref": { "type": "string" },
|
4046 | "repo": { "required": true, "type": "string" }
|
4047 | },
|
4048 | "url": "/repos/:owner/:repo/contents/:path"
|
4049 | },
|
4050 | "getContributorsStats": {
|
4051 | "method": "GET",
|
4052 | "params": {
|
4053 | "owner": { "required": true, "type": "string" },
|
4054 | "repo": { "required": true, "type": "string" }
|
4055 | },
|
4056 | "url": "/repos/:owner/:repo/stats/contributors"
|
4057 | },
|
4058 | "getDeployKey": {
|
4059 | "method": "GET",
|
4060 | "params": {
|
4061 | "key_id": { "required": true, "type": "integer" },
|
4062 | "owner": { "required": true, "type": "string" },
|
4063 | "repo": { "required": true, "type": "string" }
|
4064 | },
|
4065 | "url": "/repos/:owner/:repo/keys/:key_id"
|
4066 | },
|
4067 | "getDeployment": {
|
4068 | "method": "GET",
|
4069 | "params": {
|
4070 | "deployment_id": { "required": true, "type": "integer" },
|
4071 | "owner": { "required": true, "type": "string" },
|
4072 | "repo": { "required": true, "type": "string" }
|
4073 | },
|
4074 | "url": "/repos/:owner/:repo/deployments/:deployment_id"
|
4075 | },
|
4076 | "getDeploymentStatus": {
|
4077 | "method": "GET",
|
4078 | "params": {
|
4079 | "deployment_id": { "required": true, "type": "integer" },
|
4080 | "owner": { "required": true, "type": "string" },
|
4081 | "repo": { "required": true, "type": "string" },
|
4082 | "status_id": { "required": true, "type": "integer" }
|
4083 | },
|
4084 | "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"
|
4085 | },
|
4086 | "getDownload": {
|
4087 | "method": "GET",
|
4088 | "params": {
|
4089 | "download_id": { "required": true, "type": "integer" },
|
4090 | "owner": { "required": true, "type": "string" },
|
4091 | "repo": { "required": true, "type": "string" }
|
4092 | },
|
4093 | "url": "/repos/:owner/:repo/downloads/:download_id"
|
4094 | },
|
4095 | "getHook": {
|
4096 | "method": "GET",
|
4097 | "params": {
|
4098 | "hook_id": { "required": true, "type": "integer" },
|
4099 | "owner": { "required": true, "type": "string" },
|
4100 | "repo": { "required": true, "type": "string" }
|
4101 | },
|
4102 | "url": "/repos/:owner/:repo/hooks/:hook_id"
|
4103 | },
|
4104 | "getLatestPagesBuild": {
|
4105 | "method": "GET",
|
4106 | "params": {
|
4107 | "owner": { "required": true, "type": "string" },
|
4108 | "repo": { "required": true, "type": "string" }
|
4109 | },
|
4110 | "url": "/repos/:owner/:repo/pages/builds/latest"
|
4111 | },
|
4112 | "getLatestRelease": {
|
4113 | "method": "GET",
|
4114 | "params": {
|
4115 | "owner": { "required": true, "type": "string" },
|
4116 | "repo": { "required": true, "type": "string" }
|
4117 | },
|
4118 | "url": "/repos/:owner/:repo/releases/latest"
|
4119 | },
|
4120 | "getPages": {
|
4121 | "method": "GET",
|
4122 | "params": {
|
4123 | "owner": { "required": true, "type": "string" },
|
4124 | "repo": { "required": true, "type": "string" }
|
4125 | },
|
4126 | "url": "/repos/:owner/:repo/pages"
|
4127 | },
|
4128 | "getPagesBuild": {
|
4129 | "method": "GET",
|
4130 | "params": {
|
4131 | "build_id": { "required": true, "type": "integer" },
|
4132 | "owner": { "required": true, "type": "string" },
|
4133 | "repo": { "required": true, "type": "string" }
|
4134 | },
|
4135 | "url": "/repos/:owner/:repo/pages/builds/:build_id"
|
4136 | },
|
4137 | "getParticipationStats": {
|
4138 | "method": "GET",
|
4139 | "params": {
|
4140 | "owner": { "required": true, "type": "string" },
|
4141 | "repo": { "required": true, "type": "string" }
|
4142 | },
|
4143 | "url": "/repos/:owner/:repo/stats/participation"
|
4144 | },
|
4145 | "getProtectedBranchAdminEnforcement": {
|
4146 | "method": "GET",
|
4147 | "params": {
|
4148 | "branch": { "required": true, "type": "string" },
|
4149 | "owner": { "required": true, "type": "string" },
|
4150 | "repo": { "required": true, "type": "string" }
|
4151 | },
|
4152 | "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
|
4153 | },
|
4154 | "getProtectedBranchPullRequestReviewEnforcement": {
|
4155 | "method": "GET",
|
4156 | "params": {
|
4157 | "branch": { "required": true, "type": "string" },
|
4158 | "owner": { "required": true, "type": "string" },
|
4159 | "repo": { "required": true, "type": "string" }
|
4160 | },
|
4161 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
|
4162 | },
|
4163 | "getProtectedBranchRequiredSignatures": {
|
4164 | "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
|
4165 | "method": "GET",
|
4166 | "params": {
|
4167 | "branch": { "required": true, "type": "string" },
|
4168 | "owner": { "required": true, "type": "string" },
|
4169 | "repo": { "required": true, "type": "string" }
|
4170 | },
|
4171 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
|
4172 | },
|
4173 | "getProtectedBranchRequiredStatusChecks": {
|
4174 | "method": "GET",
|
4175 | "params": {
|
4176 | "branch": { "required": true, "type": "string" },
|
4177 | "owner": { "required": true, "type": "string" },
|
4178 | "repo": { "required": true, "type": "string" }
|
4179 | },
|
4180 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
|
4181 | },
|
4182 | "getProtectedBranchRestrictions": {
|
4183 | "method": "GET",
|
4184 | "params": {
|
4185 | "branch": { "required": true, "type": "string" },
|
4186 | "owner": { "required": true, "type": "string" },
|
4187 | "repo": { "required": true, "type": "string" }
|
4188 | },
|
4189 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
|
4190 | },
|
4191 | "getPunchCardStats": {
|
4192 | "method": "GET",
|
4193 | "params": {
|
4194 | "owner": { "required": true, "type": "string" },
|
4195 | "repo": { "required": true, "type": "string" }
|
4196 | },
|
4197 | "url": "/repos/:owner/:repo/stats/punch_card"
|
4198 | },
|
4199 | "getReadme": {
|
4200 | "method": "GET",
|
4201 | "params": {
|
4202 | "owner": { "required": true, "type": "string" },
|
4203 | "ref": { "type": "string" },
|
4204 | "repo": { "required": true, "type": "string" }
|
4205 | },
|
4206 | "url": "/repos/:owner/:repo/readme"
|
4207 | },
|
4208 | "getRelease": {
|
4209 | "method": "GET",
|
4210 | "params": {
|
4211 | "owner": { "required": true, "type": "string" },
|
4212 | "release_id": { "required": true, "type": "integer" },
|
4213 | "repo": { "required": true, "type": "string" }
|
4214 | },
|
4215 | "url": "/repos/:owner/:repo/releases/:release_id"
|
4216 | },
|
4217 | "getReleaseAsset": {
|
4218 | "method": "GET",
|
4219 | "params": {
|
4220 | "asset_id": { "required": true, "type": "integer" },
|
4221 | "owner": { "required": true, "type": "string" },
|
4222 | "repo": { "required": true, "type": "string" }
|
4223 | },
|
4224 | "url": "/repos/:owner/:repo/releases/assets/:asset_id"
|
4225 | },
|
4226 | "getReleaseByTag": {
|
4227 | "method": "GET",
|
4228 | "params": {
|
4229 | "owner": { "required": true, "type": "string" },
|
4230 | "repo": { "required": true, "type": "string" },
|
4231 | "tag": { "required": true, "type": "string" }
|
4232 | },
|
4233 | "url": "/repos/:owner/:repo/releases/tags/:tag"
|
4234 | },
|
4235 | "getTeamsWithAccessToProtectedBranch": {
|
4236 | "method": "GET",
|
4237 | "params": {
|
4238 | "branch": { "required": true, "type": "string" },
|
4239 | "owner": { "required": true, "type": "string" },
|
4240 | "repo": { "required": true, "type": "string" }
|
4241 | },
|
4242 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
|
4243 | },
|
4244 | "getUsersWithAccessToProtectedBranch": {
|
4245 | "method": "GET",
|
4246 | "params": {
|
4247 | "branch": { "required": true, "type": "string" },
|
4248 | "owner": { "required": true, "type": "string" },
|
4249 | "repo": { "required": true, "type": "string" }
|
4250 | },
|
4251 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
|
4252 | },
|
4253 | "list": {
|
4254 | "method": "GET",
|
4255 | "params": {
|
4256 | "affiliation": { "type": "string" },
|
4257 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
4258 | "page": { "type": "integer" },
|
4259 | "per_page": { "type": "integer" },
|
4260 | "sort": {
|
4261 | "enum": ["created", "updated", "pushed", "full_name"],
|
4262 | "type": "string"
|
4263 | },
|
4264 | "type": {
|
4265 | "enum": ["all", "owner", "public", "private", "member"],
|
4266 | "type": "string"
|
4267 | },
|
4268 | "visibility": { "enum": ["all", "public", "private"], "type": "string" }
|
4269 | },
|
4270 | "url": "/user/repos"
|
4271 | },
|
4272 | "listAssetsForRelease": {
|
4273 | "method": "GET",
|
4274 | "params": {
|
4275 | "owner": { "required": true, "type": "string" },
|
4276 | "page": { "type": "integer" },
|
4277 | "per_page": { "type": "integer" },
|
4278 | "release_id": { "required": true, "type": "integer" },
|
4279 | "repo": { "required": true, "type": "string" }
|
4280 | },
|
4281 | "url": "/repos/:owner/:repo/releases/:release_id/assets"
|
4282 | },
|
4283 | "listBranches": {
|
4284 | "method": "GET",
|
4285 | "params": {
|
4286 | "owner": { "required": true, "type": "string" },
|
4287 | "page": { "type": "integer" },
|
4288 | "per_page": { "type": "integer" },
|
4289 | "protected": { "type": "boolean" },
|
4290 | "repo": { "required": true, "type": "string" }
|
4291 | },
|
4292 | "url": "/repos/:owner/:repo/branches"
|
4293 | },
|
4294 | "listBranchesForHeadCommit": {
|
4295 | "headers": { "accept": "application/vnd.github.groot-preview+json" },
|
4296 | "method": "GET",
|
4297 | "params": {
|
4298 | "commit_sha": { "required": true, "type": "string" },
|
4299 | "owner": { "required": true, "type": "string" },
|
4300 | "repo": { "required": true, "type": "string" }
|
4301 | },
|
4302 | "url": "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"
|
4303 | },
|
4304 | "listCollaborators": {
|
4305 | "method": "GET",
|
4306 | "params": {
|
4307 | "affiliation": {
|
4308 | "enum": ["outside", "direct", "all"],
|
4309 | "type": "string"
|
4310 | },
|
4311 | "owner": { "required": true, "type": "string" },
|
4312 | "page": { "type": "integer" },
|
4313 | "per_page": { "type": "integer" },
|
4314 | "repo": { "required": true, "type": "string" }
|
4315 | },
|
4316 | "url": "/repos/:owner/:repo/collaborators"
|
4317 | },
|
4318 | "listCommentsForCommit": {
|
4319 | "method": "GET",
|
4320 | "params": {
|
4321 | "commit_sha": { "required": true, "type": "string" },
|
4322 | "owner": { "required": true, "type": "string" },
|
4323 | "page": { "type": "integer" },
|
4324 | "per_page": { "type": "integer" },
|
4325 | "ref": { "alias": "commit_sha", "deprecated": true, "type": "string" },
|
4326 | "repo": { "required": true, "type": "string" }
|
4327 | },
|
4328 | "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
|
4329 | },
|
4330 | "listCommitComments": {
|
4331 | "method": "GET",
|
4332 | "params": {
|
4333 | "owner": { "required": true, "type": "string" },
|
4334 | "page": { "type": "integer" },
|
4335 | "per_page": { "type": "integer" },
|
4336 | "repo": { "required": true, "type": "string" }
|
4337 | },
|
4338 | "url": "/repos/:owner/:repo/comments"
|
4339 | },
|
4340 | "listCommits": {
|
4341 | "method": "GET",
|
4342 | "params": {
|
4343 | "author": { "type": "string" },
|
4344 | "owner": { "required": true, "type": "string" },
|
4345 | "page": { "type": "integer" },
|
4346 | "path": { "type": "string" },
|
4347 | "per_page": { "type": "integer" },
|
4348 | "repo": { "required": true, "type": "string" },
|
4349 | "sha": { "type": "string" },
|
4350 | "since": { "type": "string" },
|
4351 | "until": { "type": "string" }
|
4352 | },
|
4353 | "url": "/repos/:owner/:repo/commits"
|
4354 | },
|
4355 | "listContributors": {
|
4356 | "method": "GET",
|
4357 | "params": {
|
4358 | "anon": { "type": "string" },
|
4359 | "owner": { "required": true, "type": "string" },
|
4360 | "page": { "type": "integer" },
|
4361 | "per_page": { "type": "integer" },
|
4362 | "repo": { "required": true, "type": "string" }
|
4363 | },
|
4364 | "url": "/repos/:owner/:repo/contributors"
|
4365 | },
|
4366 | "listDeployKeys": {
|
4367 | "method": "GET",
|
4368 | "params": {
|
4369 | "owner": { "required": true, "type": "string" },
|
4370 | "page": { "type": "integer" },
|
4371 | "per_page": { "type": "integer" },
|
4372 | "repo": { "required": true, "type": "string" }
|
4373 | },
|
4374 | "url": "/repos/:owner/:repo/keys"
|
4375 | },
|
4376 | "listDeploymentStatuses": {
|
4377 | "method": "GET",
|
4378 | "params": {
|
4379 | "deployment_id": { "required": true, "type": "integer" },
|
4380 | "owner": { "required": true, "type": "string" },
|
4381 | "page": { "type": "integer" },
|
4382 | "per_page": { "type": "integer" },
|
4383 | "repo": { "required": true, "type": "string" }
|
4384 | },
|
4385 | "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
|
4386 | },
|
4387 | "listDeployments": {
|
4388 | "method": "GET",
|
4389 | "params": {
|
4390 | "environment": { "type": "string" },
|
4391 | "owner": { "required": true, "type": "string" },
|
4392 | "page": { "type": "integer" },
|
4393 | "per_page": { "type": "integer" },
|
4394 | "ref": { "type": "string" },
|
4395 | "repo": { "required": true, "type": "string" },
|
4396 | "sha": { "type": "string" },
|
4397 | "task": { "type": "string" }
|
4398 | },
|
4399 | "url": "/repos/:owner/:repo/deployments"
|
4400 | },
|
4401 | "listDownloads": {
|
4402 | "method": "GET",
|
4403 | "params": {
|
4404 | "owner": { "required": true, "type": "string" },
|
4405 | "page": { "type": "integer" },
|
4406 | "per_page": { "type": "integer" },
|
4407 | "repo": { "required": true, "type": "string" }
|
4408 | },
|
4409 | "url": "/repos/:owner/:repo/downloads"
|
4410 | },
|
4411 | "listForOrg": {
|
4412 | "method": "GET",
|
4413 | "params": {
|
4414 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
4415 | "org": { "required": true, "type": "string" },
|
4416 | "page": { "type": "integer" },
|
4417 | "per_page": { "type": "integer" },
|
4418 | "sort": {
|
4419 | "enum": ["created", "updated", "pushed", "full_name"],
|
4420 | "type": "string"
|
4421 | },
|
4422 | "type": {
|
4423 | "enum": ["all", "public", "private", "forks", "sources", "member"],
|
4424 | "type": "string"
|
4425 | }
|
4426 | },
|
4427 | "url": "/orgs/:org/repos"
|
4428 | },
|
4429 | "listForUser": {
|
4430 | "method": "GET",
|
4431 | "params": {
|
4432 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
4433 | "page": { "type": "integer" },
|
4434 | "per_page": { "type": "integer" },
|
4435 | "sort": {
|
4436 | "enum": ["created", "updated", "pushed", "full_name"],
|
4437 | "type": "string"
|
4438 | },
|
4439 | "type": { "enum": ["all", "owner", "member"], "type": "string" },
|
4440 | "username": { "required": true, "type": "string" }
|
4441 | },
|
4442 | "url": "/users/:username/repos"
|
4443 | },
|
4444 | "listForks": {
|
4445 | "method": "GET",
|
4446 | "params": {
|
4447 | "owner": { "required": true, "type": "string" },
|
4448 | "page": { "type": "integer" },
|
4449 | "per_page": { "type": "integer" },
|
4450 | "repo": { "required": true, "type": "string" },
|
4451 | "sort": { "enum": ["newest", "oldest", "stargazers"], "type": "string" }
|
4452 | },
|
4453 | "url": "/repos/:owner/:repo/forks"
|
4454 | },
|
4455 | "listHooks": {
|
4456 | "method": "GET",
|
4457 | "params": {
|
4458 | "owner": { "required": true, "type": "string" },
|
4459 | "page": { "type": "integer" },
|
4460 | "per_page": { "type": "integer" },
|
4461 | "repo": { "required": true, "type": "string" }
|
4462 | },
|
4463 | "url": "/repos/:owner/:repo/hooks"
|
4464 | },
|
4465 | "listInvitations": {
|
4466 | "method": "GET",
|
4467 | "params": {
|
4468 | "owner": { "required": true, "type": "string" },
|
4469 | "page": { "type": "integer" },
|
4470 | "per_page": { "type": "integer" },
|
4471 | "repo": { "required": true, "type": "string" }
|
4472 | },
|
4473 | "url": "/repos/:owner/:repo/invitations"
|
4474 | },
|
4475 | "listInvitationsForAuthenticatedUser": {
|
4476 | "method": "GET",
|
4477 | "params": {
|
4478 | "page": { "type": "integer" },
|
4479 | "per_page": { "type": "integer" }
|
4480 | },
|
4481 | "url": "/user/repository_invitations"
|
4482 | },
|
4483 | "listLanguages": {
|
4484 | "method": "GET",
|
4485 | "params": {
|
4486 | "owner": { "required": true, "type": "string" },
|
4487 | "repo": { "required": true, "type": "string" }
|
4488 | },
|
4489 | "url": "/repos/:owner/:repo/languages"
|
4490 | },
|
4491 | "listPagesBuilds": {
|
4492 | "method": "GET",
|
4493 | "params": {
|
4494 | "owner": { "required": true, "type": "string" },
|
4495 | "page": { "type": "integer" },
|
4496 | "per_page": { "type": "integer" },
|
4497 | "repo": { "required": true, "type": "string" }
|
4498 | },
|
4499 | "url": "/repos/:owner/:repo/pages/builds"
|
4500 | },
|
4501 | "listProtectedBranchRequiredStatusChecksContexts": {
|
4502 | "method": "GET",
|
4503 | "params": {
|
4504 | "branch": { "required": true, "type": "string" },
|
4505 | "owner": { "required": true, "type": "string" },
|
4506 | "repo": { "required": true, "type": "string" }
|
4507 | },
|
4508 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
|
4509 | },
|
4510 | "listProtectedBranchTeamRestrictions": {
|
4511 | "deprecated": "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)",
|
4512 | "method": "GET",
|
4513 | "params": {
|
4514 | "branch": { "required": true, "type": "string" },
|
4515 | "owner": { "required": true, "type": "string" },
|
4516 | "repo": { "required": true, "type": "string" }
|
4517 | },
|
4518 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
|
4519 | },
|
4520 | "listProtectedBranchUserRestrictions": {
|
4521 | "deprecated": "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)",
|
4522 | "method": "GET",
|
4523 | "params": {
|
4524 | "branch": { "required": true, "type": "string" },
|
4525 | "owner": { "required": true, "type": "string" },
|
4526 | "repo": { "required": true, "type": "string" }
|
4527 | },
|
4528 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
|
4529 | },
|
4530 | "listPublic": {
|
4531 | "method": "GET",
|
4532 | "params": {
|
4533 | "page": { "type": "integer" },
|
4534 | "per_page": { "type": "integer" },
|
4535 | "since": { "type": "string" },
|
4536 | "visibility": { "type": "string" }
|
4537 | },
|
4538 | "url": "/repositories"
|
4539 | },
|
4540 | "listPullRequestsAssociatedWithCommit": {
|
4541 | "headers": { "accept": "application/vnd.github.groot-preview+json" },
|
4542 | "method": "GET",
|
4543 | "params": {
|
4544 | "commit_sha": { "required": true, "type": "string" },
|
4545 | "owner": { "required": true, "type": "string" },
|
4546 | "page": { "type": "integer" },
|
4547 | "per_page": { "type": "integer" },
|
4548 | "repo": { "required": true, "type": "string" }
|
4549 | },
|
4550 | "url": "/repos/:owner/:repo/commits/:commit_sha/pulls"
|
4551 | },
|
4552 | "listReleases": {
|
4553 | "method": "GET",
|
4554 | "params": {
|
4555 | "owner": { "required": true, "type": "string" },
|
4556 | "page": { "type": "integer" },
|
4557 | "per_page": { "type": "integer" },
|
4558 | "repo": { "required": true, "type": "string" }
|
4559 | },
|
4560 | "url": "/repos/:owner/:repo/releases"
|
4561 | },
|
4562 | "listStatusesForRef": {
|
4563 | "method": "GET",
|
4564 | "params": {
|
4565 | "owner": { "required": true, "type": "string" },
|
4566 | "page": { "type": "integer" },
|
4567 | "per_page": { "type": "integer" },
|
4568 | "ref": { "required": true, "type": "string" },
|
4569 | "repo": { "required": true, "type": "string" }
|
4570 | },
|
4571 | "url": "/repos/:owner/:repo/commits/:ref/statuses"
|
4572 | },
|
4573 | "listTags": {
|
4574 | "method": "GET",
|
4575 | "params": {
|
4576 | "owner": { "required": true, "type": "string" },
|
4577 | "page": { "type": "integer" },
|
4578 | "per_page": { "type": "integer" },
|
4579 | "repo": { "required": true, "type": "string" }
|
4580 | },
|
4581 | "url": "/repos/:owner/:repo/tags"
|
4582 | },
|
4583 | "listTeams": {
|
4584 | "method": "GET",
|
4585 | "params": {
|
4586 | "owner": { "required": true, "type": "string" },
|
4587 | "page": { "type": "integer" },
|
4588 | "per_page": { "type": "integer" },
|
4589 | "repo": { "required": true, "type": "string" }
|
4590 | },
|
4591 | "url": "/repos/:owner/:repo/teams"
|
4592 | },
|
4593 | "listTeamsWithAccessToProtectedBranch": {
|
4594 | "deprecated": "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)",
|
4595 | "method": "GET",
|
4596 | "params": {
|
4597 | "branch": { "required": true, "type": "string" },
|
4598 | "owner": { "required": true, "type": "string" },
|
4599 | "repo": { "required": true, "type": "string" }
|
4600 | },
|
4601 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
|
4602 | },
|
4603 | "listTopics": {
|
4604 | "headers": { "accept": "application/vnd.github.mercy-preview+json" },
|
4605 | "method": "GET",
|
4606 | "params": {
|
4607 | "owner": { "required": true, "type": "string" },
|
4608 | "repo": { "required": true, "type": "string" }
|
4609 | },
|
4610 | "url": "/repos/:owner/:repo/topics"
|
4611 | },
|
4612 | "listUsersWithAccessToProtectedBranch": {
|
4613 | "deprecated": "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)",
|
4614 | "method": "GET",
|
4615 | "params": {
|
4616 | "branch": { "required": true, "type": "string" },
|
4617 | "owner": { "required": true, "type": "string" },
|
4618 | "repo": { "required": true, "type": "string" }
|
4619 | },
|
4620 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
|
4621 | },
|
4622 | "merge": {
|
4623 | "method": "POST",
|
4624 | "params": {
|
4625 | "base": { "required": true, "type": "string" },
|
4626 | "commit_message": { "type": "string" },
|
4627 | "head": { "required": true, "type": "string" },
|
4628 | "owner": { "required": true, "type": "string" },
|
4629 | "repo": { "required": true, "type": "string" }
|
4630 | },
|
4631 | "url": "/repos/:owner/:repo/merges"
|
4632 | },
|
4633 | "pingHook": {
|
4634 | "method": "POST",
|
4635 | "params": {
|
4636 | "hook_id": { "required": true, "type": "integer" },
|
4637 | "owner": { "required": true, "type": "string" },
|
4638 | "repo": { "required": true, "type": "string" }
|
4639 | },
|
4640 | "url": "/repos/:owner/:repo/hooks/:hook_id/pings"
|
4641 | },
|
4642 | "removeBranchProtection": {
|
4643 | "method": "DELETE",
|
4644 | "params": {
|
4645 | "branch": { "required": true, "type": "string" },
|
4646 | "owner": { "required": true, "type": "string" },
|
4647 | "repo": { "required": true, "type": "string" }
|
4648 | },
|
4649 | "url": "/repos/:owner/:repo/branches/:branch/protection"
|
4650 | },
|
4651 | "removeCollaborator": {
|
4652 | "method": "DELETE",
|
4653 | "params": {
|
4654 | "owner": { "required": true, "type": "string" },
|
4655 | "repo": { "required": true, "type": "string" },
|
4656 | "username": { "required": true, "type": "string" }
|
4657 | },
|
4658 | "url": "/repos/:owner/:repo/collaborators/:username"
|
4659 | },
|
4660 | "removeDeployKey": {
|
4661 | "method": "DELETE",
|
4662 | "params": {
|
4663 | "key_id": { "required": true, "type": "integer" },
|
4664 | "owner": { "required": true, "type": "string" },
|
4665 | "repo": { "required": true, "type": "string" }
|
4666 | },
|
4667 | "url": "/repos/:owner/:repo/keys/:key_id"
|
4668 | },
|
4669 | "removeProtectedBranchAdminEnforcement": {
|
4670 | "method": "DELETE",
|
4671 | "params": {
|
4672 | "branch": { "required": true, "type": "string" },
|
4673 | "owner": { "required": true, "type": "string" },
|
4674 | "repo": { "required": true, "type": "string" }
|
4675 | },
|
4676 | "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
|
4677 | },
|
4678 | "removeProtectedBranchPullRequestReviewEnforcement": {
|
4679 | "method": "DELETE",
|
4680 | "params": {
|
4681 | "branch": { "required": true, "type": "string" },
|
4682 | "owner": { "required": true, "type": "string" },
|
4683 | "repo": { "required": true, "type": "string" }
|
4684 | },
|
4685 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
|
4686 | },
|
4687 | "removeProtectedBranchRequiredSignatures": {
|
4688 | "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
|
4689 | "method": "DELETE",
|
4690 | "params": {
|
4691 | "branch": { "required": true, "type": "string" },
|
4692 | "owner": { "required": true, "type": "string" },
|
4693 | "repo": { "required": true, "type": "string" }
|
4694 | },
|
4695 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
|
4696 | },
|
4697 | "removeProtectedBranchRequiredStatusChecks": {
|
4698 | "method": "DELETE",
|
4699 | "params": {
|
4700 | "branch": { "required": true, "type": "string" },
|
4701 | "owner": { "required": true, "type": "string" },
|
4702 | "repo": { "required": true, "type": "string" }
|
4703 | },
|
4704 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
|
4705 | },
|
4706 | "removeProtectedBranchRequiredStatusChecksContexts": {
|
4707 | "method": "DELETE",
|
4708 | "params": {
|
4709 | "branch": { "required": true, "type": "string" },
|
4710 | "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
|
4711 | "owner": { "required": true, "type": "string" },
|
4712 | "repo": { "required": true, "type": "string" }
|
4713 | },
|
4714 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
|
4715 | },
|
4716 | "removeProtectedBranchRestrictions": {
|
4717 | "method": "DELETE",
|
4718 | "params": {
|
4719 | "branch": { "required": true, "type": "string" },
|
4720 | "owner": { "required": true, "type": "string" },
|
4721 | "repo": { "required": true, "type": "string" }
|
4722 | },
|
4723 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
|
4724 | },
|
4725 | "removeProtectedBranchTeamRestrictions": {
|
4726 | "method": "DELETE",
|
4727 | "params": {
|
4728 | "branch": { "required": true, "type": "string" },
|
4729 | "owner": { "required": true, "type": "string" },
|
4730 | "repo": { "required": true, "type": "string" },
|
4731 | "teams": { "mapTo": "data", "required": true, "type": "string[]" }
|
4732 | },
|
4733 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
|
4734 | },
|
4735 | "removeProtectedBranchUserRestrictions": {
|
4736 | "method": "DELETE",
|
4737 | "params": {
|
4738 | "branch": { "required": true, "type": "string" },
|
4739 | "owner": { "required": true, "type": "string" },
|
4740 | "repo": { "required": true, "type": "string" },
|
4741 | "users": { "mapTo": "data", "required": true, "type": "string[]" }
|
4742 | },
|
4743 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
|
4744 | },
|
4745 | "replaceProtectedBranchRequiredStatusChecksContexts": {
|
4746 | "method": "PUT",
|
4747 | "params": {
|
4748 | "branch": { "required": true, "type": "string" },
|
4749 | "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
|
4750 | "owner": { "required": true, "type": "string" },
|
4751 | "repo": { "required": true, "type": "string" }
|
4752 | },
|
4753 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
|
4754 | },
|
4755 | "replaceProtectedBranchTeamRestrictions": {
|
4756 | "method": "PUT",
|
4757 | "params": {
|
4758 | "branch": { "required": true, "type": "string" },
|
4759 | "owner": { "required": true, "type": "string" },
|
4760 | "repo": { "required": true, "type": "string" },
|
4761 | "teams": { "mapTo": "data", "required": true, "type": "string[]" }
|
4762 | },
|
4763 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
|
4764 | },
|
4765 | "replaceProtectedBranchUserRestrictions": {
|
4766 | "method": "PUT",
|
4767 | "params": {
|
4768 | "branch": { "required": true, "type": "string" },
|
4769 | "owner": { "required": true, "type": "string" },
|
4770 | "repo": { "required": true, "type": "string" },
|
4771 | "users": { "mapTo": "data", "required": true, "type": "string[]" }
|
4772 | },
|
4773 | "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
|
4774 | },
|
4775 | "replaceTopics": {
|
4776 | "headers": { "accept": "application/vnd.github.mercy-preview+json" },
|
4777 | "method": "PUT",
|
4778 | "params": {
|
4779 | "names": { "required": true, "type": "string[]" },
|
4780 | "owner": { "required": true, "type": "string" },
|
4781 | "repo": { "required": true, "type": "string" }
|
4782 | },
|
4783 | "url": "/repos/:owner/:repo/topics"
|
4784 | },
|
4785 | "requestPageBuild": {
|
4786 | "headers": {
|
4787 | "accept": "application/vnd.github.mister-fantastic-preview+json"
|
4788 | },
|
4789 | "method": "POST",
|
4790 | "params": {
|
4791 | "owner": { "required": true, "type": "string" },
|
4792 | "repo": { "required": true, "type": "string" }
|
4793 | },
|
4794 | "url": "/repos/:owner/:repo/pages/builds"
|
4795 | },
|
4796 | "testPushHook": {
|
4797 | "method": "POST",
|
4798 | "params": {
|
4799 | "hook_id": { "required": true, "type": "integer" },
|
4800 | "owner": { "required": true, "type": "string" },
|
4801 | "repo": { "required": true, "type": "string" }
|
4802 | },
|
4803 | "url": "/repos/:owner/:repo/hooks/:hook_id/tests"
|
4804 | },
|
4805 | "transfer": {
|
4806 | "headers": { "accept": "application/vnd.github.nightshade-preview+json" },
|
4807 | "method": "POST",
|
4808 | "params": {
|
4809 | "new_owner": { "type": "string" },
|
4810 | "owner": { "required": true, "type": "string" },
|
4811 | "repo": { "required": true, "type": "string" },
|
4812 | "team_ids": { "type": "integer[]" }
|
4813 | },
|
4814 | "url": "/repos/:owner/:repo/transfer"
|
4815 | },
|
4816 | "update": {
|
4817 | "headers": { "accept": "application/vnd.github.x-ray-preview+json" },
|
4818 | "method": "PATCH",
|
4819 | "params": {
|
4820 | "allow_merge_commit": { "type": "boolean" },
|
4821 | "allow_rebase_merge": { "type": "boolean" },
|
4822 | "allow_squash_merge": { "type": "boolean" },
|
4823 | "anonymous_access_enabled": { "type": "boolean" },
|
4824 | "archived": { "type": "boolean" },
|
4825 | "default_branch": { "type": "string" },
|
4826 | "description": { "type": "string" },
|
4827 | "has_issues": { "type": "boolean" },
|
4828 | "has_projects": { "type": "boolean" },
|
4829 | "has_wiki": { "type": "boolean" },
|
4830 | "homepage": { "type": "string" },
|
4831 | "is_template": { "type": "boolean" },
|
4832 | "name": { "type": "string" },
|
4833 | "owner": { "required": true, "type": "string" },
|
4834 | "private": { "type": "boolean" },
|
4835 | "repo": { "required": true, "type": "string" }
|
4836 | },
|
4837 | "url": "/repos/:owner/:repo"
|
4838 | },
|
4839 | "updateBranchProtection": {
|
4840 | "method": "PUT",
|
4841 | "params": {
|
4842 | "branch": { "required": true, "type": "string" },
|
4843 | "enforce_admins": {
|
4844 | "allowNull": true,
|
4845 | "required": true,
|
4846 | "type": "boolean"
|
4847 | },
|
4848 | "owner": { "required": true, "type": "string" },
|
4849 | "repo": { "required": true, "type": "string" },
|
4850 | "required_pull_request_reviews": {
|
4851 | "allowNull": true,
|
4852 | "required": true,
|
4853 | "type": "object"
|
4854 | },
|
4855 | "required_pull_request_reviews.dismiss_stale_reviews": {
|
4856 | "type": "boolean"
|
4857 | },
|
4858 | "required_pull_request_reviews.dismissal_restrictions": {
|
4859 | "type": "object"
|
4860 | },
|
4861 | "required_pull_request_reviews.dismissal_restrictions.teams": {
|
4862 | "type": "string[]"
|
4863 | },
|
4864 | "required_pull_request_reviews.dismissal_restrictions.users": {
|
4865 | "type": "string[]"
|
4866 | },
|
4867 | "required_pull_request_reviews.require_code_owner_reviews": {
|
4868 | "type": "boolean"
|
4869 | },
|
4870 | "required_pull_request_reviews.required_approving_review_count": {
|
4871 | "type": "integer"
|
4872 | },
|
4873 | "required_status_checks": {
|
4874 | "allowNull": true,
|
4875 | "required": true,
|
4876 | "type": "object"
|
4877 | },
|
4878 | "required_status_checks.contexts": {
|
4879 | "required": true,
|
4880 | "type": "string[]"
|
4881 | },
|
4882 | "required_status_checks.strict": {
|
4883 | "required": true,
|
4884 | "type": "boolean"
|
4885 | },
|
4886 | "restrictions": {
|
4887 | "allowNull": true,
|
4888 | "required": true,
|
4889 | "type": "object"
|
4890 | },
|
4891 | "restrictions.teams": { "required": true, "type": "string[]" },
|
4892 | "restrictions.users": { "required": true, "type": "string[]" }
|
4893 | },
|
4894 | "url": "/repos/:owner/:repo/branches/:branch/protection"
|
4895 | },
|
4896 | "updateCommitComment": {
|
4897 | "method": "PATCH",
|
4898 | "params": {
|
4899 | "body": { "required": true, "type": "string" },
|
4900 | "comment_id": { "required": true, "type": "integer" },
|
4901 | "owner": { "required": true, "type": "string" },
|
4902 | "repo": { "required": true, "type": "string" }
|
4903 | },
|
4904 | "url": "/repos/:owner/:repo/comments/:comment_id"
|
4905 | },
|
4906 | "updateFile": {
|
4907 | "deprecated": "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
|
4908 | "method": "PUT",
|
4909 | "params": {
|
4910 | "author": { "type": "object" },
|
4911 | "author.email": { "required": true, "type": "string" },
|
4912 | "author.name": { "required": true, "type": "string" },
|
4913 | "branch": { "type": "string" },
|
4914 | "committer": { "type": "object" },
|
4915 | "committer.email": { "required": true, "type": "string" },
|
4916 | "committer.name": { "required": true, "type": "string" },
|
4917 | "content": { "required": true, "type": "string" },
|
4918 | "message": { "required": true, "type": "string" },
|
4919 | "owner": { "required": true, "type": "string" },
|
4920 | "path": { "required": true, "type": "string" },
|
4921 | "repo": { "required": true, "type": "string" },
|
4922 | "sha": { "type": "string" }
|
4923 | },
|
4924 | "url": "/repos/:owner/:repo/contents/:path"
|
4925 | },
|
4926 | "updateHook": {
|
4927 | "method": "PATCH",
|
4928 | "params": {
|
4929 | "active": { "type": "boolean" },
|
4930 | "add_events": { "type": "string[]" },
|
4931 | "config": { "type": "object" },
|
4932 | "config.content_type": { "type": "string" },
|
4933 | "config.insecure_ssl": { "type": "string" },
|
4934 | "config.secret": { "type": "string" },
|
4935 | "config.url": { "required": true, "type": "string" },
|
4936 | "events": { "type": "string[]" },
|
4937 | "hook_id": { "required": true, "type": "integer" },
|
4938 | "owner": { "required": true, "type": "string" },
|
4939 | "remove_events": { "type": "string[]" },
|
4940 | "repo": { "required": true, "type": "string" }
|
4941 | },
|
4942 | "url": "/repos/:owner/:repo/hooks/:hook_id"
|
4943 | },
|
4944 | "updateInformationAboutPagesSite": {
|
4945 | "method": "PUT",
|
4946 | "params": {
|
4947 | "owner": { "required": true, "type": "string" },
|
4948 | "repo": { "required": true, "type": "string" },
|
4949 | "source": {
|
4950 | "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""],
|
4951 | "type": "string"
|
4952 | }
|
4953 | },
|
4954 | "url": "/repos/:owner/:repo/pages"
|
4955 | },
|
4956 | "updateInvitation": {
|
4957 | "method": "PATCH",
|
4958 | "params": {
|
4959 | "invitation_id": { "required": true, "type": "integer" },
|
4960 | "owner": { "required": true, "type": "string" },
|
4961 | "permissions": { "enum": ["read", "write", "admin"], "type": "string" },
|
4962 | "repo": { "required": true, "type": "string" }
|
4963 | },
|
4964 | "url": "/repos/:owner/:repo/invitations/:invitation_id"
|
4965 | },
|
4966 | "updateProtectedBranchPullRequestReviewEnforcement": {
|
4967 | "method": "PATCH",
|
4968 | "params": {
|
4969 | "branch": { "required": true, "type": "string" },
|
4970 | "dismiss_stale_reviews": { "type": "boolean" },
|
4971 | "dismissal_restrictions": { "type": "object" },
|
4972 | "dismissal_restrictions.teams": { "type": "string[]" },
|
4973 | "dismissal_restrictions.users": { "type": "string[]" },
|
4974 | "owner": { "required": true, "type": "string" },
|
4975 | "repo": { "required": true, "type": "string" },
|
4976 | "require_code_owner_reviews": { "type": "boolean" },
|
4977 | "required_approving_review_count": { "type": "integer" }
|
4978 | },
|
4979 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
|
4980 | },
|
4981 | "updateProtectedBranchRequiredStatusChecks": {
|
4982 | "method": "PATCH",
|
4983 | "params": {
|
4984 | "branch": { "required": true, "type": "string" },
|
4985 | "contexts": { "type": "string[]" },
|
4986 | "owner": { "required": true, "type": "string" },
|
4987 | "repo": { "required": true, "type": "string" },
|
4988 | "strict": { "type": "boolean" }
|
4989 | },
|
4990 | "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
|
4991 | },
|
4992 | "updateRelease": {
|
4993 | "method": "PATCH",
|
4994 | "params": {
|
4995 | "body": { "type": "string" },
|
4996 | "draft": { "type": "boolean" },
|
4997 | "name": { "type": "string" },
|
4998 | "owner": { "required": true, "type": "string" },
|
4999 | "prerelease": { "type": "boolean" },
|
5000 | "release_id": { "required": true, "type": "integer" },
|
5001 | "repo": { "required": true, "type": "string" },
|
5002 | "tag_name": { "type": "string" },
|
5003 | "target_commitish": { "type": "string" }
|
5004 | },
|
5005 | "url": "/repos/:owner/:repo/releases/:release_id"
|
5006 | },
|
5007 | "updateReleaseAsset": {
|
5008 | "method": "PATCH",
|
5009 | "params": {
|
5010 | "asset_id": { "required": true, "type": "integer" },
|
5011 | "label": { "type": "string" },
|
5012 | "name": { "type": "string" },
|
5013 | "owner": { "required": true, "type": "string" },
|
5014 | "repo": { "required": true, "type": "string" }
|
5015 | },
|
5016 | "url": "/repos/:owner/:repo/releases/assets/:asset_id"
|
5017 | },
|
5018 | "uploadReleaseAsset": {
|
5019 | "method": "POST",
|
5020 | "params": {
|
5021 | "file": {
|
5022 | "mapTo": "data",
|
5023 | "required": true,
|
5024 | "type": "string | object"
|
5025 | },
|
5026 | "headers": { "required": true, "type": "object" },
|
5027 | "headers.content-length": { "required": true, "type": "integer" },
|
5028 | "headers.content-type": { "required": true, "type": "string" },
|
5029 | "label": { "type": "string" },
|
5030 | "name": { "required": true, "type": "string" },
|
5031 | "url": { "required": true, "type": "string" }
|
5032 | },
|
5033 | "url": ":url"
|
5034 | }
|
5035 | },
|
5036 | "search": {
|
5037 | "code": {
|
5038 | "method": "GET",
|
5039 | "params": {
|
5040 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5041 | "page": { "type": "integer" },
|
5042 | "per_page": { "type": "integer" },
|
5043 | "q": { "required": true, "type": "string" },
|
5044 | "sort": { "enum": ["indexed"], "type": "string" }
|
5045 | },
|
5046 | "url": "/search/code"
|
5047 | },
|
5048 | "commits": {
|
5049 | "headers": { "accept": "application/vnd.github.cloak-preview+json" },
|
5050 | "method": "GET",
|
5051 | "params": {
|
5052 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5053 | "page": { "type": "integer" },
|
5054 | "per_page": { "type": "integer" },
|
5055 | "q": { "required": true, "type": "string" },
|
5056 | "sort": { "enum": ["author-date", "committer-date"], "type": "string" }
|
5057 | },
|
5058 | "url": "/search/commits"
|
5059 | },
|
5060 | "issues": {
|
5061 | "deprecated": "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)",
|
5062 | "method": "GET",
|
5063 | "params": {
|
5064 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5065 | "page": { "type": "integer" },
|
5066 | "per_page": { "type": "integer" },
|
5067 | "q": { "required": true, "type": "string" },
|
5068 | "sort": {
|
5069 | "enum": [
|
5070 | "comments",
|
5071 | "reactions",
|
5072 | "reactions-+1",
|
5073 | "reactions--1",
|
5074 | "reactions-smile",
|
5075 | "reactions-thinking_face",
|
5076 | "reactions-heart",
|
5077 | "reactions-tada",
|
5078 | "interactions",
|
5079 | "created",
|
5080 | "updated"
|
5081 | ],
|
5082 | "type": "string"
|
5083 | }
|
5084 | },
|
5085 | "url": "/search/issues"
|
5086 | },
|
5087 | "issuesAndPullRequests": {
|
5088 | "method": "GET",
|
5089 | "params": {
|
5090 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5091 | "page": { "type": "integer" },
|
5092 | "per_page": { "type": "integer" },
|
5093 | "q": { "required": true, "type": "string" },
|
5094 | "sort": {
|
5095 | "enum": [
|
5096 | "comments",
|
5097 | "reactions",
|
5098 | "reactions-+1",
|
5099 | "reactions--1",
|
5100 | "reactions-smile",
|
5101 | "reactions-thinking_face",
|
5102 | "reactions-heart",
|
5103 | "reactions-tada",
|
5104 | "interactions",
|
5105 | "created",
|
5106 | "updated"
|
5107 | ],
|
5108 | "type": "string"
|
5109 | }
|
5110 | },
|
5111 | "url": "/search/issues"
|
5112 | },
|
5113 | "labels": {
|
5114 | "method": "GET",
|
5115 | "params": {
|
5116 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5117 | "q": { "required": true, "type": "string" },
|
5118 | "repository_id": { "required": true, "type": "integer" },
|
5119 | "sort": { "enum": ["created", "updated"], "type": "string" }
|
5120 | },
|
5121 | "url": "/search/labels"
|
5122 | },
|
5123 | "repos": {
|
5124 | "method": "GET",
|
5125 | "params": {
|
5126 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5127 | "page": { "type": "integer" },
|
5128 | "per_page": { "type": "integer" },
|
5129 | "q": { "required": true, "type": "string" },
|
5130 | "sort": {
|
5131 | "enum": ["stars", "forks", "help-wanted-issues", "updated"],
|
5132 | "type": "string"
|
5133 | }
|
5134 | },
|
5135 | "url": "/search/repositories"
|
5136 | },
|
5137 | "topics": {
|
5138 | "method": "GET",
|
5139 | "params": { "q": { "required": true, "type": "string" } },
|
5140 | "url": "/search/topics"
|
5141 | },
|
5142 | "users": {
|
5143 | "method": "GET",
|
5144 | "params": {
|
5145 | "order": { "enum": ["desc", "asc"], "type": "string" },
|
5146 | "page": { "type": "integer" },
|
5147 | "per_page": { "type": "integer" },
|
5148 | "q": { "required": true, "type": "string" },
|
5149 | "sort": {
|
5150 | "enum": ["followers", "repositories", "joined"],
|
5151 | "type": "string"
|
5152 | }
|
5153 | },
|
5154 | "url": "/search/users"
|
5155 | }
|
5156 | },
|
5157 | "teams": {
|
5158 | "addMember": {
|
5159 | "deprecated": "octokit.teams.addMember() is deprecated, see https://developer.github.com/enterprise/2.18/v3/teams/members/#add-team-member",
|
5160 | "method": "PUT",
|
5161 | "params": {
|
5162 | "team_id": { "required": true, "type": "integer" },
|
5163 | "username": { "required": true, "type": "string" }
|
5164 | },
|
5165 | "url": "/teams/:team_id/members/:username"
|
5166 | },
|
5167 | "addOrUpdateMembership": {
|
5168 | "method": "PUT",
|
5169 | "params": {
|
5170 | "role": { "enum": ["member", "maintainer"], "type": "string" },
|
5171 | "team_id": { "required": true, "type": "integer" },
|
5172 | "username": { "required": true, "type": "string" }
|
5173 | },
|
5174 | "url": "/teams/:team_id/memberships/:username"
|
5175 | },
|
5176 | "addOrUpdateProject": {
|
5177 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
5178 | "method": "PUT",
|
5179 | "params": {
|
5180 | "permission": { "enum": ["read", "write", "admin"], "type": "string" },
|
5181 | "project_id": { "required": true, "type": "integer" },
|
5182 | "team_id": { "required": true, "type": "integer" }
|
5183 | },
|
5184 | "url": "/teams/:team_id/projects/:project_id"
|
5185 | },
|
5186 | "addOrUpdateRepo": {
|
5187 | "method": "PUT",
|
5188 | "params": {
|
5189 | "owner": { "required": true, "type": "string" },
|
5190 | "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
|
5191 | "repo": { "required": true, "type": "string" },
|
5192 | "team_id": { "required": true, "type": "integer" }
|
5193 | },
|
5194 | "url": "/teams/:team_id/repos/:owner/:repo"
|
5195 | },
|
5196 | "checkManagesRepo": {
|
5197 | "method": "GET",
|
5198 | "params": {
|
5199 | "owner": { "required": true, "type": "string" },
|
5200 | "repo": { "required": true, "type": "string" },
|
5201 | "team_id": { "required": true, "type": "integer" }
|
5202 | },
|
5203 | "url": "/teams/:team_id/repos/:owner/:repo"
|
5204 | },
|
5205 | "create": {
|
5206 | "method": "POST",
|
5207 | "params": {
|
5208 | "description": { "type": "string" },
|
5209 | "ldap_dn": { "type": "string" },
|
5210 | "maintainers": { "type": "string[]" },
|
5211 | "name": { "required": true, "type": "string" },
|
5212 | "org": { "required": true, "type": "string" },
|
5213 | "parent_team_id": { "type": "integer" },
|
5214 | "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
|
5215 | "privacy": { "enum": ["secret", "closed"], "type": "string" },
|
5216 | "repo_names": { "type": "string[]" }
|
5217 | },
|
5218 | "url": "/orgs/:org/teams"
|
5219 | },
|
5220 | "createDiscussion": {
|
5221 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5222 | "method": "POST",
|
5223 | "params": {
|
5224 | "body": { "required": true, "type": "string" },
|
5225 | "private": { "type": "boolean" },
|
5226 | "team_id": { "required": true, "type": "integer" },
|
5227 | "title": { "required": true, "type": "string" }
|
5228 | },
|
5229 | "url": "/teams/:team_id/discussions"
|
5230 | },
|
5231 | "createDiscussionComment": {
|
5232 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5233 | "method": "POST",
|
5234 | "params": {
|
5235 | "body": { "required": true, "type": "string" },
|
5236 | "discussion_number": { "required": true, "type": "integer" },
|
5237 | "team_id": { "required": true, "type": "integer" }
|
5238 | },
|
5239 | "url": "/teams/:team_id/discussions/:discussion_number/comments"
|
5240 | },
|
5241 | "delete": {
|
5242 | "method": "DELETE",
|
5243 | "params": { "team_id": { "required": true, "type": "integer" } },
|
5244 | "url": "/teams/:team_id"
|
5245 | },
|
5246 | "deleteDiscussion": {
|
5247 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5248 | "method": "DELETE",
|
5249 | "params": {
|
5250 | "discussion_number": { "required": true, "type": "integer" },
|
5251 | "team_id": { "required": true, "type": "integer" }
|
5252 | },
|
5253 | "url": "/teams/:team_id/discussions/:discussion_number"
|
5254 | },
|
5255 | "deleteDiscussionComment": {
|
5256 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5257 | "method": "DELETE",
|
5258 | "params": {
|
5259 | "comment_number": { "required": true, "type": "integer" },
|
5260 | "discussion_number": { "required": true, "type": "integer" },
|
5261 | "team_id": { "required": true, "type": "integer" }
|
5262 | },
|
5263 | "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
|
5264 | },
|
5265 | "get": {
|
5266 | "method": "GET",
|
5267 | "params": { "team_id": { "required": true, "type": "integer" } },
|
5268 | "url": "/teams/:team_id"
|
5269 | },
|
5270 | "getByName": {
|
5271 | "method": "GET",
|
5272 | "params": {
|
5273 | "org": { "required": true, "type": "string" },
|
5274 | "team_slug": { "required": true, "type": "string" }
|
5275 | },
|
5276 | "url": "/orgs/:org/teams/:team_slug"
|
5277 | },
|
5278 | "getDiscussion": {
|
5279 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5280 | "method": "GET",
|
5281 | "params": {
|
5282 | "discussion_number": { "required": true, "type": "integer" },
|
5283 | "team_id": { "required": true, "type": "integer" }
|
5284 | },
|
5285 | "url": "/teams/:team_id/discussions/:discussion_number"
|
5286 | },
|
5287 | "getDiscussionComment": {
|
5288 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5289 | "method": "GET",
|
5290 | "params": {
|
5291 | "comment_number": { "required": true, "type": "integer" },
|
5292 | "discussion_number": { "required": true, "type": "integer" },
|
5293 | "team_id": { "required": true, "type": "integer" }
|
5294 | },
|
5295 | "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
|
5296 | },
|
5297 | "getMember": {
|
5298 | "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/enterprise/2.18/v3/teams/members/#get-team-member",
|
5299 | "method": "GET",
|
5300 | "params": {
|
5301 | "team_id": { "required": true, "type": "integer" },
|
5302 | "username": { "required": true, "type": "string" }
|
5303 | },
|
5304 | "url": "/teams/:team_id/members/:username"
|
5305 | },
|
5306 | "getMembership": {
|
5307 | "method": "GET",
|
5308 | "params": {
|
5309 | "team_id": { "required": true, "type": "integer" },
|
5310 | "username": { "required": true, "type": "string" }
|
5311 | },
|
5312 | "url": "/teams/:team_id/memberships/:username"
|
5313 | },
|
5314 | "list": {
|
5315 | "method": "GET",
|
5316 | "params": {
|
5317 | "org": { "required": true, "type": "string" },
|
5318 | "page": { "type": "integer" },
|
5319 | "per_page": { "type": "integer" }
|
5320 | },
|
5321 | "url": "/orgs/:org/teams"
|
5322 | },
|
5323 | "listChild": {
|
5324 | "headers": { "accept": "application/vnd.github.hellcat-preview+json" },
|
5325 | "method": "GET",
|
5326 | "params": {
|
5327 | "page": { "type": "integer" },
|
5328 | "per_page": { "type": "integer" },
|
5329 | "team_id": { "required": true, "type": "integer" }
|
5330 | },
|
5331 | "url": "/teams/:team_id/teams"
|
5332 | },
|
5333 | "listDiscussionComments": {
|
5334 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5335 | "method": "GET",
|
5336 | "params": {
|
5337 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
5338 | "discussion_number": { "required": true, "type": "integer" },
|
5339 | "page": { "type": "integer" },
|
5340 | "per_page": { "type": "integer" },
|
5341 | "team_id": { "required": true, "type": "integer" }
|
5342 | },
|
5343 | "url": "/teams/:team_id/discussions/:discussion_number/comments"
|
5344 | },
|
5345 | "listDiscussions": {
|
5346 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5347 | "method": "GET",
|
5348 | "params": {
|
5349 | "direction": { "enum": ["asc", "desc"], "type": "string" },
|
5350 | "page": { "type": "integer" },
|
5351 | "per_page": { "type": "integer" },
|
5352 | "team_id": { "required": true, "type": "integer" }
|
5353 | },
|
5354 | "url": "/teams/:team_id/discussions"
|
5355 | },
|
5356 | "listForAuthenticatedUser": {
|
5357 | "method": "GET",
|
5358 | "params": {
|
5359 | "page": { "type": "integer" },
|
5360 | "per_page": { "type": "integer" }
|
5361 | },
|
5362 | "url": "/user/teams"
|
5363 | },
|
5364 | "listMembers": {
|
5365 | "method": "GET",
|
5366 | "params": {
|
5367 | "page": { "type": "integer" },
|
5368 | "per_page": { "type": "integer" },
|
5369 | "role": { "enum": ["member", "maintainer", "all"], "type": "string" },
|
5370 | "team_id": { "required": true, "type": "integer" }
|
5371 | },
|
5372 | "url": "/teams/:team_id/members"
|
5373 | },
|
5374 | "listProjects": {
|
5375 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
5376 | "method": "GET",
|
5377 | "params": {
|
5378 | "page": { "type": "integer" },
|
5379 | "per_page": { "type": "integer" },
|
5380 | "team_id": { "required": true, "type": "integer" }
|
5381 | },
|
5382 | "url": "/teams/:team_id/projects"
|
5383 | },
|
5384 | "listRepos": {
|
5385 | "method": "GET",
|
5386 | "params": {
|
5387 | "page": { "type": "integer" },
|
5388 | "per_page": { "type": "integer" },
|
5389 | "team_id": { "required": true, "type": "integer" }
|
5390 | },
|
5391 | "url": "/teams/:team_id/repos"
|
5392 | },
|
5393 | "removeMember": {
|
5394 | "deprecated": "octokit.teams.removeMember() is deprecated, see https://developer.github.com/enterprise/2.18/v3/teams/members/#remove-team-member",
|
5395 | "method": "DELETE",
|
5396 | "params": {
|
5397 | "team_id": { "required": true, "type": "integer" },
|
5398 | "username": { "required": true, "type": "string" }
|
5399 | },
|
5400 | "url": "/teams/:team_id/members/:username"
|
5401 | },
|
5402 | "removeMembership": {
|
5403 | "method": "DELETE",
|
5404 | "params": {
|
5405 | "team_id": { "required": true, "type": "integer" },
|
5406 | "username": { "required": true, "type": "string" }
|
5407 | },
|
5408 | "url": "/teams/:team_id/memberships/:username"
|
5409 | },
|
5410 | "removeProject": {
|
5411 | "method": "DELETE",
|
5412 | "params": {
|
5413 | "project_id": { "required": true, "type": "integer" },
|
5414 | "team_id": { "required": true, "type": "integer" }
|
5415 | },
|
5416 | "url": "/teams/:team_id/projects/:project_id"
|
5417 | },
|
5418 | "removeRepo": {
|
5419 | "method": "DELETE",
|
5420 | "params": {
|
5421 | "owner": { "required": true, "type": "string" },
|
5422 | "repo": { "required": true, "type": "string" },
|
5423 | "team_id": { "required": true, "type": "integer" }
|
5424 | },
|
5425 | "url": "/teams/:team_id/repos/:owner/:repo"
|
5426 | },
|
5427 | "reviewProject": {
|
5428 | "headers": { "accept": "application/vnd.github.inertia-preview+json" },
|
5429 | "method": "GET",
|
5430 | "params": {
|
5431 | "project_id": { "required": true, "type": "integer" },
|
5432 | "team_id": { "required": true, "type": "integer" }
|
5433 | },
|
5434 | "url": "/teams/:team_id/projects/:project_id"
|
5435 | },
|
5436 | "update": {
|
5437 | "method": "PATCH",
|
5438 | "params": {
|
5439 | "description": { "type": "string" },
|
5440 | "name": { "required": true, "type": "string" },
|
5441 | "parent_team_id": { "type": "integer" },
|
5442 | "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
|
5443 | "privacy": { "enum": ["secret", "closed"], "type": "string" },
|
5444 | "team_id": { "required": true, "type": "integer" }
|
5445 | },
|
5446 | "url": "/teams/:team_id"
|
5447 | },
|
5448 | "updateDiscussion": {
|
5449 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5450 | "method": "PATCH",
|
5451 | "params": {
|
5452 | "body": { "type": "string" },
|
5453 | "discussion_number": { "required": true, "type": "integer" },
|
5454 | "team_id": { "required": true, "type": "integer" },
|
5455 | "title": { "type": "string" }
|
5456 | },
|
5457 | "url": "/teams/:team_id/discussions/:discussion_number"
|
5458 | },
|
5459 | "updateDiscussionComment": {
|
5460 | "headers": { "accept": "application/vnd.github.echo-preview+json" },
|
5461 | "method": "PATCH",
|
5462 | "params": {
|
5463 | "body": { "required": true, "type": "string" },
|
5464 | "comment_number": { "required": true, "type": "integer" },
|
5465 | "discussion_number": { "required": true, "type": "integer" },
|
5466 | "team_id": { "required": true, "type": "integer" }
|
5467 | },
|
5468 | "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
|
5469 | }
|
5470 | },
|
5471 | "users": {
|
5472 | "addEmails": {
|
5473 | "method": "POST",
|
5474 | "params": { "emails": { "required": true, "type": "string[]" } },
|
5475 | "url": "/user/emails"
|
5476 | },
|
5477 | "checkFollowing": {
|
5478 | "method": "GET",
|
5479 | "params": { "username": { "required": true, "type": "string" } },
|
5480 | "url": "/user/following/:username"
|
5481 | },
|
5482 | "checkFollowingForUser": {
|
5483 | "method": "GET",
|
5484 | "params": {
|
5485 | "target_user": { "required": true, "type": "string" },
|
5486 | "username": { "required": true, "type": "string" }
|
5487 | },
|
5488 | "url": "/users/:username/following/:target_user"
|
5489 | },
|
5490 | "createGpgKey": {
|
5491 | "method": "POST",
|
5492 | "params": { "armored_public_key": { "type": "string" } },
|
5493 | "url": "/user/gpg_keys"
|
5494 | },
|
5495 | "createPublicKey": {
|
5496 | "method": "POST",
|
5497 | "params": { "key": { "type": "string" }, "title": { "type": "string" } },
|
5498 | "url": "/user/keys"
|
5499 | },
|
5500 | "deleteEmails": {
|
5501 | "method": "DELETE",
|
5502 | "params": { "emails": { "required": true, "type": "string[]" } },
|
5503 | "url": "/user/emails"
|
5504 | },
|
5505 | "deleteGpgKey": {
|
5506 | "method": "DELETE",
|
5507 | "params": { "gpg_key_id": { "required": true, "type": "integer" } },
|
5508 | "url": "/user/gpg_keys/:gpg_key_id"
|
5509 | },
|
5510 | "deletePublicKey": {
|
5511 | "method": "DELETE",
|
5512 | "params": { "key_id": { "required": true, "type": "integer" } },
|
5513 | "url": "/user/keys/:key_id"
|
5514 | },
|
5515 | "follow": {
|
5516 | "method": "PUT",
|
5517 | "params": { "username": { "required": true, "type": "string" } },
|
5518 | "url": "/user/following/:username"
|
5519 | },
|
5520 | "getAuthenticated": { "method": "GET", "params": {}, "url": "/user" },
|
5521 | "getByUsername": {
|
5522 | "method": "GET",
|
5523 | "params": { "username": { "required": true, "type": "string" } },
|
5524 | "url": "/users/:username"
|
5525 | },
|
5526 | "getContextForUser": {
|
5527 | "headers": { "accept": "application/vnd.github.hagar-preview+json" },
|
5528 | "method": "GET",
|
5529 | "params": {
|
5530 | "subject_id": { "type": "string" },
|
5531 | "subject_type": {
|
5532 | "enum": ["organization", "repository", "issue", "pull_request"],
|
5533 | "type": "string"
|
5534 | },
|
5535 | "username": { "required": true, "type": "string" }
|
5536 | },
|
5537 | "url": "/users/:username/hovercard"
|
5538 | },
|
5539 | "getGpgKey": {
|
5540 | "method": "GET",
|
5541 | "params": { "gpg_key_id": { "required": true, "type": "integer" } },
|
5542 | "url": "/user/gpg_keys/:gpg_key_id"
|
5543 | },
|
5544 | "getPublicKey": {
|
5545 | "method": "GET",
|
5546 | "params": { "key_id": { "required": true, "type": "integer" } },
|
5547 | "url": "/user/keys/:key_id"
|
5548 | },
|
5549 | "list": {
|
5550 | "method": "GET",
|
5551 | "params": {
|
5552 | "page": { "type": "integer" },
|
5553 | "per_page": { "type": "integer" },
|
5554 | "since": { "type": "string" }
|
5555 | },
|
5556 | "url": "/users"
|
5557 | },
|
5558 | "listEmails": {
|
5559 | "method": "GET",
|
5560 | "params": {
|
5561 | "page": { "type": "integer" },
|
5562 | "per_page": { "type": "integer" }
|
5563 | },
|
5564 | "url": "/user/emails"
|
5565 | },
|
5566 | "listFollowersForAuthenticatedUser": {
|
5567 | "method": "GET",
|
5568 | "params": {
|
5569 | "page": { "type": "integer" },
|
5570 | "per_page": { "type": "integer" }
|
5571 | },
|
5572 | "url": "/user/followers"
|
5573 | },
|
5574 | "listFollowersForUser": {
|
5575 | "method": "GET",
|
5576 | "params": {
|
5577 | "page": { "type": "integer" },
|
5578 | "per_page": { "type": "integer" },
|
5579 | "username": { "required": true, "type": "string" }
|
5580 | },
|
5581 | "url": "/users/:username/followers"
|
5582 | },
|
5583 | "listFollowingForAuthenticatedUser": {
|
5584 | "method": "GET",
|
5585 | "params": {
|
5586 | "page": { "type": "integer" },
|
5587 | "per_page": { "type": "integer" }
|
5588 | },
|
5589 | "url": "/user/following"
|
5590 | },
|
5591 | "listFollowingForUser": {
|
5592 | "method": "GET",
|
5593 | "params": {
|
5594 | "page": { "type": "integer" },
|
5595 | "per_page": { "type": "integer" },
|
5596 | "username": { "required": true, "type": "string" }
|
5597 | },
|
5598 | "url": "/users/:username/following"
|
5599 | },
|
5600 | "listGpgKeys": {
|
5601 | "method": "GET",
|
5602 | "params": {
|
5603 | "page": { "type": "integer" },
|
5604 | "per_page": { "type": "integer" }
|
5605 | },
|
5606 | "url": "/user/gpg_keys"
|
5607 | },
|
5608 | "listGpgKeysForUser": {
|
5609 | "method": "GET",
|
5610 | "params": {
|
5611 | "page": { "type": "integer" },
|
5612 | "per_page": { "type": "integer" },
|
5613 | "username": { "required": true, "type": "string" }
|
5614 | },
|
5615 | "url": "/users/:username/gpg_keys"
|
5616 | },
|
5617 | "listPublicEmails": {
|
5618 | "method": "GET",
|
5619 | "params": {
|
5620 | "page": { "type": "integer" },
|
5621 | "per_page": { "type": "integer" }
|
5622 | },
|
5623 | "url": "/user/public_emails"
|
5624 | },
|
5625 | "listPublicKeys": {
|
5626 | "method": "GET",
|
5627 | "params": {
|
5628 | "page": { "type": "integer" },
|
5629 | "per_page": { "type": "integer" }
|
5630 | },
|
5631 | "url": "/user/keys"
|
5632 | },
|
5633 | "listPublicKeysForUser": {
|
5634 | "method": "GET",
|
5635 | "params": {
|
5636 | "page": { "type": "integer" },
|
5637 | "per_page": { "type": "integer" },
|
5638 | "username": { "required": true, "type": "string" }
|
5639 | },
|
5640 | "url": "/users/:username/keys"
|
5641 | },
|
5642 | "unfollow": {
|
5643 | "method": "DELETE",
|
5644 | "params": { "username": { "required": true, "type": "string" } },
|
5645 | "url": "/user/following/:username"
|
5646 | },
|
5647 | "updateAuthenticated": {
|
5648 | "method": "PATCH",
|
5649 | "params": {
|
5650 | "bio": { "type": "string" },
|
5651 | "blog": { "type": "string" },
|
5652 | "company": { "type": "string" },
|
5653 | "email": { "type": "string" },
|
5654 | "hireable": { "type": "boolean" },
|
5655 | "location": { "type": "string" },
|
5656 | "name": { "type": "string" }
|
5657 | },
|
5658 | "url": "/user"
|
5659 | }
|
5660 | }
|
5661 | }
|