endpoints.js 269 KB

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