all.json 193 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720
  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/ref/: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. "listMatchingRefs": {
  1437. "method": "GET",
  1438. "params": {
  1439. "owner": { "required": true, "type": "string" },
  1440. "page": { "type": "integer" },
  1441. "per_page": { "type": "integer" },
  1442. "ref": { "required": true, "type": "string" },
  1443. "repo": { "required": true, "type": "string" }
  1444. },
  1445. "url": "/repos/:owner/:repo/git/matching-refs/:ref"
  1446. },
  1447. "listRefs": {
  1448. "method": "GET",
  1449. "params": {
  1450. "namespace": { "type": "string" },
  1451. "owner": { "required": true, "type": "string" },
  1452. "page": { "type": "integer" },
  1453. "per_page": { "type": "integer" },
  1454. "repo": { "required": true, "type": "string" }
  1455. },
  1456. "url": "/repos/:owner/:repo/git/refs/:namespace"
  1457. },
  1458. "updateRef": {
  1459. "method": "PATCH",
  1460. "params": {
  1461. "force": { "type": "boolean" },
  1462. "owner": { "required": true, "type": "string" },
  1463. "ref": { "required": true, "type": "string" },
  1464. "repo": { "required": true, "type": "string" },
  1465. "sha": { "required": true, "type": "string" }
  1466. },
  1467. "url": "/repos/:owner/:repo/git/refs/:ref"
  1468. }
  1469. },
  1470. "gitignore": {
  1471. "getTemplate": {
  1472. "method": "GET",
  1473. "params": { "name": { "required": true, "type": "string" } },
  1474. "url": "/gitignore/templates/:name"
  1475. },
  1476. "listTemplates": {
  1477. "method": "GET",
  1478. "params": {},
  1479. "url": "/gitignore/templates"
  1480. }
  1481. },
  1482. "issues": {
  1483. "addAssignees": {
  1484. "method": "POST",
  1485. "params": {
  1486. "assignees": { "type": "string[]" },
  1487. "issue_number": { "required": true, "type": "integer" },
  1488. "number": {
  1489. "alias": "issue_number",
  1490. "deprecated": true,
  1491. "type": "integer"
  1492. },
  1493. "owner": { "required": true, "type": "string" },
  1494. "repo": { "required": true, "type": "string" }
  1495. },
  1496. "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
  1497. },
  1498. "addLabels": {
  1499. "method": "POST",
  1500. "params": {
  1501. "issue_number": { "required": true, "type": "integer" },
  1502. "labels": { "required": true, "type": "string[]" },
  1503. "number": {
  1504. "alias": "issue_number",
  1505. "deprecated": true,
  1506. "type": "integer"
  1507. },
  1508. "owner": { "required": true, "type": "string" },
  1509. "repo": { "required": true, "type": "string" }
  1510. },
  1511. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1512. },
  1513. "checkAssignee": {
  1514. "method": "GET",
  1515. "params": {
  1516. "assignee": { "required": true, "type": "string" },
  1517. "owner": { "required": true, "type": "string" },
  1518. "repo": { "required": true, "type": "string" }
  1519. },
  1520. "url": "/repos/:owner/:repo/assignees/:assignee"
  1521. },
  1522. "create": {
  1523. "method": "POST",
  1524. "params": {
  1525. "assignee": { "type": "string" },
  1526. "assignees": { "type": "string[]" },
  1527. "body": { "type": "string" },
  1528. "labels": { "type": "string[]" },
  1529. "milestone": { "type": "integer" },
  1530. "owner": { "required": true, "type": "string" },
  1531. "repo": { "required": true, "type": "string" },
  1532. "title": { "required": true, "type": "string" }
  1533. },
  1534. "url": "/repos/:owner/:repo/issues"
  1535. },
  1536. "createComment": {
  1537. "method": "POST",
  1538. "params": {
  1539. "body": { "required": true, "type": "string" },
  1540. "issue_number": { "required": true, "type": "integer" },
  1541. "number": {
  1542. "alias": "issue_number",
  1543. "deprecated": true,
  1544. "type": "integer"
  1545. },
  1546. "owner": { "required": true, "type": "string" },
  1547. "repo": { "required": true, "type": "string" }
  1548. },
  1549. "url": "/repos/:owner/:repo/issues/:issue_number/comments"
  1550. },
  1551. "createLabel": {
  1552. "method": "POST",
  1553. "params": {
  1554. "color": { "required": true, "type": "string" },
  1555. "description": { "type": "string" },
  1556. "name": { "required": true, "type": "string" },
  1557. "owner": { "required": true, "type": "string" },
  1558. "repo": { "required": true, "type": "string" }
  1559. },
  1560. "url": "/repos/:owner/:repo/labels"
  1561. },
  1562. "createMilestone": {
  1563. "method": "POST",
  1564. "params": {
  1565. "description": { "type": "string" },
  1566. "due_on": { "type": "string" },
  1567. "owner": { "required": true, "type": "string" },
  1568. "repo": { "required": true, "type": "string" },
  1569. "state": { "enum": ["open", "closed"], "type": "string" },
  1570. "title": { "required": true, "type": "string" }
  1571. },
  1572. "url": "/repos/:owner/:repo/milestones"
  1573. },
  1574. "deleteComment": {
  1575. "method": "DELETE",
  1576. "params": {
  1577. "comment_id": { "required": true, "type": "integer" },
  1578. "owner": { "required": true, "type": "string" },
  1579. "repo": { "required": true, "type": "string" }
  1580. },
  1581. "url": "/repos/:owner/:repo/issues/comments/:comment_id"
  1582. },
  1583. "deleteLabel": {
  1584. "method": "DELETE",
  1585. "params": {
  1586. "name": { "required": true, "type": "string" },
  1587. "owner": { "required": true, "type": "string" },
  1588. "repo": { "required": true, "type": "string" }
  1589. },
  1590. "url": "/repos/:owner/:repo/labels/:name"
  1591. },
  1592. "deleteMilestone": {
  1593. "method": "DELETE",
  1594. "params": {
  1595. "milestone_number": { "required": true, "type": "integer" },
  1596. "number": {
  1597. "alias": "milestone_number",
  1598. "deprecated": true,
  1599. "type": "integer"
  1600. },
  1601. "owner": { "required": true, "type": "string" },
  1602. "repo": { "required": true, "type": "string" }
  1603. },
  1604. "url": "/repos/:owner/:repo/milestones/:milestone_number"
  1605. },
  1606. "get": {
  1607. "method": "GET",
  1608. "params": {
  1609. "issue_number": { "required": true, "type": "integer" },
  1610. "number": {
  1611. "alias": "issue_number",
  1612. "deprecated": true,
  1613. "type": "integer"
  1614. },
  1615. "owner": { "required": true, "type": "string" },
  1616. "repo": { "required": true, "type": "string" }
  1617. },
  1618. "url": "/repos/:owner/:repo/issues/:issue_number"
  1619. },
  1620. "getComment": {
  1621. "method": "GET",
  1622. "params": {
  1623. "comment_id": { "required": true, "type": "integer" },
  1624. "owner": { "required": true, "type": "string" },
  1625. "page": { "type": "integer" },
  1626. "per_page": { "type": "integer" },
  1627. "repo": { "required": true, "type": "string" }
  1628. },
  1629. "url": "/repos/:owner/:repo/issues/comments/:comment_id"
  1630. },
  1631. "getEvent": {
  1632. "method": "GET",
  1633. "params": {
  1634. "event_id": { "required": true, "type": "integer" },
  1635. "owner": { "required": true, "type": "string" },
  1636. "repo": { "required": true, "type": "string" }
  1637. },
  1638. "url": "/repos/:owner/:repo/issues/events/:event_id"
  1639. },
  1640. "getLabel": {
  1641. "method": "GET",
  1642. "params": {
  1643. "name": { "required": true, "type": "string" },
  1644. "owner": { "required": true, "type": "string" },
  1645. "repo": { "required": true, "type": "string" }
  1646. },
  1647. "url": "/repos/:owner/:repo/labels/:name"
  1648. },
  1649. "getMilestone": {
  1650. "method": "GET",
  1651. "params": {
  1652. "milestone_number": { "required": true, "type": "integer" },
  1653. "number": {
  1654. "alias": "milestone_number",
  1655. "deprecated": true,
  1656. "type": "integer"
  1657. },
  1658. "owner": { "required": true, "type": "string" },
  1659. "repo": { "required": true, "type": "string" }
  1660. },
  1661. "url": "/repos/:owner/:repo/milestones/:milestone_number"
  1662. },
  1663. "list": {
  1664. "method": "GET",
  1665. "params": {
  1666. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1667. "filter": {
  1668. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  1669. "type": "string"
  1670. },
  1671. "labels": { "type": "string" },
  1672. "page": { "type": "integer" },
  1673. "per_page": { "type": "integer" },
  1674. "since": { "type": "string" },
  1675. "sort": {
  1676. "enum": ["created", "updated", "comments"],
  1677. "type": "string"
  1678. },
  1679. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1680. },
  1681. "url": "/issues"
  1682. },
  1683. "listAssignees": {
  1684. "method": "GET",
  1685. "params": {
  1686. "owner": { "required": true, "type": "string" },
  1687. "page": { "type": "integer" },
  1688. "per_page": { "type": "integer" },
  1689. "repo": { "required": true, "type": "string" }
  1690. },
  1691. "url": "/repos/:owner/:repo/assignees"
  1692. },
  1693. "listComments": {
  1694. "method": "GET",
  1695. "params": {
  1696. "issue_number": { "required": true, "type": "integer" },
  1697. "number": {
  1698. "alias": "issue_number",
  1699. "deprecated": true,
  1700. "type": "integer"
  1701. },
  1702. "owner": { "required": true, "type": "string" },
  1703. "page": { "type": "integer" },
  1704. "per_page": { "type": "integer" },
  1705. "repo": { "required": true, "type": "string" },
  1706. "since": { "type": "string" }
  1707. },
  1708. "url": "/repos/:owner/:repo/issues/:issue_number/comments"
  1709. },
  1710. "listCommentsForRepo": {
  1711. "method": "GET",
  1712. "params": {
  1713. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1714. "owner": { "required": true, "type": "string" },
  1715. "repo": { "required": true, "type": "string" },
  1716. "since": { "type": "string" },
  1717. "sort": { "enum": ["created", "updated"], "type": "string" }
  1718. },
  1719. "url": "/repos/:owner/:repo/issues/comments"
  1720. },
  1721. "listEvents": {
  1722. "method": "GET",
  1723. "params": {
  1724. "issue_number": { "required": true, "type": "integer" },
  1725. "number": {
  1726. "alias": "issue_number",
  1727. "deprecated": true,
  1728. "type": "integer"
  1729. },
  1730. "owner": { "required": true, "type": "string" },
  1731. "page": { "type": "integer" },
  1732. "per_page": { "type": "integer" },
  1733. "repo": { "required": true, "type": "string" }
  1734. },
  1735. "url": "/repos/:owner/:repo/issues/:issue_number/events"
  1736. },
  1737. "listEventsForRepo": {
  1738. "method": "GET",
  1739. "params": {
  1740. "owner": { "required": true, "type": "string" },
  1741. "page": { "type": "integer" },
  1742. "per_page": { "type": "integer" },
  1743. "repo": { "required": true, "type": "string" }
  1744. },
  1745. "url": "/repos/:owner/:repo/issues/events"
  1746. },
  1747. "listEventsForTimeline": {
  1748. "headers": {
  1749. "accept": "application/vnd.github.mockingbird-preview+json"
  1750. },
  1751. "method": "GET",
  1752. "params": {
  1753. "issue_number": { "required": true, "type": "integer" },
  1754. "number": {
  1755. "alias": "issue_number",
  1756. "deprecated": true,
  1757. "type": "integer"
  1758. },
  1759. "owner": { "required": true, "type": "string" },
  1760. "page": { "type": "integer" },
  1761. "per_page": { "type": "integer" },
  1762. "repo": { "required": true, "type": "string" }
  1763. },
  1764. "url": "/repos/:owner/:repo/issues/:issue_number/timeline"
  1765. },
  1766. "listForAuthenticatedUser": {
  1767. "method": "GET",
  1768. "params": {
  1769. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1770. "filter": {
  1771. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  1772. "type": "string"
  1773. },
  1774. "labels": { "type": "string" },
  1775. "page": { "type": "integer" },
  1776. "per_page": { "type": "integer" },
  1777. "since": { "type": "string" },
  1778. "sort": {
  1779. "enum": ["created", "updated", "comments"],
  1780. "type": "string"
  1781. },
  1782. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1783. },
  1784. "url": "/user/issues"
  1785. },
  1786. "listForOrg": {
  1787. "method": "GET",
  1788. "params": {
  1789. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1790. "filter": {
  1791. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  1792. "type": "string"
  1793. },
  1794. "labels": { "type": "string" },
  1795. "org": { "required": true, "type": "string" },
  1796. "page": { "type": "integer" },
  1797. "per_page": { "type": "integer" },
  1798. "since": { "type": "string" },
  1799. "sort": {
  1800. "enum": ["created", "updated", "comments"],
  1801. "type": "string"
  1802. },
  1803. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1804. },
  1805. "url": "/orgs/:org/issues"
  1806. },
  1807. "listForRepo": {
  1808. "method": "GET",
  1809. "params": {
  1810. "assignee": { "type": "string" },
  1811. "creator": { "type": "string" },
  1812. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1813. "labels": { "type": "string" },
  1814. "mentioned": { "type": "string" },
  1815. "milestone": { "type": "string" },
  1816. "owner": { "required": true, "type": "string" },
  1817. "page": { "type": "integer" },
  1818. "per_page": { "type": "integer" },
  1819. "repo": { "required": true, "type": "string" },
  1820. "since": { "type": "string" },
  1821. "sort": {
  1822. "enum": ["created", "updated", "comments"],
  1823. "type": "string"
  1824. },
  1825. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1826. },
  1827. "url": "/repos/:owner/:repo/issues"
  1828. },
  1829. "listLabelsForMilestone": {
  1830. "method": "GET",
  1831. "params": {
  1832. "milestone_number": { "required": true, "type": "integer" },
  1833. "number": {
  1834. "alias": "milestone_number",
  1835. "deprecated": true,
  1836. "type": "integer"
  1837. },
  1838. "owner": { "required": true, "type": "string" },
  1839. "page": { "type": "integer" },
  1840. "per_page": { "type": "integer" },
  1841. "repo": { "required": true, "type": "string" }
  1842. },
  1843. "url": "/repos/:owner/:repo/milestones/:milestone_number/labels"
  1844. },
  1845. "listLabelsForRepo": {
  1846. "method": "GET",
  1847. "params": {
  1848. "owner": { "required": true, "type": "string" },
  1849. "page": { "type": "integer" },
  1850. "per_page": { "type": "integer" },
  1851. "repo": { "required": true, "type": "string" }
  1852. },
  1853. "url": "/repos/:owner/:repo/labels"
  1854. },
  1855. "listLabelsOnIssue": {
  1856. "method": "GET",
  1857. "params": {
  1858. "issue_number": { "required": true, "type": "integer" },
  1859. "number": {
  1860. "alias": "issue_number",
  1861. "deprecated": true,
  1862. "type": "integer"
  1863. },
  1864. "owner": { "required": true, "type": "string" },
  1865. "page": { "type": "integer" },
  1866. "per_page": { "type": "integer" },
  1867. "repo": { "required": true, "type": "string" }
  1868. },
  1869. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1870. },
  1871. "listMilestonesForRepo": {
  1872. "method": "GET",
  1873. "params": {
  1874. "direction": { "enum": ["asc", "desc"], "type": "string" },
  1875. "owner": { "required": true, "type": "string" },
  1876. "page": { "type": "integer" },
  1877. "per_page": { "type": "integer" },
  1878. "repo": { "required": true, "type": "string" },
  1879. "sort": { "enum": ["due_on", "completeness"], "type": "string" },
  1880. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  1881. },
  1882. "url": "/repos/:owner/:repo/milestones"
  1883. },
  1884. "lock": {
  1885. "method": "PUT",
  1886. "params": {
  1887. "issue_number": { "required": true, "type": "integer" },
  1888. "lock_reason": {
  1889. "enum": ["off-topic", "too heated", "resolved", "spam"],
  1890. "type": "string"
  1891. },
  1892. "number": {
  1893. "alias": "issue_number",
  1894. "deprecated": true,
  1895. "type": "integer"
  1896. },
  1897. "owner": { "required": true, "type": "string" },
  1898. "repo": { "required": true, "type": "string" }
  1899. },
  1900. "url": "/repos/:owner/:repo/issues/:issue_number/lock"
  1901. },
  1902. "removeAssignees": {
  1903. "method": "DELETE",
  1904. "params": {
  1905. "assignees": { "type": "string[]" },
  1906. "issue_number": { "required": true, "type": "integer" },
  1907. "number": {
  1908. "alias": "issue_number",
  1909. "deprecated": true,
  1910. "type": "integer"
  1911. },
  1912. "owner": { "required": true, "type": "string" },
  1913. "repo": { "required": true, "type": "string" }
  1914. },
  1915. "url": "/repos/:owner/:repo/issues/:issue_number/assignees"
  1916. },
  1917. "removeLabel": {
  1918. "method": "DELETE",
  1919. "params": {
  1920. "issue_number": { "required": true, "type": "integer" },
  1921. "name": { "required": true, "type": "string" },
  1922. "number": {
  1923. "alias": "issue_number",
  1924. "deprecated": true,
  1925. "type": "integer"
  1926. },
  1927. "owner": { "required": true, "type": "string" },
  1928. "repo": { "required": true, "type": "string" }
  1929. },
  1930. "url": "/repos/:owner/:repo/issues/:issue_number/labels/:name"
  1931. },
  1932. "removeLabels": {
  1933. "method": "DELETE",
  1934. "params": {
  1935. "issue_number": { "required": true, "type": "integer" },
  1936. "number": {
  1937. "alias": "issue_number",
  1938. "deprecated": true,
  1939. "type": "integer"
  1940. },
  1941. "owner": { "required": true, "type": "string" },
  1942. "repo": { "required": true, "type": "string" }
  1943. },
  1944. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1945. },
  1946. "replaceLabels": {
  1947. "method": "PUT",
  1948. "params": {
  1949. "issue_number": { "required": true, "type": "integer" },
  1950. "labels": { "type": "string[]" },
  1951. "number": {
  1952. "alias": "issue_number",
  1953. "deprecated": true,
  1954. "type": "integer"
  1955. },
  1956. "owner": { "required": true, "type": "string" },
  1957. "repo": { "required": true, "type": "string" }
  1958. },
  1959. "url": "/repos/:owner/:repo/issues/:issue_number/labels"
  1960. },
  1961. "unlock": {
  1962. "method": "DELETE",
  1963. "params": {
  1964. "issue_number": { "required": true, "type": "integer" },
  1965. "number": {
  1966. "alias": "issue_number",
  1967. "deprecated": true,
  1968. "type": "integer"
  1969. },
  1970. "owner": { "required": true, "type": "string" },
  1971. "repo": { "required": true, "type": "string" }
  1972. },
  1973. "url": "/repos/:owner/:repo/issues/:issue_number/lock"
  1974. },
  1975. "update": {
  1976. "method": "PATCH",
  1977. "params": {
  1978. "assignee": { "type": "string" },
  1979. "assignees": { "type": "string[]" },
  1980. "body": { "type": "string" },
  1981. "issue_number": { "required": true, "type": "integer" },
  1982. "labels": { "type": "string[]" },
  1983. "milestone": { "allowNull": true, "type": "integer" },
  1984. "number": {
  1985. "alias": "issue_number",
  1986. "deprecated": true,
  1987. "type": "integer"
  1988. },
  1989. "owner": { "required": true, "type": "string" },
  1990. "repo": { "required": true, "type": "string" },
  1991. "state": { "enum": ["open", "closed"], "type": "string" },
  1992. "title": { "type": "string" }
  1993. },
  1994. "url": "/repos/:owner/:repo/issues/:issue_number"
  1995. },
  1996. "updateComment": {
  1997. "method": "PATCH",
  1998. "params": {
  1999. "body": { "required": true, "type": "string" },
  2000. "comment_id": { "required": true, "type": "integer" },
  2001. "owner": { "required": true, "type": "string" },
  2002. "repo": { "required": true, "type": "string" }
  2003. },
  2004. "url": "/repos/:owner/:repo/issues/comments/:comment_id"
  2005. },
  2006. "updateLabel": {
  2007. "method": "PATCH",
  2008. "params": {
  2009. "color": { "type": "string" },
  2010. "current_name": { "required": true, "type": "string" },
  2011. "description": { "type": "string" },
  2012. "name": { "type": "string" },
  2013. "owner": { "required": true, "type": "string" },
  2014. "repo": { "required": true, "type": "string" }
  2015. },
  2016. "url": "/repos/:owner/:repo/labels/:current_name"
  2017. },
  2018. "updateMilestone": {
  2019. "method": "PATCH",
  2020. "params": {
  2021. "description": { "type": "string" },
  2022. "due_on": { "type": "string" },
  2023. "milestone_number": { "required": true, "type": "integer" },
  2024. "number": {
  2025. "alias": "milestone_number",
  2026. "deprecated": true,
  2027. "type": "integer"
  2028. },
  2029. "owner": { "required": true, "type": "string" },
  2030. "repo": { "required": true, "type": "string" },
  2031. "state": { "enum": ["open", "closed"], "type": "string" },
  2032. "title": { "type": "string" }
  2033. },
  2034. "url": "/repos/:owner/:repo/milestones/:milestone_number"
  2035. }
  2036. },
  2037. "licenses": {
  2038. "get": {
  2039. "method": "GET",
  2040. "params": { "license": { "required": true, "type": "string" } },
  2041. "url": "/licenses/:license"
  2042. },
  2043. "getForRepo": {
  2044. "method": "GET",
  2045. "params": {
  2046. "owner": { "required": true, "type": "string" },
  2047. "repo": { "required": true, "type": "string" }
  2048. },
  2049. "url": "/repos/:owner/:repo/license"
  2050. },
  2051. "list": {
  2052. "deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
  2053. "method": "GET",
  2054. "params": {},
  2055. "url": "/licenses"
  2056. },
  2057. "listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" }
  2058. },
  2059. "markdown": {
  2060. "render": {
  2061. "method": "POST",
  2062. "params": {
  2063. "context": { "type": "string" },
  2064. "mode": { "enum": ["markdown", "gfm"], "type": "string" },
  2065. "text": { "required": true, "type": "string" }
  2066. },
  2067. "url": "/markdown"
  2068. },
  2069. "renderRaw": {
  2070. "headers": { "content-type": "text/plain; charset=utf-8" },
  2071. "method": "POST",
  2072. "params": {
  2073. "data": { "mapTo": "data", "required": true, "type": "string" }
  2074. },
  2075. "url": "/markdown/raw"
  2076. }
  2077. },
  2078. "meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } },
  2079. "oauthAuthorizations": {
  2080. "checkAuthorization": {
  2081. "method": "GET",
  2082. "params": {
  2083. "access_token": { "required": true, "type": "string" },
  2084. "client_id": { "required": true, "type": "string" }
  2085. },
  2086. "url": "/applications/:client_id/tokens/:access_token"
  2087. },
  2088. "createAuthorization": {
  2089. "method": "POST",
  2090. "params": {
  2091. "client_id": { "type": "string" },
  2092. "client_secret": { "type": "string" },
  2093. "fingerprint": { "type": "string" },
  2094. "note": { "required": true, "type": "string" },
  2095. "note_url": { "type": "string" },
  2096. "scopes": { "type": "string[]" }
  2097. },
  2098. "url": "/authorizations"
  2099. },
  2100. "deleteAuthorization": {
  2101. "method": "DELETE",
  2102. "params": { "authorization_id": { "required": true, "type": "integer" } },
  2103. "url": "/authorizations/:authorization_id"
  2104. },
  2105. "deleteGrant": {
  2106. "method": "DELETE",
  2107. "params": { "grant_id": { "required": true, "type": "integer" } },
  2108. "url": "/applications/grants/:grant_id"
  2109. },
  2110. "getAuthorization": {
  2111. "method": "GET",
  2112. "params": { "authorization_id": { "required": true, "type": "integer" } },
  2113. "url": "/authorizations/:authorization_id"
  2114. },
  2115. "getGrant": {
  2116. "method": "GET",
  2117. "params": { "grant_id": { "required": true, "type": "integer" } },
  2118. "url": "/applications/grants/:grant_id"
  2119. },
  2120. "getOrCreateAuthorizationForApp": {
  2121. "method": "PUT",
  2122. "params": {
  2123. "client_id": { "required": true, "type": "string" },
  2124. "client_secret": { "required": true, "type": "string" },
  2125. "fingerprint": { "type": "string" },
  2126. "note": { "type": "string" },
  2127. "note_url": { "type": "string" },
  2128. "scopes": { "type": "string[]" }
  2129. },
  2130. "url": "/authorizations/clients/:client_id"
  2131. },
  2132. "getOrCreateAuthorizationForAppAndFingerprint": {
  2133. "method": "PUT",
  2134. "params": {
  2135. "client_id": { "required": true, "type": "string" },
  2136. "client_secret": { "required": true, "type": "string" },
  2137. "fingerprint": { "required": true, "type": "string" },
  2138. "note": { "type": "string" },
  2139. "note_url": { "type": "string" },
  2140. "scopes": { "type": "string[]" }
  2141. },
  2142. "url": "/authorizations/clients/:client_id/:fingerprint"
  2143. },
  2144. "getOrCreateAuthorizationForAppFingerprint": {
  2145. "deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
  2146. "method": "PUT",
  2147. "params": {
  2148. "client_id": { "required": true, "type": "string" },
  2149. "client_secret": { "required": true, "type": "string" },
  2150. "fingerprint": { "required": true, "type": "string" },
  2151. "note": { "type": "string" },
  2152. "note_url": { "type": "string" },
  2153. "scopes": { "type": "string[]" }
  2154. },
  2155. "url": "/authorizations/clients/:client_id/:fingerprint"
  2156. },
  2157. "listAuthorizations": {
  2158. "method": "GET",
  2159. "params": {
  2160. "page": { "type": "integer" },
  2161. "per_page": { "type": "integer" }
  2162. },
  2163. "url": "/authorizations"
  2164. },
  2165. "listGrants": {
  2166. "method": "GET",
  2167. "params": {
  2168. "page": { "type": "integer" },
  2169. "per_page": { "type": "integer" }
  2170. },
  2171. "url": "/applications/grants"
  2172. },
  2173. "resetAuthorization": {
  2174. "method": "POST",
  2175. "params": {
  2176. "access_token": { "required": true, "type": "string" },
  2177. "client_id": { "required": true, "type": "string" }
  2178. },
  2179. "url": "/applications/:client_id/tokens/:access_token"
  2180. },
  2181. "revokeAuthorizationForApplication": {
  2182. "method": "DELETE",
  2183. "params": {
  2184. "access_token": { "required": true, "type": "string" },
  2185. "client_id": { "required": true, "type": "string" }
  2186. },
  2187. "url": "/applications/:client_id/tokens/:access_token"
  2188. },
  2189. "revokeGrantForApplication": {
  2190. "method": "DELETE",
  2191. "params": {
  2192. "access_token": { "required": true, "type": "string" },
  2193. "client_id": { "required": true, "type": "string" }
  2194. },
  2195. "url": "/applications/:client_id/grants/:access_token"
  2196. },
  2197. "updateAuthorization": {
  2198. "method": "PATCH",
  2199. "params": {
  2200. "add_scopes": { "type": "string[]" },
  2201. "authorization_id": { "required": true, "type": "integer" },
  2202. "fingerprint": { "type": "string" },
  2203. "note": { "type": "string" },
  2204. "note_url": { "type": "string" },
  2205. "remove_scopes": { "type": "string[]" },
  2206. "scopes": { "type": "string[]" }
  2207. },
  2208. "url": "/authorizations/:authorization_id"
  2209. }
  2210. },
  2211. "orgs": {
  2212. "addOrUpdateMembership": {
  2213. "method": "PUT",
  2214. "params": {
  2215. "org": { "required": true, "type": "string" },
  2216. "role": { "enum": ["admin", "member"], "type": "string" },
  2217. "username": { "required": true, "type": "string" }
  2218. },
  2219. "url": "/orgs/:org/memberships/:username"
  2220. },
  2221. "checkMembership": {
  2222. "method": "GET",
  2223. "params": {
  2224. "org": { "required": true, "type": "string" },
  2225. "username": { "required": true, "type": "string" }
  2226. },
  2227. "url": "/orgs/:org/members/:username"
  2228. },
  2229. "checkPublicMembership": {
  2230. "method": "GET",
  2231. "params": {
  2232. "org": { "required": true, "type": "string" },
  2233. "username": { "required": true, "type": "string" }
  2234. },
  2235. "url": "/orgs/:org/public_members/:username"
  2236. },
  2237. "concealMembership": {
  2238. "method": "DELETE",
  2239. "params": {
  2240. "org": { "required": true, "type": "string" },
  2241. "username": { "required": true, "type": "string" }
  2242. },
  2243. "url": "/orgs/:org/public_members/:username"
  2244. },
  2245. "convertMemberToOutsideCollaborator": {
  2246. "method": "PUT",
  2247. "params": {
  2248. "org": { "required": true, "type": "string" },
  2249. "username": { "required": true, "type": "string" }
  2250. },
  2251. "url": "/orgs/:org/outside_collaborators/:username"
  2252. },
  2253. "createHook": {
  2254. "method": "POST",
  2255. "params": {
  2256. "active": { "type": "boolean" },
  2257. "config": { "required": true, "type": "object" },
  2258. "config.content_type": { "type": "string" },
  2259. "config.insecure_ssl": { "type": "string" },
  2260. "config.secret": { "type": "string" },
  2261. "config.url": { "required": true, "type": "string" },
  2262. "events": { "type": "string[]" },
  2263. "name": { "required": true, "type": "string" },
  2264. "org": { "required": true, "type": "string" }
  2265. },
  2266. "url": "/orgs/:org/hooks"
  2267. },
  2268. "deleteHook": {
  2269. "method": "DELETE",
  2270. "params": {
  2271. "hook_id": { "required": true, "type": "integer" },
  2272. "org": { "required": true, "type": "string" }
  2273. },
  2274. "url": "/orgs/:org/hooks/:hook_id"
  2275. },
  2276. "get": {
  2277. "method": "GET",
  2278. "params": { "org": { "required": true, "type": "string" } },
  2279. "url": "/orgs/:org"
  2280. },
  2281. "getHook": {
  2282. "method": "GET",
  2283. "params": {
  2284. "hook_id": { "required": true, "type": "integer" },
  2285. "org": { "required": true, "type": "string" }
  2286. },
  2287. "url": "/orgs/:org/hooks/:hook_id"
  2288. },
  2289. "getMembership": {
  2290. "method": "GET",
  2291. "params": {
  2292. "org": { "required": true, "type": "string" },
  2293. "username": { "required": true, "type": "string" }
  2294. },
  2295. "url": "/orgs/:org/memberships/:username"
  2296. },
  2297. "getMembershipForAuthenticatedUser": {
  2298. "method": "GET",
  2299. "params": { "org": { "required": true, "type": "string" } },
  2300. "url": "/user/memberships/orgs/:org"
  2301. },
  2302. "list": {
  2303. "method": "GET",
  2304. "params": {
  2305. "page": { "type": "integer" },
  2306. "per_page": { "type": "integer" },
  2307. "since": { "type": "string" }
  2308. },
  2309. "url": "/organizations"
  2310. },
  2311. "listForAuthenticatedUser": {
  2312. "method": "GET",
  2313. "params": {
  2314. "page": { "type": "integer" },
  2315. "per_page": { "type": "integer" }
  2316. },
  2317. "url": "/user/orgs"
  2318. },
  2319. "listForUser": {
  2320. "method": "GET",
  2321. "params": {
  2322. "page": { "type": "integer" },
  2323. "per_page": { "type": "integer" },
  2324. "username": { "required": true, "type": "string" }
  2325. },
  2326. "url": "/users/:username/orgs"
  2327. },
  2328. "listHooks": {
  2329. "method": "GET",
  2330. "params": {
  2331. "org": { "required": true, "type": "string" },
  2332. "page": { "type": "integer" },
  2333. "per_page": { "type": "integer" }
  2334. },
  2335. "url": "/orgs/:org/hooks"
  2336. },
  2337. "listInstallations": {
  2338. "headers": {
  2339. "accept": "application/vnd.github.machine-man-preview+json"
  2340. },
  2341. "method": "GET",
  2342. "params": {
  2343. "org": { "required": true, "type": "string" },
  2344. "page": { "type": "integer" },
  2345. "per_page": { "type": "integer" }
  2346. },
  2347. "url": "/orgs/:org/installations"
  2348. },
  2349. "listMembers": {
  2350. "method": "GET",
  2351. "params": {
  2352. "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
  2353. "org": { "required": true, "type": "string" },
  2354. "page": { "type": "integer" },
  2355. "per_page": { "type": "integer" },
  2356. "role": { "enum": ["all", "admin", "member"], "type": "string" }
  2357. },
  2358. "url": "/orgs/:org/members"
  2359. },
  2360. "listMemberships": {
  2361. "method": "GET",
  2362. "params": {
  2363. "page": { "type": "integer" },
  2364. "per_page": { "type": "integer" },
  2365. "state": { "enum": ["active", "pending"], "type": "string" }
  2366. },
  2367. "url": "/user/memberships/orgs"
  2368. },
  2369. "listOutsideCollaborators": {
  2370. "method": "GET",
  2371. "params": {
  2372. "filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
  2373. "org": { "required": true, "type": "string" },
  2374. "page": { "type": "integer" },
  2375. "per_page": { "type": "integer" }
  2376. },
  2377. "url": "/orgs/:org/outside_collaborators"
  2378. },
  2379. "listPublicMembers": {
  2380. "method": "GET",
  2381. "params": {
  2382. "org": { "required": true, "type": "string" },
  2383. "page": { "type": "integer" },
  2384. "per_page": { "type": "integer" }
  2385. },
  2386. "url": "/orgs/:org/public_members"
  2387. },
  2388. "pingHook": {
  2389. "method": "POST",
  2390. "params": {
  2391. "hook_id": { "required": true, "type": "integer" },
  2392. "org": { "required": true, "type": "string" }
  2393. },
  2394. "url": "/orgs/:org/hooks/:hook_id/pings"
  2395. },
  2396. "publicizeMembership": {
  2397. "method": "PUT",
  2398. "params": {
  2399. "org": { "required": true, "type": "string" },
  2400. "username": { "required": true, "type": "string" }
  2401. },
  2402. "url": "/orgs/:org/public_members/:username"
  2403. },
  2404. "removeMember": {
  2405. "method": "DELETE",
  2406. "params": {
  2407. "org": { "required": true, "type": "string" },
  2408. "username": { "required": true, "type": "string" }
  2409. },
  2410. "url": "/orgs/:org/members/:username"
  2411. },
  2412. "removeMembership": {
  2413. "method": "DELETE",
  2414. "params": {
  2415. "org": { "required": true, "type": "string" },
  2416. "username": { "required": true, "type": "string" }
  2417. },
  2418. "url": "/orgs/:org/memberships/:username"
  2419. },
  2420. "removeOutsideCollaborator": {
  2421. "method": "DELETE",
  2422. "params": {
  2423. "org": { "required": true, "type": "string" },
  2424. "username": { "required": true, "type": "string" }
  2425. },
  2426. "url": "/orgs/:org/outside_collaborators/:username"
  2427. },
  2428. "update": {
  2429. "method": "PATCH",
  2430. "params": {
  2431. "billing_email": { "type": "string" },
  2432. "company": { "type": "string" },
  2433. "default_repository_permission": {
  2434. "enum": ["read", "write", "admin", "none"],
  2435. "type": "string"
  2436. },
  2437. "description": { "type": "string" },
  2438. "email": { "type": "string" },
  2439. "has_organization_projects": { "type": "boolean" },
  2440. "has_repository_projects": { "type": "boolean" },
  2441. "location": { "type": "string" },
  2442. "members_allowed_repository_creation_type": {
  2443. "enum": ["all", "private", "none"],
  2444. "type": "string"
  2445. },
  2446. "members_can_create_repositories": { "type": "boolean" },
  2447. "name": { "type": "string" },
  2448. "org": { "required": true, "type": "string" }
  2449. },
  2450. "url": "/orgs/:org"
  2451. },
  2452. "updateHook": {
  2453. "method": "PATCH",
  2454. "params": {
  2455. "active": { "type": "boolean" },
  2456. "config": { "type": "object" },
  2457. "config.content_type": { "type": "string" },
  2458. "config.insecure_ssl": { "type": "string" },
  2459. "config.secret": { "type": "string" },
  2460. "config.url": { "required": true, "type": "string" },
  2461. "events": { "type": "string[]" },
  2462. "hook_id": { "required": true, "type": "integer" },
  2463. "org": { "required": true, "type": "string" }
  2464. },
  2465. "url": "/orgs/:org/hooks/:hook_id"
  2466. },
  2467. "updateMembership": {
  2468. "method": "PATCH",
  2469. "params": {
  2470. "org": { "required": true, "type": "string" },
  2471. "state": { "enum": ["active"], "required": true, "type": "string" }
  2472. },
  2473. "url": "/user/memberships/orgs/:org"
  2474. }
  2475. },
  2476. "projects": {
  2477. "addCollaborator": {
  2478. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2479. "method": "PUT",
  2480. "params": {
  2481. "permission": { "enum": ["read", "write", "admin"], "type": "string" },
  2482. "project_id": { "required": true, "type": "integer" },
  2483. "username": { "required": true, "type": "string" }
  2484. },
  2485. "url": "/projects/:project_id/collaborators/:username"
  2486. },
  2487. "createCard": {
  2488. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2489. "method": "POST",
  2490. "params": {
  2491. "column_id": { "required": true, "type": "integer" },
  2492. "content_id": { "type": "integer" },
  2493. "content_type": { "type": "string" },
  2494. "note": { "type": "string" }
  2495. },
  2496. "url": "/projects/columns/:column_id/cards"
  2497. },
  2498. "createColumn": {
  2499. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2500. "method": "POST",
  2501. "params": {
  2502. "name": { "required": true, "type": "string" },
  2503. "project_id": { "required": true, "type": "integer" }
  2504. },
  2505. "url": "/projects/:project_id/columns"
  2506. },
  2507. "createForAuthenticatedUser": {
  2508. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2509. "method": "POST",
  2510. "params": {
  2511. "body": { "type": "string" },
  2512. "name": { "required": true, "type": "string" }
  2513. },
  2514. "url": "/user/projects"
  2515. },
  2516. "createForOrg": {
  2517. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2518. "method": "POST",
  2519. "params": {
  2520. "body": { "type": "string" },
  2521. "name": { "required": true, "type": "string" },
  2522. "org": { "required": true, "type": "string" }
  2523. },
  2524. "url": "/orgs/:org/projects"
  2525. },
  2526. "createForRepo": {
  2527. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2528. "method": "POST",
  2529. "params": {
  2530. "body": { "type": "string" },
  2531. "name": { "required": true, "type": "string" },
  2532. "owner": { "required": true, "type": "string" },
  2533. "repo": { "required": true, "type": "string" }
  2534. },
  2535. "url": "/repos/:owner/:repo/projects"
  2536. },
  2537. "delete": {
  2538. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2539. "method": "DELETE",
  2540. "params": { "project_id": { "required": true, "type": "integer" } },
  2541. "url": "/projects/:project_id"
  2542. },
  2543. "deleteCard": {
  2544. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2545. "method": "DELETE",
  2546. "params": { "card_id": { "required": true, "type": "integer" } },
  2547. "url": "/projects/columns/cards/:card_id"
  2548. },
  2549. "deleteColumn": {
  2550. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2551. "method": "DELETE",
  2552. "params": { "column_id": { "required": true, "type": "integer" } },
  2553. "url": "/projects/columns/:column_id"
  2554. },
  2555. "get": {
  2556. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2557. "method": "GET",
  2558. "params": {
  2559. "page": { "type": "integer" },
  2560. "per_page": { "type": "integer" },
  2561. "project_id": { "required": true, "type": "integer" }
  2562. },
  2563. "url": "/projects/:project_id"
  2564. },
  2565. "getCard": {
  2566. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2567. "method": "GET",
  2568. "params": { "card_id": { "required": true, "type": "integer" } },
  2569. "url": "/projects/columns/cards/:card_id"
  2570. },
  2571. "getColumn": {
  2572. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2573. "method": "GET",
  2574. "params": { "column_id": { "required": true, "type": "integer" } },
  2575. "url": "/projects/columns/:column_id"
  2576. },
  2577. "listCards": {
  2578. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2579. "method": "GET",
  2580. "params": {
  2581. "archived_state": {
  2582. "enum": ["all", "archived", "not_archived"],
  2583. "type": "string"
  2584. },
  2585. "column_id": { "required": true, "type": "integer" },
  2586. "page": { "type": "integer" },
  2587. "per_page": { "type": "integer" }
  2588. },
  2589. "url": "/projects/columns/:column_id/cards"
  2590. },
  2591. "listCollaborators": {
  2592. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2593. "method": "GET",
  2594. "params": {
  2595. "affiliation": {
  2596. "enum": ["outside", "direct", "all"],
  2597. "type": "string"
  2598. },
  2599. "page": { "type": "integer" },
  2600. "per_page": { "type": "integer" },
  2601. "project_id": { "required": true, "type": "integer" }
  2602. },
  2603. "url": "/projects/:project_id/collaborators"
  2604. },
  2605. "listColumns": {
  2606. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2607. "method": "GET",
  2608. "params": {
  2609. "page": { "type": "integer" },
  2610. "per_page": { "type": "integer" },
  2611. "project_id": { "required": true, "type": "integer" }
  2612. },
  2613. "url": "/projects/:project_id/columns"
  2614. },
  2615. "listForOrg": {
  2616. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2617. "method": "GET",
  2618. "params": {
  2619. "org": { "required": true, "type": "string" },
  2620. "page": { "type": "integer" },
  2621. "per_page": { "type": "integer" },
  2622. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  2623. },
  2624. "url": "/orgs/:org/projects"
  2625. },
  2626. "listForRepo": {
  2627. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2628. "method": "GET",
  2629. "params": {
  2630. "owner": { "required": true, "type": "string" },
  2631. "page": { "type": "integer" },
  2632. "per_page": { "type": "integer" },
  2633. "repo": { "required": true, "type": "string" },
  2634. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  2635. },
  2636. "url": "/repos/:owner/:repo/projects"
  2637. },
  2638. "listForUser": {
  2639. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2640. "method": "GET",
  2641. "params": {
  2642. "page": { "type": "integer" },
  2643. "per_page": { "type": "integer" },
  2644. "state": { "enum": ["open", "closed", "all"], "type": "string" },
  2645. "username": { "required": true, "type": "string" }
  2646. },
  2647. "url": "/users/:username/projects"
  2648. },
  2649. "moveCard": {
  2650. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2651. "method": "POST",
  2652. "params": {
  2653. "card_id": { "required": true, "type": "integer" },
  2654. "column_id": { "type": "integer" },
  2655. "position": {
  2656. "required": true,
  2657. "type": "string",
  2658. "validation": "^(top|bottom|after:\\d+)$"
  2659. }
  2660. },
  2661. "url": "/projects/columns/cards/:card_id/moves"
  2662. },
  2663. "moveColumn": {
  2664. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2665. "method": "POST",
  2666. "params": {
  2667. "column_id": { "required": true, "type": "integer" },
  2668. "position": {
  2669. "required": true,
  2670. "type": "string",
  2671. "validation": "^(first|last|after:\\d+)$"
  2672. }
  2673. },
  2674. "url": "/projects/columns/:column_id/moves"
  2675. },
  2676. "removeCollaborator": {
  2677. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2678. "method": "DELETE",
  2679. "params": {
  2680. "project_id": { "required": true, "type": "integer" },
  2681. "username": { "required": true, "type": "string" }
  2682. },
  2683. "url": "/projects/:project_id/collaborators/:username"
  2684. },
  2685. "reviewUserPermissionLevel": {
  2686. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2687. "method": "GET",
  2688. "params": {
  2689. "project_id": { "required": true, "type": "integer" },
  2690. "username": { "required": true, "type": "string" }
  2691. },
  2692. "url": "/projects/:project_id/collaborators/:username/permission"
  2693. },
  2694. "update": {
  2695. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2696. "method": "PATCH",
  2697. "params": {
  2698. "body": { "type": "string" },
  2699. "name": { "type": "string" },
  2700. "organization_permission": { "type": "string" },
  2701. "private": { "type": "boolean" },
  2702. "project_id": { "required": true, "type": "integer" },
  2703. "state": { "enum": ["open", "closed"], "type": "string" }
  2704. },
  2705. "url": "/projects/:project_id"
  2706. },
  2707. "updateCard": {
  2708. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2709. "method": "PATCH",
  2710. "params": {
  2711. "archived": { "type": "boolean" },
  2712. "card_id": { "required": true, "type": "integer" },
  2713. "note": { "type": "string" }
  2714. },
  2715. "url": "/projects/columns/cards/:card_id"
  2716. },
  2717. "updateColumn": {
  2718. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  2719. "method": "PATCH",
  2720. "params": {
  2721. "column_id": { "required": true, "type": "integer" },
  2722. "name": { "required": true, "type": "string" }
  2723. },
  2724. "url": "/projects/columns/:column_id"
  2725. }
  2726. },
  2727. "pulls": {
  2728. "checkIfMerged": {
  2729. "method": "GET",
  2730. "params": {
  2731. "number": {
  2732. "alias": "pull_number",
  2733. "deprecated": true,
  2734. "type": "integer"
  2735. },
  2736. "owner": { "required": true, "type": "string" },
  2737. "pull_number": { "required": true, "type": "integer" },
  2738. "repo": { "required": true, "type": "string" }
  2739. },
  2740. "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
  2741. },
  2742. "create": {
  2743. "method": "POST",
  2744. "params": {
  2745. "base": { "required": true, "type": "string" },
  2746. "body": { "type": "string" },
  2747. "draft": { "type": "boolean" },
  2748. "head": { "required": true, "type": "string" },
  2749. "maintainer_can_modify": { "type": "boolean" },
  2750. "owner": { "required": true, "type": "string" },
  2751. "repo": { "required": true, "type": "string" },
  2752. "title": { "required": true, "type": "string" }
  2753. },
  2754. "url": "/repos/:owner/:repo/pulls"
  2755. },
  2756. "createComment": {
  2757. "method": "POST",
  2758. "params": {
  2759. "body": { "required": true, "type": "string" },
  2760. "commit_id": { "required": true, "type": "string" },
  2761. "in_reply_to": {
  2762. "deprecated": true,
  2763. "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.",
  2764. "type": "integer"
  2765. },
  2766. "number": {
  2767. "alias": "pull_number",
  2768. "deprecated": true,
  2769. "type": "integer"
  2770. },
  2771. "owner": { "required": true, "type": "string" },
  2772. "path": { "required": true, "type": "string" },
  2773. "position": { "required": true, "type": "integer" },
  2774. "pull_number": { "required": true, "type": "integer" },
  2775. "repo": { "required": true, "type": "string" }
  2776. },
  2777. "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
  2778. },
  2779. "createCommentReply": {
  2780. "deprecated": "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)",
  2781. "method": "POST",
  2782. "params": {
  2783. "body": { "required": true, "type": "string" },
  2784. "commit_id": { "required": true, "type": "string" },
  2785. "in_reply_to": {
  2786. "deprecated": true,
  2787. "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.",
  2788. "type": "integer"
  2789. },
  2790. "number": {
  2791. "alias": "pull_number",
  2792. "deprecated": true,
  2793. "type": "integer"
  2794. },
  2795. "owner": { "required": true, "type": "string" },
  2796. "path": { "required": true, "type": "string" },
  2797. "position": { "required": true, "type": "integer" },
  2798. "pull_number": { "required": true, "type": "integer" },
  2799. "repo": { "required": true, "type": "string" }
  2800. },
  2801. "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
  2802. },
  2803. "createFromIssue": {
  2804. "deprecated": "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request",
  2805. "method": "POST",
  2806. "params": {
  2807. "base": { "required": true, "type": "string" },
  2808. "head": { "required": true, "type": "string" },
  2809. "issue": { "required": true, "type": "integer" },
  2810. "maintainer_can_modify": { "type": "boolean" },
  2811. "owner": { "required": true, "type": "string" },
  2812. "repo": { "required": true, "type": "string" }
  2813. },
  2814. "url": "/repos/:owner/:repo/pulls"
  2815. },
  2816. "createReview": {
  2817. "method": "POST",
  2818. "params": {
  2819. "body": { "type": "string" },
  2820. "comments": { "type": "object[]" },
  2821. "comments[].body": { "required": true, "type": "string" },
  2822. "comments[].path": { "required": true, "type": "string" },
  2823. "comments[].position": { "required": true, "type": "integer" },
  2824. "commit_id": { "type": "string" },
  2825. "event": {
  2826. "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  2827. "type": "string"
  2828. },
  2829. "number": {
  2830. "alias": "pull_number",
  2831. "deprecated": true,
  2832. "type": "integer"
  2833. },
  2834. "owner": { "required": true, "type": "string" },
  2835. "pull_number": { "required": true, "type": "integer" },
  2836. "repo": { "required": true, "type": "string" }
  2837. },
  2838. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
  2839. },
  2840. "createReviewCommentReply": {
  2841. "method": "POST",
  2842. "params": {
  2843. "body": { "required": true, "type": "string" },
  2844. "comment_id": { "required": true, "type": "integer" },
  2845. "owner": { "required": true, "type": "string" },
  2846. "pull_number": { "required": true, "type": "integer" },
  2847. "repo": { "required": true, "type": "string" }
  2848. },
  2849. "url": "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"
  2850. },
  2851. "createReviewRequest": {
  2852. "method": "POST",
  2853. "params": {
  2854. "number": {
  2855. "alias": "pull_number",
  2856. "deprecated": true,
  2857. "type": "integer"
  2858. },
  2859. "owner": { "required": true, "type": "string" },
  2860. "pull_number": { "required": true, "type": "integer" },
  2861. "repo": { "required": true, "type": "string" },
  2862. "reviewers": { "type": "string[]" },
  2863. "team_reviewers": { "type": "string[]" }
  2864. },
  2865. "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  2866. },
  2867. "deleteComment": {
  2868. "method": "DELETE",
  2869. "params": {
  2870. "comment_id": { "required": true, "type": "integer" },
  2871. "owner": { "required": true, "type": "string" },
  2872. "repo": { "required": true, "type": "string" }
  2873. },
  2874. "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
  2875. },
  2876. "deletePendingReview": {
  2877. "method": "DELETE",
  2878. "params": {
  2879. "number": {
  2880. "alias": "pull_number",
  2881. "deprecated": true,
  2882. "type": "integer"
  2883. },
  2884. "owner": { "required": true, "type": "string" },
  2885. "pull_number": { "required": true, "type": "integer" },
  2886. "repo": { "required": true, "type": "string" },
  2887. "review_id": { "required": true, "type": "integer" }
  2888. },
  2889. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  2890. },
  2891. "deleteReviewRequest": {
  2892. "method": "DELETE",
  2893. "params": {
  2894. "number": {
  2895. "alias": "pull_number",
  2896. "deprecated": true,
  2897. "type": "integer"
  2898. },
  2899. "owner": { "required": true, "type": "string" },
  2900. "pull_number": { "required": true, "type": "integer" },
  2901. "repo": { "required": true, "type": "string" },
  2902. "reviewers": { "type": "string[]" },
  2903. "team_reviewers": { "type": "string[]" }
  2904. },
  2905. "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  2906. },
  2907. "dismissReview": {
  2908. "method": "PUT",
  2909. "params": {
  2910. "message": { "required": true, "type": "string" },
  2911. "number": {
  2912. "alias": "pull_number",
  2913. "deprecated": true,
  2914. "type": "integer"
  2915. },
  2916. "owner": { "required": true, "type": "string" },
  2917. "pull_number": { "required": true, "type": "integer" },
  2918. "repo": { "required": true, "type": "string" },
  2919. "review_id": { "required": true, "type": "integer" }
  2920. },
  2921. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"
  2922. },
  2923. "get": {
  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. "pull_number": { "required": true, "type": "integer" },
  2933. "repo": { "required": true, "type": "string" }
  2934. },
  2935. "url": "/repos/:owner/:repo/pulls/:pull_number"
  2936. },
  2937. "getComment": {
  2938. "method": "GET",
  2939. "params": {
  2940. "comment_id": { "required": true, "type": "integer" },
  2941. "owner": { "required": true, "type": "string" },
  2942. "repo": { "required": true, "type": "string" }
  2943. },
  2944. "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
  2945. },
  2946. "getCommentsForReview": {
  2947. "method": "GET",
  2948. "params": {
  2949. "number": {
  2950. "alias": "pull_number",
  2951. "deprecated": true,
  2952. "type": "integer"
  2953. },
  2954. "owner": { "required": true, "type": "string" },
  2955. "page": { "type": "integer" },
  2956. "per_page": { "type": "integer" },
  2957. "pull_number": { "required": true, "type": "integer" },
  2958. "repo": { "required": true, "type": "string" },
  2959. "review_id": { "required": true, "type": "integer" }
  2960. },
  2961. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"
  2962. },
  2963. "getReview": {
  2964. "method": "GET",
  2965. "params": {
  2966. "number": {
  2967. "alias": "pull_number",
  2968. "deprecated": true,
  2969. "type": "integer"
  2970. },
  2971. "owner": { "required": true, "type": "string" },
  2972. "pull_number": { "required": true, "type": "integer" },
  2973. "repo": { "required": true, "type": "string" },
  2974. "review_id": { "required": true, "type": "integer" }
  2975. },
  2976. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  2977. },
  2978. "list": {
  2979. "method": "GET",
  2980. "params": {
  2981. "base": { "type": "string" },
  2982. "direction": { "enum": ["asc", "desc"], "type": "string" },
  2983. "head": { "type": "string" },
  2984. "owner": { "required": true, "type": "string" },
  2985. "page": { "type": "integer" },
  2986. "per_page": { "type": "integer" },
  2987. "repo": { "required": true, "type": "string" },
  2988. "sort": {
  2989. "enum": ["created", "updated", "popularity", "long-running"],
  2990. "type": "string"
  2991. },
  2992. "state": { "enum": ["open", "closed", "all"], "type": "string" }
  2993. },
  2994. "url": "/repos/:owner/:repo/pulls"
  2995. },
  2996. "listComments": {
  2997. "method": "GET",
  2998. "params": {
  2999. "direction": { "enum": ["asc", "desc"], "type": "string" },
  3000. "number": {
  3001. "alias": "pull_number",
  3002. "deprecated": true,
  3003. "type": "integer"
  3004. },
  3005. "owner": { "required": true, "type": "string" },
  3006. "page": { "type": "integer" },
  3007. "per_page": { "type": "integer" },
  3008. "pull_number": { "required": true, "type": "integer" },
  3009. "repo": { "required": true, "type": "string" },
  3010. "since": { "type": "string" },
  3011. "sort": { "enum": ["created", "updated"], "type": "string" }
  3012. },
  3013. "url": "/repos/:owner/:repo/pulls/:pull_number/comments"
  3014. },
  3015. "listCommentsForRepo": {
  3016. "method": "GET",
  3017. "params": {
  3018. "direction": { "enum": ["asc", "desc"], "type": "string" },
  3019. "owner": { "required": true, "type": "string" },
  3020. "page": { "type": "integer" },
  3021. "per_page": { "type": "integer" },
  3022. "repo": { "required": true, "type": "string" },
  3023. "since": { "type": "string" },
  3024. "sort": { "enum": ["created", "updated"], "type": "string" }
  3025. },
  3026. "url": "/repos/:owner/:repo/pulls/comments"
  3027. },
  3028. "listCommits": {
  3029. "method": "GET",
  3030. "params": {
  3031. "number": {
  3032. "alias": "pull_number",
  3033. "deprecated": true,
  3034. "type": "integer"
  3035. },
  3036. "owner": { "required": true, "type": "string" },
  3037. "page": { "type": "integer" },
  3038. "per_page": { "type": "integer" },
  3039. "pull_number": { "required": true, "type": "integer" },
  3040. "repo": { "required": true, "type": "string" }
  3041. },
  3042. "url": "/repos/:owner/:repo/pulls/:pull_number/commits"
  3043. },
  3044. "listFiles": {
  3045. "method": "GET",
  3046. "params": {
  3047. "number": {
  3048. "alias": "pull_number",
  3049. "deprecated": true,
  3050. "type": "integer"
  3051. },
  3052. "owner": { "required": true, "type": "string" },
  3053. "page": { "type": "integer" },
  3054. "per_page": { "type": "integer" },
  3055. "pull_number": { "required": true, "type": "integer" },
  3056. "repo": { "required": true, "type": "string" }
  3057. },
  3058. "url": "/repos/:owner/:repo/pulls/:pull_number/files"
  3059. },
  3060. "listReviewRequests": {
  3061. "method": "GET",
  3062. "params": {
  3063. "number": {
  3064. "alias": "pull_number",
  3065. "deprecated": true,
  3066. "type": "integer"
  3067. },
  3068. "owner": { "required": true, "type": "string" },
  3069. "page": { "type": "integer" },
  3070. "per_page": { "type": "integer" },
  3071. "pull_number": { "required": true, "type": "integer" },
  3072. "repo": { "required": true, "type": "string" }
  3073. },
  3074. "url": "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
  3075. },
  3076. "listReviews": {
  3077. "method": "GET",
  3078. "params": {
  3079. "number": {
  3080. "alias": "pull_number",
  3081. "deprecated": true,
  3082. "type": "integer"
  3083. },
  3084. "owner": { "required": true, "type": "string" },
  3085. "page": { "type": "integer" },
  3086. "per_page": { "type": "integer" },
  3087. "pull_number": { "required": true, "type": "integer" },
  3088. "repo": { "required": true, "type": "string" }
  3089. },
  3090. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews"
  3091. },
  3092. "merge": {
  3093. "method": "PUT",
  3094. "params": {
  3095. "commit_message": { "type": "string" },
  3096. "commit_title": { "type": "string" },
  3097. "merge_method": {
  3098. "enum": ["merge", "squash", "rebase"],
  3099. "type": "string"
  3100. },
  3101. "number": {
  3102. "alias": "pull_number",
  3103. "deprecated": true,
  3104. "type": "integer"
  3105. },
  3106. "owner": { "required": true, "type": "string" },
  3107. "pull_number": { "required": true, "type": "integer" },
  3108. "repo": { "required": true, "type": "string" },
  3109. "sha": { "type": "string" }
  3110. },
  3111. "url": "/repos/:owner/:repo/pulls/:pull_number/merge"
  3112. },
  3113. "submitReview": {
  3114. "method": "POST",
  3115. "params": {
  3116. "body": { "type": "string" },
  3117. "event": {
  3118. "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  3119. "required": true,
  3120. "type": "string"
  3121. },
  3122. "number": {
  3123. "alias": "pull_number",
  3124. "deprecated": true,
  3125. "type": "integer"
  3126. },
  3127. "owner": { "required": true, "type": "string" },
  3128. "pull_number": { "required": true, "type": "integer" },
  3129. "repo": { "required": true, "type": "string" },
  3130. "review_id": { "required": true, "type": "integer" }
  3131. },
  3132. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"
  3133. },
  3134. "update": {
  3135. "method": "PATCH",
  3136. "params": {
  3137. "base": { "type": "string" },
  3138. "body": { "type": "string" },
  3139. "maintainer_can_modify": { "type": "boolean" },
  3140. "number": {
  3141. "alias": "pull_number",
  3142. "deprecated": true,
  3143. "type": "integer"
  3144. },
  3145. "owner": { "required": true, "type": "string" },
  3146. "pull_number": { "required": true, "type": "integer" },
  3147. "repo": { "required": true, "type": "string" },
  3148. "state": { "enum": ["open", "closed"], "type": "string" },
  3149. "title": { "type": "string" }
  3150. },
  3151. "url": "/repos/:owner/:repo/pulls/:pull_number"
  3152. },
  3153. "updateBranch": {
  3154. "headers": { "accept": "application/vnd.github.lydian-preview+json" },
  3155. "method": "PUT",
  3156. "params": {
  3157. "expected_head_sha": { "type": "string" },
  3158. "owner": { "required": true, "type": "string" },
  3159. "pull_number": { "required": true, "type": "integer" },
  3160. "repo": { "required": true, "type": "string" }
  3161. },
  3162. "url": "/repos/:owner/:repo/pulls/:pull_number/update-branch"
  3163. },
  3164. "updateComment": {
  3165. "method": "PATCH",
  3166. "params": {
  3167. "body": { "required": true, "type": "string" },
  3168. "comment_id": { "required": true, "type": "integer" },
  3169. "owner": { "required": true, "type": "string" },
  3170. "repo": { "required": true, "type": "string" }
  3171. },
  3172. "url": "/repos/:owner/:repo/pulls/comments/:comment_id"
  3173. },
  3174. "updateReview": {
  3175. "method": "PUT",
  3176. "params": {
  3177. "body": { "required": true, "type": "string" },
  3178. "number": {
  3179. "alias": "pull_number",
  3180. "deprecated": true,
  3181. "type": "integer"
  3182. },
  3183. "owner": { "required": true, "type": "string" },
  3184. "pull_number": { "required": true, "type": "integer" },
  3185. "repo": { "required": true, "type": "string" },
  3186. "review_id": { "required": true, "type": "integer" }
  3187. },
  3188. "url": "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
  3189. }
  3190. },
  3191. "rateLimit": {
  3192. "get": { "method": "GET", "params": {}, "url": "/rate_limit" }
  3193. },
  3194. "reactions": {
  3195. "createForCommitComment": {
  3196. "headers": {
  3197. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3198. },
  3199. "method": "POST",
  3200. "params": {
  3201. "comment_id": { "required": true, "type": "integer" },
  3202. "content": {
  3203. "enum": [
  3204. "+1",
  3205. "-1",
  3206. "laugh",
  3207. "confused",
  3208. "heart",
  3209. "hooray",
  3210. "rocket",
  3211. "eyes"
  3212. ],
  3213. "required": true,
  3214. "type": "string"
  3215. },
  3216. "owner": { "required": true, "type": "string" },
  3217. "repo": { "required": true, "type": "string" }
  3218. },
  3219. "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
  3220. },
  3221. "createForIssue": {
  3222. "headers": {
  3223. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3224. },
  3225. "method": "POST",
  3226. "params": {
  3227. "content": {
  3228. "enum": [
  3229. "+1",
  3230. "-1",
  3231. "laugh",
  3232. "confused",
  3233. "heart",
  3234. "hooray",
  3235. "rocket",
  3236. "eyes"
  3237. ],
  3238. "required": true,
  3239. "type": "string"
  3240. },
  3241. "issue_number": { "required": true, "type": "integer" },
  3242. "number": {
  3243. "alias": "issue_number",
  3244. "deprecated": true,
  3245. "type": "integer"
  3246. },
  3247. "owner": { "required": true, "type": "string" },
  3248. "repo": { "required": true, "type": "string" }
  3249. },
  3250. "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
  3251. },
  3252. "createForIssueComment": {
  3253. "headers": {
  3254. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3255. },
  3256. "method": "POST",
  3257. "params": {
  3258. "comment_id": { "required": true, "type": "integer" },
  3259. "content": {
  3260. "enum": [
  3261. "+1",
  3262. "-1",
  3263. "laugh",
  3264. "confused",
  3265. "heart",
  3266. "hooray",
  3267. "rocket",
  3268. "eyes"
  3269. ],
  3270. "required": true,
  3271. "type": "string"
  3272. },
  3273. "owner": { "required": true, "type": "string" },
  3274. "repo": { "required": true, "type": "string" }
  3275. },
  3276. "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
  3277. },
  3278. "createForPullRequestReviewComment": {
  3279. "headers": {
  3280. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3281. },
  3282. "method": "POST",
  3283. "params": {
  3284. "comment_id": { "required": true, "type": "integer" },
  3285. "content": {
  3286. "enum": [
  3287. "+1",
  3288. "-1",
  3289. "laugh",
  3290. "confused",
  3291. "heart",
  3292. "hooray",
  3293. "rocket",
  3294. "eyes"
  3295. ],
  3296. "required": true,
  3297. "type": "string"
  3298. },
  3299. "owner": { "required": true, "type": "string" },
  3300. "repo": { "required": true, "type": "string" }
  3301. },
  3302. "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
  3303. },
  3304. "createForTeamDiscussion": {
  3305. "headers": {
  3306. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3307. },
  3308. "method": "POST",
  3309. "params": {
  3310. "content": {
  3311. "enum": [
  3312. "+1",
  3313. "-1",
  3314. "laugh",
  3315. "confused",
  3316. "heart",
  3317. "hooray",
  3318. "rocket",
  3319. "eyes"
  3320. ],
  3321. "required": true,
  3322. "type": "string"
  3323. },
  3324. "discussion_number": { "required": true, "type": "integer" },
  3325. "team_id": { "required": true, "type": "integer" }
  3326. },
  3327. "url": "/teams/:team_id/discussions/:discussion_number/reactions"
  3328. },
  3329. "createForTeamDiscussionComment": {
  3330. "headers": {
  3331. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3332. },
  3333. "method": "POST",
  3334. "params": {
  3335. "comment_number": { "required": true, "type": "integer" },
  3336. "content": {
  3337. "enum": [
  3338. "+1",
  3339. "-1",
  3340. "laugh",
  3341. "confused",
  3342. "heart",
  3343. "hooray",
  3344. "rocket",
  3345. "eyes"
  3346. ],
  3347. "required": true,
  3348. "type": "string"
  3349. },
  3350. "discussion_number": { "required": true, "type": "integer" },
  3351. "team_id": { "required": true, "type": "integer" }
  3352. },
  3353. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  3354. },
  3355. "delete": {
  3356. "headers": {
  3357. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3358. },
  3359. "method": "DELETE",
  3360. "params": { "reaction_id": { "required": true, "type": "integer" } },
  3361. "url": "/reactions/:reaction_id"
  3362. },
  3363. "listForCommitComment": {
  3364. "headers": {
  3365. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3366. },
  3367. "method": "GET",
  3368. "params": {
  3369. "comment_id": { "required": true, "type": "integer" },
  3370. "content": {
  3371. "enum": [
  3372. "+1",
  3373. "-1",
  3374. "laugh",
  3375. "confused",
  3376. "heart",
  3377. "hooray",
  3378. "rocket",
  3379. "eyes"
  3380. ],
  3381. "type": "string"
  3382. },
  3383. "owner": { "required": true, "type": "string" },
  3384. "page": { "type": "integer" },
  3385. "per_page": { "type": "integer" },
  3386. "repo": { "required": true, "type": "string" }
  3387. },
  3388. "url": "/repos/:owner/:repo/comments/:comment_id/reactions"
  3389. },
  3390. "listForIssue": {
  3391. "headers": {
  3392. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3393. },
  3394. "method": "GET",
  3395. "params": {
  3396. "content": {
  3397. "enum": [
  3398. "+1",
  3399. "-1",
  3400. "laugh",
  3401. "confused",
  3402. "heart",
  3403. "hooray",
  3404. "rocket",
  3405. "eyes"
  3406. ],
  3407. "type": "string"
  3408. },
  3409. "issue_number": { "required": true, "type": "integer" },
  3410. "number": {
  3411. "alias": "issue_number",
  3412. "deprecated": true,
  3413. "type": "integer"
  3414. },
  3415. "owner": { "required": true, "type": "string" },
  3416. "page": { "type": "integer" },
  3417. "per_page": { "type": "integer" },
  3418. "repo": { "required": true, "type": "string" }
  3419. },
  3420. "url": "/repos/:owner/:repo/issues/:issue_number/reactions"
  3421. },
  3422. "listForIssueComment": {
  3423. "headers": {
  3424. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3425. },
  3426. "method": "GET",
  3427. "params": {
  3428. "comment_id": { "required": true, "type": "integer" },
  3429. "content": {
  3430. "enum": [
  3431. "+1",
  3432. "-1",
  3433. "laugh",
  3434. "confused",
  3435. "heart",
  3436. "hooray",
  3437. "rocket",
  3438. "eyes"
  3439. ],
  3440. "type": "string"
  3441. },
  3442. "owner": { "required": true, "type": "string" },
  3443. "page": { "type": "integer" },
  3444. "per_page": { "type": "integer" },
  3445. "repo": { "required": true, "type": "string" }
  3446. },
  3447. "url": "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
  3448. },
  3449. "listForPullRequestReviewComment": {
  3450. "headers": {
  3451. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3452. },
  3453. "method": "GET",
  3454. "params": {
  3455. "comment_id": { "required": true, "type": "integer" },
  3456. "content": {
  3457. "enum": [
  3458. "+1",
  3459. "-1",
  3460. "laugh",
  3461. "confused",
  3462. "heart",
  3463. "hooray",
  3464. "rocket",
  3465. "eyes"
  3466. ],
  3467. "type": "string"
  3468. },
  3469. "owner": { "required": true, "type": "string" },
  3470. "page": { "type": "integer" },
  3471. "per_page": { "type": "integer" },
  3472. "repo": { "required": true, "type": "string" }
  3473. },
  3474. "url": "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
  3475. },
  3476. "listForTeamDiscussion": {
  3477. "headers": {
  3478. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3479. },
  3480. "method": "GET",
  3481. "params": {
  3482. "content": {
  3483. "enum": [
  3484. "+1",
  3485. "-1",
  3486. "laugh",
  3487. "confused",
  3488. "heart",
  3489. "hooray",
  3490. "rocket",
  3491. "eyes"
  3492. ],
  3493. "type": "string"
  3494. },
  3495. "discussion_number": { "required": true, "type": "integer" },
  3496. "page": { "type": "integer" },
  3497. "per_page": { "type": "integer" },
  3498. "team_id": { "required": true, "type": "integer" }
  3499. },
  3500. "url": "/teams/:team_id/discussions/:discussion_number/reactions"
  3501. },
  3502. "listForTeamDiscussionComment": {
  3503. "headers": {
  3504. "accept": "application/vnd.github.squirrel-girl-preview+json"
  3505. },
  3506. "method": "GET",
  3507. "params": {
  3508. "comment_number": { "required": true, "type": "integer" },
  3509. "content": {
  3510. "enum": [
  3511. "+1",
  3512. "-1",
  3513. "laugh",
  3514. "confused",
  3515. "heart",
  3516. "hooray",
  3517. "rocket",
  3518. "eyes"
  3519. ],
  3520. "type": "string"
  3521. },
  3522. "discussion_number": { "required": true, "type": "integer" },
  3523. "page": { "type": "integer" },
  3524. "per_page": { "type": "integer" },
  3525. "team_id": { "required": true, "type": "integer" }
  3526. },
  3527. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
  3528. }
  3529. },
  3530. "repos": {
  3531. "acceptInvitation": {
  3532. "method": "PATCH",
  3533. "params": { "invitation_id": { "required": true, "type": "integer" } },
  3534. "url": "/user/repository_invitations/:invitation_id"
  3535. },
  3536. "addCollaborator": {
  3537. "method": "PUT",
  3538. "params": {
  3539. "owner": { "required": true, "type": "string" },
  3540. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  3541. "repo": { "required": true, "type": "string" },
  3542. "username": { "required": true, "type": "string" }
  3543. },
  3544. "url": "/repos/:owner/:repo/collaborators/:username"
  3545. },
  3546. "addDeployKey": {
  3547. "method": "POST",
  3548. "params": {
  3549. "key": { "required": true, "type": "string" },
  3550. "owner": { "required": true, "type": "string" },
  3551. "read_only": { "type": "boolean" },
  3552. "repo": { "required": true, "type": "string" },
  3553. "title": { "type": "string" }
  3554. },
  3555. "url": "/repos/:owner/:repo/keys"
  3556. },
  3557. "addProtectedBranchAdminEnforcement": {
  3558. "method": "POST",
  3559. "params": {
  3560. "branch": { "required": true, "type": "string" },
  3561. "owner": { "required": true, "type": "string" },
  3562. "repo": { "required": true, "type": "string" }
  3563. },
  3564. "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  3565. },
  3566. "addProtectedBranchAppRestrictions": {
  3567. "method": "POST",
  3568. "params": {
  3569. "apps": { "mapTo": "data", "required": true, "type": "string[]" },
  3570. "branch": { "required": true, "type": "string" },
  3571. "owner": { "required": true, "type": "string" },
  3572. "repo": { "required": true, "type": "string" }
  3573. },
  3574. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  3575. },
  3576. "addProtectedBranchRequiredSignatures": {
  3577. "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
  3578. "method": "POST",
  3579. "params": {
  3580. "branch": { "required": true, "type": "string" },
  3581. "owner": { "required": true, "type": "string" },
  3582. "repo": { "required": true, "type": "string" }
  3583. },
  3584. "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  3585. },
  3586. "addProtectedBranchRequiredStatusChecksContexts": {
  3587. "method": "POST",
  3588. "params": {
  3589. "branch": { "required": true, "type": "string" },
  3590. "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
  3591. "owner": { "required": true, "type": "string" },
  3592. "repo": { "required": true, "type": "string" }
  3593. },
  3594. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  3595. },
  3596. "addProtectedBranchTeamRestrictions": {
  3597. "method": "POST",
  3598. "params": {
  3599. "branch": { "required": true, "type": "string" },
  3600. "owner": { "required": true, "type": "string" },
  3601. "repo": { "required": true, "type": "string" },
  3602. "teams": { "mapTo": "data", "required": true, "type": "string[]" }
  3603. },
  3604. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  3605. },
  3606. "addProtectedBranchUserRestrictions": {
  3607. "method": "POST",
  3608. "params": {
  3609. "branch": { "required": true, "type": "string" },
  3610. "owner": { "required": true, "type": "string" },
  3611. "repo": { "required": true, "type": "string" },
  3612. "users": { "mapTo": "data", "required": true, "type": "string[]" }
  3613. },
  3614. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  3615. },
  3616. "checkCollaborator": {
  3617. "method": "GET",
  3618. "params": {
  3619. "owner": { "required": true, "type": "string" },
  3620. "repo": { "required": true, "type": "string" },
  3621. "username": { "required": true, "type": "string" }
  3622. },
  3623. "url": "/repos/:owner/:repo/collaborators/:username"
  3624. },
  3625. "compareCommits": {
  3626. "method": "GET",
  3627. "params": {
  3628. "base": { "required": true, "type": "string" },
  3629. "head": { "required": true, "type": "string" },
  3630. "owner": { "required": true, "type": "string" },
  3631. "repo": { "required": true, "type": "string" }
  3632. },
  3633. "url": "/repos/:owner/:repo/compare/:base...:head"
  3634. },
  3635. "createCommitComment": {
  3636. "method": "POST",
  3637. "params": {
  3638. "body": { "required": true, "type": "string" },
  3639. "commit_sha": { "required": true, "type": "string" },
  3640. "line": { "type": "integer" },
  3641. "owner": { "required": true, "type": "string" },
  3642. "path": { "type": "string" },
  3643. "position": { "type": "integer" },
  3644. "repo": { "required": true, "type": "string" },
  3645. "sha": { "alias": "commit_sha", "deprecated": true, "type": "string" }
  3646. },
  3647. "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
  3648. },
  3649. "createDeployment": {
  3650. "method": "POST",
  3651. "params": {
  3652. "auto_merge": { "type": "boolean" },
  3653. "description": { "type": "string" },
  3654. "environment": { "type": "string" },
  3655. "owner": { "required": true, "type": "string" },
  3656. "payload": { "type": "string" },
  3657. "production_environment": { "type": "boolean" },
  3658. "ref": { "required": true, "type": "string" },
  3659. "repo": { "required": true, "type": "string" },
  3660. "required_contexts": { "type": "string[]" },
  3661. "task": { "type": "string" },
  3662. "transient_environment": { "type": "boolean" }
  3663. },
  3664. "url": "/repos/:owner/:repo/deployments"
  3665. },
  3666. "createDeploymentStatus": {
  3667. "method": "POST",
  3668. "params": {
  3669. "auto_inactive": { "type": "boolean" },
  3670. "deployment_id": { "required": true, "type": "integer" },
  3671. "description": { "type": "string" },
  3672. "environment": {
  3673. "enum": ["production", "staging", "qa"],
  3674. "type": "string"
  3675. },
  3676. "environment_url": { "type": "string" },
  3677. "log_url": { "type": "string" },
  3678. "owner": { "required": true, "type": "string" },
  3679. "repo": { "required": true, "type": "string" },
  3680. "state": {
  3681. "enum": [
  3682. "error",
  3683. "failure",
  3684. "inactive",
  3685. "in_progress",
  3686. "queued",
  3687. "pending",
  3688. "success"
  3689. ],
  3690. "required": true,
  3691. "type": "string"
  3692. },
  3693. "target_url": { "type": "string" }
  3694. },
  3695. "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
  3696. },
  3697. "createFile": {
  3698. "deprecated": "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
  3699. "method": "PUT",
  3700. "params": {
  3701. "author": { "type": "object" },
  3702. "author.email": { "required": true, "type": "string" },
  3703. "author.name": { "required": true, "type": "string" },
  3704. "branch": { "type": "string" },
  3705. "committer": { "type": "object" },
  3706. "committer.email": { "required": true, "type": "string" },
  3707. "committer.name": { "required": true, "type": "string" },
  3708. "content": { "required": true, "type": "string" },
  3709. "message": { "required": true, "type": "string" },
  3710. "owner": { "required": true, "type": "string" },
  3711. "path": { "required": true, "type": "string" },
  3712. "repo": { "required": true, "type": "string" },
  3713. "sha": { "type": "string" }
  3714. },
  3715. "url": "/repos/:owner/:repo/contents/:path"
  3716. },
  3717. "createForAuthenticatedUser": {
  3718. "method": "POST",
  3719. "params": {
  3720. "allow_merge_commit": { "type": "boolean" },
  3721. "allow_rebase_merge": { "type": "boolean" },
  3722. "allow_squash_merge": { "type": "boolean" },
  3723. "auto_init": { "type": "boolean" },
  3724. "description": { "type": "string" },
  3725. "gitignore_template": { "type": "string" },
  3726. "has_issues": { "type": "boolean" },
  3727. "has_projects": { "type": "boolean" },
  3728. "has_wiki": { "type": "boolean" },
  3729. "homepage": { "type": "string" },
  3730. "is_template": { "type": "boolean" },
  3731. "license_template": { "type": "string" },
  3732. "name": { "required": true, "type": "string" },
  3733. "private": { "type": "boolean" },
  3734. "team_id": { "type": "integer" }
  3735. },
  3736. "url": "/user/repos"
  3737. },
  3738. "createFork": {
  3739. "method": "POST",
  3740. "params": {
  3741. "organization": { "type": "string" },
  3742. "owner": { "required": true, "type": "string" },
  3743. "repo": { "required": true, "type": "string" }
  3744. },
  3745. "url": "/repos/:owner/:repo/forks"
  3746. },
  3747. "createHook": {
  3748. "method": "POST",
  3749. "params": {
  3750. "active": { "type": "boolean" },
  3751. "config": { "required": true, "type": "object" },
  3752. "config.content_type": { "type": "string" },
  3753. "config.insecure_ssl": { "type": "string" },
  3754. "config.secret": { "type": "string" },
  3755. "config.url": { "required": true, "type": "string" },
  3756. "events": { "type": "string[]" },
  3757. "name": { "type": "string" },
  3758. "owner": { "required": true, "type": "string" },
  3759. "repo": { "required": true, "type": "string" }
  3760. },
  3761. "url": "/repos/:owner/:repo/hooks"
  3762. },
  3763. "createInOrg": {
  3764. "method": "POST",
  3765. "params": {
  3766. "allow_merge_commit": { "type": "boolean" },
  3767. "allow_rebase_merge": { "type": "boolean" },
  3768. "allow_squash_merge": { "type": "boolean" },
  3769. "auto_init": { "type": "boolean" },
  3770. "description": { "type": "string" },
  3771. "gitignore_template": { "type": "string" },
  3772. "has_issues": { "type": "boolean" },
  3773. "has_projects": { "type": "boolean" },
  3774. "has_wiki": { "type": "boolean" },
  3775. "homepage": { "type": "string" },
  3776. "is_template": { "type": "boolean" },
  3777. "license_template": { "type": "string" },
  3778. "name": { "required": true, "type": "string" },
  3779. "org": { "required": true, "type": "string" },
  3780. "private": { "type": "boolean" },
  3781. "team_id": { "type": "integer" }
  3782. },
  3783. "url": "/orgs/:org/repos"
  3784. },
  3785. "createOrUpdateFile": {
  3786. "method": "PUT",
  3787. "params": {
  3788. "author": { "type": "object" },
  3789. "author.email": { "required": true, "type": "string" },
  3790. "author.name": { "required": true, "type": "string" },
  3791. "branch": { "type": "string" },
  3792. "committer": { "type": "object" },
  3793. "committer.email": { "required": true, "type": "string" },
  3794. "committer.name": { "required": true, "type": "string" },
  3795. "content": { "required": true, "type": "string" },
  3796. "message": { "required": true, "type": "string" },
  3797. "owner": { "required": true, "type": "string" },
  3798. "path": { "required": true, "type": "string" },
  3799. "repo": { "required": true, "type": "string" },
  3800. "sha": { "type": "string" }
  3801. },
  3802. "url": "/repos/:owner/:repo/contents/:path"
  3803. },
  3804. "createRelease": {
  3805. "method": "POST",
  3806. "params": {
  3807. "body": { "type": "string" },
  3808. "draft": { "type": "boolean" },
  3809. "name": { "type": "string" },
  3810. "owner": { "required": true, "type": "string" },
  3811. "prerelease": { "type": "boolean" },
  3812. "repo": { "required": true, "type": "string" },
  3813. "tag_name": { "required": true, "type": "string" },
  3814. "target_commitish": { "type": "string" }
  3815. },
  3816. "url": "/repos/:owner/:repo/releases"
  3817. },
  3818. "createStatus": {
  3819. "method": "POST",
  3820. "params": {
  3821. "context": { "type": "string" },
  3822. "description": { "type": "string" },
  3823. "owner": { "required": true, "type": "string" },
  3824. "repo": { "required": true, "type": "string" },
  3825. "sha": { "required": true, "type": "string" },
  3826. "state": {
  3827. "enum": ["error", "failure", "pending", "success"],
  3828. "required": true,
  3829. "type": "string"
  3830. },
  3831. "target_url": { "type": "string" }
  3832. },
  3833. "url": "/repos/:owner/:repo/statuses/:sha"
  3834. },
  3835. "createUsingTemplate": {
  3836. "headers": { "accept": "application/vnd.github.baptiste-preview+json" },
  3837. "method": "POST",
  3838. "params": {
  3839. "description": { "type": "string" },
  3840. "name": { "required": true, "type": "string" },
  3841. "owner": { "type": "string" },
  3842. "private": { "type": "boolean" },
  3843. "template_owner": { "required": true, "type": "string" },
  3844. "template_repo": { "required": true, "type": "string" }
  3845. },
  3846. "url": "/repos/:template_owner/:template_repo/generate"
  3847. },
  3848. "declineInvitation": {
  3849. "method": "DELETE",
  3850. "params": { "invitation_id": { "required": true, "type": "integer" } },
  3851. "url": "/user/repository_invitations/:invitation_id"
  3852. },
  3853. "delete": {
  3854. "method": "DELETE",
  3855. "params": {
  3856. "owner": { "required": true, "type": "string" },
  3857. "repo": { "required": true, "type": "string" }
  3858. },
  3859. "url": "/repos/:owner/:repo"
  3860. },
  3861. "deleteCommitComment": {
  3862. "method": "DELETE",
  3863. "params": {
  3864. "comment_id": { "required": true, "type": "integer" },
  3865. "owner": { "required": true, "type": "string" },
  3866. "repo": { "required": true, "type": "string" }
  3867. },
  3868. "url": "/repos/:owner/:repo/comments/:comment_id"
  3869. },
  3870. "deleteDownload": {
  3871. "method": "DELETE",
  3872. "params": {
  3873. "download_id": { "required": true, "type": "integer" },
  3874. "owner": { "required": true, "type": "string" },
  3875. "repo": { "required": true, "type": "string" }
  3876. },
  3877. "url": "/repos/:owner/:repo/downloads/:download_id"
  3878. },
  3879. "deleteFile": {
  3880. "method": "DELETE",
  3881. "params": {
  3882. "author": { "type": "object" },
  3883. "author.email": { "type": "string" },
  3884. "author.name": { "type": "string" },
  3885. "branch": { "type": "string" },
  3886. "committer": { "type": "object" },
  3887. "committer.email": { "type": "string" },
  3888. "committer.name": { "type": "string" },
  3889. "message": { "required": true, "type": "string" },
  3890. "owner": { "required": true, "type": "string" },
  3891. "path": { "required": true, "type": "string" },
  3892. "repo": { "required": true, "type": "string" },
  3893. "sha": { "required": true, "type": "string" }
  3894. },
  3895. "url": "/repos/:owner/:repo/contents/:path"
  3896. },
  3897. "deleteHook": {
  3898. "method": "DELETE",
  3899. "params": {
  3900. "hook_id": { "required": true, "type": "integer" },
  3901. "owner": { "required": true, "type": "string" },
  3902. "repo": { "required": true, "type": "string" }
  3903. },
  3904. "url": "/repos/:owner/:repo/hooks/:hook_id"
  3905. },
  3906. "deleteInvitation": {
  3907. "method": "DELETE",
  3908. "params": {
  3909. "invitation_id": { "required": true, "type": "integer" },
  3910. "owner": { "required": true, "type": "string" },
  3911. "repo": { "required": true, "type": "string" }
  3912. },
  3913. "url": "/repos/:owner/:repo/invitations/:invitation_id"
  3914. },
  3915. "deleteRelease": {
  3916. "method": "DELETE",
  3917. "params": {
  3918. "owner": { "required": true, "type": "string" },
  3919. "release_id": { "required": true, "type": "integer" },
  3920. "repo": { "required": true, "type": "string" }
  3921. },
  3922. "url": "/repos/:owner/:repo/releases/:release_id"
  3923. },
  3924. "deleteReleaseAsset": {
  3925. "method": "DELETE",
  3926. "params": {
  3927. "asset_id": { "required": true, "type": "integer" },
  3928. "owner": { "required": true, "type": "string" },
  3929. "repo": { "required": true, "type": "string" }
  3930. },
  3931. "url": "/repos/:owner/:repo/releases/assets/:asset_id"
  3932. },
  3933. "disablePagesSite": {
  3934. "headers": { "accept": "application/vnd.github.switcheroo-preview+json" },
  3935. "method": "DELETE",
  3936. "params": {
  3937. "owner": { "required": true, "type": "string" },
  3938. "repo": { "required": true, "type": "string" }
  3939. },
  3940. "url": "/repos/:owner/:repo/pages"
  3941. },
  3942. "disableVulnerabilityAlerts": {
  3943. "headers": { "accept": "application/vnd.github.dorian-preview+json" },
  3944. "method": "DELETE",
  3945. "params": {
  3946. "owner": { "required": true, "type": "string" },
  3947. "repo": { "required": true, "type": "string" }
  3948. },
  3949. "url": "/repos/:owner/:repo/vulnerability-alerts"
  3950. },
  3951. "enablePagesSite": {
  3952. "headers": { "accept": "application/vnd.github.switcheroo-preview+json" },
  3953. "method": "POST",
  3954. "params": {
  3955. "owner": { "required": true, "type": "string" },
  3956. "repo": { "required": true, "type": "string" },
  3957. "source": { "type": "object" },
  3958. "source.branch": { "enum": ["master", "gh-pages"], "type": "string" },
  3959. "source.path": { "type": "string" }
  3960. },
  3961. "url": "/repos/:owner/:repo/pages"
  3962. },
  3963. "enableVulnerabilityAlerts": {
  3964. "headers": { "accept": "application/vnd.github.dorian-preview+json" },
  3965. "method": "PUT",
  3966. "params": {
  3967. "owner": { "required": true, "type": "string" },
  3968. "repo": { "required": true, "type": "string" }
  3969. },
  3970. "url": "/repos/:owner/:repo/vulnerability-alerts"
  3971. },
  3972. "get": {
  3973. "method": "GET",
  3974. "params": {
  3975. "owner": { "required": true, "type": "string" },
  3976. "repo": { "required": true, "type": "string" }
  3977. },
  3978. "url": "/repos/:owner/:repo"
  3979. },
  3980. "getAppsWithAccessToProtectedBranch": {
  3981. "method": "GET",
  3982. "params": {
  3983. "branch": { "required": true, "type": "string" },
  3984. "owner": { "required": true, "type": "string" },
  3985. "repo": { "required": true, "type": "string" }
  3986. },
  3987. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  3988. },
  3989. "getArchiveLink": {
  3990. "method": "GET",
  3991. "params": {
  3992. "archive_format": { "required": true, "type": "string" },
  3993. "owner": { "required": true, "type": "string" },
  3994. "ref": { "required": true, "type": "string" },
  3995. "repo": { "required": true, "type": "string" }
  3996. },
  3997. "url": "/repos/:owner/:repo/:archive_format/:ref"
  3998. },
  3999. "getBranch": {
  4000. "method": "GET",
  4001. "params": {
  4002. "branch": { "required": true, "type": "string" },
  4003. "owner": { "required": true, "type": "string" },
  4004. "repo": { "required": true, "type": "string" }
  4005. },
  4006. "url": "/repos/:owner/:repo/branches/:branch"
  4007. },
  4008. "getBranchProtection": {
  4009. "method": "GET",
  4010. "params": {
  4011. "branch": { "required": true, "type": "string" },
  4012. "owner": { "required": true, "type": "string" },
  4013. "repo": { "required": true, "type": "string" }
  4014. },
  4015. "url": "/repos/:owner/:repo/branches/:branch/protection"
  4016. },
  4017. "getCodeFrequencyStats": {
  4018. "method": "GET",
  4019. "params": {
  4020. "owner": { "required": true, "type": "string" },
  4021. "repo": { "required": true, "type": "string" }
  4022. },
  4023. "url": "/repos/:owner/:repo/stats/code_frequency"
  4024. },
  4025. "getCollaboratorPermissionLevel": {
  4026. "method": "GET",
  4027. "params": {
  4028. "owner": { "required": true, "type": "string" },
  4029. "repo": { "required": true, "type": "string" },
  4030. "username": { "required": true, "type": "string" }
  4031. },
  4032. "url": "/repos/:owner/:repo/collaborators/:username/permission"
  4033. },
  4034. "getCombinedStatusForRef": {
  4035. "method": "GET",
  4036. "params": {
  4037. "owner": { "required": true, "type": "string" },
  4038. "ref": { "required": true, "type": "string" },
  4039. "repo": { "required": true, "type": "string" }
  4040. },
  4041. "url": "/repos/:owner/:repo/commits/:ref/status"
  4042. },
  4043. "getCommit": {
  4044. "method": "GET",
  4045. "params": {
  4046. "commit_sha": { "alias": "ref", "deprecated": true, "type": "string" },
  4047. "owner": { "required": true, "type": "string" },
  4048. "ref": { "required": true, "type": "string" },
  4049. "repo": { "required": true, "type": "string" },
  4050. "sha": { "alias": "ref", "deprecated": true, "type": "string" }
  4051. },
  4052. "url": "/repos/:owner/:repo/commits/:ref"
  4053. },
  4054. "getCommitActivityStats": {
  4055. "method": "GET",
  4056. "params": {
  4057. "owner": { "required": true, "type": "string" },
  4058. "repo": { "required": true, "type": "string" }
  4059. },
  4060. "url": "/repos/:owner/:repo/stats/commit_activity"
  4061. },
  4062. "getCommitComment": {
  4063. "method": "GET",
  4064. "params": {
  4065. "comment_id": { "required": true, "type": "integer" },
  4066. "owner": { "required": true, "type": "string" },
  4067. "repo": { "required": true, "type": "string" }
  4068. },
  4069. "url": "/repos/:owner/:repo/comments/:comment_id"
  4070. },
  4071. "getCommitRefSha": {
  4072. "deprecated": "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit",
  4073. "headers": { "accept": "application/vnd.github.v3.sha" },
  4074. "method": "GET",
  4075. "params": {
  4076. "owner": { "required": true, "type": "string" },
  4077. "ref": { "required": true, "type": "string" },
  4078. "repo": { "required": true, "type": "string" }
  4079. },
  4080. "url": "/repos/:owner/:repo/commits/:ref"
  4081. },
  4082. "getContents": {
  4083. "method": "GET",
  4084. "params": {
  4085. "owner": { "required": true, "type": "string" },
  4086. "path": { "required": true, "type": "string" },
  4087. "ref": { "type": "string" },
  4088. "repo": { "required": true, "type": "string" }
  4089. },
  4090. "url": "/repos/:owner/:repo/contents/:path"
  4091. },
  4092. "getContributorsStats": {
  4093. "method": "GET",
  4094. "params": {
  4095. "owner": { "required": true, "type": "string" },
  4096. "repo": { "required": true, "type": "string" }
  4097. },
  4098. "url": "/repos/:owner/:repo/stats/contributors"
  4099. },
  4100. "getDeployKey": {
  4101. "method": "GET",
  4102. "params": {
  4103. "key_id": { "required": true, "type": "integer" },
  4104. "owner": { "required": true, "type": "string" },
  4105. "repo": { "required": true, "type": "string" }
  4106. },
  4107. "url": "/repos/:owner/:repo/keys/:key_id"
  4108. },
  4109. "getDeployment": {
  4110. "method": "GET",
  4111. "params": {
  4112. "deployment_id": { "required": true, "type": "integer" },
  4113. "owner": { "required": true, "type": "string" },
  4114. "repo": { "required": true, "type": "string" }
  4115. },
  4116. "url": "/repos/:owner/:repo/deployments/:deployment_id"
  4117. },
  4118. "getDeploymentStatus": {
  4119. "method": "GET",
  4120. "params": {
  4121. "deployment_id": { "required": true, "type": "integer" },
  4122. "owner": { "required": true, "type": "string" },
  4123. "repo": { "required": true, "type": "string" },
  4124. "status_id": { "required": true, "type": "integer" }
  4125. },
  4126. "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"
  4127. },
  4128. "getDownload": {
  4129. "method": "GET",
  4130. "params": {
  4131. "download_id": { "required": true, "type": "integer" },
  4132. "owner": { "required": true, "type": "string" },
  4133. "repo": { "required": true, "type": "string" }
  4134. },
  4135. "url": "/repos/:owner/:repo/downloads/:download_id"
  4136. },
  4137. "getHook": {
  4138. "method": "GET",
  4139. "params": {
  4140. "hook_id": { "required": true, "type": "integer" },
  4141. "owner": { "required": true, "type": "string" },
  4142. "repo": { "required": true, "type": "string" }
  4143. },
  4144. "url": "/repos/:owner/:repo/hooks/:hook_id"
  4145. },
  4146. "getLatestPagesBuild": {
  4147. "method": "GET",
  4148. "params": {
  4149. "owner": { "required": true, "type": "string" },
  4150. "repo": { "required": true, "type": "string" }
  4151. },
  4152. "url": "/repos/:owner/:repo/pages/builds/latest"
  4153. },
  4154. "getLatestRelease": {
  4155. "method": "GET",
  4156. "params": {
  4157. "owner": { "required": true, "type": "string" },
  4158. "repo": { "required": true, "type": "string" }
  4159. },
  4160. "url": "/repos/:owner/:repo/releases/latest"
  4161. },
  4162. "getPages": {
  4163. "method": "GET",
  4164. "params": {
  4165. "owner": { "required": true, "type": "string" },
  4166. "repo": { "required": true, "type": "string" }
  4167. },
  4168. "url": "/repos/:owner/:repo/pages"
  4169. },
  4170. "getPagesBuild": {
  4171. "method": "GET",
  4172. "params": {
  4173. "build_id": { "required": true, "type": "integer" },
  4174. "owner": { "required": true, "type": "string" },
  4175. "repo": { "required": true, "type": "string" }
  4176. },
  4177. "url": "/repos/:owner/:repo/pages/builds/:build_id"
  4178. },
  4179. "getParticipationStats": {
  4180. "method": "GET",
  4181. "params": {
  4182. "owner": { "required": true, "type": "string" },
  4183. "repo": { "required": true, "type": "string" }
  4184. },
  4185. "url": "/repos/:owner/:repo/stats/participation"
  4186. },
  4187. "getProtectedBranchAdminEnforcement": {
  4188. "method": "GET",
  4189. "params": {
  4190. "branch": { "required": true, "type": "string" },
  4191. "owner": { "required": true, "type": "string" },
  4192. "repo": { "required": true, "type": "string" }
  4193. },
  4194. "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  4195. },
  4196. "getProtectedBranchPullRequestReviewEnforcement": {
  4197. "method": "GET",
  4198. "params": {
  4199. "branch": { "required": true, "type": "string" },
  4200. "owner": { "required": true, "type": "string" },
  4201. "repo": { "required": true, "type": "string" }
  4202. },
  4203. "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  4204. },
  4205. "getProtectedBranchRequiredSignatures": {
  4206. "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
  4207. "method": "GET",
  4208. "params": {
  4209. "branch": { "required": true, "type": "string" },
  4210. "owner": { "required": true, "type": "string" },
  4211. "repo": { "required": true, "type": "string" }
  4212. },
  4213. "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  4214. },
  4215. "getProtectedBranchRequiredStatusChecks": {
  4216. "method": "GET",
  4217. "params": {
  4218. "branch": { "required": true, "type": "string" },
  4219. "owner": { "required": true, "type": "string" },
  4220. "repo": { "required": true, "type": "string" }
  4221. },
  4222. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  4223. },
  4224. "getProtectedBranchRestrictions": {
  4225. "method": "GET",
  4226. "params": {
  4227. "branch": { "required": true, "type": "string" },
  4228. "owner": { "required": true, "type": "string" },
  4229. "repo": { "required": true, "type": "string" }
  4230. },
  4231. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
  4232. },
  4233. "getPunchCardStats": {
  4234. "method": "GET",
  4235. "params": {
  4236. "owner": { "required": true, "type": "string" },
  4237. "repo": { "required": true, "type": "string" }
  4238. },
  4239. "url": "/repos/:owner/:repo/stats/punch_card"
  4240. },
  4241. "getReadme": {
  4242. "method": "GET",
  4243. "params": {
  4244. "owner": { "required": true, "type": "string" },
  4245. "ref": { "type": "string" },
  4246. "repo": { "required": true, "type": "string" }
  4247. },
  4248. "url": "/repos/:owner/:repo/readme"
  4249. },
  4250. "getRelease": {
  4251. "method": "GET",
  4252. "params": {
  4253. "owner": { "required": true, "type": "string" },
  4254. "release_id": { "required": true, "type": "integer" },
  4255. "repo": { "required": true, "type": "string" }
  4256. },
  4257. "url": "/repos/:owner/:repo/releases/:release_id"
  4258. },
  4259. "getReleaseAsset": {
  4260. "method": "GET",
  4261. "params": {
  4262. "asset_id": { "required": true, "type": "integer" },
  4263. "owner": { "required": true, "type": "string" },
  4264. "repo": { "required": true, "type": "string" }
  4265. },
  4266. "url": "/repos/:owner/:repo/releases/assets/:asset_id"
  4267. },
  4268. "getReleaseByTag": {
  4269. "method": "GET",
  4270. "params": {
  4271. "owner": { "required": true, "type": "string" },
  4272. "repo": { "required": true, "type": "string" },
  4273. "tag": { "required": true, "type": "string" }
  4274. },
  4275. "url": "/repos/:owner/:repo/releases/tags/:tag"
  4276. },
  4277. "getTeamsWithAccessToProtectedBranch": {
  4278. "method": "GET",
  4279. "params": {
  4280. "branch": { "required": true, "type": "string" },
  4281. "owner": { "required": true, "type": "string" },
  4282. "repo": { "required": true, "type": "string" }
  4283. },
  4284. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4285. },
  4286. "getUsersWithAccessToProtectedBranch": {
  4287. "method": "GET",
  4288. "params": {
  4289. "branch": { "required": true, "type": "string" },
  4290. "owner": { "required": true, "type": "string" },
  4291. "repo": { "required": true, "type": "string" }
  4292. },
  4293. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4294. },
  4295. "list": {
  4296. "method": "GET",
  4297. "params": {
  4298. "affiliation": { "type": "string" },
  4299. "direction": { "enum": ["asc", "desc"], "type": "string" },
  4300. "page": { "type": "integer" },
  4301. "per_page": { "type": "integer" },
  4302. "sort": {
  4303. "enum": ["created", "updated", "pushed", "full_name"],
  4304. "type": "string"
  4305. },
  4306. "type": {
  4307. "enum": ["all", "owner", "public", "private", "member"],
  4308. "type": "string"
  4309. },
  4310. "visibility": { "enum": ["all", "public", "private"], "type": "string" }
  4311. },
  4312. "url": "/user/repos"
  4313. },
  4314. "listAppsWithAccessToProtectedBranch": {
  4315. "deprecated": "octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)",
  4316. "method": "GET",
  4317. "params": {
  4318. "branch": { "required": true, "type": "string" },
  4319. "owner": { "required": true, "type": "string" },
  4320. "repo": { "required": true, "type": "string" }
  4321. },
  4322. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  4323. },
  4324. "listAssetsForRelease": {
  4325. "method": "GET",
  4326. "params": {
  4327. "owner": { "required": true, "type": "string" },
  4328. "page": { "type": "integer" },
  4329. "per_page": { "type": "integer" },
  4330. "release_id": { "required": true, "type": "integer" },
  4331. "repo": { "required": true, "type": "string" }
  4332. },
  4333. "url": "/repos/:owner/:repo/releases/:release_id/assets"
  4334. },
  4335. "listBranches": {
  4336. "method": "GET",
  4337. "params": {
  4338. "owner": { "required": true, "type": "string" },
  4339. "page": { "type": "integer" },
  4340. "per_page": { "type": "integer" },
  4341. "protected": { "type": "boolean" },
  4342. "repo": { "required": true, "type": "string" }
  4343. },
  4344. "url": "/repos/:owner/:repo/branches"
  4345. },
  4346. "listBranchesForHeadCommit": {
  4347. "headers": { "accept": "application/vnd.github.groot-preview+json" },
  4348. "method": "GET",
  4349. "params": {
  4350. "commit_sha": { "required": true, "type": "string" },
  4351. "owner": { "required": true, "type": "string" },
  4352. "repo": { "required": true, "type": "string" }
  4353. },
  4354. "url": "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"
  4355. },
  4356. "listCollaborators": {
  4357. "method": "GET",
  4358. "params": {
  4359. "affiliation": {
  4360. "enum": ["outside", "direct", "all"],
  4361. "type": "string"
  4362. },
  4363. "owner": { "required": true, "type": "string" },
  4364. "page": { "type": "integer" },
  4365. "per_page": { "type": "integer" },
  4366. "repo": { "required": true, "type": "string" }
  4367. },
  4368. "url": "/repos/:owner/:repo/collaborators"
  4369. },
  4370. "listCommentsForCommit": {
  4371. "method": "GET",
  4372. "params": {
  4373. "commit_sha": { "required": true, "type": "string" },
  4374. "owner": { "required": true, "type": "string" },
  4375. "page": { "type": "integer" },
  4376. "per_page": { "type": "integer" },
  4377. "ref": { "alias": "commit_sha", "deprecated": true, "type": "string" },
  4378. "repo": { "required": true, "type": "string" }
  4379. },
  4380. "url": "/repos/:owner/:repo/commits/:commit_sha/comments"
  4381. },
  4382. "listCommitComments": {
  4383. "method": "GET",
  4384. "params": {
  4385. "owner": { "required": true, "type": "string" },
  4386. "page": { "type": "integer" },
  4387. "per_page": { "type": "integer" },
  4388. "repo": { "required": true, "type": "string" }
  4389. },
  4390. "url": "/repos/:owner/:repo/comments"
  4391. },
  4392. "listCommits": {
  4393. "method": "GET",
  4394. "params": {
  4395. "author": { "type": "string" },
  4396. "owner": { "required": true, "type": "string" },
  4397. "page": { "type": "integer" },
  4398. "path": { "type": "string" },
  4399. "per_page": { "type": "integer" },
  4400. "repo": { "required": true, "type": "string" },
  4401. "sha": { "type": "string" },
  4402. "since": { "type": "string" },
  4403. "until": { "type": "string" }
  4404. },
  4405. "url": "/repos/:owner/:repo/commits"
  4406. },
  4407. "listContributors": {
  4408. "method": "GET",
  4409. "params": {
  4410. "anon": { "type": "string" },
  4411. "owner": { "required": true, "type": "string" },
  4412. "page": { "type": "integer" },
  4413. "per_page": { "type": "integer" },
  4414. "repo": { "required": true, "type": "string" }
  4415. },
  4416. "url": "/repos/:owner/:repo/contributors"
  4417. },
  4418. "listDeployKeys": {
  4419. "method": "GET",
  4420. "params": {
  4421. "owner": { "required": true, "type": "string" },
  4422. "page": { "type": "integer" },
  4423. "per_page": { "type": "integer" },
  4424. "repo": { "required": true, "type": "string" }
  4425. },
  4426. "url": "/repos/:owner/:repo/keys"
  4427. },
  4428. "listDeploymentStatuses": {
  4429. "method": "GET",
  4430. "params": {
  4431. "deployment_id": { "required": true, "type": "integer" },
  4432. "owner": { "required": true, "type": "string" },
  4433. "page": { "type": "integer" },
  4434. "per_page": { "type": "integer" },
  4435. "repo": { "required": true, "type": "string" }
  4436. },
  4437. "url": "/repos/:owner/:repo/deployments/:deployment_id/statuses"
  4438. },
  4439. "listDeployments": {
  4440. "method": "GET",
  4441. "params": {
  4442. "environment": { "type": "string" },
  4443. "owner": { "required": true, "type": "string" },
  4444. "page": { "type": "integer" },
  4445. "per_page": { "type": "integer" },
  4446. "ref": { "type": "string" },
  4447. "repo": { "required": true, "type": "string" },
  4448. "sha": { "type": "string" },
  4449. "task": { "type": "string" }
  4450. },
  4451. "url": "/repos/:owner/:repo/deployments"
  4452. },
  4453. "listDownloads": {
  4454. "method": "GET",
  4455. "params": {
  4456. "owner": { "required": true, "type": "string" },
  4457. "page": { "type": "integer" },
  4458. "per_page": { "type": "integer" },
  4459. "repo": { "required": true, "type": "string" }
  4460. },
  4461. "url": "/repos/:owner/:repo/downloads"
  4462. },
  4463. "listForOrg": {
  4464. "method": "GET",
  4465. "params": {
  4466. "direction": { "enum": ["asc", "desc"], "type": "string" },
  4467. "org": { "required": true, "type": "string" },
  4468. "page": { "type": "integer" },
  4469. "per_page": { "type": "integer" },
  4470. "sort": {
  4471. "enum": ["created", "updated", "pushed", "full_name"],
  4472. "type": "string"
  4473. },
  4474. "type": {
  4475. "enum": ["all", "public", "private", "forks", "sources", "member"],
  4476. "type": "string"
  4477. }
  4478. },
  4479. "url": "/orgs/:org/repos"
  4480. },
  4481. "listForUser": {
  4482. "method": "GET",
  4483. "params": {
  4484. "direction": { "enum": ["asc", "desc"], "type": "string" },
  4485. "page": { "type": "integer" },
  4486. "per_page": { "type": "integer" },
  4487. "sort": {
  4488. "enum": ["created", "updated", "pushed", "full_name"],
  4489. "type": "string"
  4490. },
  4491. "type": { "enum": ["all", "owner", "member"], "type": "string" },
  4492. "username": { "required": true, "type": "string" }
  4493. },
  4494. "url": "/users/:username/repos"
  4495. },
  4496. "listForks": {
  4497. "method": "GET",
  4498. "params": {
  4499. "owner": { "required": true, "type": "string" },
  4500. "page": { "type": "integer" },
  4501. "per_page": { "type": "integer" },
  4502. "repo": { "required": true, "type": "string" },
  4503. "sort": { "enum": ["newest", "oldest", "stargazers"], "type": "string" }
  4504. },
  4505. "url": "/repos/:owner/:repo/forks"
  4506. },
  4507. "listHooks": {
  4508. "method": "GET",
  4509. "params": {
  4510. "owner": { "required": true, "type": "string" },
  4511. "page": { "type": "integer" },
  4512. "per_page": { "type": "integer" },
  4513. "repo": { "required": true, "type": "string" }
  4514. },
  4515. "url": "/repos/:owner/:repo/hooks"
  4516. },
  4517. "listInvitations": {
  4518. "method": "GET",
  4519. "params": {
  4520. "owner": { "required": true, "type": "string" },
  4521. "page": { "type": "integer" },
  4522. "per_page": { "type": "integer" },
  4523. "repo": { "required": true, "type": "string" }
  4524. },
  4525. "url": "/repos/:owner/:repo/invitations"
  4526. },
  4527. "listInvitationsForAuthenticatedUser": {
  4528. "method": "GET",
  4529. "params": {
  4530. "page": { "type": "integer" },
  4531. "per_page": { "type": "integer" }
  4532. },
  4533. "url": "/user/repository_invitations"
  4534. },
  4535. "listLanguages": {
  4536. "method": "GET",
  4537. "params": {
  4538. "owner": { "required": true, "type": "string" },
  4539. "repo": { "required": true, "type": "string" }
  4540. },
  4541. "url": "/repos/:owner/:repo/languages"
  4542. },
  4543. "listPagesBuilds": {
  4544. "method": "GET",
  4545. "params": {
  4546. "owner": { "required": true, "type": "string" },
  4547. "page": { "type": "integer" },
  4548. "per_page": { "type": "integer" },
  4549. "repo": { "required": true, "type": "string" }
  4550. },
  4551. "url": "/repos/:owner/:repo/pages/builds"
  4552. },
  4553. "listProtectedBranchRequiredStatusChecksContexts": {
  4554. "method": "GET",
  4555. "params": {
  4556. "branch": { "required": true, "type": "string" },
  4557. "owner": { "required": true, "type": "string" },
  4558. "repo": { "required": true, "type": "string" }
  4559. },
  4560. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  4561. },
  4562. "listProtectedBranchTeamRestrictions": {
  4563. "deprecated": "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)",
  4564. "method": "GET",
  4565. "params": {
  4566. "branch": { "required": true, "type": "string" },
  4567. "owner": { "required": true, "type": "string" },
  4568. "repo": { "required": true, "type": "string" }
  4569. },
  4570. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4571. },
  4572. "listProtectedBranchUserRestrictions": {
  4573. "deprecated": "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)",
  4574. "method": "GET",
  4575. "params": {
  4576. "branch": { "required": true, "type": "string" },
  4577. "owner": { "required": true, "type": "string" },
  4578. "repo": { "required": true, "type": "string" }
  4579. },
  4580. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4581. },
  4582. "listPublic": {
  4583. "method": "GET",
  4584. "params": {
  4585. "page": { "type": "integer" },
  4586. "per_page": { "type": "integer" },
  4587. "since": { "type": "string" },
  4588. "visibility": { "type": "string" }
  4589. },
  4590. "url": "/repositories"
  4591. },
  4592. "listPullRequestsAssociatedWithCommit": {
  4593. "headers": { "accept": "application/vnd.github.groot-preview+json" },
  4594. "method": "GET",
  4595. "params": {
  4596. "commit_sha": { "required": true, "type": "string" },
  4597. "owner": { "required": true, "type": "string" },
  4598. "page": { "type": "integer" },
  4599. "per_page": { "type": "integer" },
  4600. "repo": { "required": true, "type": "string" }
  4601. },
  4602. "url": "/repos/:owner/:repo/commits/:commit_sha/pulls"
  4603. },
  4604. "listReleases": {
  4605. "method": "GET",
  4606. "params": {
  4607. "owner": { "required": true, "type": "string" },
  4608. "page": { "type": "integer" },
  4609. "per_page": { "type": "integer" },
  4610. "repo": { "required": true, "type": "string" }
  4611. },
  4612. "url": "/repos/:owner/:repo/releases"
  4613. },
  4614. "listStatusesForRef": {
  4615. "method": "GET",
  4616. "params": {
  4617. "owner": { "required": true, "type": "string" },
  4618. "page": { "type": "integer" },
  4619. "per_page": { "type": "integer" },
  4620. "ref": { "required": true, "type": "string" },
  4621. "repo": { "required": true, "type": "string" }
  4622. },
  4623. "url": "/repos/:owner/:repo/commits/:ref/statuses"
  4624. },
  4625. "listTags": {
  4626. "method": "GET",
  4627. "params": {
  4628. "owner": { "required": true, "type": "string" },
  4629. "page": { "type": "integer" },
  4630. "per_page": { "type": "integer" },
  4631. "repo": { "required": true, "type": "string" }
  4632. },
  4633. "url": "/repos/:owner/:repo/tags"
  4634. },
  4635. "listTeams": {
  4636. "method": "GET",
  4637. "params": {
  4638. "owner": { "required": true, "type": "string" },
  4639. "page": { "type": "integer" },
  4640. "per_page": { "type": "integer" },
  4641. "repo": { "required": true, "type": "string" }
  4642. },
  4643. "url": "/repos/:owner/:repo/teams"
  4644. },
  4645. "listTeamsWithAccessToProtectedBranch": {
  4646. "deprecated": "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)",
  4647. "method": "GET",
  4648. "params": {
  4649. "branch": { "required": true, "type": "string" },
  4650. "owner": { "required": true, "type": "string" },
  4651. "repo": { "required": true, "type": "string" }
  4652. },
  4653. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4654. },
  4655. "listTopics": {
  4656. "headers": { "accept": "application/vnd.github.mercy-preview+json" },
  4657. "method": "GET",
  4658. "params": {
  4659. "owner": { "required": true, "type": "string" },
  4660. "repo": { "required": true, "type": "string" }
  4661. },
  4662. "url": "/repos/:owner/:repo/topics"
  4663. },
  4664. "listUsersWithAccessToProtectedBranch": {
  4665. "deprecated": "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)",
  4666. "method": "GET",
  4667. "params": {
  4668. "branch": { "required": true, "type": "string" },
  4669. "owner": { "required": true, "type": "string" },
  4670. "repo": { "required": true, "type": "string" }
  4671. },
  4672. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4673. },
  4674. "merge": {
  4675. "method": "POST",
  4676. "params": {
  4677. "base": { "required": true, "type": "string" },
  4678. "commit_message": { "type": "string" },
  4679. "head": { "required": true, "type": "string" },
  4680. "owner": { "required": true, "type": "string" },
  4681. "repo": { "required": true, "type": "string" }
  4682. },
  4683. "url": "/repos/:owner/:repo/merges"
  4684. },
  4685. "pingHook": {
  4686. "method": "POST",
  4687. "params": {
  4688. "hook_id": { "required": true, "type": "integer" },
  4689. "owner": { "required": true, "type": "string" },
  4690. "repo": { "required": true, "type": "string" }
  4691. },
  4692. "url": "/repos/:owner/:repo/hooks/:hook_id/pings"
  4693. },
  4694. "removeBranchProtection": {
  4695. "method": "DELETE",
  4696. "params": {
  4697. "branch": { "required": true, "type": "string" },
  4698. "owner": { "required": true, "type": "string" },
  4699. "repo": { "required": true, "type": "string" }
  4700. },
  4701. "url": "/repos/:owner/:repo/branches/:branch/protection"
  4702. },
  4703. "removeCollaborator": {
  4704. "method": "DELETE",
  4705. "params": {
  4706. "owner": { "required": true, "type": "string" },
  4707. "repo": { "required": true, "type": "string" },
  4708. "username": { "required": true, "type": "string" }
  4709. },
  4710. "url": "/repos/:owner/:repo/collaborators/:username"
  4711. },
  4712. "removeDeployKey": {
  4713. "method": "DELETE",
  4714. "params": {
  4715. "key_id": { "required": true, "type": "integer" },
  4716. "owner": { "required": true, "type": "string" },
  4717. "repo": { "required": true, "type": "string" }
  4718. },
  4719. "url": "/repos/:owner/:repo/keys/:key_id"
  4720. },
  4721. "removeProtectedBranchAdminEnforcement": {
  4722. "method": "DELETE",
  4723. "params": {
  4724. "branch": { "required": true, "type": "string" },
  4725. "owner": { "required": true, "type": "string" },
  4726. "repo": { "required": true, "type": "string" }
  4727. },
  4728. "url": "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
  4729. },
  4730. "removeProtectedBranchAppRestrictions": {
  4731. "method": "DELETE",
  4732. "params": {
  4733. "apps": { "mapTo": "data", "required": true, "type": "string[]" },
  4734. "branch": { "required": true, "type": "string" },
  4735. "owner": { "required": true, "type": "string" },
  4736. "repo": { "required": true, "type": "string" }
  4737. },
  4738. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  4739. },
  4740. "removeProtectedBranchPullRequestReviewEnforcement": {
  4741. "method": "DELETE",
  4742. "params": {
  4743. "branch": { "required": true, "type": "string" },
  4744. "owner": { "required": true, "type": "string" },
  4745. "repo": { "required": true, "type": "string" }
  4746. },
  4747. "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  4748. },
  4749. "removeProtectedBranchRequiredSignatures": {
  4750. "headers": { "accept": "application/vnd.github.zzzax-preview+json" },
  4751. "method": "DELETE",
  4752. "params": {
  4753. "branch": { "required": true, "type": "string" },
  4754. "owner": { "required": true, "type": "string" },
  4755. "repo": { "required": true, "type": "string" }
  4756. },
  4757. "url": "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
  4758. },
  4759. "removeProtectedBranchRequiredStatusChecks": {
  4760. "method": "DELETE",
  4761. "params": {
  4762. "branch": { "required": true, "type": "string" },
  4763. "owner": { "required": true, "type": "string" },
  4764. "repo": { "required": true, "type": "string" }
  4765. },
  4766. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  4767. },
  4768. "removeProtectedBranchRequiredStatusChecksContexts": {
  4769. "method": "DELETE",
  4770. "params": {
  4771. "branch": { "required": true, "type": "string" },
  4772. "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
  4773. "owner": { "required": true, "type": "string" },
  4774. "repo": { "required": true, "type": "string" }
  4775. },
  4776. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  4777. },
  4778. "removeProtectedBranchRestrictions": {
  4779. "method": "DELETE",
  4780. "params": {
  4781. "branch": { "required": true, "type": "string" },
  4782. "owner": { "required": true, "type": "string" },
  4783. "repo": { "required": true, "type": "string" }
  4784. },
  4785. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions"
  4786. },
  4787. "removeProtectedBranchTeamRestrictions": {
  4788. "method": "DELETE",
  4789. "params": {
  4790. "branch": { "required": true, "type": "string" },
  4791. "owner": { "required": true, "type": "string" },
  4792. "repo": { "required": true, "type": "string" },
  4793. "teams": { "mapTo": "data", "required": true, "type": "string[]" }
  4794. },
  4795. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4796. },
  4797. "removeProtectedBranchUserRestrictions": {
  4798. "method": "DELETE",
  4799. "params": {
  4800. "branch": { "required": true, "type": "string" },
  4801. "owner": { "required": true, "type": "string" },
  4802. "repo": { "required": true, "type": "string" },
  4803. "users": { "mapTo": "data", "required": true, "type": "string[]" }
  4804. },
  4805. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4806. },
  4807. "replaceProtectedBranchAppRestrictions": {
  4808. "method": "PUT",
  4809. "params": {
  4810. "apps": { "mapTo": "data", "required": true, "type": "string[]" },
  4811. "branch": { "required": true, "type": "string" },
  4812. "owner": { "required": true, "type": "string" },
  4813. "repo": { "required": true, "type": "string" }
  4814. },
  4815. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
  4816. },
  4817. "replaceProtectedBranchRequiredStatusChecksContexts": {
  4818. "method": "PUT",
  4819. "params": {
  4820. "branch": { "required": true, "type": "string" },
  4821. "contexts": { "mapTo": "data", "required": true, "type": "string[]" },
  4822. "owner": { "required": true, "type": "string" },
  4823. "repo": { "required": true, "type": "string" }
  4824. },
  4825. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
  4826. },
  4827. "replaceProtectedBranchTeamRestrictions": {
  4828. "method": "PUT",
  4829. "params": {
  4830. "branch": { "required": true, "type": "string" },
  4831. "owner": { "required": true, "type": "string" },
  4832. "repo": { "required": true, "type": "string" },
  4833. "teams": { "mapTo": "data", "required": true, "type": "string[]" }
  4834. },
  4835. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
  4836. },
  4837. "replaceProtectedBranchUserRestrictions": {
  4838. "method": "PUT",
  4839. "params": {
  4840. "branch": { "required": true, "type": "string" },
  4841. "owner": { "required": true, "type": "string" },
  4842. "repo": { "required": true, "type": "string" },
  4843. "users": { "mapTo": "data", "required": true, "type": "string[]" }
  4844. },
  4845. "url": "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
  4846. },
  4847. "replaceTopics": {
  4848. "headers": { "accept": "application/vnd.github.mercy-preview+json" },
  4849. "method": "PUT",
  4850. "params": {
  4851. "names": { "required": true, "type": "string[]" },
  4852. "owner": { "required": true, "type": "string" },
  4853. "repo": { "required": true, "type": "string" }
  4854. },
  4855. "url": "/repos/:owner/:repo/topics"
  4856. },
  4857. "requestPageBuild": {
  4858. "method": "POST",
  4859. "params": {
  4860. "owner": { "required": true, "type": "string" },
  4861. "repo": { "required": true, "type": "string" }
  4862. },
  4863. "url": "/repos/:owner/:repo/pages/builds"
  4864. },
  4865. "testPushHook": {
  4866. "method": "POST",
  4867. "params": {
  4868. "hook_id": { "required": true, "type": "integer" },
  4869. "owner": { "required": true, "type": "string" },
  4870. "repo": { "required": true, "type": "string" }
  4871. },
  4872. "url": "/repos/:owner/:repo/hooks/:hook_id/tests"
  4873. },
  4874. "transfer": {
  4875. "headers": { "accept": "application/vnd.github.nightshade-preview+json" },
  4876. "method": "POST",
  4877. "params": {
  4878. "new_owner": { "type": "string" },
  4879. "owner": { "required": true, "type": "string" },
  4880. "repo": { "required": true, "type": "string" },
  4881. "team_ids": { "type": "integer[]" }
  4882. },
  4883. "url": "/repos/:owner/:repo/transfer"
  4884. },
  4885. "update": {
  4886. "headers": { "accept": "application/vnd.github.x-ray-preview+json" },
  4887. "method": "PATCH",
  4888. "params": {
  4889. "allow_merge_commit": { "type": "boolean" },
  4890. "allow_rebase_merge": { "type": "boolean" },
  4891. "allow_squash_merge": { "type": "boolean" },
  4892. "anonymous_access_enabled": { "type": "boolean" },
  4893. "archived": { "type": "boolean" },
  4894. "default_branch": { "type": "string" },
  4895. "description": { "type": "string" },
  4896. "has_issues": { "type": "boolean" },
  4897. "has_projects": { "type": "boolean" },
  4898. "has_wiki": { "type": "boolean" },
  4899. "homepage": { "type": "string" },
  4900. "is_template": { "type": "boolean" },
  4901. "name": { "type": "string" },
  4902. "owner": { "required": true, "type": "string" },
  4903. "private": { "type": "boolean" },
  4904. "repo": { "required": true, "type": "string" }
  4905. },
  4906. "url": "/repos/:owner/:repo"
  4907. },
  4908. "updateBranchProtection": {
  4909. "method": "PUT",
  4910. "params": {
  4911. "branch": { "required": true, "type": "string" },
  4912. "enforce_admins": {
  4913. "allowNull": true,
  4914. "required": true,
  4915. "type": "boolean"
  4916. },
  4917. "owner": { "required": true, "type": "string" },
  4918. "repo": { "required": true, "type": "string" },
  4919. "required_pull_request_reviews": {
  4920. "allowNull": true,
  4921. "required": true,
  4922. "type": "object"
  4923. },
  4924. "required_pull_request_reviews.dismiss_stale_reviews": {
  4925. "type": "boolean"
  4926. },
  4927. "required_pull_request_reviews.dismissal_restrictions": {
  4928. "type": "object"
  4929. },
  4930. "required_pull_request_reviews.dismissal_restrictions.teams": {
  4931. "type": "string[]"
  4932. },
  4933. "required_pull_request_reviews.dismissal_restrictions.users": {
  4934. "type": "string[]"
  4935. },
  4936. "required_pull_request_reviews.require_code_owner_reviews": {
  4937. "type": "boolean"
  4938. },
  4939. "required_pull_request_reviews.required_approving_review_count": {
  4940. "type": "integer"
  4941. },
  4942. "required_status_checks": {
  4943. "allowNull": true,
  4944. "required": true,
  4945. "type": "object"
  4946. },
  4947. "required_status_checks.contexts": {
  4948. "required": true,
  4949. "type": "string[]"
  4950. },
  4951. "required_status_checks.strict": {
  4952. "required": true,
  4953. "type": "boolean"
  4954. },
  4955. "restrictions": {
  4956. "allowNull": true,
  4957. "required": true,
  4958. "type": "object"
  4959. },
  4960. "restrictions.apps": { "type": "string[]" },
  4961. "restrictions.teams": { "required": true, "type": "string[]" },
  4962. "restrictions.users": { "required": true, "type": "string[]" }
  4963. },
  4964. "url": "/repos/:owner/:repo/branches/:branch/protection"
  4965. },
  4966. "updateCommitComment": {
  4967. "method": "PATCH",
  4968. "params": {
  4969. "body": { "required": true, "type": "string" },
  4970. "comment_id": { "required": true, "type": "integer" },
  4971. "owner": { "required": true, "type": "string" },
  4972. "repo": { "required": true, "type": "string" }
  4973. },
  4974. "url": "/repos/:owner/:repo/comments/:comment_id"
  4975. },
  4976. "updateFile": {
  4977. "deprecated": "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
  4978. "method": "PUT",
  4979. "params": {
  4980. "author": { "type": "object" },
  4981. "author.email": { "required": true, "type": "string" },
  4982. "author.name": { "required": true, "type": "string" },
  4983. "branch": { "type": "string" },
  4984. "committer": { "type": "object" },
  4985. "committer.email": { "required": true, "type": "string" },
  4986. "committer.name": { "required": true, "type": "string" },
  4987. "content": { "required": true, "type": "string" },
  4988. "message": { "required": true, "type": "string" },
  4989. "owner": { "required": true, "type": "string" },
  4990. "path": { "required": true, "type": "string" },
  4991. "repo": { "required": true, "type": "string" },
  4992. "sha": { "type": "string" }
  4993. },
  4994. "url": "/repos/:owner/:repo/contents/:path"
  4995. },
  4996. "updateHook": {
  4997. "method": "PATCH",
  4998. "params": {
  4999. "active": { "type": "boolean" },
  5000. "add_events": { "type": "string[]" },
  5001. "config": { "type": "object" },
  5002. "config.content_type": { "type": "string" },
  5003. "config.insecure_ssl": { "type": "string" },
  5004. "config.secret": { "type": "string" },
  5005. "config.url": { "required": true, "type": "string" },
  5006. "events": { "type": "string[]" },
  5007. "hook_id": { "required": true, "type": "integer" },
  5008. "owner": { "required": true, "type": "string" },
  5009. "remove_events": { "type": "string[]" },
  5010. "repo": { "required": true, "type": "string" }
  5011. },
  5012. "url": "/repos/:owner/:repo/hooks/:hook_id"
  5013. },
  5014. "updateInformationAboutPagesSite": {
  5015. "method": "PUT",
  5016. "params": {
  5017. "owner": { "required": true, "type": "string" },
  5018. "repo": { "required": true, "type": "string" },
  5019. "source": {
  5020. "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""],
  5021. "type": "string"
  5022. }
  5023. },
  5024. "url": "/repos/:owner/:repo/pages"
  5025. },
  5026. "updateInvitation": {
  5027. "method": "PATCH",
  5028. "params": {
  5029. "invitation_id": { "required": true, "type": "integer" },
  5030. "owner": { "required": true, "type": "string" },
  5031. "permissions": { "enum": ["read", "write", "admin"], "type": "string" },
  5032. "repo": { "required": true, "type": "string" }
  5033. },
  5034. "url": "/repos/:owner/:repo/invitations/:invitation_id"
  5035. },
  5036. "updateProtectedBranchPullRequestReviewEnforcement": {
  5037. "method": "PATCH",
  5038. "params": {
  5039. "branch": { "required": true, "type": "string" },
  5040. "dismiss_stale_reviews": { "type": "boolean" },
  5041. "dismissal_restrictions": { "type": "object" },
  5042. "dismissal_restrictions.teams": { "type": "string[]" },
  5043. "dismissal_restrictions.users": { "type": "string[]" },
  5044. "owner": { "required": true, "type": "string" },
  5045. "repo": { "required": true, "type": "string" },
  5046. "require_code_owner_reviews": { "type": "boolean" },
  5047. "required_approving_review_count": { "type": "integer" }
  5048. },
  5049. "url": "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
  5050. },
  5051. "updateProtectedBranchRequiredStatusChecks": {
  5052. "method": "PATCH",
  5053. "params": {
  5054. "branch": { "required": true, "type": "string" },
  5055. "contexts": { "type": "string[]" },
  5056. "owner": { "required": true, "type": "string" },
  5057. "repo": { "required": true, "type": "string" },
  5058. "strict": { "type": "boolean" }
  5059. },
  5060. "url": "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
  5061. },
  5062. "updateRelease": {
  5063. "method": "PATCH",
  5064. "params": {
  5065. "body": { "type": "string" },
  5066. "draft": { "type": "boolean" },
  5067. "name": { "type": "string" },
  5068. "owner": { "required": true, "type": "string" },
  5069. "prerelease": { "type": "boolean" },
  5070. "release_id": { "required": true, "type": "integer" },
  5071. "repo": { "required": true, "type": "string" },
  5072. "tag_name": { "type": "string" },
  5073. "target_commitish": { "type": "string" }
  5074. },
  5075. "url": "/repos/:owner/:repo/releases/:release_id"
  5076. },
  5077. "updateReleaseAsset": {
  5078. "method": "PATCH",
  5079. "params": {
  5080. "asset_id": { "required": true, "type": "integer" },
  5081. "label": { "type": "string" },
  5082. "name": { "type": "string" },
  5083. "owner": { "required": true, "type": "string" },
  5084. "repo": { "required": true, "type": "string" }
  5085. },
  5086. "url": "/repos/:owner/:repo/releases/assets/:asset_id"
  5087. },
  5088. "uploadReleaseAsset": {
  5089. "method": "POST",
  5090. "params": {
  5091. "file": {
  5092. "mapTo": "data",
  5093. "required": true,
  5094. "type": "string | object"
  5095. },
  5096. "headers": { "required": true, "type": "object" },
  5097. "headers.content-length": { "required": true, "type": "integer" },
  5098. "headers.content-type": { "required": true, "type": "string" },
  5099. "label": { "type": "string" },
  5100. "name": { "required": true, "type": "string" },
  5101. "url": { "required": true, "type": "string" }
  5102. },
  5103. "url": ":url"
  5104. }
  5105. },
  5106. "search": {
  5107. "code": {
  5108. "method": "GET",
  5109. "params": {
  5110. "order": { "enum": ["desc", "asc"], "type": "string" },
  5111. "page": { "type": "integer" },
  5112. "per_page": { "type": "integer" },
  5113. "q": { "required": true, "type": "string" },
  5114. "sort": { "enum": ["indexed"], "type": "string" }
  5115. },
  5116. "url": "/search/code"
  5117. },
  5118. "commits": {
  5119. "headers": { "accept": "application/vnd.github.cloak-preview+json" },
  5120. "method": "GET",
  5121. "params": {
  5122. "order": { "enum": ["desc", "asc"], "type": "string" },
  5123. "page": { "type": "integer" },
  5124. "per_page": { "type": "integer" },
  5125. "q": { "required": true, "type": "string" },
  5126. "sort": { "enum": ["author-date", "committer-date"], "type": "string" }
  5127. },
  5128. "url": "/search/commits"
  5129. },
  5130. "issues": {
  5131. "deprecated": "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)",
  5132. "method": "GET",
  5133. "params": {
  5134. "order": { "enum": ["desc", "asc"], "type": "string" },
  5135. "page": { "type": "integer" },
  5136. "per_page": { "type": "integer" },
  5137. "q": { "required": true, "type": "string" },
  5138. "sort": {
  5139. "enum": [
  5140. "comments",
  5141. "reactions",
  5142. "reactions-+1",
  5143. "reactions--1",
  5144. "reactions-smile",
  5145. "reactions-thinking_face",
  5146. "reactions-heart",
  5147. "reactions-tada",
  5148. "interactions",
  5149. "created",
  5150. "updated"
  5151. ],
  5152. "type": "string"
  5153. }
  5154. },
  5155. "url": "/search/issues"
  5156. },
  5157. "issuesAndPullRequests": {
  5158. "method": "GET",
  5159. "params": {
  5160. "order": { "enum": ["desc", "asc"], "type": "string" },
  5161. "page": { "type": "integer" },
  5162. "per_page": { "type": "integer" },
  5163. "q": { "required": true, "type": "string" },
  5164. "sort": {
  5165. "enum": [
  5166. "comments",
  5167. "reactions",
  5168. "reactions-+1",
  5169. "reactions--1",
  5170. "reactions-smile",
  5171. "reactions-thinking_face",
  5172. "reactions-heart",
  5173. "reactions-tada",
  5174. "interactions",
  5175. "created",
  5176. "updated"
  5177. ],
  5178. "type": "string"
  5179. }
  5180. },
  5181. "url": "/search/issues"
  5182. },
  5183. "labels": {
  5184. "method": "GET",
  5185. "params": {
  5186. "order": { "enum": ["desc", "asc"], "type": "string" },
  5187. "q": { "required": true, "type": "string" },
  5188. "repository_id": { "required": true, "type": "integer" },
  5189. "sort": { "enum": ["created", "updated"], "type": "string" }
  5190. },
  5191. "url": "/search/labels"
  5192. },
  5193. "repos": {
  5194. "method": "GET",
  5195. "params": {
  5196. "order": { "enum": ["desc", "asc"], "type": "string" },
  5197. "page": { "type": "integer" },
  5198. "per_page": { "type": "integer" },
  5199. "q": { "required": true, "type": "string" },
  5200. "sort": {
  5201. "enum": ["stars", "forks", "help-wanted-issues", "updated"],
  5202. "type": "string"
  5203. }
  5204. },
  5205. "url": "/search/repositories"
  5206. },
  5207. "topics": {
  5208. "method": "GET",
  5209. "params": { "q": { "required": true, "type": "string" } },
  5210. "url": "/search/topics"
  5211. },
  5212. "users": {
  5213. "method": "GET",
  5214. "params": {
  5215. "order": { "enum": ["desc", "asc"], "type": "string" },
  5216. "page": { "type": "integer" },
  5217. "per_page": { "type": "integer" },
  5218. "q": { "required": true, "type": "string" },
  5219. "sort": {
  5220. "enum": ["followers", "repositories", "joined"],
  5221. "type": "string"
  5222. }
  5223. },
  5224. "url": "/search/users"
  5225. }
  5226. },
  5227. "teams": {
  5228. "addMember": {
  5229. "deprecated": "octokit.teams.addMember() is deprecated, see https://developer.github.com/enterprise/2.19/v3/teams/members/#add-team-member",
  5230. "method": "PUT",
  5231. "params": {
  5232. "team_id": { "required": true, "type": "integer" },
  5233. "username": { "required": true, "type": "string" }
  5234. },
  5235. "url": "/teams/:team_id/members/:username"
  5236. },
  5237. "addOrUpdateMembership": {
  5238. "method": "PUT",
  5239. "params": {
  5240. "role": { "enum": ["member", "maintainer"], "type": "string" },
  5241. "team_id": { "required": true, "type": "integer" },
  5242. "username": { "required": true, "type": "string" }
  5243. },
  5244. "url": "/teams/:team_id/memberships/:username"
  5245. },
  5246. "addOrUpdateProject": {
  5247. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  5248. "method": "PUT",
  5249. "params": {
  5250. "permission": { "enum": ["read", "write", "admin"], "type": "string" },
  5251. "project_id": { "required": true, "type": "integer" },
  5252. "team_id": { "required": true, "type": "integer" }
  5253. },
  5254. "url": "/teams/:team_id/projects/:project_id"
  5255. },
  5256. "addOrUpdateRepo": {
  5257. "method": "PUT",
  5258. "params": {
  5259. "owner": { "required": true, "type": "string" },
  5260. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  5261. "repo": { "required": true, "type": "string" },
  5262. "team_id": { "required": true, "type": "integer" }
  5263. },
  5264. "url": "/teams/:team_id/repos/:owner/:repo"
  5265. },
  5266. "checkManagesRepo": {
  5267. "method": "GET",
  5268. "params": {
  5269. "owner": { "required": true, "type": "string" },
  5270. "repo": { "required": true, "type": "string" },
  5271. "team_id": { "required": true, "type": "integer" }
  5272. },
  5273. "url": "/teams/:team_id/repos/:owner/:repo"
  5274. },
  5275. "create": {
  5276. "method": "POST",
  5277. "params": {
  5278. "description": { "type": "string" },
  5279. "ldap_dn": { "type": "string" },
  5280. "maintainers": { "type": "string[]" },
  5281. "name": { "required": true, "type": "string" },
  5282. "org": { "required": true, "type": "string" },
  5283. "parent_team_id": { "type": "integer" },
  5284. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  5285. "privacy": { "enum": ["secret", "closed"], "type": "string" },
  5286. "repo_names": { "type": "string[]" }
  5287. },
  5288. "url": "/orgs/:org/teams"
  5289. },
  5290. "createDiscussion": {
  5291. "method": "POST",
  5292. "params": {
  5293. "body": { "required": true, "type": "string" },
  5294. "private": { "type": "boolean" },
  5295. "team_id": { "required": true, "type": "integer" },
  5296. "title": { "required": true, "type": "string" }
  5297. },
  5298. "url": "/teams/:team_id/discussions"
  5299. },
  5300. "createDiscussionComment": {
  5301. "method": "POST",
  5302. "params": {
  5303. "body": { "required": true, "type": "string" },
  5304. "discussion_number": { "required": true, "type": "integer" },
  5305. "team_id": { "required": true, "type": "integer" }
  5306. },
  5307. "url": "/teams/:team_id/discussions/:discussion_number/comments"
  5308. },
  5309. "delete": {
  5310. "method": "DELETE",
  5311. "params": { "team_id": { "required": true, "type": "integer" } },
  5312. "url": "/teams/:team_id"
  5313. },
  5314. "deleteDiscussion": {
  5315. "method": "DELETE",
  5316. "params": {
  5317. "discussion_number": { "required": true, "type": "integer" },
  5318. "team_id": { "required": true, "type": "integer" }
  5319. },
  5320. "url": "/teams/:team_id/discussions/:discussion_number"
  5321. },
  5322. "deleteDiscussionComment": {
  5323. "method": "DELETE",
  5324. "params": {
  5325. "comment_number": { "required": true, "type": "integer" },
  5326. "discussion_number": { "required": true, "type": "integer" },
  5327. "team_id": { "required": true, "type": "integer" }
  5328. },
  5329. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  5330. },
  5331. "get": {
  5332. "method": "GET",
  5333. "params": { "team_id": { "required": true, "type": "integer" } },
  5334. "url": "/teams/:team_id"
  5335. },
  5336. "getByName": {
  5337. "method": "GET",
  5338. "params": {
  5339. "org": { "required": true, "type": "string" },
  5340. "team_slug": { "required": true, "type": "string" }
  5341. },
  5342. "url": "/orgs/:org/teams/:team_slug"
  5343. },
  5344. "getDiscussion": {
  5345. "method": "GET",
  5346. "params": {
  5347. "discussion_number": { "required": true, "type": "integer" },
  5348. "team_id": { "required": true, "type": "integer" }
  5349. },
  5350. "url": "/teams/:team_id/discussions/:discussion_number"
  5351. },
  5352. "getDiscussionComment": {
  5353. "method": "GET",
  5354. "params": {
  5355. "comment_number": { "required": true, "type": "integer" },
  5356. "discussion_number": { "required": true, "type": "integer" },
  5357. "team_id": { "required": true, "type": "integer" }
  5358. },
  5359. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  5360. },
  5361. "getMember": {
  5362. "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/enterprise/2.19/v3/teams/members/#get-team-member",
  5363. "method": "GET",
  5364. "params": {
  5365. "team_id": { "required": true, "type": "integer" },
  5366. "username": { "required": true, "type": "string" }
  5367. },
  5368. "url": "/teams/:team_id/members/:username"
  5369. },
  5370. "getMembership": {
  5371. "method": "GET",
  5372. "params": {
  5373. "team_id": { "required": true, "type": "integer" },
  5374. "username": { "required": true, "type": "string" }
  5375. },
  5376. "url": "/teams/:team_id/memberships/:username"
  5377. },
  5378. "list": {
  5379. "method": "GET",
  5380. "params": {
  5381. "org": { "required": true, "type": "string" },
  5382. "page": { "type": "integer" },
  5383. "per_page": { "type": "integer" }
  5384. },
  5385. "url": "/orgs/:org/teams"
  5386. },
  5387. "listChild": {
  5388. "headers": { "accept": "application/vnd.github.hellcat-preview+json" },
  5389. "method": "GET",
  5390. "params": {
  5391. "page": { "type": "integer" },
  5392. "per_page": { "type": "integer" },
  5393. "team_id": { "required": true, "type": "integer" }
  5394. },
  5395. "url": "/teams/:team_id/teams"
  5396. },
  5397. "listDiscussionComments": {
  5398. "method": "GET",
  5399. "params": {
  5400. "direction": { "enum": ["asc", "desc"], "type": "string" },
  5401. "discussion_number": { "required": true, "type": "integer" },
  5402. "page": { "type": "integer" },
  5403. "per_page": { "type": "integer" },
  5404. "team_id": { "required": true, "type": "integer" }
  5405. },
  5406. "url": "/teams/:team_id/discussions/:discussion_number/comments"
  5407. },
  5408. "listDiscussions": {
  5409. "method": "GET",
  5410. "params": {
  5411. "direction": { "enum": ["asc", "desc"], "type": "string" },
  5412. "page": { "type": "integer" },
  5413. "per_page": { "type": "integer" },
  5414. "team_id": { "required": true, "type": "integer" }
  5415. },
  5416. "url": "/teams/:team_id/discussions"
  5417. },
  5418. "listForAuthenticatedUser": {
  5419. "method": "GET",
  5420. "params": {
  5421. "page": { "type": "integer" },
  5422. "per_page": { "type": "integer" }
  5423. },
  5424. "url": "/user/teams"
  5425. },
  5426. "listMembers": {
  5427. "method": "GET",
  5428. "params": {
  5429. "page": { "type": "integer" },
  5430. "per_page": { "type": "integer" },
  5431. "role": { "enum": ["member", "maintainer", "all"], "type": "string" },
  5432. "team_id": { "required": true, "type": "integer" }
  5433. },
  5434. "url": "/teams/:team_id/members"
  5435. },
  5436. "listProjects": {
  5437. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  5438. "method": "GET",
  5439. "params": {
  5440. "page": { "type": "integer" },
  5441. "per_page": { "type": "integer" },
  5442. "team_id": { "required": true, "type": "integer" }
  5443. },
  5444. "url": "/teams/:team_id/projects"
  5445. },
  5446. "listRepos": {
  5447. "method": "GET",
  5448. "params": {
  5449. "page": { "type": "integer" },
  5450. "per_page": { "type": "integer" },
  5451. "team_id": { "required": true, "type": "integer" }
  5452. },
  5453. "url": "/teams/:team_id/repos"
  5454. },
  5455. "removeMember": {
  5456. "deprecated": "octokit.teams.removeMember() is deprecated, see https://developer.github.com/enterprise/2.19/v3/teams/members/#remove-team-member",
  5457. "method": "DELETE",
  5458. "params": {
  5459. "team_id": { "required": true, "type": "integer" },
  5460. "username": { "required": true, "type": "string" }
  5461. },
  5462. "url": "/teams/:team_id/members/:username"
  5463. },
  5464. "removeMembership": {
  5465. "method": "DELETE",
  5466. "params": {
  5467. "team_id": { "required": true, "type": "integer" },
  5468. "username": { "required": true, "type": "string" }
  5469. },
  5470. "url": "/teams/:team_id/memberships/:username"
  5471. },
  5472. "removeProject": {
  5473. "method": "DELETE",
  5474. "params": {
  5475. "project_id": { "required": true, "type": "integer" },
  5476. "team_id": { "required": true, "type": "integer" }
  5477. },
  5478. "url": "/teams/:team_id/projects/:project_id"
  5479. },
  5480. "removeRepo": {
  5481. "method": "DELETE",
  5482. "params": {
  5483. "owner": { "required": true, "type": "string" },
  5484. "repo": { "required": true, "type": "string" },
  5485. "team_id": { "required": true, "type": "integer" }
  5486. },
  5487. "url": "/teams/:team_id/repos/:owner/:repo"
  5488. },
  5489. "reviewProject": {
  5490. "headers": { "accept": "application/vnd.github.inertia-preview+json" },
  5491. "method": "GET",
  5492. "params": {
  5493. "project_id": { "required": true, "type": "integer" },
  5494. "team_id": { "required": true, "type": "integer" }
  5495. },
  5496. "url": "/teams/:team_id/projects/:project_id"
  5497. },
  5498. "update": {
  5499. "method": "PATCH",
  5500. "params": {
  5501. "description": { "type": "string" },
  5502. "name": { "required": true, "type": "string" },
  5503. "parent_team_id": { "type": "integer" },
  5504. "permission": { "enum": ["pull", "push", "admin"], "type": "string" },
  5505. "privacy": { "enum": ["secret", "closed"], "type": "string" },
  5506. "team_id": { "required": true, "type": "integer" }
  5507. },
  5508. "url": "/teams/:team_id"
  5509. },
  5510. "updateDiscussion": {
  5511. "method": "PATCH",
  5512. "params": {
  5513. "body": { "type": "string" },
  5514. "discussion_number": { "required": true, "type": "integer" },
  5515. "team_id": { "required": true, "type": "integer" },
  5516. "title": { "type": "string" }
  5517. },
  5518. "url": "/teams/:team_id/discussions/:discussion_number"
  5519. },
  5520. "updateDiscussionComment": {
  5521. "method": "PATCH",
  5522. "params": {
  5523. "body": { "required": true, "type": "string" },
  5524. "comment_number": { "required": true, "type": "integer" },
  5525. "discussion_number": { "required": true, "type": "integer" },
  5526. "team_id": { "required": true, "type": "integer" }
  5527. },
  5528. "url": "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
  5529. }
  5530. },
  5531. "users": {
  5532. "addEmails": {
  5533. "method": "POST",
  5534. "params": { "emails": { "required": true, "type": "string[]" } },
  5535. "url": "/user/emails"
  5536. },
  5537. "checkFollowing": {
  5538. "method": "GET",
  5539. "params": { "username": { "required": true, "type": "string" } },
  5540. "url": "/user/following/:username"
  5541. },
  5542. "checkFollowingForUser": {
  5543. "method": "GET",
  5544. "params": {
  5545. "target_user": { "required": true, "type": "string" },
  5546. "username": { "required": true, "type": "string" }
  5547. },
  5548. "url": "/users/:username/following/:target_user"
  5549. },
  5550. "createGpgKey": {
  5551. "method": "POST",
  5552. "params": { "armored_public_key": { "type": "string" } },
  5553. "url": "/user/gpg_keys"
  5554. },
  5555. "createPublicKey": {
  5556. "method": "POST",
  5557. "params": { "key": { "type": "string" }, "title": { "type": "string" } },
  5558. "url": "/user/keys"
  5559. },
  5560. "deleteEmails": {
  5561. "method": "DELETE",
  5562. "params": { "emails": { "required": true, "type": "string[]" } },
  5563. "url": "/user/emails"
  5564. },
  5565. "deleteGpgKey": {
  5566. "method": "DELETE",
  5567. "params": { "gpg_key_id": { "required": true, "type": "integer" } },
  5568. "url": "/user/gpg_keys/:gpg_key_id"
  5569. },
  5570. "deletePublicKey": {
  5571. "method": "DELETE",
  5572. "params": { "key_id": { "required": true, "type": "integer" } },
  5573. "url": "/user/keys/:key_id"
  5574. },
  5575. "follow": {
  5576. "method": "PUT",
  5577. "params": { "username": { "required": true, "type": "string" } },
  5578. "url": "/user/following/:username"
  5579. },
  5580. "getAuthenticated": { "method": "GET", "params": {}, "url": "/user" },
  5581. "getByUsername": {
  5582. "method": "GET",
  5583. "params": { "username": { "required": true, "type": "string" } },
  5584. "url": "/users/:username"
  5585. },
  5586. "getContextForUser": {
  5587. "method": "GET",
  5588. "params": {
  5589. "subject_id": { "type": "string" },
  5590. "subject_type": {
  5591. "enum": ["organization", "repository", "issue", "pull_request"],
  5592. "type": "string"
  5593. },
  5594. "username": { "required": true, "type": "string" }
  5595. },
  5596. "url": "/users/:username/hovercard"
  5597. },
  5598. "getGpgKey": {
  5599. "method": "GET",
  5600. "params": { "gpg_key_id": { "required": true, "type": "integer" } },
  5601. "url": "/user/gpg_keys/:gpg_key_id"
  5602. },
  5603. "getPublicKey": {
  5604. "method": "GET",
  5605. "params": { "key_id": { "required": true, "type": "integer" } },
  5606. "url": "/user/keys/:key_id"
  5607. },
  5608. "list": {
  5609. "method": "GET",
  5610. "params": {
  5611. "page": { "type": "integer" },
  5612. "per_page": { "type": "integer" },
  5613. "since": { "type": "string" }
  5614. },
  5615. "url": "/users"
  5616. },
  5617. "listEmails": {
  5618. "method": "GET",
  5619. "params": {
  5620. "page": { "type": "integer" },
  5621. "per_page": { "type": "integer" }
  5622. },
  5623. "url": "/user/emails"
  5624. },
  5625. "listFollowersForAuthenticatedUser": {
  5626. "method": "GET",
  5627. "params": {
  5628. "page": { "type": "integer" },
  5629. "per_page": { "type": "integer" }
  5630. },
  5631. "url": "/user/followers"
  5632. },
  5633. "listFollowersForUser": {
  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/followers"
  5641. },
  5642. "listFollowingForAuthenticatedUser": {
  5643. "method": "GET",
  5644. "params": {
  5645. "page": { "type": "integer" },
  5646. "per_page": { "type": "integer" }
  5647. },
  5648. "url": "/user/following"
  5649. },
  5650. "listFollowingForUser": {
  5651. "method": "GET",
  5652. "params": {
  5653. "page": { "type": "integer" },
  5654. "per_page": { "type": "integer" },
  5655. "username": { "required": true, "type": "string" }
  5656. },
  5657. "url": "/users/:username/following"
  5658. },
  5659. "listGpgKeys": {
  5660. "method": "GET",
  5661. "params": {
  5662. "page": { "type": "integer" },
  5663. "per_page": { "type": "integer" }
  5664. },
  5665. "url": "/user/gpg_keys"
  5666. },
  5667. "listGpgKeysForUser": {
  5668. "method": "GET",
  5669. "params": {
  5670. "page": { "type": "integer" },
  5671. "per_page": { "type": "integer" },
  5672. "username": { "required": true, "type": "string" }
  5673. },
  5674. "url": "/users/:username/gpg_keys"
  5675. },
  5676. "listPublicEmails": {
  5677. "method": "GET",
  5678. "params": {
  5679. "page": { "type": "integer" },
  5680. "per_page": { "type": "integer" }
  5681. },
  5682. "url": "/user/public_emails"
  5683. },
  5684. "listPublicKeys": {
  5685. "method": "GET",
  5686. "params": {
  5687. "page": { "type": "integer" },
  5688. "per_page": { "type": "integer" }
  5689. },
  5690. "url": "/user/keys"
  5691. },
  5692. "listPublicKeysForUser": {
  5693. "method": "GET",
  5694. "params": {
  5695. "page": { "type": "integer" },
  5696. "per_page": { "type": "integer" },
  5697. "username": { "required": true, "type": "string" }
  5698. },
  5699. "url": "/users/:username/keys"
  5700. },
  5701. "unfollow": {
  5702. "method": "DELETE",
  5703. "params": { "username": { "required": true, "type": "string" } },
  5704. "url": "/user/following/:username"
  5705. },
  5706. "updateAuthenticated": {
  5707. "method": "PATCH",
  5708. "params": {
  5709. "bio": { "type": "string" },
  5710. "blog": { "type": "string" },
  5711. "company": { "type": "string" },
  5712. "email": { "type": "string" },
  5713. "hireable": { "type": "boolean" },
  5714. "location": { "type": "string" },
  5715. "name": { "type": "string" }
  5716. },
  5717. "url": "/user"
  5718. }
  5719. }
  5720. }