UNPKG

13.3 kBJSONView Raw
1{
2 "addAuthorizedSshKey": {
3 "method": "POST",
4 "params": { "authorized_key": { "required": true, "type": "string" } },
5 "url": "/setup/api/settings/authorized-keys"
6 },
7 "checkConfigurationStatus": {
8 "method": "GET",
9 "params": {},
10 "url": "/setup/api/configcheck"
11 },
12 "checkMaintenanceStatus": {
13 "method": "GET",
14 "params": {},
15 "url": "/setup/api/maintenance"
16 },
17 "createGlobalHook": {
18 "headers": { "accept": "application/vnd.github.superpro-preview+json" },
19 "method": "POST",
20 "params": {
21 "active": { "type": "boolean" },
22 "config": { "required": true, "type": "object" },
23 "config.content_type": { "type": "string" },
24 "config.insecure_ssl": { "type": "string" },
25 "config.secret": { "type": "string" },
26 "config.url": { "required": true, "type": "string" },
27 "events": { "type": "string[]" },
28 "name": { "required": true, "type": "string" }
29 },
30 "url": "/admin/hooks"
31 },
32 "createImpersonationOAuthToken": {
33 "method": "POST",
34 "params": {
35 "scopes": { "type": "string[]" },
36 "username": { "required": true, "type": "string" }
37 },
38 "url": "/admin/users/:username/authorizations"
39 },
40 "createOrg": {
41 "method": "POST",
42 "params": {
43 "admin": { "required": true, "type": "string" },
44 "login": { "required": true, "type": "string" },
45 "profile_name": { "type": "string" }
46 },
47 "url": "/admin/organizations"
48 },
49 "createPreReceiveEnvironment": {
50 "method": "POST",
51 "params": {
52 "image_url": { "required": true, "type": "string" },
53 "name": { "required": true, "type": "string" }
54 },
55 "url": "/admin/pre-receive-environments"
56 },
57 "createPreReceiveHook": {
58 "method": "POST",
59 "params": {
60 "allow_downstream_configuration": { "type": "boolean" },
61 "enforcement": { "type": "string" },
62 "environment": { "required": true, "type": "object" },
63 "name": { "required": true, "type": "string" },
64 "script": { "required": true, "type": "string" },
65 "script_repository": { "required": true, "type": "object" }
66 },
67 "url": "/admin/pre-receive-hooks"
68 },
69 "createUser": {
70 "method": "POST",
71 "params": {
72 "email": { "type": "string" },
73 "login": { "required": true, "type": "string" }
74 },
75 "url": "/admin/users"
76 },
77 "deleteGlobalHook": {
78 "headers": { "accept": "application/vnd.github.superpro-preview+json" },
79 "method": "DELETE",
80 "params": { "hook_id": { "required": true, "type": "integer" } },
81 "url": "/admin/hooks/:hook_id"
82 },
83 "deleteImpersonationOAuthToken": {
84 "method": "DELETE",
85 "params": { "username": { "required": true, "type": "string" } },
86 "url": "/admin/users/:username/authorizations"
87 },
88 "deletePersonalAccessToken": {
89 "method": "DELETE",
90 "params": { "token_id": { "required": true, "type": "integer" } },
91 "url": "/admin/tokens/:token_id"
92 },
93 "deletePreReceiveEnvironment": {
94 "method": "DELETE",
95 "params": {
96 "pre_receive_environment_id": { "required": true, "type": "integer" }
97 },
98 "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
99 },
100 "deletePreReceiveHook": {
101 "method": "DELETE",
102 "params": {
103 "pre_receive_hook_id": { "required": true, "type": "integer" }
104 },
105 "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
106 },
107 "deletePublicKey": {
108 "method": "DELETE",
109 "params": { "key_ids": { "required": true, "type": "string" } },
110 "url": "/admin/keys/:key_ids"
111 },
112 "deleteUser": {
113 "method": "DELETE",
114 "params": { "username": { "required": true, "type": "string" } },
115 "url": "/admin/users/:username"
116 },
117 "demoteSiteAdministratorToOrdinaryUser": {
118 "method": "DELETE",
119 "params": { "username": { "required": true, "type": "string" } },
120 "url": "/users/:username/site_admin"
121 },
122 "enableOrDisableMaintenanceMode": {
123 "method": "POST",
124 "params": { "maintenance": { "required": true, "type": "string" } },
125 "url": "/setup/api/maintenance"
126 },
127 "getGlobalHook": {
128 "headers": { "accept": "application/vnd.github.superpro-preview+json" },
129 "method": "GET",
130 "params": { "hook_id": { "required": true, "type": "integer" } },
131 "url": "/admin/hooks/:hook_id"
132 },
133 "getLicenseInformation": {
134 "method": "GET",
135 "params": {},
136 "url": "/enterprise/settings/license"
137 },
138 "getPreReceiveEnvironment": {
139 "method": "GET",
140 "params": {
141 "pre_receive_environment_id": { "required": true, "type": "integer" }
142 },
143 "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
144 },
145 "getPreReceiveEnvironmentDownloadStatus": {
146 "method": "GET",
147 "params": {
148 "downloaded_at": { "type": "string" },
149 "message": { "type": "string" },
150 "pre_receive_environment_id": { "required": true, "type": "integer" },
151 "state": { "type": "string" }
152 },
153 "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest"
154 },
155 "getPreReceiveHook": {
156 "method": "GET",
157 "params": {
158 "pre_receive_hook_id": { "required": true, "type": "integer" }
159 },
160 "url": "/admin/pre-receive-hooks/:pre_receive_hook_id"
161 },
162 "getPreReceiveHookForOrg": {
163 "method": "GET",
164 "params": {
165 "org": { "required": true, "type": "string" },
166 "pre_receive_hook_id": { "required": true, "type": "integer" }
167 },
168 "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
169 },
170 "getPreReceiveHookForRepo": {
171 "method": "GET",
172 "params": {
173 "owner": { "required": true, "type": "string" },
174 "pre_receive_hook_id": { "required": true, "type": "integer" },
175 "repo": { "required": true, "type": "string" }
176 },
177 "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
178 },
179 "getTypeStats": {
180 "method": "GET",
181 "params": { "type": { "required": true, "type": "string" } },
182 "url": "/enterprise/stats/:type"
183 },
184 "listGlobalHooks": {
185 "headers": { "accept": "application/vnd.github.superpro-preview+json" },
186 "method": "GET",
187 "params": {
188 "page": { "type": "integer" },
189 "per_page": { "type": "integer" }
190 },
191 "url": "/admin/hooks"
192 },
193 "listPersonalAccessTokens": {
194 "method": "GET",
195 "params": {
196 "page": { "type": "integer" },
197 "per_page": { "type": "integer" }
198 },
199 "url": "/admin/tokens"
200 },
201 "listPreReceiveEnvironments": {
202 "method": "GET",
203 "params": {
204 "page": { "type": "integer" },
205 "per_page": { "type": "integer" }
206 },
207 "url": "/admin/pre-receive-environments"
208 },
209 "listPreReceiveHooks": {
210 "method": "GET",
211 "params": {
212 "page": { "type": "integer" },
213 "per_page": { "type": "integer" }
214 },
215 "url": "/admin/pre-receive-hooks"
216 },
217 "listPreReceiveHooksForOrg": {
218 "method": "GET",
219 "params": {
220 "org": { "required": true, "type": "string" },
221 "page": { "type": "integer" },
222 "per_page": { "type": "integer" }
223 },
224 "url": "/orgs/:org/pre-receive-hooks"
225 },
226 "listPreReceiveHooksForRepo": {
227 "method": "GET",
228 "params": {
229 "owner": { "required": true, "type": "string" },
230 "page": { "type": "integer" },
231 "per_page": { "type": "integer" },
232 "repo": { "required": true, "type": "string" }
233 },
234 "url": "/repos/:owner/:repo/pre-receive-hooks"
235 },
236 "modifySettings": {
237 "method": "PUT",
238 "params": { "settings": { "required": true, "type": "string" } },
239 "url": "/setup/api/settings"
240 },
241 "pingGlobalHook": {
242 "headers": { "accept": "application/vnd.github.superpro-preview+json" },
243 "method": "POST",
244 "params": { "hook_id": { "required": true, "type": "integer" } },
245 "url": "/admin/hooks/:hook_id/pings"
246 },
247 "promoteOrdinaryUserToSiteAdministrator": {
248 "method": "PUT",
249 "params": { "username": { "required": true, "type": "string" } },
250 "url": "/users/:username/site_admin"
251 },
252 "queueIndexingJob": {
253 "method": "POST",
254 "params": { "target": { "required": true, "type": "string" } },
255 "url": "/staff/indexing_jobs"
256 },
257 "removeAuthorizedSshKey": {
258 "method": "DELETE",
259 "params": { "authorized_key": { "required": true, "type": "string" } },
260 "url": "/setup/api/settings/authorized-keys"
261 },
262 "removeEnforcementOverridesForPreReceiveHookForOrg": {
263 "method": "DELETE",
264 "params": {
265 "org": { "required": true, "type": "string" },
266 "pre_receive_hook_id": { "required": true, "type": "integer" }
267 },
268 "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
269 },
270 "removeEnforcementOverridesForPreReceiveHookForRepo": {
271 "method": "DELETE",
272 "params": {
273 "owner": { "required": true, "type": "string" },
274 "pre_receive_hook_id": { "required": true, "type": "integer" },
275 "repo": { "required": true, "type": "string" }
276 },
277 "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
278 },
279 "renameOrg": {
280 "method": "PATCH",
281 "params": {
282 "login": { "required": true, "type": "string" },
283 "org": { "required": true, "type": "string" }
284 },
285 "url": "/admin/organizations/:org"
286 },
287 "renameUser": {
288 "method": "PATCH",
289 "params": {
290 "login": { "required": true, "type": "string" },
291 "username": { "required": true, "type": "string" }
292 },
293 "url": "/admin/users/:username"
294 },
295 "retrieveAuthorizedSshKeys": {
296 "method": "GET",
297 "params": {},
298 "url": "/setup/api/settings/authorized-keys"
299 },
300 "retrieveSettings": {
301 "method": "GET",
302 "params": {},
303 "url": "/setup/api/settings"
304 },
305 "startConfigurationProcess": {
306 "method": "POST",
307 "params": {},
308 "url": "/setup/api/configure"
309 },
310 "suspendUser": {
311 "method": "PUT",
312 "params": {
313 "reason": { "type": "string" },
314 "username": { "required": true, "type": "string" }
315 },
316 "url": "/users/:username/suspended"
317 },
318 "syncLdapMappingForTeam": {
319 "method": "POST",
320 "params": { "team_id": { "required": true, "type": "integer" } },
321 "url": "/admin/ldap/teams/:team_id/sync"
322 },
323 "syncLdapMappingForUser": {
324 "method": "POST",
325 "params": { "username": { "required": true, "type": "string" } },
326 "url": "/admin/ldap/users/:username/sync"
327 },
328 "triggerPreReceiveEnvironmentDownload": {
329 "method": "POST",
330 "params": {
331 "pre_receive_environment_id": { "required": true, "type": "integer" }
332 },
333 "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads"
334 },
335 "unsuspendUser": {
336 "method": "DELETE",
337 "params": {
338 "reason": { "type": "string" },
339 "username": { "required": true, "type": "string" }
340 },
341 "url": "/users/:username/suspended"
342 },
343 "updateGlobalHook": {
344 "headers": { "accept": "application/vnd.github.superpro-preview+json" },
345 "method": "PATCH",
346 "params": {
347 "active": { "type": "boolean" },
348 "config": { "type": "object" },
349 "config.content_type": { "type": "string" },
350 "config.insecure_ssl": { "type": "string" },
351 "config.secret": { "type": "string" },
352 "config.url": { "required": true, "type": "string" },
353 "events": { "type": "string[]" },
354 "hook_id": { "required": true, "type": "integer" }
355 },
356 "url": "/admin/hooks/:hook_id"
357 },
358 "updateLdapMappingForTeam": {
359 "method": "PATCH",
360 "params": {
361 "ldap_dn": { "type": "string" },
362 "team_id": { "required": true, "type": "integer" }
363 },
364 "url": "/admin/ldap/teams/:team_id/mapping"
365 },
366 "updateLdapMappingForUser": {
367 "method": "PATCH",
368 "params": {
369 "ldap_dn": { "type": "string" },
370 "username": { "required": true, "type": "string" }
371 },
372 "url": "/admin/ldap/users/:username/mapping"
373 },
374 "updatePreReceiveEnvironment": {
375 "method": "PATCH",
376 "params": {
377 "image_url": { "type": "string" },
378 "name": { "type": "string" },
379 "pre_receive_environment_id": { "required": true, "type": "integer" }
380 },
381 "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
382 },
383 "updatePreReceiveHook": {
384 "method": "PATCH",
385 "params": {
386 "pre_receive_hook_id": { "required": true, "type": "integer" }
387 },
388 "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
389 },
390 "updatePreReceiveHookEnforcementForOrg": {
391 "method": "PATCH",
392 "params": {
393 "org": { "required": true, "type": "string" },
394 "pre_receive_hook_id": { "required": true, "type": "integer" }
395 },
396 "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
397 },
398 "updatePreReceiveHookEnforcementForRepo": {
399 "method": "PATCH",
400 "params": {
401 "owner": { "required": true, "type": "string" },
402 "pre_receive_hook_id": { "required": true, "type": "integer" },
403 "repo": { "required": true, "type": "string" }
404 },
405 "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
406 },
407 "upgradeLicense": {
408 "method": "POST",
409 "params": { "license": { "type": "string" } },
410 "url": "/setup/api/upgrade"
411 },
412 "uploadLicenseForFirstTime": {
413 "method": "POST",
414 "params": {
415 "license": { "required": true, "type": "string" },
416 "password": { "type": "string" },
417 "settings": { "type": "string" }
418 },
419 "url": "/setup/api/start"
420 }
421}