123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726 |
- import { Deprecation } from 'deprecation';
- var endpointsByScope = {
- actions: {
- cancelWorkflowRun: {
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- run_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runs/:run_id/cancel"
- },
- createOrUpdateSecretForRepo: {
- method: "PUT",
- params: {
- encrypted_value: { type: "string" },
- key_id: { type: "string" },
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/secrets/:name"
- },
- createRegistrationToken: {
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/runners/registration-token"
- },
- createRemoveToken: {
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/runners/remove-token"
- },
- deleteArtifact: {
- method: "DELETE",
- params: {
- artifact_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"
- },
- deleteSecretFromRepo: {
- method: "DELETE",
- params: {
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/secrets/:name"
- },
- downloadArtifact: {
- method: "GET",
- params: {
- archive_format: { required: true, type: "string" },
- artifact_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format"
- },
- getArtifact: {
- method: "GET",
- params: {
- artifact_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/artifacts/:artifact_id"
- },
- getPublicKey: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/secrets/public-key"
- },
- getSecret: {
- method: "GET",
- params: {
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/secrets/:name"
- },
- getSelfHostedRunner: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- runner_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runners/:runner_id"
- },
- getWorkflow: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- workflow_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/workflows/:workflow_id"
- },
- getWorkflowJob: {
- method: "GET",
- params: {
- job_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/jobs/:job_id"
- },
- getWorkflowRun: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- run_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runs/:run_id"
- },
- listDownloadsForSelfHostedRunnerApplication: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/runners/downloads"
- },
- listJobsForWorkflowRun: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- run_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runs/:run_id/jobs"
- },
- listRepoWorkflowRuns: {
- method: "GET",
- params: {
- actor: { type: "string" },
- branch: { type: "string" },
- event: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- status: { enum: ["completed", "status", "conclusion"], type: "string" }
- },
- url: "/repos/:owner/:repo/actions/runs"
- },
- listRepoWorkflows: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/workflows"
- },
- listSecretsForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/secrets"
- },
- listSelfHostedRunnersForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/runners"
- },
- listWorkflowJobLogs: {
- method: "GET",
- params: {
- job_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/actions/jobs/:job_id/logs"
- },
- listWorkflowRunArtifacts: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- run_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts"
- },
- listWorkflowRunLogs: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- run_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runs/:run_id/logs"
- },
- listWorkflowRuns: {
- method: "GET",
- params: {
- actor: { type: "string" },
- branch: { type: "string" },
- event: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- status: { enum: ["completed", "status", "conclusion"], type: "string" },
- workflow_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs"
- },
- reRunWorkflow: {
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- run_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runs/:run_id/rerun"
- },
- removeSelfHostedRunner: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- runner_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/actions/runners/:runner_id"
- }
- },
- activity: {
- checkStarringRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/user/starred/:owner/:repo"
- },
- deleteRepoSubscription: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/subscription"
- },
- deleteThreadSubscription: {
- method: "DELETE",
- params: { thread_id: { required: true, type: "integer" } },
- url: "/notifications/threads/:thread_id/subscription"
- },
- getRepoSubscription: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/subscription"
- },
- getThread: {
- method: "GET",
- params: { thread_id: { required: true, type: "integer" } },
- url: "/notifications/threads/:thread_id"
- },
- getThreadSubscription: {
- method: "GET",
- params: { thread_id: { required: true, type: "integer" } },
- url: "/notifications/threads/:thread_id/subscription"
- },
- listEventsForOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/events/orgs/:org"
- },
- listEventsForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/events"
- },
- listFeeds: { method: "GET", params: {}, url: "/feeds" },
- listNotifications: {
- method: "GET",
- params: {
- all: { type: "boolean" },
- before: { type: "string" },
- page: { type: "integer" },
- participating: { type: "boolean" },
- per_page: { type: "integer" },
- since: { type: "string" }
- },
- url: "/notifications"
- },
- listNotificationsForRepo: {
- method: "GET",
- params: {
- all: { type: "boolean" },
- before: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- participating: { type: "boolean" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- since: { type: "string" }
- },
- url: "/repos/:owner/:repo/notifications"
- },
- listPublicEvents: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/events"
- },
- listPublicEventsForOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/events"
- },
- listPublicEventsForRepoNetwork: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/networks/:owner/:repo/events"
- },
- listPublicEventsForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/events/public"
- },
- listReceivedEventsForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/received_events"
- },
- listReceivedPublicEventsForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/received_events/public"
- },
- listRepoEvents: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/events"
- },
- listReposStarredByAuthenticatedUser: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/user/starred"
- },
- listReposStarredByUser: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- sort: { enum: ["created", "updated"], type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/starred"
- },
- listReposWatchedByUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/subscriptions"
- },
- listStargazersForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/stargazers"
- },
- listWatchedReposForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/subscriptions"
- },
- listWatchersForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/subscribers"
- },
- markAsRead: {
- method: "PUT",
- params: { last_read_at: { type: "string" } },
- url: "/notifications"
- },
- markNotificationsAsReadForRepo: {
- method: "PUT",
- params: {
- last_read_at: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/notifications"
- },
- markThreadAsRead: {
- method: "PATCH",
- params: { thread_id: { required: true, type: "integer" } },
- url: "/notifications/threads/:thread_id"
- },
- setRepoSubscription: {
- method: "PUT",
- params: {
- ignored: { type: "boolean" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- subscribed: { type: "boolean" }
- },
- url: "/repos/:owner/:repo/subscription"
- },
- setThreadSubscription: {
- method: "PUT",
- params: {
- ignored: { type: "boolean" },
- thread_id: { required: true, type: "integer" }
- },
- url: "/notifications/threads/:thread_id/subscription"
- },
- starRepo: {
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/user/starred/:owner/:repo"
- },
- unstarRepo: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/user/starred/:owner/:repo"
- }
- },
- apps: {
- addRepoToInstallation: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "PUT",
- params: {
- installation_id: { required: true, type: "integer" },
- repository_id: { required: true, type: "integer" }
- },
- url: "/user/installations/:installation_id/repositories/:repository_id"
- },
- checkAccountIsAssociatedWithAny: {
- method: "GET",
- params: { account_id: { required: true, type: "integer" } },
- url: "/marketplace_listing/accounts/:account_id"
- },
- checkAccountIsAssociatedWithAnyStubbed: {
- method: "GET",
- params: { account_id: { required: true, type: "integer" } },
- url: "/marketplace_listing/stubbed/accounts/:account_id"
- },
- checkAuthorization: {
- deprecated: "octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization",
- method: "GET",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/tokens/:access_token"
- },
- checkToken: {
- headers: { accept: "application/vnd.github.doctor-strange-preview+json" },
- method: "POST",
- params: {
- access_token: { type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/token"
- },
- createContentAttachment: {
- headers: { accept: "application/vnd.github.corsair-preview+json" },
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- content_reference_id: { required: true, type: "integer" },
- title: { required: true, type: "string" }
- },
- url: "/content_references/:content_reference_id/attachments"
- },
- createFromManifest: {
- headers: { accept: "application/vnd.github.fury-preview+json" },
- method: "POST",
- params: { code: { required: true, type: "string" } },
- url: "/app-manifests/:code/conversions"
- },
- createInstallationToken: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "POST",
- params: {
- installation_id: { required: true, type: "integer" },
- permissions: { type: "object" },
- repository_ids: { type: "integer[]" }
- },
- url: "/app/installations/:installation_id/access_tokens"
- },
- deleteAuthorization: {
- headers: { accept: "application/vnd.github.doctor-strange-preview+json" },
- method: "DELETE",
- params: {
- access_token: { type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/grant"
- },
- deleteInstallation: {
- headers: {
- accept: "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
- },
- method: "DELETE",
- params: { installation_id: { required: true, type: "integer" } },
- url: "/app/installations/:installation_id"
- },
- deleteToken: {
- headers: { accept: "application/vnd.github.doctor-strange-preview+json" },
- method: "DELETE",
- params: {
- access_token: { type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/token"
- },
- findOrgInstallation: {
- deprecated: "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)",
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { org: { required: true, type: "string" } },
- url: "/orgs/:org/installation"
- },
- findRepoInstallation: {
- deprecated: "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)",
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/installation"
- },
- findUserInstallation: {
- deprecated: "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)",
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { username: { required: true, type: "string" } },
- url: "/users/:username/installation"
- },
- getAuthenticated: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: {},
- url: "/app"
- },
- getBySlug: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { app_slug: { required: true, type: "string" } },
- url: "/apps/:app_slug"
- },
- getInstallation: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { installation_id: { required: true, type: "integer" } },
- url: "/app/installations/:installation_id"
- },
- getOrgInstallation: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { org: { required: true, type: "string" } },
- url: "/orgs/:org/installation"
- },
- getRepoInstallation: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/installation"
- },
- getUserInstallation: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { username: { required: true, type: "string" } },
- url: "/users/:username/installation"
- },
- listAccountsUserOrOrgOnPlan: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- plan_id: { required: true, type: "integer" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/marketplace_listing/plans/:plan_id/accounts"
- },
- listAccountsUserOrOrgOnPlanStubbed: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- plan_id: { required: true, type: "integer" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/marketplace_listing/stubbed/plans/:plan_id/accounts"
- },
- listInstallationReposForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: {
- installation_id: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/user/installations/:installation_id/repositories"
- },
- listInstallations: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/app/installations"
- },
- listInstallationsForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/installations"
- },
- listMarketplacePurchasesForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/marketplace_purchases"
- },
- listMarketplacePurchasesForAuthenticatedUserStubbed: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/marketplace_purchases/stubbed"
- },
- listPlans: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/marketplace_listing/plans"
- },
- listPlansStubbed: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/marketplace_listing/stubbed/plans"
- },
- listRepos: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/installation/repositories"
- },
- removeRepoFromInstallation: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "DELETE",
- params: {
- installation_id: { required: true, type: "integer" },
- repository_id: { required: true, type: "integer" }
- },
- url: "/user/installations/:installation_id/repositories/:repository_id"
- },
- resetAuthorization: {
- deprecated: "octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization",
- method: "POST",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/tokens/:access_token"
- },
- resetToken: {
- headers: { accept: "application/vnd.github.doctor-strange-preview+json" },
- method: "PATCH",
- params: {
- access_token: { type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/token"
- },
- revokeAuthorizationForApplication: {
- deprecated: "octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application",
- method: "DELETE",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/tokens/:access_token"
- },
- revokeGrantForApplication: {
- deprecated: "octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application",
- method: "DELETE",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/grants/:access_token"
- },
- revokeInstallationToken: {
- headers: { accept: "application/vnd.github.gambit-preview+json" },
- method: "DELETE",
- params: {},
- url: "/installation/token"
- }
- },
- checks: {
- create: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "POST",
- params: {
- actions: { type: "object[]" },
- "actions[].description": { required: true, type: "string" },
- "actions[].identifier": { required: true, type: "string" },
- "actions[].label": { required: true, type: "string" },
- completed_at: { type: "string" },
- conclusion: {
- enum: [
- "success",
- "failure",
- "neutral",
- "cancelled",
- "timed_out",
- "action_required"
- ],
- type: "string"
- },
- details_url: { type: "string" },
- external_id: { type: "string" },
- head_sha: { required: true, type: "string" },
- name: { required: true, type: "string" },
- output: { type: "object" },
- "output.annotations": { type: "object[]" },
- "output.annotations[].annotation_level": {
- enum: ["notice", "warning", "failure"],
- required: true,
- type: "string"
- },
- "output.annotations[].end_column": { type: "integer" },
- "output.annotations[].end_line": { required: true, type: "integer" },
- "output.annotations[].message": { required: true, type: "string" },
- "output.annotations[].path": { required: true, type: "string" },
- "output.annotations[].raw_details": { type: "string" },
- "output.annotations[].start_column": { type: "integer" },
- "output.annotations[].start_line": { required: true, type: "integer" },
- "output.annotations[].title": { type: "string" },
- "output.images": { type: "object[]" },
- "output.images[].alt": { required: true, type: "string" },
- "output.images[].caption": { type: "string" },
- "output.images[].image_url": { required: true, type: "string" },
- "output.summary": { required: true, type: "string" },
- "output.text": { type: "string" },
- "output.title": { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- started_at: { type: "string" },
- status: { enum: ["queued", "in_progress", "completed"], type: "string" }
- },
- url: "/repos/:owner/:repo/check-runs"
- },
- createSuite: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "POST",
- params: {
- head_sha: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/check-suites"
- },
- get: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "GET",
- params: {
- check_run_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/check-runs/:check_run_id"
- },
- getSuite: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "GET",
- params: {
- check_suite_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/check-suites/:check_suite_id"
- },
- listAnnotations: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "GET",
- params: {
- check_run_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/check-runs/:check_run_id/annotations"
- },
- listForRef: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "GET",
- params: {
- check_name: { type: "string" },
- filter: { enum: ["latest", "all"], type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- status: { enum: ["queued", "in_progress", "completed"], type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:ref/check-runs"
- },
- listForSuite: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "GET",
- params: {
- check_name: { type: "string" },
- check_suite_id: { required: true, type: "integer" },
- filter: { enum: ["latest", "all"], type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- status: { enum: ["queued", "in_progress", "completed"], type: "string" }
- },
- url: "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs"
- },
- listSuitesForRef: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "GET",
- params: {
- app_id: { type: "integer" },
- check_name: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:ref/check-suites"
- },
- rerequestSuite: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "POST",
- params: {
- check_suite_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest"
- },
- setSuitesPreferences: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "PATCH",
- params: {
- auto_trigger_checks: { type: "object[]" },
- "auto_trigger_checks[].app_id": { required: true, type: "integer" },
- "auto_trigger_checks[].setting": { required: true, type: "boolean" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/check-suites/preferences"
- },
- update: {
- headers: { accept: "application/vnd.github.antiope-preview+json" },
- method: "PATCH",
- params: {
- actions: { type: "object[]" },
- "actions[].description": { required: true, type: "string" },
- "actions[].identifier": { required: true, type: "string" },
- "actions[].label": { required: true, type: "string" },
- check_run_id: { required: true, type: "integer" },
- completed_at: { type: "string" },
- conclusion: {
- enum: [
- "success",
- "failure",
- "neutral",
- "cancelled",
- "timed_out",
- "action_required"
- ],
- type: "string"
- },
- details_url: { type: "string" },
- external_id: { type: "string" },
- name: { type: "string" },
- output: { type: "object" },
- "output.annotations": { type: "object[]" },
- "output.annotations[].annotation_level": {
- enum: ["notice", "warning", "failure"],
- required: true,
- type: "string"
- },
- "output.annotations[].end_column": { type: "integer" },
- "output.annotations[].end_line": { required: true, type: "integer" },
- "output.annotations[].message": { required: true, type: "string" },
- "output.annotations[].path": { required: true, type: "string" },
- "output.annotations[].raw_details": { type: "string" },
- "output.annotations[].start_column": { type: "integer" },
- "output.annotations[].start_line": { required: true, type: "integer" },
- "output.annotations[].title": { type: "string" },
- "output.images": { type: "object[]" },
- "output.images[].alt": { required: true, type: "string" },
- "output.images[].caption": { type: "string" },
- "output.images[].image_url": { required: true, type: "string" },
- "output.summary": { required: true, type: "string" },
- "output.text": { type: "string" },
- "output.title": { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- started_at: { type: "string" },
- status: { enum: ["queued", "in_progress", "completed"], type: "string" }
- },
- url: "/repos/:owner/:repo/check-runs/:check_run_id"
- }
- },
- codesOfConduct: {
- getConductCode: {
- headers: { accept: "application/vnd.github.scarlet-witch-preview+json" },
- method: "GET",
- params: { key: { required: true, type: "string" } },
- url: "/codes_of_conduct/:key"
- },
- getForRepo: {
- headers: { accept: "application/vnd.github.scarlet-witch-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/community/code_of_conduct"
- },
- listConductCodes: {
- headers: { accept: "application/vnd.github.scarlet-witch-preview+json" },
- method: "GET",
- params: {},
- url: "/codes_of_conduct"
- }
- },
- emojis: { get: { method: "GET", params: {}, url: "/emojis" } },
- gists: {
- checkIsStarred: {
- method: "GET",
- params: { gist_id: { required: true, type: "string" } },
- url: "/gists/:gist_id/star"
- },
- create: {
- method: "POST",
- params: {
- description: { type: "string" },
- files: { required: true, type: "object" },
- "files.content": { type: "string" },
- public: { type: "boolean" }
- },
- url: "/gists"
- },
- createComment: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- gist_id: { required: true, type: "string" }
- },
- url: "/gists/:gist_id/comments"
- },
- delete: {
- method: "DELETE",
- params: { gist_id: { required: true, type: "string" } },
- url: "/gists/:gist_id"
- },
- deleteComment: {
- method: "DELETE",
- params: {
- comment_id: { required: true, type: "integer" },
- gist_id: { required: true, type: "string" }
- },
- url: "/gists/:gist_id/comments/:comment_id"
- },
- fork: {
- method: "POST",
- params: { gist_id: { required: true, type: "string" } },
- url: "/gists/:gist_id/forks"
- },
- get: {
- method: "GET",
- params: { gist_id: { required: true, type: "string" } },
- url: "/gists/:gist_id"
- },
- getComment: {
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- gist_id: { required: true, type: "string" }
- },
- url: "/gists/:gist_id/comments/:comment_id"
- },
- getRevision: {
- method: "GET",
- params: {
- gist_id: { required: true, type: "string" },
- sha: { required: true, type: "string" }
- },
- url: "/gists/:gist_id/:sha"
- },
- list: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" }
- },
- url: "/gists"
- },
- listComments: {
- method: "GET",
- params: {
- gist_id: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/gists/:gist_id/comments"
- },
- listCommits: {
- method: "GET",
- params: {
- gist_id: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/gists/:gist_id/commits"
- },
- listForks: {
- method: "GET",
- params: {
- gist_id: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/gists/:gist_id/forks"
- },
- listPublic: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" }
- },
- url: "/gists/public"
- },
- listPublicForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/gists"
- },
- listStarred: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" }
- },
- url: "/gists/starred"
- },
- star: {
- method: "PUT",
- params: { gist_id: { required: true, type: "string" } },
- url: "/gists/:gist_id/star"
- },
- unstar: {
- method: "DELETE",
- params: { gist_id: { required: true, type: "string" } },
- url: "/gists/:gist_id/star"
- },
- update: {
- method: "PATCH",
- params: {
- description: { type: "string" },
- files: { type: "object" },
- "files.content": { type: "string" },
- "files.filename": { type: "string" },
- gist_id: { required: true, type: "string" }
- },
- url: "/gists/:gist_id"
- },
- updateComment: {
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_id: { required: true, type: "integer" },
- gist_id: { required: true, type: "string" }
- },
- url: "/gists/:gist_id/comments/:comment_id"
- }
- },
- git: {
- createBlob: {
- method: "POST",
- params: {
- content: { required: true, type: "string" },
- encoding: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/blobs"
- },
- createCommit: {
- method: "POST",
- params: {
- author: { type: "object" },
- "author.date": { type: "string" },
- "author.email": { type: "string" },
- "author.name": { type: "string" },
- committer: { type: "object" },
- "committer.date": { type: "string" },
- "committer.email": { type: "string" },
- "committer.name": { type: "string" },
- message: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- parents: { required: true, type: "string[]" },
- repo: { required: true, type: "string" },
- signature: { type: "string" },
- tree: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/commits"
- },
- createRef: {
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/refs"
- },
- createTag: {
- method: "POST",
- params: {
- message: { required: true, type: "string" },
- object: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- tag: { required: true, type: "string" },
- tagger: { type: "object" },
- "tagger.date": { type: "string" },
- "tagger.email": { type: "string" },
- "tagger.name": { type: "string" },
- type: {
- enum: ["commit", "tree", "blob"],
- required: true,
- type: "string"
- }
- },
- url: "/repos/:owner/:repo/git/tags"
- },
- createTree: {
- method: "POST",
- params: {
- base_tree: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- tree: { required: true, type: "object[]" },
- "tree[].content": { type: "string" },
- "tree[].mode": {
- enum: ["100644", "100755", "040000", "160000", "120000"],
- type: "string"
- },
- "tree[].path": { type: "string" },
- "tree[].sha": { allowNull: true, type: "string" },
- "tree[].type": { enum: ["blob", "tree", "commit"], type: "string" }
- },
- url: "/repos/:owner/:repo/git/trees"
- },
- deleteRef: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/refs/:ref"
- },
- getBlob: {
- method: "GET",
- params: {
- file_sha: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/blobs/:file_sha"
- },
- getCommit: {
- method: "GET",
- params: {
- commit_sha: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/commits/:commit_sha"
- },
- getRef: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/ref/:ref"
- },
- getTag: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- tag_sha: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/tags/:tag_sha"
- },
- getTree: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- recursive: { enum: ["1"], type: "integer" },
- repo: { required: true, type: "string" },
- tree_sha: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/trees/:tree_sha"
- },
- listMatchingRefs: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/matching-refs/:ref"
- },
- listRefs: {
- method: "GET",
- params: {
- namespace: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/refs/:namespace"
- },
- updateRef: {
- method: "PATCH",
- params: {
- force: { type: "boolean" },
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/git/refs/:ref"
- }
- },
- gitignore: {
- getTemplate: {
- method: "GET",
- params: { name: { required: true, type: "string" } },
- url: "/gitignore/templates/:name"
- },
- listTemplates: { method: "GET", params: {}, url: "/gitignore/templates" }
- },
- interactions: {
- addOrUpdateRestrictionsForOrg: {
- headers: { accept: "application/vnd.github.sombra-preview+json" },
- method: "PUT",
- params: {
- limit: {
- enum: ["existing_users", "contributors_only", "collaborators_only"],
- required: true,
- type: "string"
- },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/interaction-limits"
- },
- addOrUpdateRestrictionsForRepo: {
- headers: { accept: "application/vnd.github.sombra-preview+json" },
- method: "PUT",
- params: {
- limit: {
- enum: ["existing_users", "contributors_only", "collaborators_only"],
- required: true,
- type: "string"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/interaction-limits"
- },
- getRestrictionsForOrg: {
- headers: { accept: "application/vnd.github.sombra-preview+json" },
- method: "GET",
- params: { org: { required: true, type: "string" } },
- url: "/orgs/:org/interaction-limits"
- },
- getRestrictionsForRepo: {
- headers: { accept: "application/vnd.github.sombra-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/interaction-limits"
- },
- removeRestrictionsForOrg: {
- headers: { accept: "application/vnd.github.sombra-preview+json" },
- method: "DELETE",
- params: { org: { required: true, type: "string" } },
- url: "/orgs/:org/interaction-limits"
- },
- removeRestrictionsForRepo: {
- headers: { accept: "application/vnd.github.sombra-preview+json" },
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/interaction-limits"
- }
- },
- issues: {
- addAssignees: {
- method: "POST",
- params: {
- assignees: { type: "string[]" },
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/assignees"
- },
- addLabels: {
- method: "POST",
- params: {
- issue_number: { required: true, type: "integer" },
- labels: { required: true, type: "string[]" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- checkAssignee: {
- method: "GET",
- params: {
- assignee: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/assignees/:assignee"
- },
- create: {
- method: "POST",
- params: {
- assignee: { type: "string" },
- assignees: { type: "string[]" },
- body: { type: "string" },
- labels: { type: "string[]" },
- milestone: { type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- title: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues"
- },
- createComment: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/comments"
- },
- createLabel: {
- method: "POST",
- params: {
- color: { required: true, type: "string" },
- description: { type: "string" },
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/labels"
- },
- createMilestone: {
- method: "POST",
- params: {
- description: { type: "string" },
- due_on: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- state: { enum: ["open", "closed"], type: "string" },
- title: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/milestones"
- },
- deleteComment: {
- method: "DELETE",
- params: {
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/comments/:comment_id"
- },
- deleteLabel: {
- method: "DELETE",
- params: {
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/labels/:name"
- },
- deleteMilestone: {
- method: "DELETE",
- params: {
- milestone_number: { required: true, type: "integer" },
- number: {
- alias: "milestone_number",
- deprecated: true,
- type: "integer"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/milestones/:milestone_number"
- },
- get: {
- method: "GET",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number"
- },
- getComment: {
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/comments/:comment_id"
- },
- getEvent: {
- method: "GET",
- params: {
- event_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/events/:event_id"
- },
- getLabel: {
- method: "GET",
- params: {
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/labels/:name"
- },
- getMilestone: {
- method: "GET",
- params: {
- milestone_number: { required: true, type: "integer" },
- number: {
- alias: "milestone_number",
- deprecated: true,
- type: "integer"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/milestones/:milestone_number"
- },
- list: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- filter: {
- enum: ["assigned", "created", "mentioned", "subscribed", "all"],
- type: "string"
- },
- labels: { type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" },
- sort: { enum: ["created", "updated", "comments"], type: "string" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/issues"
- },
- listAssignees: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/assignees"
- },
- listComments: {
- method: "GET",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- since: { type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/comments"
- },
- listCommentsForRepo: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- since: { type: "string" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/repos/:owner/:repo/issues/comments"
- },
- listEvents: {
- method: "GET",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/events"
- },
- listEventsForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/events"
- },
- listEventsForTimeline: {
- headers: { accept: "application/vnd.github.mockingbird-preview+json" },
- method: "GET",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/timeline"
- },
- listForAuthenticatedUser: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- filter: {
- enum: ["assigned", "created", "mentioned", "subscribed", "all"],
- type: "string"
- },
- labels: { type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" },
- sort: { enum: ["created", "updated", "comments"], type: "string" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/user/issues"
- },
- listForOrg: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- filter: {
- enum: ["assigned", "created", "mentioned", "subscribed", "all"],
- type: "string"
- },
- labels: { type: "string" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" },
- sort: { enum: ["created", "updated", "comments"], type: "string" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/orgs/:org/issues"
- },
- listForRepo: {
- method: "GET",
- params: {
- assignee: { type: "string" },
- creator: { type: "string" },
- direction: { enum: ["asc", "desc"], type: "string" },
- labels: { type: "string" },
- mentioned: { type: "string" },
- milestone: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- since: { type: "string" },
- sort: { enum: ["created", "updated", "comments"], type: "string" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/repos/:owner/:repo/issues"
- },
- listLabelsForMilestone: {
- method: "GET",
- params: {
- milestone_number: { required: true, type: "integer" },
- number: {
- alias: "milestone_number",
- deprecated: true,
- type: "integer"
- },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/milestones/:milestone_number/labels"
- },
- listLabelsForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/labels"
- },
- listLabelsOnIssue: {
- method: "GET",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- listMilestonesForRepo: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- sort: { enum: ["due_on", "completeness"], type: "string" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/repos/:owner/:repo/milestones"
- },
- lock: {
- method: "PUT",
- params: {
- issue_number: { required: true, type: "integer" },
- lock_reason: {
- enum: ["off-topic", "too heated", "resolved", "spam"],
- type: "string"
- },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/lock"
- },
- removeAssignees: {
- method: "DELETE",
- params: {
- assignees: { type: "string[]" },
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/assignees"
- },
- removeLabel: {
- method: "DELETE",
- params: {
- issue_number: { required: true, type: "integer" },
- name: { required: true, type: "string" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/labels/:name"
- },
- removeLabels: {
- method: "DELETE",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- replaceLabels: {
- method: "PUT",
- params: {
- issue_number: { required: true, type: "integer" },
- labels: { type: "string[]" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/labels"
- },
- unlock: {
- method: "DELETE",
- params: {
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/lock"
- },
- update: {
- method: "PATCH",
- params: {
- assignee: { type: "string" },
- assignees: { type: "string[]" },
- body: { type: "string" },
- issue_number: { required: true, type: "integer" },
- labels: { type: "string[]" },
- milestone: { allowNull: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- state: { enum: ["open", "closed"], type: "string" },
- title: { type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number"
- },
- updateComment: {
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/comments/:comment_id"
- },
- updateLabel: {
- method: "PATCH",
- params: {
- color: { type: "string" },
- current_name: { required: true, type: "string" },
- description: { type: "string" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/labels/:current_name"
- },
- updateMilestone: {
- method: "PATCH",
- params: {
- description: { type: "string" },
- due_on: { type: "string" },
- milestone_number: { required: true, type: "integer" },
- number: {
- alias: "milestone_number",
- deprecated: true,
- type: "integer"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- state: { enum: ["open", "closed"], type: "string" },
- title: { type: "string" }
- },
- url: "/repos/:owner/:repo/milestones/:milestone_number"
- }
- },
- licenses: {
- get: {
- method: "GET",
- params: { license: { required: true, type: "string" } },
- url: "/licenses/:license"
- },
- getForRepo: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/license"
- },
- list: {
- deprecated: "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
- method: "GET",
- params: {},
- url: "/licenses"
- },
- listCommonlyUsed: { method: "GET", params: {}, url: "/licenses" }
- },
- markdown: {
- render: {
- method: "POST",
- params: {
- context: { type: "string" },
- mode: { enum: ["markdown", "gfm"], type: "string" },
- text: { required: true, type: "string" }
- },
- url: "/markdown"
- },
- renderRaw: {
- headers: { "content-type": "text/plain; charset=utf-8" },
- method: "POST",
- params: { data: { mapTo: "data", required: true, type: "string" } },
- url: "/markdown/raw"
- }
- },
- meta: { get: { method: "GET", params: {}, url: "/meta" } },
- migrations: {
- cancelImport: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/import"
- },
- deleteArchiveForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "DELETE",
- params: { migration_id: { required: true, type: "integer" } },
- url: "/user/migrations/:migration_id/archive"
- },
- deleteArchiveForOrg: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "DELETE",
- params: {
- migration_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/migrations/:migration_id/archive"
- },
- downloadArchiveForOrg: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: {
- migration_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/migrations/:migration_id/archive"
- },
- getArchiveForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: { migration_id: { required: true, type: "integer" } },
- url: "/user/migrations/:migration_id/archive"
- },
- getArchiveForOrg: {
- deprecated: "octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() (2020-01-27)",
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: {
- migration_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/migrations/:migration_id/archive"
- },
- getCommitAuthors: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- since: { type: "string" }
- },
- url: "/repos/:owner/:repo/import/authors"
- },
- getImportProgress: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/import"
- },
- getLargeFiles: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/import/large_files"
- },
- getStatusForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: { migration_id: { required: true, type: "integer" } },
- url: "/user/migrations/:migration_id"
- },
- getStatusForOrg: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: {
- migration_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/migrations/:migration_id"
- },
- listForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/migrations"
- },
- listForOrg: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/migrations"
- },
- listReposForOrg: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: {
- migration_id: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/migrations/:migration_id/repositories"
- },
- listReposForUser: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "GET",
- params: {
- migration_id: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/user/:migration_id/repositories"
- },
- mapCommitAuthor: {
- method: "PATCH",
- params: {
- author_id: { required: true, type: "integer" },
- email: { type: "string" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/import/authors/:author_id"
- },
- setLfsPreference: {
- method: "PATCH",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- use_lfs: { enum: ["opt_in", "opt_out"], required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/import/lfs"
- },
- startForAuthenticatedUser: {
- method: "POST",
- params: {
- exclude_attachments: { type: "boolean" },
- lock_repositories: { type: "boolean" },
- repositories: { required: true, type: "string[]" }
- },
- url: "/user/migrations"
- },
- startForOrg: {
- method: "POST",
- params: {
- exclude_attachments: { type: "boolean" },
- lock_repositories: { type: "boolean" },
- org: { required: true, type: "string" },
- repositories: { required: true, type: "string[]" }
- },
- url: "/orgs/:org/migrations"
- },
- startImport: {
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- tfvc_project: { type: "string" },
- vcs: {
- enum: ["subversion", "git", "mercurial", "tfvc"],
- type: "string"
- },
- vcs_password: { type: "string" },
- vcs_url: { required: true, type: "string" },
- vcs_username: { type: "string" }
- },
- url: "/repos/:owner/:repo/import"
- },
- unlockRepoForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "DELETE",
- params: {
- migration_id: { required: true, type: "integer" },
- repo_name: { required: true, type: "string" }
- },
- url: "/user/migrations/:migration_id/repos/:repo_name/lock"
- },
- unlockRepoForOrg: {
- headers: { accept: "application/vnd.github.wyandotte-preview+json" },
- method: "DELETE",
- params: {
- migration_id: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- repo_name: { required: true, type: "string" }
- },
- url: "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"
- },
- updateImport: {
- method: "PATCH",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- vcs_password: { type: "string" },
- vcs_username: { type: "string" }
- },
- url: "/repos/:owner/:repo/import"
- }
- },
- oauthAuthorizations: {
- checkAuthorization: {
- deprecated: "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)",
- method: "GET",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/tokens/:access_token"
- },
- createAuthorization: {
- deprecated: "octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization",
- method: "POST",
- params: {
- client_id: { type: "string" },
- client_secret: { type: "string" },
- fingerprint: { type: "string" },
- note: { required: true, type: "string" },
- note_url: { type: "string" },
- scopes: { type: "string[]" }
- },
- url: "/authorizations"
- },
- deleteAuthorization: {
- deprecated: "octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization",
- method: "DELETE",
- params: { authorization_id: { required: true, type: "integer" } },
- url: "/authorizations/:authorization_id"
- },
- deleteGrant: {
- deprecated: "octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant",
- method: "DELETE",
- params: { grant_id: { required: true, type: "integer" } },
- url: "/applications/grants/:grant_id"
- },
- getAuthorization: {
- deprecated: "octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization",
- method: "GET",
- params: { authorization_id: { required: true, type: "integer" } },
- url: "/authorizations/:authorization_id"
- },
- getGrant: {
- deprecated: "octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant",
- method: "GET",
- params: { grant_id: { required: true, type: "integer" } },
- url: "/applications/grants/:grant_id"
- },
- getOrCreateAuthorizationForApp: {
- deprecated: "octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app",
- method: "PUT",
- params: {
- client_id: { required: true, type: "string" },
- client_secret: { required: true, type: "string" },
- fingerprint: { type: "string" },
- note: { type: "string" },
- note_url: { type: "string" },
- scopes: { type: "string[]" }
- },
- url: "/authorizations/clients/:client_id"
- },
- getOrCreateAuthorizationForAppAndFingerprint: {
- 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",
- method: "PUT",
- params: {
- client_id: { required: true, type: "string" },
- client_secret: { required: true, type: "string" },
- fingerprint: { required: true, type: "string" },
- note: { type: "string" },
- note_url: { type: "string" },
- scopes: { type: "string[]" }
- },
- url: "/authorizations/clients/:client_id/:fingerprint"
- },
- getOrCreateAuthorizationForAppFingerprint: {
- deprecated: "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
- method: "PUT",
- params: {
- client_id: { required: true, type: "string" },
- client_secret: { required: true, type: "string" },
- fingerprint: { required: true, type: "string" },
- note: { type: "string" },
- note_url: { type: "string" },
- scopes: { type: "string[]" }
- },
- url: "/authorizations/clients/:client_id/:fingerprint"
- },
- listAuthorizations: {
- deprecated: "octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations",
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/authorizations"
- },
- listGrants: {
- deprecated: "octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants",
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/applications/grants"
- },
- resetAuthorization: {
- deprecated: "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)",
- method: "POST",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/tokens/:access_token"
- },
- revokeAuthorizationForApplication: {
- deprecated: "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)",
- method: "DELETE",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/tokens/:access_token"
- },
- revokeGrantForApplication: {
- deprecated: "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)",
- method: "DELETE",
- params: {
- access_token: { required: true, type: "string" },
- client_id: { required: true, type: "string" }
- },
- url: "/applications/:client_id/grants/:access_token"
- },
- updateAuthorization: {
- deprecated: "octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization",
- method: "PATCH",
- params: {
- add_scopes: { type: "string[]" },
- authorization_id: { required: true, type: "integer" },
- fingerprint: { type: "string" },
- note: { type: "string" },
- note_url: { type: "string" },
- remove_scopes: { type: "string[]" },
- scopes: { type: "string[]" }
- },
- url: "/authorizations/:authorization_id"
- }
- },
- orgs: {
- addOrUpdateMembership: {
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- role: { enum: ["admin", "member"], type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/memberships/:username"
- },
- blockUser: {
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/blocks/:username"
- },
- checkBlockedUser: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/blocks/:username"
- },
- checkMembership: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/members/:username"
- },
- checkPublicMembership: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/public_members/:username"
- },
- concealMembership: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/public_members/:username"
- },
- convertMemberToOutsideCollaborator: {
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/outside_collaborators/:username"
- },
- createHook: {
- method: "POST",
- params: {
- active: { type: "boolean" },
- config: { required: true, type: "object" },
- "config.content_type": { type: "string" },
- "config.insecure_ssl": { type: "string" },
- "config.secret": { type: "string" },
- "config.url": { required: true, type: "string" },
- events: { type: "string[]" },
- name: { required: true, type: "string" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/hooks"
- },
- createInvitation: {
- method: "POST",
- params: {
- email: { type: "string" },
- invitee_id: { type: "integer" },
- org: { required: true, type: "string" },
- role: {
- enum: ["admin", "direct_member", "billing_manager"],
- type: "string"
- },
- team_ids: { type: "integer[]" }
- },
- url: "/orgs/:org/invitations"
- },
- deleteHook: {
- method: "DELETE",
- params: {
- hook_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/hooks/:hook_id"
- },
- get: {
- method: "GET",
- params: { org: { required: true, type: "string" } },
- url: "/orgs/:org"
- },
- getHook: {
- method: "GET",
- params: {
- hook_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/hooks/:hook_id"
- },
- getMembership: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/memberships/:username"
- },
- getMembershipForAuthenticatedUser: {
- method: "GET",
- params: { org: { required: true, type: "string" } },
- url: "/user/memberships/orgs/:org"
- },
- list: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "integer" }
- },
- url: "/organizations"
- },
- listBlockedUsers: {
- method: "GET",
- params: { org: { required: true, type: "string" } },
- url: "/orgs/:org/blocks"
- },
- listForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/orgs"
- },
- listForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/orgs"
- },
- listHooks: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/hooks"
- },
- listInstallations: {
- headers: { accept: "application/vnd.github.machine-man-preview+json" },
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/installations"
- },
- listInvitationTeams: {
- method: "GET",
- params: {
- invitation_id: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/invitations/:invitation_id/teams"
- },
- listMembers: {
- method: "GET",
- params: {
- filter: { enum: ["2fa_disabled", "all"], type: "string" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- role: { enum: ["all", "admin", "member"], type: "string" }
- },
- url: "/orgs/:org/members"
- },
- listMemberships: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- state: { enum: ["active", "pending"], type: "string" }
- },
- url: "/user/memberships/orgs"
- },
- listOutsideCollaborators: {
- method: "GET",
- params: {
- filter: { enum: ["2fa_disabled", "all"], type: "string" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/outside_collaborators"
- },
- listPendingInvitations: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/invitations"
- },
- listPublicMembers: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/public_members"
- },
- pingHook: {
- method: "POST",
- params: {
- hook_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/hooks/:hook_id/pings"
- },
- publicizeMembership: {
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/public_members/:username"
- },
- removeMember: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/members/:username"
- },
- removeMembership: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/memberships/:username"
- },
- removeOutsideCollaborator: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/outside_collaborators/:username"
- },
- unblockUser: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/blocks/:username"
- },
- update: {
- method: "PATCH",
- params: {
- billing_email: { type: "string" },
- company: { type: "string" },
- default_repository_permission: {
- enum: ["read", "write", "admin", "none"],
- type: "string"
- },
- description: { type: "string" },
- email: { type: "string" },
- has_organization_projects: { type: "boolean" },
- has_repository_projects: { type: "boolean" },
- location: { type: "string" },
- members_allowed_repository_creation_type: {
- enum: ["all", "private", "none"],
- type: "string"
- },
- members_can_create_internal_repositories: { type: "boolean" },
- members_can_create_private_repositories: { type: "boolean" },
- members_can_create_public_repositories: { type: "boolean" },
- members_can_create_repositories: { type: "boolean" },
- name: { type: "string" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org"
- },
- updateHook: {
- method: "PATCH",
- params: {
- active: { type: "boolean" },
- config: { type: "object" },
- "config.content_type": { type: "string" },
- "config.insecure_ssl": { type: "string" },
- "config.secret": { type: "string" },
- "config.url": { required: true, type: "string" },
- events: { type: "string[]" },
- hook_id: { required: true, type: "integer" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/hooks/:hook_id"
- },
- updateMembership: {
- method: "PATCH",
- params: {
- org: { required: true, type: "string" },
- state: { enum: ["active"], required: true, type: "string" }
- },
- url: "/user/memberships/orgs/:org"
- }
- },
- projects: {
- addCollaborator: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PUT",
- params: {
- permission: { enum: ["read", "write", "admin"], type: "string" },
- project_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/projects/:project_id/collaborators/:username"
- },
- createCard: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- column_id: { required: true, type: "integer" },
- content_id: { type: "integer" },
- content_type: { type: "string" },
- note: { type: "string" }
- },
- url: "/projects/columns/:column_id/cards"
- },
- createColumn: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- name: { required: true, type: "string" },
- project_id: { required: true, type: "integer" }
- },
- url: "/projects/:project_id/columns"
- },
- createForAuthenticatedUser: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- body: { type: "string" },
- name: { required: true, type: "string" }
- },
- url: "/user/projects"
- },
- createForOrg: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- body: { type: "string" },
- name: { required: true, type: "string" },
- org: { required: true, type: "string" }
- },
- url: "/orgs/:org/projects"
- },
- createForRepo: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- body: { type: "string" },
- name: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/projects"
- },
- delete: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "DELETE",
- params: { project_id: { required: true, type: "integer" } },
- url: "/projects/:project_id"
- },
- deleteCard: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "DELETE",
- params: { card_id: { required: true, type: "integer" } },
- url: "/projects/columns/cards/:card_id"
- },
- deleteColumn: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "DELETE",
- params: { column_id: { required: true, type: "integer" } },
- url: "/projects/columns/:column_id"
- },
- get: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: { project_id: { required: true, type: "integer" } },
- url: "/projects/:project_id"
- },
- getCard: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: { card_id: { required: true, type: "integer" } },
- url: "/projects/columns/cards/:card_id"
- },
- getColumn: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: { column_id: { required: true, type: "integer" } },
- url: "/projects/columns/:column_id"
- },
- listCards: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- archived_state: {
- enum: ["all", "archived", "not_archived"],
- type: "string"
- },
- column_id: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/projects/columns/:column_id/cards"
- },
- listCollaborators: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- affiliation: { enum: ["outside", "direct", "all"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- project_id: { required: true, type: "integer" }
- },
- url: "/projects/:project_id/collaborators"
- },
- listColumns: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- project_id: { required: true, type: "integer" }
- },
- url: "/projects/:project_id/columns"
- },
- listForOrg: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/orgs/:org/projects"
- },
- listForRepo: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/repos/:owner/:repo/projects"
- },
- listForUser: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- state: { enum: ["open", "closed", "all"], type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/projects"
- },
- moveCard: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- card_id: { required: true, type: "integer" },
- column_id: { type: "integer" },
- position: {
- required: true,
- type: "string",
- validation: "^(top|bottom|after:\\d+)$"
- }
- },
- url: "/projects/columns/cards/:card_id/moves"
- },
- moveColumn: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "POST",
- params: {
- column_id: { required: true, type: "integer" },
- position: {
- required: true,
- type: "string",
- validation: "^(first|last|after:\\d+)$"
- }
- },
- url: "/projects/columns/:column_id/moves"
- },
- removeCollaborator: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "DELETE",
- params: {
- project_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/projects/:project_id/collaborators/:username"
- },
- reviewUserPermissionLevel: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- project_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/projects/:project_id/collaborators/:username/permission"
- },
- update: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PATCH",
- params: {
- body: { type: "string" },
- name: { type: "string" },
- organization_permission: { type: "string" },
- private: { type: "boolean" },
- project_id: { required: true, type: "integer" },
- state: { enum: ["open", "closed"], type: "string" }
- },
- url: "/projects/:project_id"
- },
- updateCard: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PATCH",
- params: {
- archived: { type: "boolean" },
- card_id: { required: true, type: "integer" },
- note: { type: "string" }
- },
- url: "/projects/columns/cards/:card_id"
- },
- updateColumn: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PATCH",
- params: {
- column_id: { required: true, type: "integer" },
- name: { required: true, type: "string" }
- },
- url: "/projects/columns/:column_id"
- }
- },
- pulls: {
- checkIfMerged: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/merge"
- },
- create: {
- method: "POST",
- params: {
- base: { required: true, type: "string" },
- body: { type: "string" },
- draft: { type: "boolean" },
- head: { required: true, type: "string" },
- maintainer_can_modify: { type: "boolean" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- title: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls"
- },
- createComment: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- commit_id: { required: true, type: "string" },
- in_reply_to: {
- deprecated: true,
- 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.",
- type: "integer"
- },
- line: { type: "integer" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- position: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- side: { enum: ["LEFT", "RIGHT"], type: "string" },
- start_line: { type: "integer" },
- start_side: { enum: ["LEFT", "RIGHT", "side"], type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/comments"
- },
- createCommentReply: {
- deprecated: "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)",
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- commit_id: { required: true, type: "string" },
- in_reply_to: {
- deprecated: true,
- 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.",
- type: "integer"
- },
- line: { type: "integer" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- position: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- side: { enum: ["LEFT", "RIGHT"], type: "string" },
- start_line: { type: "integer" },
- start_side: { enum: ["LEFT", "RIGHT", "side"], type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/comments"
- },
- createFromIssue: {
- deprecated: "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request",
- method: "POST",
- params: {
- base: { required: true, type: "string" },
- draft: { type: "boolean" },
- head: { required: true, type: "string" },
- issue: { required: true, type: "integer" },
- maintainer_can_modify: { type: "boolean" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls"
- },
- createReview: {
- method: "POST",
- params: {
- body: { type: "string" },
- comments: { type: "object[]" },
- "comments[].body": { required: true, type: "string" },
- "comments[].path": { required: true, type: "string" },
- "comments[].position": { required: true, type: "integer" },
- commit_id: { type: "string" },
- event: {
- enum: ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
- type: "string"
- },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews"
- },
- createReviewCommentReply: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies"
- },
- createReviewRequest: {
- method: "POST",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- reviewers: { type: "string[]" },
- team_reviewers: { type: "string[]" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
- },
- deleteComment: {
- method: "DELETE",
- params: {
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/comments/:comment_id"
- },
- deletePendingReview: {
- method: "DELETE",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- review_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
- },
- deleteReviewRequest: {
- method: "DELETE",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- reviewers: { type: "string[]" },
- team_reviewers: { type: "string[]" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
- },
- dismissReview: {
- method: "PUT",
- params: {
- message: { required: true, type: "string" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- review_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals"
- },
- get: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number"
- },
- getComment: {
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/comments/:comment_id"
- },
- getCommentsForReview: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- review_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments"
- },
- getReview: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- review_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
- },
- list: {
- method: "GET",
- params: {
- base: { type: "string" },
- direction: { enum: ["asc", "desc"], type: "string" },
- head: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- sort: {
- enum: ["created", "updated", "popularity", "long-running"],
- type: "string"
- },
- state: { enum: ["open", "closed", "all"], type: "string" }
- },
- url: "/repos/:owner/:repo/pulls"
- },
- listComments: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- since: { type: "string" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/comments"
- },
- listCommentsForRepo: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- since: { type: "string" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/comments"
- },
- listCommits: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/commits"
- },
- listFiles: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/files"
- },
- listReviewRequests: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers"
- },
- listReviews: {
- method: "GET",
- params: {
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews"
- },
- merge: {
- method: "PUT",
- params: {
- commit_message: { type: "string" },
- commit_title: { type: "string" },
- merge_method: { enum: ["merge", "squash", "rebase"], type: "string" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- sha: { type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/merge"
- },
- submitReview: {
- method: "POST",
- params: {
- body: { type: "string" },
- event: {
- enum: ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
- required: true,
- type: "string"
- },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- review_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events"
- },
- update: {
- method: "PATCH",
- params: {
- base: { type: "string" },
- body: { type: "string" },
- maintainer_can_modify: { type: "boolean" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- state: { enum: ["open", "closed"], type: "string" },
- title: { type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number"
- },
- updateBranch: {
- headers: { accept: "application/vnd.github.lydian-preview+json" },
- method: "PUT",
- params: {
- expected_head_sha: { type: "string" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/update-branch"
- },
- updateComment: {
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/comments/:comment_id"
- },
- updateReview: {
- method: "PUT",
- params: {
- body: { required: true, type: "string" },
- number: { alias: "pull_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- pull_number: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- review_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id"
- }
- },
- rateLimit: { get: { method: "GET", params: {}, url: "/rate_limit" } },
- reactions: {
- createForCommitComment: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- comment_id: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/comments/:comment_id/reactions"
- },
- createForIssue: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/reactions"
- },
- createForIssueComment: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- comment_id: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
- },
- createForPullRequestReviewComment: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- comment_id: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
- },
- createForTeamDiscussion: {
- deprecated: "octokit.reactions.createForTeamDiscussion() has been renamed to octokit.reactions.createForTeamDiscussionLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/reactions"
- },
- createForTeamDiscussionComment: {
- deprecated: "octokit.reactions.createForTeamDiscussionComment() has been renamed to octokit.reactions.createForTeamDiscussionCommentLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- comment_number: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- createForTeamDiscussionCommentInOrg: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- comment_number: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- createForTeamDiscussionCommentLegacy: {
- deprecated: "octokit.reactions.createForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- comment_number: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- createForTeamDiscussionInOrg: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"
- },
- createForTeamDiscussionLegacy: {
- deprecated: "octokit.reactions.createForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "POST",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- required: true,
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/reactions"
- },
- delete: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "DELETE",
- params: { reaction_id: { required: true, type: "integer" } },
- url: "/reactions/:reaction_id"
- },
- listForCommitComment: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/comments/:comment_id/reactions"
- },
- listForIssue: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- issue_number: { required: true, type: "integer" },
- number: { alias: "issue_number", deprecated: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/:issue_number/reactions"
- },
- listForIssueComment: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions"
- },
- listForPullRequestReviewComment: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions"
- },
- listForTeamDiscussion: {
- deprecated: "octokit.reactions.listForTeamDiscussion() has been renamed to octokit.reactions.listForTeamDiscussionLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/reactions"
- },
- listForTeamDiscussionComment: {
- deprecated: "octokit.reactions.listForTeamDiscussionComment() has been renamed to octokit.reactions.listForTeamDiscussionCommentLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- comment_number: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- listForTeamDiscussionCommentInOrg: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- comment_number: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- listForTeamDiscussionCommentLegacy: {
- deprecated: "octokit.reactions.listForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- comment_number: { required: true, type: "integer" },
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions"
- },
- listForTeamDiscussionInOrg: {
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions"
- },
- listForTeamDiscussionLegacy: {
- deprecated: "octokit.reactions.listForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy",
- headers: { accept: "application/vnd.github.squirrel-girl-preview+json" },
- method: "GET",
- params: {
- content: {
- enum: [
- "+1",
- "-1",
- "laugh",
- "confused",
- "heart",
- "hooray",
- "rocket",
- "eyes"
- ],
- type: "string"
- },
- discussion_number: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/reactions"
- }
- },
- repos: {
- acceptInvitation: {
- method: "PATCH",
- params: { invitation_id: { required: true, type: "integer" } },
- url: "/user/repository_invitations/:invitation_id"
- },
- addCollaborator: {
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- repo: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/collaborators/:username"
- },
- addDeployKey: {
- method: "POST",
- params: {
- key: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- read_only: { type: "boolean" },
- repo: { required: true, type: "string" },
- title: { type: "string" }
- },
- url: "/repos/:owner/:repo/keys"
- },
- addProtectedBranchAdminEnforcement: {
- method: "POST",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
- },
- addProtectedBranchAppRestrictions: {
- method: "POST",
- params: {
- apps: { mapTo: "data", required: true, type: "string[]" },
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
- },
- addProtectedBranchRequiredSignatures: {
- headers: { accept: "application/vnd.github.zzzax-preview+json" },
- method: "POST",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
- },
- addProtectedBranchRequiredStatusChecksContexts: {
- method: "POST",
- params: {
- branch: { required: true, type: "string" },
- contexts: { mapTo: "data", required: true, type: "string[]" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- addProtectedBranchTeamRestrictions: {
- method: "POST",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- teams: { mapTo: "data", required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- addProtectedBranchUserRestrictions: {
- method: "POST",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- users: { mapTo: "data", required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- checkCollaborator: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/collaborators/:username"
- },
- checkVulnerabilityAlerts: {
- headers: { accept: "application/vnd.github.dorian-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/vulnerability-alerts"
- },
- compareCommits: {
- method: "GET",
- params: {
- base: { required: true, type: "string" },
- head: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/compare/:base...:head"
- },
- createCommitComment: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- commit_sha: { required: true, type: "string" },
- line: { type: "integer" },
- owner: { required: true, type: "string" },
- path: { type: "string" },
- position: { type: "integer" },
- repo: { required: true, type: "string" },
- sha: { alias: "commit_sha", deprecated: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:commit_sha/comments"
- },
- createDeployment: {
- method: "POST",
- params: {
- auto_merge: { type: "boolean" },
- description: { type: "string" },
- environment: { type: "string" },
- owner: { required: true, type: "string" },
- payload: { type: "string" },
- production_environment: { type: "boolean" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- required_contexts: { type: "string[]" },
- task: { type: "string" },
- transient_environment: { type: "boolean" }
- },
- url: "/repos/:owner/:repo/deployments"
- },
- createDeploymentStatus: {
- method: "POST",
- params: {
- auto_inactive: { type: "boolean" },
- deployment_id: { required: true, type: "integer" },
- description: { type: "string" },
- environment: { enum: ["production", "staging", "qa"], type: "string" },
- environment_url: { type: "string" },
- log_url: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- state: {
- enum: [
- "error",
- "failure",
- "inactive",
- "in_progress",
- "queued",
- "pending",
- "success"
- ],
- required: true,
- type: "string"
- },
- target_url: { type: "string" }
- },
- url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"
- },
- createDispatchEvent: {
- method: "POST",
- params: {
- client_payload: { type: "object" },
- event_type: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/dispatches"
- },
- createFile: {
- deprecated: "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
- method: "PUT",
- params: {
- author: { type: "object" },
- "author.email": { required: true, type: "string" },
- "author.name": { required: true, type: "string" },
- branch: { type: "string" },
- committer: { type: "object" },
- "committer.email": { required: true, type: "string" },
- "committer.name": { required: true, type: "string" },
- content: { required: true, type: "string" },
- message: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { type: "string" }
- },
- url: "/repos/:owner/:repo/contents/:path"
- },
- createForAuthenticatedUser: {
- method: "POST",
- params: {
- allow_merge_commit: { type: "boolean" },
- allow_rebase_merge: { type: "boolean" },
- allow_squash_merge: { type: "boolean" },
- auto_init: { type: "boolean" },
- delete_branch_on_merge: { type: "boolean" },
- description: { type: "string" },
- gitignore_template: { type: "string" },
- has_issues: { type: "boolean" },
- has_projects: { type: "boolean" },
- has_wiki: { type: "boolean" },
- homepage: { type: "string" },
- is_template: { type: "boolean" },
- license_template: { type: "string" },
- name: { required: true, type: "string" },
- private: { type: "boolean" },
- team_id: { type: "integer" },
- visibility: {
- enum: ["public", "private", "visibility", "internal"],
- type: "string"
- }
- },
- url: "/user/repos"
- },
- createFork: {
- method: "POST",
- params: {
- organization: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/forks"
- },
- createHook: {
- method: "POST",
- params: {
- active: { type: "boolean" },
- config: { required: true, type: "object" },
- "config.content_type": { type: "string" },
- "config.insecure_ssl": { type: "string" },
- "config.secret": { type: "string" },
- "config.url": { required: true, type: "string" },
- events: { type: "string[]" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks"
- },
- createInOrg: {
- method: "POST",
- params: {
- allow_merge_commit: { type: "boolean" },
- allow_rebase_merge: { type: "boolean" },
- allow_squash_merge: { type: "boolean" },
- auto_init: { type: "boolean" },
- delete_branch_on_merge: { type: "boolean" },
- description: { type: "string" },
- gitignore_template: { type: "string" },
- has_issues: { type: "boolean" },
- has_projects: { type: "boolean" },
- has_wiki: { type: "boolean" },
- homepage: { type: "string" },
- is_template: { type: "boolean" },
- license_template: { type: "string" },
- name: { required: true, type: "string" },
- org: { required: true, type: "string" },
- private: { type: "boolean" },
- team_id: { type: "integer" },
- visibility: {
- enum: ["public", "private", "visibility", "internal"],
- type: "string"
- }
- },
- url: "/orgs/:org/repos"
- },
- createOrUpdateFile: {
- method: "PUT",
- params: {
- author: { type: "object" },
- "author.email": { required: true, type: "string" },
- "author.name": { required: true, type: "string" },
- branch: { type: "string" },
- committer: { type: "object" },
- "committer.email": { required: true, type: "string" },
- "committer.name": { required: true, type: "string" },
- content: { required: true, type: "string" },
- message: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { type: "string" }
- },
- url: "/repos/:owner/:repo/contents/:path"
- },
- createRelease: {
- method: "POST",
- params: {
- body: { type: "string" },
- draft: { type: "boolean" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- prerelease: { type: "boolean" },
- repo: { required: true, type: "string" },
- tag_name: { required: true, type: "string" },
- target_commitish: { type: "string" }
- },
- url: "/repos/:owner/:repo/releases"
- },
- createStatus: {
- method: "POST",
- params: {
- context: { type: "string" },
- description: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { required: true, type: "string" },
- state: {
- enum: ["error", "failure", "pending", "success"],
- required: true,
- type: "string"
- },
- target_url: { type: "string" }
- },
- url: "/repos/:owner/:repo/statuses/:sha"
- },
- createUsingTemplate: {
- headers: { accept: "application/vnd.github.baptiste-preview+json" },
- method: "POST",
- params: {
- description: { type: "string" },
- name: { required: true, type: "string" },
- owner: { type: "string" },
- private: { type: "boolean" },
- template_owner: { required: true, type: "string" },
- template_repo: { required: true, type: "string" }
- },
- url: "/repos/:template_owner/:template_repo/generate"
- },
- declineInvitation: {
- method: "DELETE",
- params: { invitation_id: { required: true, type: "integer" } },
- url: "/user/repository_invitations/:invitation_id"
- },
- delete: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo"
- },
- deleteCommitComment: {
- method: "DELETE",
- params: {
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/comments/:comment_id"
- },
- deleteDownload: {
- method: "DELETE",
- params: {
- download_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/downloads/:download_id"
- },
- deleteFile: {
- method: "DELETE",
- params: {
- author: { type: "object" },
- "author.email": { type: "string" },
- "author.name": { type: "string" },
- branch: { type: "string" },
- committer: { type: "object" },
- "committer.email": { type: "string" },
- "committer.name": { type: "string" },
- message: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/contents/:path"
- },
- deleteHook: {
- method: "DELETE",
- params: {
- hook_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks/:hook_id"
- },
- deleteInvitation: {
- method: "DELETE",
- params: {
- invitation_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/invitations/:invitation_id"
- },
- deleteRelease: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- release_id: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/:release_id"
- },
- deleteReleaseAsset: {
- method: "DELETE",
- params: {
- asset_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/assets/:asset_id"
- },
- disableAutomatedSecurityFixes: {
- headers: { accept: "application/vnd.github.london-preview+json" },
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/automated-security-fixes"
- },
- disablePagesSite: {
- headers: { accept: "application/vnd.github.switcheroo-preview+json" },
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pages"
- },
- disableVulnerabilityAlerts: {
- headers: { accept: "application/vnd.github.dorian-preview+json" },
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/vulnerability-alerts"
- },
- enableAutomatedSecurityFixes: {
- headers: { accept: "application/vnd.github.london-preview+json" },
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/automated-security-fixes"
- },
- enablePagesSite: {
- headers: { accept: "application/vnd.github.switcheroo-preview+json" },
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- source: { type: "object" },
- "source.branch": { enum: ["master", "gh-pages"], type: "string" },
- "source.path": { type: "string" }
- },
- url: "/repos/:owner/:repo/pages"
- },
- enableVulnerabilityAlerts: {
- headers: { accept: "application/vnd.github.dorian-preview+json" },
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/vulnerability-alerts"
- },
- get: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo"
- },
- getAppsWithAccessToProtectedBranch: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
- },
- getArchiveLink: {
- method: "GET",
- params: {
- archive_format: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/:archive_format/:ref"
- },
- getBranch: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch"
- },
- getBranchProtection: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection"
- },
- getClones: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- per: { enum: ["day", "week"], type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/traffic/clones"
- },
- getCodeFrequencyStats: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/stats/code_frequency"
- },
- getCollaboratorPermissionLevel: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/collaborators/:username/permission"
- },
- getCombinedStatusForRef: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:ref/status"
- },
- getCommit: {
- method: "GET",
- params: {
- commit_sha: { alias: "ref", deprecated: true, type: "string" },
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { alias: "ref", deprecated: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:ref"
- },
- getCommitActivityStats: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/stats/commit_activity"
- },
- getCommitComment: {
- method: "GET",
- params: {
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/comments/:comment_id"
- },
- getCommitRefSha: {
- deprecated: "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit",
- headers: { accept: "application/vnd.github.v3.sha" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:ref"
- },
- getContents: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- ref: { type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/contents/:path"
- },
- getContributorsStats: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/stats/contributors"
- },
- getDeployKey: {
- method: "GET",
- params: {
- key_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/keys/:key_id"
- },
- getDeployment: {
- method: "GET",
- params: {
- deployment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/deployments/:deployment_id"
- },
- getDeploymentStatus: {
- method: "GET",
- params: {
- deployment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- status_id: { required: true, type: "integer" }
- },
- url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id"
- },
- getDownload: {
- method: "GET",
- params: {
- download_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/downloads/:download_id"
- },
- getHook: {
- method: "GET",
- params: {
- hook_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks/:hook_id"
- },
- getLatestPagesBuild: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pages/builds/latest"
- },
- getLatestRelease: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/latest"
- },
- getPages: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pages"
- },
- getPagesBuild: {
- method: "GET",
- params: {
- build_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pages/builds/:build_id"
- },
- getParticipationStats: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/stats/participation"
- },
- getProtectedBranchAdminEnforcement: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
- },
- getProtectedBranchPullRequestReviewEnforcement: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
- },
- getProtectedBranchRequiredSignatures: {
- headers: { accept: "application/vnd.github.zzzax-preview+json" },
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
- },
- getProtectedBranchRequiredStatusChecks: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
- },
- getProtectedBranchRestrictions: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"
- },
- getPunchCardStats: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/stats/punch_card"
- },
- getReadme: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- ref: { type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/readme"
- },
- getRelease: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- release_id: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/:release_id"
- },
- getReleaseAsset: {
- method: "GET",
- params: {
- asset_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/assets/:asset_id"
- },
- getReleaseByTag: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- tag: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/tags/:tag"
- },
- getTeamsWithAccessToProtectedBranch: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- getTopPaths: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/traffic/popular/paths"
- },
- getTopReferrers: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/traffic/popular/referrers"
- },
- getUsersWithAccessToProtectedBranch: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- getViews: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- per: { enum: ["day", "week"], type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/traffic/views"
- },
- list: {
- method: "GET",
- params: {
- affiliation: { type: "string" },
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- sort: {
- enum: ["created", "updated", "pushed", "full_name"],
- type: "string"
- },
- type: {
- enum: ["all", "owner", "public", "private", "member"],
- type: "string"
- },
- visibility: { enum: ["all", "public", "private"], type: "string" }
- },
- url: "/user/repos"
- },
- listAppsWithAccessToProtectedBranch: {
- deprecated: "octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)",
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
- },
- listAssetsForRelease: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- release_id: { required: true, type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/:release_id/assets"
- },
- listBranches: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- protected: { type: "boolean" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches"
- },
- listBranchesForHeadCommit: {
- headers: { accept: "application/vnd.github.groot-preview+json" },
- method: "GET",
- params: {
- commit_sha: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head"
- },
- listCollaborators: {
- method: "GET",
- params: {
- affiliation: { enum: ["outside", "direct", "all"], type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/collaborators"
- },
- listCommentsForCommit: {
- method: "GET",
- params: {
- commit_sha: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- ref: { alias: "commit_sha", deprecated: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:commit_sha/comments"
- },
- listCommitComments: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/comments"
- },
- listCommits: {
- method: "GET",
- params: {
- author: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- path: { type: "string" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- sha: { type: "string" },
- since: { type: "string" },
- until: { type: "string" }
- },
- url: "/repos/:owner/:repo/commits"
- },
- listContributors: {
- method: "GET",
- params: {
- anon: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/contributors"
- },
- listDeployKeys: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/keys"
- },
- listDeploymentStatuses: {
- method: "GET",
- params: {
- deployment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/deployments/:deployment_id/statuses"
- },
- listDeployments: {
- method: "GET",
- params: {
- environment: { type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- ref: { type: "string" },
- repo: { required: true, type: "string" },
- sha: { type: "string" },
- task: { type: "string" }
- },
- url: "/repos/:owner/:repo/deployments"
- },
- listDownloads: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/downloads"
- },
- listForOrg: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- sort: {
- enum: ["created", "updated", "pushed", "full_name"],
- type: "string"
- },
- type: {
- enum: [
- "all",
- "public",
- "private",
- "forks",
- "sources",
- "member",
- "internal"
- ],
- type: "string"
- }
- },
- url: "/orgs/:org/repos"
- },
- listForUser: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- sort: {
- enum: ["created", "updated", "pushed", "full_name"],
- type: "string"
- },
- type: { enum: ["all", "owner", "member"], type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/repos"
- },
- listForks: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" },
- sort: { enum: ["newest", "oldest", "stargazers"], type: "string" }
- },
- url: "/repos/:owner/:repo/forks"
- },
- listHooks: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks"
- },
- listInvitations: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/invitations"
- },
- listInvitationsForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/repository_invitations"
- },
- listLanguages: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/languages"
- },
- listPagesBuilds: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pages/builds"
- },
- listProtectedBranchRequiredStatusChecksContexts: {
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- listProtectedBranchTeamRestrictions: {
- deprecated: "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)",
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- listProtectedBranchUserRestrictions: {
- deprecated: "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)",
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- listPublic: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "integer" }
- },
- url: "/repositories"
- },
- listPullRequestsAssociatedWithCommit: {
- headers: { accept: "application/vnd.github.groot-preview+json" },
- method: "GET",
- params: {
- commit_sha: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:commit_sha/pulls"
- },
- listReleases: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases"
- },
- listStatusesForRef: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- ref: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/commits/:ref/statuses"
- },
- listTags: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/tags"
- },
- listTeams: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/teams"
- },
- listTeamsWithAccessToProtectedBranch: {
- deprecated: "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)",
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- listTopics: {
- headers: { accept: "application/vnd.github.mercy-preview+json" },
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/topics"
- },
- listUsersWithAccessToProtectedBranch: {
- deprecated: "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)",
- method: "GET",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- merge: {
- method: "POST",
- params: {
- base: { required: true, type: "string" },
- commit_message: { type: "string" },
- head: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/merges"
- },
- pingHook: {
- method: "POST",
- params: {
- hook_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks/:hook_id/pings"
- },
- removeBranchProtection: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection"
- },
- removeCollaborator: {
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/collaborators/:username"
- },
- removeDeployKey: {
- method: "DELETE",
- params: {
- key_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/keys/:key_id"
- },
- removeProtectedBranchAdminEnforcement: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins"
- },
- removeProtectedBranchAppRestrictions: {
- method: "DELETE",
- params: {
- apps: { mapTo: "data", required: true, type: "string[]" },
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
- },
- removeProtectedBranchPullRequestReviewEnforcement: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
- },
- removeProtectedBranchRequiredSignatures: {
- headers: { accept: "application/vnd.github.zzzax-preview+json" },
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures"
- },
- removeProtectedBranchRequiredStatusChecks: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
- },
- removeProtectedBranchRequiredStatusChecksContexts: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- contexts: { mapTo: "data", required: true, type: "string[]" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- removeProtectedBranchRestrictions: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions"
- },
- removeProtectedBranchTeamRestrictions: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- teams: { mapTo: "data", required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- removeProtectedBranchUserRestrictions: {
- method: "DELETE",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- users: { mapTo: "data", required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- replaceProtectedBranchAppRestrictions: {
- method: "PUT",
- params: {
- apps: { mapTo: "data", required: true, type: "string[]" },
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps"
- },
- replaceProtectedBranchRequiredStatusChecksContexts: {
- method: "PUT",
- params: {
- branch: { required: true, type: "string" },
- contexts: { mapTo: "data", required: true, type: "string[]" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts"
- },
- replaceProtectedBranchTeamRestrictions: {
- method: "PUT",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- teams: { mapTo: "data", required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams"
- },
- replaceProtectedBranchUserRestrictions: {
- method: "PUT",
- params: {
- branch: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- users: { mapTo: "data", required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users"
- },
- replaceTopics: {
- headers: { accept: "application/vnd.github.mercy-preview+json" },
- method: "PUT",
- params: {
- names: { required: true, type: "string[]" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/topics"
- },
- requestPageBuild: {
- method: "POST",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/pages/builds"
- },
- retrieveCommunityProfileMetrics: {
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/community/profile"
- },
- testPushHook: {
- method: "POST",
- params: {
- hook_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks/:hook_id/tests"
- },
- transfer: {
- method: "POST",
- params: {
- new_owner: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_ids: { type: "integer[]" }
- },
- url: "/repos/:owner/:repo/transfer"
- },
- update: {
- method: "PATCH",
- params: {
- allow_merge_commit: { type: "boolean" },
- allow_rebase_merge: { type: "boolean" },
- allow_squash_merge: { type: "boolean" },
- archived: { type: "boolean" },
- default_branch: { type: "string" },
- delete_branch_on_merge: { type: "boolean" },
- description: { type: "string" },
- has_issues: { type: "boolean" },
- has_projects: { type: "boolean" },
- has_wiki: { type: "boolean" },
- homepage: { type: "string" },
- is_template: { type: "boolean" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- private: { type: "boolean" },
- repo: { required: true, type: "string" },
- visibility: {
- enum: ["public", "private", "visibility", "internal"],
- type: "string"
- }
- },
- url: "/repos/:owner/:repo"
- },
- updateBranchProtection: {
- method: "PUT",
- params: {
- allow_deletions: { type: "boolean" },
- allow_force_pushes: { allowNull: true, type: "boolean" },
- branch: { required: true, type: "string" },
- enforce_admins: { allowNull: true, required: true, type: "boolean" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- required_linear_history: { type: "boolean" },
- required_pull_request_reviews: {
- allowNull: true,
- required: true,
- type: "object"
- },
- "required_pull_request_reviews.dismiss_stale_reviews": {
- type: "boolean"
- },
- "required_pull_request_reviews.dismissal_restrictions": {
- type: "object"
- },
- "required_pull_request_reviews.dismissal_restrictions.teams": {
- type: "string[]"
- },
- "required_pull_request_reviews.dismissal_restrictions.users": {
- type: "string[]"
- },
- "required_pull_request_reviews.require_code_owner_reviews": {
- type: "boolean"
- },
- "required_pull_request_reviews.required_approving_review_count": {
- type: "integer"
- },
- required_status_checks: {
- allowNull: true,
- required: true,
- type: "object"
- },
- "required_status_checks.contexts": { required: true, type: "string[]" },
- "required_status_checks.strict": { required: true, type: "boolean" },
- restrictions: { allowNull: true, required: true, type: "object" },
- "restrictions.apps": { type: "string[]" },
- "restrictions.teams": { required: true, type: "string[]" },
- "restrictions.users": { required: true, type: "string[]" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection"
- },
- updateCommitComment: {
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/comments/:comment_id"
- },
- updateFile: {
- deprecated: "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)",
- method: "PUT",
- params: {
- author: { type: "object" },
- "author.email": { required: true, type: "string" },
- "author.name": { required: true, type: "string" },
- branch: { type: "string" },
- committer: { type: "object" },
- "committer.email": { required: true, type: "string" },
- "committer.name": { required: true, type: "string" },
- content: { required: true, type: "string" },
- message: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- path: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- sha: { type: "string" }
- },
- url: "/repos/:owner/:repo/contents/:path"
- },
- updateHook: {
- method: "PATCH",
- params: {
- active: { type: "boolean" },
- add_events: { type: "string[]" },
- config: { type: "object" },
- "config.content_type": { type: "string" },
- "config.insecure_ssl": { type: "string" },
- "config.secret": { type: "string" },
- "config.url": { required: true, type: "string" },
- events: { type: "string[]" },
- hook_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- remove_events: { type: "string[]" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/hooks/:hook_id"
- },
- updateInformationAboutPagesSite: {
- method: "PUT",
- params: {
- cname: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- source: {
- enum: ['"gh-pages"', '"master"', '"master /docs"'],
- type: "string"
- }
- },
- url: "/repos/:owner/:repo/pages"
- },
- updateInvitation: {
- method: "PATCH",
- params: {
- invitation_id: { required: true, type: "integer" },
- owner: { required: true, type: "string" },
- permissions: { enum: ["read", "write", "admin"], type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/invitations/:invitation_id"
- },
- updateProtectedBranchPullRequestReviewEnforcement: {
- method: "PATCH",
- params: {
- branch: { required: true, type: "string" },
- dismiss_stale_reviews: { type: "boolean" },
- dismissal_restrictions: { type: "object" },
- "dismissal_restrictions.teams": { type: "string[]" },
- "dismissal_restrictions.users": { type: "string[]" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- require_code_owner_reviews: { type: "boolean" },
- required_approving_review_count: { type: "integer" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews"
- },
- updateProtectedBranchRequiredStatusChecks: {
- method: "PATCH",
- params: {
- branch: { required: true, type: "string" },
- contexts: { type: "string[]" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- strict: { type: "boolean" }
- },
- url: "/repos/:owner/:repo/branches/:branch/protection/required_status_checks"
- },
- updateRelease: {
- method: "PATCH",
- params: {
- body: { type: "string" },
- draft: { type: "boolean" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- prerelease: { type: "boolean" },
- release_id: { required: true, type: "integer" },
- repo: { required: true, type: "string" },
- tag_name: { type: "string" },
- target_commitish: { type: "string" }
- },
- url: "/repos/:owner/:repo/releases/:release_id"
- },
- updateReleaseAsset: {
- method: "PATCH",
- params: {
- asset_id: { required: true, type: "integer" },
- label: { type: "string" },
- name: { type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" }
- },
- url: "/repos/:owner/:repo/releases/assets/:asset_id"
- },
- uploadReleaseAsset: {
- method: "POST",
- params: {
- data: { mapTo: "data", required: true, type: "string | object" },
- file: { alias: "data", deprecated: true, type: "string | object" },
- headers: { required: true, type: "object" },
- "headers.content-length": { required: true, type: "integer" },
- "headers.content-type": { required: true, type: "string" },
- label: { type: "string" },
- name: { required: true, type: "string" },
- url: { required: true, type: "string" }
- },
- url: ":url"
- }
- },
- search: {
- code: {
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- q: { required: true, type: "string" },
- sort: { enum: ["indexed"], type: "string" }
- },
- url: "/search/code"
- },
- commits: {
- headers: { accept: "application/vnd.github.cloak-preview+json" },
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- q: { required: true, type: "string" },
- sort: { enum: ["author-date", "committer-date"], type: "string" }
- },
- url: "/search/commits"
- },
- issues: {
- deprecated: "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)",
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- q: { required: true, type: "string" },
- sort: {
- enum: [
- "comments",
- "reactions",
- "reactions-+1",
- "reactions--1",
- "reactions-smile",
- "reactions-thinking_face",
- "reactions-heart",
- "reactions-tada",
- "interactions",
- "created",
- "updated"
- ],
- type: "string"
- }
- },
- url: "/search/issues"
- },
- issuesAndPullRequests: {
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- q: { required: true, type: "string" },
- sort: {
- enum: [
- "comments",
- "reactions",
- "reactions-+1",
- "reactions--1",
- "reactions-smile",
- "reactions-thinking_face",
- "reactions-heart",
- "reactions-tada",
- "interactions",
- "created",
- "updated"
- ],
- type: "string"
- }
- },
- url: "/search/issues"
- },
- labels: {
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- q: { required: true, type: "string" },
- repository_id: { required: true, type: "integer" },
- sort: { enum: ["created", "updated"], type: "string" }
- },
- url: "/search/labels"
- },
- repos: {
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- q: { required: true, type: "string" },
- sort: {
- enum: ["stars", "forks", "help-wanted-issues", "updated"],
- type: "string"
- }
- },
- url: "/search/repositories"
- },
- topics: {
- method: "GET",
- params: { q: { required: true, type: "string" } },
- url: "/search/topics"
- },
- users: {
- method: "GET",
- params: {
- order: { enum: ["desc", "asc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- q: { required: true, type: "string" },
- sort: { enum: ["followers", "repositories", "joined"], type: "string" }
- },
- url: "/search/users"
- }
- },
- teams: {
- addMember: {
- deprecated: "octokit.teams.addMember() has been renamed to octokit.teams.addMemberLegacy() (2020-01-16)",
- method: "PUT",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/members/:username"
- },
- addMemberLegacy: {
- deprecated: "octokit.teams.addMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy",
- method: "PUT",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/members/:username"
- },
- addOrUpdateMembership: {
- deprecated: "octokit.teams.addOrUpdateMembership() has been renamed to octokit.teams.addOrUpdateMembershipLegacy() (2020-01-16)",
- method: "PUT",
- params: {
- role: { enum: ["member", "maintainer"], type: "string" },
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/memberships/:username"
- },
- addOrUpdateMembershipInOrg: {
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- role: { enum: ["member", "maintainer"], type: "string" },
- team_slug: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/memberships/:username"
- },
- addOrUpdateMembershipLegacy: {
- deprecated: "octokit.teams.addOrUpdateMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy",
- method: "PUT",
- params: {
- role: { enum: ["member", "maintainer"], type: "string" },
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/memberships/:username"
- },
- addOrUpdateProject: {
- deprecated: "octokit.teams.addOrUpdateProject() has been renamed to octokit.teams.addOrUpdateProjectLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PUT",
- params: {
- permission: { enum: ["read", "write", "admin"], type: "string" },
- project_id: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects/:project_id"
- },
- addOrUpdateProjectInOrg: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- permission: { enum: ["read", "write", "admin"], type: "string" },
- project_id: { required: true, type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/projects/:project_id"
- },
- addOrUpdateProjectLegacy: {
- deprecated: "octokit.teams.addOrUpdateProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy",
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "PUT",
- params: {
- permission: { enum: ["read", "write", "admin"], type: "string" },
- project_id: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects/:project_id"
- },
- addOrUpdateRepo: {
- deprecated: "octokit.teams.addOrUpdateRepo() has been renamed to octokit.teams.addOrUpdateRepoLegacy() (2020-01-16)",
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- repo: { required: true, type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos/:owner/:repo"
- },
- addOrUpdateRepoInOrg: {
- method: "PUT",
- params: {
- org: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- repo: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"
- },
- addOrUpdateRepoLegacy: {
- deprecated: "octokit.teams.addOrUpdateRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy",
- method: "PUT",
- params: {
- owner: { required: true, type: "string" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- repo: { required: true, type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos/:owner/:repo"
- },
- checkManagesRepo: {
- deprecated: "octokit.teams.checkManagesRepo() has been renamed to octokit.teams.checkManagesRepoLegacy() (2020-01-16)",
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos/:owner/:repo"
- },
- checkManagesRepoInOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"
- },
- checkManagesRepoLegacy: {
- deprecated: "octokit.teams.checkManagesRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy",
- method: "GET",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos/:owner/:repo"
- },
- create: {
- method: "POST",
- params: {
- description: { type: "string" },
- maintainers: { type: "string[]" },
- name: { required: true, type: "string" },
- org: { required: true, type: "string" },
- parent_team_id: { type: "integer" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- privacy: { enum: ["secret", "closed"], type: "string" },
- repo_names: { type: "string[]" }
- },
- url: "/orgs/:org/teams"
- },
- createDiscussion: {
- deprecated: "octokit.teams.createDiscussion() has been renamed to octokit.teams.createDiscussionLegacy() (2020-01-16)",
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- private: { type: "boolean" },
- team_id: { required: true, type: "integer" },
- title: { required: true, type: "string" }
- },
- url: "/teams/:team_id/discussions"
- },
- createDiscussionComment: {
- deprecated: "octokit.teams.createDiscussionComment() has been renamed to octokit.teams.createDiscussionCommentLegacy() (2020-01-16)",
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments"
- },
- createDiscussionCommentInOrg: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"
- },
- createDiscussionCommentLegacy: {
- deprecated: "octokit.teams.createDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy",
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments"
- },
- createDiscussionInOrg: {
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- org: { required: true, type: "string" },
- private: { type: "boolean" },
- team_slug: { required: true, type: "string" },
- title: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions"
- },
- createDiscussionLegacy: {
- deprecated: "octokit.teams.createDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy",
- method: "POST",
- params: {
- body: { required: true, type: "string" },
- private: { type: "boolean" },
- team_id: { required: true, type: "integer" },
- title: { required: true, type: "string" }
- },
- url: "/teams/:team_id/discussions"
- },
- delete: {
- deprecated: "octokit.teams.delete() has been renamed to octokit.teams.deleteLegacy() (2020-01-16)",
- method: "DELETE",
- params: { team_id: { required: true, type: "integer" } },
- url: "/teams/:team_id"
- },
- deleteDiscussion: {
- deprecated: "octokit.teams.deleteDiscussion() has been renamed to octokit.teams.deleteDiscussionLegacy() (2020-01-16)",
- method: "DELETE",
- params: {
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number"
- },
- deleteDiscussionComment: {
- deprecated: "octokit.teams.deleteDiscussionComment() has been renamed to octokit.teams.deleteDiscussionCommentLegacy() (2020-01-16)",
- method: "DELETE",
- params: {
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- deleteDiscussionCommentInOrg: {
- method: "DELETE",
- params: {
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"
- },
- deleteDiscussionCommentLegacy: {
- deprecated: "octokit.teams.deleteDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy",
- method: "DELETE",
- params: {
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- deleteDiscussionInOrg: {
- method: "DELETE",
- params: {
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"
- },
- deleteDiscussionLegacy: {
- deprecated: "octokit.teams.deleteDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy",
- method: "DELETE",
- params: {
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number"
- },
- deleteInOrg: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug"
- },
- deleteLegacy: {
- deprecated: "octokit.teams.deleteLegacy() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy",
- method: "DELETE",
- params: { team_id: { required: true, type: "integer" } },
- url: "/teams/:team_id"
- },
- get: {
- deprecated: "octokit.teams.get() has been renamed to octokit.teams.getLegacy() (2020-01-16)",
- method: "GET",
- params: { team_id: { required: true, type: "integer" } },
- url: "/teams/:team_id"
- },
- getByName: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug"
- },
- getDiscussion: {
- deprecated: "octokit.teams.getDiscussion() has been renamed to octokit.teams.getDiscussionLegacy() (2020-01-16)",
- method: "GET",
- params: {
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number"
- },
- getDiscussionComment: {
- deprecated: "octokit.teams.getDiscussionComment() has been renamed to octokit.teams.getDiscussionCommentLegacy() (2020-01-16)",
- method: "GET",
- params: {
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- getDiscussionCommentInOrg: {
- method: "GET",
- params: {
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"
- },
- getDiscussionCommentLegacy: {
- deprecated: "octokit.teams.getDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy",
- method: "GET",
- params: {
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- getDiscussionInOrg: {
- method: "GET",
- params: {
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"
- },
- getDiscussionLegacy: {
- deprecated: "octokit.teams.getDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy",
- method: "GET",
- params: {
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number"
- },
- getLegacy: {
- deprecated: "octokit.teams.getLegacy() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy",
- method: "GET",
- params: { team_id: { required: true, type: "integer" } },
- url: "/teams/:team_id"
- },
- getMember: {
- deprecated: "octokit.teams.getMember() has been renamed to octokit.teams.getMemberLegacy() (2020-01-16)",
- method: "GET",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/members/:username"
- },
- getMemberLegacy: {
- deprecated: "octokit.teams.getMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy",
- method: "GET",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/members/:username"
- },
- getMembership: {
- deprecated: "octokit.teams.getMembership() has been renamed to octokit.teams.getMembershipLegacy() (2020-01-16)",
- method: "GET",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/memberships/:username"
- },
- getMembershipInOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/memberships/:username"
- },
- getMembershipLegacy: {
- deprecated: "octokit.teams.getMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy",
- method: "GET",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/memberships/:username"
- },
- list: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" }
- },
- url: "/orgs/:org/teams"
- },
- listChild: {
- deprecated: "octokit.teams.listChild() has been renamed to octokit.teams.listChildLegacy() (2020-01-16)",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/teams"
- },
- listChildInOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/teams"
- },
- listChildLegacy: {
- deprecated: "octokit.teams.listChildLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/teams"
- },
- listDiscussionComments: {
- deprecated: "octokit.teams.listDiscussionComments() has been renamed to octokit.teams.listDiscussionCommentsLegacy() (2020-01-16)",
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- discussion_number: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments"
- },
- listDiscussionCommentsInOrg: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments"
- },
- listDiscussionCommentsLegacy: {
- deprecated: "octokit.teams.listDiscussionCommentsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy",
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- discussion_number: { required: true, type: "integer" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments"
- },
- listDiscussions: {
- deprecated: "octokit.teams.listDiscussions() has been renamed to octokit.teams.listDiscussionsLegacy() (2020-01-16)",
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions"
- },
- listDiscussionsInOrg: {
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions"
- },
- listDiscussionsLegacy: {
- deprecated: "octokit.teams.listDiscussionsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy",
- method: "GET",
- params: {
- direction: { enum: ["asc", "desc"], type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions"
- },
- listForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/teams"
- },
- listMembers: {
- deprecated: "octokit.teams.listMembers() has been renamed to octokit.teams.listMembersLegacy() (2020-01-16)",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- role: { enum: ["member", "maintainer", "all"], type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/members"
- },
- listMembersInOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- role: { enum: ["member", "maintainer", "all"], type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/members"
- },
- listMembersLegacy: {
- deprecated: "octokit.teams.listMembersLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- role: { enum: ["member", "maintainer", "all"], type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/members"
- },
- listPendingInvitations: {
- deprecated: "octokit.teams.listPendingInvitations() has been renamed to octokit.teams.listPendingInvitationsLegacy() (2020-01-16)",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/invitations"
- },
- listPendingInvitationsInOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/invitations"
- },
- listPendingInvitationsLegacy: {
- deprecated: "octokit.teams.listPendingInvitationsLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/invitations"
- },
- listProjects: {
- deprecated: "octokit.teams.listProjects() has been renamed to octokit.teams.listProjectsLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects"
- },
- listProjectsInOrg: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/projects"
- },
- listProjectsLegacy: {
- deprecated: "octokit.teams.listProjectsLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy",
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects"
- },
- listRepos: {
- deprecated: "octokit.teams.listRepos() has been renamed to octokit.teams.listReposLegacy() (2020-01-16)",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos"
- },
- listReposInOrg: {
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/repos"
- },
- listReposLegacy: {
- deprecated: "octokit.teams.listReposLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy",
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos"
- },
- removeMember: {
- deprecated: "octokit.teams.removeMember() has been renamed to octokit.teams.removeMemberLegacy() (2020-01-16)",
- method: "DELETE",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/members/:username"
- },
- removeMemberLegacy: {
- deprecated: "octokit.teams.removeMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy",
- method: "DELETE",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/members/:username"
- },
- removeMembership: {
- deprecated: "octokit.teams.removeMembership() has been renamed to octokit.teams.removeMembershipLegacy() (2020-01-16)",
- method: "DELETE",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/memberships/:username"
- },
- removeMembershipInOrg: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/memberships/:username"
- },
- removeMembershipLegacy: {
- deprecated: "octokit.teams.removeMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy",
- method: "DELETE",
- params: {
- team_id: { required: true, type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/teams/:team_id/memberships/:username"
- },
- removeProject: {
- deprecated: "octokit.teams.removeProject() has been renamed to octokit.teams.removeProjectLegacy() (2020-01-16)",
- method: "DELETE",
- params: {
- project_id: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects/:project_id"
- },
- removeProjectInOrg: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- project_id: { required: true, type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/projects/:project_id"
- },
- removeProjectLegacy: {
- deprecated: "octokit.teams.removeProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy",
- method: "DELETE",
- params: {
- project_id: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects/:project_id"
- },
- removeRepo: {
- deprecated: "octokit.teams.removeRepo() has been renamed to octokit.teams.removeRepoLegacy() (2020-01-16)",
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos/:owner/:repo"
- },
- removeRepoInOrg: {
- method: "DELETE",
- params: {
- org: { required: true, type: "string" },
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo"
- },
- removeRepoLegacy: {
- deprecated: "octokit.teams.removeRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy",
- method: "DELETE",
- params: {
- owner: { required: true, type: "string" },
- repo: { required: true, type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/repos/:owner/:repo"
- },
- reviewProject: {
- deprecated: "octokit.teams.reviewProject() has been renamed to octokit.teams.reviewProjectLegacy() (2020-01-16)",
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- project_id: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects/:project_id"
- },
- reviewProjectInOrg: {
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- org: { required: true, type: "string" },
- project_id: { required: true, type: "integer" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/projects/:project_id"
- },
- reviewProjectLegacy: {
- deprecated: "octokit.teams.reviewProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy",
- headers: { accept: "application/vnd.github.inertia-preview+json" },
- method: "GET",
- params: {
- project_id: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/projects/:project_id"
- },
- update: {
- deprecated: "octokit.teams.update() has been renamed to octokit.teams.updateLegacy() (2020-01-16)",
- method: "PATCH",
- params: {
- description: { type: "string" },
- name: { required: true, type: "string" },
- parent_team_id: { type: "integer" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- privacy: { enum: ["secret", "closed"], type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id"
- },
- updateDiscussion: {
- deprecated: "octokit.teams.updateDiscussion() has been renamed to octokit.teams.updateDiscussionLegacy() (2020-01-16)",
- method: "PATCH",
- params: {
- body: { type: "string" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" },
- title: { type: "string" }
- },
- url: "/teams/:team_id/discussions/:discussion_number"
- },
- updateDiscussionComment: {
- deprecated: "octokit.teams.updateDiscussionComment() has been renamed to octokit.teams.updateDiscussionCommentLegacy() (2020-01-16)",
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- updateDiscussionCommentInOrg: {
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number"
- },
- updateDiscussionCommentLegacy: {
- deprecated: "octokit.teams.updateDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy",
- method: "PATCH",
- params: {
- body: { required: true, type: "string" },
- comment_number: { required: true, type: "integer" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id/discussions/:discussion_number/comments/:comment_number"
- },
- updateDiscussionInOrg: {
- method: "PATCH",
- params: {
- body: { type: "string" },
- discussion_number: { required: true, type: "integer" },
- org: { required: true, type: "string" },
- team_slug: { required: true, type: "string" },
- title: { type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number"
- },
- updateDiscussionLegacy: {
- deprecated: "octokit.teams.updateDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy",
- method: "PATCH",
- params: {
- body: { type: "string" },
- discussion_number: { required: true, type: "integer" },
- team_id: { required: true, type: "integer" },
- title: { type: "string" }
- },
- url: "/teams/:team_id/discussions/:discussion_number"
- },
- updateInOrg: {
- method: "PATCH",
- params: {
- description: { type: "string" },
- name: { required: true, type: "string" },
- org: { required: true, type: "string" },
- parent_team_id: { type: "integer" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- privacy: { enum: ["secret", "closed"], type: "string" },
- team_slug: { required: true, type: "string" }
- },
- url: "/orgs/:org/teams/:team_slug"
- },
- updateLegacy: {
- deprecated: "octokit.teams.updateLegacy() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy",
- method: "PATCH",
- params: {
- description: { type: "string" },
- name: { required: true, type: "string" },
- parent_team_id: { type: "integer" },
- permission: { enum: ["pull", "push", "admin"], type: "string" },
- privacy: { enum: ["secret", "closed"], type: "string" },
- team_id: { required: true, type: "integer" }
- },
- url: "/teams/:team_id"
- }
- },
- users: {
- addEmails: {
- method: "POST",
- params: { emails: { required: true, type: "string[]" } },
- url: "/user/emails"
- },
- block: {
- method: "PUT",
- params: { username: { required: true, type: "string" } },
- url: "/user/blocks/:username"
- },
- checkBlocked: {
- method: "GET",
- params: { username: { required: true, type: "string" } },
- url: "/user/blocks/:username"
- },
- checkFollowing: {
- method: "GET",
- params: { username: { required: true, type: "string" } },
- url: "/user/following/:username"
- },
- checkFollowingForUser: {
- method: "GET",
- params: {
- target_user: { required: true, type: "string" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/following/:target_user"
- },
- createGpgKey: {
- method: "POST",
- params: { armored_public_key: { type: "string" } },
- url: "/user/gpg_keys"
- },
- createPublicKey: {
- method: "POST",
- params: { key: { type: "string" }, title: { type: "string" } },
- url: "/user/keys"
- },
- deleteEmails: {
- method: "DELETE",
- params: { emails: { required: true, type: "string[]" } },
- url: "/user/emails"
- },
- deleteGpgKey: {
- method: "DELETE",
- params: { gpg_key_id: { required: true, type: "integer" } },
- url: "/user/gpg_keys/:gpg_key_id"
- },
- deletePublicKey: {
- method: "DELETE",
- params: { key_id: { required: true, type: "integer" } },
- url: "/user/keys/:key_id"
- },
- follow: {
- method: "PUT",
- params: { username: { required: true, type: "string" } },
- url: "/user/following/:username"
- },
- getAuthenticated: { method: "GET", params: {}, url: "/user" },
- getByUsername: {
- method: "GET",
- params: { username: { required: true, type: "string" } },
- url: "/users/:username"
- },
- getContextForUser: {
- method: "GET",
- params: {
- subject_id: { type: "string" },
- subject_type: {
- enum: ["organization", "repository", "issue", "pull_request"],
- type: "string"
- },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/hovercard"
- },
- getGpgKey: {
- method: "GET",
- params: { gpg_key_id: { required: true, type: "integer" } },
- url: "/user/gpg_keys/:gpg_key_id"
- },
- getPublicKey: {
- method: "GET",
- params: { key_id: { required: true, type: "integer" } },
- url: "/user/keys/:key_id"
- },
- list: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- since: { type: "string" }
- },
- url: "/users"
- },
- listBlocked: { method: "GET", params: {}, url: "/user/blocks" },
- listEmails: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/emails"
- },
- listFollowersForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/followers"
- },
- listFollowersForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/followers"
- },
- listFollowingForAuthenticatedUser: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/following"
- },
- listFollowingForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/following"
- },
- listGpgKeys: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/gpg_keys"
- },
- listGpgKeysForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/gpg_keys"
- },
- listPublicEmails: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/public_emails"
- },
- listPublicKeys: {
- method: "GET",
- params: { page: { type: "integer" }, per_page: { type: "integer" } },
- url: "/user/keys"
- },
- listPublicKeysForUser: {
- method: "GET",
- params: {
- page: { type: "integer" },
- per_page: { type: "integer" },
- username: { required: true, type: "string" }
- },
- url: "/users/:username/keys"
- },
- togglePrimaryEmailVisibility: {
- method: "PATCH",
- params: {
- email: { required: true, type: "string" },
- visibility: { required: true, type: "string" }
- },
- url: "/user/email/visibility"
- },
- unblock: {
- method: "DELETE",
- params: { username: { required: true, type: "string" } },
- url: "/user/blocks/:username"
- },
- unfollow: {
- method: "DELETE",
- params: { username: { required: true, type: "string" } },
- url: "/user/following/:username"
- },
- updateAuthenticated: {
- method: "PATCH",
- params: {
- bio: { type: "string" },
- blog: { type: "string" },
- company: { type: "string" },
- email: { type: "string" },
- hireable: { type: "boolean" },
- location: { type: "string" },
- name: { type: "string" }
- },
- url: "/user"
- }
- }
- };
- const VERSION = "2.4.0";
- function registerEndpoints(octokit, routes) {
- Object.keys(routes).forEach(namespaceName => {
- if (!octokit[namespaceName]) {
- octokit[namespaceName] = {};
- }
- Object.keys(routes[namespaceName]).forEach(apiName => {
- const apiOptions = routes[namespaceName][apiName];
- const endpointDefaults = ["method", "url", "headers"].reduce((map, key) => {
- if (typeof apiOptions[key] !== "undefined") {
- map[key] = apiOptions[key];
- }
- return map;
- }, {});
- endpointDefaults.request = {
- validate: apiOptions.params
- };
- let request = octokit.request.defaults(endpointDefaults);
- // patch request & endpoint methods to support deprecated parameters.
- // Not the most elegant solution, but we don’t want to move deprecation
- // logic into octokit/endpoint.js as it’s out of scope
- const hasDeprecatedParam = Object.keys(apiOptions.params || {}).find(key => apiOptions.params[key].deprecated);
- if (hasDeprecatedParam) {
- const patch = patchForDeprecation.bind(null, octokit, apiOptions);
- request = patch(octokit.request.defaults(endpointDefaults), `.${namespaceName}.${apiName}()`);
- request.endpoint = patch(request.endpoint, `.${namespaceName}.${apiName}.endpoint()`);
- request.endpoint.merge = patch(request.endpoint.merge, `.${namespaceName}.${apiName}.endpoint.merge()`);
- }
- if (apiOptions.deprecated) {
- octokit[namespaceName][apiName] = Object.assign(function deprecatedEndpointMethod() {
- octokit.log.warn(new Deprecation(`[@octokit/rest] ${apiOptions.deprecated}`));
- octokit[namespaceName][apiName] = request;
- return request.apply(null, arguments);
- }, request);
- return;
- }
- octokit[namespaceName][apiName] = request;
- });
- });
- }
- function patchForDeprecation(octokit, apiOptions, method, methodName) {
- const patchedMethod = (options) => {
- options = Object.assign({}, options);
- Object.keys(options).forEach(key => {
- if (apiOptions.params[key] && apiOptions.params[key].deprecated) {
- const aliasKey = apiOptions.params[key].alias;
- octokit.log.warn(new Deprecation(`[@octokit/rest] "${key}" parameter is deprecated for "${methodName}". Use "${aliasKey}" instead`));
- if (!(aliasKey in options)) {
- options[aliasKey] = options[key];
- }
- delete options[key];
- }
- });
- return method(options);
- };
- Object.keys(method).forEach(key => {
- patchedMethod[key] = method[key];
- });
- return patchedMethod;
- }
- /**
- * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary
- * goal is to rebuild @octokit/rest on top of @octokit/core. Once that is
- * done, we will remove the registerEndpoints methods and return the methods
- * directly as with the other plugins. At that point we will also remove the
- * legacy workarounds and deprecations.
- *
- * See the plan at
- * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1
- */
- function restEndpointMethods(octokit) {
- // @ts-ignore
- octokit.registerEndpoints = registerEndpoints.bind(null, octokit);
- registerEndpoints(octokit, endpointsByScope);
- // Aliasing scopes for backward compatibility
- // See https://github.com/octokit/rest.js/pull/1134
- [
- ["gitdata", "git"],
- ["authorization", "oauthAuthorizations"],
- ["pullRequests", "pulls"]
- ].forEach(([deprecatedScope, scope]) => {
- Object.defineProperty(octokit, deprecatedScope, {
- get() {
- octokit.log.warn(
- // @ts-ignore
- new Deprecation(`[@octokit/plugin-rest-endpoint-methods] "octokit.${deprecatedScope}.*" methods are deprecated, use "octokit.${scope}.*" instead`));
- // @ts-ignore
- return octokit[scope];
- }
- });
- });
- return {};
- }
- restEndpointMethods.VERSION = VERSION;
- export { restEndpointMethods };
- //# sourceMappingURL=index.js.map
|