| 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 | "deletePreReceiveEnvironment": {
|
| 89 | "method": "DELETE",
|
| 90 | "params": {
|
| 91 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
| 92 | },
|
| 93 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
|
| 94 | },
|
| 95 | "deletePreReceiveHook": {
|
| 96 | "method": "DELETE",
|
| 97 | "params": {
|
| 98 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
| 99 | },
|
| 100 | "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
|
| 101 | },
|
| 102 | "deletePublicKey": {
|
| 103 | "method": "DELETE",
|
| 104 | "params": { "key_ids": { "required": true, "type": "string" } },
|
| 105 | "url": "/admin/keys/:key_ids"
|
| 106 | },
|
| 107 | "deleteUser": {
|
| 108 | "method": "DELETE",
|
| 109 | "params": { "username": { "required": true, "type": "string" } },
|
| 110 | "url": "/admin/users/:username"
|
| 111 | },
|
| 112 | "demoteSiteAdministratorToOrdinaryUser": {
|
| 113 | "method": "DELETE",
|
| 114 | "params": { "username": { "required": true, "type": "string" } },
|
| 115 | "url": "/users/:username/site_admin"
|
| 116 | },
|
| 117 | "enableOrDisableMaintenanceMode": {
|
| 118 | "method": "POST",
|
| 119 | "params": { "maintenance": { "required": true, "type": "string" } },
|
| 120 | "url": "/setup/api/maintenance"
|
| 121 | },
|
| 122 | "getGlobalHook": {
|
| 123 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
| 124 | "method": "GET",
|
| 125 | "params": { "hook_id": { "required": true, "type": "integer" } },
|
| 126 | "url": "/admin/hooks/:hook_id"
|
| 127 | },
|
| 128 | "getLicenseInformation": {
|
| 129 | "method": "GET",
|
| 130 | "params": {},
|
| 131 | "url": "/enterprise/settings/license"
|
| 132 | },
|
| 133 | "getPreReceiveEnvironment": {
|
| 134 | "method": "GET",
|
| 135 | "params": {
|
| 136 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
| 137 | },
|
| 138 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
|
| 139 | },
|
| 140 | "getPreReceiveEnvironmentDownloadStatus": {
|
| 141 | "method": "GET",
|
| 142 | "params": {
|
| 143 | "downloaded_at": { "type": "string" },
|
| 144 | "message": { "type": "string" },
|
| 145 | "pre_receive_environment_id": { "required": true, "type": "integer" },
|
| 146 | "state": { "type": "string" }
|
| 147 | },
|
| 148 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest"
|
| 149 | },
|
| 150 | "getPreReceiveHook": {
|
| 151 | "method": "GET",
|
| 152 | "params": {
|
| 153 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
| 154 | },
|
| 155 | "url": "/admin/pre-receive-hooks/:pre_receive_hook_id"
|
| 156 | },
|
| 157 | "getPreReceiveHookForOrg": {
|
| 158 | "method": "GET",
|
| 159 | "params": {
|
| 160 | "org": { "required": true, "type": "string" },
|
| 161 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
| 162 | },
|
| 163 | "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
|
| 164 | },
|
| 165 | "getPreReceiveHookForRepo": {
|
| 166 | "method": "GET",
|
| 167 | "params": {
|
| 168 | "owner": { "required": true, "type": "string" },
|
| 169 | "pre_receive_hook_id": { "required": true, "type": "integer" },
|
| 170 | "repo": { "required": true, "type": "string" }
|
| 171 | },
|
| 172 | "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
|
| 173 | },
|
| 174 | "getTypeStats": {
|
| 175 | "method": "GET",
|
| 176 | "params": { "type": { "required": true, "type": "string" } },
|
| 177 | "url": "/enterprise/stats/:type"
|
| 178 | },
|
| 179 | "listGlobalHooks": {
|
| 180 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
| 181 | "method": "GET",
|
| 182 | "params": {
|
| 183 | "page": { "type": "integer" },
|
| 184 | "per_page": { "type": "integer" }
|
| 185 | },
|
| 186 | "url": "/admin/hooks"
|
| 187 | },
|
| 188 | "listPreReceiveEnvironments": {
|
| 189 | "method": "GET",
|
| 190 | "params": {
|
| 191 | "page": { "type": "integer" },
|
| 192 | "per_page": { "type": "integer" }
|
| 193 | },
|
| 194 | "url": "/admin/pre-receive-environments"
|
| 195 | },
|
| 196 | "listPreReceiveHooks": {
|
| 197 | "method": "GET",
|
| 198 | "params": {
|
| 199 | "page": { "type": "integer" },
|
| 200 | "per_page": { "type": "integer" }
|
| 201 | },
|
| 202 | "url": "/admin/pre-receive-hooks"
|
| 203 | },
|
| 204 | "listPreReceiveHooksForOrg": {
|
| 205 | "method": "GET",
|
| 206 | "params": {
|
| 207 | "org": { "required": true, "type": "string" },
|
| 208 | "page": { "type": "integer" },
|
| 209 | "per_page": { "type": "integer" }
|
| 210 | },
|
| 211 | "url": "/orgs/:org/pre-receive-hooks"
|
| 212 | },
|
| 213 | "listPreReceiveHooksForRepo": {
|
| 214 | "method": "GET",
|
| 215 | "params": {
|
| 216 | "owner": { "required": true, "type": "string" },
|
| 217 | "page": { "type": "integer" },
|
| 218 | "per_page": { "type": "integer" },
|
| 219 | "repo": { "required": true, "type": "string" }
|
| 220 | },
|
| 221 | "url": "/repos/:owner/:repo/pre-receive-hooks"
|
| 222 | },
|
| 223 | "modifySettings": {
|
| 224 | "method": "PUT",
|
| 225 | "params": { "settings": { "required": true, "type": "string" } },
|
| 226 | "url": "/setup/api/settings"
|
| 227 | },
|
| 228 | "pingGlobalHook": {
|
| 229 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
| 230 | "method": "POST",
|
| 231 | "params": { "hook_id": { "required": true, "type": "integer" } },
|
| 232 | "url": "/admin/hooks/:hook_id/pings"
|
| 233 | },
|
| 234 | "promoteOrdinaryUserToSiteAdministrator": {
|
| 235 | "method": "PUT",
|
| 236 | "params": { "username": { "required": true, "type": "string" } },
|
| 237 | "url": "/users/:username/site_admin"
|
| 238 | },
|
| 239 | "queueIndexingJob": {
|
| 240 | "method": "POST",
|
| 241 | "params": { "target": { "required": true, "type": "string" } },
|
| 242 | "url": "/staff/indexing_jobs"
|
| 243 | },
|
| 244 | "removeAuthorizedSshKey": {
|
| 245 | "method": "DELETE",
|
| 246 | "params": { "authorized_key": { "required": true, "type": "string" } },
|
| 247 | "url": "/setup/api/settings/authorized-keys"
|
| 248 | },
|
| 249 | "removeEnforcementOverridesForPreReceiveHookForOrg": {
|
| 250 | "method": "DELETE",
|
| 251 | "params": {
|
| 252 | "org": { "required": true, "type": "string" },
|
| 253 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
| 254 | },
|
| 255 | "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
|
| 256 | },
|
| 257 | "removeEnforcementOverridesForPreReceiveHookForRepo": {
|
| 258 | "method": "DELETE",
|
| 259 | "params": {
|
| 260 | "owner": { "required": true, "type": "string" },
|
| 261 | "pre_receive_hook_id": { "required": true, "type": "integer" },
|
| 262 | "repo": { "required": true, "type": "string" }
|
| 263 | },
|
| 264 | "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
|
| 265 | },
|
| 266 | "renameOrg": {
|
| 267 | "method": "PATCH",
|
| 268 | "params": {
|
| 269 | "login": { "required": true, "type": "string" },
|
| 270 | "org": { "required": true, "type": "string" }
|
| 271 | },
|
| 272 | "url": "/admin/organizations/:org"
|
| 273 | },
|
| 274 | "renameUser": {
|
| 275 | "method": "PATCH",
|
| 276 | "params": {
|
| 277 | "login": { "required": true, "type": "string" },
|
| 278 | "username": { "required": true, "type": "string" }
|
| 279 | },
|
| 280 | "url": "/admin/users/:username"
|
| 281 | },
|
| 282 | "retrieveAuthorizedSshKeys": {
|
| 283 | "method": "GET",
|
| 284 | "params": {},
|
| 285 | "url": "/setup/api/settings/authorized-keys"
|
| 286 | },
|
| 287 | "retrieveSettings": {
|
| 288 | "method": "GET",
|
| 289 | "params": {},
|
| 290 | "url": "/setup/api/settings"
|
| 291 | },
|
| 292 | "startConfigurationProcess": {
|
| 293 | "method": "POST",
|
| 294 | "params": {},
|
| 295 | "url": "/setup/api/configure"
|
| 296 | },
|
| 297 | "suspendUser": {
|
| 298 | "method": "PUT",
|
| 299 | "params": {
|
| 300 | "reason": { "type": "string" },
|
| 301 | "username": { "required": true, "type": "string" }
|
| 302 | },
|
| 303 | "url": "/users/:username/suspended"
|
| 304 | },
|
| 305 | "syncLdapMappingForTeam": {
|
| 306 | "method": "POST",
|
| 307 | "params": { "team_id": { "required": true, "type": "integer" } },
|
| 308 | "url": "/admin/ldap/teams/:team_id/sync"
|
| 309 | },
|
| 310 | "syncLdapMappingForUser": {
|
| 311 | "method": "POST",
|
| 312 | "params": { "username": { "required": true, "type": "string" } },
|
| 313 | "url": "/admin/ldap/users/:username/sync"
|
| 314 | },
|
| 315 | "triggerPreReceiveEnvironmentDownload": {
|
| 316 | "method": "POST",
|
| 317 | "params": {
|
| 318 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
| 319 | },
|
| 320 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads"
|
| 321 | },
|
| 322 | "unsuspendUser": {
|
| 323 | "method": "DELETE",
|
| 324 | "params": {
|
| 325 | "reason": { "type": "string" },
|
| 326 | "username": { "required": true, "type": "string" }
|
| 327 | },
|
| 328 | "url": "/users/:username/suspended"
|
| 329 | },
|
| 330 | "updateGlobalHook": {
|
| 331 | "headers": { "accept": "application/vnd.github.superpro-preview+json" },
|
| 332 | "method": "PATCH",
|
| 333 | "params": {
|
| 334 | "active": { "type": "boolean" },
|
| 335 | "config": { "type": "object" },
|
| 336 | "config.content_type": { "type": "string" },
|
| 337 | "config.insecure_ssl": { "type": "string" },
|
| 338 | "config.secret": { "type": "string" },
|
| 339 | "config.url": { "required": true, "type": "string" },
|
| 340 | "events": { "type": "string[]" },
|
| 341 | "hook_id": { "required": true, "type": "integer" }
|
| 342 | },
|
| 343 | "url": "/admin/hooks/:hook_id"
|
| 344 | },
|
| 345 | "updateLdapMappingForTeam": {
|
| 346 | "method": "PATCH",
|
| 347 | "params": {
|
| 348 | "ldap_dn": { "type": "string" },
|
| 349 | "team_id": { "required": true, "type": "integer" }
|
| 350 | },
|
| 351 | "url": "/admin/ldap/teams/:team_id/mapping"
|
| 352 | },
|
| 353 | "updateLdapMappingForUser": {
|
| 354 | "method": "PATCH",
|
| 355 | "params": {
|
| 356 | "ldap_dn": { "type": "string" },
|
| 357 | "username": { "required": true, "type": "string" }
|
| 358 | },
|
| 359 | "url": "/admin/ldap/users/:username/mapping"
|
| 360 | },
|
| 361 | "updatePreReceiveEnvironment": {
|
| 362 | "method": "PATCH",
|
| 363 | "params": {
|
| 364 | "image_url": { "type": "string" },
|
| 365 | "name": { "type": "string" },
|
| 366 | "pre_receive_environment_id": { "required": true, "type": "integer" }
|
| 367 | },
|
| 368 | "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
|
| 369 | },
|
| 370 | "updatePreReceiveHook": {
|
| 371 | "method": "PATCH",
|
| 372 | "params": {
|
| 373 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
| 374 | },
|
| 375 | "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
|
| 376 | },
|
| 377 | "updatePreReceiveHookEnforcementForOrg": {
|
| 378 | "method": "PATCH",
|
| 379 | "params": {
|
| 380 | "org": { "required": true, "type": "string" },
|
| 381 | "pre_receive_hook_id": { "required": true, "type": "integer" }
|
| 382 | },
|
| 383 | "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
|
| 384 | },
|
| 385 | "updatePreReceiveHookEnforcementForRepo": {
|
| 386 | "method": "PATCH",
|
| 387 | "params": {
|
| 388 | "owner": { "required": true, "type": "string" },
|
| 389 | "pre_receive_hook_id": { "required": true, "type": "integer" },
|
| 390 | "repo": { "required": true, "type": "string" }
|
| 391 | },
|
| 392 | "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
|
| 393 | },
|
| 394 | "upgradeLicense": {
|
| 395 | "method": "POST",
|
| 396 | "params": { "license": { "type": "string" } },
|
| 397 | "url": "/setup/api/upgrade"
|
| 398 | },
|
| 399 | "uploadLicenseForFirstTime": {
|
| 400 | "method": "POST",
|
| 401 | "params": {
|
| 402 | "license": { "required": true, "type": "string" },
|
| 403 | "password": { "type": "string" },
|
| 404 | "settings": { "type": "string" }
|
| 405 | },
|
| 406 | "url": "/setup/api/start"
|
| 407 | }
|
| 408 | }
|