12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720 |
- {
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- }
- },
- "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" } },
- "enterpriseAdmin": {
- "addAuthorizedSshKey": {
- "method": "POST",
- "params": { "authorized_key": { "required": true, "type": "string" } },
- "url": "/setup/api/settings/authorized-keys"
- },
- "checkConfigurationStatus": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/configcheck"
- },
- "checkMaintenanceStatus": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/maintenance"
- },
- "createGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "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" }
- },
- "url": "/admin/hooks"
- },
- "createImpersonationOAuthToken": {
- "method": "POST",
- "params": {
- "scopes": { "type": "string[]" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/admin/users/:username/authorizations"
- },
- "createOrg": {
- "method": "POST",
- "params": {
- "admin": { "required": true, "type": "string" },
- "login": { "required": true, "type": "string" },
- "profile_name": { "type": "string" }
- },
- "url": "/admin/organizations"
- },
- "createPreReceiveEnvironment": {
- "method": "POST",
- "params": {
- "image_url": { "required": true, "type": "string" },
- "name": { "required": true, "type": "string" }
- },
- "url": "/admin/pre-receive-environments"
- },
- "createPreReceiveHook": {
- "method": "POST",
- "params": {
- "allow_downstream_configuration": { "type": "boolean" },
- "enforcement": { "type": "string" },
- "environment": { "required": true, "type": "object" },
- "name": { "required": true, "type": "string" },
- "script": { "required": true, "type": "string" },
- "script_repository": { "required": true, "type": "object" }
- },
- "url": "/admin/pre-receive-hooks"
- },
- "createUser": {
- "method": "POST",
- "params": {
- "email": { "type": "string" },
- "login": { "required": true, "type": "string" }
- },
- "url": "/admin/users"
- },
- "deleteGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "DELETE",
- "params": { "hook_id": { "required": true, "type": "integer" } },
- "url": "/admin/hooks/:hook_id"
- },
- "deleteImpersonationOAuthToken": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/admin/users/:username/authorizations"
- },
- "deletePersonalAccessToken": {
- "method": "DELETE",
- "params": { "token_id": { "required": true, "type": "integer" } },
- "url": "/admin/tokens/:token_id"
- },
- "deletePreReceiveEnvironment": {
- "method": "DELETE",
- "params": {
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
- },
- "deletePreReceiveHook": {
- "method": "DELETE",
- "params": {
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
- },
- "deletePublicKey": {
- "method": "DELETE",
- "params": { "key_ids": { "required": true, "type": "string" } },
- "url": "/admin/keys/:key_ids"
- },
- "deleteUser": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/admin/users/:username"
- },
- "demoteSiteAdministratorToOrdinaryUser": {
- "method": "DELETE",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username/site_admin"
- },
- "enableOrDisableMaintenanceMode": {
- "method": "POST",
- "params": { "maintenance": { "required": true, "type": "string" } },
- "url": "/setup/api/maintenance"
- },
- "getGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "GET",
- "params": { "hook_id": { "required": true, "type": "integer" } },
- "url": "/admin/hooks/:hook_id"
- },
- "getLicenseInformation": {
- "method": "GET",
- "params": {},
- "url": "/enterprise/settings/license"
- },
- "getPreReceiveEnvironment": {
- "method": "GET",
- "params": {
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
- },
- "getPreReceiveEnvironmentDownloadStatus": {
- "method": "GET",
- "params": {
- "downloaded_at": { "type": "string" },
- "message": { "type": "string" },
- "pre_receive_environment_id": { "required": true, "type": "integer" },
- "state": { "type": "string" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest"
- },
- "getPreReceiveHook": {
- "method": "GET",
- "params": {
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-hooks/:pre_receive_hook_id"
- },
- "getPreReceiveHookForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
- },
- "getPreReceiveHookForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
- },
- "getTypeStats": {
- "method": "GET",
- "params": { "type": { "required": true, "type": "string" } },
- "url": "/enterprise/stats/:type"
- },
- "listGlobalHooks": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/hooks"
- },
- "listPersonalAccessTokens": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/tokens"
- },
- "listPreReceiveEnvironments": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/pre-receive-environments"
- },
- "listPreReceiveHooks": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/admin/pre-receive-hooks"
- },
- "listPreReceiveHooksForOrg": {
- "method": "GET",
- "params": {
- "org": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks"
- },
- "listPreReceiveHooksForRepo": {
- "method": "GET",
- "params": {
- "owner": { "required": true, "type": "string" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks"
- },
- "modifySettings": {
- "method": "PUT",
- "params": { "settings": { "required": true, "type": "string" } },
- "url": "/setup/api/settings"
- },
- "pingGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "method": "POST",
- "params": { "hook_id": { "required": true, "type": "integer" } },
- "url": "/admin/hooks/:hook_id/pings"
- },
- "promoteOrdinaryUserToSiteAdministrator": {
- "method": "PUT",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/users/:username/site_admin"
- },
- "queueIndexingJob": {
- "method": "POST",
- "params": { "target": { "required": true, "type": "string" } },
- "url": "/staff/indexing_jobs"
- },
- "removeAuthorizedSshKey": {
- "method": "DELETE",
- "params": { "authorized_key": { "required": true, "type": "string" } },
- "url": "/setup/api/settings/authorized-keys"
- },
- "removeEnforcementOverridesForPreReceiveHookForOrg": {
- "method": "DELETE",
- "params": {
- "org": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
- },
- "removeEnforcementOverridesForPreReceiveHookForRepo": {
- "method": "DELETE",
- "params": {
- "owner": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
- },
- "renameOrg": {
- "method": "PATCH",
- "params": {
- "login": { "required": true, "type": "string" },
- "org": { "required": true, "type": "string" }
- },
- "url": "/admin/organizations/:org"
- },
- "renameUser": {
- "method": "PATCH",
- "params": {
- "login": { "required": true, "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/admin/users/:username"
- },
- "retrieveAuthorizedSshKeys": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/settings/authorized-keys"
- },
- "retrieveSettings": {
- "method": "GET",
- "params": {},
- "url": "/setup/api/settings"
- },
- "startConfigurationProcess": {
- "method": "POST",
- "params": {},
- "url": "/setup/api/configure"
- },
- "suspendUser": {
- "method": "PUT",
- "params": {
- "reason": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/suspended"
- },
- "syncLdapMappingForTeam": {
- "method": "POST",
- "params": { "team_id": { "required": true, "type": "integer" } },
- "url": "/admin/ldap/teams/:team_id/sync"
- },
- "syncLdapMappingForUser": {
- "method": "POST",
- "params": { "username": { "required": true, "type": "string" } },
- "url": "/admin/ldap/users/:username/sync"
- },
- "triggerPreReceiveEnvironmentDownload": {
- "method": "POST",
- "params": {
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads"
- },
- "unsuspendUser": {
- "method": "DELETE",
- "params": {
- "reason": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/users/:username/suspended"
- },
- "updateGlobalHook": {
- "headers": { "accept": "application/vnd.github.superpro-preview+json" },
- "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" }
- },
- "url": "/admin/hooks/:hook_id"
- },
- "updateLdapMappingForTeam": {
- "method": "PATCH",
- "params": {
- "ldap_dn": { "type": "string" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/ldap/teams/:team_id/mapping"
- },
- "updateLdapMappingForUser": {
- "method": "PATCH",
- "params": {
- "ldap_dn": { "type": "string" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/admin/ldap/users/:username/mapping"
- },
- "updatePreReceiveEnvironment": {
- "method": "PATCH",
- "params": {
- "image_url": { "type": "string" },
- "name": { "type": "string" },
- "pre_receive_environment_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre-receive-environments/:pre_receive_environment_id"
- },
- "updatePreReceiveHook": {
- "method": "PATCH",
- "params": {
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/admin/pre_receive_hooks/:pre_receive_hook_id"
- },
- "updatePreReceiveHookEnforcementForOrg": {
- "method": "PATCH",
- "params": {
- "org": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" }
- },
- "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id"
- },
- "updatePreReceiveHookEnforcementForRepo": {
- "method": "PATCH",
- "params": {
- "owner": { "required": true, "type": "string" },
- "pre_receive_hook_id": { "required": true, "type": "integer" },
- "repo": { "required": true, "type": "string" }
- },
- "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id"
- },
- "upgradeLicense": {
- "method": "POST",
- "params": { "license": { "type": "string" } },
- "url": "/setup/api/upgrade"
- },
- "uploadLicenseForFirstTime": {
- "method": "POST",
- "params": {
- "license": { "required": true, "type": "string" },
- "password": { "type": "string" },
- "settings": { "type": "string" }
- },
- "url": "/setup/api/start"
- }
- },
- "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"
- }
- },
- "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" },
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "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" } },
- "oauthAuthorizations": {
- "checkAuthorization": {
- "method": "GET",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/tokens/:access_token"
- },
- "createAuthorization": {
- "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": {
- "method": "DELETE",
- "params": { "authorization_id": { "required": true, "type": "integer" } },
- "url": "/authorizations/:authorization_id"
- },
- "deleteGrant": {
- "method": "DELETE",
- "params": { "grant_id": { "required": true, "type": "integer" } },
- "url": "/applications/grants/:grant_id"
- },
- "getAuthorization": {
- "method": "GET",
- "params": { "authorization_id": { "required": true, "type": "integer" } },
- "url": "/authorizations/:authorization_id"
- },
- "getGrant": {
- "method": "GET",
- "params": { "grant_id": { "required": true, "type": "integer" } },
- "url": "/applications/grants/:grant_id"
- },
- "getOrCreateAuthorizationForApp": {
- "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": {
- "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": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/authorizations"
- },
- "listGrants": {
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" }
- },
- "url": "/applications/grants"
- },
- "resetAuthorization": {
- "method": "POST",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/tokens/:access_token"
- },
- "revokeAuthorizationForApplication": {
- "method": "DELETE",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/tokens/:access_token"
- },
- "revokeGrantForApplication": {
- "method": "DELETE",
- "params": {
- "access_token": { "required": true, "type": "string" },
- "client_id": { "required": true, "type": "string" }
- },
- "url": "/applications/:client_id/grants/:access_token"
- },
- "updateAuthorization": {
- "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"
- },
- "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"
- },
- "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": "string" }
- },
- "url": "/organizations"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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_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": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "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"
- },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "position": { "required": true, "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "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"
- },
- "number": {
- "alias": "pull_number",
- "deprecated": true,
- "type": "integer"
- },
- "owner": { "required": true, "type": "string" },
- "path": { "required": true, "type": "string" },
- "position": { "required": true, "type": "integer" },
- "pull_number": { "required": true, "type": "integer" },
- "repo": { "required": true, "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" },
- "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": {
- "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": {
- "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"
- },
- "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": {
- "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": {
- "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"
- }
- },
- "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"
- },
- "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"
- },
- "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" },
- "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" }
- },
- "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" },
- "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" }
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"
- },
- "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"],
- "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": "string" },
- "visibility": { "type": "string" }
- },
- "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"
- },
- "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": {
- "headers": { "accept": "application/vnd.github.nightshade-preview+json" },
- "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": {
- "headers": { "accept": "application/vnd.github.x-ray-preview+json" },
- "method": "PATCH",
- "params": {
- "allow_merge_commit": { "type": "boolean" },
- "allow_rebase_merge": { "type": "boolean" },
- "allow_squash_merge": { "type": "boolean" },
- "anonymous_access_enabled": { "type": "boolean" },
- "archived": { "type": "boolean" },
- "default_branch": { "type": "string" },
- "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" }
- },
- "url": "/repos/:owner/:repo"
- },
- "updateBranchProtection": {
- "method": "PUT",
- "params": {
- "branch": { "required": true, "type": "string" },
- "enforce_admins": {
- "allowNull": true,
- "required": true,
- "type": "boolean"
- },
- "owner": { "required": true, "type": "string" },
- "repo": { "required": true, "type": "string" },
- "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": {
- "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": {
- "file": {
- "mapTo": "data",
- "required": 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() is deprecated, see https://developer.github.com/enterprise/2.19/v3/teams/members/#add-team-member",
- "method": "PUT",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/members/:username"
- },
- "addOrUpdateMembership": {
- "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": {
- "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": {
- "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": {
- "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" },
- "ldap_dn": { "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": {
- "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": {
- "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"
- },
- "delete": {
- "method": "DELETE",
- "params": { "team_id": { "required": true, "type": "integer" } },
- "url": "/teams/:team_id"
- },
- "deleteDiscussion": {
- "method": "DELETE",
- "params": {
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number"
- },
- "deleteDiscussionComment": {
- "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"
- },
- "get": {
- "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": {
- "method": "GET",
- "params": {
- "discussion_number": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/discussions/:discussion_number"
- },
- "getDiscussionComment": {
- "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"
- },
- "getMember": {
- "deprecated": "octokit.teams.getMember() is deprecated, see https://developer.github.com/enterprise/2.19/v3/teams/members/#get-team-member",
- "method": "GET",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/members/:username"
- },
- "getMembership": {
- "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": {
- "headers": { "accept": "application/vnd.github.hellcat-preview+json" },
- "method": "GET",
- "params": {
- "page": { "type": "integer" },
- "per_page": { "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/teams"
- },
- "listDiscussionComments": {
- "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": {
- "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": {
- "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"
- },
- "listProjects": {
- "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": {
- "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() is deprecated, see https://developer.github.com/enterprise/2.19/v3/teams/members/#remove-team-member",
- "method": "DELETE",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/members/:username"
- },
- "removeMembership": {
- "method": "DELETE",
- "params": {
- "team_id": { "required": true, "type": "integer" },
- "username": { "required": true, "type": "string" }
- },
- "url": "/teams/:team_id/memberships/:username"
- },
- "removeProject": {
- "method": "DELETE",
- "params": {
- "project_id": { "required": true, "type": "integer" },
- "team_id": { "required": true, "type": "integer" }
- },
- "url": "/teams/:team_id/projects/:project_id"
- },
- "removeRepo": {
- "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": {
- "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": {
- "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": {
- "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": {
- "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"
- }
- },
- "users": {
- "addEmails": {
- "method": "POST",
- "params": { "emails": { "required": true, "type": "string[]" } },
- "url": "/user/emails"
- },
- "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"
- },
- "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"
- },
- "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"
- }
- }
- }
|