index.js 273 KB

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