ghe-2.17-endpoints.json 1.9 MB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484134851348613487134881348913490134911349213493134941349513496134971349813499135001350113502135031350413505135061350713508135091351013511135121351313514135151351613517135181351913520135211352213523135241352513526135271352813529135301353113532135331353413535135361353713538135391354013541135421354313544135451354613547135481354913550135511355213553135541355513556135571355813559135601356113562135631356413565135661356713568135691357013571135721357313574135751357613577135781357913580135811358213583135841358513586135871358813589135901359113592135931359413595135961359713598135991360013601136021360313604136051360613607136081360913610136111361213613136141361513616136171361813619136201362113622136231362413625136261362713628136291363013631136321363313634136351363613637136381363913640136411364213643136441364513646136471364813649136501365113652136531365413655136561365713658136591366013661136621366313664136651366613667136681366913670136711367213673136741367513676136771367813679136801368113682136831368413685136861368713688136891369013691136921369313694136951369613697136981369913700137011370213703137041370513706137071370813709137101371113712137131371413715137161371713718137191372013721137221372313724137251372613727137281372913730137311373213733137341373513736137371373813739137401374113742137431374413745137461374713748137491375013751137521375313754137551375613757137581375913760137611376213763137641376513766137671376813769137701377113772137731377413775137761377713778137791378013781137821378313784137851378613787137881378913790137911379213793137941379513796137971379813799138001380113802138031380413805138061380713808138091381013811138121381313814138151381613817138181381913820138211382213823138241382513826138271382813829138301383113832138331383413835138361383713838138391384013841138421384313844138451384613847138481384913850138511385213853138541385513856138571385813859138601386113862138631386413865138661386713868138691387013871138721387313874138751387613877138781387913880138811388213883138841388513886138871388813889138901389113892138931389413895138961389713898138991390013901139021390313904139051390613907139081390913910139111391213913139141391513916139171391813919139201392113922139231392413925139261392713928139291393013931139321393313934139351393613937139381393913940139411394213943139441394513946139471394813949139501395113952139531395413955139561395713958139591396013961139621396313964139651396613967139681396913970139711397213973139741397513976139771397813979139801398113982139831398413985139861398713988139891399013991139921399313994139951399613997139981399914000140011400214003140041400514006140071400814009140101401114012140131401414015140161401714018140191402014021140221402314024140251402614027140281402914030140311403214033140341403514036140371403814039140401404114042140431404414045140461404714048140491405014051140521405314054140551405614057140581405914060140611406214063140641406514066140671406814069140701407114072140731407414075140761407714078140791408014081140821408314084140851408614087140881408914090140911409214093140941409514096140971409814099141001410114102141031410414105141061410714108141091411014111141121411314114141151411614117141181411914120141211412214123141241412514126141271412814129141301413114132141331413414135141361413714138141391414014141141421414314144141451414614147141481414914150141511415214153141541415514156141571415814159141601416114162141631416414165141661416714168141691417014171141721417314174141751417614177141781417914180141811418214183141841418514186141871418814189141901419114192141931419414195141961419714198141991420014201142021420314204142051420614207142081420914210142111421214213142141421514216142171421814219142201422114222142231422414225142261422714228142291423014231142321423314234142351423614237142381423914240142411424214243142441424514246142471424814249142501425114252142531425414255142561425714258142591426014261142621426314264142651426614267142681426914270142711427214273142741427514276142771427814279142801428114282142831428414285142861428714288142891429014291142921429314294142951429614297142981429914300143011430214303143041430514306143071430814309143101431114312143131431414315143161431714318143191432014321143221432314324143251432614327143281432914330143311433214333143341433514336143371433814339143401434114342143431434414345143461434714348143491435014351143521435314354143551435614357143581435914360143611436214363143641436514366143671436814369143701437114372143731437414375143761437714378143791438014381143821438314384143851438614387143881438914390143911439214393143941439514396143971439814399144001440114402144031440414405144061440714408144091441014411144121441314414144151441614417144181441914420144211442214423144241442514426144271442814429144301443114432144331443414435144361443714438144391444014441144421444314444144451444614447144481444914450144511445214453144541445514456144571445814459144601446114462144631446414465144661446714468144691447014471144721447314474144751447614477144781447914480144811448214483144841448514486144871448814489144901449114492144931449414495144961449714498144991450014501145021450314504145051450614507145081450914510145111451214513145141451514516145171451814519145201452114522145231452414525145261452714528145291453014531145321453314534145351453614537145381453914540145411454214543145441454514546145471454814549145501455114552145531455414555145561455714558145591456014561145621456314564145651456614567145681456914570145711457214573145741457514576145771457814579145801458114582145831458414585145861458714588145891459014591145921459314594145951459614597145981459914600146011460214603146041460514606146071460814609146101461114612146131461414615146161461714618146191462014621146221462314624146251462614627146281462914630146311463214633146341463514636146371463814639146401464114642146431464414645146461464714648146491465014651146521465314654146551465614657146581465914660146611466214663146641466514666146671466814669146701467114672146731467414675146761467714678146791468014681146821468314684146851468614687146881468914690146911469214693146941469514696146971469814699147001470114702147031470414705147061470714708147091471014711147121471314714147151471614717147181471914720147211472214723147241472514726147271472814729147301473114732147331473414735147361473714738147391474014741147421474314744147451474614747147481474914750147511475214753147541475514756147571475814759147601476114762147631476414765147661476714768147691477014771147721477314774147751477614777147781477914780147811478214783147841478514786147871478814789147901479114792147931479414795147961479714798147991480014801148021480314804148051480614807148081480914810148111481214813148141481514816148171481814819148201482114822148231482414825148261482714828148291483014831148321483314834148351483614837148381483914840148411484214843148441484514846148471484814849148501485114852148531485414855148561485714858148591486014861148621486314864148651486614867148681486914870148711487214873148741487514876148771487814879148801488114882148831488414885148861488714888148891489014891148921489314894148951489614897148981489914900149011490214903149041490514906149071490814909149101491114912149131491414915149161491714918149191492014921149221492314924149251492614927149281492914930149311493214933149341493514936149371493814939149401494114942149431494414945149461494714948149491495014951149521495314954149551495614957149581495914960149611496214963149641496514966149671496814969149701497114972149731497414975149761497714978149791498014981149821498314984149851498614987149881498914990149911499214993149941499514996149971499814999150001500115002150031500415005150061500715008150091501015011150121501315014150151501615017150181501915020150211502215023150241502515026150271502815029150301503115032150331503415035150361503715038150391504015041150421504315044150451504615047150481504915050150511505215053150541505515056150571505815059150601506115062150631506415065150661506715068150691507015071150721507315074150751507615077150781507915080150811508215083150841508515086150871508815089150901509115092150931509415095150961509715098150991510015101151021510315104151051510615107151081510915110151111511215113151141511515116151171511815119151201512115122151231512415125151261512715128151291513015131151321513315134151351513615137151381513915140151411514215143151441514515146151471514815149151501515115152151531515415155151561515715158151591516015161151621516315164151651516615167151681516915170151711517215173151741517515176151771517815179151801518115182151831518415185151861518715188151891519015191151921519315194151951519615197151981519915200152011520215203152041520515206152071520815209152101521115212152131521415215152161521715218152191522015221152221522315224152251522615227152281522915230152311523215233152341523515236152371523815239152401524115242152431524415245152461524715248152491525015251152521525315254152551525615257152581525915260152611526215263152641526515266152671526815269152701527115272152731527415275152761527715278152791528015281152821528315284152851528615287152881528915290152911529215293152941529515296152971529815299153001530115302153031530415305153061530715308153091531015311153121531315314153151531615317153181531915320153211532215323153241532515326153271532815329153301533115332153331533415335153361533715338153391534015341153421534315344153451534615347153481534915350153511535215353153541535515356153571535815359153601536115362153631536415365153661536715368153691537015371153721537315374153751537615377153781537915380153811538215383153841538515386153871538815389153901539115392153931539415395153961539715398153991540015401154021540315404154051540615407154081540915410154111541215413154141541515416154171541815419154201542115422154231542415425154261542715428154291543015431154321543315434154351543615437154381543915440154411544215443154441544515446154471544815449154501545115452154531545415455154561545715458154591546015461154621546315464154651546615467154681546915470154711547215473154741547515476154771547815479154801548115482154831548415485154861548715488154891549015491154921549315494154951549615497154981549915500155011550215503155041550515506155071550815509155101551115512155131551415515155161551715518155191552015521155221552315524155251552615527155281552915530155311553215533155341553515536155371553815539155401554115542155431554415545155461554715548155491555015551155521555315554155551555615557155581555915560155611556215563155641556515566155671556815569155701557115572155731557415575155761557715578155791558015581155821558315584155851558615587155881558915590155911559215593155941559515596155971559815599156001560115602156031560415605156061560715608156091561015611156121561315614156151561615617156181561915620156211562215623156241562515626156271562815629156301563115632156331563415635156361563715638156391564015641156421564315644156451564615647156481564915650156511565215653156541565515656156571565815659156601566115662156631566415665156661566715668156691567015671156721567315674156751567615677156781567915680156811568215683156841568515686156871568815689156901569115692156931569415695156961569715698156991570015701157021570315704157051570615707157081570915710157111571215713157141571515716157171571815719157201572115722157231572415725157261572715728157291573015731157321573315734157351573615737157381573915740157411574215743157441574515746157471574815749157501575115752157531575415755157561575715758157591576015761157621576315764157651576615767157681576915770157711577215773157741577515776157771577815779157801578115782157831578415785157861578715788157891579015791157921579315794157951579615797157981579915800158011580215803158041580515806158071580815809158101581115812158131581415815158161581715818158191582015821158221582315824158251582615827158281582915830158311583215833158341583515836158371583815839158401584115842158431584415845158461584715848158491585015851158521585315854158551585615857158581585915860158611586215863158641586515866158671586815869158701587115872158731587415875158761587715878158791588015881158821588315884158851588615887158881588915890158911589215893158941589515896158971589815899159001590115902159031590415905159061590715908159091591015911159121591315914159151591615917159181591915920159211592215923159241592515926159271592815929159301593115932159331593415935159361593715938159391594015941159421594315944159451594615947159481594915950159511595215953159541595515956159571595815959159601596115962159631596415965159661596715968159691597015971159721597315974159751597615977159781597915980159811598215983159841598515986159871598815989159901599115992159931599415995159961599715998159991600016001160021600316004160051600616007160081600916010160111601216013160141601516016160171601816019160201602116022160231602416025160261602716028160291603016031160321603316034160351603616037160381603916040160411604216043160441604516046160471604816049160501605116052160531605416055160561605716058160591606016061160621606316064160651606616067160681606916070160711607216073160741607516076160771607816079160801608116082160831608416085160861608716088160891609016091160921609316094160951609616097160981609916100161011610216103161041610516106161071610816109161101611116112161131611416115161161611716118161191612016121161221612316124161251612616127161281612916130161311613216133161341613516136161371613816139161401614116142161431614416145161461614716148161491615016151161521615316154161551615616157161581615916160161611616216163161641616516166161671616816169161701617116172161731617416175161761617716178161791618016181161821618316184161851618616187161881618916190161911619216193161941619516196161971619816199162001620116202162031620416205162061620716208162091621016211162121621316214162151621616217162181621916220162211622216223162241622516226162271622816229162301623116232162331623416235162361623716238162391624016241162421624316244162451624616247162481624916250162511625216253162541625516256162571625816259162601626116262162631626416265162661626716268162691627016271162721627316274162751627616277162781627916280162811628216283162841628516286162871628816289162901629116292162931629416295162961629716298162991630016301163021630316304163051630616307163081630916310163111631216313163141631516316163171631816319163201632116322163231632416325163261632716328163291633016331163321633316334163351633616337163381633916340163411634216343163441634516346163471634816349163501635116352163531635416355163561635716358163591636016361163621636316364163651636616367163681636916370163711637216373163741637516376163771637816379163801638116382163831638416385163861638716388163891639016391163921639316394163951639616397163981639916400164011640216403164041640516406164071640816409164101641116412164131641416415164161641716418164191642016421164221642316424164251642616427164281642916430164311643216433164341643516436164371643816439164401644116442164431644416445164461644716448164491645016451164521645316454164551645616457164581645916460164611646216463164641646516466164671646816469164701647116472164731647416475164761647716478164791648016481164821648316484164851648616487164881648916490164911649216493164941649516496164971649816499165001650116502165031650416505165061650716508165091651016511165121651316514165151651616517165181651916520165211652216523165241652516526165271652816529165301653116532165331653416535165361653716538165391654016541165421654316544165451654616547165481654916550165511655216553165541655516556165571655816559165601656116562165631656416565165661656716568165691657016571165721657316574165751657616577165781657916580165811658216583165841658516586165871658816589165901659116592165931659416595165961659716598165991660016601166021660316604166051660616607166081660916610166111661216613166141661516616166171661816619166201662116622166231662416625166261662716628166291663016631166321663316634166351663616637166381663916640166411664216643166441664516646166471664816649166501665116652166531665416655166561665716658166591666016661166621666316664166651666616667166681666916670166711667216673166741667516676166771667816679166801668116682166831668416685166861668716688166891669016691166921669316694166951669616697166981669916700167011670216703167041670516706167071670816709167101671116712167131671416715167161671716718167191672016721167221672316724167251672616727167281672916730167311673216733167341673516736167371673816739167401674116742167431674416745167461674716748167491675016751167521675316754167551675616757167581675916760167611676216763167641676516766167671676816769167701677116772167731677416775167761677716778167791678016781167821678316784167851678616787167881678916790167911679216793167941679516796167971679816799168001680116802168031680416805168061680716808168091681016811168121681316814168151681616817168181681916820168211682216823168241682516826168271682816829168301683116832168331683416835168361683716838168391684016841168421684316844168451684616847168481684916850168511685216853168541685516856168571685816859168601686116862168631686416865168661686716868168691687016871168721687316874168751687616877168781687916880168811688216883168841688516886168871688816889168901689116892168931689416895168961689716898168991690016901169021690316904169051690616907169081690916910169111691216913169141691516916169171691816919169201692116922169231692416925169261692716928169291693016931169321693316934169351693616937169381693916940169411694216943169441694516946169471694816949169501695116952169531695416955169561695716958169591696016961169621696316964169651696616967169681696916970169711697216973169741697516976169771697816979169801698116982169831698416985169861698716988169891699016991169921699316994169951699616997169981699917000170011700217003170041700517006170071700817009170101701117012170131701417015170161701717018170191702017021170221702317024170251702617027170281702917030170311703217033170341703517036170371703817039170401704117042170431704417045170461704717048170491705017051170521705317054170551705617057170581705917060170611706217063170641706517066170671706817069170701707117072170731707417075170761707717078170791708017081170821708317084170851708617087170881708917090170911709217093170941709517096170971709817099171001710117102171031710417105171061710717108171091711017111171121711317114171151711617117171181711917120171211712217123171241712517126171271712817129171301713117132171331713417135171361713717138171391714017141171421714317144171451714617147171481714917150171511715217153171541715517156171571715817159171601716117162171631716417165171661716717168171691717017171171721717317174171751717617177171781717917180171811718217183171841718517186171871718817189171901719117192171931719417195171961719717198171991720017201172021720317204172051720617207172081720917210172111721217213172141721517216172171721817219172201722117222172231722417225172261722717228172291723017231172321723317234172351723617237172381723917240172411724217243172441724517246172471724817249172501725117252172531725417255172561725717258172591726017261172621726317264172651726617267172681726917270172711727217273172741727517276172771727817279172801728117282172831728417285172861728717288172891729017291172921729317294172951729617297172981729917300173011730217303173041730517306173071730817309173101731117312173131731417315173161731717318173191732017321173221732317324173251732617327173281732917330173311733217333173341733517336173371733817339173401734117342173431734417345173461734717348173491735017351173521735317354173551735617357173581735917360173611736217363173641736517366173671736817369173701737117372173731737417375173761737717378173791738017381173821738317384173851738617387173881738917390173911739217393173941739517396173971739817399174001740117402174031740417405174061740717408174091741017411174121741317414174151741617417174181741917420174211742217423174241742517426174271742817429174301743117432174331743417435174361743717438174391744017441174421744317444174451744617447174481744917450174511745217453174541745517456174571745817459174601746117462174631746417465174661746717468174691747017471174721747317474174751747617477174781747917480174811748217483174841748517486174871748817489174901749117492174931749417495174961749717498174991750017501175021750317504175051750617507175081750917510175111751217513175141751517516175171751817519175201752117522175231752417525175261752717528175291753017531175321753317534175351753617537175381753917540175411754217543175441754517546175471754817549175501755117552175531755417555175561755717558175591756017561175621756317564175651756617567175681756917570175711757217573175741757517576175771757817579175801758117582175831758417585175861758717588175891759017591175921759317594175951759617597175981759917600176011760217603176041760517606176071760817609176101761117612176131761417615176161761717618176191762017621176221762317624176251762617627176281762917630176311763217633176341763517636176371763817639176401764117642176431764417645176461764717648176491765017651176521765317654176551765617657176581765917660176611766217663176641766517666176671766817669176701767117672176731767417675176761767717678176791768017681176821768317684176851768617687176881768917690176911769217693176941769517696176971769817699177001770117702177031770417705177061770717708177091771017711177121771317714177151771617717177181771917720177211772217723177241772517726177271772817729177301773117732177331773417735177361773717738177391774017741177421774317744177451774617747177481774917750177511775217753177541775517756177571775817759177601776117762177631776417765177661776717768177691777017771177721777317774177751777617777177781777917780177811778217783177841778517786177871778817789177901779117792177931779417795177961779717798177991780017801178021780317804178051780617807178081780917810178111781217813178141781517816178171781817819178201782117822178231782417825178261782717828178291783017831178321783317834178351783617837178381783917840178411784217843178441784517846178471784817849178501785117852178531785417855178561785717858178591786017861178621786317864178651786617867178681786917870178711787217873178741787517876178771787817879178801788117882178831788417885178861788717888178891789017891178921789317894178951789617897178981789917900179011790217903179041790517906179071790817909179101791117912179131791417915179161791717918179191792017921179221792317924179251792617927179281792917930179311793217933179341793517936179371793817939179401794117942179431794417945179461794717948179491795017951179521795317954179551795617957179581795917960179611796217963179641796517966179671796817969179701797117972179731797417975179761797717978179791798017981179821798317984179851798617987179881798917990179911799217993179941799517996179971799817999180001800118002180031800418005180061800718008180091801018011180121801318014180151801618017180181801918020180211802218023180241802518026180271802818029180301803118032180331803418035180361803718038180391804018041180421804318044180451804618047180481804918050180511805218053180541805518056180571805818059180601806118062180631806418065180661806718068180691807018071180721807318074180751807618077180781807918080180811808218083180841808518086180871808818089180901809118092180931809418095180961809718098180991810018101181021810318104181051810618107181081810918110181111811218113181141811518116181171811818119181201812118122181231812418125181261812718128181291813018131181321813318134181351813618137181381813918140181411814218143181441814518146181471814818149181501815118152181531815418155181561815718158181591816018161181621816318164181651816618167181681816918170181711817218173181741817518176181771817818179181801818118182181831818418185181861818718188181891819018191181921819318194181951819618197181981819918200182011820218203182041820518206182071820818209182101821118212182131821418215182161821718218182191822018221182221822318224182251822618227182281822918230182311823218233182341823518236182371823818239182401824118242182431824418245182461824718248182491825018251182521825318254182551825618257182581825918260182611826218263182641826518266182671826818269182701827118272182731827418275182761827718278182791828018281182821828318284182851828618287182881828918290182911829218293182941829518296182971829818299183001830118302183031830418305183061830718308183091831018311183121831318314183151831618317183181831918320183211832218323183241832518326183271832818329183301833118332183331833418335183361833718338183391834018341183421834318344183451834618347183481834918350183511835218353183541835518356183571835818359183601836118362183631836418365183661836718368183691837018371183721837318374183751837618377183781837918380183811838218383183841838518386183871838818389183901839118392183931839418395183961839718398183991840018401184021840318404184051840618407184081840918410184111841218413184141841518416184171841818419184201842118422184231842418425184261842718428184291843018431184321843318434184351843618437184381843918440184411844218443184441844518446184471844818449184501845118452184531845418455184561845718458184591846018461184621846318464184651846618467184681846918470184711847218473184741847518476184771847818479184801848118482184831848418485184861848718488184891849018491184921849318494184951849618497184981849918500185011850218503185041850518506185071850818509185101851118512185131851418515185161851718518185191852018521185221852318524185251852618527185281852918530185311853218533185341853518536185371853818539185401854118542185431854418545185461854718548185491855018551185521855318554185551855618557185581855918560185611856218563185641856518566185671856818569185701857118572185731857418575185761857718578185791858018581185821858318584185851858618587185881858918590185911859218593185941859518596185971859818599186001860118602186031860418605186061860718608186091861018611186121861318614186151861618617186181861918620186211862218623186241862518626186271862818629186301863118632186331863418635186361863718638186391864018641186421864318644186451864618647186481864918650186511865218653186541865518656186571865818659186601866118662186631866418665186661866718668186691867018671186721867318674186751867618677186781867918680186811868218683186841868518686186871868818689186901869118692186931869418695186961869718698186991870018701187021870318704187051870618707187081870918710187111871218713187141871518716187171871818719187201872118722187231872418725187261872718728187291873018731187321873318734187351873618737187381873918740187411874218743187441874518746187471874818749187501875118752187531875418755187561875718758187591876018761187621876318764187651876618767187681876918770187711877218773187741877518776187771877818779187801878118782187831878418785187861878718788187891879018791187921879318794187951879618797187981879918800188011880218803188041880518806188071880818809188101881118812188131881418815188161881718818188191882018821188221882318824188251882618827188281882918830188311883218833188341883518836188371883818839188401884118842188431884418845188461884718848188491885018851188521885318854188551885618857188581885918860188611886218863188641886518866188671886818869188701887118872188731887418875188761887718878188791888018881188821888318884188851888618887188881888918890188911889218893188941889518896188971889818899189001890118902189031890418905189061890718908189091891018911189121891318914189151891618917189181891918920189211892218923189241892518926189271892818929189301893118932189331893418935189361893718938189391894018941189421894318944189451894618947189481894918950189511895218953189541895518956189571895818959189601896118962189631896418965189661896718968189691897018971189721897318974189751897618977189781897918980189811898218983189841898518986189871898818989189901899118992189931899418995189961899718998189991900019001190021900319004190051900619007190081900919010190111901219013190141901519016190171901819019190201902119022190231902419025190261902719028190291903019031190321903319034190351903619037190381903919040190411904219043190441904519046190471904819049190501905119052190531905419055190561905719058190591906019061190621906319064190651906619067190681906919070190711907219073190741907519076190771907819079190801908119082190831908419085190861908719088190891909019091190921909319094190951909619097190981909919100191011910219103191041910519106191071910819109191101911119112191131911419115191161911719118191191912019121191221912319124191251912619127191281912919130191311913219133191341913519136191371913819139191401914119142191431914419145191461914719148191491915019151191521915319154191551915619157191581915919160191611916219163191641916519166191671916819169191701917119172191731917419175191761917719178191791918019181191821918319184191851918619187191881918919190191911919219193191941919519196191971919819199192001920119202192031920419205192061920719208192091921019211192121921319214192151921619217192181921919220192211922219223192241922519226192271922819229192301923119232192331923419235192361923719238192391924019241192421924319244192451924619247192481924919250192511925219253192541925519256192571925819259192601926119262192631926419265192661926719268192691927019271192721927319274192751927619277192781927919280192811928219283192841928519286192871928819289192901929119292192931929419295192961929719298192991930019301193021930319304193051930619307193081930919310193111931219313193141931519316193171931819319193201932119322193231932419325193261932719328193291933019331193321933319334193351933619337193381933919340193411934219343193441934519346193471934819349193501935119352193531935419355193561935719358193591936019361193621936319364193651936619367193681936919370193711937219373193741937519376193771937819379193801938119382193831938419385193861938719388193891939019391193921939319394193951939619397193981939919400194011940219403194041940519406194071940819409194101941119412194131941419415194161941719418194191942019421194221942319424194251942619427194281942919430194311943219433194341943519436194371943819439194401944119442194431944419445194461944719448194491945019451194521945319454194551945619457194581945919460194611946219463194641946519466194671946819469194701947119472194731947419475194761947719478194791948019481194821948319484194851948619487194881948919490194911949219493194941949519496194971949819499195001950119502195031950419505195061950719508195091951019511195121951319514195151951619517195181951919520195211952219523195241952519526195271952819529195301953119532195331953419535195361953719538195391954019541195421954319544195451954619547195481954919550195511955219553195541955519556195571955819559195601956119562195631956419565195661956719568195691957019571195721957319574195751957619577195781957919580195811958219583195841958519586195871958819589195901959119592195931959419595195961959719598195991960019601196021960319604196051960619607196081960919610196111961219613196141961519616196171961819619196201962119622196231962419625196261962719628196291963019631196321963319634196351963619637196381963919640196411964219643196441964519646196471964819649196501965119652196531965419655196561965719658196591966019661196621966319664196651966619667196681966919670196711967219673196741967519676196771967819679196801968119682196831968419685196861968719688196891969019691196921969319694196951969619697196981969919700197011970219703197041970519706197071970819709197101971119712197131971419715197161971719718197191972019721197221972319724197251972619727197281972919730197311973219733197341973519736197371973819739197401974119742197431974419745197461974719748197491975019751197521975319754197551975619757197581975919760197611976219763197641976519766197671976819769197701977119772197731977419775197761977719778197791978019781197821978319784197851978619787197881978919790197911979219793197941979519796197971979819799198001980119802198031980419805198061980719808198091981019811198121981319814198151981619817198181981919820198211982219823198241982519826198271982819829198301983119832198331983419835198361983719838198391984019841198421984319844198451984619847198481984919850198511985219853198541985519856198571985819859198601986119862198631986419865198661986719868198691987019871198721987319874198751987619877198781987919880198811988219883198841988519886198871988819889198901989119892198931989419895198961989719898198991990019901199021990319904199051990619907199081990919910199111991219913199141991519916199171991819919199201992119922199231992419925199261992719928199291993019931199321993319934199351993619937199381993919940199411994219943199441994519946199471994819949199501995119952199531995419955199561995719958199591996019961199621996319964199651996619967199681996919970199711997219973199741997519976199771997819979199801998119982199831998419985199861998719988199891999019991199921999319994199951999619997199981999920000200012000220003200042000520006200072000820009200102001120012200132001420015200162001720018200192002020021200222002320024200252002620027200282002920030200312003220033200342003520036200372003820039200402004120042200432004420045200462004720048200492005020051200522005320054200552005620057200582005920060200612006220063200642006520066200672006820069200702007120072200732007420075200762007720078200792008020081200822008320084200852008620087200882008920090200912009220093200942009520096200972009820099201002010120102201032010420105201062010720108201092011020111201122011320114201152011620117201182011920120201212012220123201242012520126201272012820129201302013120132201332013420135201362013720138201392014020141201422014320144201452014620147201482014920150201512015220153201542015520156201572015820159201602016120162201632016420165201662016720168201692017020171201722017320174201752017620177201782017920180201812018220183201842018520186201872018820189201902019120192201932019420195201962019720198201992020020201202022020320204202052020620207202082020920210202112021220213202142021520216202172021820219202202022120222202232022420225202262022720228202292023020231202322023320234202352023620237202382023920240202412024220243202442024520246202472024820249202502025120252202532025420255202562025720258202592026020261202622026320264202652026620267202682026920270202712027220273202742027520276202772027820279202802028120282202832028420285202862028720288202892029020291202922029320294202952029620297202982029920300203012030220303203042030520306203072030820309203102031120312203132031420315203162031720318203192032020321203222032320324203252032620327203282032920330203312033220333203342033520336203372033820339203402034120342203432034420345203462034720348203492035020351203522035320354203552035620357203582035920360203612036220363203642036520366203672036820369203702037120372203732037420375203762037720378203792038020381203822038320384203852038620387203882038920390203912039220393203942039520396203972039820399204002040120402204032040420405204062040720408204092041020411204122041320414204152041620417204182041920420204212042220423204242042520426204272042820429204302043120432204332043420435204362043720438204392044020441204422044320444204452044620447204482044920450204512045220453204542045520456204572045820459204602046120462204632046420465204662046720468204692047020471204722047320474204752047620477204782047920480204812048220483204842048520486204872048820489204902049120492204932049420495204962049720498204992050020501205022050320504205052050620507205082050920510205112051220513205142051520516205172051820519205202052120522205232052420525205262052720528205292053020531205322053320534205352053620537205382053920540205412054220543205442054520546205472054820549205502055120552205532055420555205562055720558205592056020561205622056320564205652056620567205682056920570205712057220573205742057520576205772057820579205802058120582205832058420585205862058720588205892059020591205922059320594205952059620597205982059920600206012060220603206042060520606206072060820609206102061120612206132061420615206162061720618206192062020621206222062320624206252062620627206282062920630206312063220633206342063520636206372063820639206402064120642206432064420645206462064720648206492065020651206522065320654206552065620657206582065920660206612066220663206642066520666206672066820669206702067120672206732067420675206762067720678206792068020681206822068320684206852068620687206882068920690206912069220693206942069520696206972069820699207002070120702207032070420705207062070720708207092071020711207122071320714207152071620717207182071920720207212072220723207242072520726207272072820729207302073120732207332073420735207362073720738207392074020741207422074320744207452074620747207482074920750207512075220753207542075520756207572075820759207602076120762207632076420765207662076720768207692077020771207722077320774207752077620777207782077920780207812078220783207842078520786207872078820789207902079120792207932079420795207962079720798207992080020801208022080320804208052080620807208082080920810208112081220813208142081520816208172081820819208202082120822208232082420825208262082720828208292083020831208322083320834208352083620837208382083920840208412084220843208442084520846208472084820849208502085120852208532085420855208562085720858208592086020861208622086320864208652086620867208682086920870208712087220873208742087520876208772087820879208802088120882208832088420885208862088720888208892089020891208922089320894208952089620897208982089920900209012090220903209042090520906209072090820909209102091120912209132091420915209162091720918209192092020921209222092320924209252092620927209282092920930209312093220933209342093520936209372093820939209402094120942209432094420945209462094720948209492095020951209522095320954209552095620957209582095920960209612096220963209642096520966209672096820969209702097120972209732097420975209762097720978209792098020981209822098320984209852098620987209882098920990209912099220993209942099520996209972099820999210002100121002210032100421005210062100721008210092101021011210122101321014210152101621017210182101921020210212102221023210242102521026210272102821029210302103121032210332103421035210362103721038210392104021041210422104321044210452104621047210482104921050210512105221053210542105521056210572105821059210602106121062210632106421065210662106721068210692107021071210722107321074210752107621077210782107921080210812108221083210842108521086210872108821089210902109121092210932109421095210962109721098210992110021101211022110321104211052110621107211082110921110211112111221113211142111521116211172111821119211202112121122211232112421125211262112721128211292113021131211322113321134211352113621137211382113921140211412114221143211442114521146211472114821149211502115121152211532115421155211562115721158211592116021161211622116321164211652116621167211682116921170211712117221173211742117521176211772117821179211802118121182211832118421185211862118721188211892119021191211922119321194211952119621197211982119921200212012120221203212042120521206212072120821209212102121121212212132121421215212162121721218212192122021221212222122321224212252122621227212282122921230212312123221233212342123521236212372123821239212402124121242212432124421245212462124721248212492125021251212522125321254212552125621257212582125921260212612126221263212642126521266212672126821269212702127121272212732127421275212762127721278212792128021281212822128321284212852128621287212882128921290212912129221293212942129521296212972129821299213002130121302213032130421305213062130721308213092131021311213122131321314213152131621317213182131921320213212132221323213242132521326213272132821329213302133121332213332133421335213362133721338213392134021341213422134321344213452134621347213482134921350213512135221353213542135521356213572135821359213602136121362213632136421365213662136721368213692137021371213722137321374213752137621377213782137921380213812138221383213842138521386213872138821389213902139121392213932139421395213962139721398213992140021401214022140321404214052140621407214082140921410214112141221413214142141521416214172141821419214202142121422214232142421425214262142721428214292143021431214322143321434214352143621437214382143921440214412144221443214442144521446214472144821449214502145121452214532145421455214562145721458214592146021461214622146321464214652146621467214682146921470214712147221473214742147521476214772147821479214802148121482214832148421485214862148721488214892149021491214922149321494214952149621497214982149921500215012150221503215042150521506215072150821509215102151121512215132151421515215162151721518215192152021521215222152321524215252152621527215282152921530215312153221533215342153521536215372153821539215402154121542215432154421545215462154721548215492155021551215522155321554215552155621557215582155921560215612156221563215642156521566215672156821569215702157121572215732157421575215762157721578215792158021581215822158321584215852158621587215882158921590215912159221593215942159521596215972159821599216002160121602216032160421605216062160721608216092161021611216122161321614216152161621617216182161921620216212162221623216242162521626216272162821629216302163121632216332163421635216362163721638216392164021641216422164321644216452164621647216482164921650216512165221653216542165521656216572165821659216602166121662216632166421665216662166721668216692167021671216722167321674216752167621677216782167921680216812168221683216842168521686216872168821689216902169121692216932169421695216962169721698216992170021701217022170321704217052170621707217082170921710217112171221713217142171521716217172171821719217202172121722217232172421725217262172721728217292173021731217322173321734217352173621737217382173921740217412174221743217442174521746217472174821749217502175121752217532175421755217562175721758217592176021761217622176321764217652176621767217682176921770217712177221773217742177521776217772177821779217802178121782217832178421785217862178721788217892179021791217922179321794217952179621797217982179921800218012180221803218042180521806218072180821809218102181121812218132181421815218162181721818218192182021821218222182321824218252182621827218282182921830218312183221833218342183521836218372183821839218402184121842218432184421845218462184721848218492185021851218522185321854218552185621857218582185921860218612186221863218642186521866218672186821869218702187121872218732187421875218762187721878218792188021881218822188321884218852188621887218882188921890218912189221893218942189521896218972189821899219002190121902219032190421905219062190721908219092191021911219122191321914219152191621917219182191921920219212192221923219242192521926219272192821929219302193121932219332193421935219362193721938219392194021941219422194321944219452194621947219482194921950219512195221953219542195521956219572195821959219602196121962219632196421965219662196721968219692197021971219722197321974219752197621977219782197921980219812198221983219842198521986219872198821989219902199121992219932199421995219962199721998219992200022001220022200322004220052200622007220082200922010220112201222013220142201522016220172201822019220202202122022220232202422025220262202722028220292203022031220322203322034220352203622037220382203922040220412204222043220442204522046220472204822049220502205122052220532205422055220562205722058220592206022061220622206322064220652206622067220682206922070220712207222073220742207522076220772207822079220802208122082220832208422085220862208722088220892209022091220922209322094220952209622097220982209922100221012210222103221042210522106221072210822109221102211122112221132211422115221162211722118221192212022121221222212322124221252212622127221282212922130221312213222133221342213522136221372213822139221402214122142221432214422145221462214722148221492215022151221522215322154221552215622157221582215922160221612216222163221642216522166221672216822169221702217122172221732217422175221762217722178221792218022181221822218322184221852218622187221882218922190221912219222193221942219522196221972219822199222002220122202222032220422205222062220722208222092221022211222122221322214222152221622217222182221922220222212222222223222242222522226222272222822229222302223122232222332223422235222362223722238222392224022241222422224322244222452224622247222482224922250222512225222253222542225522256222572225822259222602226122262222632226422265222662226722268222692227022271222722227322274222752227622277222782227922280222812228222283222842228522286222872228822289222902229122292222932229422295222962229722298222992230022301223022230322304223052230622307223082230922310223112231222313223142231522316223172231822319223202232122322223232232422325223262232722328223292233022331223322233322334223352233622337223382233922340223412234222343223442234522346223472234822349223502235122352223532235422355223562235722358223592236022361223622236322364223652236622367223682236922370223712237222373223742237522376223772237822379223802238122382223832238422385223862238722388223892239022391223922239322394223952239622397223982239922400224012240222403224042240522406224072240822409224102241122412224132241422415224162241722418224192242022421224222242322424224252242622427224282242922430224312243222433224342243522436224372243822439224402244122442224432244422445224462244722448224492245022451224522245322454224552245622457224582245922460224612246222463224642246522466224672246822469224702247122472224732247422475224762247722478224792248022481224822248322484224852248622487224882248922490224912249222493224942249522496224972249822499225002250122502225032250422505225062250722508225092251022511225122251322514225152251622517225182251922520225212252222523225242252522526225272252822529225302253122532225332253422535225362253722538225392254022541225422254322544225452254622547225482254922550225512255222553225542255522556225572255822559225602256122562225632256422565225662256722568225692257022571225722257322574225752257622577225782257922580225812258222583225842258522586225872258822589225902259122592225932259422595225962259722598225992260022601226022260322604226052260622607226082260922610226112261222613226142261522616226172261822619226202262122622226232262422625226262262722628226292263022631226322263322634226352263622637226382263922640226412264222643226442264522646226472264822649226502265122652226532265422655226562265722658226592266022661226622266322664226652266622667226682266922670226712267222673226742267522676226772267822679226802268122682226832268422685226862268722688226892269022691226922269322694226952269622697226982269922700227012270222703227042270522706227072270822709227102271122712227132271422715227162271722718227192272022721227222272322724227252272622727227282272922730227312273222733227342273522736227372273822739227402274122742227432274422745227462274722748227492275022751227522275322754227552275622757227582275922760227612276222763227642276522766227672276822769227702277122772227732277422775227762277722778227792278022781227822278322784227852278622787227882278922790227912279222793227942279522796227972279822799228002280122802228032280422805228062280722808228092281022811228122281322814228152281622817228182281922820228212282222823228242282522826228272282822829228302283122832228332283422835228362283722838228392284022841228422284322844228452284622847228482284922850228512285222853228542285522856228572285822859228602286122862228632286422865228662286722868228692287022871228722287322874228752287622877228782287922880228812288222883228842288522886228872288822889228902289122892228932289422895228962289722898228992290022901229022290322904229052290622907229082290922910229112291222913229142291522916229172291822919229202292122922229232292422925229262292722928229292293022931229322293322934229352293622937229382293922940229412294222943229442294522946229472294822949229502295122952229532295422955229562295722958229592296022961229622296322964229652296622967229682296922970229712297222973229742297522976229772297822979229802298122982229832298422985229862298722988229892299022991229922299322994229952299622997229982299923000230012300223003230042300523006230072300823009230102301123012230132301423015230162301723018230192302023021230222302323024230252302623027230282302923030230312303223033230342303523036230372303823039230402304123042230432304423045230462304723048230492305023051230522305323054230552305623057230582305923060230612306223063230642306523066230672306823069230702307123072230732307423075230762307723078230792308023081230822308323084230852308623087230882308923090230912309223093230942309523096230972309823099231002310123102231032310423105231062310723108231092311023111231122311323114231152311623117231182311923120231212312223123231242312523126231272312823129231302313123132231332313423135231362313723138231392314023141231422314323144231452314623147231482314923150231512315223153231542315523156231572315823159231602316123162231632316423165231662316723168231692317023171231722317323174231752317623177231782317923180231812318223183231842318523186231872318823189231902319123192231932319423195231962319723198231992320023201232022320323204232052320623207232082320923210232112321223213232142321523216232172321823219232202322123222232232322423225232262322723228232292323023231232322323323234232352323623237232382323923240232412324223243232442324523246232472324823249232502325123252232532325423255232562325723258232592326023261232622326323264232652326623267232682326923270232712327223273232742327523276232772327823279232802328123282232832328423285232862328723288232892329023291232922329323294232952329623297232982329923300233012330223303233042330523306233072330823309233102331123312233132331423315233162331723318233192332023321233222332323324233252332623327233282332923330233312333223333233342333523336233372333823339233402334123342233432334423345233462334723348233492335023351233522335323354233552335623357233582335923360233612336223363233642336523366233672336823369233702337123372233732337423375233762337723378233792338023381233822338323384233852338623387233882338923390233912339223393233942339523396233972339823399234002340123402234032340423405234062340723408234092341023411234122341323414234152341623417234182341923420234212342223423234242342523426234272342823429234302343123432234332343423435234362343723438234392344023441234422344323444234452344623447234482344923450234512345223453234542345523456234572345823459234602346123462234632346423465234662346723468234692347023471234722347323474234752347623477234782347923480234812348223483234842348523486234872348823489234902349123492234932349423495234962349723498234992350023501235022350323504235052350623507235082350923510235112351223513235142351523516235172351823519235202352123522235232352423525235262352723528235292353023531235322353323534235352353623537235382353923540235412354223543235442354523546235472354823549235502355123552235532355423555235562355723558235592356023561235622356323564235652356623567235682356923570235712357223573235742357523576235772357823579235802358123582235832358423585235862358723588235892359023591235922359323594235952359623597235982359923600236012360223603236042360523606236072360823609236102361123612236132361423615236162361723618236192362023621236222362323624236252362623627236282362923630236312363223633236342363523636236372363823639236402364123642236432364423645236462364723648236492365023651236522365323654236552365623657236582365923660236612366223663236642366523666236672366823669236702367123672236732367423675236762367723678236792368023681236822368323684236852368623687236882368923690236912369223693236942369523696236972369823699237002370123702237032370423705237062370723708237092371023711237122371323714237152371623717237182371923720237212372223723237242372523726237272372823729237302373123732237332373423735237362373723738237392374023741237422374323744237452374623747237482374923750237512375223753237542375523756237572375823759237602376123762237632376423765237662376723768237692377023771237722377323774237752377623777237782377923780237812378223783237842378523786237872378823789237902379123792237932379423795237962379723798237992380023801238022380323804238052380623807238082380923810238112381223813238142381523816238172381823819238202382123822238232382423825238262382723828238292383023831238322383323834238352383623837238382383923840238412384223843238442384523846238472384823849238502385123852238532385423855238562385723858238592386023861238622386323864238652386623867238682386923870238712387223873238742387523876238772387823879238802388123882238832388423885238862388723888238892389023891238922389323894238952389623897238982389923900239012390223903239042390523906239072390823909239102391123912239132391423915239162391723918239192392023921239222392323924239252392623927239282392923930239312393223933239342393523936239372393823939239402394123942239432394423945239462394723948239492395023951239522395323954239552395623957239582395923960239612396223963239642396523966239672396823969239702397123972239732397423975239762397723978239792398023981239822398323984239852398623987239882398923990239912399223993239942399523996239972399823999240002400124002240032400424005240062400724008240092401024011240122401324014240152401624017240182401924020240212402224023240242402524026240272402824029240302403124032240332403424035240362403724038240392404024041240422404324044240452404624047240482404924050240512405224053240542405524056240572405824059240602406124062240632406424065240662406724068240692407024071240722407324074240752407624077240782407924080240812408224083240842408524086240872408824089240902409124092240932409424095240962409724098240992410024101241022410324104241052410624107241082410924110241112411224113241142411524116241172411824119241202412124122241232412424125241262412724128241292413024131241322413324134241352413624137241382413924140241412414224143241442414524146241472414824149241502415124152241532415424155241562415724158241592416024161241622416324164241652416624167241682416924170241712417224173241742417524176241772417824179241802418124182241832418424185241862418724188241892419024191241922419324194241952419624197241982419924200242012420224203242042420524206242072420824209242102421124212242132421424215242162421724218242192422024221242222422324224242252422624227242282422924230242312423224233242342423524236242372423824239242402424124242242432424424245242462424724248242492425024251242522425324254242552425624257242582425924260242612426224263242642426524266242672426824269242702427124272242732427424275242762427724278242792428024281242822428324284242852428624287242882428924290242912429224293242942429524296242972429824299243002430124302243032430424305243062430724308243092431024311243122431324314243152431624317243182431924320243212432224323243242432524326243272432824329243302433124332243332433424335243362433724338243392434024341243422434324344243452434624347243482434924350243512435224353243542435524356243572435824359243602436124362243632436424365243662436724368243692437024371243722437324374243752437624377243782437924380243812438224383243842438524386243872438824389243902439124392243932439424395243962439724398243992440024401244022440324404244052440624407244082440924410244112441224413244142441524416244172441824419244202442124422244232442424425244262442724428244292443024431244322443324434244352443624437244382443924440244412444224443244442444524446244472444824449244502445124452244532445424455244562445724458244592446024461244622446324464244652446624467244682446924470244712447224473244742447524476244772447824479244802448124482244832448424485244862448724488244892449024491244922449324494244952449624497244982449924500245012450224503245042450524506245072450824509245102451124512245132451424515245162451724518245192452024521245222452324524245252452624527245282452924530245312453224533245342453524536245372453824539245402454124542245432454424545245462454724548245492455024551245522455324554245552455624557245582455924560245612456224563245642456524566245672456824569245702457124572245732457424575245762457724578245792458024581245822458324584245852458624587245882458924590245912459224593245942459524596245972459824599246002460124602246032460424605246062460724608246092461024611246122461324614246152461624617246182461924620246212462224623246242462524626246272462824629246302463124632246332463424635246362463724638246392464024641246422464324644246452464624647246482464924650246512465224653246542465524656246572465824659246602466124662246632466424665246662466724668246692467024671246722467324674246752467624677246782467924680246812468224683246842468524686246872468824689246902469124692246932469424695246962469724698246992470024701247022470324704247052470624707247082470924710247112471224713247142471524716247172471824719247202472124722247232472424725247262472724728247292473024731247322473324734247352473624737247382473924740247412474224743247442474524746247472474824749247502475124752247532475424755247562475724758247592476024761247622476324764247652476624767247682476924770247712477224773247742477524776247772477824779247802478124782247832478424785247862478724788247892479024791247922479324794247952479624797247982479924800248012480224803248042480524806248072480824809248102481124812248132481424815248162481724818248192482024821248222482324824248252482624827248282482924830248312483224833248342483524836248372483824839248402484124842248432484424845248462484724848248492485024851248522485324854248552485624857248582485924860248612486224863248642486524866248672486824869248702487124872248732487424875248762487724878248792488024881248822488324884248852488624887248882488924890248912489224893248942489524896248972489824899249002490124902249032490424905249062490724908249092491024911249122491324914249152491624917249182491924920249212492224923249242492524926249272492824929249302493124932249332493424935249362493724938249392494024941249422494324944249452494624947249482494924950249512495224953249542495524956249572495824959249602496124962249632496424965249662496724968249692497024971249722497324974249752497624977249782497924980249812498224983249842498524986249872498824989249902499124992249932499424995249962499724998249992500025001250022500325004250052500625007250082500925010250112501225013250142501525016250172501825019250202502125022250232502425025250262502725028250292503025031250322503325034250352503625037250382503925040250412504225043250442504525046250472504825049250502505125052250532505425055250562505725058250592506025061250622506325064250652506625067250682506925070250712507225073250742507525076250772507825079250802508125082250832508425085250862508725088250892509025091250922509325094250952509625097250982509925100251012510225103251042510525106251072510825109251102511125112251132511425115251162511725118251192512025121251222512325124251252512625127251282512925130251312513225133251342513525136251372513825139251402514125142251432514425145251462514725148251492515025151251522515325154251552515625157251582515925160251612516225163251642516525166251672516825169251702517125172251732517425175251762517725178251792518025181251822518325184251852518625187251882518925190251912519225193251942519525196251972519825199252002520125202252032520425205252062520725208252092521025211252122521325214252152521625217252182521925220252212522225223252242522525226252272522825229252302523125232252332523425235252362523725238252392524025241252422524325244252452524625247252482524925250252512525225253252542525525256252572525825259252602526125262252632526425265252662526725268252692527025271252722527325274252752527625277252782527925280252812528225283252842528525286252872528825289252902529125292252932529425295252962529725298252992530025301253022530325304253052530625307253082530925310253112531225313253142531525316253172531825319253202532125322253232532425325253262532725328253292533025331253322533325334253352533625337253382533925340253412534225343253442534525346253472534825349253502535125352253532535425355253562535725358253592536025361253622536325364253652536625367253682536925370253712537225373253742537525376253772537825379253802538125382253832538425385253862538725388253892539025391253922539325394253952539625397253982539925400254012540225403254042540525406254072540825409254102541125412254132541425415254162541725418254192542025421254222542325424254252542625427254282542925430254312543225433254342543525436254372543825439254402544125442254432544425445254462544725448254492545025451254522545325454254552545625457254582545925460254612546225463254642546525466254672546825469254702547125472254732547425475254762547725478254792548025481254822548325484254852548625487254882548925490254912549225493254942549525496254972549825499255002550125502255032550425505255062550725508255092551025511255122551325514255152551625517255182551925520255212552225523255242552525526255272552825529255302553125532255332553425535255362553725538255392554025541255422554325544255452554625547255482554925550255512555225553255542555525556255572555825559255602556125562255632556425565255662556725568255692557025571255722557325574255752557625577255782557925580255812558225583255842558525586255872558825589255902559125592255932559425595255962559725598255992560025601256022560325604256052560625607256082560925610256112561225613256142561525616256172561825619256202562125622256232562425625256262562725628256292563025631256322563325634256352563625637256382563925640256412564225643256442564525646256472564825649256502565125652256532565425655256562565725658256592566025661256622566325664256652566625667256682566925670256712567225673256742567525676256772567825679256802568125682256832568425685256862568725688256892569025691256922569325694256952569625697256982569925700257012570225703257042570525706257072570825709257102571125712257132571425715257162571725718257192572025721257222572325724257252572625727257282572925730257312573225733257342573525736257372573825739257402574125742257432574425745257462574725748257492575025751257522575325754257552575625757257582575925760257612576225763257642576525766257672576825769257702577125772257732577425775257762577725778257792578025781257822578325784257852578625787257882578925790257912579225793257942579525796257972579825799258002580125802258032580425805258062580725808258092581025811258122581325814258152581625817258182581925820258212582225823258242582525826258272582825829258302583125832258332583425835258362583725838258392584025841258422584325844258452584625847258482584925850258512585225853258542585525856258572585825859258602586125862258632586425865258662586725868258692587025871258722587325874258752587625877258782587925880258812588225883258842588525886258872588825889258902589125892258932589425895258962589725898258992590025901259022590325904259052590625907259082590925910259112591225913259142591525916259172591825919259202592125922259232592425925259262592725928259292593025931259322593325934259352593625937259382593925940259412594225943259442594525946259472594825949259502595125952259532595425955259562595725958259592596025961259622596325964259652596625967259682596925970259712597225973259742597525976259772597825979259802598125982259832598425985259862598725988259892599025991259922599325994259952599625997259982599926000260012600226003260042600526006260072600826009260102601126012260132601426015260162601726018260192602026021260222602326024260252602626027260282602926030260312603226033260342603526036260372603826039260402604126042260432604426045260462604726048260492605026051260522605326054260552605626057260582605926060260612606226063260642606526066260672606826069260702607126072260732607426075260762607726078260792608026081260822608326084260852608626087260882608926090260912609226093260942609526096260972609826099261002610126102261032610426105261062610726108261092611026111261122611326114261152611626117261182611926120261212612226123261242612526126261272612826129261302613126132261332613426135261362613726138261392614026141261422614326144261452614626147261482614926150261512615226153261542615526156261572615826159261602616126162261632616426165261662616726168261692617026171261722617326174261752617626177261782617926180261812618226183261842618526186261872618826189261902619126192261932619426195261962619726198261992620026201262022620326204262052620626207262082620926210262112621226213262142621526216262172621826219262202622126222262232622426225262262622726228262292623026231262322623326234262352623626237262382623926240262412624226243262442624526246262472624826249262502625126252262532625426255262562625726258262592626026261262622626326264262652626626267262682626926270262712627226273262742627526276262772627826279262802628126282262832628426285262862628726288262892629026291262922629326294262952629626297262982629926300263012630226303263042630526306263072630826309263102631126312263132631426315263162631726318263192632026321263222632326324263252632626327263282632926330263312633226333263342633526336263372633826339263402634126342263432634426345263462634726348263492635026351263522635326354263552635626357263582635926360263612636226363263642636526366263672636826369263702637126372263732637426375263762637726378263792638026381263822638326384263852638626387263882638926390263912639226393263942639526396263972639826399264002640126402264032640426405264062640726408264092641026411264122641326414264152641626417264182641926420264212642226423264242642526426264272642826429264302643126432264332643426435264362643726438264392644026441264422644326444264452644626447264482644926450264512645226453264542645526456264572645826459264602646126462264632646426465264662646726468264692647026471264722647326474264752647626477264782647926480264812648226483264842648526486264872648826489264902649126492264932649426495264962649726498264992650026501265022650326504265052650626507265082650926510265112651226513265142651526516265172651826519265202652126522265232652426525265262652726528265292653026531265322653326534265352653626537265382653926540265412654226543265442654526546265472654826549265502655126552265532655426555265562655726558265592656026561265622656326564265652656626567265682656926570265712657226573265742657526576265772657826579265802658126582265832658426585265862658726588265892659026591265922659326594265952659626597265982659926600266012660226603266042660526606266072660826609266102661126612266132661426615266162661726618266192662026621266222662326624266252662626627266282662926630266312663226633266342663526636266372663826639266402664126642266432664426645266462664726648266492665026651266522665326654266552665626657266582665926660266612666226663266642666526666266672666826669266702667126672266732667426675266762667726678266792668026681266822668326684266852668626687266882668926690266912669226693266942669526696266972669826699267002670126702267032670426705267062670726708267092671026711267122671326714267152671626717267182671926720267212672226723267242672526726267272672826729267302673126732267332673426735267362673726738267392674026741267422674326744267452674626747267482674926750267512675226753267542675526756267572675826759267602676126762267632676426765267662676726768267692677026771267722677326774267752677626777267782677926780267812678226783267842678526786267872678826789267902679126792267932679426795267962679726798267992680026801268022680326804268052680626807268082680926810268112681226813268142681526816268172681826819268202682126822268232682426825268262682726828268292683026831268322683326834268352683626837268382683926840268412684226843268442684526846268472684826849268502685126852268532685426855268562685726858268592686026861268622686326864268652686626867268682686926870268712687226873268742687526876268772687826879268802688126882268832688426885268862688726888268892689026891268922689326894268952689626897268982689926900269012690226903269042690526906269072690826909269102691126912269132691426915269162691726918269192692026921269222692326924269252692626927269282692926930269312693226933269342693526936269372693826939269402694126942269432694426945269462694726948269492695026951269522695326954269552695626957269582695926960269612696226963269642696526966269672696826969269702697126972269732697426975269762697726978269792698026981269822698326984269852698626987269882698926990269912699226993269942699526996269972699826999270002700127002270032700427005270062700727008270092701027011270122701327014270152701627017270182701927020270212702227023270242702527026270272702827029270302703127032270332703427035270362703727038270392704027041270422704327044270452704627047270482704927050270512705227053270542705527056270572705827059270602706127062270632706427065270662706727068270692707027071270722707327074270752707627077270782707927080270812708227083270842708527086270872708827089270902709127092270932709427095270962709727098270992710027101271022710327104271052710627107271082710927110271112711227113271142711527116271172711827119271202712127122271232712427125271262712727128271292713027131271322713327134271352713627137271382713927140271412714227143271442714527146271472714827149271502715127152271532715427155271562715727158271592716027161271622716327164271652716627167271682716927170271712717227173271742717527176271772717827179271802718127182271832718427185271862718727188271892719027191271922719327194271952719627197271982719927200272012720227203272042720527206272072720827209272102721127212272132721427215272162721727218272192722027221272222722327224272252722627227272282722927230272312723227233272342723527236272372723827239272402724127242272432724427245272462724727248272492725027251272522725327254272552725627257272582725927260272612726227263272642726527266272672726827269272702727127272272732727427275272762727727278272792728027281272822728327284272852728627287272882728927290272912729227293272942729527296272972729827299273002730127302273032730427305273062730727308273092731027311273122731327314273152731627317273182731927320273212732227323273242732527326273272732827329273302733127332273332733427335273362733727338273392734027341273422734327344273452734627347273482734927350273512735227353273542735527356273572735827359273602736127362273632736427365273662736727368273692737027371273722737327374273752737627377273782737927380273812738227383273842738527386273872738827389273902739127392273932739427395273962739727398273992740027401274022740327404274052740627407274082740927410274112741227413274142741527416274172741827419274202742127422274232742427425274262742727428274292743027431274322743327434274352743627437274382743927440274412744227443274442744527446274472744827449274502745127452274532745427455274562745727458274592746027461274622746327464274652746627467274682746927470274712747227473274742747527476274772747827479274802748127482274832748427485274862748727488274892749027491274922749327494274952749627497274982749927500275012750227503275042750527506275072750827509275102751127512275132751427515275162751727518275192752027521275222752327524275252752627527275282752927530275312753227533275342753527536275372753827539275402754127542275432754427545275462754727548275492755027551275522755327554275552755627557275582755927560275612756227563275642756527566275672756827569275702757127572275732757427575275762757727578275792758027581275822758327584275852758627587275882758927590275912759227593275942759527596275972759827599276002760127602276032760427605276062760727608276092761027611276122761327614276152761627617276182761927620276212762227623276242762527626276272762827629276302763127632276332763427635276362763727638276392764027641276422764327644276452764627647276482764927650276512765227653276542765527656276572765827659276602766127662276632766427665276662766727668276692767027671276722767327674276752767627677276782767927680276812768227683276842768527686276872768827689276902769127692276932769427695276962769727698276992770027701277022770327704277052770627707277082770927710277112771227713277142771527716277172771827719277202772127722277232772427725277262772727728277292773027731277322773327734277352773627737277382773927740277412774227743277442774527746277472774827749277502775127752277532775427755277562775727758277592776027761277622776327764277652776627767277682776927770277712777227773277742777527776277772777827779277802778127782277832778427785277862778727788277892779027791277922779327794277952779627797277982779927800278012780227803278042780527806278072780827809278102781127812278132781427815278162781727818278192782027821278222782327824278252782627827278282782927830278312783227833278342783527836278372783827839278402784127842278432784427845278462784727848278492785027851278522785327854278552785627857278582785927860278612786227863278642786527866278672786827869278702787127872278732787427875278762787727878278792788027881278822788327884278852788627887278882788927890278912789227893278942789527896278972789827899279002790127902279032790427905279062790727908279092791027911279122791327914279152791627917279182791927920279212792227923279242792527926279272792827929279302793127932279332793427935279362793727938279392794027941279422794327944279452794627947279482794927950279512795227953279542795527956279572795827959279602796127962279632796427965279662796727968279692797027971279722797327974279752797627977279782797927980279812798227983279842798527986279872798827989279902799127992279932799427995279962799727998279992800028001280022800328004280052800628007280082800928010280112801228013280142801528016280172801828019280202802128022280232802428025280262802728028280292803028031280322803328034280352803628037280382803928040280412804228043280442804528046280472804828049280502805128052280532805428055280562805728058280592806028061280622806328064280652806628067280682806928070280712807228073280742807528076280772807828079280802808128082280832808428085280862808728088280892809028091280922809328094280952809628097280982809928100281012810228103281042810528106281072810828109281102811128112281132811428115281162811728118281192812028121281222812328124281252812628127281282812928130281312813228133281342813528136281372813828139281402814128142281432814428145281462814728148281492815028151281522815328154281552815628157281582815928160281612816228163281642816528166281672816828169281702817128172281732817428175281762817728178281792818028181281822818328184281852818628187281882818928190281912819228193281942819528196281972819828199282002820128202282032820428205282062820728208282092821028211282122821328214282152821628217282182821928220282212822228223282242822528226282272822828229282302823128232282332823428235282362823728238282392824028241282422824328244282452824628247282482824928250282512825228253282542825528256282572825828259282602826128262282632826428265282662826728268282692827028271282722827328274282752827628277282782827928280282812828228283282842828528286282872828828289282902829128292282932829428295282962829728298282992830028301283022830328304283052830628307283082830928310283112831228313283142831528316283172831828319283202832128322283232832428325283262832728328283292833028331283322833328334283352833628337283382833928340283412834228343283442834528346283472834828349283502835128352283532835428355283562835728358283592836028361283622836328364283652836628367283682836928370283712837228373283742837528376283772837828379283802838128382283832838428385283862838728388283892839028391283922839328394283952839628397283982839928400284012840228403284042840528406284072840828409284102841128412284132841428415284162841728418284192842028421284222842328424284252842628427284282842928430284312843228433284342843528436284372843828439284402844128442284432844428445284462844728448284492845028451284522845328454284552845628457284582845928460284612846228463284642846528466284672846828469284702847128472284732847428475284762847728478284792848028481284822848328484284852848628487284882848928490284912849228493284942849528496284972849828499285002850128502285032850428505285062850728508285092851028511285122851328514285152851628517285182851928520285212852228523285242852528526285272852828529285302853128532285332853428535285362853728538285392854028541285422854328544285452854628547285482854928550285512855228553285542855528556285572855828559285602856128562285632856428565285662856728568285692857028571285722857328574285752857628577285782857928580285812858228583285842858528586285872858828589285902859128592285932859428595285962859728598285992860028601286022860328604286052860628607286082860928610286112861228613286142861528616286172861828619286202862128622286232862428625286262862728628286292863028631286322863328634286352863628637286382863928640286412864228643286442864528646286472864828649286502865128652286532865428655286562865728658286592866028661286622866328664286652866628667286682866928670286712867228673286742867528676286772867828679286802868128682286832868428685286862868728688286892869028691286922869328694286952869628697286982869928700287012870228703287042870528706287072870828709287102871128712287132871428715287162871728718287192872028721287222872328724287252872628727287282872928730287312873228733287342873528736287372873828739287402874128742287432874428745287462874728748287492875028751287522875328754287552875628757287582875928760287612876228763287642876528766287672876828769287702877128772287732877428775287762877728778287792878028781287822878328784287852878628787287882878928790287912879228793287942879528796287972879828799288002880128802288032880428805288062880728808288092881028811288122881328814288152881628817288182881928820288212882228823288242882528826288272882828829288302883128832288332883428835288362883728838288392884028841288422884328844288452884628847288482884928850288512885228853288542885528856288572885828859288602886128862288632886428865288662886728868288692887028871288722887328874288752887628877288782887928880288812888228883288842888528886288872888828889288902889128892288932889428895288962889728898288992890028901289022890328904289052890628907289082890928910289112891228913289142891528916289172891828919289202892128922289232892428925289262892728928289292893028931289322893328934289352893628937289382893928940289412894228943289442894528946289472894828949289502895128952289532895428955289562895728958289592896028961289622896328964289652896628967289682896928970289712897228973289742897528976289772897828979289802898128982289832898428985289862898728988289892899028991289922899328994289952899628997289982899929000290012900229003290042900529006290072900829009290102901129012290132901429015290162901729018290192902029021290222902329024290252902629027290282902929030290312903229033290342903529036290372903829039290402904129042290432904429045290462904729048290492905029051290522905329054290552905629057290582905929060290612906229063290642906529066290672906829069290702907129072290732907429075290762907729078290792908029081290822908329084290852908629087290882908929090290912909229093290942909529096290972909829099291002910129102291032910429105291062910729108291092911029111291122911329114291152911629117291182911929120291212912229123291242912529126291272912829129291302913129132291332913429135291362913729138291392914029141291422914329144291452914629147291482914929150291512915229153291542915529156291572915829159291602916129162291632916429165291662916729168291692917029171291722917329174291752917629177291782917929180291812918229183291842918529186291872918829189291902919129192291932919429195291962919729198291992920029201292022920329204292052920629207292082920929210292112921229213292142921529216292172921829219292202922129222292232922429225292262922729228292292923029231292322923329234292352923629237292382923929240292412924229243292442924529246292472924829249292502925129252292532925429255292562925729258292592926029261292622926329264292652926629267292682926929270292712927229273292742927529276292772927829279292802928129282292832928429285292862928729288292892929029291292922929329294292952929629297292982929929300293012930229303293042930529306293072930829309293102931129312293132931429315293162931729318293192932029321293222932329324293252932629327293282932929330293312933229333293342933529336293372933829339293402934129342293432934429345293462934729348293492935029351293522935329354293552935629357293582935929360293612936229363293642936529366293672936829369293702937129372293732937429375293762937729378293792938029381293822938329384293852938629387293882938929390293912939229393293942939529396293972939829399294002940129402294032940429405294062940729408294092941029411294122941329414294152941629417294182941929420294212942229423294242942529426294272942829429294302943129432294332943429435294362943729438294392944029441294422944329444294452944629447294482944929450294512945229453294542945529456294572945829459294602946129462294632946429465294662946729468294692947029471294722947329474294752947629477294782947929480294812948229483294842948529486294872948829489294902949129492294932949429495294962949729498294992950029501295022950329504295052950629507295082950929510295112951229513295142951529516295172951829519295202952129522295232952429525295262952729528295292953029531295322953329534295352953629537295382953929540295412954229543295442954529546295472954829549295502955129552295532955429555295562955729558295592956029561295622956329564295652956629567295682956929570295712957229573295742957529576295772957829579295802958129582295832958429585295862958729588295892959029591295922959329594295952959629597295982959929600296012960229603296042960529606296072960829609296102961129612296132961429615296162961729618296192962029621296222962329624296252962629627296282962929630296312963229633296342963529636296372963829639296402964129642296432964429645296462964729648296492965029651296522965329654296552965629657296582965929660296612966229663296642966529666296672966829669296702967129672296732967429675296762967729678296792968029681296822968329684296852968629687296882968929690296912969229693296942969529696296972969829699297002970129702297032970429705297062970729708297092971029711297122971329714297152971629717297182971929720297212972229723297242972529726297272972829729297302973129732297332973429735297362973729738297392974029741297422974329744297452974629747297482974929750297512975229753297542975529756297572975829759297602976129762297632976429765297662976729768297692977029771297722977329774297752977629777297782977929780297812978229783297842978529786297872978829789297902979129792297932979429795297962979729798297992980029801298022980329804298052980629807298082980929810298112981229813298142981529816298172981829819298202982129822298232982429825298262982729828298292983029831298322983329834298352983629837298382983929840298412984229843298442984529846298472984829849298502985129852298532985429855298562985729858298592986029861298622986329864298652986629867298682986929870298712987229873298742987529876298772987829879298802988129882298832988429885298862988729888298892989029891298922989329894298952989629897298982989929900299012990229903299042990529906299072990829909299102991129912299132991429915299162991729918299192992029921299222992329924299252992629927299282992929930299312993229933299342993529936299372993829939299402994129942299432994429945299462994729948299492995029951299522995329954299552995629957299582995929960299612996229963299642996529966299672996829969299702997129972299732997429975299762997729978299792998029981299822998329984299852998629987299882998929990299912999229993299942999529996299972999829999300003000130002300033000430005300063000730008300093001030011300123001330014300153001630017300183001930020300213002230023300243002530026300273002830029300303003130032300333003430035300363003730038300393004030041300423004330044300453004630047300483004930050300513005230053300543005530056300573005830059300603006130062300633006430065300663006730068300693007030071300723007330074300753007630077300783007930080300813008230083300843008530086300873008830089300903009130092300933009430095300963009730098300993010030101301023010330104301053010630107301083010930110301113011230113301143011530116301173011830119301203012130122301233012430125301263012730128301293013030131301323013330134301353013630137301383013930140301413014230143301443014530146301473014830149301503015130152301533015430155301563015730158301593016030161301623016330164301653016630167301683016930170301713017230173301743017530176301773017830179301803018130182301833018430185301863018730188301893019030191301923019330194301953019630197301983019930200302013020230203302043020530206302073020830209302103021130212302133021430215302163021730218302193022030221302223022330224302253022630227302283022930230302313023230233302343023530236302373023830239302403024130242302433024430245302463024730248302493025030251302523025330254302553025630257302583025930260302613026230263302643026530266302673026830269302703027130272302733027430275302763027730278302793028030281302823028330284302853028630287302883028930290302913029230293302943029530296302973029830299303003030130302303033030430305303063030730308303093031030311303123031330314303153031630317303183031930320303213032230323303243032530326303273032830329303303033130332303333033430335303363033730338303393034030341303423034330344303453034630347303483034930350303513035230353303543035530356303573035830359303603036130362303633036430365303663036730368303693037030371303723037330374303753037630377303783037930380303813038230383303843038530386303873038830389303903039130392303933039430395303963039730398303993040030401304023040330404304053040630407304083040930410304113041230413304143041530416304173041830419304203042130422304233042430425304263042730428304293043030431304323043330434304353043630437304383043930440304413044230443304443044530446304473044830449304503045130452304533045430455304563045730458304593046030461304623046330464304653046630467304683046930470304713047230473304743047530476304773047830479304803048130482304833048430485304863048730488304893049030491304923049330494304953049630497304983049930500305013050230503305043050530506305073050830509305103051130512305133051430515305163051730518305193052030521305223052330524305253052630527305283052930530305313053230533305343053530536305373053830539305403054130542305433054430545305463054730548305493055030551305523055330554305553055630557305583055930560305613056230563305643056530566305673056830569305703057130572305733057430575305763057730578305793058030581305823058330584305853058630587305883058930590305913059230593305943059530596305973059830599306003060130602306033060430605306063060730608306093061030611306123061330614306153061630617306183061930620306213062230623306243062530626306273062830629306303063130632306333063430635306363063730638306393064030641306423064330644306453064630647306483064930650306513065230653306543065530656306573065830659306603066130662306633066430665306663066730668306693067030671306723067330674306753067630677306783067930680306813068230683306843068530686306873068830689306903069130692306933069430695306963069730698306993070030701307023070330704307053070630707307083070930710307113071230713307143071530716307173071830719307203072130722307233072430725307263072730728307293073030731307323073330734307353073630737307383073930740307413074230743307443074530746307473074830749307503075130752307533075430755307563075730758307593076030761307623076330764307653076630767307683076930770307713077230773307743077530776307773077830779307803078130782307833078430785307863078730788307893079030791307923079330794307953079630797307983079930800308013080230803308043080530806308073080830809308103081130812308133081430815308163081730818308193082030821308223082330824308253082630827308283082930830308313083230833308343083530836308373083830839308403084130842308433084430845308463084730848308493085030851308523085330854308553085630857308583085930860308613086230863308643086530866308673086830869308703087130872308733087430875308763087730878308793088030881308823088330884308853088630887308883088930890308913089230893308943089530896308973089830899309003090130902309033090430905309063090730908309093091030911309123091330914309153091630917309183091930920309213092230923309243092530926309273092830929309303093130932309333093430935309363093730938309393094030941309423094330944309453094630947309483094930950309513095230953309543095530956309573095830959309603096130962309633096430965309663096730968309693097030971309723097330974309753097630977309783097930980309813098230983309843098530986309873098830989309903099130992309933099430995309963099730998309993100031001310023100331004310053100631007310083100931010310113101231013310143101531016310173101831019310203102131022310233102431025310263102731028310293103031031310323103331034310353103631037310383103931040310413104231043310443104531046310473104831049310503105131052310533105431055310563105731058310593106031061310623106331064310653106631067310683106931070310713107231073310743107531076310773107831079310803108131082310833108431085310863108731088310893109031091310923109331094310953109631097310983109931100311013110231103311043110531106311073110831109311103111131112311133111431115311163111731118311193112031121311223112331124311253112631127311283112931130311313113231133311343113531136311373113831139311403114131142311433114431145311463114731148311493115031151311523115331154311553115631157311583115931160311613116231163311643116531166311673116831169311703117131172311733117431175311763117731178311793118031181311823118331184311853118631187311883118931190311913119231193311943119531196311973119831199312003120131202312033120431205312063120731208312093121031211312123121331214312153121631217312183121931220312213122231223312243122531226312273122831229312303123131232312333123431235312363123731238312393124031241312423124331244312453124631247312483124931250312513125231253312543125531256312573125831259312603126131262312633126431265312663126731268312693127031271312723127331274312753127631277312783127931280312813128231283312843128531286312873128831289312903129131292312933129431295312963129731298312993130031301313023130331304313053130631307313083130931310313113131231313313143131531316313173131831319313203132131322313233132431325313263132731328313293133031331313323133331334313353133631337313383133931340313413134231343313443134531346313473134831349313503135131352313533135431355313563135731358313593136031361313623136331364313653136631367313683136931370313713137231373313743137531376313773137831379313803138131382313833138431385313863138731388313893139031391313923139331394313953139631397313983139931400314013140231403314043140531406314073140831409314103141131412314133141431415314163141731418314193142031421314223142331424314253142631427314283142931430314313143231433314343143531436314373143831439314403144131442314433144431445314463144731448314493145031451314523145331454314553145631457314583145931460314613146231463314643146531466314673146831469314703147131472314733147431475314763147731478314793148031481314823148331484314853148631487314883148931490314913149231493314943149531496314973149831499315003150131502315033150431505315063150731508315093151031511315123151331514315153151631517315183151931520315213152231523315243152531526315273152831529315303153131532315333153431535315363153731538315393154031541315423154331544315453154631547315483154931550315513155231553315543155531556315573155831559315603156131562315633156431565315663156731568315693157031571315723157331574315753157631577315783157931580315813158231583315843158531586315873158831589315903159131592315933159431595315963159731598315993160031601316023160331604316053160631607316083160931610316113161231613316143161531616316173161831619316203162131622316233162431625316263162731628316293163031631316323163331634316353163631637316383163931640316413164231643316443164531646316473164831649316503165131652316533165431655316563165731658316593166031661316623166331664316653166631667316683166931670316713167231673316743167531676316773167831679316803168131682316833168431685316863168731688316893169031691316923169331694316953169631697316983169931700317013170231703317043170531706317073170831709317103171131712317133171431715317163171731718317193172031721317223172331724317253172631727317283172931730317313173231733317343173531736317373173831739317403174131742317433174431745317463174731748317493175031751317523175331754317553175631757317583175931760317613176231763317643176531766317673176831769317703177131772317733177431775317763177731778317793178031781317823178331784317853178631787317883178931790317913179231793317943179531796317973179831799318003180131802318033180431805318063180731808318093181031811318123181331814318153181631817318183181931820318213182231823318243182531826318273182831829318303183131832318333183431835318363183731838318393184031841318423184331844318453184631847318483184931850318513185231853318543185531856318573185831859318603186131862318633186431865318663186731868318693187031871318723187331874318753187631877318783187931880318813188231883318843188531886318873188831889318903189131892318933189431895318963189731898318993190031901319023190331904319053190631907319083190931910319113191231913319143191531916319173191831919319203192131922319233192431925319263192731928319293193031931319323193331934319353193631937319383193931940319413194231943319443194531946319473194831949319503195131952319533195431955319563195731958319593196031961319623196331964319653196631967319683196931970319713197231973319743197531976319773197831979319803198131982319833198431985319863198731988319893199031991319923199331994319953199631997319983199932000320013200232003320043200532006320073200832009320103201132012320133201432015320163201732018320193202032021320223202332024320253202632027320283202932030320313203232033320343203532036320373203832039320403204132042320433204432045320463204732048320493205032051320523205332054320553205632057320583205932060320613206232063320643206532066320673206832069320703207132072320733207432075320763207732078320793208032081320823208332084320853208632087320883208932090320913209232093320943209532096320973209832099321003210132102321033210432105321063210732108321093211032111321123211332114321153211632117321183211932120321213212232123321243212532126321273212832129321303213132132321333213432135321363213732138321393214032141321423214332144321453214632147321483214932150321513215232153321543215532156321573215832159321603216132162321633216432165321663216732168321693217032171321723217332174321753217632177321783217932180321813218232183321843218532186321873218832189321903219132192321933219432195321963219732198321993220032201322023220332204322053220632207322083220932210322113221232213322143221532216322173221832219322203222132222322233222432225322263222732228322293223032231322323223332234322353223632237322383223932240322413224232243322443224532246322473224832249322503225132252322533225432255322563225732258322593226032261322623226332264322653226632267322683226932270322713227232273322743227532276322773227832279322803228132282322833228432285322863228732288322893229032291322923229332294322953229632297322983229932300323013230232303323043230532306323073230832309323103231132312323133231432315323163231732318323193232032321323223232332324323253232632327323283232932330323313233232333323343233532336323373233832339323403234132342323433234432345323463234732348323493235032351323523235332354323553235632357323583235932360323613236232363323643236532366323673236832369323703237132372323733237432375323763237732378323793238032381323823238332384323853238632387323883238932390323913239232393323943239532396323973239832399324003240132402324033240432405324063240732408324093241032411324123241332414324153241632417324183241932420324213242232423324243242532426324273242832429324303243132432324333243432435324363243732438324393244032441324423244332444324453244632447324483244932450324513245232453324543245532456324573245832459324603246132462324633246432465324663246732468324693247032471324723247332474324753247632477324783247932480324813248232483324843248532486324873248832489324903249132492324933249432495324963249732498324993250032501325023250332504325053250632507325083250932510325113251232513325143251532516325173251832519325203252132522325233252432525325263252732528325293253032531325323253332534325353253632537325383253932540325413254232543325443254532546325473254832549325503255132552325533255432555325563255732558325593256032561325623256332564325653256632567325683256932570325713257232573325743257532576325773257832579325803258132582325833258432585325863258732588325893259032591325923259332594325953259632597325983259932600326013260232603326043260532606326073260832609326103261132612326133261432615326163261732618326193262032621326223262332624326253262632627326283262932630326313263232633326343263532636326373263832639326403264132642326433264432645326463264732648326493265032651326523265332654326553265632657326583265932660326613266232663326643266532666326673266832669326703267132672326733267432675326763267732678326793268032681326823268332684326853268632687326883268932690326913269232693326943269532696326973269832699327003270132702327033270432705327063270732708327093271032711327123271332714327153271632717327183271932720327213272232723327243272532726327273272832729327303273132732327333273432735327363273732738327393274032741327423274332744327453274632747327483274932750327513275232753327543275532756327573275832759327603276132762327633276432765327663276732768327693277032771327723277332774327753277632777327783277932780327813278232783327843278532786327873278832789327903279132792327933279432795327963279732798327993280032801328023280332804328053280632807328083280932810328113281232813328143281532816328173281832819328203282132822328233282432825328263282732828328293283032831328323283332834328353283632837328383283932840328413284232843328443284532846328473284832849328503285132852328533285432855328563285732858328593286032861328623286332864328653286632867328683286932870328713287232873328743287532876328773287832879328803288132882328833288432885328863288732888328893289032891328923289332894328953289632897328983289932900329013290232903329043290532906329073290832909329103291132912329133291432915329163291732918329193292032921329223292332924329253292632927329283292932930329313293232933329343293532936329373293832939329403294132942329433294432945329463294732948329493295032951329523295332954329553295632957329583295932960329613296232963329643296532966329673296832969329703297132972329733297432975329763297732978329793298032981329823298332984329853298632987329883298932990329913299232993329943299532996329973299832999330003300133002330033300433005330063300733008330093301033011330123301333014330153301633017330183301933020330213302233023330243302533026330273302833029330303303133032330333303433035330363303733038330393304033041330423304333044330453304633047330483304933050330513305233053330543305533056330573305833059330603306133062330633306433065330663306733068330693307033071330723307333074330753307633077330783307933080330813308233083330843308533086330873308833089330903309133092330933309433095330963309733098330993310033101331023310333104331053310633107331083310933110331113311233113331143311533116331173311833119331203312133122331233312433125331263312733128331293313033131331323313333134331353313633137331383313933140331413314233143331443314533146331473314833149331503315133152331533315433155331563315733158331593316033161331623316333164331653316633167331683316933170331713317233173331743317533176331773317833179331803318133182331833318433185331863318733188331893319033191331923319333194331953319633197331983319933200332013320233203332043320533206332073320833209332103321133212332133321433215332163321733218332193322033221332223322333224332253322633227332283322933230332313323233233332343323533236332373323833239332403324133242332433324433245332463324733248332493325033251332523325333254332553325633257332583325933260332613326233263332643326533266332673326833269332703327133272332733327433275332763327733278332793328033281332823328333284332853328633287332883328933290332913329233293332943329533296332973329833299333003330133302333033330433305333063330733308333093331033311333123331333314333153331633317333183331933320333213332233323333243332533326333273332833329333303333133332333333333433335333363333733338333393334033341333423334333344333453334633347333483334933350333513335233353333543335533356333573335833359333603336133362333633336433365333663336733368333693337033371333723337333374333753337633377333783337933380333813338233383333843338533386333873338833389333903339133392333933339433395333963339733398333993340033401334023340333404334053340633407334083340933410334113341233413334143341533416334173341833419334203342133422334233342433425334263342733428334293343033431334323343333434334353343633437334383343933440334413344233443334443344533446334473344833449334503345133452334533345433455334563345733458334593346033461334623346333464334653346633467334683346933470334713347233473334743347533476334773347833479334803348133482334833348433485334863348733488334893349033491334923349333494334953349633497334983349933500335013350233503335043350533506335073350833509335103351133512335133351433515335163351733518335193352033521335223352333524335253352633527335283352933530335313353233533335343353533536335373353833539335403354133542335433354433545335463354733548335493355033551335523355333554335553355633557335583355933560335613356233563335643356533566335673356833569335703357133572335733357433575335763357733578335793358033581335823358333584335853358633587335883358933590335913359233593335943359533596335973359833599336003360133602336033360433605336063360733608336093361033611336123361333614336153361633617336183361933620336213362233623336243362533626336273362833629336303363133632336333363433635336363363733638336393364033641336423364333644336453364633647336483364933650336513365233653336543365533656336573365833659336603366133662336633366433665336663366733668336693367033671336723367333674336753367633677336783367933680336813368233683336843368533686336873368833689336903369133692336933369433695336963369733698336993370033701337023370333704337053370633707337083370933710337113371233713337143371533716337173371833719337203372133722337233372433725337263372733728337293373033731337323373333734337353373633737337383373933740337413374233743337443374533746337473374833749337503375133752337533375433755337563375733758337593376033761337623376333764337653376633767337683376933770337713377233773337743377533776337773377833779337803378133782337833378433785337863378733788337893379033791337923379333794337953379633797337983379933800338013380233803338043380533806338073380833809338103381133812338133381433815338163381733818338193382033821338223382333824338253382633827338283382933830338313383233833338343383533836338373383833839338403384133842338433384433845338463384733848338493385033851338523385333854338553385633857338583385933860338613386233863338643386533866338673386833869338703387133872338733387433875338763387733878338793388033881338823388333884338853388633887338883388933890338913389233893338943389533896338973389833899339003390133902339033390433905339063390733908339093391033911339123391333914339153391633917339183391933920339213392233923339243392533926339273392833929339303393133932339333393433935339363393733938339393394033941339423394333944339453394633947339483394933950339513395233953339543395533956339573395833959339603396133962339633396433965339663396733968339693397033971339723397333974339753397633977339783397933980339813398233983339843398533986339873398833989339903399133992339933399433995339963399733998339993400034001340023400334004340053400634007340083400934010340113401234013340143401534016340173401834019340203402134022340233402434025340263402734028340293403034031340323403334034340353403634037340383403934040340413404234043340443404534046340473404834049340503405134052340533405434055340563405734058340593406034061340623406334064340653406634067340683406934070340713407234073340743407534076340773407834079340803408134082340833408434085340863408734088340893409034091340923409334094340953409634097340983409934100341013410234103341043410534106341073410834109341103411134112341133411434115341163411734118341193412034121341223412334124341253412634127341283412934130341313413234133341343413534136341373413834139341403414134142341433414434145341463414734148341493415034151341523415334154341553415634157341583415934160341613416234163341643416534166341673416834169341703417134172341733417434175341763417734178341793418034181341823418334184341853418634187341883418934190341913419234193341943419534196341973419834199342003420134202342033420434205342063420734208342093421034211342123421334214342153421634217342183421934220342213422234223342243422534226342273422834229342303423134232342333423434235342363423734238342393424034241342423424334244342453424634247342483424934250342513425234253342543425534256342573425834259342603426134262342633426434265342663426734268342693427034271342723427334274342753427634277342783427934280342813428234283342843428534286342873428834289342903429134292342933429434295342963429734298342993430034301343023430334304343053430634307343083430934310343113431234313343143431534316343173431834319343203432134322343233432434325343263432734328343293433034331343323433334334343353433634337343383433934340343413434234343343443434534346343473434834349343503435134352343533435434355343563435734358343593436034361343623436334364343653436634367343683436934370343713437234373343743437534376343773437834379343803438134382343833438434385343863438734388343893439034391343923439334394343953439634397343983439934400344013440234403344043440534406344073440834409344103441134412344133441434415344163441734418344193442034421344223442334424344253442634427344283442934430344313443234433344343443534436344373443834439344403444134442344433444434445344463444734448344493445034451344523445334454344553445634457344583445934460344613446234463344643446534466344673446834469344703447134472344733447434475344763447734478344793448034481344823448334484344853448634487344883448934490344913449234493344943449534496344973449834499345003450134502345033450434505345063450734508345093451034511345123451334514345153451634517345183451934520345213452234523345243452534526345273452834529345303453134532345333453434535345363453734538345393454034541345423454334544345453454634547345483454934550345513455234553345543455534556345573455834559345603456134562345633456434565345663456734568345693457034571345723457334574345753457634577345783457934580345813458234583345843458534586345873458834589345903459134592345933459434595345963459734598345993460034601346023460334604346053460634607346083460934610346113461234613346143461534616346173461834619346203462134622346233462434625346263462734628346293463034631346323463334634346353463634637346383463934640346413464234643346443464534646346473464834649346503465134652346533465434655346563465734658346593466034661346623466334664346653466634667346683466934670346713467234673346743467534676346773467834679346803468134682346833468434685346863468734688346893469034691346923469334694346953469634697346983469934700347013470234703347043470534706347073470834709347103471134712347133471434715347163471734718347193472034721347223472334724347253472634727347283472934730347313473234733347343473534736347373473834739347403474134742347433474434745347463474734748347493475034751347523475334754347553475634757347583475934760347613476234763347643476534766347673476834769347703477134772347733477434775347763477734778347793478034781347823478334784347853478634787347883478934790347913479234793347943479534796347973479834799348003480134802348033480434805348063480734808348093481034811348123481334814348153481634817348183481934820348213482234823348243482534826348273482834829348303483134832348333483434835348363483734838348393484034841348423484334844348453484634847348483484934850348513485234853348543485534856348573485834859348603486134862348633486434865348663486734868348693487034871348723487334874348753487634877348783487934880348813488234883348843488534886348873488834889348903489134892348933489434895348963489734898348993490034901349023490334904349053490634907349083490934910349113491234913349143491534916349173491834919349203492134922349233492434925349263492734928349293493034931349323493334934349353493634937349383493934940349413494234943349443494534946349473494834949349503495134952349533495434955349563495734958349593496034961349623496334964349653496634967349683496934970349713497234973349743497534976349773497834979349803498134982349833498434985349863498734988349893499034991349923499334994349953499634997349983499935000350013500235003350043500535006350073500835009350103501135012350133501435015350163501735018350193502035021350223502335024350253502635027350283502935030350313503235033350343503535036350373503835039350403504135042350433504435045350463504735048350493505035051350523505335054350553505635057350583505935060350613506235063350643506535066350673506835069350703507135072350733507435075350763507735078350793508035081350823508335084350853508635087350883508935090350913509235093350943509535096350973509835099351003510135102351033510435105351063510735108351093511035111351123511335114351153511635117351183511935120351213512235123351243512535126351273512835129351303513135132351333513435135351363513735138351393514035141351423514335144351453514635147351483514935150351513515235153351543515535156351573515835159351603516135162351633516435165351663516735168351693517035171351723517335174351753517635177351783517935180351813518235183351843518535186351873518835189351903519135192351933519435195351963519735198351993520035201352023520335204352053520635207352083520935210352113521235213352143521535216352173521835219352203522135222352233522435225352263522735228352293523035231352323523335234352353523635237352383523935240352413524235243352443524535246352473524835249352503525135252352533525435255352563525735258352593526035261352623526335264352653526635267352683526935270352713527235273352743527535276352773527835279352803528135282352833528435285352863528735288352893529035291352923529335294352953529635297352983529935300353013530235303353043530535306353073530835309353103531135312353133531435315353163531735318353193532035321353223532335324353253532635327353283532935330353313533235333353343533535336353373533835339353403534135342353433534435345353463534735348353493535035351353523535335354353553535635357353583535935360353613536235363353643536535366353673536835369353703537135372353733537435375353763537735378353793538035381353823538335384353853538635387353883538935390353913539235393353943539535396353973539835399354003540135402354033540435405354063540735408354093541035411354123541335414354153541635417354183541935420354213542235423354243542535426354273542835429354303543135432354333543435435354363543735438354393544035441354423544335444354453544635447354483544935450354513545235453354543545535456354573545835459354603546135462354633546435465354663546735468354693547035471354723547335474354753547635477354783547935480354813548235483354843548535486354873548835489354903549135492354933549435495354963549735498354993550035501355023550335504355053550635507355083550935510355113551235513355143551535516355173551835519355203552135522355233552435525355263552735528355293553035531355323553335534355353553635537355383553935540355413554235543355443554535546355473554835549355503555135552355533555435555355563555735558355593556035561355623556335564355653556635567355683556935570355713557235573355743557535576355773557835579355803558135582355833558435585355863558735588355893559035591355923559335594355953559635597355983559935600356013560235603356043560535606356073560835609356103561135612356133561435615356163561735618356193562035621356223562335624356253562635627356283562935630356313563235633356343563535636356373563835639356403564135642356433564435645356463564735648356493565035651356523565335654356553565635657356583565935660356613566235663356643566535666356673566835669356703567135672356733567435675356763567735678356793568035681356823568335684356853568635687356883568935690356913569235693356943569535696356973569835699357003570135702357033570435705357063570735708357093571035711357123571335714357153571635717357183571935720357213572235723357243572535726357273572835729357303573135732357333573435735357363573735738357393574035741357423574335744357453574635747357483574935750357513575235753357543575535756357573575835759357603576135762357633576435765357663576735768357693577035771357723577335774357753577635777357783577935780357813578235783357843578535786357873578835789357903579135792357933579435795357963579735798357993580035801358023580335804358053580635807358083580935810358113581235813358143581535816358173581835819358203582135822358233582435825358263582735828358293583035831358323583335834358353583635837358383583935840358413584235843358443584535846358473584835849358503585135852358533585435855358563585735858358593586035861358623586335864358653586635867358683586935870358713587235873358743587535876358773587835879358803588135882358833588435885358863588735888358893589035891358923589335894358953589635897358983589935900359013590235903359043590535906359073590835909359103591135912359133591435915359163591735918359193592035921359223592335924359253592635927359283592935930359313593235933359343593535936359373593835939359403594135942359433594435945359463594735948359493595035951359523595335954359553595635957359583595935960359613596235963359643596535966359673596835969359703597135972359733597435975359763597735978359793598035981359823598335984359853598635987359883598935990359913599235993359943599535996359973599835999360003600136002360033600436005360063600736008360093601036011360123601336014360153601636017360183601936020360213602236023360243602536026360273602836029360303603136032360333603436035360363603736038360393604036041360423604336044360453604636047360483604936050360513605236053360543605536056360573605836059360603606136062360633606436065360663606736068360693607036071360723607336074360753607636077360783607936080360813608236083360843608536086360873608836089360903609136092360933609436095360963609736098360993610036101361023610336104361053610636107361083610936110361113611236113361143611536116361173611836119361203612136122361233612436125361263612736128361293613036131361323613336134361353613636137361383613936140361413614236143361443614536146361473614836149361503615136152361533615436155361563615736158361593616036161361623616336164361653616636167361683616936170361713617236173361743617536176361773617836179361803618136182361833618436185361863618736188361893619036191361923619336194361953619636197361983619936200362013620236203362043620536206362073620836209362103621136212362133621436215362163621736218362193622036221362223622336224362253622636227362283622936230362313623236233362343623536236362373623836239362403624136242362433624436245362463624736248362493625036251362523625336254362553625636257362583625936260362613626236263362643626536266362673626836269362703627136272362733627436275362763627736278362793628036281362823628336284362853628636287362883628936290362913629236293362943629536296362973629836299363003630136302363033630436305363063630736308363093631036311363123631336314363153631636317363183631936320363213632236323363243632536326363273632836329363303633136332363333633436335363363633736338363393634036341363423634336344363453634636347363483634936350363513635236353363543635536356363573635836359363603636136362363633636436365363663636736368363693637036371363723637336374363753637636377363783637936380363813638236383363843638536386363873638836389363903639136392363933639436395363963639736398363993640036401364023640336404364053640636407364083640936410364113641236413364143641536416364173641836419364203642136422364233642436425364263642736428364293643036431364323643336434364353643636437364383643936440364413644236443364443644536446364473644836449364503645136452364533645436455364563645736458364593646036461364623646336464364653646636467364683646936470364713647236473364743647536476364773647836479364803648136482364833648436485364863648736488364893649036491364923649336494364953649636497364983649936500365013650236503365043650536506365073650836509365103651136512365133651436515365163651736518365193652036521365223652336524365253652636527365283652936530365313653236533365343653536536365373653836539365403654136542365433654436545365463654736548365493655036551365523655336554365553655636557365583655936560365613656236563365643656536566365673656836569365703657136572365733657436575365763657736578365793658036581365823658336584365853658636587365883658936590365913659236593365943659536596365973659836599366003660136602366033660436605366063660736608366093661036611366123661336614366153661636617366183661936620366213662236623366243662536626366273662836629366303663136632366333663436635366363663736638366393664036641366423664336644366453664636647366483664936650366513665236653366543665536656366573665836659366603666136662366633666436665366663666736668366693667036671366723667336674366753667636677366783667936680366813668236683366843668536686366873668836689366903669136692366933669436695366963669736698366993670036701367023670336704367053670636707367083670936710367113671236713367143671536716367173671836719367203672136722367233672436725367263672736728367293673036731367323673336734367353673636737367383673936740367413674236743367443674536746367473674836749367503675136752367533675436755367563675736758367593676036761367623676336764367653676636767367683676936770367713677236773367743677536776367773677836779367803678136782367833678436785367863678736788367893679036791367923679336794367953679636797367983679936800368013680236803368043680536806368073680836809368103681136812368133681436815368163681736818368193682036821368223682336824368253682636827368283682936830368313683236833368343683536836368373683836839368403684136842368433684436845368463684736848368493685036851368523685336854368553685636857368583685936860368613686236863368643686536866368673686836869368703687136872368733687436875368763687736878368793688036881368823688336884368853688636887368883688936890368913689236893368943689536896368973689836899369003690136902369033690436905369063690736908369093691036911369123691336914369153691636917369183691936920369213692236923369243692536926369273692836929369303693136932369333693436935369363693736938369393694036941369423694336944369453694636947369483694936950369513695236953369543695536956369573695836959369603696136962369633696436965369663696736968369693697036971369723697336974369753697636977369783697936980369813698236983369843698536986369873698836989369903699136992369933699436995369963699736998369993700037001370023700337004370053700637007370083700937010370113701237013370143701537016370173701837019370203702137022370233702437025370263702737028370293703037031370323703337034370353703637037370383703937040370413704237043370443704537046370473704837049370503705137052370533705437055370563705737058370593706037061370623706337064370653706637067370683706937070370713707237073370743707537076370773707837079370803708137082370833708437085370863708737088370893709037091370923709337094370953709637097370983709937100371013710237103371043710537106371073710837109371103711137112371133711437115371163711737118371193712037121371223712337124371253712637127371283712937130371313713237133371343713537136371373713837139371403714137142371433714437145371463714737148371493715037151371523715337154371553715637157371583715937160371613716237163371643716537166371673716837169371703717137172371733717437175371763717737178371793718037181371823718337184371853718637187371883718937190371913719237193371943719537196371973719837199372003720137202372033720437205372063720737208372093721037211372123721337214372153721637217372183721937220372213722237223372243722537226372273722837229372303723137232372333723437235372363723737238372393724037241372423724337244372453724637247372483724937250372513725237253372543725537256372573725837259372603726137262372633726437265372663726737268372693727037271372723727337274372753727637277372783727937280372813728237283372843728537286372873728837289372903729137292372933729437295372963729737298372993730037301373023730337304373053730637307373083730937310373113731237313373143731537316373173731837319373203732137322
  1. [
  2. {
  3. "name": "List global hooks",
  4. "scope": "enterpriseAdmin",
  5. "id": "listGlobalHooks",
  6. "method": "GET",
  7. "url": "/admin/hooks",
  8. "isDeprecated": false,
  9. "description": "",
  10. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#list-global-hooks",
  11. "previews": [{ "name": "superpro" }],
  12. "headers": [
  13. {
  14. "name": "accept",
  15. "value": "application/vnd.github.superpro-preview+json"
  16. }
  17. ],
  18. "parameters": [
  19. {
  20. "name": "per_page",
  21. "description": "Results per page (max 100)",
  22. "in": "QUERY",
  23. "type": "integer",
  24. "required": false,
  25. "enum": null,
  26. "allowNull": false,
  27. "mapToData": null,
  28. "validation": null,
  29. "alias": null,
  30. "deprecated": null
  31. },
  32. {
  33. "name": "page",
  34. "description": "Page number of the results to fetch.",
  35. "in": "QUERY",
  36. "type": "integer",
  37. "required": false,
  38. "enum": null,
  39. "allowNull": false,
  40. "mapToData": null,
  41. "validation": null,
  42. "alias": null,
  43. "deprecated": null
  44. }
  45. ],
  46. "responses": [
  47. {
  48. "code": 200,
  49. "description": "response",
  50. "examples": [
  51. {
  52. "data": "[{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}]"
  53. }
  54. ]
  55. }
  56. ],
  57. "renamed": null
  58. },
  59. {
  60. "name": "Create a global hook",
  61. "scope": "enterpriseAdmin",
  62. "id": "createGlobalHook",
  63. "method": "POST",
  64. "url": "/admin/hooks",
  65. "isDeprecated": false,
  66. "description": "",
  67. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#create-a-global-hook",
  68. "previews": [{ "name": "superpro" }],
  69. "headers": [
  70. {
  71. "name": "accept",
  72. "value": "application/vnd.github.superpro-preview+json"
  73. }
  74. ],
  75. "parameters": [
  76. {
  77. "name": "name",
  78. "description": "Must be passed as \"web\".",
  79. "in": "BODY",
  80. "type": "string",
  81. "required": true,
  82. "enum": null,
  83. "allowNull": false,
  84. "mapToData": null,
  85. "validation": null,
  86. "alias": null,
  87. "deprecated": null
  88. },
  89. {
  90. "name": "config",
  91. "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#create-hook-config-params).",
  92. "in": "BODY",
  93. "type": "object",
  94. "required": true,
  95. "enum": null,
  96. "allowNull": false,
  97. "mapToData": null,
  98. "validation": null,
  99. "alias": null,
  100. "deprecated": null
  101. },
  102. {
  103. "name": "config.url",
  104. "description": "The URL to which the payloads will be delivered.",
  105. "in": "BODY",
  106. "type": "string",
  107. "required": true,
  108. "enum": null,
  109. "allowNull": false,
  110. "mapToData": null,
  111. "validation": null,
  112. "alias": null,
  113. "deprecated": null
  114. },
  115. {
  116. "name": "config.content_type",
  117. "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
  118. "in": "BODY",
  119. "type": "string",
  120. "required": false,
  121. "enum": null,
  122. "allowNull": false,
  123. "mapToData": null,
  124. "validation": null,
  125. "alias": null,
  126. "deprecated": null
  127. },
  128. {
  129. "name": "config.secret",
  130. "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/enterprise/2.17/webhooks/#delivery-headers) header.",
  131. "in": "BODY",
  132. "type": "string",
  133. "required": false,
  134. "enum": null,
  135. "allowNull": false,
  136. "mapToData": null,
  137. "validation": null,
  138. "alias": null,
  139. "deprecated": null
  140. },
  141. {
  142. "name": "config.insecure_ssl",
  143. "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
  144. "in": "BODY",
  145. "type": "string",
  146. "required": false,
  147. "enum": null,
  148. "allowNull": false,
  149. "mapToData": null,
  150. "validation": null,
  151. "alias": null,
  152. "deprecated": null
  153. },
  154. {
  155. "name": "events",
  156. "description": "The [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
  157. "in": "BODY",
  158. "type": "string[]",
  159. "required": false,
  160. "enum": null,
  161. "allowNull": false,
  162. "mapToData": null,
  163. "validation": null,
  164. "alias": null,
  165. "deprecated": null
  166. },
  167. {
  168. "name": "active",
  169. "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
  170. "in": "BODY",
  171. "type": "boolean",
  172. "required": false,
  173. "enum": null,
  174. "allowNull": false,
  175. "mapToData": null,
  176. "validation": null,
  177. "alias": null,
  178. "deprecated": null
  179. }
  180. ],
  181. "responses": [
  182. {
  183. "code": 201,
  184. "description": "response",
  185. "examples": [
  186. {
  187. "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}"
  188. }
  189. ]
  190. }
  191. ],
  192. "renamed": null
  193. },
  194. {
  195. "name": "Get single global hook",
  196. "scope": "enterpriseAdmin",
  197. "id": "getGlobalHook",
  198. "method": "GET",
  199. "url": "/admin/hooks/{hook_id}",
  200. "isDeprecated": false,
  201. "description": "",
  202. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#get-single-global-hook",
  203. "previews": [{ "name": "superpro" }],
  204. "headers": [
  205. {
  206. "name": "accept",
  207. "value": "application/vnd.github.superpro-preview+json"
  208. }
  209. ],
  210. "parameters": [
  211. {
  212. "name": "hook_id",
  213. "description": "hook_id parameter",
  214. "in": "PATH",
  215. "type": "integer",
  216. "required": true,
  217. "enum": null,
  218. "allowNull": false,
  219. "mapToData": null,
  220. "validation": null,
  221. "alias": null,
  222. "deprecated": null
  223. }
  224. ],
  225. "responses": [
  226. {
  227. "code": 200,
  228. "description": "response",
  229. "examples": [
  230. {
  231. "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\",\"user\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"secret\":\"********\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}"
  232. }
  233. ]
  234. }
  235. ],
  236. "renamed": null
  237. },
  238. {
  239. "name": "Edit a global hook",
  240. "scope": "enterpriseAdmin",
  241. "id": "updateGlobalHook",
  242. "method": "PATCH",
  243. "url": "/admin/hooks/{hook_id}",
  244. "isDeprecated": false,
  245. "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.",
  246. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#edit-a-global-hook",
  247. "previews": [{ "name": "superpro" }],
  248. "headers": [
  249. {
  250. "name": "accept",
  251. "value": "application/vnd.github.superpro-preview+json"
  252. }
  253. ],
  254. "parameters": [
  255. {
  256. "name": "hook_id",
  257. "description": "hook_id parameter",
  258. "in": "PATH",
  259. "type": "integer",
  260. "required": true,
  261. "enum": null,
  262. "allowNull": false,
  263. "mapToData": null,
  264. "validation": null,
  265. "alias": null,
  266. "deprecated": null
  267. },
  268. {
  269. "name": "config",
  270. "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#update-hook-config-params).",
  271. "in": "BODY",
  272. "type": "object",
  273. "required": false,
  274. "enum": null,
  275. "allowNull": false,
  276. "mapToData": null,
  277. "validation": null,
  278. "alias": null,
  279. "deprecated": null
  280. },
  281. {
  282. "name": "config.url",
  283. "description": "The URL to which the payloads will be delivered.",
  284. "in": "BODY",
  285. "type": "string",
  286. "required": true,
  287. "enum": null,
  288. "allowNull": false,
  289. "mapToData": null,
  290. "validation": null,
  291. "alias": null,
  292. "deprecated": null
  293. },
  294. {
  295. "name": "config.content_type",
  296. "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
  297. "in": "BODY",
  298. "type": "string",
  299. "required": false,
  300. "enum": null,
  301. "allowNull": false,
  302. "mapToData": null,
  303. "validation": null,
  304. "alias": null,
  305. "deprecated": null
  306. },
  307. {
  308. "name": "config.secret",
  309. "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/enterprise/2.17/webhooks/#delivery-headers) header.",
  310. "in": "BODY",
  311. "type": "string",
  312. "required": false,
  313. "enum": null,
  314. "allowNull": false,
  315. "mapToData": null,
  316. "validation": null,
  317. "alias": null,
  318. "deprecated": null
  319. },
  320. {
  321. "name": "config.insecure_ssl",
  322. "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
  323. "in": "BODY",
  324. "type": "string",
  325. "required": false,
  326. "enum": null,
  327. "allowNull": false,
  328. "mapToData": null,
  329. "validation": null,
  330. "alias": null,
  331. "deprecated": null
  332. },
  333. {
  334. "name": "events",
  335. "description": "The [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.",
  336. "in": "BODY",
  337. "type": "string[]",
  338. "required": false,
  339. "enum": null,
  340. "allowNull": false,
  341. "mapToData": null,
  342. "validation": null,
  343. "alias": null,
  344. "deprecated": null
  345. },
  346. {
  347. "name": "active",
  348. "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
  349. "in": "BODY",
  350. "type": "boolean",
  351. "required": false,
  352. "enum": null,
  353. "allowNull": false,
  354. "mapToData": null,
  355. "validation": null,
  356. "alias": null,
  357. "deprecated": null
  358. }
  359. ],
  360. "responses": [
  361. {
  362. "code": 200,
  363. "description": "response",
  364. "examples": [
  365. {
  366. "data": "{\"type\":\"Global\",\"id\":1,\"name\":\"web\",\"active\":true,\"events\":[\"organization\"],\"config\":{\"url\":\"https://example.com\",\"content_type\":\"form\",\"insecure_ssl\":\"0\"},\"updated_at\":\"2017-12-07T00:14:59Z\",\"created_at\":\"2017-12-07T00:14:59Z\",\"url\":\"https://api.github.com/admin/hooks/1\",\"ping_url\":\"https://api.github.com/admin/hooks/1/pings\"}"
  367. }
  368. ]
  369. }
  370. ],
  371. "renamed": null
  372. },
  373. {
  374. "name": "Delete a global hook",
  375. "scope": "enterpriseAdmin",
  376. "id": "deleteGlobalHook",
  377. "method": "DELETE",
  378. "url": "/admin/hooks/{hook_id}",
  379. "isDeprecated": false,
  380. "description": "",
  381. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#delete-a-global-hook",
  382. "previews": [{ "name": "superpro" }],
  383. "headers": [
  384. {
  385. "name": "accept",
  386. "value": "application/vnd.github.superpro-preview+json"
  387. }
  388. ],
  389. "parameters": [
  390. {
  391. "name": "hook_id",
  392. "description": "hook_id parameter",
  393. "in": "PATH",
  394. "type": "integer",
  395. "required": true,
  396. "enum": null,
  397. "allowNull": false,
  398. "mapToData": null,
  399. "validation": null,
  400. "alias": null,
  401. "deprecated": null
  402. }
  403. ],
  404. "responses": [],
  405. "renamed": null
  406. },
  407. {
  408. "name": "Ping a global hook",
  409. "scope": "enterpriseAdmin",
  410. "id": "pingGlobalHook",
  411. "method": "POST",
  412. "url": "/admin/hooks/{hook_id}/pings",
  413. "isDeprecated": false,
  414. "description": "This will trigger a [ping event](https://developer.github.com/enterprise/2.17/webhooks/#ping-event) to be sent to the hook.",
  415. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/global_webhooks/#ping-a-global-hook",
  416. "previews": [{ "name": "superpro" }],
  417. "headers": [
  418. {
  419. "name": "accept",
  420. "value": "application/vnd.github.superpro-preview+json"
  421. }
  422. ],
  423. "parameters": [
  424. {
  425. "name": "hook_id",
  426. "description": "hook_id parameter",
  427. "in": "PATH",
  428. "type": "integer",
  429. "required": true,
  430. "enum": null,
  431. "allowNull": false,
  432. "mapToData": null,
  433. "validation": null,
  434. "alias": null,
  435. "deprecated": null
  436. }
  437. ],
  438. "responses": [],
  439. "renamed": null
  440. },
  441. {
  442. "name": "Delete a public key",
  443. "scope": "enterpriseAdmin",
  444. "id": "deletePublicKey",
  445. "method": "DELETE",
  446. "url": "/admin/keys/{key_ids}",
  447. "isDeprecated": false,
  448. "description": "",
  449. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#delete-a-public-key",
  450. "previews": [],
  451. "headers": [],
  452. "parameters": [
  453. {
  454. "name": "key_ids",
  455. "description": "key_ids parameter",
  456. "in": "PATH",
  457. "type": "string",
  458. "required": true,
  459. "enum": null,
  460. "allowNull": false,
  461. "mapToData": null,
  462. "validation": null,
  463. "alias": null,
  464. "deprecated": null
  465. }
  466. ],
  467. "responses": [],
  468. "renamed": null
  469. },
  470. {
  471. "name": "Update LDAP mapping for a team",
  472. "scope": "enterpriseAdmin",
  473. "id": "updateLdapMappingForTeam",
  474. "method": "PATCH",
  475. "url": "/admin/ldap/teams/{team_id}/mapping",
  476. "isDeprecated": false,
  477. "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create team](https://developer.github.com/enterprise/2.17/v3/teams/#create-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.",
  478. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team",
  479. "previews": [],
  480. "headers": [],
  481. "parameters": [
  482. {
  483. "name": "team_id",
  484. "description": "team_id parameter",
  485. "in": "PATH",
  486. "type": "integer",
  487. "required": true,
  488. "enum": null,
  489. "allowNull": false,
  490. "mapToData": null,
  491. "validation": null,
  492. "alias": null,
  493. "deprecated": null
  494. },
  495. {
  496. "name": "ldap_dn",
  497. "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
  498. "in": "BODY",
  499. "type": "string",
  500. "required": false,
  501. "enum": null,
  502. "allowNull": false,
  503. "mapToData": null,
  504. "validation": null,
  505. "alias": null,
  506. "deprecated": null
  507. }
  508. ],
  509. "responses": [
  510. {
  511. "code": 200,
  512. "description": "response",
  513. "examples": [
  514. {
  515. "data": "{\"ldap_dn\":\"cn=Enterprise Ops,ou=teams,dc=github,dc=com\",\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}"
  516. }
  517. ]
  518. }
  519. ],
  520. "renamed": null
  521. },
  522. {
  523. "name": "Sync LDAP mapping for a team",
  524. "scope": "enterpriseAdmin",
  525. "id": "syncLdapMappingForTeam",
  526. "method": "POST",
  527. "url": "/admin/ldap/teams/{team_id}/sync",
  528. "isDeprecated": false,
  529. "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
  530. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/ldap/#sync-ldap-mapping-for-a-team",
  531. "previews": [],
  532. "headers": [],
  533. "parameters": [
  534. {
  535. "name": "team_id",
  536. "description": "team_id parameter",
  537. "in": "PATH",
  538. "type": "integer",
  539. "required": true,
  540. "enum": null,
  541. "allowNull": false,
  542. "mapToData": null,
  543. "validation": null,
  544. "alias": null,
  545. "deprecated": null
  546. }
  547. ],
  548. "responses": [
  549. {
  550. "code": 201,
  551. "description": "response",
  552. "examples": [{ "data": "{\"status\":\"queued\"}" }]
  553. }
  554. ],
  555. "renamed": null
  556. },
  557. {
  558. "name": "Update LDAP mapping for a user",
  559. "scope": "enterpriseAdmin",
  560. "id": "updateLdapMappingForUser",
  561. "method": "PATCH",
  562. "url": "/admin/ldap/users/{username}/mapping",
  563. "isDeprecated": false,
  564. "description": "",
  565. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-user",
  566. "previews": [],
  567. "headers": [],
  568. "parameters": [
  569. {
  570. "name": "username",
  571. "description": "username parameter",
  572. "in": "PATH",
  573. "type": "string",
  574. "required": true,
  575. "enum": null,
  576. "allowNull": false,
  577. "mapToData": null,
  578. "validation": null,
  579. "alias": null,
  580. "deprecated": null
  581. },
  582. {
  583. "name": "ldap_dn",
  584. "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.",
  585. "in": "BODY",
  586. "type": "string",
  587. "required": false,
  588. "enum": null,
  589. "allowNull": false,
  590. "mapToData": null,
  591. "validation": null,
  592. "alias": null,
  593. "deprecated": null
  594. }
  595. ],
  596. "responses": [
  597. {
  598. "code": 200,
  599. "description": "response",
  600. "examples": [
  601. {
  602. "data": "{\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\",\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}"
  603. }
  604. ]
  605. }
  606. ],
  607. "renamed": null
  608. },
  609. {
  610. "name": "Sync LDAP mapping for a user",
  611. "scope": "enterpriseAdmin",
  612. "id": "syncLdapMappingForUser",
  613. "method": "POST",
  614. "url": "/admin/ldap/users/{username}/sync",
  615. "isDeprecated": false,
  616. "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.",
  617. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/ldap/#sync-ldap-mapping-for-a-user",
  618. "previews": [],
  619. "headers": [],
  620. "parameters": [
  621. {
  622. "name": "username",
  623. "description": "username parameter",
  624. "in": "PATH",
  625. "type": "string",
  626. "required": true,
  627. "enum": null,
  628. "allowNull": false,
  629. "mapToData": null,
  630. "validation": null,
  631. "alias": null,
  632. "deprecated": null
  633. }
  634. ],
  635. "responses": [
  636. {
  637. "code": 201,
  638. "description": "response",
  639. "examples": [{ "data": "{\"status\":\"queued\"}" }]
  640. }
  641. ],
  642. "renamed": null
  643. },
  644. {
  645. "name": "Create an organization",
  646. "scope": "enterpriseAdmin",
  647. "id": "createOrg",
  648. "method": "POST",
  649. "url": "/admin/organizations",
  650. "isDeprecated": false,
  651. "description": "",
  652. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/orgs/#create-an-organization",
  653. "previews": [],
  654. "headers": [],
  655. "parameters": [
  656. {
  657. "name": "login",
  658. "description": "The organization's username.",
  659. "in": "BODY",
  660. "type": "string",
  661. "required": true,
  662. "enum": null,
  663. "allowNull": false,
  664. "mapToData": null,
  665. "validation": null,
  666. "alias": null,
  667. "deprecated": null
  668. },
  669. {
  670. "name": "admin",
  671. "description": "The login of the user who will manage this organization.",
  672. "in": "BODY",
  673. "type": "string",
  674. "required": true,
  675. "enum": null,
  676. "allowNull": false,
  677. "mapToData": null,
  678. "validation": null,
  679. "alias": null,
  680. "deprecated": null
  681. },
  682. {
  683. "name": "profile_name",
  684. "description": "The organization's display name.",
  685. "in": "BODY",
  686. "type": "string",
  687. "required": false,
  688. "enum": null,
  689. "allowNull": false,
  690. "mapToData": null,
  691. "validation": null,
  692. "alias": null,
  693. "deprecated": null
  694. }
  695. ],
  696. "responses": [
  697. {
  698. "code": 201,
  699. "description": "response",
  700. "examples": [
  701. {
  702. "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}"
  703. }
  704. ]
  705. }
  706. ],
  707. "renamed": null
  708. },
  709. {
  710. "name": "Rename an organization",
  711. "scope": "enterpriseAdmin",
  712. "id": "renameOrg",
  713. "method": "PATCH",
  714. "url": "/admin/organizations/{org}",
  715. "isDeprecated": false,
  716. "description": "",
  717. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/orgs/#rename-an-organization",
  718. "previews": [],
  719. "headers": [],
  720. "parameters": [
  721. {
  722. "name": "org",
  723. "description": "org parameter",
  724. "in": "PATH",
  725. "type": "string",
  726. "required": true,
  727. "enum": null,
  728. "allowNull": false,
  729. "mapToData": null,
  730. "validation": null,
  731. "alias": null,
  732. "deprecated": null
  733. },
  734. {
  735. "name": "login",
  736. "description": "The organization's new name.",
  737. "in": "BODY",
  738. "type": "string",
  739. "required": true,
  740. "enum": null,
  741. "allowNull": false,
  742. "mapToData": null,
  743. "validation": null,
  744. "alias": null,
  745. "deprecated": null
  746. }
  747. ],
  748. "responses": [
  749. {
  750. "code": 202,
  751. "description": "response",
  752. "examples": [
  753. {
  754. "data": "{\"message\":\"Job queued to rename organization. It may take a few minutes to complete.\",\"url\":\"https://<hostname>/api/v3/organizations/1\"}"
  755. }
  756. ]
  757. }
  758. ],
  759. "renamed": null
  760. },
  761. {
  762. "name": "List pre-receive environments",
  763. "scope": "enterpriseAdmin",
  764. "id": "listPreReceiveEnvironments",
  765. "method": "GET",
  766. "url": "/admin/pre-receive-environments",
  767. "isDeprecated": false,
  768. "description": "",
  769. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#list-pre-receive-environments",
  770. "previews": [],
  771. "headers": [],
  772. "parameters": [
  773. {
  774. "name": "per_page",
  775. "description": "Results per page (max 100)",
  776. "in": "QUERY",
  777. "type": "integer",
  778. "required": false,
  779. "enum": null,
  780. "allowNull": false,
  781. "mapToData": null,
  782. "validation": null,
  783. "alias": null,
  784. "deprecated": null
  785. },
  786. {
  787. "name": "page",
  788. "description": "Page number of the results to fetch.",
  789. "in": "QUERY",
  790. "type": "integer",
  791. "required": false,
  792. "enum": null,
  793. "allowNull": false,
  794. "mapToData": null,
  795. "validation": null,
  796. "alias": null,
  797. "deprecated": null
  798. }
  799. ],
  800. "responses": [
  801. {
  802. "code": 200,
  803. "description": "response",
  804. "examples": [
  805. {
  806. "data": "[{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":14,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}]"
  807. }
  808. ]
  809. }
  810. ],
  811. "renamed": null
  812. },
  813. {
  814. "name": "Create a pre-receive environment",
  815. "scope": "enterpriseAdmin",
  816. "id": "createPreReceiveEnvironment",
  817. "method": "POST",
  818. "url": "/admin/pre-receive-environments",
  819. "isDeprecated": false,
  820. "description": "",
  821. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#create-a-pre-receive-environment",
  822. "previews": [],
  823. "headers": [],
  824. "parameters": [
  825. {
  826. "name": "name",
  827. "description": "The new pre-receive environment's name.",
  828. "in": "BODY",
  829. "type": "string",
  830. "required": true,
  831. "enum": null,
  832. "allowNull": false,
  833. "mapToData": null,
  834. "validation": null,
  835. "alias": null,
  836. "deprecated": null
  837. },
  838. {
  839. "name": "image_url",
  840. "description": "URL from which to download a tarball of this environment.",
  841. "in": "BODY",
  842. "type": "string",
  843. "required": true,
  844. "enum": null,
  845. "allowNull": false,
  846. "mapToData": null,
  847. "validation": null,
  848. "alias": null,
  849. "deprecated": null
  850. }
  851. ],
  852. "responses": [
  853. {
  854. "code": 201,
  855. "description": "response",
  856. "examples": [
  857. {
  858. "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}}"
  859. }
  860. ]
  861. }
  862. ],
  863. "renamed": null
  864. },
  865. {
  866. "name": "Get a single pre-receive environment",
  867. "scope": "enterpriseAdmin",
  868. "id": "getPreReceiveEnvironment",
  869. "method": "GET",
  870. "url": "/admin/pre-receive-environments/{pre_receive_environment_id}",
  871. "isDeprecated": false,
  872. "description": "",
  873. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#get-a-single-pre-receive-environment",
  874. "previews": [],
  875. "headers": [],
  876. "parameters": [
  877. {
  878. "name": "pre_receive_environment_id",
  879. "description": "pre_receive_environment_id parameter",
  880. "in": "PATH",
  881. "type": "integer",
  882. "required": true,
  883. "enum": null,
  884. "allowNull": false,
  885. "mapToData": null,
  886. "validation": null,
  887. "alias": null,
  888. "deprecated": null
  889. }
  890. ],
  891. "responses": [
  892. {
  893. "code": 200,
  894. "description": "response",
  895. "examples": [
  896. {
  897. "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}"
  898. }
  899. ]
  900. }
  901. ],
  902. "renamed": null
  903. },
  904. {
  905. "name": "Edit a pre-receive environment",
  906. "scope": "enterpriseAdmin",
  907. "id": "updatePreReceiveEnvironment",
  908. "method": "PATCH",
  909. "url": "/admin/pre-receive-environments/{pre_receive_environment_id}",
  910. "isDeprecated": false,
  911. "description": "If you attempt to modify the default environment, you will get a response like this:",
  912. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#edit-a-pre-receive-environment",
  913. "previews": [],
  914. "headers": [],
  915. "parameters": [
  916. {
  917. "name": "pre_receive_environment_id",
  918. "description": "pre_receive_environment_id parameter",
  919. "in": "PATH",
  920. "type": "integer",
  921. "required": true,
  922. "enum": null,
  923. "allowNull": false,
  924. "mapToData": null,
  925. "validation": null,
  926. "alias": null,
  927. "deprecated": null
  928. },
  929. {
  930. "name": "name",
  931. "description": "This pre-receive environment's new name.",
  932. "in": "BODY",
  933. "type": "string",
  934. "required": false,
  935. "enum": null,
  936. "allowNull": false,
  937. "mapToData": null,
  938. "validation": null,
  939. "alias": null,
  940. "deprecated": null
  941. },
  942. {
  943. "name": "image_url",
  944. "description": "URL from which to download a tarball of this environment.",
  945. "in": "BODY",
  946. "type": "string",
  947. "required": false,
  948. "enum": null,
  949. "allowNull": false,
  950. "mapToData": null,
  951. "validation": null,
  952. "alias": null,
  953. "deprecated": null
  954. }
  955. ],
  956. "responses": [
  957. {
  958. "code": 200,
  959. "description": "response",
  960. "examples": [
  961. {
  962. "data": "{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}}"
  963. }
  964. ]
  965. },
  966. {
  967. "code": 422,
  968. "description": "Client Errors",
  969. "examples": [
  970. {
  971. "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}"
  972. }
  973. ]
  974. }
  975. ],
  976. "renamed": null
  977. },
  978. {
  979. "name": "Delete a pre-receive environment",
  980. "scope": "enterpriseAdmin",
  981. "id": "deletePreReceiveEnvironment",
  982. "method": "DELETE",
  983. "url": "/admin/pre-receive-environments/{pre_receive_environment_id}",
  984. "isDeprecated": false,
  985. "description": "If you attempt to delete an environment that cannot be deleted, you will get a response like this:\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_",
  986. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#delete-a-pre-receive-environment",
  987. "previews": [],
  988. "headers": [],
  989. "parameters": [
  990. {
  991. "name": "pre_receive_environment_id",
  992. "description": "pre_receive_environment_id parameter",
  993. "in": "PATH",
  994. "type": "integer",
  995. "required": true,
  996. "enum": null,
  997. "allowNull": false,
  998. "mapToData": null,
  999. "validation": null,
  1000. "alias": null,
  1001. "deprecated": null
  1002. }
  1003. ],
  1004. "responses": [
  1005. {
  1006. "code": 422,
  1007. "description": "Client Errors",
  1008. "examples": [
  1009. {
  1010. "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Cannot modify or delete the default environment\"}]}"
  1011. }
  1012. ]
  1013. }
  1014. ],
  1015. "renamed": null
  1016. },
  1017. {
  1018. "name": "Trigger a pre-receive environment download",
  1019. "scope": "enterpriseAdmin",
  1020. "id": "triggerPreReceiveEnvironmentDownload",
  1021. "method": "POST",
  1022. "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads",
  1023. "isDeprecated": false,
  1024. "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will get a reponse like this:\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_",
  1025. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#trigger-a-pre-receive-environment-download",
  1026. "previews": [],
  1027. "headers": [],
  1028. "parameters": [
  1029. {
  1030. "name": "pre_receive_environment_id",
  1031. "description": "pre_receive_environment_id parameter",
  1032. "in": "PATH",
  1033. "type": "integer",
  1034. "required": true,
  1035. "enum": null,
  1036. "allowNull": false,
  1037. "mapToData": null,
  1038. "validation": null,
  1039. "alias": null,
  1040. "deprecated": null
  1041. }
  1042. ],
  1043. "responses": [
  1044. {
  1045. "code": 202,
  1046. "description": "response",
  1047. "examples": [
  1048. {
  1049. "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"not_started\",\"downloaded_at\":null,\"message\":null}"
  1050. }
  1051. ]
  1052. },
  1053. {
  1054. "code": 422,
  1055. "description": "Client Errors",
  1056. "examples": [
  1057. {
  1058. "data": "{\"message\":\"Validation Failed\",\"errors\":[{\"resource\":\"PreReceiveEnvironment\",\"code\":\"custom\",\"message\":\"Can not start a new download when a download is in progress\"}]}"
  1059. }
  1060. ]
  1061. }
  1062. ],
  1063. "renamed": null
  1064. },
  1065. {
  1066. "name": "Get a pre-receive environment's download status",
  1067. "scope": "enterpriseAdmin",
  1068. "id": "getPreReceiveEnvironmentDownloadStatus",
  1069. "method": "GET",
  1070. "url": "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest",
  1071. "isDeprecated": false,
  1072. "description": "In addition to seeing the download status at the `/admin/pre-receive-environments/:pre_receive_environment_id`, there is also a separate endpoint for just the status.\n\nPossible values for `state` are `not_started`, `in_progress`, `success`, `failed`.",
  1073. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_environments/#get-a-pre-receive-environments-download-status",
  1074. "previews": [],
  1075. "headers": [],
  1076. "parameters": [
  1077. {
  1078. "name": "pre_receive_environment_id",
  1079. "description": "pre_receive_environment_id parameter",
  1080. "in": "PATH",
  1081. "type": "integer",
  1082. "required": true,
  1083. "enum": null,
  1084. "allowNull": false,
  1085. "mapToData": null,
  1086. "validation": null,
  1087. "alias": null,
  1088. "deprecated": null
  1089. },
  1090. {
  1091. "name": "state",
  1092. "description": "The state of the most recent download.",
  1093. "in": "QUERY",
  1094. "type": "string",
  1095. "required": false,
  1096. "enum": null,
  1097. "allowNull": false,
  1098. "mapToData": null,
  1099. "validation": null,
  1100. "alias": null,
  1101. "deprecated": null
  1102. },
  1103. {
  1104. "name": "downloaded_at",
  1105. "description": "The time when the most recent download started.",
  1106. "in": "QUERY",
  1107. "type": "string",
  1108. "required": false,
  1109. "enum": null,
  1110. "allowNull": false,
  1111. "mapToData": null,
  1112. "validation": null,
  1113. "alias": null,
  1114. "deprecated": null
  1115. },
  1116. {
  1117. "name": "message",
  1118. "description": "On failure, this will have any error messages produced.",
  1119. "in": "QUERY",
  1120. "type": "string",
  1121. "required": false,
  1122. "enum": null,
  1123. "allowNull": false,
  1124. "mapToData": null,
  1125. "validation": null,
  1126. "alias": null,
  1127. "deprecated": null
  1128. }
  1129. ],
  1130. "responses": [
  1131. {
  1132. "code": 200,
  1133. "description": "response",
  1134. "examples": [
  1135. {
  1136. "data": "{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/3/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}"
  1137. }
  1138. ]
  1139. }
  1140. ],
  1141. "renamed": null
  1142. },
  1143. {
  1144. "name": "List pre-receive hooks",
  1145. "scope": "enterpriseAdmin",
  1146. "id": "listPreReceiveHooks",
  1147. "method": "GET",
  1148. "url": "/admin/pre-receive-hooks",
  1149. "isDeprecated": false,
  1150. "description": "",
  1151. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_hooks/#list-pre-receive-hooks",
  1152. "previews": [],
  1153. "headers": [],
  1154. "parameters": [
  1155. {
  1156. "name": "per_page",
  1157. "description": "Results per page (max 100)",
  1158. "in": "QUERY",
  1159. "type": "integer",
  1160. "required": false,
  1161. "enum": null,
  1162. "allowNull": false,
  1163. "mapToData": null,
  1164. "validation": null,
  1165. "alias": null,
  1166. "deprecated": null
  1167. },
  1168. {
  1169. "name": "page",
  1170. "description": "Page number of the results to fetch.",
  1171. "in": "QUERY",
  1172. "type": "integer",
  1173. "required": false,
  1174. "enum": null,
  1175. "allowNull": false,
  1176. "mapToData": null,
  1177. "validation": null,
  1178. "alias": null,
  1179. "deprecated": null
  1180. }
  1181. ],
  1182. "responses": [
  1183. {
  1184. "code": 200,
  1185. "description": "response",
  1186. "examples": [
  1187. {
  1188. "data": "[{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}]"
  1189. }
  1190. ]
  1191. }
  1192. ],
  1193. "renamed": null
  1194. },
  1195. {
  1196. "name": "Create a pre-receive hook",
  1197. "scope": "enterpriseAdmin",
  1198. "id": "createPreReceiveHook",
  1199. "method": "POST",
  1200. "url": "/admin/pre-receive-hooks",
  1201. "isDeprecated": false,
  1202. "description": "",
  1203. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_hooks/#create-a-pre-receive-hook",
  1204. "previews": [],
  1205. "headers": [],
  1206. "parameters": [
  1207. {
  1208. "name": "name",
  1209. "description": "The name of the hook.",
  1210. "in": "BODY",
  1211. "type": "string",
  1212. "required": true,
  1213. "enum": null,
  1214. "allowNull": false,
  1215. "mapToData": null,
  1216. "validation": null,
  1217. "alias": null,
  1218. "deprecated": null
  1219. },
  1220. {
  1221. "name": "script",
  1222. "description": "The script that the hook runs.",
  1223. "in": "BODY",
  1224. "type": "string",
  1225. "required": true,
  1226. "enum": null,
  1227. "allowNull": false,
  1228. "mapToData": null,
  1229. "validation": null,
  1230. "alias": null,
  1231. "deprecated": null
  1232. },
  1233. {
  1234. "name": "script_repository",
  1235. "description": "The GitHub repository where the script is kept.",
  1236. "in": "BODY",
  1237. "type": "object",
  1238. "required": true,
  1239. "enum": null,
  1240. "allowNull": false,
  1241. "mapToData": null,
  1242. "validation": null,
  1243. "alias": null,
  1244. "deprecated": null
  1245. },
  1246. {
  1247. "name": "environment",
  1248. "description": "The pre-receive environment where the script is executed.",
  1249. "in": "BODY",
  1250. "type": "object",
  1251. "required": true,
  1252. "enum": null,
  1253. "allowNull": false,
  1254. "mapToData": null,
  1255. "validation": null,
  1256. "alias": null,
  1257. "deprecated": null
  1258. },
  1259. {
  1260. "name": "enforcement",
  1261. "description": "The state of enforcement for this hook. default: `disabled`",
  1262. "in": "BODY",
  1263. "type": "string",
  1264. "required": false,
  1265. "enum": null,
  1266. "allowNull": false,
  1267. "mapToData": null,
  1268. "validation": null,
  1269. "alias": null,
  1270. "deprecated": null
  1271. },
  1272. {
  1273. "name": "allow_downstream_configuration",
  1274. "description": "Whether enforcement can be overridden at the org or repo level. default: `false`",
  1275. "in": "BODY",
  1276. "type": "boolean",
  1277. "required": false,
  1278. "enum": null,
  1279. "allowNull": false,
  1280. "mapToData": null,
  1281. "validation": null,
  1282. "alias": null,
  1283. "deprecated": null
  1284. }
  1285. ],
  1286. "responses": [
  1287. {
  1288. "code": 201,
  1289. "description": "response",
  1290. "examples": [
  1291. {
  1292. "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}"
  1293. }
  1294. ]
  1295. }
  1296. ],
  1297. "renamed": null
  1298. },
  1299. {
  1300. "name": "Get a single pre-receive hook",
  1301. "scope": "enterpriseAdmin",
  1302. "id": "getPreReceiveHook",
  1303. "method": "GET",
  1304. "url": "/admin/pre-receive-hooks/{pre_receive_hook_id}",
  1305. "isDeprecated": false,
  1306. "description": "",
  1307. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_hooks/#get-a-single-pre-receive-hook",
  1308. "previews": [],
  1309. "headers": [],
  1310. "parameters": [
  1311. {
  1312. "name": "pre_receive_hook_id",
  1313. "description": "pre_receive_hook_id parameter",
  1314. "in": "PATH",
  1315. "type": "integer",
  1316. "required": true,
  1317. "enum": null,
  1318. "allowNull": false,
  1319. "mapToData": null,
  1320. "validation": null,
  1321. "alias": null,
  1322. "deprecated": null
  1323. }
  1324. ],
  1325. "responses": [
  1326. {
  1327. "code": 200,
  1328. "description": "response",
  1329. "examples": [
  1330. {
  1331. "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":2,\"name\":\"DevTools Hook Env\",\"image_url\":\"https://my_file_server/path/to/devtools_env.tar.gz\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/2\",\"default_environment\":false,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":false}"
  1332. }
  1333. ]
  1334. }
  1335. ],
  1336. "renamed": null
  1337. },
  1338. {
  1339. "name": "Edit a pre-receive hook",
  1340. "scope": "enterpriseAdmin",
  1341. "id": "updatePreReceiveHook",
  1342. "method": "PATCH",
  1343. "url": "/admin/pre_receive_hooks/{pre_receive_hook_id}",
  1344. "isDeprecated": false,
  1345. "description": "",
  1346. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_hooks/#edit-a-pre-receive-hook",
  1347. "previews": [],
  1348. "headers": [],
  1349. "parameters": [
  1350. {
  1351. "name": "pre_receive_hook_id",
  1352. "description": "pre_receive_hook_id parameter",
  1353. "in": "PATH",
  1354. "type": "integer",
  1355. "required": true,
  1356. "enum": null,
  1357. "allowNull": false,
  1358. "mapToData": null,
  1359. "validation": null,
  1360. "alias": null,
  1361. "deprecated": null
  1362. }
  1363. ],
  1364. "responses": [
  1365. {
  1366. "code": 200,
  1367. "description": "response",
  1368. "examples": [
  1369. {
  1370. "data": "{\"id\":1,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"script\":\"scripts/commmit_check.sh\",\"script_repository\":{\"id\":595,\"full_name\":\"DevIT/hooks\",\"url\":\"https://github.example.com/api/v3/repos/DevIT/hooks\",\"html_url\":\"https://github.example.com/DevIT/hooks\"},\"environment\":{\"id\":1,\"name\":\"Default\",\"image_url\":\"githubenterprise://internal\",\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1\",\"html_url\":\"https://github.example.com/admin/pre-receive-environments/1\",\"default_environment\":true,\"created_at\":\"2016-05-20T11:35:45-05:00\",\"hooks_count\":1,\"download\":{\"url\":\"https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest\",\"state\":\"success\",\"downloaded_at\":\"2016-05-26T07:42:53-05:00\",\"message\":null}},\"allow_downstream_configuration\":true}"
  1371. }
  1372. ]
  1373. }
  1374. ],
  1375. "renamed": null
  1376. },
  1377. {
  1378. "name": "Delete a pre-receive hook",
  1379. "scope": "enterpriseAdmin",
  1380. "id": "deletePreReceiveHook",
  1381. "method": "DELETE",
  1382. "url": "/admin/pre_receive_hooks/{pre_receive_hook_id}",
  1383. "isDeprecated": false,
  1384. "description": "",
  1385. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/pre_receive_hooks/#delete-a-pre-receive-hook",
  1386. "previews": [],
  1387. "headers": [],
  1388. "parameters": [
  1389. {
  1390. "name": "pre_receive_hook_id",
  1391. "description": "pre_receive_hook_id parameter",
  1392. "in": "PATH",
  1393. "type": "integer",
  1394. "required": true,
  1395. "enum": null,
  1396. "allowNull": false,
  1397. "mapToData": null,
  1398. "validation": null,
  1399. "alias": null,
  1400. "deprecated": null
  1401. }
  1402. ],
  1403. "responses": [],
  1404. "renamed": null
  1405. },
  1406. {
  1407. "name": "List personal access tokens",
  1408. "scope": "enterpriseAdmin",
  1409. "id": "listPersonalAccessTokens",
  1410. "method": "GET",
  1411. "url": "/admin/tokens",
  1412. "isDeprecated": false,
  1413. "description": "Lists personal access tokens for all users, including admin users.",
  1414. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#list-personal-access-tokens",
  1415. "previews": [],
  1416. "headers": [],
  1417. "parameters": [
  1418. {
  1419. "name": "per_page",
  1420. "description": "Results per page (max 100)",
  1421. "in": "QUERY",
  1422. "type": "integer",
  1423. "required": false,
  1424. "enum": null,
  1425. "allowNull": false,
  1426. "mapToData": null,
  1427. "validation": null,
  1428. "alias": null,
  1429. "deprecated": null
  1430. },
  1431. {
  1432. "name": "page",
  1433. "description": "Page number of the results to fetch.",
  1434. "in": "QUERY",
  1435. "type": "integer",
  1436. "required": false,
  1437. "enum": null,
  1438. "allowNull": false,
  1439. "mapToData": null,
  1440. "validation": null,
  1441. "alias": null,
  1442. "deprecated": null
  1443. }
  1444. ],
  1445. "responses": [
  1446. {
  1447. "code": 200,
  1448. "description": "response",
  1449. "examples": [
  1450. {
  1451. "data": "[{\"id\":2,\"url\":\"https://enterprise.octocat.com/api/v3/authorizations/2\",\"app\":{\"name\":\"My personal access token\",\"url\":\"https://developer.github.com/enterprise/v3/enterprise-admin/users/#list-personal-access-tokens\",\"client_id\":\"00000000000000000000\"},\"token\":\"\",\"hashed_token\":\"23cffb2fab1b0a62747863eba88cb9327e561f2f7a0c8661c0d9b83146cb8d45\",\"token_last_eight\":\"848f9f8a\",\"note\":\"My personal access token\",\"note_url\":null,\"created_at\":\"2019-04-24T21:49:02Z\",\"updated_at\":\"2019-04-24T21:49:02Z\",\"scopes\":[\"admin:business\",\"admin:gpg_key\",\"admin:org\",\"admin:org_hook\",\"admin:pre_receive_hook\",\"admin:public_key\",\"admin:repo_hook\",\"delete_repo\",\"gist\",\"notifications\",\"repo\",\"user\",\"write:discussion\"],\"fingerprint\":null}]"
  1452. }
  1453. ]
  1454. }
  1455. ],
  1456. "renamed": null
  1457. },
  1458. {
  1459. "name": "Delete a personal access token",
  1460. "scope": "enterpriseAdmin",
  1461. "id": "deletePersonalAccessToken",
  1462. "method": "DELETE",
  1463. "url": "/admin/tokens/{token_id}",
  1464. "isDeprecated": false,
  1465. "description": "Deletes a personal access token. Returns a `403 - Forbidden` status when a personal access token is in use. For example, if you access this endpoint with the same personal access token that you are trying to delete, you will receive this error.",
  1466. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#delete-a-personal-access-token",
  1467. "previews": [],
  1468. "headers": [],
  1469. "parameters": [
  1470. {
  1471. "name": "token_id",
  1472. "description": "token_id parameter",
  1473. "in": "PATH",
  1474. "type": "integer",
  1475. "required": true,
  1476. "enum": null,
  1477. "allowNull": false,
  1478. "mapToData": null,
  1479. "validation": null,
  1480. "alias": null,
  1481. "deprecated": null
  1482. }
  1483. ],
  1484. "responses": [],
  1485. "renamed": null
  1486. },
  1487. {
  1488. "name": "Create a new user",
  1489. "scope": "enterpriseAdmin",
  1490. "id": "createUser",
  1491. "method": "POST",
  1492. "url": "/admin/users",
  1493. "isDeprecated": false,
  1494. "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.",
  1495. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#create-a-new-user",
  1496. "previews": [],
  1497. "headers": [],
  1498. "parameters": [
  1499. {
  1500. "name": "login",
  1501. "description": "The user's username.",
  1502. "in": "BODY",
  1503. "type": "string",
  1504. "required": true,
  1505. "enum": null,
  1506. "allowNull": false,
  1507. "mapToData": null,
  1508. "validation": null,
  1509. "alias": null,
  1510. "deprecated": null
  1511. },
  1512. {
  1513. "name": "email",
  1514. "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub Enterprise Server authentication guide](https://help.github.com/enterprise/2.17/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).",
  1515. "in": "BODY",
  1516. "type": "string",
  1517. "required": false,
  1518. "enum": null,
  1519. "allowNull": false,
  1520. "mapToData": null,
  1521. "validation": null,
  1522. "alias": null,
  1523. "deprecated": null
  1524. }
  1525. ],
  1526. "responses": [
  1527. {
  1528. "code": 201,
  1529. "description": "response",
  1530. "examples": [
  1531. {
  1532. "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}"
  1533. }
  1534. ]
  1535. }
  1536. ],
  1537. "renamed": null
  1538. },
  1539. {
  1540. "name": "Rename an existing user",
  1541. "scope": "enterpriseAdmin",
  1542. "id": "renameUser",
  1543. "method": "PATCH",
  1544. "url": "/admin/users/{username}",
  1545. "isDeprecated": false,
  1546. "description": "",
  1547. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#rename-an-existing-user",
  1548. "previews": [],
  1549. "headers": [],
  1550. "parameters": [
  1551. {
  1552. "name": "username",
  1553. "description": "username parameter",
  1554. "in": "PATH",
  1555. "type": "string",
  1556. "required": true,
  1557. "enum": null,
  1558. "allowNull": false,
  1559. "mapToData": null,
  1560. "validation": null,
  1561. "alias": null,
  1562. "deprecated": null
  1563. },
  1564. {
  1565. "name": "login",
  1566. "description": "The user's new username.",
  1567. "in": "BODY",
  1568. "type": "string",
  1569. "required": true,
  1570. "enum": null,
  1571. "allowNull": false,
  1572. "mapToData": null,
  1573. "validation": null,
  1574. "alias": null,
  1575. "deprecated": null
  1576. }
  1577. ],
  1578. "responses": [
  1579. {
  1580. "code": 202,
  1581. "description": "response",
  1582. "examples": [
  1583. {
  1584. "data": "{\"message\":\"Job queued to rename user. It may take a few minutes to complete.\",\"url\":\"https://api.github.com/user/1\"}"
  1585. }
  1586. ]
  1587. }
  1588. ],
  1589. "renamed": null
  1590. },
  1591. {
  1592. "name": "Delete a user",
  1593. "scope": "enterpriseAdmin",
  1594. "id": "deleteUser",
  1595. "method": "DELETE",
  1596. "url": "/admin/users/{username}",
  1597. "isDeprecated": false,
  1598. "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.",
  1599. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#delete-a-user",
  1600. "previews": [],
  1601. "headers": [],
  1602. "parameters": [
  1603. {
  1604. "name": "username",
  1605. "description": "username parameter",
  1606. "in": "PATH",
  1607. "type": "string",
  1608. "required": true,
  1609. "enum": null,
  1610. "allowNull": false,
  1611. "mapToData": null,
  1612. "validation": null,
  1613. "alias": null,
  1614. "deprecated": null
  1615. }
  1616. ],
  1617. "responses": [],
  1618. "renamed": null
  1619. },
  1620. {
  1621. "name": "Create an impersonation OAuth token",
  1622. "scope": "enterpriseAdmin",
  1623. "id": "createImpersonationOAuthToken",
  1624. "method": "POST",
  1625. "url": "/admin/users/{username}/authorizations",
  1626. "isDeprecated": false,
  1627. "description": "",
  1628. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#create-an-impersonation-oauth-token",
  1629. "previews": [],
  1630. "headers": [],
  1631. "parameters": [
  1632. {
  1633. "name": "username",
  1634. "description": "username parameter",
  1635. "in": "PATH",
  1636. "type": "string",
  1637. "required": true,
  1638. "enum": null,
  1639. "allowNull": false,
  1640. "mapToData": null,
  1641. "validation": null,
  1642. "alias": null,
  1643. "deprecated": null
  1644. },
  1645. {
  1646. "name": "scopes",
  1647. "description": "A list of [scopes](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  1648. "in": "BODY",
  1649. "type": "string[]",
  1650. "required": false,
  1651. "enum": null,
  1652. "allowNull": false,
  1653. "mapToData": null,
  1654. "validation": null,
  1655. "alias": null,
  1656. "deprecated": null
  1657. }
  1658. ],
  1659. "responses": [
  1660. {
  1661. "code": 201,
  1662. "description": "response",
  1663. "examples": [
  1664. {
  1665. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  1666. }
  1667. ]
  1668. }
  1669. ],
  1670. "renamed": null
  1671. },
  1672. {
  1673. "name": "Delete an impersonation OAuth token",
  1674. "scope": "enterpriseAdmin",
  1675. "id": "deleteImpersonationOAuthToken",
  1676. "method": "DELETE",
  1677. "url": "/admin/users/{username}/authorizations",
  1678. "isDeprecated": false,
  1679. "description": "",
  1680. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token",
  1681. "previews": [],
  1682. "headers": [],
  1683. "parameters": [
  1684. {
  1685. "name": "username",
  1686. "description": "username parameter",
  1687. "in": "PATH",
  1688. "type": "string",
  1689. "required": true,
  1690. "enum": null,
  1691. "allowNull": false,
  1692. "mapToData": null,
  1693. "validation": null,
  1694. "alias": null,
  1695. "deprecated": null
  1696. }
  1697. ],
  1698. "responses": [],
  1699. "renamed": null
  1700. },
  1701. {
  1702. "name": "Get the authenticated GitHub App",
  1703. "scope": "apps",
  1704. "id": "getAuthenticated",
  1705. "method": "GET",
  1706. "url": "/app",
  1707. "isDeprecated": false,
  1708. "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations](https://developer.github.com/enterprise/2.17/v3/apps/#list-installations)\" endpoint.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  1709. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-the-authenticated-github-app",
  1710. "previews": [{ "name": "machine-man" }],
  1711. "headers": [
  1712. {
  1713. "name": "accept",
  1714. "value": "application/vnd.github.machine-man-preview+json"
  1715. }
  1716. ],
  1717. "parameters": [],
  1718. "responses": [
  1719. {
  1720. "code": 200,
  1721. "description": "response",
  1722. "examples": [
  1723. {
  1724. "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"installations_count\":3}"
  1725. }
  1726. ]
  1727. }
  1728. ],
  1729. "renamed": null
  1730. },
  1731. {
  1732. "name": "Create a GitHub App from a manifest",
  1733. "scope": "apps",
  1734. "id": "createFromManifest",
  1735. "method": "POST",
  1736. "url": "/app-manifests/{code}/conversions",
  1737. "isDeprecated": false,
  1738. "description": "Use this endpoint to complete the handshake necessary when implementing the [GitHub App Manifest flow](https://developer.github.com/enterprise/2.17/apps/building-github-apps/creating-github-apps-from-a-manifest/). When you create a GitHub App with the manifest flow, you receive a temporary `code` used to retrieve the GitHub App's `id`, `pem` (private key), and `webhook_secret`.",
  1739. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#create-a-github-app-from-a-manifest",
  1740. "previews": [{ "name": "fury" }],
  1741. "headers": [
  1742. { "name": "accept", "value": "application/vnd.github.fury-preview+json" }
  1743. ],
  1744. "parameters": [
  1745. {
  1746. "name": "code",
  1747. "description": "code parameter",
  1748. "in": "PATH",
  1749. "type": "string",
  1750. "required": true,
  1751. "enum": null,
  1752. "allowNull": false,
  1753. "mapToData": null,
  1754. "validation": null,
  1755. "alias": null,
  1756. "deprecated": null
  1757. }
  1758. ],
  1759. "responses": [
  1760. {
  1761. "code": 200,
  1762. "description": "response",
  1763. "examples": [
  1764. {
  1765. "data": "{\"id\":1,\"node_id\":\"MDM6QXBwNTk=\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"name\":\"octoapp\",\"description\":null,\"external_url\":\"https://www.example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2018-09-13T12:28:37Z\",\"updated_at\":\"2018-09-13T12:28:37Z\",\"client_id\":\"Iv1.8a61f9b3a7aba766\",\"client_secret\":\"1726be1638095a19edd134c77bde3aa2ece1e5d8\",\"webhook_secret\":\"e340154128314309424b7c8e90325147d99fdafa\",\"pem\":\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEowIBAAKCAQEAuEPzOUE+kiEH1WLiMeBytTEF856j0hOVcSUSUkZxKvqczkWM\\n9vo1gDyC7ZXhdH9fKh32aapba3RSsp4ke+giSmYTk2mGR538ShSDxh0OgpJmjiKP\\nX0Bj4j5sFqfXuCtl9SkH4iueivv4R53ktqM+n6hk98l6hRwC39GVIblAh2lEM4L/\\n6WvYwuQXPMM5OG2Ryh2tDZ1WS5RKfgq+9ksNJ5Q9UtqtqHkO+E63N5OK9sbzpUUm\\noNaOl3udTlZD3A8iqwMPVxH4SxgATBPAc+bmjk6BMJ0qIzDcVGTrqrzUiywCTLma\\nszdk8GjzXtPDmuBgNn+o6s02qVGpyydgEuqmTQIDAQABAoIBACL6AvkjQVVLn8kJ\\ndBYznJJ4M8ECo+YEgaFwgAHODT0zRQCCgzd+Vxl4YwHmKV2Lr+y2s0drZt8GvYva\\nKOK8NYYZyi15IlwFyRXmvvykF1UBpSXluYFDH7KaVroWMgRreHcIys5LqVSIb6Bo\\ngDmK0yBLPp8qR29s2b7ScZRtLaqGJiX+j55rNzrZwxHkxFHyG9OG+u9IsBElcKCP\\nkYCVE8ZdYexfnKOZbgn2kZB9qu0T/Mdvki8yk3I2bI6xYO24oQmhnT36qnqWoCBX\\nNuCNsBQgpYZeZET8mEAUmo9d+ABmIHIvSs005agK8xRaP4+6jYgy6WwoejJRF5yd\\nNBuF7aECgYEA50nZ4FiZYV0vcJDxFYeY3kYOvVuKn8OyW+2rg7JIQTremIjv8FkE\\nZnwuF9ZRxgqLxUIfKKfzp/5l5LrycNoj2YKfHKnRejxRWXqG+ZETfxxlmlRns0QG\\nJ4+BYL0CoanDSeA4fuyn4Bv7cy/03TDhfg/Uq0Aeg+hhcPE/vx3ebPsCgYEAy/Pv\\neDLssOSdeyIxf0Brtocg6aPXIVaLdus+bXmLg77rJIFytAZmTTW8SkkSczWtucI3\\nFI1I6sei/8FdPzAl62/JDdlf7Wd9K7JIotY4TzT7Tm7QU7xpfLLYIP1bOFjN81rk\\n77oOD4LsXcosB/U6s1blPJMZ6AlO2EKs10UuR1cCgYBipzuJ2ADEaOz9RLWwi0AH\\nPza2Sj+c2epQD9ZivD7Zo/Sid3ZwvGeGF13JyR7kLEdmAkgsHUdu1rI7mAolXMaB\\n1pdrsHureeLxGbRM6za3tzMXWv1Il7FQWoPC8ZwXvMOR1VQDv4nzq7vbbA8z8c+c\\n57+8tALQHOTDOgQIzwK61QKBgERGVc0EJy4Uag+VY8J4m1ZQKBluqo7TfP6DQ7O8\\nM5MX73maB/7yAX8pVO39RjrhJlYACRZNMbK+v/ckEQYdJSSKmGCVe0JrGYDuPtic\\nI9+IGfSorf7KHPoMmMN6bPYQ7Gjh7a++tgRFTMEc8956Hnt4xGahy9NcglNtBpVN\\n6G8jAoGBAMCh028pdzJa/xeBHLLaVB2sc0Fe7993WlsPmnVE779dAz7qMscOtXJK\\nfgtriltLSSD6rTA9hUAsL/X62rY0wdXuNdijjBb/qvrx7CAV6i37NK1CjABNjsfG\\nZM372Ac6zc1EqSrid2IjET1YqyIW2KGLI1R2xbQc98UGlt48OdWu\\n-----END RSA PRIVATE KEY-----\\n\"}"
  1766. }
  1767. ]
  1768. }
  1769. ],
  1770. "renamed": null
  1771. },
  1772. {
  1773. "name": "List installations",
  1774. "scope": "apps",
  1775. "id": "listInstallations",
  1776. "method": "GET",
  1777. "url": "/app/installations",
  1778. "isDeprecated": false,
  1779. "description": "You must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.",
  1780. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#list-installations",
  1781. "previews": [{ "name": "machine-man" }],
  1782. "headers": [
  1783. {
  1784. "name": "accept",
  1785. "value": "application/vnd.github.machine-man-preview+json"
  1786. }
  1787. ],
  1788. "parameters": [
  1789. {
  1790. "name": "per_page",
  1791. "description": "Results per page (max 100)",
  1792. "in": "QUERY",
  1793. "type": "integer",
  1794. "required": false,
  1795. "enum": null,
  1796. "allowNull": false,
  1797. "mapToData": null,
  1798. "validation": null,
  1799. "alias": null,
  1800. "deprecated": null
  1801. },
  1802. {
  1803. "name": "page",
  1804. "description": "Page number of the results to fetch.",
  1805. "in": "QUERY",
  1806. "type": "integer",
  1807. "required": false,
  1808. "enum": null,
  1809. "allowNull": false,
  1810. "mapToData": null,
  1811. "validation": null,
  1812. "alias": null,
  1813. "deprecated": null
  1814. }
  1815. ],
  1816. "responses": [
  1817. {
  1818. "code": 200,
  1819. "description": "The permissions the installation has are included under the `permissions` key.",
  1820. "examples": [
  1821. {
  1822. "data": "[{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yml\",\"repository_selection\":\"selected\"}]"
  1823. }
  1824. ]
  1825. }
  1826. ],
  1827. "renamed": null
  1828. },
  1829. {
  1830. "name": "Get an installation",
  1831. "scope": "apps",
  1832. "id": "getInstallation",
  1833. "method": "GET",
  1834. "url": "/app/installations/{installation_id}",
  1835. "isDeprecated": false,
  1836. "description": "You must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  1837. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-an-installation",
  1838. "previews": [{ "name": "machine-man" }],
  1839. "headers": [
  1840. {
  1841. "name": "accept",
  1842. "value": "application/vnd.github.machine-man-preview+json"
  1843. }
  1844. ],
  1845. "parameters": [
  1846. {
  1847. "name": "installation_id",
  1848. "description": "installation_id parameter",
  1849. "in": "PATH",
  1850. "type": "integer",
  1851. "required": true,
  1852. "enum": null,
  1853. "allowNull": false,
  1854. "mapToData": null,
  1855. "validation": null,
  1856. "alias": null,
  1857. "deprecated": null
  1858. }
  1859. ],
  1860. "responses": [
  1861. {
  1862. "code": 200,
  1863. "description": "response",
  1864. "examples": [
  1865. {
  1866. "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yml\",\"repository_selection\":\"selected\"}"
  1867. }
  1868. ]
  1869. }
  1870. ],
  1871. "renamed": null
  1872. },
  1873. {
  1874. "name": "Delete an installation",
  1875. "scope": "apps",
  1876. "id": "deleteInstallation",
  1877. "method": "DELETE",
  1878. "url": "/app/installations/{installation_id}",
  1879. "isDeprecated": false,
  1880. "description": "Uninstalls a GitHub App on a user, organization, or business account.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  1881. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#delete-an-installation",
  1882. "previews": [{ "name": "gambit" }, { "name": "machine-man" }],
  1883. "headers": [
  1884. {
  1885. "name": "accept",
  1886. "value": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json"
  1887. }
  1888. ],
  1889. "parameters": [
  1890. {
  1891. "name": "installation_id",
  1892. "description": "installation_id parameter",
  1893. "in": "PATH",
  1894. "type": "integer",
  1895. "required": true,
  1896. "enum": null,
  1897. "allowNull": false,
  1898. "mapToData": null,
  1899. "validation": null,
  1900. "alias": null,
  1901. "deprecated": null
  1902. }
  1903. ],
  1904. "responses": [],
  1905. "renamed": null
  1906. },
  1907. {
  1908. "name": "Create a new installation token",
  1909. "scope": "apps",
  1910. "id": "createInstallationToken",
  1911. "method": "POST",
  1912. "url": "/app/installations/{installation_id}/access_tokens",
  1913. "isDeprecated": false,
  1914. "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token.\n\nBy default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the `repository_ids` when creating the token. When you omit `repository_ids`, the response does not contain the `repositories` key.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThis example grants the token \"Read and write\" permission to `issues` and \"Read\" permission to `contents`, and restricts the token's access to the repository with an `id` of 1296269.",
  1915. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#create-a-new-installation-token",
  1916. "previews": [{ "name": "machine-man" }],
  1917. "headers": [
  1918. {
  1919. "name": "accept",
  1920. "value": "application/vnd.github.machine-man-preview+json"
  1921. }
  1922. ],
  1923. "parameters": [
  1924. {
  1925. "name": "installation_id",
  1926. "description": "installation_id parameter",
  1927. "in": "PATH",
  1928. "type": "integer",
  1929. "required": true,
  1930. "enum": null,
  1931. "allowNull": false,
  1932. "mapToData": null,
  1933. "validation": null,
  1934. "alias": null,
  1935. "deprecated": null
  1936. },
  1937. {
  1938. "name": "repository_ids",
  1939. "description": "The `id`s of the repositories that the installation token can access. Providing repository `id`s restricts the access of an installation token to specific repositories. You can use the \"[List repositories](https://developer.github.com/enterprise/2.17/v3/apps/installations/#list-repositories)\" endpoint to get the `id` of all repositories that an installation can access. For example, you can select specific repositories when creating an installation token to restrict the number of repositories that can be cloned using the token.",
  1940. "in": "BODY",
  1941. "type": "integer[]",
  1942. "required": false,
  1943. "enum": null,
  1944. "allowNull": false,
  1945. "mapToData": null,
  1946. "validation": null,
  1947. "alias": null,
  1948. "deprecated": null
  1949. },
  1950. {
  1951. "name": "permissions",
  1952. "description": "The permissions granted to the access token. The permissions object includes the permission names and their access type. For a complete list of permissions and allowable values, see \"[GitHub App permissions](https://developer.github.com/enterprise/2.17/apps/building-github-apps/creating-github-apps-using-url-parameters/#github-app-permissions).\"",
  1953. "in": "BODY",
  1954. "type": "object",
  1955. "required": false,
  1956. "enum": null,
  1957. "allowNull": false,
  1958. "mapToData": null,
  1959. "validation": null,
  1960. "alias": null,
  1961. "deprecated": null
  1962. }
  1963. ],
  1964. "responses": [
  1965. {
  1966. "code": 201,
  1967. "description": "response",
  1968. "examples": [
  1969. {
  1970. "data": "{\"token\":\"v1.1f699f1069f60xxx\",\"expires_at\":\"2016-07-11T22:14:10Z\",\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}]}"
  1971. }
  1972. ]
  1973. }
  1974. ],
  1975. "renamed": null
  1976. },
  1977. {
  1978. "name": "List your grants",
  1979. "scope": "oauthAuthorizations",
  1980. "id": "listGrants",
  1981. "method": "GET",
  1982. "url": "/applications/grants",
  1983. "isDeprecated": false,
  1984. "description": "You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.",
  1985. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#list-your-grants",
  1986. "previews": [],
  1987. "headers": [],
  1988. "parameters": [
  1989. {
  1990. "name": "per_page",
  1991. "description": "Results per page (max 100)",
  1992. "in": "QUERY",
  1993. "type": "integer",
  1994. "required": false,
  1995. "enum": null,
  1996. "allowNull": false,
  1997. "mapToData": null,
  1998. "validation": null,
  1999. "alias": null,
  2000. "deprecated": null
  2001. },
  2002. {
  2003. "name": "page",
  2004. "description": "Page number of the results to fetch.",
  2005. "in": "QUERY",
  2006. "type": "integer",
  2007. "required": false,
  2008. "enum": null,
  2009. "allowNull": false,
  2010. "mapToData": null,
  2011. "validation": null,
  2012. "alias": null,
  2013. "deprecated": null
  2014. }
  2015. ],
  2016. "responses": [
  2017. {
  2018. "code": 200,
  2019. "description": "response",
  2020. "examples": [
  2021. {
  2022. "data": "[{\"id\":1,\"url\":\"https://api.github.com/applications/grants/1\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"created_at\":\"2011-09-06T17:26:27Z\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"scopes\":[\"public_repo\"]}]"
  2023. }
  2024. ]
  2025. }
  2026. ],
  2027. "renamed": null
  2028. },
  2029. {
  2030. "name": "Get a single grant",
  2031. "scope": "oauthAuthorizations",
  2032. "id": "getGrant",
  2033. "method": "GET",
  2034. "url": "/applications/grants/{grant_id}",
  2035. "isDeprecated": false,
  2036. "description": "",
  2037. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#get-a-single-grant",
  2038. "previews": [],
  2039. "headers": [],
  2040. "parameters": [
  2041. {
  2042. "name": "grant_id",
  2043. "description": "grant_id parameter",
  2044. "in": "PATH",
  2045. "type": "integer",
  2046. "required": true,
  2047. "enum": null,
  2048. "allowNull": false,
  2049. "mapToData": null,
  2050. "validation": null,
  2051. "alias": null,
  2052. "deprecated": null
  2053. }
  2054. ],
  2055. "responses": [
  2056. {
  2057. "code": 200,
  2058. "description": "response",
  2059. "examples": [
  2060. {
  2061. "data": "{\"id\":1,\"url\":\"https://api.github.com/applications/grants/1\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"created_at\":\"2011-09-06T17:26:27Z\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"scopes\":[\"public_repo\"]}"
  2062. }
  2063. ]
  2064. }
  2065. ],
  2066. "renamed": null
  2067. },
  2068. {
  2069. "name": "Delete a grant",
  2070. "scope": "oauthAuthorizations",
  2071. "id": "deleteGrant",
  2072. "method": "DELETE",
  2073. "url": "/applications/grants/{grant_id}",
  2074. "isDeprecated": false,
  2075. "description": "Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
  2076. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#delete-a-grant",
  2077. "previews": [],
  2078. "headers": [],
  2079. "parameters": [
  2080. {
  2081. "name": "grant_id",
  2082. "description": "grant_id parameter",
  2083. "in": "PATH",
  2084. "type": "integer",
  2085. "required": true,
  2086. "enum": null,
  2087. "allowNull": false,
  2088. "mapToData": null,
  2089. "validation": null,
  2090. "alias": null,
  2091. "deprecated": null
  2092. }
  2093. ],
  2094. "responses": [],
  2095. "renamed": null
  2096. },
  2097. {
  2098. "name": "Revoke a grant for an application",
  2099. "scope": "oauthAuthorizations",
  2100. "id": "revokeGrantForApplication",
  2101. "method": "DELETE",
  2102. "url": "/applications/{client_id}/grants/{access_token}",
  2103. "isDeprecated": false,
  2104. "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).",
  2105. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#revoke-a-grant-for-an-application",
  2106. "previews": [],
  2107. "headers": [],
  2108. "parameters": [
  2109. {
  2110. "name": "client_id",
  2111. "description": "client_id parameter",
  2112. "in": "PATH",
  2113. "type": "string",
  2114. "required": true,
  2115. "enum": null,
  2116. "allowNull": false,
  2117. "mapToData": null,
  2118. "validation": null,
  2119. "alias": null,
  2120. "deprecated": null
  2121. },
  2122. {
  2123. "name": "access_token",
  2124. "description": "access_token parameter",
  2125. "in": "PATH",
  2126. "type": "string",
  2127. "required": true,
  2128. "enum": null,
  2129. "allowNull": false,
  2130. "mapToData": null,
  2131. "validation": null,
  2132. "alias": null,
  2133. "deprecated": null
  2134. }
  2135. ],
  2136. "responses": [],
  2137. "renamed": null
  2138. },
  2139. {
  2140. "name": "Check an authorization",
  2141. "scope": "oauthAuthorizations",
  2142. "id": "checkAuthorization",
  2143. "method": "GET",
  2144. "url": "/applications/{client_id}/tokens/{access_token}",
  2145. "isDeprecated": false,
  2146. "description": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
  2147. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#check-an-authorization",
  2148. "previews": [],
  2149. "headers": [],
  2150. "parameters": [
  2151. {
  2152. "name": "client_id",
  2153. "description": "client_id parameter",
  2154. "in": "PATH",
  2155. "type": "string",
  2156. "required": true,
  2157. "enum": null,
  2158. "allowNull": false,
  2159. "mapToData": null,
  2160. "validation": null,
  2161. "alias": null,
  2162. "deprecated": null
  2163. },
  2164. {
  2165. "name": "access_token",
  2166. "description": "access_token parameter",
  2167. "in": "PATH",
  2168. "type": "string",
  2169. "required": true,
  2170. "enum": null,
  2171. "allowNull": false,
  2172. "mapToData": null,
  2173. "validation": null,
  2174. "alias": null,
  2175. "deprecated": null
  2176. }
  2177. ],
  2178. "responses": [
  2179. {
  2180. "code": 200,
  2181. "description": "response",
  2182. "examples": [
  2183. {
  2184. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  2185. }
  2186. ]
  2187. }
  2188. ],
  2189. "renamed": null
  2190. },
  2191. {
  2192. "name": "Reset an authorization",
  2193. "scope": "oauthAuthorizations",
  2194. "id": "resetAuthorization",
  2195. "method": "POST",
  2196. "url": "/applications/{client_id}/tokens/{access_token}",
  2197. "isDeprecated": false,
  2198. "description": "OAuth applications can use this API method to reset a valid OAuth token without end user involvement. Applications must save the \"token\" property in the response, because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.",
  2199. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#reset-an-authorization",
  2200. "previews": [],
  2201. "headers": [],
  2202. "parameters": [
  2203. {
  2204. "name": "client_id",
  2205. "description": "client_id parameter",
  2206. "in": "PATH",
  2207. "type": "string",
  2208. "required": true,
  2209. "enum": null,
  2210. "allowNull": false,
  2211. "mapToData": null,
  2212. "validation": null,
  2213. "alias": null,
  2214. "deprecated": null
  2215. },
  2216. {
  2217. "name": "access_token",
  2218. "description": "access_token parameter",
  2219. "in": "PATH",
  2220. "type": "string",
  2221. "required": true,
  2222. "enum": null,
  2223. "allowNull": false,
  2224. "mapToData": null,
  2225. "validation": null,
  2226. "alias": null,
  2227. "deprecated": null
  2228. }
  2229. ],
  2230. "responses": [
  2231. {
  2232. "code": 200,
  2233. "description": "response",
  2234. "examples": [
  2235. {
  2236. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  2237. }
  2238. ]
  2239. }
  2240. ],
  2241. "renamed": null
  2242. },
  2243. {
  2244. "name": "Revoke an authorization for an application",
  2245. "scope": "oauthAuthorizations",
  2246. "id": "revokeAuthorizationForApplication",
  2247. "method": "DELETE",
  2248. "url": "/applications/{client_id}/tokens/{access_token}",
  2249. "isDeprecated": false,
  2250. "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`.",
  2251. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#revoke-an-authorization-for-an-application",
  2252. "previews": [],
  2253. "headers": [],
  2254. "parameters": [
  2255. {
  2256. "name": "client_id",
  2257. "description": "client_id parameter",
  2258. "in": "PATH",
  2259. "type": "string",
  2260. "required": true,
  2261. "enum": null,
  2262. "allowNull": false,
  2263. "mapToData": null,
  2264. "validation": null,
  2265. "alias": null,
  2266. "deprecated": null
  2267. },
  2268. {
  2269. "name": "access_token",
  2270. "description": "access_token parameter",
  2271. "in": "PATH",
  2272. "type": "string",
  2273. "required": true,
  2274. "enum": null,
  2275. "allowNull": false,
  2276. "mapToData": null,
  2277. "validation": null,
  2278. "alias": null,
  2279. "deprecated": null
  2280. }
  2281. ],
  2282. "responses": [],
  2283. "renamed": null
  2284. },
  2285. {
  2286. "name": "Get a single GitHub App",
  2287. "scope": "apps",
  2288. "id": "getBySlug",
  2289. "method": "GET",
  2290. "url": "/apps/{app_slug}",
  2291. "isDeprecated": false,
  2292. "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
  2293. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-a-single-github-app",
  2294. "previews": [{ "name": "machine-man" }],
  2295. "headers": [
  2296. {
  2297. "name": "accept",
  2298. "value": "application/vnd.github.machine-man-preview+json"
  2299. }
  2300. ],
  2301. "parameters": [
  2302. {
  2303. "name": "app_slug",
  2304. "description": "app_slug parameter",
  2305. "in": "PATH",
  2306. "type": "string",
  2307. "required": true,
  2308. "enum": null,
  2309. "allowNull": false,
  2310. "mapToData": null,
  2311. "validation": null,
  2312. "alias": null,
  2313. "deprecated": null
  2314. }
  2315. ],
  2316. "responses": [
  2317. {
  2318. "code": 200,
  2319. "description": "response",
  2320. "examples": [
  2321. {
  2322. "data": "{\"id\":1,\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}"
  2323. }
  2324. ]
  2325. }
  2326. ],
  2327. "renamed": null
  2328. },
  2329. {
  2330. "name": "List your authorizations",
  2331. "scope": "oauthAuthorizations",
  2332. "id": "listAuthorizations",
  2333. "method": "GET",
  2334. "url": "/authorizations",
  2335. "isDeprecated": false,
  2336. "description": "",
  2337. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#list-your-authorizations",
  2338. "previews": [],
  2339. "headers": [],
  2340. "parameters": [
  2341. {
  2342. "name": "per_page",
  2343. "description": "Results per page (max 100)",
  2344. "in": "QUERY",
  2345. "type": "integer",
  2346. "required": false,
  2347. "enum": null,
  2348. "allowNull": false,
  2349. "mapToData": null,
  2350. "validation": null,
  2351. "alias": null,
  2352. "deprecated": null
  2353. },
  2354. {
  2355. "name": "page",
  2356. "description": "Page number of the results to fetch.",
  2357. "in": "QUERY",
  2358. "type": "integer",
  2359. "required": false,
  2360. "enum": null,
  2361. "allowNull": false,
  2362. "mapToData": null,
  2363. "validation": null,
  2364. "alias": null,
  2365. "deprecated": null
  2366. }
  2367. ],
  2368. "responses": [
  2369. {
  2370. "code": 200,
  2371. "description": "response",
  2372. "examples": [
  2373. {
  2374. "data": "[{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}]"
  2375. }
  2376. ]
  2377. }
  2378. ],
  2379. "renamed": null
  2380. },
  2381. {
  2382. "name": "Create a new authorization",
  2383. "scope": "oauthAuthorizations",
  2384. "id": "createAuthorization",
  2385. "method": "POST",
  2386. "url": "/authorizations",
  2387. "isDeprecated": false,
  2388. "description": "Creates OAuth tokens using [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/enterprise/2.17/v3/auth/#working-with-two-factor-authentication).\"\n\nYou can use this endpoint to create multiple OAuth tokens instead of implementing the [web flow](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/authorizing-oauth-apps/).\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).",
  2389. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#create-a-new-authorization",
  2390. "previews": [],
  2391. "headers": [],
  2392. "parameters": [
  2393. {
  2394. "name": "scopes",
  2395. "description": "A list of scopes that this authorization is in.",
  2396. "in": "BODY",
  2397. "type": "string[]",
  2398. "required": false,
  2399. "enum": null,
  2400. "allowNull": false,
  2401. "mapToData": null,
  2402. "validation": null,
  2403. "alias": null,
  2404. "deprecated": null
  2405. },
  2406. {
  2407. "name": "note",
  2408. "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.",
  2409. "in": "BODY",
  2410. "type": "string",
  2411. "required": true,
  2412. "enum": null,
  2413. "allowNull": false,
  2414. "mapToData": null,
  2415. "validation": null,
  2416. "alias": null,
  2417. "deprecated": null
  2418. },
  2419. {
  2420. "name": "note_url",
  2421. "description": "A URL to remind you what app the OAuth token is for.",
  2422. "in": "BODY",
  2423. "type": "string",
  2424. "required": false,
  2425. "enum": null,
  2426. "allowNull": false,
  2427. "mapToData": null,
  2428. "validation": null,
  2429. "alias": null,
  2430. "deprecated": null
  2431. },
  2432. {
  2433. "name": "client_id",
  2434. "description": "The 20 character OAuth app client key for which to create the token.",
  2435. "in": "BODY",
  2436. "type": "string",
  2437. "required": false,
  2438. "enum": null,
  2439. "allowNull": false,
  2440. "mapToData": null,
  2441. "validation": null,
  2442. "alias": null,
  2443. "deprecated": null
  2444. },
  2445. {
  2446. "name": "client_secret",
  2447. "description": "The 40 character OAuth app client secret for which to create the token.",
  2448. "in": "BODY",
  2449. "type": "string",
  2450. "required": false,
  2451. "enum": null,
  2452. "allowNull": false,
  2453. "mapToData": null,
  2454. "validation": null,
  2455. "alias": null,
  2456. "deprecated": null
  2457. },
  2458. {
  2459. "name": "fingerprint",
  2460. "description": "A unique string to distinguish an authorization from others created for the same client ID and user.",
  2461. "in": "BODY",
  2462. "type": "string",
  2463. "required": false,
  2464. "enum": null,
  2465. "allowNull": false,
  2466. "mapToData": null,
  2467. "validation": null,
  2468. "alias": null,
  2469. "deprecated": null
  2470. }
  2471. ],
  2472. "responses": [
  2473. {
  2474. "code": 201,
  2475. "description": "response",
  2476. "examples": [
  2477. {
  2478. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"\"}"
  2479. }
  2480. ]
  2481. }
  2482. ],
  2483. "renamed": null
  2484. },
  2485. {
  2486. "name": "Get-or-create an authorization for a specific app",
  2487. "scope": "oauthAuthorizations",
  2488. "id": "getOrCreateAuthorizationForApp",
  2489. "method": "PUT",
  2490. "url": "/authorizations/clients/{client_id}",
  2491. "isDeprecated": false,
  2492. "description": "Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/enterprise/2.17/v3/auth/#working-with-two-factor-authentication).\"",
  2493. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app",
  2494. "previews": [],
  2495. "headers": [],
  2496. "parameters": [
  2497. {
  2498. "name": "client_id",
  2499. "description": "client_id parameter",
  2500. "in": "PATH",
  2501. "type": "string",
  2502. "required": true,
  2503. "enum": null,
  2504. "allowNull": false,
  2505. "mapToData": null,
  2506. "validation": null,
  2507. "alias": null,
  2508. "deprecated": null
  2509. },
  2510. {
  2511. "name": "client_secret",
  2512. "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.",
  2513. "in": "BODY",
  2514. "type": "string",
  2515. "required": true,
  2516. "enum": null,
  2517. "allowNull": false,
  2518. "mapToData": null,
  2519. "validation": null,
  2520. "alias": null,
  2521. "deprecated": null
  2522. },
  2523. {
  2524. "name": "scopes",
  2525. "description": "A list of scopes that this authorization is in.",
  2526. "in": "BODY",
  2527. "type": "string[]",
  2528. "required": false,
  2529. "enum": null,
  2530. "allowNull": false,
  2531. "mapToData": null,
  2532. "validation": null,
  2533. "alias": null,
  2534. "deprecated": null
  2535. },
  2536. {
  2537. "name": "note",
  2538. "description": "A note to remind you what the OAuth token is for.",
  2539. "in": "BODY",
  2540. "type": "string",
  2541. "required": false,
  2542. "enum": null,
  2543. "allowNull": false,
  2544. "mapToData": null,
  2545. "validation": null,
  2546. "alias": null,
  2547. "deprecated": null
  2548. },
  2549. {
  2550. "name": "note_url",
  2551. "description": "A URL to remind you what app the OAuth token is for.",
  2552. "in": "BODY",
  2553. "type": "string",
  2554. "required": false,
  2555. "enum": null,
  2556. "allowNull": false,
  2557. "mapToData": null,
  2558. "validation": null,
  2559. "alias": null,
  2560. "deprecated": null
  2561. },
  2562. {
  2563. "name": "fingerprint",
  2564. "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).",
  2565. "in": "BODY",
  2566. "type": "string",
  2567. "required": false,
  2568. "enum": null,
  2569. "allowNull": false,
  2570. "mapToData": null,
  2571. "validation": null,
  2572. "alias": null,
  2573. "deprecated": null
  2574. }
  2575. ],
  2576. "responses": [
  2577. {
  2578. "code": 200,
  2579. "description": "Response if returning an existing token",
  2580. "examples": [
  2581. {
  2582. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"\"}"
  2583. }
  2584. ]
  2585. },
  2586. {
  2587. "code": 201,
  2588. "description": "Response if returning a new token",
  2589. "examples": [
  2590. {
  2591. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"\"}"
  2592. }
  2593. ]
  2594. }
  2595. ],
  2596. "renamed": null
  2597. },
  2598. {
  2599. "name": "Get-or-create an authorization for a specific app and fingerprint",
  2600. "scope": "oauthAuthorizations",
  2601. "id": "getOrCreateAuthorizationForAppAndFingerprint",
  2602. "method": "PUT",
  2603. "url": "/authorizations/clients/{client_id}/{fingerprint}",
  2604. "isDeprecated": false,
  2605. "description": "This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/enterprise/2.17/v3/auth/#working-with-two-factor-authentication).\"",
  2606. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint",
  2607. "previews": [],
  2608. "headers": [],
  2609. "parameters": [
  2610. {
  2611. "name": "client_id",
  2612. "description": "client_id parameter",
  2613. "in": "PATH",
  2614. "type": "string",
  2615. "required": true,
  2616. "enum": null,
  2617. "allowNull": false,
  2618. "mapToData": null,
  2619. "validation": null,
  2620. "alias": null,
  2621. "deprecated": null
  2622. },
  2623. {
  2624. "name": "fingerprint",
  2625. "description": "fingerprint parameter",
  2626. "in": "PATH",
  2627. "type": "string",
  2628. "required": true,
  2629. "enum": null,
  2630. "allowNull": false,
  2631. "mapToData": null,
  2632. "validation": null,
  2633. "alias": null,
  2634. "deprecated": null
  2635. },
  2636. {
  2637. "name": "client_secret",
  2638. "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.",
  2639. "in": "BODY",
  2640. "type": "string",
  2641. "required": true,
  2642. "enum": null,
  2643. "allowNull": false,
  2644. "mapToData": null,
  2645. "validation": null,
  2646. "alias": null,
  2647. "deprecated": null
  2648. },
  2649. {
  2650. "name": "scopes",
  2651. "description": "A list of scopes that this authorization is in.",
  2652. "in": "BODY",
  2653. "type": "string[]",
  2654. "required": false,
  2655. "enum": null,
  2656. "allowNull": false,
  2657. "mapToData": null,
  2658. "validation": null,
  2659. "alias": null,
  2660. "deprecated": null
  2661. },
  2662. {
  2663. "name": "note",
  2664. "description": "A note to remind you what the OAuth token is for.",
  2665. "in": "BODY",
  2666. "type": "string",
  2667. "required": false,
  2668. "enum": null,
  2669. "allowNull": false,
  2670. "mapToData": null,
  2671. "validation": null,
  2672. "alias": null,
  2673. "deprecated": null
  2674. },
  2675. {
  2676. "name": "note_url",
  2677. "description": "A URL to remind you what app the OAuth token is for.",
  2678. "in": "BODY",
  2679. "type": "string",
  2680. "required": false,
  2681. "enum": null,
  2682. "allowNull": false,
  2683. "mapToData": null,
  2684. "validation": null,
  2685. "alias": null,
  2686. "deprecated": null
  2687. }
  2688. ],
  2689. "responses": [
  2690. {
  2691. "code": 200,
  2692. "description": "Response if returning an existing token",
  2693. "examples": [
  2694. {
  2695. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  2696. }
  2697. ]
  2698. },
  2699. {
  2700. "code": 201,
  2701. "description": "Response if returning a new token",
  2702. "examples": [
  2703. {
  2704. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  2705. }
  2706. ]
  2707. }
  2708. ],
  2709. "renamed": null
  2710. },
  2711. {
  2712. "name": "Get-or-create an authorization for a specific app and fingerprint",
  2713. "scope": "oauthAuthorizations",
  2714. "id": "getOrCreateAuthorizationForAppFingerprint",
  2715. "method": "PUT",
  2716. "url": "/authorizations/clients/{client_id}/{fingerprint}",
  2717. "isDeprecated": false,
  2718. "description": "This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/enterprise/2.17/v3/auth/#working-with-two-factor-authentication).\"",
  2719. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint",
  2720. "previews": [],
  2721. "headers": [],
  2722. "parameters": [
  2723. {
  2724. "name": "client_id",
  2725. "description": "client_id parameter",
  2726. "in": "PATH",
  2727. "type": "string",
  2728. "required": true,
  2729. "enum": null,
  2730. "allowNull": false,
  2731. "mapToData": null,
  2732. "validation": null,
  2733. "alias": null,
  2734. "deprecated": null
  2735. },
  2736. {
  2737. "name": "fingerprint",
  2738. "description": "fingerprint parameter",
  2739. "in": "PATH",
  2740. "type": "string",
  2741. "required": true,
  2742. "enum": null,
  2743. "allowNull": false,
  2744. "mapToData": null,
  2745. "validation": null,
  2746. "alias": null,
  2747. "deprecated": null
  2748. },
  2749. {
  2750. "name": "client_secret",
  2751. "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.",
  2752. "in": "BODY",
  2753. "type": "string",
  2754. "required": true,
  2755. "enum": null,
  2756. "allowNull": false,
  2757. "mapToData": null,
  2758. "validation": null,
  2759. "alias": null,
  2760. "deprecated": null
  2761. },
  2762. {
  2763. "name": "scopes",
  2764. "description": "A list of scopes that this authorization is in.",
  2765. "in": "BODY",
  2766. "type": "string[]",
  2767. "required": false,
  2768. "enum": null,
  2769. "allowNull": false,
  2770. "mapToData": null,
  2771. "validation": null,
  2772. "alias": null,
  2773. "deprecated": null
  2774. },
  2775. {
  2776. "name": "note",
  2777. "description": "A note to remind you what the OAuth token is for.",
  2778. "in": "BODY",
  2779. "type": "string",
  2780. "required": false,
  2781. "enum": null,
  2782. "allowNull": false,
  2783. "mapToData": null,
  2784. "validation": null,
  2785. "alias": null,
  2786. "deprecated": null
  2787. },
  2788. {
  2789. "name": "note_url",
  2790. "description": "A URL to remind you what app the OAuth token is for.",
  2791. "in": "BODY",
  2792. "type": "string",
  2793. "required": false,
  2794. "enum": null,
  2795. "allowNull": false,
  2796. "mapToData": null,
  2797. "validation": null,
  2798. "alias": null,
  2799. "deprecated": null
  2800. }
  2801. ],
  2802. "responses": [
  2803. {
  2804. "code": 200,
  2805. "description": "Response if returning an existing token",
  2806. "examples": [
  2807. {
  2808. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  2809. }
  2810. ]
  2811. },
  2812. {
  2813. "code": 201,
  2814. "description": "Response if returning a new token",
  2815. "examples": [
  2816. {
  2817. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  2818. }
  2819. ]
  2820. }
  2821. ],
  2822. "renamed": {
  2823. "before": {
  2824. "scope": "oauthAuthorizations",
  2825. "id": "getOrCreateAuthorizationForAppFingerprint"
  2826. },
  2827. "after": {
  2828. "scope": "oauthAuthorizations",
  2829. "id": "getOrCreateAuthorizationForAppAndFingerprint"
  2830. },
  2831. "date": "2018-12-27",
  2832. "note": "`idName` changed for \"Get-or-create an authorization for a specific app and fingerprint\". It now includes `-and-`"
  2833. }
  2834. },
  2835. {
  2836. "name": "Get a single authorization",
  2837. "scope": "oauthAuthorizations",
  2838. "id": "getAuthorization",
  2839. "method": "GET",
  2840. "url": "/authorizations/{authorization_id}",
  2841. "isDeprecated": false,
  2842. "description": "",
  2843. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#get-a-single-authorization",
  2844. "previews": [],
  2845. "headers": [],
  2846. "parameters": [
  2847. {
  2848. "name": "authorization_id",
  2849. "description": "authorization_id parameter",
  2850. "in": "PATH",
  2851. "type": "integer",
  2852. "required": true,
  2853. "enum": null,
  2854. "allowNull": false,
  2855. "mapToData": null,
  2856. "validation": null,
  2857. "alias": null,
  2858. "deprecated": null
  2859. }
  2860. ],
  2861. "responses": [
  2862. {
  2863. "code": 200,
  2864. "description": "response",
  2865. "examples": [
  2866. {
  2867. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  2868. }
  2869. ]
  2870. }
  2871. ],
  2872. "renamed": null
  2873. },
  2874. {
  2875. "name": "Update an existing authorization",
  2876. "scope": "oauthAuthorizations",
  2877. "id": "updateAuthorization",
  2878. "method": "PATCH",
  2879. "url": "/authorizations/{authorization_id}",
  2880. "isDeprecated": false,
  2881. "description": "If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/enterprise/2.17/v3/auth/#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.",
  2882. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#update-an-existing-authorization",
  2883. "previews": [],
  2884. "headers": [],
  2885. "parameters": [
  2886. {
  2887. "name": "authorization_id",
  2888. "description": "authorization_id parameter",
  2889. "in": "PATH",
  2890. "type": "integer",
  2891. "required": true,
  2892. "enum": null,
  2893. "allowNull": false,
  2894. "mapToData": null,
  2895. "validation": null,
  2896. "alias": null,
  2897. "deprecated": null
  2898. },
  2899. {
  2900. "name": "scopes",
  2901. "description": "Replaces the authorization scopes with these.",
  2902. "in": "BODY",
  2903. "type": "string[]",
  2904. "required": false,
  2905. "enum": null,
  2906. "allowNull": false,
  2907. "mapToData": null,
  2908. "validation": null,
  2909. "alias": null,
  2910. "deprecated": null
  2911. },
  2912. {
  2913. "name": "add_scopes",
  2914. "description": "A list of scopes to add to this authorization.",
  2915. "in": "BODY",
  2916. "type": "string[]",
  2917. "required": false,
  2918. "enum": null,
  2919. "allowNull": false,
  2920. "mapToData": null,
  2921. "validation": null,
  2922. "alias": null,
  2923. "deprecated": null
  2924. },
  2925. {
  2926. "name": "remove_scopes",
  2927. "description": "A list of scopes to remove from this authorization.",
  2928. "in": "BODY",
  2929. "type": "string[]",
  2930. "required": false,
  2931. "enum": null,
  2932. "allowNull": false,
  2933. "mapToData": null,
  2934. "validation": null,
  2935. "alias": null,
  2936. "deprecated": null
  2937. },
  2938. {
  2939. "name": "note",
  2940. "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.",
  2941. "in": "BODY",
  2942. "type": "string",
  2943. "required": false,
  2944. "enum": null,
  2945. "allowNull": false,
  2946. "mapToData": null,
  2947. "validation": null,
  2948. "alias": null,
  2949. "deprecated": null
  2950. },
  2951. {
  2952. "name": "note_url",
  2953. "description": "A URL to remind you what app the OAuth token is for.",
  2954. "in": "BODY",
  2955. "type": "string",
  2956. "required": false,
  2957. "enum": null,
  2958. "allowNull": false,
  2959. "mapToData": null,
  2960. "validation": null,
  2961. "alias": null,
  2962. "deprecated": null
  2963. },
  2964. {
  2965. "name": "fingerprint",
  2966. "description": "A unique string to distinguish an authorization from others created for the same client ID and user.",
  2967. "in": "BODY",
  2968. "type": "string",
  2969. "required": false,
  2970. "enum": null,
  2971. "allowNull": false,
  2972. "mapToData": null,
  2973. "validation": null,
  2974. "alias": null,
  2975. "deprecated": null
  2976. }
  2977. ],
  2978. "responses": [
  2979. {
  2980. "code": 200,
  2981. "description": "response",
  2982. "examples": [
  2983. {
  2984. "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}"
  2985. }
  2986. ]
  2987. }
  2988. ],
  2989. "renamed": null
  2990. },
  2991. {
  2992. "name": "Delete an authorization",
  2993. "scope": "oauthAuthorizations",
  2994. "id": "deleteAuthorization",
  2995. "method": "DELETE",
  2996. "url": "/authorizations/{authorization_id}",
  2997. "isDeprecated": false,
  2998. "description": "",
  2999. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#delete-an-authorization",
  3000. "previews": [],
  3001. "headers": [],
  3002. "parameters": [
  3003. {
  3004. "name": "authorization_id",
  3005. "description": "authorization_id parameter",
  3006. "in": "PATH",
  3007. "type": "integer",
  3008. "required": true,
  3009. "enum": null,
  3010. "allowNull": false,
  3011. "mapToData": null,
  3012. "validation": null,
  3013. "alias": null,
  3014. "deprecated": null
  3015. }
  3016. ],
  3017. "responses": [],
  3018. "renamed": null
  3019. },
  3020. {
  3021. "name": "List all codes of conduct",
  3022. "scope": "codesOfConduct",
  3023. "id": "listConductCodes",
  3024. "method": "GET",
  3025. "url": "/codes_of_conduct",
  3026. "isDeprecated": false,
  3027. "description": "",
  3028. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/codes_of_conduct/#list-all-codes-of-conduct",
  3029. "previews": [{ "name": "scarlet-witch" }],
  3030. "headers": [
  3031. {
  3032. "name": "accept",
  3033. "value": "application/vnd.github.scarlet-witch-preview+json"
  3034. }
  3035. ],
  3036. "parameters": [],
  3037. "responses": [
  3038. {
  3039. "code": 200,
  3040. "description": "response",
  3041. "examples": [
  3042. {
  3043. "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\"}]"
  3044. }
  3045. ]
  3046. }
  3047. ],
  3048. "renamed": null
  3049. },
  3050. {
  3051. "name": "Get an individual code of conduct",
  3052. "scope": "codesOfConduct",
  3053. "id": "getConductCode",
  3054. "method": "GET",
  3055. "url": "/codes_of_conduct/{key}",
  3056. "isDeprecated": false,
  3057. "description": "",
  3058. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/codes_of_conduct/#get-an-individual-code-of-conduct",
  3059. "previews": [{ "name": "scarlet-witch" }],
  3060. "headers": [
  3061. {
  3062. "name": "accept",
  3063. "value": "application/vnd.github.scarlet-witch-preview+json"
  3064. }
  3065. ],
  3066. "parameters": [
  3067. {
  3068. "name": "key",
  3069. "description": "key parameter",
  3070. "in": "PATH",
  3071. "type": "string",
  3072. "required": true,
  3073. "enum": null,
  3074. "allowNull": false,
  3075. "mapToData": null,
  3076. "validation": null,
  3077. "alias": null,
  3078. "deprecated": null
  3079. }
  3080. ],
  3081. "responses": [
  3082. {
  3083. "code": 200,
  3084. "description": "response",
  3085. "examples": [
  3086. {
  3087. "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\"}"
  3088. }
  3089. ]
  3090. }
  3091. ],
  3092. "renamed": null
  3093. },
  3094. {
  3095. "name": "Create a content attachment",
  3096. "scope": "apps",
  3097. "id": "createContentAttachment",
  3098. "method": "POST",
  3099. "url": "/content_references/{content_reference_id}/attachments",
  3100. "isDeprecated": false,
  3101. "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://developer.github.com/enterprise/2.17/v3/activity/events/types/#contentreferenceevent) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://developer.github.com/enterprise/2.17/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.\n\nThis example creates a content attachment for the domain `https://errors.ai/`.",
  3102. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/installations/#create-a-content-attachment",
  3103. "previews": [{ "name": "corsair" }],
  3104. "headers": [
  3105. {
  3106. "name": "accept",
  3107. "value": "application/vnd.github.corsair-preview+json"
  3108. }
  3109. ],
  3110. "parameters": [
  3111. {
  3112. "name": "content_reference_id",
  3113. "description": "content_reference_id parameter",
  3114. "in": "PATH",
  3115. "type": "integer",
  3116. "required": true,
  3117. "enum": null,
  3118. "allowNull": false,
  3119. "mapToData": null,
  3120. "validation": null,
  3121. "alias": null,
  3122. "deprecated": null
  3123. },
  3124. {
  3125. "name": "title",
  3126. "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.",
  3127. "in": "BODY",
  3128. "type": "string",
  3129. "required": true,
  3130. "enum": null,
  3131. "allowNull": false,
  3132. "mapToData": null,
  3133. "validation": null,
  3134. "alias": null,
  3135. "deprecated": null
  3136. },
  3137. {
  3138. "name": "body",
  3139. "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.",
  3140. "in": "BODY",
  3141. "type": "string",
  3142. "required": true,
  3143. "enum": null,
  3144. "allowNull": false,
  3145. "mapToData": null,
  3146. "validation": null,
  3147. "alias": null,
  3148. "deprecated": null
  3149. }
  3150. ],
  3151. "responses": [
  3152. {
  3153. "code": 200,
  3154. "description": "response",
  3155. "examples": [
  3156. {
  3157. "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}"
  3158. }
  3159. ]
  3160. }
  3161. ],
  3162. "renamed": null
  3163. },
  3164. {
  3165. "name": "Get",
  3166. "scope": "emojis",
  3167. "id": "get",
  3168. "method": "GET",
  3169. "url": "/emojis",
  3170. "isDeprecated": false,
  3171. "description": "Lists all the emojis available to use on GitHub Enterprise Server.\n\n",
  3172. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/emojis/#emojis",
  3173. "previews": [],
  3174. "headers": [],
  3175. "parameters": [],
  3176. "responses": [],
  3177. "renamed": null
  3178. },
  3179. {
  3180. "name": "Get license information",
  3181. "scope": "enterpriseAdmin",
  3182. "id": "getLicenseInformation",
  3183. "method": "GET",
  3184. "url": "/enterprise/settings/license",
  3185. "isDeprecated": false,
  3186. "description": "",
  3187. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/license/#get-license-information",
  3188. "previews": [],
  3189. "headers": [],
  3190. "parameters": [],
  3191. "responses": [
  3192. {
  3193. "code": 200,
  3194. "description": "response",
  3195. "examples": [
  3196. {
  3197. "data": "{\"seats\":1400,\"seats_used\":1316,\"seats_available\":84,\"kind\":\"standard\",\"days_until_expiration\":365,\"expire_at\":\"2016/02/06 12:41:52 -0600\"}"
  3198. }
  3199. ]
  3200. }
  3201. ],
  3202. "renamed": null
  3203. },
  3204. {
  3205. "name": "Get statistics",
  3206. "scope": "enterpriseAdmin",
  3207. "id": "getTypeStats",
  3208. "method": "GET",
  3209. "url": "/enterprise/stats/{type}",
  3210. "isDeprecated": false,
  3211. "description": "There are a variety of types to choose from:\n\n| Type | Description |\n| ------------ | --------------------------------------------------------------------------------------------------- |\n| `issues` | The number of open and closed issues. |\n| `hooks` | The number of active and inactive hooks. |\n| `milestones` | The number of open and closed milestones. |\n| `orgs` | The number of organizations, teams, team members, and disabled organizations. |\n| `comments` | The number of comments on issues, pull requests, commits, and gists. |\n| `pages` | The number of GitHub Pages sites. |\n| `users` | The number of suspended and admin users. |\n| `gists` | The number of private and public gists. |\n| `pulls` | The number of merged, mergeable, and unmergeable pull requests. |\n| `repos` | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis. |\n| `all` | All of the statistics listed above. |\n\nThese statistics are cached and will be updated approximately every 10 minutes.",
  3212. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/admin_stats/#get-statistics",
  3213. "previews": [],
  3214. "headers": [],
  3215. "parameters": [
  3216. {
  3217. "name": "type",
  3218. "description": "type parameter",
  3219. "in": "PATH",
  3220. "type": "string",
  3221. "required": true,
  3222. "enum": null,
  3223. "allowNull": false,
  3224. "mapToData": null,
  3225. "validation": null,
  3226. "alias": null,
  3227. "deprecated": null
  3228. }
  3229. ],
  3230. "responses": [
  3231. {
  3232. "code": 200,
  3233. "description": "response",
  3234. "examples": [
  3235. {
  3236. "data": "{\"repos\":{\"total_repos\":212,\"root_repos\":194,\"fork_repos\":18,\"org_repos\":51,\"total_pushes\":3082,\"total_wikis\":15},\"hooks\":{\"total_hooks\":27,\"active_hooks\":23,\"inactive_hooks\":4},\"pages\":{\"total_pages\":36},\"orgs\":{\"total_orgs\":33,\"disabled_orgs\":0,\"total_teams\":60,\"total_team_members\":314},\"users\":{\"total_users\":254,\"admin_users\":45,\"suspended_users\":21},\"pulls\":{\"total_pulls\":86,\"merged_pulls\":60,\"mergeable_pulls\":21,\"unmergeable_pulls\":3},\"issues\":{\"total_issues\":179,\"open_issues\":83,\"closed_issues\":96},\"milestones\":{\"total_milestones\":7,\"open_milestones\":6,\"closed_milestones\":1},\"gists\":{\"total_gists\":178,\"private_gists\":151,\"public_gists\":25},\"comments\":{\"total_commit_comments\":6,\"total_gist_comments\":28,\"total_issue_comments\":366,\"total_pull_request_comments\":30}}"
  3237. }
  3238. ]
  3239. }
  3240. ],
  3241. "renamed": null
  3242. },
  3243. {
  3244. "name": "List public events",
  3245. "scope": "activity",
  3246. "id": "listPublicEvents",
  3247. "method": "GET",
  3248. "url": "/events",
  3249. "isDeprecated": false,
  3250. "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.",
  3251. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-public-events",
  3252. "previews": [],
  3253. "headers": [],
  3254. "parameters": [
  3255. {
  3256. "name": "per_page",
  3257. "description": "Results per page (max 100)",
  3258. "in": "QUERY",
  3259. "type": "integer",
  3260. "required": false,
  3261. "enum": null,
  3262. "allowNull": false,
  3263. "mapToData": null,
  3264. "validation": null,
  3265. "alias": null,
  3266. "deprecated": null
  3267. },
  3268. {
  3269. "name": "page",
  3270. "description": "Page number of the results to fetch.",
  3271. "in": "QUERY",
  3272. "type": "integer",
  3273. "required": false,
  3274. "enum": null,
  3275. "allowNull": false,
  3276. "mapToData": null,
  3277. "validation": null,
  3278. "alias": null,
  3279. "deprecated": null
  3280. }
  3281. ],
  3282. "responses": [],
  3283. "renamed": null
  3284. },
  3285. {
  3286. "name": "List feeds",
  3287. "scope": "activity",
  3288. "id": "listFeeds",
  3289. "method": "GET",
  3290. "url": "/feeds",
  3291. "isDeprecated": false,
  3292. "description": "GitHub Enterprise Server provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise Server global public timeline\n* **User**: The public timeline for any user, using [URI template](https://developer.github.com/enterprise/2.17/v3/#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/enterprise/2.17/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens.",
  3293. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/feeds/#list-feeds",
  3294. "previews": [],
  3295. "headers": [],
  3296. "parameters": [],
  3297. "responses": [
  3298. {
  3299. "code": 200,
  3300. "description": "response",
  3301. "examples": [
  3302. {
  3303. "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}]}}"
  3304. }
  3305. ]
  3306. }
  3307. ],
  3308. "renamed": null
  3309. },
  3310. {
  3311. "name": "List the authenticated user's gists or if called anonymously, this will return all public gists",
  3312. "scope": "gists",
  3313. "id": "list",
  3314. "method": "GET",
  3315. "url": "/gists",
  3316. "isDeprecated": false,
  3317. "description": "",
  3318. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#list-a-users-gists",
  3319. "previews": [],
  3320. "headers": [],
  3321. "parameters": [
  3322. {
  3323. "name": "since",
  3324. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.",
  3325. "in": "QUERY",
  3326. "type": "string",
  3327. "required": false,
  3328. "enum": null,
  3329. "allowNull": false,
  3330. "mapToData": null,
  3331. "validation": null,
  3332. "alias": null,
  3333. "deprecated": null
  3334. },
  3335. {
  3336. "name": "per_page",
  3337. "description": "Results per page (max 100)",
  3338. "in": "QUERY",
  3339. "type": "integer",
  3340. "required": false,
  3341. "enum": null,
  3342. "allowNull": false,
  3343. "mapToData": null,
  3344. "validation": null,
  3345. "alias": null,
  3346. "deprecated": null
  3347. },
  3348. {
  3349. "name": "page",
  3350. "description": "Page number of the results to fetch.",
  3351. "in": "QUERY",
  3352. "type": "integer",
  3353. "required": false,
  3354. "enum": null,
  3355. "allowNull": false,
  3356. "mapToData": null,
  3357. "validation": null,
  3358. "alias": null,
  3359. "deprecated": null
  3360. }
  3361. ],
  3362. "responses": [
  3363. {
  3364. "code": 200,
  3365. "description": "response",
  3366. "examples": [
  3367. {
  3368. "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]"
  3369. }
  3370. ]
  3371. }
  3372. ],
  3373. "renamed": null
  3374. },
  3375. {
  3376. "name": "Create a gist",
  3377. "scope": "gists",
  3378. "id": "create",
  3379. "method": "POST",
  3380. "url": "/gists",
  3381. "isDeprecated": false,
  3382. "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.",
  3383. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#create-a-gist",
  3384. "previews": [],
  3385. "headers": [],
  3386. "parameters": [
  3387. {
  3388. "name": "files",
  3389. "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.",
  3390. "in": "BODY",
  3391. "type": "object",
  3392. "required": true,
  3393. "enum": null,
  3394. "allowNull": false,
  3395. "mapToData": null,
  3396. "validation": null,
  3397. "alias": null,
  3398. "deprecated": null
  3399. },
  3400. {
  3401. "name": "files.content",
  3402. "description": "The content of the file.",
  3403. "in": "BODY",
  3404. "type": "string",
  3405. "required": false,
  3406. "enum": null,
  3407. "allowNull": false,
  3408. "mapToData": null,
  3409. "validation": null,
  3410. "alias": null,
  3411. "deprecated": null
  3412. },
  3413. {
  3414. "name": "description",
  3415. "description": "A descriptive name for this gist.",
  3416. "in": "BODY",
  3417. "type": "string",
  3418. "required": false,
  3419. "enum": null,
  3420. "allowNull": false,
  3421. "mapToData": null,
  3422. "validation": null,
  3423. "alias": null,
  3424. "deprecated": null
  3425. },
  3426. {
  3427. "name": "public",
  3428. "description": "When `true`, the gist will be public and available for anyone to see.",
  3429. "in": "BODY",
  3430. "type": "boolean",
  3431. "required": false,
  3432. "enum": null,
  3433. "allowNull": false,
  3434. "mapToData": null,
  3435. "validation": null,
  3436. "alias": null,
  3437. "deprecated": null
  3438. }
  3439. ],
  3440. "responses": [
  3441. {
  3442. "code": 201,
  3443. "description": "response",
  3444. "examples": [
  3445. {
  3446. "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}"
  3447. }
  3448. ]
  3449. }
  3450. ],
  3451. "renamed": null
  3452. },
  3453. {
  3454. "name": "List all public gists",
  3455. "scope": "gists",
  3456. "id": "listPublic",
  3457. "method": "GET",
  3458. "url": "/gists/public",
  3459. "isDeprecated": false,
  3460. "description": "List all public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://developer.github.com/enterprise/2.17/v3/#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.",
  3461. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#list-all-public-gists",
  3462. "previews": [],
  3463. "headers": [],
  3464. "parameters": [
  3465. {
  3466. "name": "since",
  3467. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.",
  3468. "in": "QUERY",
  3469. "type": "string",
  3470. "required": false,
  3471. "enum": null,
  3472. "allowNull": false,
  3473. "mapToData": null,
  3474. "validation": null,
  3475. "alias": null,
  3476. "deprecated": null
  3477. },
  3478. {
  3479. "name": "per_page",
  3480. "description": "Results per page (max 100)",
  3481. "in": "QUERY",
  3482. "type": "integer",
  3483. "required": false,
  3484. "enum": null,
  3485. "allowNull": false,
  3486. "mapToData": null,
  3487. "validation": null,
  3488. "alias": null,
  3489. "deprecated": null
  3490. },
  3491. {
  3492. "name": "page",
  3493. "description": "Page number of the results to fetch.",
  3494. "in": "QUERY",
  3495. "type": "integer",
  3496. "required": false,
  3497. "enum": null,
  3498. "allowNull": false,
  3499. "mapToData": null,
  3500. "validation": null,
  3501. "alias": null,
  3502. "deprecated": null
  3503. }
  3504. ],
  3505. "responses": [
  3506. {
  3507. "code": 200,
  3508. "description": "response",
  3509. "examples": [
  3510. {
  3511. "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]"
  3512. }
  3513. ]
  3514. }
  3515. ],
  3516. "renamed": null
  3517. },
  3518. {
  3519. "name": "List starred gists",
  3520. "scope": "gists",
  3521. "id": "listStarred",
  3522. "method": "GET",
  3523. "url": "/gists/starred",
  3524. "isDeprecated": false,
  3525. "description": "List the authenticated user's starred gists:",
  3526. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#list-starred-gists",
  3527. "previews": [],
  3528. "headers": [],
  3529. "parameters": [
  3530. {
  3531. "name": "since",
  3532. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.",
  3533. "in": "QUERY",
  3534. "type": "string",
  3535. "required": false,
  3536. "enum": null,
  3537. "allowNull": false,
  3538. "mapToData": null,
  3539. "validation": null,
  3540. "alias": null,
  3541. "deprecated": null
  3542. },
  3543. {
  3544. "name": "per_page",
  3545. "description": "Results per page (max 100)",
  3546. "in": "QUERY",
  3547. "type": "integer",
  3548. "required": false,
  3549. "enum": null,
  3550. "allowNull": false,
  3551. "mapToData": null,
  3552. "validation": null,
  3553. "alias": null,
  3554. "deprecated": null
  3555. },
  3556. {
  3557. "name": "page",
  3558. "description": "Page number of the results to fetch.",
  3559. "in": "QUERY",
  3560. "type": "integer",
  3561. "required": false,
  3562. "enum": null,
  3563. "allowNull": false,
  3564. "mapToData": null,
  3565. "validation": null,
  3566. "alias": null,
  3567. "deprecated": null
  3568. }
  3569. ],
  3570. "responses": [
  3571. {
  3572. "code": 200,
  3573. "description": "response",
  3574. "examples": [
  3575. {
  3576. "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]"
  3577. }
  3578. ]
  3579. }
  3580. ],
  3581. "renamed": null
  3582. },
  3583. {
  3584. "name": "Get a single gist",
  3585. "scope": "gists",
  3586. "id": "get",
  3587. "method": "GET",
  3588. "url": "/gists/{gist_id}",
  3589. "isDeprecated": false,
  3590. "description": "",
  3591. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#get-a-single-gist",
  3592. "previews": [],
  3593. "headers": [],
  3594. "parameters": [
  3595. {
  3596. "name": "gist_id",
  3597. "description": "gist_id parameter",
  3598. "in": "PATH",
  3599. "type": "string",
  3600. "required": true,
  3601. "enum": null,
  3602. "allowNull": false,
  3603. "mapToData": null,
  3604. "validation": null,
  3605. "alias": null,
  3606. "deprecated": null
  3607. }
  3608. ],
  3609. "responses": [
  3610. {
  3611. "code": 200,
  3612. "description": "response",
  3613. "examples": [
  3614. {
  3615. "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}"
  3616. }
  3617. ]
  3618. }
  3619. ],
  3620. "renamed": null
  3621. },
  3622. {
  3623. "name": "Edit a gist",
  3624. "scope": "gists",
  3625. "id": "update",
  3626. "method": "PATCH",
  3627. "url": "/gists/{gist_id}",
  3628. "isDeprecated": false,
  3629. "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.",
  3630. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#edit-a-gist",
  3631. "previews": [],
  3632. "headers": [],
  3633. "parameters": [
  3634. {
  3635. "name": "gist_id",
  3636. "description": "gist_id parameter",
  3637. "in": "PATH",
  3638. "type": "string",
  3639. "required": true,
  3640. "enum": null,
  3641. "allowNull": false,
  3642. "mapToData": null,
  3643. "validation": null,
  3644. "alias": null,
  3645. "deprecated": null
  3646. },
  3647. {
  3648. "name": "description",
  3649. "description": "A descriptive name for this gist.",
  3650. "in": "BODY",
  3651. "type": "string",
  3652. "required": false,
  3653. "enum": null,
  3654. "allowNull": false,
  3655. "mapToData": null,
  3656. "validation": null,
  3657. "alias": null,
  3658. "deprecated": null
  3659. },
  3660. {
  3661. "name": "files",
  3662. "description": "The filenames and content that make up this gist.",
  3663. "in": "BODY",
  3664. "type": "object",
  3665. "required": false,
  3666. "enum": null,
  3667. "allowNull": false,
  3668. "mapToData": null,
  3669. "validation": null,
  3670. "alias": null,
  3671. "deprecated": null
  3672. },
  3673. {
  3674. "name": "files.content",
  3675. "description": "The updated content of the file.",
  3676. "in": "BODY",
  3677. "type": "string",
  3678. "required": false,
  3679. "enum": null,
  3680. "allowNull": false,
  3681. "mapToData": null,
  3682. "validation": null,
  3683. "alias": null,
  3684. "deprecated": null
  3685. },
  3686. {
  3687. "name": "files.filename",
  3688. "description": "The new name for this file. To delete a file, set the value of the filename to `null`.",
  3689. "in": "BODY",
  3690. "type": "string",
  3691. "required": false,
  3692. "enum": null,
  3693. "allowNull": false,
  3694. "mapToData": null,
  3695. "validation": null,
  3696. "alias": null,
  3697. "deprecated": null
  3698. }
  3699. ],
  3700. "responses": [
  3701. {
  3702. "code": 200,
  3703. "description": "response",
  3704. "examples": [
  3705. {
  3706. "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world.md\":{\"filename\":\"hello_world.md\",\"type\":\"text/plain\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/8df0a8f642973cbda937bf542d37d4e9/raw/4221bb4b942568c4e3ab253022d2b7fec7844f21/hello_world.md\",\"size\":73,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` or `python hello_world.py` to print Hello World\"},\"new_file.txt\":{\"filename\":\"new_file.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/8df0a8f642973cbda937bf542d37d4e9/raw/56ab7bdf864fa11c1e16acce2a5116171514d2d1/new_file.txt\",\"size\":31,\"truncated\":false,\"content\":\"This is a new placeholder file.\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}"
  3707. }
  3708. ]
  3709. }
  3710. ],
  3711. "renamed": null
  3712. },
  3713. {
  3714. "name": "Delete a gist",
  3715. "scope": "gists",
  3716. "id": "delete",
  3717. "method": "DELETE",
  3718. "url": "/gists/{gist_id}",
  3719. "isDeprecated": false,
  3720. "description": "",
  3721. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#delete-a-gist",
  3722. "previews": [],
  3723. "headers": [],
  3724. "parameters": [
  3725. {
  3726. "name": "gist_id",
  3727. "description": "gist_id parameter",
  3728. "in": "PATH",
  3729. "type": "string",
  3730. "required": true,
  3731. "enum": null,
  3732. "allowNull": false,
  3733. "mapToData": null,
  3734. "validation": null,
  3735. "alias": null,
  3736. "deprecated": null
  3737. }
  3738. ],
  3739. "responses": [],
  3740. "renamed": null
  3741. },
  3742. {
  3743. "name": "List comments on a gist",
  3744. "scope": "gists",
  3745. "id": "listComments",
  3746. "method": "GET",
  3747. "url": "/gists/{gist_id}/comments",
  3748. "isDeprecated": false,
  3749. "description": "",
  3750. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/comments/#list-comments-on-a-gist",
  3751. "previews": [],
  3752. "headers": [],
  3753. "parameters": [
  3754. {
  3755. "name": "gist_id",
  3756. "description": "gist_id parameter",
  3757. "in": "PATH",
  3758. "type": "string",
  3759. "required": true,
  3760. "enum": null,
  3761. "allowNull": false,
  3762. "mapToData": null,
  3763. "validation": null,
  3764. "alias": null,
  3765. "deprecated": null
  3766. },
  3767. {
  3768. "name": "per_page",
  3769. "description": "Results per page (max 100)",
  3770. "in": "QUERY",
  3771. "type": "integer",
  3772. "required": false,
  3773. "enum": null,
  3774. "allowNull": false,
  3775. "mapToData": null,
  3776. "validation": null,
  3777. "alias": null,
  3778. "deprecated": null
  3779. },
  3780. {
  3781. "name": "page",
  3782. "description": "Page number of the results to fetch.",
  3783. "in": "QUERY",
  3784. "type": "integer",
  3785. "required": false,
  3786. "enum": null,
  3787. "allowNull": false,
  3788. "mapToData": null,
  3789. "validation": null,
  3790. "alias": null,
  3791. "deprecated": null
  3792. }
  3793. ],
  3794. "responses": [
  3795. {
  3796. "code": 200,
  3797. "description": "response",
  3798. "examples": [
  3799. {
  3800. "data": "[{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}]"
  3801. }
  3802. ]
  3803. }
  3804. ],
  3805. "renamed": null
  3806. },
  3807. {
  3808. "name": "Create a comment",
  3809. "scope": "gists",
  3810. "id": "createComment",
  3811. "method": "POST",
  3812. "url": "/gists/{gist_id}/comments",
  3813. "isDeprecated": false,
  3814. "description": "",
  3815. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/comments/#create-a-comment",
  3816. "previews": [],
  3817. "headers": [],
  3818. "parameters": [
  3819. {
  3820. "name": "gist_id",
  3821. "description": "gist_id parameter",
  3822. "in": "PATH",
  3823. "type": "string",
  3824. "required": true,
  3825. "enum": null,
  3826. "allowNull": false,
  3827. "mapToData": null,
  3828. "validation": null,
  3829. "alias": null,
  3830. "deprecated": null
  3831. },
  3832. {
  3833. "name": "body",
  3834. "description": "The comment text.",
  3835. "in": "BODY",
  3836. "type": "string",
  3837. "required": true,
  3838. "enum": null,
  3839. "allowNull": false,
  3840. "mapToData": null,
  3841. "validation": null,
  3842. "alias": null,
  3843. "deprecated": null
  3844. }
  3845. ],
  3846. "responses": [
  3847. {
  3848. "code": 201,
  3849. "description": "response",
  3850. "examples": [
  3851. {
  3852. "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}"
  3853. }
  3854. ]
  3855. }
  3856. ],
  3857. "renamed": null
  3858. },
  3859. {
  3860. "name": "Get a single comment",
  3861. "scope": "gists",
  3862. "id": "getComment",
  3863. "method": "GET",
  3864. "url": "/gists/{gist_id}/comments/{comment_id}",
  3865. "isDeprecated": false,
  3866. "description": "",
  3867. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/comments/#get-a-single-comment",
  3868. "previews": [],
  3869. "headers": [],
  3870. "parameters": [
  3871. {
  3872. "name": "gist_id",
  3873. "description": "gist_id parameter",
  3874. "in": "PATH",
  3875. "type": "string",
  3876. "required": true,
  3877. "enum": null,
  3878. "allowNull": false,
  3879. "mapToData": null,
  3880. "validation": null,
  3881. "alias": null,
  3882. "deprecated": null
  3883. },
  3884. {
  3885. "name": "comment_id",
  3886. "description": "comment_id parameter",
  3887. "in": "PATH",
  3888. "type": "integer",
  3889. "required": true,
  3890. "enum": null,
  3891. "allowNull": false,
  3892. "mapToData": null,
  3893. "validation": null,
  3894. "alias": null,
  3895. "deprecated": null
  3896. }
  3897. ],
  3898. "responses": [
  3899. {
  3900. "code": 200,
  3901. "description": "response",
  3902. "examples": [
  3903. {
  3904. "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}"
  3905. }
  3906. ]
  3907. }
  3908. ],
  3909. "renamed": null
  3910. },
  3911. {
  3912. "name": "Edit a comment",
  3913. "scope": "gists",
  3914. "id": "updateComment",
  3915. "method": "PATCH",
  3916. "url": "/gists/{gist_id}/comments/{comment_id}",
  3917. "isDeprecated": false,
  3918. "description": "",
  3919. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/comments/#edit-a-comment",
  3920. "previews": [],
  3921. "headers": [],
  3922. "parameters": [
  3923. {
  3924. "name": "gist_id",
  3925. "description": "gist_id parameter",
  3926. "in": "PATH",
  3927. "type": "string",
  3928. "required": true,
  3929. "enum": null,
  3930. "allowNull": false,
  3931. "mapToData": null,
  3932. "validation": null,
  3933. "alias": null,
  3934. "deprecated": null
  3935. },
  3936. {
  3937. "name": "comment_id",
  3938. "description": "comment_id parameter",
  3939. "in": "PATH",
  3940. "type": "integer",
  3941. "required": true,
  3942. "enum": null,
  3943. "allowNull": false,
  3944. "mapToData": null,
  3945. "validation": null,
  3946. "alias": null,
  3947. "deprecated": null
  3948. },
  3949. {
  3950. "name": "body",
  3951. "description": "The comment text.",
  3952. "in": "BODY",
  3953. "type": "string",
  3954. "required": true,
  3955. "enum": null,
  3956. "allowNull": false,
  3957. "mapToData": null,
  3958. "validation": null,
  3959. "alias": null,
  3960. "deprecated": null
  3961. }
  3962. ],
  3963. "responses": [
  3964. {
  3965. "code": 200,
  3966. "description": "response",
  3967. "examples": [
  3968. {
  3969. "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}"
  3970. }
  3971. ]
  3972. }
  3973. ],
  3974. "renamed": null
  3975. },
  3976. {
  3977. "name": "Delete a comment",
  3978. "scope": "gists",
  3979. "id": "deleteComment",
  3980. "method": "DELETE",
  3981. "url": "/gists/{gist_id}/comments/{comment_id}",
  3982. "isDeprecated": false,
  3983. "description": "",
  3984. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/comments/#delete-a-comment",
  3985. "previews": [],
  3986. "headers": [],
  3987. "parameters": [
  3988. {
  3989. "name": "gist_id",
  3990. "description": "gist_id parameter",
  3991. "in": "PATH",
  3992. "type": "string",
  3993. "required": true,
  3994. "enum": null,
  3995. "allowNull": false,
  3996. "mapToData": null,
  3997. "validation": null,
  3998. "alias": null,
  3999. "deprecated": null
  4000. },
  4001. {
  4002. "name": "comment_id",
  4003. "description": "comment_id parameter",
  4004. "in": "PATH",
  4005. "type": "integer",
  4006. "required": true,
  4007. "enum": null,
  4008. "allowNull": false,
  4009. "mapToData": null,
  4010. "validation": null,
  4011. "alias": null,
  4012. "deprecated": null
  4013. }
  4014. ],
  4015. "responses": [],
  4016. "renamed": null
  4017. },
  4018. {
  4019. "name": "List gist commits",
  4020. "scope": "gists",
  4021. "id": "listCommits",
  4022. "method": "GET",
  4023. "url": "/gists/{gist_id}/commits",
  4024. "isDeprecated": false,
  4025. "description": "",
  4026. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#list-gist-commits",
  4027. "previews": [],
  4028. "headers": [],
  4029. "parameters": [
  4030. {
  4031. "name": "gist_id",
  4032. "description": "gist_id parameter",
  4033. "in": "PATH",
  4034. "type": "string",
  4035. "required": true,
  4036. "enum": null,
  4037. "allowNull": false,
  4038. "mapToData": null,
  4039. "validation": null,
  4040. "alias": null,
  4041. "deprecated": null
  4042. },
  4043. {
  4044. "name": "per_page",
  4045. "description": "Results per page (max 100)",
  4046. "in": "QUERY",
  4047. "type": "integer",
  4048. "required": false,
  4049. "enum": null,
  4050. "allowNull": false,
  4051. "mapToData": null,
  4052. "validation": null,
  4053. "alias": null,
  4054. "deprecated": null
  4055. },
  4056. {
  4057. "name": "page",
  4058. "description": "Page number of the results to fetch.",
  4059. "in": "QUERY",
  4060. "type": "integer",
  4061. "required": false,
  4062. "enum": null,
  4063. "allowNull": false,
  4064. "mapToData": null,
  4065. "validation": null,
  4066. "alias": null,
  4067. "deprecated": null
  4068. }
  4069. ],
  4070. "responses": [
  4071. {
  4072. "code": 200,
  4073. "description": "response",
  4074. "examples": [
  4075. {
  4076. "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]"
  4077. }
  4078. ]
  4079. }
  4080. ],
  4081. "renamed": null
  4082. },
  4083. {
  4084. "name": "Fork a gist",
  4085. "scope": "gists",
  4086. "id": "fork",
  4087. "method": "POST",
  4088. "url": "/gists/{gist_id}/forks",
  4089. "isDeprecated": false,
  4090. "description": "**Note**: This was previously `/gists/:gist_id/fork`.",
  4091. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#fork-a-gist",
  4092. "previews": [],
  4093. "headers": [],
  4094. "parameters": [
  4095. {
  4096. "name": "gist_id",
  4097. "description": "gist_id parameter",
  4098. "in": "PATH",
  4099. "type": "string",
  4100. "required": true,
  4101. "enum": null,
  4102. "allowNull": false,
  4103. "mapToData": null,
  4104. "validation": null,
  4105. "alias": null,
  4106. "deprecated": null
  4107. }
  4108. ],
  4109. "responses": [
  4110. {
  4111. "code": 201,
  4112. "description": "response",
  4113. "examples": [
  4114. {
  4115. "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}"
  4116. }
  4117. ]
  4118. }
  4119. ],
  4120. "renamed": null
  4121. },
  4122. {
  4123. "name": "List gist forks",
  4124. "scope": "gists",
  4125. "id": "listForks",
  4126. "method": "GET",
  4127. "url": "/gists/{gist_id}/forks",
  4128. "isDeprecated": false,
  4129. "description": "",
  4130. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#list-gist-forks",
  4131. "previews": [],
  4132. "headers": [],
  4133. "parameters": [
  4134. {
  4135. "name": "gist_id",
  4136. "description": "gist_id parameter",
  4137. "in": "PATH",
  4138. "type": "string",
  4139. "required": true,
  4140. "enum": null,
  4141. "allowNull": false,
  4142. "mapToData": null,
  4143. "validation": null,
  4144. "alias": null,
  4145. "deprecated": null
  4146. },
  4147. {
  4148. "name": "per_page",
  4149. "description": "Results per page (max 100)",
  4150. "in": "QUERY",
  4151. "type": "integer",
  4152. "required": false,
  4153. "enum": null,
  4154. "allowNull": false,
  4155. "mapToData": null,
  4156. "validation": null,
  4157. "alias": null,
  4158. "deprecated": null
  4159. },
  4160. {
  4161. "name": "page",
  4162. "description": "Page number of the results to fetch.",
  4163. "in": "QUERY",
  4164. "type": "integer",
  4165. "required": false,
  4166. "enum": null,
  4167. "allowNull": false,
  4168. "mapToData": null,
  4169. "validation": null,
  4170. "alias": null,
  4171. "deprecated": null
  4172. }
  4173. ],
  4174. "responses": [
  4175. {
  4176. "code": 200,
  4177. "description": "response",
  4178. "examples": [
  4179. {
  4180. "data": "[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]"
  4181. }
  4182. ]
  4183. }
  4184. ],
  4185. "renamed": null
  4186. },
  4187. {
  4188. "name": "Star a gist",
  4189. "scope": "gists",
  4190. "id": "star",
  4191. "method": "PUT",
  4192. "url": "/gists/{gist_id}/star",
  4193. "isDeprecated": false,
  4194. "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  4195. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#star-a-gist",
  4196. "previews": [],
  4197. "headers": [],
  4198. "parameters": [
  4199. {
  4200. "name": "gist_id",
  4201. "description": "gist_id parameter",
  4202. "in": "PATH",
  4203. "type": "string",
  4204. "required": true,
  4205. "enum": null,
  4206. "allowNull": false,
  4207. "mapToData": null,
  4208. "validation": null,
  4209. "alias": null,
  4210. "deprecated": null
  4211. }
  4212. ],
  4213. "responses": [],
  4214. "renamed": null
  4215. },
  4216. {
  4217. "name": "Unstar a gist",
  4218. "scope": "gists",
  4219. "id": "unstar",
  4220. "method": "DELETE",
  4221. "url": "/gists/{gist_id}/star",
  4222. "isDeprecated": false,
  4223. "description": "",
  4224. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#unstar-a-gist",
  4225. "previews": [],
  4226. "headers": [],
  4227. "parameters": [
  4228. {
  4229. "name": "gist_id",
  4230. "description": "gist_id parameter",
  4231. "in": "PATH",
  4232. "type": "string",
  4233. "required": true,
  4234. "enum": null,
  4235. "allowNull": false,
  4236. "mapToData": null,
  4237. "validation": null,
  4238. "alias": null,
  4239. "deprecated": null
  4240. }
  4241. ],
  4242. "responses": [],
  4243. "renamed": null
  4244. },
  4245. {
  4246. "name": "Check if a gist is starred",
  4247. "scope": "gists",
  4248. "id": "checkIsStarred",
  4249. "method": "GET",
  4250. "url": "/gists/{gist_id}/star",
  4251. "isDeprecated": false,
  4252. "description": "",
  4253. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#check-if-a-gist-is-starred",
  4254. "previews": [],
  4255. "headers": [],
  4256. "parameters": [
  4257. {
  4258. "name": "gist_id",
  4259. "description": "gist_id parameter",
  4260. "in": "PATH",
  4261. "type": "string",
  4262. "required": true,
  4263. "enum": null,
  4264. "allowNull": false,
  4265. "mapToData": null,
  4266. "validation": null,
  4267. "alias": null,
  4268. "deprecated": null
  4269. }
  4270. ],
  4271. "responses": [],
  4272. "renamed": null
  4273. },
  4274. {
  4275. "name": "Get a specific revision of a gist",
  4276. "scope": "gists",
  4277. "id": "getRevision",
  4278. "method": "GET",
  4279. "url": "/gists/{gist_id}/{sha}",
  4280. "isDeprecated": false,
  4281. "description": "",
  4282. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#get-a-specific-revision-of-a-gist",
  4283. "previews": [],
  4284. "headers": [],
  4285. "parameters": [
  4286. {
  4287. "name": "gist_id",
  4288. "description": "gist_id parameter",
  4289. "in": "PATH",
  4290. "type": "string",
  4291. "required": true,
  4292. "enum": null,
  4293. "allowNull": false,
  4294. "mapToData": null,
  4295. "validation": null,
  4296. "alias": null,
  4297. "deprecated": null
  4298. },
  4299. {
  4300. "name": "sha",
  4301. "description": "sha parameter",
  4302. "in": "PATH",
  4303. "type": "string",
  4304. "required": true,
  4305. "enum": null,
  4306. "allowNull": false,
  4307. "mapToData": null,
  4308. "validation": null,
  4309. "alias": null,
  4310. "deprecated": null
  4311. }
  4312. ],
  4313. "responses": [
  4314. {
  4315. "code": 200,
  4316. "description": "response",
  4317. "examples": [
  4318. {
  4319. "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}"
  4320. }
  4321. ]
  4322. }
  4323. ],
  4324. "renamed": null
  4325. },
  4326. {
  4327. "name": "Listing available templates",
  4328. "scope": "gitignore",
  4329. "id": "listTemplates",
  4330. "method": "GET",
  4331. "url": "/gitignore/templates",
  4332. "isDeprecated": false,
  4333. "description": "List all templates available to pass as an option when [creating a repository](https://developer.github.com/enterprise/2.17/v3/repos/#create).",
  4334. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gitignore/#listing-available-templates",
  4335. "previews": [],
  4336. "headers": [],
  4337. "parameters": [],
  4338. "responses": [
  4339. {
  4340. "code": 200,
  4341. "description": "response",
  4342. "examples": [
  4343. {
  4344. "data": "[\"Actionscript\",\"Android\",\"AppceleratorTitanium\",\"Autotools\",\"Bancha\",\"C\",\"C++\"]"
  4345. }
  4346. ]
  4347. }
  4348. ],
  4349. "renamed": null
  4350. },
  4351. {
  4352. "name": "Get a single template",
  4353. "scope": "gitignore",
  4354. "id": "getTemplate",
  4355. "method": "GET",
  4356. "url": "/gitignore/templates/{name}",
  4357. "isDeprecated": false,
  4358. "description": "The API also allows fetching the source of a single template.\n\nUse the raw [media type](https://developer.github.com/enterprise/2.17/v3/media/) to get the raw contents.\n\n",
  4359. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gitignore/#get-a-single-template",
  4360. "previews": [],
  4361. "headers": [],
  4362. "parameters": [
  4363. {
  4364. "name": "name",
  4365. "description": "name parameter",
  4366. "in": "PATH",
  4367. "type": "string",
  4368. "required": true,
  4369. "enum": null,
  4370. "allowNull": false,
  4371. "mapToData": null,
  4372. "validation": null,
  4373. "alias": null,
  4374. "deprecated": null
  4375. }
  4376. ],
  4377. "responses": [
  4378. {
  4379. "code": 200,
  4380. "description": "response",
  4381. "examples": [
  4382. {
  4383. "data": "{\"name\":\"C\",\"source\":\"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"}"
  4384. }
  4385. ]
  4386. }
  4387. ],
  4388. "renamed": null
  4389. },
  4390. {
  4391. "name": "List repositories",
  4392. "scope": "apps",
  4393. "id": "listRepos",
  4394. "method": "GET",
  4395. "url": "/installation/repositories",
  4396. "isDeprecated": false,
  4397. "description": "List repositories that an installation can access.\n\nYou must use an [installation access token](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.",
  4398. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/installations/#list-repositories",
  4399. "previews": [{ "name": "machine-man" }],
  4400. "headers": [
  4401. {
  4402. "name": "accept",
  4403. "value": "application/vnd.github.machine-man-preview+json"
  4404. }
  4405. ],
  4406. "parameters": [
  4407. {
  4408. "name": "per_page",
  4409. "description": "Results per page (max 100)",
  4410. "in": "QUERY",
  4411. "type": "integer",
  4412. "required": false,
  4413. "enum": null,
  4414. "allowNull": false,
  4415. "mapToData": null,
  4416. "validation": null,
  4417. "alias": null,
  4418. "deprecated": null
  4419. },
  4420. {
  4421. "name": "page",
  4422. "description": "Page number of the results to fetch.",
  4423. "in": "QUERY",
  4424. "type": "integer",
  4425. "required": false,
  4426. "enum": null,
  4427. "allowNull": false,
  4428. "mapToData": null,
  4429. "validation": null,
  4430. "alias": null,
  4431. "deprecated": null
  4432. }
  4433. ],
  4434. "responses": [
  4435. {
  4436. "code": 200,
  4437. "description": "response",
  4438. "examples": [
  4439. {
  4440. "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}]}"
  4441. }
  4442. ]
  4443. }
  4444. ],
  4445. "renamed": null
  4446. },
  4447. {
  4448. "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories",
  4449. "scope": "issues",
  4450. "id": "list",
  4451. "method": "GET",
  4452. "url": "/issues",
  4453. "isDeprecated": false,
  4454. "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests)\" endpoint.",
  4455. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#list-issues",
  4456. "previews": [],
  4457. "headers": [],
  4458. "parameters": [
  4459. {
  4460. "name": "filter",
  4461. "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation",
  4462. "in": "QUERY",
  4463. "type": "string",
  4464. "required": false,
  4465. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  4466. "allowNull": false,
  4467. "mapToData": null,
  4468. "validation": null,
  4469. "alias": null,
  4470. "deprecated": null
  4471. },
  4472. {
  4473. "name": "state",
  4474. "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
  4475. "in": "QUERY",
  4476. "type": "string",
  4477. "required": false,
  4478. "enum": ["open", "closed", "all"],
  4479. "allowNull": false,
  4480. "mapToData": null,
  4481. "validation": null,
  4482. "alias": null,
  4483. "deprecated": null
  4484. },
  4485. {
  4486. "name": "labels",
  4487. "description": "A list of comma separated label names. Example: `bug,ui,@high`",
  4488. "in": "QUERY",
  4489. "type": "string",
  4490. "required": false,
  4491. "enum": null,
  4492. "allowNull": false,
  4493. "mapToData": null,
  4494. "validation": null,
  4495. "alias": null,
  4496. "deprecated": null
  4497. },
  4498. {
  4499. "name": "sort",
  4500. "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
  4501. "in": "QUERY",
  4502. "type": "string",
  4503. "required": false,
  4504. "enum": ["created", "updated", "comments"],
  4505. "allowNull": false,
  4506. "mapToData": null,
  4507. "validation": null,
  4508. "alias": null,
  4509. "deprecated": null
  4510. },
  4511. {
  4512. "name": "direction",
  4513. "description": "The direction of the sort. Can be either `asc` or `desc`.",
  4514. "in": "QUERY",
  4515. "type": "string",
  4516. "required": false,
  4517. "enum": ["asc", "desc"],
  4518. "allowNull": false,
  4519. "mapToData": null,
  4520. "validation": null,
  4521. "alias": null,
  4522. "deprecated": null
  4523. },
  4524. {
  4525. "name": "since",
  4526. "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  4527. "in": "QUERY",
  4528. "type": "string",
  4529. "required": false,
  4530. "enum": null,
  4531. "allowNull": false,
  4532. "mapToData": null,
  4533. "validation": null,
  4534. "alias": null,
  4535. "deprecated": null
  4536. },
  4537. {
  4538. "name": "per_page",
  4539. "description": "Results per page (max 100)",
  4540. "in": "QUERY",
  4541. "type": "integer",
  4542. "required": false,
  4543. "enum": null,
  4544. "allowNull": false,
  4545. "mapToData": null,
  4546. "validation": null,
  4547. "alias": null,
  4548. "deprecated": null
  4549. },
  4550. {
  4551. "name": "page",
  4552. "description": "Page number of the results to fetch.",
  4553. "in": "QUERY",
  4554. "type": "integer",
  4555. "required": false,
  4556. "enum": null,
  4557. "allowNull": false,
  4558. "mapToData": null,
  4559. "validation": null,
  4560. "alias": null,
  4561. "deprecated": null
  4562. }
  4563. ],
  4564. "responses": [
  4565. {
  4566. "code": 200,
  4567. "description": "response",
  4568. "examples": [
  4569. {
  4570. "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}]"
  4571. }
  4572. ]
  4573. }
  4574. ],
  4575. "renamed": null
  4576. },
  4577. {
  4578. "name": "List commonly used licenses",
  4579. "scope": "licenses",
  4580. "id": "listCommonlyUsed",
  4581. "method": "GET",
  4582. "url": "/licenses",
  4583. "isDeprecated": false,
  4584. "description": "",
  4585. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/licenses/#list-commonly-used-licenses",
  4586. "previews": [],
  4587. "headers": [],
  4588. "parameters": [],
  4589. "responses": [
  4590. {
  4591. "code": 200,
  4592. "description": "response",
  4593. "examples": [
  4594. {
  4595. "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\"}]"
  4596. }
  4597. ]
  4598. }
  4599. ],
  4600. "renamed": null
  4601. },
  4602. {
  4603. "name": "List commonly used licenses",
  4604. "scope": "licenses",
  4605. "id": "list",
  4606. "method": "GET",
  4607. "url": "/licenses",
  4608. "isDeprecated": false,
  4609. "description": "",
  4610. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/licenses/#list-commonly-used-licenses",
  4611. "previews": [],
  4612. "headers": [],
  4613. "parameters": [],
  4614. "responses": [
  4615. {
  4616. "code": 200,
  4617. "description": "response",
  4618. "examples": [
  4619. {
  4620. "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\"}]"
  4621. }
  4622. ]
  4623. }
  4624. ],
  4625. "renamed": {
  4626. "before": { "scope": "licenses", "id": "list" },
  4627. "after": { "scope": "licenses", "id": "listCommonlyUsed" },
  4628. "date": "2019-03-05",
  4629. "note": "\"List all licenses\" renamed to \"List commonly used licenses\""
  4630. }
  4631. },
  4632. {
  4633. "name": "Get an individual license",
  4634. "scope": "licenses",
  4635. "id": "get",
  4636. "method": "GET",
  4637. "url": "/licenses/{license}",
  4638. "isDeprecated": false,
  4639. "description": "",
  4640. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/licenses/#get-an-individual-license",
  4641. "previews": [],
  4642. "headers": [],
  4643. "parameters": [
  4644. {
  4645. "name": "license",
  4646. "description": "license parameter",
  4647. "in": "PATH",
  4648. "type": "string",
  4649. "required": true,
  4650. "enum": null,
  4651. "allowNull": false,
  4652. "mapToData": null,
  4653. "validation": null,
  4654. "alias": null,
  4655. "deprecated": null
  4656. }
  4657. ],
  4658. "responses": [
  4659. {
  4660. "code": 200,
  4661. "description": "response",
  4662. "examples": [
  4663. {
  4664. "data": "{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"http://choosealicense.com/licenses/mit/\",\"description\":\"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\"implementation\":\"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\"permissions\":[\"commercial-use\",\"modifications\",\"distribution\",\"sublicense\",\"private-use\"],\"conditions\":[\"include-copyright\"],\"limitations\":[\"no-liability\"],\"body\":\"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\"featured\":true}"
  4665. }
  4666. ]
  4667. }
  4668. ],
  4669. "renamed": null
  4670. },
  4671. {
  4672. "name": "Render an arbitrary Markdown document",
  4673. "scope": "markdown",
  4674. "id": "render",
  4675. "method": "POST",
  4676. "url": "/markdown",
  4677. "isDeprecated": false,
  4678. "description": "",
  4679. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/markdown/#render-an-arbitrary-markdown-document",
  4680. "previews": [],
  4681. "headers": [],
  4682. "parameters": [
  4683. {
  4684. "name": "text",
  4685. "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.",
  4686. "in": "BODY",
  4687. "type": "string",
  4688. "required": true,
  4689. "enum": null,
  4690. "allowNull": false,
  4691. "mapToData": null,
  4692. "validation": null,
  4693. "alias": null,
  4694. "deprecated": null
  4695. },
  4696. {
  4697. "name": "mode",
  4698. "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.",
  4699. "in": "BODY",
  4700. "type": "string",
  4701. "required": false,
  4702. "enum": ["markdown", "gfm"],
  4703. "allowNull": false,
  4704. "mapToData": null,
  4705. "validation": null,
  4706. "alias": null,
  4707. "deprecated": null
  4708. },
  4709. {
  4710. "name": "context",
  4711. "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.",
  4712. "in": "BODY",
  4713. "type": "string",
  4714. "required": false,
  4715. "enum": null,
  4716. "allowNull": false,
  4717. "mapToData": null,
  4718. "validation": null,
  4719. "alias": null,
  4720. "deprecated": null
  4721. }
  4722. ],
  4723. "responses": [],
  4724. "renamed": null
  4725. },
  4726. {
  4727. "name": "Render a Markdown document in raw mode",
  4728. "scope": "markdown",
  4729. "id": "renderRaw",
  4730. "method": "POST",
  4731. "url": "/markdown/raw",
  4732. "isDeprecated": false,
  4733. "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.\n\n",
  4734. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/markdown/#render-a-markdown-document-in-raw-mode",
  4735. "previews": [],
  4736. "headers": [
  4737. { "name": "content-type", "value": "text/plain; charset=utf-8" }
  4738. ],
  4739. "parameters": [
  4740. {
  4741. "name": "data",
  4742. "description": "data parameter",
  4743. "in": "BODY",
  4744. "type": "string",
  4745. "required": true,
  4746. "enum": null,
  4747. "allowNull": false,
  4748. "mapToData": true,
  4749. "validation": null,
  4750. "alias": null,
  4751. "deprecated": null
  4752. }
  4753. ],
  4754. "responses": [],
  4755. "renamed": null
  4756. },
  4757. {
  4758. "name": "Get",
  4759. "scope": "meta",
  4760. "id": "get",
  4761. "method": "GET",
  4762. "url": "/meta",
  4763. "isDeprecated": false,
  4764. "description": "If you access this endpoint on your organization's [GitHub Enterprise Server](https://enterprise.github.com/) installation, this endpoint provides information about that installation.\n\n**Note:** GitHub Enterprise release 2.17 and higher no longer allows admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.17/v3/guides/replacing-github-services) to help you update your services to webhooks.",
  4765. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/meta/#meta",
  4766. "previews": [],
  4767. "headers": [],
  4768. "parameters": [],
  4769. "responses": [
  4770. {
  4771. "code": 200,
  4772. "description": "response",
  4773. "examples": [
  4774. {
  4775. "data": "{\"verifiable_password_authentication\":true,\"installed_version\":\"2.17.0\",\"github_services_sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}"
  4776. }
  4777. ]
  4778. }
  4779. ],
  4780. "renamed": null
  4781. },
  4782. {
  4783. "name": "List public events for a network of repositories",
  4784. "scope": "activity",
  4785. "id": "listPublicEventsForRepoNetwork",
  4786. "method": "GET",
  4787. "url": "/networks/{owner}/{repo}/events",
  4788. "isDeprecated": false,
  4789. "description": "",
  4790. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-public-events-for-a-network-of-repositories",
  4791. "previews": [],
  4792. "headers": [],
  4793. "parameters": [
  4794. {
  4795. "name": "owner",
  4796. "description": "owner parameter",
  4797. "in": "PATH",
  4798. "type": "string",
  4799. "required": true,
  4800. "enum": null,
  4801. "allowNull": false,
  4802. "mapToData": null,
  4803. "validation": null,
  4804. "alias": null,
  4805. "deprecated": null
  4806. },
  4807. {
  4808. "name": "repo",
  4809. "description": "repo parameter",
  4810. "in": "PATH",
  4811. "type": "string",
  4812. "required": true,
  4813. "enum": null,
  4814. "allowNull": false,
  4815. "mapToData": null,
  4816. "validation": null,
  4817. "alias": null,
  4818. "deprecated": null
  4819. },
  4820. {
  4821. "name": "per_page",
  4822. "description": "Results per page (max 100)",
  4823. "in": "QUERY",
  4824. "type": "integer",
  4825. "required": false,
  4826. "enum": null,
  4827. "allowNull": false,
  4828. "mapToData": null,
  4829. "validation": null,
  4830. "alias": null,
  4831. "deprecated": null
  4832. },
  4833. {
  4834. "name": "page",
  4835. "description": "Page number of the results to fetch.",
  4836. "in": "QUERY",
  4837. "type": "integer",
  4838. "required": false,
  4839. "enum": null,
  4840. "allowNull": false,
  4841. "mapToData": null,
  4842. "validation": null,
  4843. "alias": null,
  4844. "deprecated": null
  4845. }
  4846. ],
  4847. "responses": [],
  4848. "renamed": null
  4849. },
  4850. {
  4851. "name": "List your notifications",
  4852. "scope": "activity",
  4853. "id": "listNotifications",
  4854. "method": "GET",
  4855. "url": "/notifications",
  4856. "isDeprecated": false,
  4857. "description": "List all notifications for the current user, sorted by most recently updated.\n\nThe following example uses the `since` parameter to list notifications that have been updated after the specified time.",
  4858. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#list-your-notifications",
  4859. "previews": [],
  4860. "headers": [],
  4861. "parameters": [
  4862. {
  4863. "name": "all",
  4864. "description": "If `true`, show notifications marked as read.",
  4865. "in": "QUERY",
  4866. "type": "boolean",
  4867. "required": false,
  4868. "enum": null,
  4869. "allowNull": false,
  4870. "mapToData": null,
  4871. "validation": null,
  4872. "alias": null,
  4873. "deprecated": null
  4874. },
  4875. {
  4876. "name": "participating",
  4877. "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.",
  4878. "in": "QUERY",
  4879. "type": "boolean",
  4880. "required": false,
  4881. "enum": null,
  4882. "allowNull": false,
  4883. "mapToData": null,
  4884. "validation": null,
  4885. "alias": null,
  4886. "deprecated": null
  4887. },
  4888. {
  4889. "name": "since",
  4890. "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  4891. "in": "QUERY",
  4892. "type": "string",
  4893. "required": false,
  4894. "enum": null,
  4895. "allowNull": false,
  4896. "mapToData": null,
  4897. "validation": null,
  4898. "alias": null,
  4899. "deprecated": null
  4900. },
  4901. {
  4902. "name": "before",
  4903. "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  4904. "in": "QUERY",
  4905. "type": "string",
  4906. "required": false,
  4907. "enum": null,
  4908. "allowNull": false,
  4909. "mapToData": null,
  4910. "validation": null,
  4911. "alias": null,
  4912. "deprecated": null
  4913. },
  4914. {
  4915. "name": "per_page",
  4916. "description": "Results per page (max 100)",
  4917. "in": "QUERY",
  4918. "type": "integer",
  4919. "required": false,
  4920. "enum": null,
  4921. "allowNull": false,
  4922. "mapToData": null,
  4923. "validation": null,
  4924. "alias": null,
  4925. "deprecated": null
  4926. },
  4927. {
  4928. "name": "page",
  4929. "description": "Page number of the results to fetch.",
  4930. "in": "QUERY",
  4931. "type": "integer",
  4932. "required": false,
  4933. "enum": null,
  4934. "allowNull": false,
  4935. "mapToData": null,
  4936. "validation": null,
  4937. "alias": null,
  4938. "deprecated": null
  4939. }
  4940. ],
  4941. "responses": [
  4942. {
  4943. "code": 200,
  4944. "description": "response",
  4945. "examples": [
  4946. {
  4947. "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}]"
  4948. }
  4949. ]
  4950. }
  4951. ],
  4952. "renamed": null
  4953. },
  4954. {
  4955. "name": "Mark as read",
  4956. "scope": "activity",
  4957. "id": "markAsRead",
  4958. "method": "PUT",
  4959. "url": "/notifications",
  4960. "isDeprecated": false,
  4961. "description": "Marks a notification as \"read\" removes it from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications](https://developer.github.com/enterprise/2.17/v3/activity/notifications/#list-your-notifications) endpoint and pass the query parameter `all=false`.",
  4962. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#mark-as-read",
  4963. "previews": [],
  4964. "headers": [],
  4965. "parameters": [
  4966. {
  4967. "name": "last_read_at",
  4968. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.",
  4969. "in": "BODY",
  4970. "type": "string",
  4971. "required": false,
  4972. "enum": null,
  4973. "allowNull": false,
  4974. "mapToData": null,
  4975. "validation": null,
  4976. "alias": null,
  4977. "deprecated": null
  4978. }
  4979. ],
  4980. "responses": [],
  4981. "renamed": null
  4982. },
  4983. {
  4984. "name": "View a single thread",
  4985. "scope": "activity",
  4986. "id": "getThread",
  4987. "method": "GET",
  4988. "url": "/notifications/threads/{thread_id}",
  4989. "isDeprecated": false,
  4990. "description": "",
  4991. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#view-a-single-thread",
  4992. "previews": [],
  4993. "headers": [],
  4994. "parameters": [
  4995. {
  4996. "name": "thread_id",
  4997. "description": "thread_id parameter",
  4998. "in": "PATH",
  4999. "type": "integer",
  5000. "required": true,
  5001. "enum": null,
  5002. "allowNull": false,
  5003. "mapToData": null,
  5004. "validation": null,
  5005. "alias": null,
  5006. "deprecated": null
  5007. }
  5008. ],
  5009. "responses": [
  5010. {
  5011. "code": 200,
  5012. "description": "response",
  5013. "examples": [
  5014. {
  5015. "data": "{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}"
  5016. }
  5017. ]
  5018. }
  5019. ],
  5020. "renamed": null
  5021. },
  5022. {
  5023. "name": "Mark a thread as read",
  5024. "scope": "activity",
  5025. "id": "markThreadAsRead",
  5026. "method": "PATCH",
  5027. "url": "/notifications/threads/{thread_id}",
  5028. "isDeprecated": false,
  5029. "description": "",
  5030. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#mark-a-thread-as-read",
  5031. "previews": [],
  5032. "headers": [],
  5033. "parameters": [
  5034. {
  5035. "name": "thread_id",
  5036. "description": "thread_id parameter",
  5037. "in": "PATH",
  5038. "type": "integer",
  5039. "required": true,
  5040. "enum": null,
  5041. "allowNull": false,
  5042. "mapToData": null,
  5043. "validation": null,
  5044. "alias": null,
  5045. "deprecated": null
  5046. }
  5047. ],
  5048. "responses": [],
  5049. "renamed": null
  5050. },
  5051. {
  5052. "name": "Get a thread subscription",
  5053. "scope": "activity",
  5054. "id": "getThreadSubscription",
  5055. "method": "GET",
  5056. "url": "/notifications/threads/{thread_id}/subscription",
  5057. "isDeprecated": false,
  5058. "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://developer.github.com/enterprise/2.17/v3/activity/watching/#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.",
  5059. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#get-a-thread-subscription",
  5060. "previews": [],
  5061. "headers": [],
  5062. "parameters": [
  5063. {
  5064. "name": "thread_id",
  5065. "description": "thread_id parameter",
  5066. "in": "PATH",
  5067. "type": "integer",
  5068. "required": true,
  5069. "enum": null,
  5070. "allowNull": false,
  5071. "mapToData": null,
  5072. "validation": null,
  5073. "alias": null,
  5074. "deprecated": null
  5075. }
  5076. ],
  5077. "responses": [
  5078. {
  5079. "code": 200,
  5080. "description": "response",
  5081. "examples": [
  5082. {
  5083. "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}"
  5084. }
  5085. ]
  5086. }
  5087. ],
  5088. "renamed": null
  5089. },
  5090. {
  5091. "name": "Set a thread subscription",
  5092. "scope": "activity",
  5093. "id": "setThreadSubscription",
  5094. "method": "PUT",
  5095. "url": "/notifications/threads/{thread_id}/subscription",
  5096. "isDeprecated": false,
  5097. "description": "This lets you subscribe or unsubscribe from a conversation.",
  5098. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#set-a-thread-subscription",
  5099. "previews": [],
  5100. "headers": [],
  5101. "parameters": [
  5102. {
  5103. "name": "thread_id",
  5104. "description": "thread_id parameter",
  5105. "in": "PATH",
  5106. "type": "integer",
  5107. "required": true,
  5108. "enum": null,
  5109. "allowNull": false,
  5110. "mapToData": null,
  5111. "validation": null,
  5112. "alias": null,
  5113. "deprecated": null
  5114. },
  5115. {
  5116. "name": "ignored",
  5117. "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.",
  5118. "in": "BODY",
  5119. "type": "boolean",
  5120. "required": false,
  5121. "enum": null,
  5122. "allowNull": false,
  5123. "mapToData": null,
  5124. "validation": null,
  5125. "alias": null,
  5126. "deprecated": null
  5127. }
  5128. ],
  5129. "responses": [
  5130. {
  5131. "code": 200,
  5132. "description": "response",
  5133. "examples": [
  5134. {
  5135. "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}"
  5136. }
  5137. ]
  5138. }
  5139. ],
  5140. "renamed": null
  5141. },
  5142. {
  5143. "name": "Delete a thread subscription",
  5144. "scope": "activity",
  5145. "id": "deleteThreadSubscription",
  5146. "method": "DELETE",
  5147. "url": "/notifications/threads/{thread_id}/subscription",
  5148. "isDeprecated": false,
  5149. "description": "Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed.",
  5150. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#delete-a-thread-subscription",
  5151. "previews": [],
  5152. "headers": [],
  5153. "parameters": [
  5154. {
  5155. "name": "thread_id",
  5156. "description": "thread_id parameter",
  5157. "in": "PATH",
  5158. "type": "integer",
  5159. "required": true,
  5160. "enum": null,
  5161. "allowNull": false,
  5162. "mapToData": null,
  5163. "validation": null,
  5164. "alias": null,
  5165. "deprecated": null
  5166. }
  5167. ],
  5168. "responses": [],
  5169. "renamed": null
  5170. },
  5171. {
  5172. "name": "List all organizations",
  5173. "scope": "orgs",
  5174. "id": "list",
  5175. "method": "GET",
  5176. "url": "/organizations",
  5177. "isDeprecated": false,
  5178. "description": "Lists all organizations, in the order that they were created on GitHub Enterprise Server.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/enterprise/2.17/v3/#link-header) to get the URL for the next page of organizations.",
  5179. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/#list-all-organizations",
  5180. "previews": [],
  5181. "headers": [],
  5182. "parameters": [
  5183. {
  5184. "name": "since",
  5185. "description": "The integer ID of the last Organization that you've seen.",
  5186. "in": "QUERY",
  5187. "type": "string",
  5188. "required": false,
  5189. "enum": null,
  5190. "allowNull": false,
  5191. "mapToData": null,
  5192. "validation": null,
  5193. "alias": null,
  5194. "deprecated": null
  5195. },
  5196. {
  5197. "name": "per_page",
  5198. "description": "Results per page (max 100)",
  5199. "in": "QUERY",
  5200. "type": "integer",
  5201. "required": false,
  5202. "enum": null,
  5203. "allowNull": false,
  5204. "mapToData": null,
  5205. "validation": null,
  5206. "alias": null,
  5207. "deprecated": null
  5208. },
  5209. {
  5210. "name": "page",
  5211. "description": "Page number of the results to fetch.",
  5212. "in": "QUERY",
  5213. "type": "integer",
  5214. "required": false,
  5215. "enum": null,
  5216. "allowNull": false,
  5217. "mapToData": null,
  5218. "validation": null,
  5219. "alias": null,
  5220. "deprecated": null
  5221. }
  5222. ],
  5223. "responses": [
  5224. {
  5225. "code": 200,
  5226. "description": "response",
  5227. "examples": [
  5228. {
  5229. "data": "[{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]"
  5230. }
  5231. ]
  5232. }
  5233. ],
  5234. "renamed": null
  5235. },
  5236. {
  5237. "name": "Get an organization",
  5238. "scope": "orgs",
  5239. "id": "get",
  5240. "method": "GET",
  5241. "url": "/orgs/{org}",
  5242. "isDeprecated": false,
  5243. "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).",
  5244. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/#get-an-organization",
  5245. "previews": [],
  5246. "headers": [],
  5247. "parameters": [
  5248. {
  5249. "name": "org",
  5250. "description": "org parameter",
  5251. "in": "PATH",
  5252. "type": "string",
  5253. "required": true,
  5254. "enum": null,
  5255. "allowNull": false,
  5256. "mapToData": null,
  5257. "validation": null,
  5258. "alias": null,
  5259. "deprecated": null
  5260. }
  5261. ],
  5262. "responses": [
  5263. {
  5264. "code": 200,
  5265. "description": "response",
  5266. "examples": [
  5267. {
  5268. "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"support@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_settings\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\"}"
  5269. }
  5270. ]
  5271. }
  5272. ],
  5273. "renamed": null
  5274. },
  5275. {
  5276. "name": "Edit an organization",
  5277. "scope": "orgs",
  5278. "id": "update",
  5279. "method": "PATCH",
  5280. "url": "/orgs/{org}",
  5281. "isDeprecated": false,
  5282. "description": "**Note:** The new `members_allowed_repository_creation_type` replaces the functionality of `members_can_create_repositories`.\n\nSetting `members_allowed_repository_creation_type` will override the value of `members_can_create_repositories` in the following ways:\n\n* Setting `members_allowed_repository_creation_type` to `all` or `private` sets `members_can_create_repositories` to `true`.\n* Setting `members_allowed_repository_creation_type` to `none` sets `members_can_create_repositories` to `false`.\n* If you omit `members_allowed_repository_creation_type`, `members_can_create_repositories` is not modified.\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.",
  5283. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/#edit-an-organization",
  5284. "previews": [],
  5285. "headers": [],
  5286. "parameters": [
  5287. {
  5288. "name": "org",
  5289. "description": "org parameter",
  5290. "in": "PATH",
  5291. "type": "string",
  5292. "required": true,
  5293. "enum": null,
  5294. "allowNull": false,
  5295. "mapToData": null,
  5296. "validation": null,
  5297. "alias": null,
  5298. "deprecated": null
  5299. },
  5300. {
  5301. "name": "billing_email",
  5302. "description": "Billing email address. This address is not publicized.",
  5303. "in": "BODY",
  5304. "type": "string",
  5305. "required": false,
  5306. "enum": null,
  5307. "allowNull": false,
  5308. "mapToData": null,
  5309. "validation": null,
  5310. "alias": null,
  5311. "deprecated": null
  5312. },
  5313. {
  5314. "name": "company",
  5315. "description": "The company name.",
  5316. "in": "BODY",
  5317. "type": "string",
  5318. "required": false,
  5319. "enum": null,
  5320. "allowNull": false,
  5321. "mapToData": null,
  5322. "validation": null,
  5323. "alias": null,
  5324. "deprecated": null
  5325. },
  5326. {
  5327. "name": "email",
  5328. "description": "The publicly visible email address.",
  5329. "in": "BODY",
  5330. "type": "string",
  5331. "required": false,
  5332. "enum": null,
  5333. "allowNull": false,
  5334. "mapToData": null,
  5335. "validation": null,
  5336. "alias": null,
  5337. "deprecated": null
  5338. },
  5339. {
  5340. "name": "location",
  5341. "description": "The location.",
  5342. "in": "BODY",
  5343. "type": "string",
  5344. "required": false,
  5345. "enum": null,
  5346. "allowNull": false,
  5347. "mapToData": null,
  5348. "validation": null,
  5349. "alias": null,
  5350. "deprecated": null
  5351. },
  5352. {
  5353. "name": "name",
  5354. "description": "The shorthand name of the company.",
  5355. "in": "BODY",
  5356. "type": "string",
  5357. "required": false,
  5358. "enum": null,
  5359. "allowNull": false,
  5360. "mapToData": null,
  5361. "validation": null,
  5362. "alias": null,
  5363. "deprecated": null
  5364. },
  5365. {
  5366. "name": "description",
  5367. "description": "The description of the company.",
  5368. "in": "BODY",
  5369. "type": "string",
  5370. "required": false,
  5371. "enum": null,
  5372. "allowNull": false,
  5373. "mapToData": null,
  5374. "validation": null,
  5375. "alias": null,
  5376. "deprecated": null
  5377. },
  5378. {
  5379. "name": "has_organization_projects",
  5380. "description": "Toggles whether an organization can use organization projects.",
  5381. "in": "BODY",
  5382. "type": "boolean",
  5383. "required": false,
  5384. "enum": null,
  5385. "allowNull": false,
  5386. "mapToData": null,
  5387. "validation": null,
  5388. "alias": null,
  5389. "deprecated": null
  5390. },
  5391. {
  5392. "name": "has_repository_projects",
  5393. "description": "Toggles whether repositories that belong to the organization can use repository projects.",
  5394. "in": "BODY",
  5395. "type": "boolean",
  5396. "required": false,
  5397. "enum": null,
  5398. "allowNull": false,
  5399. "mapToData": null,
  5400. "validation": null,
  5401. "alias": null,
  5402. "deprecated": null
  5403. },
  5404. {
  5405. "name": "default_repository_permission",
  5406. "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.",
  5407. "in": "BODY",
  5408. "type": "string",
  5409. "required": false,
  5410. "enum": ["read", "write", "admin", "none"],
  5411. "allowNull": false,
  5412. "mapToData": null,
  5413. "validation": null,
  5414. "alias": null,
  5415. "deprecated": null
  5416. },
  5417. {
  5418. "name": "members_can_create_repositories",
  5419. "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.",
  5420. "in": "BODY",
  5421. "type": "boolean",
  5422. "required": false,
  5423. "enum": null,
  5424. "allowNull": false,
  5425. "mapToData": null,
  5426. "validation": null,
  5427. "alias": null,
  5428. "deprecated": null
  5429. },
  5430. {
  5431. "name": "members_allowed_repository_creation_type",
  5432. "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/enterprise/2.17/v3/orgs/#members_can_create_repositories) for details.",
  5433. "in": "BODY",
  5434. "type": "string",
  5435. "required": false,
  5436. "enum": ["all", "private", "none"],
  5437. "allowNull": false,
  5438. "mapToData": null,
  5439. "validation": null,
  5440. "alias": null,
  5441. "deprecated": null
  5442. }
  5443. ],
  5444. "responses": [
  5445. {
  5446. "code": 200,
  5447. "description": "response",
  5448. "examples": [
  5449. {
  5450. "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"support@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_settings\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\"}"
  5451. }
  5452. ]
  5453. }
  5454. ],
  5455. "renamed": null
  5456. },
  5457. {
  5458. "name": "List public events for an organization",
  5459. "scope": "activity",
  5460. "id": "listPublicEventsForOrg",
  5461. "method": "GET",
  5462. "url": "/orgs/{org}/events",
  5463. "isDeprecated": false,
  5464. "description": "",
  5465. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-public-events-for-an-organization",
  5466. "previews": [],
  5467. "headers": [],
  5468. "parameters": [
  5469. {
  5470. "name": "org",
  5471. "description": "org parameter",
  5472. "in": "PATH",
  5473. "type": "string",
  5474. "required": true,
  5475. "enum": null,
  5476. "allowNull": false,
  5477. "mapToData": null,
  5478. "validation": null,
  5479. "alias": null,
  5480. "deprecated": null
  5481. },
  5482. {
  5483. "name": "per_page",
  5484. "description": "Results per page (max 100)",
  5485. "in": "QUERY",
  5486. "type": "integer",
  5487. "required": false,
  5488. "enum": null,
  5489. "allowNull": false,
  5490. "mapToData": null,
  5491. "validation": null,
  5492. "alias": null,
  5493. "deprecated": null
  5494. },
  5495. {
  5496. "name": "page",
  5497. "description": "Page number of the results to fetch.",
  5498. "in": "QUERY",
  5499. "type": "integer",
  5500. "required": false,
  5501. "enum": null,
  5502. "allowNull": false,
  5503. "mapToData": null,
  5504. "validation": null,
  5505. "alias": null,
  5506. "deprecated": null
  5507. }
  5508. ],
  5509. "responses": [],
  5510. "renamed": null
  5511. },
  5512. {
  5513. "name": "List hooks",
  5514. "scope": "orgs",
  5515. "id": "listHooks",
  5516. "method": "GET",
  5517. "url": "/orgs/{org}/hooks",
  5518. "isDeprecated": false,
  5519. "description": "",
  5520. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#list-hooks",
  5521. "previews": [],
  5522. "headers": [],
  5523. "parameters": [
  5524. {
  5525. "name": "org",
  5526. "description": "org parameter",
  5527. "in": "PATH",
  5528. "type": "string",
  5529. "required": true,
  5530. "enum": null,
  5531. "allowNull": false,
  5532. "mapToData": null,
  5533. "validation": null,
  5534. "alias": null,
  5535. "deprecated": null
  5536. },
  5537. {
  5538. "name": "per_page",
  5539. "description": "Results per page (max 100)",
  5540. "in": "QUERY",
  5541. "type": "integer",
  5542. "required": false,
  5543. "enum": null,
  5544. "allowNull": false,
  5545. "mapToData": null,
  5546. "validation": null,
  5547. "alias": null,
  5548. "deprecated": null
  5549. },
  5550. {
  5551. "name": "page",
  5552. "description": "Page number of the results to fetch.",
  5553. "in": "QUERY",
  5554. "type": "integer",
  5555. "required": false,
  5556. "enum": null,
  5557. "allowNull": false,
  5558. "mapToData": null,
  5559. "validation": null,
  5560. "alias": null,
  5561. "deprecated": null
  5562. }
  5563. ],
  5564. "responses": [
  5565. {
  5566. "code": 200,
  5567. "description": "response",
  5568. "examples": [
  5569. {
  5570. "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}]"
  5571. }
  5572. ]
  5573. }
  5574. ],
  5575. "renamed": null
  5576. },
  5577. {
  5578. "name": "Create a hook",
  5579. "scope": "orgs",
  5580. "id": "createHook",
  5581. "method": "POST",
  5582. "url": "/orgs/{org}/hooks",
  5583. "isDeprecated": false,
  5584. "description": "Here's how you can create a hook that posts payloads in JSON format:",
  5585. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#create-a-hook",
  5586. "previews": [],
  5587. "headers": [],
  5588. "parameters": [
  5589. {
  5590. "name": "org",
  5591. "description": "org parameter",
  5592. "in": "PATH",
  5593. "type": "string",
  5594. "required": true,
  5595. "enum": null,
  5596. "allowNull": false,
  5597. "mapToData": null,
  5598. "validation": null,
  5599. "alias": null,
  5600. "deprecated": null
  5601. },
  5602. {
  5603. "name": "name",
  5604. "description": "Must be passed as \"web\".",
  5605. "in": "BODY",
  5606. "type": "string",
  5607. "required": true,
  5608. "enum": null,
  5609. "allowNull": false,
  5610. "mapToData": null,
  5611. "validation": null,
  5612. "alias": null,
  5613. "deprecated": null
  5614. },
  5615. {
  5616. "name": "config",
  5617. "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#create-hook-config-params).",
  5618. "in": "BODY",
  5619. "type": "object",
  5620. "required": true,
  5621. "enum": null,
  5622. "allowNull": false,
  5623. "mapToData": null,
  5624. "validation": null,
  5625. "alias": null,
  5626. "deprecated": null
  5627. },
  5628. {
  5629. "name": "config.url",
  5630. "description": "The URL to which the payloads will be delivered.",
  5631. "in": "BODY",
  5632. "type": "string",
  5633. "required": true,
  5634. "enum": null,
  5635. "allowNull": false,
  5636. "mapToData": null,
  5637. "validation": null,
  5638. "alias": null,
  5639. "deprecated": null
  5640. },
  5641. {
  5642. "name": "config.content_type",
  5643. "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
  5644. "in": "BODY",
  5645. "type": "string",
  5646. "required": false,
  5647. "enum": null,
  5648. "allowNull": false,
  5649. "mapToData": null,
  5650. "validation": null,
  5651. "alias": null,
  5652. "deprecated": null
  5653. },
  5654. {
  5655. "name": "config.secret",
  5656. "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/enterprise/2.17/webhooks/#delivery-headers) header.",
  5657. "in": "BODY",
  5658. "type": "string",
  5659. "required": false,
  5660. "enum": null,
  5661. "allowNull": false,
  5662. "mapToData": null,
  5663. "validation": null,
  5664. "alias": null,
  5665. "deprecated": null
  5666. },
  5667. {
  5668. "name": "config.insecure_ssl",
  5669. "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
  5670. "in": "BODY",
  5671. "type": "string",
  5672. "required": false,
  5673. "enum": null,
  5674. "allowNull": false,
  5675. "mapToData": null,
  5676. "validation": null,
  5677. "alias": null,
  5678. "deprecated": null
  5679. },
  5680. {
  5681. "name": "events",
  5682. "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.",
  5683. "in": "BODY",
  5684. "type": "string[]",
  5685. "required": false,
  5686. "enum": null,
  5687. "allowNull": false,
  5688. "mapToData": null,
  5689. "validation": null,
  5690. "alias": null,
  5691. "deprecated": null
  5692. },
  5693. {
  5694. "name": "active",
  5695. "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
  5696. "in": "BODY",
  5697. "type": "boolean",
  5698. "required": false,
  5699. "enum": null,
  5700. "allowNull": false,
  5701. "mapToData": null,
  5702. "validation": null,
  5703. "alias": null,
  5704. "deprecated": null
  5705. }
  5706. ],
  5707. "responses": [
  5708. {
  5709. "code": 201,
  5710. "description": "response",
  5711. "examples": [
  5712. {
  5713. "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}"
  5714. }
  5715. ]
  5716. }
  5717. ],
  5718. "renamed": null
  5719. },
  5720. {
  5721. "name": "Get single hook",
  5722. "scope": "orgs",
  5723. "id": "getHook",
  5724. "method": "GET",
  5725. "url": "/orgs/{org}/hooks/{hook_id}",
  5726. "isDeprecated": false,
  5727. "description": "",
  5728. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#get-single-hook",
  5729. "previews": [],
  5730. "headers": [],
  5731. "parameters": [
  5732. {
  5733. "name": "org",
  5734. "description": "org parameter",
  5735. "in": "PATH",
  5736. "type": "string",
  5737. "required": true,
  5738. "enum": null,
  5739. "allowNull": false,
  5740. "mapToData": null,
  5741. "validation": null,
  5742. "alias": null,
  5743. "deprecated": null
  5744. },
  5745. {
  5746. "name": "hook_id",
  5747. "description": "hook_id parameter",
  5748. "in": "PATH",
  5749. "type": "integer",
  5750. "required": true,
  5751. "enum": null,
  5752. "allowNull": false,
  5753. "mapToData": null,
  5754. "validation": null,
  5755. "alias": null,
  5756. "deprecated": null
  5757. }
  5758. ],
  5759. "responses": [
  5760. {
  5761. "code": 200,
  5762. "description": "response",
  5763. "examples": [
  5764. {
  5765. "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}"
  5766. }
  5767. ]
  5768. }
  5769. ],
  5770. "renamed": null
  5771. },
  5772. {
  5773. "name": "Edit a hook",
  5774. "scope": "orgs",
  5775. "id": "updateHook",
  5776. "method": "PATCH",
  5777. "url": "/orgs/{org}/hooks/{hook_id}",
  5778. "isDeprecated": false,
  5779. "description": "",
  5780. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#edit-a-hook",
  5781. "previews": [],
  5782. "headers": [],
  5783. "parameters": [
  5784. {
  5785. "name": "org",
  5786. "description": "org parameter",
  5787. "in": "PATH",
  5788. "type": "string",
  5789. "required": true,
  5790. "enum": null,
  5791. "allowNull": false,
  5792. "mapToData": null,
  5793. "validation": null,
  5794. "alias": null,
  5795. "deprecated": null
  5796. },
  5797. {
  5798. "name": "hook_id",
  5799. "description": "hook_id parameter",
  5800. "in": "PATH",
  5801. "type": "integer",
  5802. "required": true,
  5803. "enum": null,
  5804. "allowNull": false,
  5805. "mapToData": null,
  5806. "validation": null,
  5807. "alias": null,
  5808. "deprecated": null
  5809. },
  5810. {
  5811. "name": "config",
  5812. "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#update-hook-config-params).",
  5813. "in": "BODY",
  5814. "type": "object",
  5815. "required": false,
  5816. "enum": null,
  5817. "allowNull": false,
  5818. "mapToData": null,
  5819. "validation": null,
  5820. "alias": null,
  5821. "deprecated": null
  5822. },
  5823. {
  5824. "name": "config.url",
  5825. "description": "The URL to which the payloads will be delivered.",
  5826. "in": "BODY",
  5827. "type": "string",
  5828. "required": true,
  5829. "enum": null,
  5830. "allowNull": false,
  5831. "mapToData": null,
  5832. "validation": null,
  5833. "alias": null,
  5834. "deprecated": null
  5835. },
  5836. {
  5837. "name": "config.content_type",
  5838. "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
  5839. "in": "BODY",
  5840. "type": "string",
  5841. "required": false,
  5842. "enum": null,
  5843. "allowNull": false,
  5844. "mapToData": null,
  5845. "validation": null,
  5846. "alias": null,
  5847. "deprecated": null
  5848. },
  5849. {
  5850. "name": "config.secret",
  5851. "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/enterprise/2.17/webhooks/#delivery-headers) header.",
  5852. "in": "BODY",
  5853. "type": "string",
  5854. "required": false,
  5855. "enum": null,
  5856. "allowNull": false,
  5857. "mapToData": null,
  5858. "validation": null,
  5859. "alias": null,
  5860. "deprecated": null
  5861. },
  5862. {
  5863. "name": "config.insecure_ssl",
  5864. "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
  5865. "in": "BODY",
  5866. "type": "string",
  5867. "required": false,
  5868. "enum": null,
  5869. "allowNull": false,
  5870. "mapToData": null,
  5871. "validation": null,
  5872. "alias": null,
  5873. "deprecated": null
  5874. },
  5875. {
  5876. "name": "events",
  5877. "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.",
  5878. "in": "BODY",
  5879. "type": "string[]",
  5880. "required": false,
  5881. "enum": null,
  5882. "allowNull": false,
  5883. "mapToData": null,
  5884. "validation": null,
  5885. "alias": null,
  5886. "deprecated": null
  5887. },
  5888. {
  5889. "name": "active",
  5890. "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
  5891. "in": "BODY",
  5892. "type": "boolean",
  5893. "required": false,
  5894. "enum": null,
  5895. "allowNull": false,
  5896. "mapToData": null,
  5897. "validation": null,
  5898. "alias": null,
  5899. "deprecated": null
  5900. }
  5901. ],
  5902. "responses": [
  5903. {
  5904. "code": 200,
  5905. "description": "response",
  5906. "examples": [
  5907. {
  5908. "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}"
  5909. }
  5910. ]
  5911. }
  5912. ],
  5913. "renamed": null
  5914. },
  5915. {
  5916. "name": "Delete a hook",
  5917. "scope": "orgs",
  5918. "id": "deleteHook",
  5919. "method": "DELETE",
  5920. "url": "/orgs/{org}/hooks/{hook_id}",
  5921. "isDeprecated": false,
  5922. "description": "",
  5923. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#delete-a-hook",
  5924. "previews": [],
  5925. "headers": [],
  5926. "parameters": [
  5927. {
  5928. "name": "org",
  5929. "description": "org parameter",
  5930. "in": "PATH",
  5931. "type": "string",
  5932. "required": true,
  5933. "enum": null,
  5934. "allowNull": false,
  5935. "mapToData": null,
  5936. "validation": null,
  5937. "alias": null,
  5938. "deprecated": null
  5939. },
  5940. {
  5941. "name": "hook_id",
  5942. "description": "hook_id parameter",
  5943. "in": "PATH",
  5944. "type": "integer",
  5945. "required": true,
  5946. "enum": null,
  5947. "allowNull": false,
  5948. "mapToData": null,
  5949. "validation": null,
  5950. "alias": null,
  5951. "deprecated": null
  5952. }
  5953. ],
  5954. "responses": [],
  5955. "renamed": null
  5956. },
  5957. {
  5958. "name": "Ping a hook",
  5959. "scope": "orgs",
  5960. "id": "pingHook",
  5961. "method": "POST",
  5962. "url": "/orgs/{org}/hooks/{hook_id}/pings",
  5963. "isDeprecated": false,
  5964. "description": "This will trigger a [ping event](https://developer.github.com/enterprise/2.17/webhooks/#ping-event) to be sent to the hook.",
  5965. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/hooks/#ping-a-hook",
  5966. "previews": [],
  5967. "headers": [],
  5968. "parameters": [
  5969. {
  5970. "name": "org",
  5971. "description": "org parameter",
  5972. "in": "PATH",
  5973. "type": "string",
  5974. "required": true,
  5975. "enum": null,
  5976. "allowNull": false,
  5977. "mapToData": null,
  5978. "validation": null,
  5979. "alias": null,
  5980. "deprecated": null
  5981. },
  5982. {
  5983. "name": "hook_id",
  5984. "description": "hook_id parameter",
  5985. "in": "PATH",
  5986. "type": "integer",
  5987. "required": true,
  5988. "enum": null,
  5989. "allowNull": false,
  5990. "mapToData": null,
  5991. "validation": null,
  5992. "alias": null,
  5993. "deprecated": null
  5994. }
  5995. ],
  5996. "responses": [],
  5997. "renamed": null
  5998. },
  5999. {
  6000. "name": "Get an organization installation",
  6001. "scope": "apps",
  6002. "id": "getOrgInstallation",
  6003. "method": "GET",
  6004. "url": "/orgs/{org}/installation",
  6005. "isDeprecated": false,
  6006. "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  6007. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-an-organization-installation",
  6008. "previews": [{ "name": "machine-man" }],
  6009. "headers": [
  6010. {
  6011. "name": "accept",
  6012. "value": "application/vnd.github.machine-man-preview+json"
  6013. }
  6014. ],
  6015. "parameters": [
  6016. {
  6017. "name": "org",
  6018. "description": "org parameter",
  6019. "in": "PATH",
  6020. "type": "string",
  6021. "required": true,
  6022. "enum": null,
  6023. "allowNull": false,
  6024. "mapToData": null,
  6025. "validation": null,
  6026. "alias": null,
  6027. "deprecated": null
  6028. }
  6029. ],
  6030. "responses": [
  6031. {
  6032. "code": 200,
  6033. "description": "response",
  6034. "examples": [
  6035. {
  6036. "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}"
  6037. }
  6038. ]
  6039. }
  6040. ],
  6041. "renamed": null
  6042. },
  6043. {
  6044. "name": "Get an organization installation",
  6045. "scope": "apps",
  6046. "id": "findOrgInstallation",
  6047. "method": "GET",
  6048. "url": "/orgs/{org}/installation",
  6049. "isDeprecated": false,
  6050. "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  6051. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-an-organization-installation",
  6052. "previews": [{ "name": "machine-man" }],
  6053. "headers": [
  6054. {
  6055. "name": "accept",
  6056. "value": "application/vnd.github.machine-man-preview+json"
  6057. }
  6058. ],
  6059. "parameters": [
  6060. {
  6061. "name": "org",
  6062. "description": "org parameter",
  6063. "in": "PATH",
  6064. "type": "string",
  6065. "required": true,
  6066. "enum": null,
  6067. "allowNull": false,
  6068. "mapToData": null,
  6069. "validation": null,
  6070. "alias": null,
  6071. "deprecated": null
  6072. }
  6073. ],
  6074. "responses": [
  6075. {
  6076. "code": 200,
  6077. "description": "response",
  6078. "examples": [
  6079. {
  6080. "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}"
  6081. }
  6082. ]
  6083. }
  6084. ],
  6085. "renamed": {
  6086. "before": { "scope": "apps", "id": "findOrgInstallation" },
  6087. "after": { "scope": "apps", "id": "getOrgInstallation" },
  6088. "date": "2019-04-10",
  6089. "note": "\"Find organization installation\" renamed to \"Get an organization installation\""
  6090. }
  6091. },
  6092. {
  6093. "name": "List all issues for a given organization assigned to the authenticated user",
  6094. "scope": "issues",
  6095. "id": "listForOrg",
  6096. "method": "GET",
  6097. "url": "/orgs/{org}/issues",
  6098. "isDeprecated": false,
  6099. "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests)\" endpoint.",
  6100. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#list-issues",
  6101. "previews": [],
  6102. "headers": [],
  6103. "parameters": [
  6104. {
  6105. "name": "org",
  6106. "description": "org parameter",
  6107. "in": "PATH",
  6108. "type": "string",
  6109. "required": true,
  6110. "enum": null,
  6111. "allowNull": false,
  6112. "mapToData": null,
  6113. "validation": null,
  6114. "alias": null,
  6115. "deprecated": null
  6116. },
  6117. {
  6118. "name": "filter",
  6119. "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation",
  6120. "in": "QUERY",
  6121. "type": "string",
  6122. "required": false,
  6123. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  6124. "allowNull": false,
  6125. "mapToData": null,
  6126. "validation": null,
  6127. "alias": null,
  6128. "deprecated": null
  6129. },
  6130. {
  6131. "name": "state",
  6132. "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
  6133. "in": "QUERY",
  6134. "type": "string",
  6135. "required": false,
  6136. "enum": ["open", "closed", "all"],
  6137. "allowNull": false,
  6138. "mapToData": null,
  6139. "validation": null,
  6140. "alias": null,
  6141. "deprecated": null
  6142. },
  6143. {
  6144. "name": "labels",
  6145. "description": "A list of comma separated label names. Example: `bug,ui,@high`",
  6146. "in": "QUERY",
  6147. "type": "string",
  6148. "required": false,
  6149. "enum": null,
  6150. "allowNull": false,
  6151. "mapToData": null,
  6152. "validation": null,
  6153. "alias": null,
  6154. "deprecated": null
  6155. },
  6156. {
  6157. "name": "sort",
  6158. "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
  6159. "in": "QUERY",
  6160. "type": "string",
  6161. "required": false,
  6162. "enum": ["created", "updated", "comments"],
  6163. "allowNull": false,
  6164. "mapToData": null,
  6165. "validation": null,
  6166. "alias": null,
  6167. "deprecated": null
  6168. },
  6169. {
  6170. "name": "direction",
  6171. "description": "The direction of the sort. Can be either `asc` or `desc`.",
  6172. "in": "QUERY",
  6173. "type": "string",
  6174. "required": false,
  6175. "enum": ["asc", "desc"],
  6176. "allowNull": false,
  6177. "mapToData": null,
  6178. "validation": null,
  6179. "alias": null,
  6180. "deprecated": null
  6181. },
  6182. {
  6183. "name": "since",
  6184. "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  6185. "in": "QUERY",
  6186. "type": "string",
  6187. "required": false,
  6188. "enum": null,
  6189. "allowNull": false,
  6190. "mapToData": null,
  6191. "validation": null,
  6192. "alias": null,
  6193. "deprecated": null
  6194. },
  6195. {
  6196. "name": "per_page",
  6197. "description": "Results per page (max 100)",
  6198. "in": "QUERY",
  6199. "type": "integer",
  6200. "required": false,
  6201. "enum": null,
  6202. "allowNull": false,
  6203. "mapToData": null,
  6204. "validation": null,
  6205. "alias": null,
  6206. "deprecated": null
  6207. },
  6208. {
  6209. "name": "page",
  6210. "description": "Page number of the results to fetch.",
  6211. "in": "QUERY",
  6212. "type": "integer",
  6213. "required": false,
  6214. "enum": null,
  6215. "allowNull": false,
  6216. "mapToData": null,
  6217. "validation": null,
  6218. "alias": null,
  6219. "deprecated": null
  6220. }
  6221. ],
  6222. "responses": [
  6223. {
  6224. "code": 200,
  6225. "description": "response",
  6226. "examples": [
  6227. {
  6228. "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}]"
  6229. }
  6230. ]
  6231. }
  6232. ],
  6233. "renamed": null
  6234. },
  6235. {
  6236. "name": "Members list",
  6237. "scope": "orgs",
  6238. "id": "listMembers",
  6239. "method": "GET",
  6240. "url": "/orgs/{org}/members",
  6241. "isDeprecated": false,
  6242. "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.\n\n",
  6243. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#members-list",
  6244. "previews": [],
  6245. "headers": [],
  6246. "parameters": [
  6247. {
  6248. "name": "org",
  6249. "description": "org parameter",
  6250. "in": "PATH",
  6251. "type": "string",
  6252. "required": true,
  6253. "enum": null,
  6254. "allowNull": false,
  6255. "mapToData": null,
  6256. "validation": null,
  6257. "alias": null,
  6258. "deprecated": null
  6259. },
  6260. {
  6261. "name": "filter",
  6262. "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.",
  6263. "in": "QUERY",
  6264. "type": "string",
  6265. "required": false,
  6266. "enum": ["2fa_disabled", "all"],
  6267. "allowNull": false,
  6268. "mapToData": null,
  6269. "validation": null,
  6270. "alias": null,
  6271. "deprecated": null
  6272. },
  6273. {
  6274. "name": "role",
  6275. "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.",
  6276. "in": "QUERY",
  6277. "type": "string",
  6278. "required": false,
  6279. "enum": ["all", "admin", "member"],
  6280. "allowNull": false,
  6281. "mapToData": null,
  6282. "validation": null,
  6283. "alias": null,
  6284. "deprecated": null
  6285. },
  6286. {
  6287. "name": "per_page",
  6288. "description": "Results per page (max 100)",
  6289. "in": "QUERY",
  6290. "type": "integer",
  6291. "required": false,
  6292. "enum": null,
  6293. "allowNull": false,
  6294. "mapToData": null,
  6295. "validation": null,
  6296. "alias": null,
  6297. "deprecated": null
  6298. },
  6299. {
  6300. "name": "page",
  6301. "description": "Page number of the results to fetch.",
  6302. "in": "QUERY",
  6303. "type": "integer",
  6304. "required": false,
  6305. "enum": null,
  6306. "allowNull": false,
  6307. "mapToData": null,
  6308. "validation": null,
  6309. "alias": null,
  6310. "deprecated": null
  6311. }
  6312. ],
  6313. "responses": [
  6314. {
  6315. "code": 200,
  6316. "description": "response",
  6317. "examples": [
  6318. {
  6319. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  6320. }
  6321. ]
  6322. }
  6323. ],
  6324. "renamed": null
  6325. },
  6326. {
  6327. "name": "Check membership",
  6328. "scope": "orgs",
  6329. "id": "checkMembership",
  6330. "method": "GET",
  6331. "url": "/orgs/{org}/members/{username}",
  6332. "isDeprecated": false,
  6333. "description": "Check if a user is, publicly or privately, a member of the organization.",
  6334. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#check-membership",
  6335. "previews": [],
  6336. "headers": [],
  6337. "parameters": [
  6338. {
  6339. "name": "org",
  6340. "description": "org parameter",
  6341. "in": "PATH",
  6342. "type": "string",
  6343. "required": true,
  6344. "enum": null,
  6345. "allowNull": false,
  6346. "mapToData": null,
  6347. "validation": null,
  6348. "alias": null,
  6349. "deprecated": null
  6350. },
  6351. {
  6352. "name": "username",
  6353. "description": "username parameter",
  6354. "in": "PATH",
  6355. "type": "string",
  6356. "required": true,
  6357. "enum": null,
  6358. "allowNull": false,
  6359. "mapToData": null,
  6360. "validation": null,
  6361. "alias": null,
  6362. "deprecated": null
  6363. }
  6364. ],
  6365. "responses": [],
  6366. "renamed": null
  6367. },
  6368. {
  6369. "name": "Remove a member",
  6370. "scope": "orgs",
  6371. "id": "removeMember",
  6372. "method": "DELETE",
  6373. "url": "/orgs/{org}/members/{username}",
  6374. "isDeprecated": false,
  6375. "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.",
  6376. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#remove-a-member",
  6377. "previews": [],
  6378. "headers": [],
  6379. "parameters": [
  6380. {
  6381. "name": "org",
  6382. "description": "org parameter",
  6383. "in": "PATH",
  6384. "type": "string",
  6385. "required": true,
  6386. "enum": null,
  6387. "allowNull": false,
  6388. "mapToData": null,
  6389. "validation": null,
  6390. "alias": null,
  6391. "deprecated": null
  6392. },
  6393. {
  6394. "name": "username",
  6395. "description": "username parameter",
  6396. "in": "PATH",
  6397. "type": "string",
  6398. "required": true,
  6399. "enum": null,
  6400. "allowNull": false,
  6401. "mapToData": null,
  6402. "validation": null,
  6403. "alias": null,
  6404. "deprecated": null
  6405. }
  6406. ],
  6407. "responses": [],
  6408. "renamed": null
  6409. },
  6410. {
  6411. "name": "Get organization membership",
  6412. "scope": "orgs",
  6413. "id": "getMembership",
  6414. "method": "GET",
  6415. "url": "/orgs/{org}/memberships/{username}",
  6416. "isDeprecated": false,
  6417. "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.",
  6418. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#get-organization-membership",
  6419. "previews": [],
  6420. "headers": [],
  6421. "parameters": [
  6422. {
  6423. "name": "org",
  6424. "description": "org parameter",
  6425. "in": "PATH",
  6426. "type": "string",
  6427. "required": true,
  6428. "enum": null,
  6429. "allowNull": false,
  6430. "mapToData": null,
  6431. "validation": null,
  6432. "alias": null,
  6433. "deprecated": null
  6434. },
  6435. {
  6436. "name": "username",
  6437. "description": "username parameter",
  6438. "in": "PATH",
  6439. "type": "string",
  6440. "required": true,
  6441. "enum": null,
  6442. "allowNull": false,
  6443. "mapToData": null,
  6444. "validation": null,
  6445. "alias": null,
  6446. "deprecated": null
  6447. }
  6448. ],
  6449. "responses": [
  6450. {
  6451. "code": 200,
  6452. "description": "response",
  6453. "examples": [
  6454. {
  6455. "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  6456. },
  6457. {
  6458. "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"member\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  6459. },
  6460. {
  6461. "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"member\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  6462. }
  6463. ]
  6464. }
  6465. ],
  6466. "renamed": null
  6467. },
  6468. {
  6469. "name": "Add or update organization membership",
  6470. "scope": "orgs",
  6471. "id": "addOrUpdateMembership",
  6472. "method": "PUT",
  6473. "url": "/orgs/{org}/memberships/{username}",
  6474. "isDeprecated": false,
  6475. "description": "Only authenticated organization owners can add a member to the organization or update the member's role.",
  6476. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#add-or-update-organization-membership",
  6477. "previews": [],
  6478. "headers": [],
  6479. "parameters": [
  6480. {
  6481. "name": "org",
  6482. "description": "org parameter",
  6483. "in": "PATH",
  6484. "type": "string",
  6485. "required": true,
  6486. "enum": null,
  6487. "allowNull": false,
  6488. "mapToData": null,
  6489. "validation": null,
  6490. "alias": null,
  6491. "deprecated": null
  6492. },
  6493. {
  6494. "name": "username",
  6495. "description": "username parameter",
  6496. "in": "PATH",
  6497. "type": "string",
  6498. "required": true,
  6499. "enum": null,
  6500. "allowNull": false,
  6501. "mapToData": null,
  6502. "validation": null,
  6503. "alias": null,
  6504. "deprecated": null
  6505. },
  6506. {
  6507. "name": "role",
  6508. "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.",
  6509. "in": "BODY",
  6510. "type": "string",
  6511. "required": false,
  6512. "enum": ["admin", "member"],
  6513. "allowNull": false,
  6514. "mapToData": null,
  6515. "validation": null,
  6516. "alias": null,
  6517. "deprecated": null
  6518. }
  6519. ],
  6520. "responses": [
  6521. {
  6522. "code": 200,
  6523. "description": "response",
  6524. "examples": [
  6525. {
  6526. "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  6527. }
  6528. ]
  6529. }
  6530. ],
  6531. "renamed": null
  6532. },
  6533. {
  6534. "name": "Remove organization membership",
  6535. "scope": "orgs",
  6536. "id": "removeMembership",
  6537. "method": "DELETE",
  6538. "url": "/orgs/{org}/memberships/{username}",
  6539. "isDeprecated": false,
  6540. "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.",
  6541. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#remove-organization-membership",
  6542. "previews": [],
  6543. "headers": [],
  6544. "parameters": [
  6545. {
  6546. "name": "org",
  6547. "description": "org parameter",
  6548. "in": "PATH",
  6549. "type": "string",
  6550. "required": true,
  6551. "enum": null,
  6552. "allowNull": false,
  6553. "mapToData": null,
  6554. "validation": null,
  6555. "alias": null,
  6556. "deprecated": null
  6557. },
  6558. {
  6559. "name": "username",
  6560. "description": "username parameter",
  6561. "in": "PATH",
  6562. "type": "string",
  6563. "required": true,
  6564. "enum": null,
  6565. "allowNull": false,
  6566. "mapToData": null,
  6567. "validation": null,
  6568. "alias": null,
  6569. "deprecated": null
  6570. }
  6571. ],
  6572. "responses": [],
  6573. "renamed": null
  6574. },
  6575. {
  6576. "name": "List outside collaborators",
  6577. "scope": "orgs",
  6578. "id": "listOutsideCollaborators",
  6579. "method": "GET",
  6580. "url": "/orgs/{org}/outside_collaborators",
  6581. "isDeprecated": false,
  6582. "description": "List all users who are outside collaborators of an organization.\n\n",
  6583. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/outside_collaborators/#list-outside-collaborators",
  6584. "previews": [],
  6585. "headers": [],
  6586. "parameters": [
  6587. {
  6588. "name": "org",
  6589. "description": "org parameter",
  6590. "in": "PATH",
  6591. "type": "string",
  6592. "required": true,
  6593. "enum": null,
  6594. "allowNull": false,
  6595. "mapToData": null,
  6596. "validation": null,
  6597. "alias": null,
  6598. "deprecated": null
  6599. },
  6600. {
  6601. "name": "filter",
  6602. "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.",
  6603. "in": "QUERY",
  6604. "type": "string",
  6605. "required": false,
  6606. "enum": ["2fa_disabled", "all"],
  6607. "allowNull": false,
  6608. "mapToData": null,
  6609. "validation": null,
  6610. "alias": null,
  6611. "deprecated": null
  6612. },
  6613. {
  6614. "name": "per_page",
  6615. "description": "Results per page (max 100)",
  6616. "in": "QUERY",
  6617. "type": "integer",
  6618. "required": false,
  6619. "enum": null,
  6620. "allowNull": false,
  6621. "mapToData": null,
  6622. "validation": null,
  6623. "alias": null,
  6624. "deprecated": null
  6625. },
  6626. {
  6627. "name": "page",
  6628. "description": "Page number of the results to fetch.",
  6629. "in": "QUERY",
  6630. "type": "integer",
  6631. "required": false,
  6632. "enum": null,
  6633. "allowNull": false,
  6634. "mapToData": null,
  6635. "validation": null,
  6636. "alias": null,
  6637. "deprecated": null
  6638. }
  6639. ],
  6640. "responses": [
  6641. {
  6642. "code": 200,
  6643. "description": "response",
  6644. "examples": [
  6645. {
  6646. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  6647. }
  6648. ]
  6649. }
  6650. ],
  6651. "renamed": null
  6652. },
  6653. {
  6654. "name": "Remove outside collaborator",
  6655. "scope": "orgs",
  6656. "id": "removeOutsideCollaborator",
  6657. "method": "DELETE",
  6658. "url": "/orgs/{org}/outside_collaborators/{username}",
  6659. "isDeprecated": false,
  6660. "description": "Removing a user from this list will remove them from all the organization's repositories.",
  6661. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/outside_collaborators/#remove-outside-collaborator",
  6662. "previews": [],
  6663. "headers": [],
  6664. "parameters": [
  6665. {
  6666. "name": "org",
  6667. "description": "org parameter",
  6668. "in": "PATH",
  6669. "type": "string",
  6670. "required": true,
  6671. "enum": null,
  6672. "allowNull": false,
  6673. "mapToData": null,
  6674. "validation": null,
  6675. "alias": null,
  6676. "deprecated": null
  6677. },
  6678. {
  6679. "name": "username",
  6680. "description": "username parameter",
  6681. "in": "PATH",
  6682. "type": "string",
  6683. "required": true,
  6684. "enum": null,
  6685. "allowNull": false,
  6686. "mapToData": null,
  6687. "validation": null,
  6688. "alias": null,
  6689. "deprecated": null
  6690. }
  6691. ],
  6692. "responses": [
  6693. {
  6694. "code": 422,
  6695. "description": "Response if user is a member of the organization",
  6696. "examples": [
  6697. {
  6698. "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/orgs/outside_collaborators/#remove-outside-collaborator\"}"
  6699. }
  6700. ]
  6701. }
  6702. ],
  6703. "renamed": null
  6704. },
  6705. {
  6706. "name": "Convert member to outside collaborator",
  6707. "scope": "orgs",
  6708. "id": "convertMemberToOutsideCollaborator",
  6709. "method": "PUT",
  6710. "url": "/orgs/{org}/outside_collaborators/{username}",
  6711. "isDeprecated": false,
  6712. "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".",
  6713. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator",
  6714. "previews": [],
  6715. "headers": [],
  6716. "parameters": [
  6717. {
  6718. "name": "org",
  6719. "description": "org parameter",
  6720. "in": "PATH",
  6721. "type": "string",
  6722. "required": true,
  6723. "enum": null,
  6724. "allowNull": false,
  6725. "mapToData": null,
  6726. "validation": null,
  6727. "alias": null,
  6728. "deprecated": null
  6729. },
  6730. {
  6731. "name": "username",
  6732. "description": "username parameter",
  6733. "in": "PATH",
  6734. "type": "string",
  6735. "required": true,
  6736. "enum": null,
  6737. "allowNull": false,
  6738. "mapToData": null,
  6739. "validation": null,
  6740. "alias": null,
  6741. "deprecated": null
  6742. }
  6743. ],
  6744. "responses": [
  6745. {
  6746. "code": 403,
  6747. "description": "response",
  6748. "examples": [
  6749. {
  6750. "data": "{\"message\":\"Cannot convert the last owner to an outside collaborator\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\"}"
  6751. },
  6752. {
  6753. "data": "{\"message\":\"<user> is not a member of the <organization> organization.\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\"}"
  6754. }
  6755. ]
  6756. }
  6757. ],
  6758. "renamed": null
  6759. },
  6760. {
  6761. "name": "List pre-receive hooks for organization",
  6762. "scope": "enterpriseAdmin",
  6763. "id": "listPreReceiveHooksForOrg",
  6764. "method": "GET",
  6765. "url": "/orgs/{org}/pre-receive-hooks",
  6766. "isDeprecated": false,
  6767. "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.",
  6768. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/org_pre_receive_hooks/#list-pre-receive-hooks",
  6769. "previews": [],
  6770. "headers": [],
  6771. "parameters": [
  6772. {
  6773. "name": "org",
  6774. "description": "org parameter",
  6775. "in": "PATH",
  6776. "type": "string",
  6777. "required": true,
  6778. "enum": null,
  6779. "allowNull": false,
  6780. "mapToData": null,
  6781. "validation": null,
  6782. "alias": null,
  6783. "deprecated": null
  6784. },
  6785. {
  6786. "name": "per_page",
  6787. "description": "Results per page (max 100)",
  6788. "in": "QUERY",
  6789. "type": "integer",
  6790. "required": false,
  6791. "enum": null,
  6792. "allowNull": false,
  6793. "mapToData": null,
  6794. "validation": null,
  6795. "alias": null,
  6796. "deprecated": null
  6797. },
  6798. {
  6799. "name": "page",
  6800. "description": "Page number of the results to fetch.",
  6801. "in": "QUERY",
  6802. "type": "integer",
  6803. "required": false,
  6804. "enum": null,
  6805. "allowNull": false,
  6806. "mapToData": null,
  6807. "validation": null,
  6808. "alias": null,
  6809. "deprecated": null
  6810. }
  6811. ],
  6812. "responses": [
  6813. {
  6814. "code": 200,
  6815. "description": "response",
  6816. "examples": [
  6817. {
  6818. "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}]"
  6819. }
  6820. ]
  6821. }
  6822. ],
  6823. "renamed": null
  6824. },
  6825. {
  6826. "name": "Get a single pre-receive hook for organization",
  6827. "scope": "enterpriseAdmin",
  6828. "id": "getPreReceiveHookForOrg",
  6829. "method": "GET",
  6830. "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}",
  6831. "isDeprecated": false,
  6832. "description": "",
  6833. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/org_pre_receive_hooks/#get-a-single-pre-receive-hook",
  6834. "previews": [],
  6835. "headers": [],
  6836. "parameters": [
  6837. {
  6838. "name": "org",
  6839. "description": "org parameter",
  6840. "in": "PATH",
  6841. "type": "string",
  6842. "required": true,
  6843. "enum": null,
  6844. "allowNull": false,
  6845. "mapToData": null,
  6846. "validation": null,
  6847. "alias": null,
  6848. "deprecated": null
  6849. },
  6850. {
  6851. "name": "pre_receive_hook_id",
  6852. "description": "pre_receive_hook_id parameter",
  6853. "in": "PATH",
  6854. "type": "integer",
  6855. "required": true,
  6856. "enum": null,
  6857. "allowNull": false,
  6858. "mapToData": null,
  6859. "validation": null,
  6860. "alias": null,
  6861. "deprecated": null
  6862. }
  6863. ],
  6864. "responses": [
  6865. {
  6866. "code": 200,
  6867. "description": "response",
  6868. "examples": [
  6869. {
  6870. "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}"
  6871. }
  6872. ]
  6873. }
  6874. ],
  6875. "renamed": null
  6876. },
  6877. {
  6878. "name": "Update pre-receive hook enforcement for organization",
  6879. "scope": "enterpriseAdmin",
  6880. "id": "updatePreReceiveHookEnforcementForOrg",
  6881. "method": "PATCH",
  6882. "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}",
  6883. "isDeprecated": false,
  6884. "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`",
  6885. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/org_pre_receive_hooks/#update-pre-receive-hook-enforcement",
  6886. "previews": [],
  6887. "headers": [],
  6888. "parameters": [
  6889. {
  6890. "name": "org",
  6891. "description": "org parameter",
  6892. "in": "PATH",
  6893. "type": "string",
  6894. "required": true,
  6895. "enum": null,
  6896. "allowNull": false,
  6897. "mapToData": null,
  6898. "validation": null,
  6899. "alias": null,
  6900. "deprecated": null
  6901. },
  6902. {
  6903. "name": "pre_receive_hook_id",
  6904. "description": "pre_receive_hook_id parameter",
  6905. "in": "PATH",
  6906. "type": "integer",
  6907. "required": true,
  6908. "enum": null,
  6909. "allowNull": false,
  6910. "mapToData": null,
  6911. "validation": null,
  6912. "alias": null,
  6913. "deprecated": null
  6914. }
  6915. ],
  6916. "responses": [
  6917. {
  6918. "code": 200,
  6919. "description": "response",
  6920. "examples": [
  6921. {
  6922. "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\",\"allow_downstream_configuration\":false}"
  6923. }
  6924. ]
  6925. }
  6926. ],
  6927. "renamed": null
  6928. },
  6929. {
  6930. "name": "Remove enforcement overrides for a pre-receive hook for organization",
  6931. "scope": "enterpriseAdmin",
  6932. "id": "removeEnforcementOverridesForPreReceiveHookForOrg",
  6933. "method": "DELETE",
  6934. "url": "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}",
  6935. "isDeprecated": false,
  6936. "description": "Removes any overrides for this hook at the org level for this org.",
  6937. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/org_pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook",
  6938. "previews": [],
  6939. "headers": [],
  6940. "parameters": [
  6941. {
  6942. "name": "org",
  6943. "description": "org parameter",
  6944. "in": "PATH",
  6945. "type": "string",
  6946. "required": true,
  6947. "enum": null,
  6948. "allowNull": false,
  6949. "mapToData": null,
  6950. "validation": null,
  6951. "alias": null,
  6952. "deprecated": null
  6953. },
  6954. {
  6955. "name": "pre_receive_hook_id",
  6956. "description": "pre_receive_hook_id parameter",
  6957. "in": "PATH",
  6958. "type": "integer",
  6959. "required": true,
  6960. "enum": null,
  6961. "allowNull": false,
  6962. "mapToData": null,
  6963. "validation": null,
  6964. "alias": null,
  6965. "deprecated": null
  6966. }
  6967. ],
  6968. "responses": [
  6969. {
  6970. "code": 200,
  6971. "description": "response",
  6972. "examples": [
  6973. {
  6974. "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/admin/pre-receive-hooks/42\",\"allow_downstream_configuration\":true}"
  6975. }
  6976. ]
  6977. }
  6978. ],
  6979. "renamed": null
  6980. },
  6981. {
  6982. "name": "List organization projects",
  6983. "scope": "projects",
  6984. "id": "listForOrg",
  6985. "method": "GET",
  6986. "url": "/orgs/{org}/projects",
  6987. "isDeprecated": false,
  6988. "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.\n\ns",
  6989. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#list-organization-projects",
  6990. "previews": [{ "name": "inertia" }],
  6991. "headers": [
  6992. {
  6993. "name": "accept",
  6994. "value": "application/vnd.github.inertia-preview+json"
  6995. }
  6996. ],
  6997. "parameters": [
  6998. {
  6999. "name": "org",
  7000. "description": "org parameter",
  7001. "in": "PATH",
  7002. "type": "string",
  7003. "required": true,
  7004. "enum": null,
  7005. "allowNull": false,
  7006. "mapToData": null,
  7007. "validation": null,
  7008. "alias": null,
  7009. "deprecated": null
  7010. },
  7011. {
  7012. "name": "state",
  7013. "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
  7014. "in": "QUERY",
  7015. "type": "string",
  7016. "required": false,
  7017. "enum": ["open", "closed", "all"],
  7018. "allowNull": false,
  7019. "mapToData": null,
  7020. "validation": null,
  7021. "alias": null,
  7022. "deprecated": null
  7023. },
  7024. {
  7025. "name": "per_page",
  7026. "description": "Results per page (max 100)",
  7027. "in": "QUERY",
  7028. "type": "integer",
  7029. "required": false,
  7030. "enum": null,
  7031. "allowNull": false,
  7032. "mapToData": null,
  7033. "validation": null,
  7034. "alias": null,
  7035. "deprecated": null
  7036. },
  7037. {
  7038. "name": "page",
  7039. "description": "Page number of the results to fetch.",
  7040. "in": "QUERY",
  7041. "type": "integer",
  7042. "required": false,
  7043. "enum": null,
  7044. "allowNull": false,
  7045. "mapToData": null,
  7046. "validation": null,
  7047. "alias": null,
  7048. "deprecated": null
  7049. }
  7050. ],
  7051. "responses": [
  7052. {
  7053. "code": 200,
  7054. "description": "response",
  7055. "examples": [
  7056. {
  7057. "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]"
  7058. }
  7059. ]
  7060. }
  7061. ],
  7062. "renamed": null
  7063. },
  7064. {
  7065. "name": "Create an organization project",
  7066. "scope": "projects",
  7067. "id": "createForOrg",
  7068. "method": "POST",
  7069. "url": "/orgs/{org}/projects",
  7070. "isDeprecated": false,
  7071. "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
  7072. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#create-an-organization-project",
  7073. "previews": [{ "name": "inertia" }],
  7074. "headers": [
  7075. {
  7076. "name": "accept",
  7077. "value": "application/vnd.github.inertia-preview+json"
  7078. }
  7079. ],
  7080. "parameters": [
  7081. {
  7082. "name": "org",
  7083. "description": "org parameter",
  7084. "in": "PATH",
  7085. "type": "string",
  7086. "required": true,
  7087. "enum": null,
  7088. "allowNull": false,
  7089. "mapToData": null,
  7090. "validation": null,
  7091. "alias": null,
  7092. "deprecated": null
  7093. },
  7094. {
  7095. "name": "name",
  7096. "description": "The name of the project.",
  7097. "in": "BODY",
  7098. "type": "string",
  7099. "required": true,
  7100. "enum": null,
  7101. "allowNull": false,
  7102. "mapToData": null,
  7103. "validation": null,
  7104. "alias": null,
  7105. "deprecated": null
  7106. },
  7107. {
  7108. "name": "body",
  7109. "description": "The description of the project.",
  7110. "in": "BODY",
  7111. "type": "string",
  7112. "required": false,
  7113. "enum": null,
  7114. "allowNull": false,
  7115. "mapToData": null,
  7116. "validation": null,
  7117. "alias": null,
  7118. "deprecated": null
  7119. }
  7120. ],
  7121. "responses": [
  7122. {
  7123. "code": 201,
  7124. "description": "response",
  7125. "examples": [
  7126. {
  7127. "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}"
  7128. }
  7129. ]
  7130. }
  7131. ],
  7132. "renamed": null
  7133. },
  7134. {
  7135. "name": "Public members list",
  7136. "scope": "orgs",
  7137. "id": "listPublicMembers",
  7138. "method": "GET",
  7139. "url": "/orgs/{org}/public_members",
  7140. "isDeprecated": false,
  7141. "description": "Members of an organization can choose to have their membership publicized or not.",
  7142. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#public-members-list",
  7143. "previews": [],
  7144. "headers": [],
  7145. "parameters": [
  7146. {
  7147. "name": "org",
  7148. "description": "org parameter",
  7149. "in": "PATH",
  7150. "type": "string",
  7151. "required": true,
  7152. "enum": null,
  7153. "allowNull": false,
  7154. "mapToData": null,
  7155. "validation": null,
  7156. "alias": null,
  7157. "deprecated": null
  7158. },
  7159. {
  7160. "name": "per_page",
  7161. "description": "Results per page (max 100)",
  7162. "in": "QUERY",
  7163. "type": "integer",
  7164. "required": false,
  7165. "enum": null,
  7166. "allowNull": false,
  7167. "mapToData": null,
  7168. "validation": null,
  7169. "alias": null,
  7170. "deprecated": null
  7171. },
  7172. {
  7173. "name": "page",
  7174. "description": "Page number of the results to fetch.",
  7175. "in": "QUERY",
  7176. "type": "integer",
  7177. "required": false,
  7178. "enum": null,
  7179. "allowNull": false,
  7180. "mapToData": null,
  7181. "validation": null,
  7182. "alias": null,
  7183. "deprecated": null
  7184. }
  7185. ],
  7186. "responses": [
  7187. {
  7188. "code": 200,
  7189. "description": "response",
  7190. "examples": [
  7191. {
  7192. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  7193. }
  7194. ]
  7195. }
  7196. ],
  7197. "renamed": null
  7198. },
  7199. {
  7200. "name": "Check public membership",
  7201. "scope": "orgs",
  7202. "id": "checkPublicMembership",
  7203. "method": "GET",
  7204. "url": "/orgs/{org}/public_members/{username}",
  7205. "isDeprecated": false,
  7206. "description": "",
  7207. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#check-public-membership",
  7208. "previews": [],
  7209. "headers": [],
  7210. "parameters": [
  7211. {
  7212. "name": "org",
  7213. "description": "org parameter",
  7214. "in": "PATH",
  7215. "type": "string",
  7216. "required": true,
  7217. "enum": null,
  7218. "allowNull": false,
  7219. "mapToData": null,
  7220. "validation": null,
  7221. "alias": null,
  7222. "deprecated": null
  7223. },
  7224. {
  7225. "name": "username",
  7226. "description": "username parameter",
  7227. "in": "PATH",
  7228. "type": "string",
  7229. "required": true,
  7230. "enum": null,
  7231. "allowNull": false,
  7232. "mapToData": null,
  7233. "validation": null,
  7234. "alias": null,
  7235. "deprecated": null
  7236. }
  7237. ],
  7238. "responses": [],
  7239. "renamed": null
  7240. },
  7241. {
  7242. "name": "Publicize a user's membership",
  7243. "scope": "orgs",
  7244. "id": "publicizeMembership",
  7245. "method": "PUT",
  7246. "url": "/orgs/{org}/public_members/{username}",
  7247. "isDeprecated": false,
  7248. "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  7249. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#publicize-a-users-membership",
  7250. "previews": [],
  7251. "headers": [],
  7252. "parameters": [
  7253. {
  7254. "name": "org",
  7255. "description": "org parameter",
  7256. "in": "PATH",
  7257. "type": "string",
  7258. "required": true,
  7259. "enum": null,
  7260. "allowNull": false,
  7261. "mapToData": null,
  7262. "validation": null,
  7263. "alias": null,
  7264. "deprecated": null
  7265. },
  7266. {
  7267. "name": "username",
  7268. "description": "username parameter",
  7269. "in": "PATH",
  7270. "type": "string",
  7271. "required": true,
  7272. "enum": null,
  7273. "allowNull": false,
  7274. "mapToData": null,
  7275. "validation": null,
  7276. "alias": null,
  7277. "deprecated": null
  7278. }
  7279. ],
  7280. "responses": [],
  7281. "renamed": null
  7282. },
  7283. {
  7284. "name": "Conceal a user's membership",
  7285. "scope": "orgs",
  7286. "id": "concealMembership",
  7287. "method": "DELETE",
  7288. "url": "/orgs/{org}/public_members/{username}",
  7289. "isDeprecated": false,
  7290. "description": "",
  7291. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#conceal-a-users-membership",
  7292. "previews": [],
  7293. "headers": [],
  7294. "parameters": [
  7295. {
  7296. "name": "org",
  7297. "description": "org parameter",
  7298. "in": "PATH",
  7299. "type": "string",
  7300. "required": true,
  7301. "enum": null,
  7302. "allowNull": false,
  7303. "mapToData": null,
  7304. "validation": null,
  7305. "alias": null,
  7306. "deprecated": null
  7307. },
  7308. {
  7309. "name": "username",
  7310. "description": "username parameter",
  7311. "in": "PATH",
  7312. "type": "string",
  7313. "required": true,
  7314. "enum": null,
  7315. "allowNull": false,
  7316. "mapToData": null,
  7317. "validation": null,
  7318. "alias": null,
  7319. "deprecated": null
  7320. }
  7321. ],
  7322. "responses": [],
  7323. "renamed": null
  7324. },
  7325. {
  7326. "name": "List organization repositories",
  7327. "scope": "repos",
  7328. "id": "listForOrg",
  7329. "method": "GET",
  7330. "url": "/orgs/{org}/repos",
  7331. "isDeprecated": false,
  7332. "description": "Lists repositories for the specified organization.",
  7333. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-organization-repositories",
  7334. "previews": [],
  7335. "headers": [],
  7336. "parameters": [
  7337. {
  7338. "name": "org",
  7339. "description": "org parameter",
  7340. "in": "PATH",
  7341. "type": "string",
  7342. "required": true,
  7343. "enum": null,
  7344. "allowNull": false,
  7345. "mapToData": null,
  7346. "validation": null,
  7347. "alias": null,
  7348. "deprecated": null
  7349. },
  7350. {
  7351. "name": "type",
  7352. "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`.",
  7353. "in": "QUERY",
  7354. "type": "string",
  7355. "required": false,
  7356. "enum": ["all", "public", "private", "forks", "sources", "member"],
  7357. "allowNull": false,
  7358. "mapToData": null,
  7359. "validation": null,
  7360. "alias": null,
  7361. "deprecated": null
  7362. },
  7363. {
  7364. "name": "sort",
  7365. "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
  7366. "in": "QUERY",
  7367. "type": "string",
  7368. "required": false,
  7369. "enum": ["created", "updated", "pushed", "full_name"],
  7370. "allowNull": false,
  7371. "mapToData": null,
  7372. "validation": null,
  7373. "alias": null,
  7374. "deprecated": null
  7375. },
  7376. {
  7377. "name": "direction",
  7378. "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`",
  7379. "in": "QUERY",
  7380. "type": "string",
  7381. "required": false,
  7382. "enum": ["asc", "desc"],
  7383. "allowNull": false,
  7384. "mapToData": null,
  7385. "validation": null,
  7386. "alias": null,
  7387. "deprecated": null
  7388. },
  7389. {
  7390. "name": "per_page",
  7391. "description": "Results per page (max 100)",
  7392. "in": "QUERY",
  7393. "type": "integer",
  7394. "required": false,
  7395. "enum": null,
  7396. "allowNull": false,
  7397. "mapToData": null,
  7398. "validation": null,
  7399. "alias": null,
  7400. "deprecated": null
  7401. },
  7402. {
  7403. "name": "page",
  7404. "description": "Page number of the results to fetch.",
  7405. "in": "QUERY",
  7406. "type": "integer",
  7407. "required": false,
  7408. "enum": null,
  7409. "allowNull": false,
  7410. "mapToData": null,
  7411. "validation": null,
  7412. "alias": null,
  7413. "deprecated": null
  7414. }
  7415. ],
  7416. "responses": [
  7417. {
  7418. "code": 200,
  7419. "description": "response",
  7420. "examples": [
  7421. {
  7422. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]"
  7423. }
  7424. ]
  7425. }
  7426. ],
  7427. "renamed": null
  7428. },
  7429. {
  7430. "name": "Creates a new repository in the specified organization",
  7431. "scope": "repos",
  7432. "id": "createInOrg",
  7433. "method": "POST",
  7434. "url": "/orgs/{org}/repos",
  7435. "isDeprecated": false,
  7436. "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
  7437. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#create",
  7438. "previews": [],
  7439. "headers": [],
  7440. "parameters": [
  7441. {
  7442. "name": "org",
  7443. "description": "org parameter",
  7444. "in": "PATH",
  7445. "type": "string",
  7446. "required": true,
  7447. "enum": null,
  7448. "allowNull": false,
  7449. "mapToData": null,
  7450. "validation": null,
  7451. "alias": null,
  7452. "deprecated": null
  7453. },
  7454. {
  7455. "name": "name",
  7456. "description": "The name of the repository.",
  7457. "in": "BODY",
  7458. "type": "string",
  7459. "required": true,
  7460. "enum": null,
  7461. "allowNull": false,
  7462. "mapToData": null,
  7463. "validation": null,
  7464. "alias": null,
  7465. "deprecated": null
  7466. },
  7467. {
  7468. "name": "description",
  7469. "description": "A short description of the repository.",
  7470. "in": "BODY",
  7471. "type": "string",
  7472. "required": false,
  7473. "enum": null,
  7474. "allowNull": false,
  7475. "mapToData": null,
  7476. "validation": null,
  7477. "alias": null,
  7478. "deprecated": null
  7479. },
  7480. {
  7481. "name": "homepage",
  7482. "description": "A URL with more information about the repository.",
  7483. "in": "BODY",
  7484. "type": "string",
  7485. "required": false,
  7486. "enum": null,
  7487. "allowNull": false,
  7488. "mapToData": null,
  7489. "validation": null,
  7490. "alias": null,
  7491. "deprecated": null
  7492. },
  7493. {
  7494. "name": "private",
  7495. "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.",
  7496. "in": "BODY",
  7497. "type": "boolean",
  7498. "required": false,
  7499. "enum": null,
  7500. "allowNull": false,
  7501. "mapToData": null,
  7502. "validation": null,
  7503. "alias": null,
  7504. "deprecated": null
  7505. },
  7506. {
  7507. "name": "has_issues",
  7508. "description": "Either `true` to enable issues for this repository or `false` to disable them.",
  7509. "in": "BODY",
  7510. "type": "boolean",
  7511. "required": false,
  7512. "enum": null,
  7513. "allowNull": false,
  7514. "mapToData": null,
  7515. "validation": null,
  7516. "alias": null,
  7517. "deprecated": null
  7518. },
  7519. {
  7520. "name": "has_projects",
  7521. "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.",
  7522. "in": "BODY",
  7523. "type": "boolean",
  7524. "required": false,
  7525. "enum": null,
  7526. "allowNull": false,
  7527. "mapToData": null,
  7528. "validation": null,
  7529. "alias": null,
  7530. "deprecated": null
  7531. },
  7532. {
  7533. "name": "has_wiki",
  7534. "description": "Either `true` to enable the wiki for this repository or `false` to disable it.",
  7535. "in": "BODY",
  7536. "type": "boolean",
  7537. "required": false,
  7538. "enum": null,
  7539. "allowNull": false,
  7540. "mapToData": null,
  7541. "validation": null,
  7542. "alias": null,
  7543. "deprecated": null
  7544. },
  7545. {
  7546. "name": "team_id",
  7547. "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
  7548. "in": "BODY",
  7549. "type": "integer",
  7550. "required": false,
  7551. "enum": null,
  7552. "allowNull": false,
  7553. "mapToData": null,
  7554. "validation": null,
  7555. "alias": null,
  7556. "deprecated": null
  7557. },
  7558. {
  7559. "name": "auto_init",
  7560. "description": "Pass `true` to create an initial commit with empty README.",
  7561. "in": "BODY",
  7562. "type": "boolean",
  7563. "required": false,
  7564. "enum": null,
  7565. "allowNull": false,
  7566. "mapToData": null,
  7567. "validation": null,
  7568. "alias": null,
  7569. "deprecated": null
  7570. },
  7571. {
  7572. "name": "gitignore_template",
  7573. "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".",
  7574. "in": "BODY",
  7575. "type": "string",
  7576. "required": false,
  7577. "enum": null,
  7578. "allowNull": false,
  7579. "mapToData": null,
  7580. "validation": null,
  7581. "alias": null,
  7582. "deprecated": null
  7583. },
  7584. {
  7585. "name": "license_template",
  7586. "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".",
  7587. "in": "BODY",
  7588. "type": "string",
  7589. "required": false,
  7590. "enum": null,
  7591. "allowNull": false,
  7592. "mapToData": null,
  7593. "validation": null,
  7594. "alias": null,
  7595. "deprecated": null
  7596. },
  7597. {
  7598. "name": "allow_squash_merge",
  7599. "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  7600. "in": "BODY",
  7601. "type": "boolean",
  7602. "required": false,
  7603. "enum": null,
  7604. "allowNull": false,
  7605. "mapToData": null,
  7606. "validation": null,
  7607. "alias": null,
  7608. "deprecated": null
  7609. },
  7610. {
  7611. "name": "allow_merge_commit",
  7612. "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  7613. "in": "BODY",
  7614. "type": "boolean",
  7615. "required": false,
  7616. "enum": null,
  7617. "allowNull": false,
  7618. "mapToData": null,
  7619. "validation": null,
  7620. "alias": null,
  7621. "deprecated": null
  7622. },
  7623. {
  7624. "name": "allow_rebase_merge",
  7625. "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  7626. "in": "BODY",
  7627. "type": "boolean",
  7628. "required": false,
  7629. "enum": null,
  7630. "allowNull": false,
  7631. "mapToData": null,
  7632. "validation": null,
  7633. "alias": null,
  7634. "deprecated": null
  7635. }
  7636. ],
  7637. "responses": [
  7638. {
  7639. "code": 201,
  7640. "description": "response",
  7641. "examples": [
  7642. {
  7643. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}"
  7644. }
  7645. ]
  7646. }
  7647. ],
  7648. "renamed": null
  7649. },
  7650. {
  7651. "name": "List teams",
  7652. "scope": "teams",
  7653. "id": "list",
  7654. "method": "GET",
  7655. "url": "/orgs/{org}/teams",
  7656. "isDeprecated": false,
  7657. "description": "",
  7658. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#list-teams",
  7659. "previews": [],
  7660. "headers": [],
  7661. "parameters": [
  7662. {
  7663. "name": "org",
  7664. "description": "org parameter",
  7665. "in": "PATH",
  7666. "type": "string",
  7667. "required": true,
  7668. "enum": null,
  7669. "allowNull": false,
  7670. "mapToData": null,
  7671. "validation": null,
  7672. "alias": null,
  7673. "deprecated": null
  7674. },
  7675. {
  7676. "name": "per_page",
  7677. "description": "Results per page (max 100)",
  7678. "in": "QUERY",
  7679. "type": "integer",
  7680. "required": false,
  7681. "enum": null,
  7682. "allowNull": false,
  7683. "mapToData": null,
  7684. "validation": null,
  7685. "alias": null,
  7686. "deprecated": null
  7687. },
  7688. {
  7689. "name": "page",
  7690. "description": "Page number of the results to fetch.",
  7691. "in": "QUERY",
  7692. "type": "integer",
  7693. "required": false,
  7694. "enum": null,
  7695. "allowNull": false,
  7696. "mapToData": null,
  7697. "validation": null,
  7698. "alias": null,
  7699. "deprecated": null
  7700. }
  7701. ],
  7702. "responses": [
  7703. {
  7704. "code": 200,
  7705. "description": "response",
  7706. "examples": [
  7707. {
  7708. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  7709. }
  7710. ]
  7711. }
  7712. ],
  7713. "renamed": null
  7714. },
  7715. {
  7716. "name": "Create team",
  7717. "scope": "teams",
  7718. "id": "create",
  7719. "method": "POST",
  7720. "url": "/orgs/{org}/teams",
  7721. "isDeprecated": false,
  7722. "description": "To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\" in the GitHub Help documentation.",
  7723. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#create-team",
  7724. "previews": [],
  7725. "headers": [],
  7726. "parameters": [
  7727. {
  7728. "name": "org",
  7729. "description": "org parameter",
  7730. "in": "PATH",
  7731. "type": "string",
  7732. "required": true,
  7733. "enum": null,
  7734. "allowNull": false,
  7735. "mapToData": null,
  7736. "validation": null,
  7737. "alias": null,
  7738. "deprecated": null
  7739. },
  7740. {
  7741. "name": "name",
  7742. "description": "The name of the team.",
  7743. "in": "BODY",
  7744. "type": "string",
  7745. "required": true,
  7746. "enum": null,
  7747. "allowNull": false,
  7748. "mapToData": null,
  7749. "validation": null,
  7750. "alias": null,
  7751. "deprecated": null
  7752. },
  7753. {
  7754. "name": "description",
  7755. "description": "The description of the team.",
  7756. "in": "BODY",
  7757. "type": "string",
  7758. "required": false,
  7759. "enum": null,
  7760. "allowNull": false,
  7761. "mapToData": null,
  7762. "validation": null,
  7763. "alias": null,
  7764. "deprecated": null
  7765. },
  7766. {
  7767. "name": "maintainers",
  7768. "description": "List GitHub Enterprise Server IDs for organization members who will become team maintainers.",
  7769. "in": "BODY",
  7770. "type": "string[]",
  7771. "required": false,
  7772. "enum": null,
  7773. "allowNull": false,
  7774. "mapToData": null,
  7775. "validation": null,
  7776. "alias": null,
  7777. "deprecated": null
  7778. },
  7779. {
  7780. "name": "repo_names",
  7781. "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.",
  7782. "in": "BODY",
  7783. "type": "string[]",
  7784. "required": false,
  7785. "enum": null,
  7786. "allowNull": false,
  7787. "mapToData": null,
  7788. "validation": null,
  7789. "alias": null,
  7790. "deprecated": null
  7791. },
  7792. {
  7793. "name": "privacy",
  7794. "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.",
  7795. "in": "BODY",
  7796. "type": "string",
  7797. "required": false,
  7798. "enum": ["secret", "closed"],
  7799. "allowNull": false,
  7800. "mapToData": null,
  7801. "validation": null,
  7802. "alias": null,
  7803. "deprecated": null
  7804. },
  7805. {
  7806. "name": "permission",
  7807. "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.",
  7808. "in": "BODY",
  7809. "type": "string",
  7810. "required": false,
  7811. "enum": ["pull", "push", "admin"],
  7812. "allowNull": false,
  7813. "mapToData": null,
  7814. "validation": null,
  7815. "alias": null,
  7816. "deprecated": null
  7817. },
  7818. {
  7819. "name": "parent_team_id",
  7820. "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.",
  7821. "in": "BODY",
  7822. "type": "integer",
  7823. "required": false,
  7824. "enum": null,
  7825. "allowNull": false,
  7826. "mapToData": null,
  7827. "validation": null,
  7828. "alias": null,
  7829. "deprecated": null
  7830. },
  7831. {
  7832. "name": "ldap_dn",
  7833. "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Update LDAP mapping for a team](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN.",
  7834. "in": "BODY",
  7835. "type": "string",
  7836. "required": false,
  7837. "enum": null,
  7838. "allowNull": false,
  7839. "mapToData": null,
  7840. "validation": null,
  7841. "alias": null,
  7842. "deprecated": null
  7843. }
  7844. ],
  7845. "responses": [
  7846. {
  7847. "code": 201,
  7848. "description": "response",
  7849. "examples": [
  7850. {
  7851. "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}"
  7852. }
  7853. ]
  7854. }
  7855. ],
  7856. "renamed": null
  7857. },
  7858. {
  7859. "name": "Get team by name",
  7860. "scope": "teams",
  7861. "id": "getByName",
  7862. "method": "GET",
  7863. "url": "/orgs/{org}/teams/{team_slug}",
  7864. "isDeprecated": false,
  7865. "description": "Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.",
  7866. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#get-team-by-name",
  7867. "previews": [],
  7868. "headers": [],
  7869. "parameters": [
  7870. {
  7871. "name": "org",
  7872. "description": "org parameter",
  7873. "in": "PATH",
  7874. "type": "string",
  7875. "required": true,
  7876. "enum": null,
  7877. "allowNull": false,
  7878. "mapToData": null,
  7879. "validation": null,
  7880. "alias": null,
  7881. "deprecated": null
  7882. },
  7883. {
  7884. "name": "team_slug",
  7885. "description": "team_slug parameter",
  7886. "in": "PATH",
  7887. "type": "string",
  7888. "required": true,
  7889. "enum": null,
  7890. "allowNull": false,
  7891. "mapToData": null,
  7892. "validation": null,
  7893. "alias": null,
  7894. "deprecated": null
  7895. }
  7896. ],
  7897. "responses": [
  7898. {
  7899. "code": 200,
  7900. "description": "response",
  7901. "examples": [
  7902. {
  7903. "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}"
  7904. }
  7905. ]
  7906. }
  7907. ],
  7908. "renamed": null
  7909. },
  7910. {
  7911. "name": "Get a project card",
  7912. "scope": "projects",
  7913. "id": "getCard",
  7914. "method": "GET",
  7915. "url": "/projects/columns/cards/{card_id}",
  7916. "isDeprecated": false,
  7917. "description": "",
  7918. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/cards/#get-a-project-card",
  7919. "previews": [{ "name": "inertia" }],
  7920. "headers": [
  7921. {
  7922. "name": "accept",
  7923. "value": "application/vnd.github.inertia-preview+json"
  7924. }
  7925. ],
  7926. "parameters": [
  7927. {
  7928. "name": "card_id",
  7929. "description": "card_id parameter",
  7930. "in": "PATH",
  7931. "type": "integer",
  7932. "required": true,
  7933. "enum": null,
  7934. "allowNull": false,
  7935. "mapToData": null,
  7936. "validation": null,
  7937. "alias": null,
  7938. "deprecated": null
  7939. }
  7940. ],
  7941. "responses": [
  7942. {
  7943. "code": 200,
  7944. "description": "response",
  7945. "examples": [
  7946. {
  7947. "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}"
  7948. }
  7949. ]
  7950. }
  7951. ],
  7952. "renamed": null
  7953. },
  7954. {
  7955. "name": "Update a project card",
  7956. "scope": "projects",
  7957. "id": "updateCard",
  7958. "method": "PATCH",
  7959. "url": "/projects/columns/cards/{card_id}",
  7960. "isDeprecated": false,
  7961. "description": "",
  7962. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/cards/#update-a-project-card",
  7963. "previews": [{ "name": "inertia" }],
  7964. "headers": [
  7965. {
  7966. "name": "accept",
  7967. "value": "application/vnd.github.inertia-preview+json"
  7968. }
  7969. ],
  7970. "parameters": [
  7971. {
  7972. "name": "card_id",
  7973. "description": "card_id parameter",
  7974. "in": "PATH",
  7975. "type": "integer",
  7976. "required": true,
  7977. "enum": null,
  7978. "allowNull": false,
  7979. "mapToData": null,
  7980. "validation": null,
  7981. "alias": null,
  7982. "deprecated": null
  7983. },
  7984. {
  7985. "name": "note",
  7986. "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.",
  7987. "in": "BODY",
  7988. "type": "string",
  7989. "required": false,
  7990. "enum": null,
  7991. "allowNull": false,
  7992. "mapToData": null,
  7993. "validation": null,
  7994. "alias": null,
  7995. "deprecated": null
  7996. },
  7997. {
  7998. "name": "archived",
  7999. "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.",
  8000. "in": "BODY",
  8001. "type": "boolean",
  8002. "required": false,
  8003. "enum": null,
  8004. "allowNull": false,
  8005. "mapToData": null,
  8006. "validation": null,
  8007. "alias": null,
  8008. "deprecated": null
  8009. }
  8010. ],
  8011. "responses": [
  8012. {
  8013. "code": 200,
  8014. "description": "response",
  8015. "examples": [
  8016. {
  8017. "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}"
  8018. }
  8019. ]
  8020. }
  8021. ],
  8022. "renamed": null
  8023. },
  8024. {
  8025. "name": "Delete a project card",
  8026. "scope": "projects",
  8027. "id": "deleteCard",
  8028. "method": "DELETE",
  8029. "url": "/projects/columns/cards/{card_id}",
  8030. "isDeprecated": false,
  8031. "description": "",
  8032. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/cards/#delete-a-project-card",
  8033. "previews": [{ "name": "inertia" }],
  8034. "headers": [
  8035. {
  8036. "name": "accept",
  8037. "value": "application/vnd.github.inertia-preview+json"
  8038. }
  8039. ],
  8040. "parameters": [
  8041. {
  8042. "name": "card_id",
  8043. "description": "card_id parameter",
  8044. "in": "PATH",
  8045. "type": "integer",
  8046. "required": true,
  8047. "enum": null,
  8048. "allowNull": false,
  8049. "mapToData": null,
  8050. "validation": null,
  8051. "alias": null,
  8052. "deprecated": null
  8053. }
  8054. ],
  8055. "responses": [],
  8056. "renamed": null
  8057. },
  8058. {
  8059. "name": "Move a project card",
  8060. "scope": "projects",
  8061. "id": "moveCard",
  8062. "method": "POST",
  8063. "url": "/projects/columns/cards/{card_id}/moves",
  8064. "isDeprecated": false,
  8065. "description": "",
  8066. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/cards/#move-a-project-card",
  8067. "previews": [{ "name": "inertia" }],
  8068. "headers": [
  8069. {
  8070. "name": "accept",
  8071. "value": "application/vnd.github.inertia-preview+json"
  8072. }
  8073. ],
  8074. "parameters": [
  8075. {
  8076. "name": "card_id",
  8077. "description": "card_id parameter",
  8078. "in": "PATH",
  8079. "type": "integer",
  8080. "required": true,
  8081. "enum": null,
  8082. "allowNull": false,
  8083. "mapToData": null,
  8084. "validation": null,
  8085. "alias": null,
  8086. "deprecated": null
  8087. },
  8088. {
  8089. "name": "position",
  8090. "description": "Can be one of `top`, `bottom`, or `after:<card_id>`, where `<card_id>` is the `id` value of a card in the same column, or in the new column specified by `column_id`.",
  8091. "in": "BODY",
  8092. "type": "string",
  8093. "required": true,
  8094. "enum": null,
  8095. "allowNull": false,
  8096. "mapToData": null,
  8097. "validation": "^(top|bottom|after:\\d+)$",
  8098. "alias": null,
  8099. "deprecated": null
  8100. },
  8101. {
  8102. "name": "column_id",
  8103. "description": "The `id` value of a column in the same project.",
  8104. "in": "BODY",
  8105. "type": "integer",
  8106. "required": false,
  8107. "enum": null,
  8108. "allowNull": false,
  8109. "mapToData": null,
  8110. "validation": null,
  8111. "alias": null,
  8112. "deprecated": null
  8113. }
  8114. ],
  8115. "responses": [],
  8116. "renamed": null
  8117. },
  8118. {
  8119. "name": "Get a project column",
  8120. "scope": "projects",
  8121. "id": "getColumn",
  8122. "method": "GET",
  8123. "url": "/projects/columns/{column_id}",
  8124. "isDeprecated": false,
  8125. "description": "",
  8126. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/columns/#get-a-project-column",
  8127. "previews": [{ "name": "inertia" }],
  8128. "headers": [
  8129. {
  8130. "name": "accept",
  8131. "value": "application/vnd.github.inertia-preview+json"
  8132. }
  8133. ],
  8134. "parameters": [
  8135. {
  8136. "name": "column_id",
  8137. "description": "column_id parameter",
  8138. "in": "PATH",
  8139. "type": "integer",
  8140. "required": true,
  8141. "enum": null,
  8142. "allowNull": false,
  8143. "mapToData": null,
  8144. "validation": null,
  8145. "alias": null,
  8146. "deprecated": null
  8147. }
  8148. ],
  8149. "responses": [
  8150. {
  8151. "code": 200,
  8152. "description": "response",
  8153. "examples": [
  8154. {
  8155. "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}"
  8156. }
  8157. ]
  8158. }
  8159. ],
  8160. "renamed": null
  8161. },
  8162. {
  8163. "name": "Update a project column",
  8164. "scope": "projects",
  8165. "id": "updateColumn",
  8166. "method": "PATCH",
  8167. "url": "/projects/columns/{column_id}",
  8168. "isDeprecated": false,
  8169. "description": "",
  8170. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/columns/#update-a-project-column",
  8171. "previews": [{ "name": "inertia" }],
  8172. "headers": [
  8173. {
  8174. "name": "accept",
  8175. "value": "application/vnd.github.inertia-preview+json"
  8176. }
  8177. ],
  8178. "parameters": [
  8179. {
  8180. "name": "column_id",
  8181. "description": "column_id parameter",
  8182. "in": "PATH",
  8183. "type": "integer",
  8184. "required": true,
  8185. "enum": null,
  8186. "allowNull": false,
  8187. "mapToData": null,
  8188. "validation": null,
  8189. "alias": null,
  8190. "deprecated": null
  8191. },
  8192. {
  8193. "name": "name",
  8194. "description": "The new name of the column.",
  8195. "in": "BODY",
  8196. "type": "string",
  8197. "required": true,
  8198. "enum": null,
  8199. "allowNull": false,
  8200. "mapToData": null,
  8201. "validation": null,
  8202. "alias": null,
  8203. "deprecated": null
  8204. }
  8205. ],
  8206. "responses": [
  8207. {
  8208. "code": 200,
  8209. "description": "response",
  8210. "examples": [
  8211. {
  8212. "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}"
  8213. }
  8214. ]
  8215. }
  8216. ],
  8217. "renamed": null
  8218. },
  8219. {
  8220. "name": "Delete a project column",
  8221. "scope": "projects",
  8222. "id": "deleteColumn",
  8223. "method": "DELETE",
  8224. "url": "/projects/columns/{column_id}",
  8225. "isDeprecated": false,
  8226. "description": "",
  8227. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/columns/#delete-a-project-column",
  8228. "previews": [{ "name": "inertia" }],
  8229. "headers": [
  8230. {
  8231. "name": "accept",
  8232. "value": "application/vnd.github.inertia-preview+json"
  8233. }
  8234. ],
  8235. "parameters": [
  8236. {
  8237. "name": "column_id",
  8238. "description": "column_id parameter",
  8239. "in": "PATH",
  8240. "type": "integer",
  8241. "required": true,
  8242. "enum": null,
  8243. "allowNull": false,
  8244. "mapToData": null,
  8245. "validation": null,
  8246. "alias": null,
  8247. "deprecated": null
  8248. }
  8249. ],
  8250. "responses": [],
  8251. "renamed": null
  8252. },
  8253. {
  8254. "name": "List project cards",
  8255. "scope": "projects",
  8256. "id": "listCards",
  8257. "method": "GET",
  8258. "url": "/projects/columns/{column_id}/cards",
  8259. "isDeprecated": false,
  8260. "description": "",
  8261. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/cards/#list-project-cards",
  8262. "previews": [{ "name": "inertia" }],
  8263. "headers": [
  8264. {
  8265. "name": "accept",
  8266. "value": "application/vnd.github.inertia-preview+json"
  8267. }
  8268. ],
  8269. "parameters": [
  8270. {
  8271. "name": "column_id",
  8272. "description": "column_id parameter",
  8273. "in": "PATH",
  8274. "type": "integer",
  8275. "required": true,
  8276. "enum": null,
  8277. "allowNull": false,
  8278. "mapToData": null,
  8279. "validation": null,
  8280. "alias": null,
  8281. "deprecated": null
  8282. },
  8283. {
  8284. "name": "archived_state",
  8285. "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.",
  8286. "in": "QUERY",
  8287. "type": "string",
  8288. "required": false,
  8289. "enum": ["all", "archived", "not_archived"],
  8290. "allowNull": false,
  8291. "mapToData": null,
  8292. "validation": null,
  8293. "alias": null,
  8294. "deprecated": null
  8295. },
  8296. {
  8297. "name": "per_page",
  8298. "description": "Results per page (max 100)",
  8299. "in": "QUERY",
  8300. "type": "integer",
  8301. "required": false,
  8302. "enum": null,
  8303. "allowNull": false,
  8304. "mapToData": null,
  8305. "validation": null,
  8306. "alias": null,
  8307. "deprecated": null
  8308. },
  8309. {
  8310. "name": "page",
  8311. "description": "Page number of the results to fetch.",
  8312. "in": "QUERY",
  8313. "type": "integer",
  8314. "required": false,
  8315. "enum": null,
  8316. "allowNull": false,
  8317. "mapToData": null,
  8318. "validation": null,
  8319. "alias": null,
  8320. "deprecated": null
  8321. }
  8322. ],
  8323. "responses": [
  8324. {
  8325. "code": 200,
  8326. "description": "response",
  8327. "examples": [
  8328. {
  8329. "data": "[{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}]"
  8330. }
  8331. ]
  8332. }
  8333. ],
  8334. "renamed": null
  8335. },
  8336. {
  8337. "name": "Create a project card",
  8338. "scope": "projects",
  8339. "id": "createCard",
  8340. "method": "POST",
  8341. "url": "/projects/columns/{column_id}/cards",
  8342. "isDeprecated": false,
  8343. "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests)\" endpoint.",
  8344. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/cards/#create-a-project-card",
  8345. "previews": [{ "name": "inertia" }],
  8346. "headers": [
  8347. {
  8348. "name": "accept",
  8349. "value": "application/vnd.github.inertia-preview+json"
  8350. }
  8351. ],
  8352. "parameters": [
  8353. {
  8354. "name": "column_id",
  8355. "description": "column_id parameter",
  8356. "in": "PATH",
  8357. "type": "integer",
  8358. "required": true,
  8359. "enum": null,
  8360. "allowNull": false,
  8361. "mapToData": null,
  8362. "validation": null,
  8363. "alias": null,
  8364. "deprecated": null
  8365. },
  8366. {
  8367. "name": "note",
  8368. "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.",
  8369. "in": "BODY",
  8370. "type": "string",
  8371. "required": false,
  8372. "enum": null,
  8373. "allowNull": false,
  8374. "mapToData": null,
  8375. "validation": null,
  8376. "alias": null,
  8377. "deprecated": null
  8378. },
  8379. {
  8380. "name": "content_id",
  8381. "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/enterprise/2.17/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.",
  8382. "in": "BODY",
  8383. "type": "integer",
  8384. "required": false,
  8385. "enum": null,
  8386. "allowNull": false,
  8387. "mapToData": null,
  8388. "validation": null,
  8389. "alias": null,
  8390. "deprecated": null
  8391. },
  8392. {
  8393. "name": "content_type",
  8394. "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.",
  8395. "in": "BODY",
  8396. "type": "string",
  8397. "required": false,
  8398. "enum": null,
  8399. "allowNull": false,
  8400. "mapToData": null,
  8401. "validation": null,
  8402. "alias": null,
  8403. "deprecated": null
  8404. }
  8405. ],
  8406. "responses": [
  8407. {
  8408. "code": 201,
  8409. "description": "response",
  8410. "examples": [
  8411. {
  8412. "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}"
  8413. }
  8414. ]
  8415. }
  8416. ],
  8417. "renamed": null
  8418. },
  8419. {
  8420. "name": "Move a project column",
  8421. "scope": "projects",
  8422. "id": "moveColumn",
  8423. "method": "POST",
  8424. "url": "/projects/columns/{column_id}/moves",
  8425. "isDeprecated": false,
  8426. "description": "",
  8427. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/columns/#move-a-project-column",
  8428. "previews": [{ "name": "inertia" }],
  8429. "headers": [
  8430. {
  8431. "name": "accept",
  8432. "value": "application/vnd.github.inertia-preview+json"
  8433. }
  8434. ],
  8435. "parameters": [
  8436. {
  8437. "name": "column_id",
  8438. "description": "column_id parameter",
  8439. "in": "PATH",
  8440. "type": "integer",
  8441. "required": true,
  8442. "enum": null,
  8443. "allowNull": false,
  8444. "mapToData": null,
  8445. "validation": null,
  8446. "alias": null,
  8447. "deprecated": null
  8448. },
  8449. {
  8450. "name": "position",
  8451. "description": "Can be one of `first`, `last`, or `after:<column_id>`, where `<column_id>` is the `id` value of a column in the same project.",
  8452. "in": "BODY",
  8453. "type": "string",
  8454. "required": true,
  8455. "enum": null,
  8456. "allowNull": false,
  8457. "mapToData": null,
  8458. "validation": "^(first|last|after:\\d+)$",
  8459. "alias": null,
  8460. "deprecated": null
  8461. }
  8462. ],
  8463. "responses": [],
  8464. "renamed": null
  8465. },
  8466. {
  8467. "name": "Get a project",
  8468. "scope": "projects",
  8469. "id": "get",
  8470. "method": "GET",
  8471. "url": "/projects/{project_id}",
  8472. "isDeprecated": false,
  8473. "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
  8474. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#get-a-project",
  8475. "previews": [{ "name": "inertia" }],
  8476. "headers": [
  8477. {
  8478. "name": "accept",
  8479. "value": "application/vnd.github.inertia-preview+json"
  8480. }
  8481. ],
  8482. "parameters": [
  8483. {
  8484. "name": "project_id",
  8485. "description": "project_id parameter",
  8486. "in": "PATH",
  8487. "type": "integer",
  8488. "required": true,
  8489. "enum": null,
  8490. "allowNull": false,
  8491. "mapToData": null,
  8492. "validation": null,
  8493. "alias": null,
  8494. "deprecated": null
  8495. },
  8496. {
  8497. "name": "per_page",
  8498. "description": "Results per page (max 100)",
  8499. "in": "QUERY",
  8500. "type": "integer",
  8501. "required": false,
  8502. "enum": null,
  8503. "allowNull": false,
  8504. "mapToData": null,
  8505. "validation": null,
  8506. "alias": null,
  8507. "deprecated": null
  8508. },
  8509. {
  8510. "name": "page",
  8511. "description": "Page number of the results to fetch.",
  8512. "in": "QUERY",
  8513. "type": "integer",
  8514. "required": false,
  8515. "enum": null,
  8516. "allowNull": false,
  8517. "mapToData": null,
  8518. "validation": null,
  8519. "alias": null,
  8520. "deprecated": null
  8521. }
  8522. ],
  8523. "responses": [
  8524. {
  8525. "code": 200,
  8526. "description": "response",
  8527. "examples": [
  8528. {
  8529. "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}"
  8530. }
  8531. ]
  8532. }
  8533. ],
  8534. "renamed": null
  8535. },
  8536. {
  8537. "name": "Update a project",
  8538. "scope": "projects",
  8539. "id": "update",
  8540. "method": "PATCH",
  8541. "url": "/projects/{project_id}",
  8542. "isDeprecated": false,
  8543. "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
  8544. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#update-a-project",
  8545. "previews": [{ "name": "inertia" }],
  8546. "headers": [
  8547. {
  8548. "name": "accept",
  8549. "value": "application/vnd.github.inertia-preview+json"
  8550. }
  8551. ],
  8552. "parameters": [
  8553. {
  8554. "name": "project_id",
  8555. "description": "project_id parameter",
  8556. "in": "PATH",
  8557. "type": "integer",
  8558. "required": true,
  8559. "enum": null,
  8560. "allowNull": false,
  8561. "mapToData": null,
  8562. "validation": null,
  8563. "alias": null,
  8564. "deprecated": null
  8565. },
  8566. {
  8567. "name": "name",
  8568. "description": "The name of the project.",
  8569. "in": "BODY",
  8570. "type": "string",
  8571. "required": false,
  8572. "enum": null,
  8573. "allowNull": false,
  8574. "mapToData": null,
  8575. "validation": null,
  8576. "alias": null,
  8577. "deprecated": null
  8578. },
  8579. {
  8580. "name": "body",
  8581. "description": "The description of the project.",
  8582. "in": "BODY",
  8583. "type": "string",
  8584. "required": false,
  8585. "enum": null,
  8586. "allowNull": false,
  8587. "mapToData": null,
  8588. "validation": null,
  8589. "alias": null,
  8590. "deprecated": null
  8591. },
  8592. {
  8593. "name": "state",
  8594. "description": "State of the project. Either `open` or `closed`.",
  8595. "in": "BODY",
  8596. "type": "string",
  8597. "required": false,
  8598. "enum": ["open", "closed"],
  8599. "allowNull": false,
  8600. "mapToData": null,
  8601. "validation": null,
  8602. "alias": null,
  8603. "deprecated": null
  8604. },
  8605. {
  8606. "name": "organization_permission",
  8607. "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/enterprise/2.17/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.17/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.",
  8608. "in": "BODY",
  8609. "type": "string",
  8610. "required": false,
  8611. "enum": null,
  8612. "allowNull": false,
  8613. "mapToData": null,
  8614. "validation": null,
  8615. "alias": null,
  8616. "deprecated": null
  8617. },
  8618. {
  8619. "name": "private",
  8620. "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.",
  8621. "in": "BODY",
  8622. "type": "boolean",
  8623. "required": false,
  8624. "enum": null,
  8625. "allowNull": false,
  8626. "mapToData": null,
  8627. "validation": null,
  8628. "alias": null,
  8629. "deprecated": null
  8630. }
  8631. ],
  8632. "responses": [
  8633. {
  8634. "code": 200,
  8635. "description": "response",
  8636. "examples": [
  8637. {
  8638. "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}"
  8639. }
  8640. ]
  8641. }
  8642. ],
  8643. "renamed": null
  8644. },
  8645. {
  8646. "name": "Delete a project",
  8647. "scope": "projects",
  8648. "id": "delete",
  8649. "method": "DELETE",
  8650. "url": "/projects/{project_id}",
  8651. "isDeprecated": false,
  8652. "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.",
  8653. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#delete-a-project",
  8654. "previews": [{ "name": "inertia" }],
  8655. "headers": [
  8656. {
  8657. "name": "accept",
  8658. "value": "application/vnd.github.inertia-preview+json"
  8659. }
  8660. ],
  8661. "parameters": [
  8662. {
  8663. "name": "project_id",
  8664. "description": "project_id parameter",
  8665. "in": "PATH",
  8666. "type": "integer",
  8667. "required": true,
  8668. "enum": null,
  8669. "allowNull": false,
  8670. "mapToData": null,
  8671. "validation": null,
  8672. "alias": null,
  8673. "deprecated": null
  8674. }
  8675. ],
  8676. "responses": [],
  8677. "renamed": null
  8678. },
  8679. {
  8680. "name": "List collaborators",
  8681. "scope": "projects",
  8682. "id": "listCollaborators",
  8683. "method": "GET",
  8684. "url": "/projects/{project_id}/collaborators",
  8685. "isDeprecated": false,
  8686. "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.",
  8687. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/collaborators/#list-collaborators",
  8688. "previews": [{ "name": "inertia" }],
  8689. "headers": [
  8690. {
  8691. "name": "accept",
  8692. "value": "application/vnd.github.inertia-preview+json"
  8693. }
  8694. ],
  8695. "parameters": [
  8696. {
  8697. "name": "project_id",
  8698. "description": "project_id parameter",
  8699. "in": "PATH",
  8700. "type": "integer",
  8701. "required": true,
  8702. "enum": null,
  8703. "allowNull": false,
  8704. "mapToData": null,
  8705. "validation": null,
  8706. "alias": null,
  8707. "deprecated": null
  8708. },
  8709. {
  8710. "name": "affiliation",
  8711. "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.",
  8712. "in": "QUERY",
  8713. "type": "string",
  8714. "required": false,
  8715. "enum": ["outside", "direct", "all"],
  8716. "allowNull": false,
  8717. "mapToData": null,
  8718. "validation": null,
  8719. "alias": null,
  8720. "deprecated": null
  8721. },
  8722. {
  8723. "name": "per_page",
  8724. "description": "Results per page (max 100)",
  8725. "in": "QUERY",
  8726. "type": "integer",
  8727. "required": false,
  8728. "enum": null,
  8729. "allowNull": false,
  8730. "mapToData": null,
  8731. "validation": null,
  8732. "alias": null,
  8733. "deprecated": null
  8734. },
  8735. {
  8736. "name": "page",
  8737. "description": "Page number of the results to fetch.",
  8738. "in": "QUERY",
  8739. "type": "integer",
  8740. "required": false,
  8741. "enum": null,
  8742. "allowNull": false,
  8743. "mapToData": null,
  8744. "validation": null,
  8745. "alias": null,
  8746. "deprecated": null
  8747. }
  8748. ],
  8749. "responses": [
  8750. {
  8751. "code": 200,
  8752. "description": "response",
  8753. "examples": [
  8754. {
  8755. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  8756. }
  8757. ]
  8758. }
  8759. ],
  8760. "renamed": null
  8761. },
  8762. {
  8763. "name": "Add user as a collaborator",
  8764. "scope": "projects",
  8765. "id": "addCollaborator",
  8766. "method": "PUT",
  8767. "url": "/projects/{project_id}/collaborators/{username}",
  8768. "isDeprecated": false,
  8769. "description": "Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.",
  8770. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/collaborators/#add-user-as-a-collaborator",
  8771. "previews": [{ "name": "inertia" }],
  8772. "headers": [
  8773. {
  8774. "name": "accept",
  8775. "value": "application/vnd.github.inertia-preview+json"
  8776. }
  8777. ],
  8778. "parameters": [
  8779. {
  8780. "name": "project_id",
  8781. "description": "project_id parameter",
  8782. "in": "PATH",
  8783. "type": "integer",
  8784. "required": true,
  8785. "enum": null,
  8786. "allowNull": false,
  8787. "mapToData": null,
  8788. "validation": null,
  8789. "alias": null,
  8790. "deprecated": null
  8791. },
  8792. {
  8793. "name": "username",
  8794. "description": "username parameter",
  8795. "in": "PATH",
  8796. "type": "string",
  8797. "required": true,
  8798. "enum": null,
  8799. "allowNull": false,
  8800. "mapToData": null,
  8801. "validation": null,
  8802. "alias": null,
  8803. "deprecated": null
  8804. },
  8805. {
  8806. "name": "permission",
  8807. "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.",
  8808. "in": "BODY",
  8809. "type": "string",
  8810. "required": false,
  8811. "enum": ["read", "write", "admin"],
  8812. "allowNull": false,
  8813. "mapToData": null,
  8814. "validation": null,
  8815. "alias": null,
  8816. "deprecated": null
  8817. }
  8818. ],
  8819. "responses": [],
  8820. "renamed": null
  8821. },
  8822. {
  8823. "name": "Remove user as a collaborator",
  8824. "scope": "projects",
  8825. "id": "removeCollaborator",
  8826. "method": "DELETE",
  8827. "url": "/projects/{project_id}/collaborators/{username}",
  8828. "isDeprecated": false,
  8829. "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.",
  8830. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/collaborators/#remove-user-as-a-collaborator",
  8831. "previews": [{ "name": "inertia" }],
  8832. "headers": [
  8833. {
  8834. "name": "accept",
  8835. "value": "application/vnd.github.inertia-preview+json"
  8836. }
  8837. ],
  8838. "parameters": [
  8839. {
  8840. "name": "project_id",
  8841. "description": "project_id parameter",
  8842. "in": "PATH",
  8843. "type": "integer",
  8844. "required": true,
  8845. "enum": null,
  8846. "allowNull": false,
  8847. "mapToData": null,
  8848. "validation": null,
  8849. "alias": null,
  8850. "deprecated": null
  8851. },
  8852. {
  8853. "name": "username",
  8854. "description": "username parameter",
  8855. "in": "PATH",
  8856. "type": "string",
  8857. "required": true,
  8858. "enum": null,
  8859. "allowNull": false,
  8860. "mapToData": null,
  8861. "validation": null,
  8862. "alias": null,
  8863. "deprecated": null
  8864. }
  8865. ],
  8866. "responses": [],
  8867. "renamed": null
  8868. },
  8869. {
  8870. "name": "Review a user's permission level",
  8871. "scope": "projects",
  8872. "id": "reviewUserPermissionLevel",
  8873. "method": "GET",
  8874. "url": "/projects/{project_id}/collaborators/{username}/permission",
  8875. "isDeprecated": false,
  8876. "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.",
  8877. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/collaborators/#review-a-users-permission-level",
  8878. "previews": [{ "name": "inertia" }],
  8879. "headers": [
  8880. {
  8881. "name": "accept",
  8882. "value": "application/vnd.github.inertia-preview+json"
  8883. }
  8884. ],
  8885. "parameters": [
  8886. {
  8887. "name": "project_id",
  8888. "description": "project_id parameter",
  8889. "in": "PATH",
  8890. "type": "integer",
  8891. "required": true,
  8892. "enum": null,
  8893. "allowNull": false,
  8894. "mapToData": null,
  8895. "validation": null,
  8896. "alias": null,
  8897. "deprecated": null
  8898. },
  8899. {
  8900. "name": "username",
  8901. "description": "username parameter",
  8902. "in": "PATH",
  8903. "type": "string",
  8904. "required": true,
  8905. "enum": null,
  8906. "allowNull": false,
  8907. "mapToData": null,
  8908. "validation": null,
  8909. "alias": null,
  8910. "deprecated": null
  8911. }
  8912. ],
  8913. "responses": [
  8914. {
  8915. "code": 200,
  8916. "description": "response",
  8917. "examples": [
  8918. {
  8919. "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  8920. }
  8921. ]
  8922. }
  8923. ],
  8924. "renamed": null
  8925. },
  8926. {
  8927. "name": "List project columns",
  8928. "scope": "projects",
  8929. "id": "listColumns",
  8930. "method": "GET",
  8931. "url": "/projects/{project_id}/columns",
  8932. "isDeprecated": false,
  8933. "description": "",
  8934. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/columns/#list-project-columns",
  8935. "previews": [{ "name": "inertia" }],
  8936. "headers": [
  8937. {
  8938. "name": "accept",
  8939. "value": "application/vnd.github.inertia-preview+json"
  8940. }
  8941. ],
  8942. "parameters": [
  8943. {
  8944. "name": "project_id",
  8945. "description": "project_id parameter",
  8946. "in": "PATH",
  8947. "type": "integer",
  8948. "required": true,
  8949. "enum": null,
  8950. "allowNull": false,
  8951. "mapToData": null,
  8952. "validation": null,
  8953. "alias": null,
  8954. "deprecated": null
  8955. },
  8956. {
  8957. "name": "per_page",
  8958. "description": "Results per page (max 100)",
  8959. "in": "QUERY",
  8960. "type": "integer",
  8961. "required": false,
  8962. "enum": null,
  8963. "allowNull": false,
  8964. "mapToData": null,
  8965. "validation": null,
  8966. "alias": null,
  8967. "deprecated": null
  8968. },
  8969. {
  8970. "name": "page",
  8971. "description": "Page number of the results to fetch.",
  8972. "in": "QUERY",
  8973. "type": "integer",
  8974. "required": false,
  8975. "enum": null,
  8976. "allowNull": false,
  8977. "mapToData": null,
  8978. "validation": null,
  8979. "alias": null,
  8980. "deprecated": null
  8981. }
  8982. ],
  8983. "responses": [
  8984. {
  8985. "code": 200,
  8986. "description": "response",
  8987. "examples": [
  8988. {
  8989. "data": "[{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}]"
  8990. }
  8991. ]
  8992. }
  8993. ],
  8994. "renamed": null
  8995. },
  8996. {
  8997. "name": "Create a project column",
  8998. "scope": "projects",
  8999. "id": "createColumn",
  9000. "method": "POST",
  9001. "url": "/projects/{project_id}/columns",
  9002. "isDeprecated": false,
  9003. "description": "",
  9004. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/columns/#create-a-project-column",
  9005. "previews": [{ "name": "inertia" }],
  9006. "headers": [
  9007. {
  9008. "name": "accept",
  9009. "value": "application/vnd.github.inertia-preview+json"
  9010. }
  9011. ],
  9012. "parameters": [
  9013. {
  9014. "name": "project_id",
  9015. "description": "project_id parameter",
  9016. "in": "PATH",
  9017. "type": "integer",
  9018. "required": true,
  9019. "enum": null,
  9020. "allowNull": false,
  9021. "mapToData": null,
  9022. "validation": null,
  9023. "alias": null,
  9024. "deprecated": null
  9025. },
  9026. {
  9027. "name": "name",
  9028. "description": "The name of the column.",
  9029. "in": "BODY",
  9030. "type": "string",
  9031. "required": true,
  9032. "enum": null,
  9033. "allowNull": false,
  9034. "mapToData": null,
  9035. "validation": null,
  9036. "alias": null,
  9037. "deprecated": null
  9038. }
  9039. ],
  9040. "responses": [
  9041. {
  9042. "code": 200,
  9043. "description": "response",
  9044. "examples": [
  9045. {
  9046. "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}"
  9047. }
  9048. ]
  9049. }
  9050. ],
  9051. "renamed": null
  9052. },
  9053. {
  9054. "name": "Get your current rate limit status",
  9055. "scope": "rateLimit",
  9056. "id": "get",
  9057. "method": "GET",
  9058. "url": "/rate_limit",
  9059. "isDeprecated": false,
  9060. "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Understanding your rate limit status**\n\nThe Search API has a [custom rate limit](https://developer.github.com/enterprise/2.17/v3/search/#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](https://developer.github.com/enterprise/2.17/v4/guides/resource-limitations/#rate-limit) that is separate from and calculated differently than rate limits in the REST API.\n\nFor these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four objects:\n\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the [Search API](https://developer.github.com/enterprise/2.17/v3/search/).\n* The `graphql` object provides your rate limit status for the [GraphQL API](https://developer.github.com/enterprise/2.17/v4/).\n* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](https://developer.github.com/enterprise/2.17/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint.\n\nFor more information on the headers and values in the rate limit response, see \"[Rate limiting](https://developer.github.com/enterprise/2.17/v3/#rate-limiting).\"\n\nThe `rate` object (shown at the bottom of the response above) is deprecated.\n\nIf you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.",
  9061. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/rate_limit/#get-your-current-rate-limit-status",
  9062. "previews": [],
  9063. "headers": [],
  9064. "parameters": [],
  9065. "responses": [
  9066. {
  9067. "code": 200,
  9068. "description": "response",
  9069. "examples": [
  9070. {
  9071. "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873}}"
  9072. }
  9073. ]
  9074. }
  9075. ],
  9076. "renamed": null
  9077. },
  9078. {
  9079. "name": "Delete a reaction",
  9080. "scope": "reactions",
  9081. "id": "delete",
  9082. "method": "DELETE",
  9083. "url": "/reactions/{reaction_id}",
  9084. "isDeprecated": false,
  9085. "description": "OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/enterprise/2.17/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/).",
  9086. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#delete-a-reaction",
  9087. "previews": [{ "name": "echo" }, { "name": "squirrel-girl" }],
  9088. "headers": [
  9089. {
  9090. "name": "accept",
  9091. "value": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  9092. }
  9093. ],
  9094. "parameters": [
  9095. {
  9096. "name": "reaction_id",
  9097. "description": "reaction_id parameter",
  9098. "in": "PATH",
  9099. "type": "integer",
  9100. "required": true,
  9101. "enum": null,
  9102. "allowNull": false,
  9103. "mapToData": null,
  9104. "validation": null,
  9105. "alias": null,
  9106. "deprecated": null
  9107. }
  9108. ],
  9109. "responses": [],
  9110. "renamed": null
  9111. },
  9112. {
  9113. "name": "Get",
  9114. "scope": "repos",
  9115. "id": "get",
  9116. "method": "GET",
  9117. "url": "/repos/{owner}/{repo}",
  9118. "isDeprecated": false,
  9119. "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.",
  9120. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#get",
  9121. "previews": [],
  9122. "headers": [],
  9123. "parameters": [
  9124. {
  9125. "name": "owner",
  9126. "description": "owner parameter",
  9127. "in": "PATH",
  9128. "type": "string",
  9129. "required": true,
  9130. "enum": null,
  9131. "allowNull": false,
  9132. "mapToData": null,
  9133. "validation": null,
  9134. "alias": null,
  9135. "deprecated": null
  9136. },
  9137. {
  9138. "name": "repo",
  9139. "description": "repo parameter",
  9140. "in": "PATH",
  9141. "type": "string",
  9142. "required": true,
  9143. "enum": null,
  9144. "allowNull": false,
  9145. "mapToData": null,
  9146. "validation": null,
  9147. "alias": null,
  9148. "deprecated": null
  9149. }
  9150. ],
  9151. "responses": [
  9152. {
  9153. "code": 200,
  9154. "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.",
  9155. "examples": [
  9156. {
  9157. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}"
  9158. }
  9159. ]
  9160. }
  9161. ],
  9162. "renamed": null
  9163. },
  9164. {
  9165. "name": "Edit",
  9166. "scope": "repos",
  9167. "id": "update",
  9168. "method": "PATCH",
  9169. "url": "/repos/{owner}/{repo}",
  9170. "isDeprecated": false,
  9171. "description": "**Note**: To edit a repository's topics, use the [`topics` endpoint](https://developer.github.com/enterprise/2.17/v3/repos/#replace-all-topics-for-a-repository).",
  9172. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#edit",
  9173. "previews": [{ "name": "x-ray" }],
  9174. "headers": [
  9175. { "name": "accept", "value": "application/vnd.github.x-ray-preview+json" }
  9176. ],
  9177. "parameters": [
  9178. {
  9179. "name": "owner",
  9180. "description": "owner parameter",
  9181. "in": "PATH",
  9182. "type": "string",
  9183. "required": true,
  9184. "enum": null,
  9185. "allowNull": false,
  9186. "mapToData": null,
  9187. "validation": null,
  9188. "alias": null,
  9189. "deprecated": null
  9190. },
  9191. {
  9192. "name": "repo",
  9193. "description": "repo parameter",
  9194. "in": "PATH",
  9195. "type": "string",
  9196. "required": true,
  9197. "enum": null,
  9198. "allowNull": false,
  9199. "mapToData": null,
  9200. "validation": null,
  9201. "alias": null,
  9202. "deprecated": null
  9203. },
  9204. {
  9205. "name": "name",
  9206. "description": "The name of the repository.",
  9207. "in": "BODY",
  9208. "type": "string",
  9209. "required": false,
  9210. "enum": null,
  9211. "allowNull": false,
  9212. "mapToData": null,
  9213. "validation": null,
  9214. "alias": null,
  9215. "deprecated": null
  9216. },
  9217. {
  9218. "name": "description",
  9219. "description": "A short description of the repository.",
  9220. "in": "BODY",
  9221. "type": "string",
  9222. "required": false,
  9223. "enum": null,
  9224. "allowNull": false,
  9225. "mapToData": null,
  9226. "validation": null,
  9227. "alias": null,
  9228. "deprecated": null
  9229. },
  9230. {
  9231. "name": "homepage",
  9232. "description": "A URL with more information about the repository.",
  9233. "in": "BODY",
  9234. "type": "string",
  9235. "required": false,
  9236. "enum": null,
  9237. "allowNull": false,
  9238. "mapToData": null,
  9239. "validation": null,
  9240. "alias": null,
  9241. "deprecated": null
  9242. },
  9243. {
  9244. "name": "private",
  9245. "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private, or if the \"Users Can Change Repo Visibility\" appliance setting is disabled and you are not a hosted site admin. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private, or if the \"Users Can Change Repo Visibility\" appliance setting is disabled and you are not a hosted site admin.",
  9246. "in": "BODY",
  9247. "type": "boolean",
  9248. "required": false,
  9249. "enum": null,
  9250. "allowNull": false,
  9251. "mapToData": null,
  9252. "validation": null,
  9253. "alias": null,
  9254. "deprecated": null
  9255. },
  9256. {
  9257. "name": "has_issues",
  9258. "description": "Either `true` to enable issues for this repository or `false` to disable them.",
  9259. "in": "BODY",
  9260. "type": "boolean",
  9261. "required": false,
  9262. "enum": null,
  9263. "allowNull": false,
  9264. "mapToData": null,
  9265. "validation": null,
  9266. "alias": null,
  9267. "deprecated": null
  9268. },
  9269. {
  9270. "name": "has_projects",
  9271. "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.",
  9272. "in": "BODY",
  9273. "type": "boolean",
  9274. "required": false,
  9275. "enum": null,
  9276. "allowNull": false,
  9277. "mapToData": null,
  9278. "validation": null,
  9279. "alias": null,
  9280. "deprecated": null
  9281. },
  9282. {
  9283. "name": "has_wiki",
  9284. "description": "Either `true` to enable the wiki for this repository or `false` to disable it.",
  9285. "in": "BODY",
  9286. "type": "boolean",
  9287. "required": false,
  9288. "enum": null,
  9289. "allowNull": false,
  9290. "mapToData": null,
  9291. "validation": null,
  9292. "alias": null,
  9293. "deprecated": null
  9294. },
  9295. {
  9296. "name": "default_branch",
  9297. "description": "Updates the default branch for this repository.",
  9298. "in": "BODY",
  9299. "type": "string",
  9300. "required": false,
  9301. "enum": null,
  9302. "allowNull": false,
  9303. "mapToData": null,
  9304. "validation": null,
  9305. "alias": null,
  9306. "deprecated": null
  9307. },
  9308. {
  9309. "name": "allow_squash_merge",
  9310. "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  9311. "in": "BODY",
  9312. "type": "boolean",
  9313. "required": false,
  9314. "enum": null,
  9315. "allowNull": false,
  9316. "mapToData": null,
  9317. "validation": null,
  9318. "alias": null,
  9319. "deprecated": null
  9320. },
  9321. {
  9322. "name": "allow_merge_commit",
  9323. "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  9324. "in": "BODY",
  9325. "type": "boolean",
  9326. "required": false,
  9327. "enum": null,
  9328. "allowNull": false,
  9329. "mapToData": null,
  9330. "validation": null,
  9331. "alias": null,
  9332. "deprecated": null
  9333. },
  9334. {
  9335. "name": "allow_rebase_merge",
  9336. "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  9337. "in": "BODY",
  9338. "type": "boolean",
  9339. "required": false,
  9340. "enum": null,
  9341. "allowNull": false,
  9342. "mapToData": null,
  9343. "validation": null,
  9344. "alias": null,
  9345. "deprecated": null
  9346. },
  9347. {
  9348. "name": "archived",
  9349. "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.",
  9350. "in": "BODY",
  9351. "type": "boolean",
  9352. "required": false,
  9353. "enum": null,
  9354. "allowNull": false,
  9355. "mapToData": null,
  9356. "validation": null,
  9357. "alias": null,
  9358. "deprecated": null
  9359. },
  9360. {
  9361. "name": "anonymous_access_enabled",
  9362. "description": "Either `true` to allow anonymous Git access to a public repository, or `false` to disable it. This feature is only available to site and repository administrators in GitHub Enterprise Server instances that have private mode enabled.",
  9363. "in": "BODY",
  9364. "type": "boolean",
  9365. "required": false,
  9366. "enum": null,
  9367. "allowNull": false,
  9368. "mapToData": null,
  9369. "validation": null,
  9370. "alias": null,
  9371. "deprecated": null
  9372. }
  9373. ],
  9374. "responses": [
  9375. {
  9376. "code": 200,
  9377. "description": "response",
  9378. "examples": [
  9379. {
  9380. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}"
  9381. }
  9382. ]
  9383. }
  9384. ],
  9385. "renamed": null
  9386. },
  9387. {
  9388. "name": "Delete a repository",
  9389. "scope": "repos",
  9390. "id": "delete",
  9391. "method": "DELETE",
  9392. "url": "/repos/{owner}/{repo}",
  9393. "isDeprecated": false,
  9394. "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:\n\nIf a site admin has configured the enterprise appliance to prevent users from deleting organization-owned repositories, a user will get this response:",
  9395. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#delete-a-repository",
  9396. "previews": [],
  9397. "headers": [],
  9398. "parameters": [
  9399. {
  9400. "name": "owner",
  9401. "description": "owner parameter",
  9402. "in": "PATH",
  9403. "type": "string",
  9404. "required": true,
  9405. "enum": null,
  9406. "allowNull": false,
  9407. "mapToData": null,
  9408. "validation": null,
  9409. "alias": null,
  9410. "deprecated": null
  9411. },
  9412. {
  9413. "name": "repo",
  9414. "description": "repo parameter",
  9415. "in": "PATH",
  9416. "type": "string",
  9417. "required": true,
  9418. "enum": null,
  9419. "allowNull": false,
  9420. "mapToData": null,
  9421. "validation": null,
  9422. "alias": null,
  9423. "deprecated": null
  9424. }
  9425. ],
  9426. "responses": [
  9427. {
  9428. "code": 403,
  9429. "description": "response",
  9430. "examples": [
  9431. {
  9432. "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/repos/#delete-a-repository\"}"
  9433. },
  9434. {
  9435. "data": "{\"message\":\"Users cannot delete repositories on this appliance.\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/repos/#delete-a-repository\"}"
  9436. }
  9437. ]
  9438. }
  9439. ],
  9440. "renamed": null
  9441. },
  9442. {
  9443. "name": "List assignees",
  9444. "scope": "issues",
  9445. "id": "listAssignees",
  9446. "method": "GET",
  9447. "url": "/repos/{owner}/{repo}/assignees",
  9448. "isDeprecated": false,
  9449. "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.",
  9450. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/assignees/#list-assignees",
  9451. "previews": [],
  9452. "headers": [],
  9453. "parameters": [
  9454. {
  9455. "name": "owner",
  9456. "description": "owner parameter",
  9457. "in": "PATH",
  9458. "type": "string",
  9459. "required": true,
  9460. "enum": null,
  9461. "allowNull": false,
  9462. "mapToData": null,
  9463. "validation": null,
  9464. "alias": null,
  9465. "deprecated": null
  9466. },
  9467. {
  9468. "name": "repo",
  9469. "description": "repo parameter",
  9470. "in": "PATH",
  9471. "type": "string",
  9472. "required": true,
  9473. "enum": null,
  9474. "allowNull": false,
  9475. "mapToData": null,
  9476. "validation": null,
  9477. "alias": null,
  9478. "deprecated": null
  9479. },
  9480. {
  9481. "name": "per_page",
  9482. "description": "Results per page (max 100)",
  9483. "in": "QUERY",
  9484. "type": "integer",
  9485. "required": false,
  9486. "enum": null,
  9487. "allowNull": false,
  9488. "mapToData": null,
  9489. "validation": null,
  9490. "alias": null,
  9491. "deprecated": null
  9492. },
  9493. {
  9494. "name": "page",
  9495. "description": "Page number of the results to fetch.",
  9496. "in": "QUERY",
  9497. "type": "integer",
  9498. "required": false,
  9499. "enum": null,
  9500. "allowNull": false,
  9501. "mapToData": null,
  9502. "validation": null,
  9503. "alias": null,
  9504. "deprecated": null
  9505. }
  9506. ],
  9507. "responses": [
  9508. {
  9509. "code": 200,
  9510. "description": "response",
  9511. "examples": [
  9512. {
  9513. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  9514. }
  9515. ]
  9516. }
  9517. ],
  9518. "renamed": null
  9519. },
  9520. {
  9521. "name": "Check assignee",
  9522. "scope": "issues",
  9523. "id": "checkAssignee",
  9524. "method": "GET",
  9525. "url": "/repos/{owner}/{repo}/assignees/{assignee}",
  9526. "isDeprecated": false,
  9527. "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.",
  9528. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/assignees/#check-assignee",
  9529. "previews": [],
  9530. "headers": [],
  9531. "parameters": [
  9532. {
  9533. "name": "owner",
  9534. "description": "owner parameter",
  9535. "in": "PATH",
  9536. "type": "string",
  9537. "required": true,
  9538. "enum": null,
  9539. "allowNull": false,
  9540. "mapToData": null,
  9541. "validation": null,
  9542. "alias": null,
  9543. "deprecated": null
  9544. },
  9545. {
  9546. "name": "repo",
  9547. "description": "repo parameter",
  9548. "in": "PATH",
  9549. "type": "string",
  9550. "required": true,
  9551. "enum": null,
  9552. "allowNull": false,
  9553. "mapToData": null,
  9554. "validation": null,
  9555. "alias": null,
  9556. "deprecated": null
  9557. },
  9558. {
  9559. "name": "assignee",
  9560. "description": "assignee parameter",
  9561. "in": "PATH",
  9562. "type": "string",
  9563. "required": true,
  9564. "enum": null,
  9565. "allowNull": false,
  9566. "mapToData": null,
  9567. "validation": null,
  9568. "alias": null,
  9569. "deprecated": null
  9570. }
  9571. ],
  9572. "responses": [],
  9573. "renamed": null
  9574. },
  9575. {
  9576. "name": "List branches",
  9577. "scope": "repos",
  9578. "id": "listBranches",
  9579. "method": "GET",
  9580. "url": "/repos/{owner}/{repo}/branches",
  9581. "isDeprecated": false,
  9582. "description": "",
  9583. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-branches",
  9584. "previews": [],
  9585. "headers": [],
  9586. "parameters": [
  9587. {
  9588. "name": "owner",
  9589. "description": "owner parameter",
  9590. "in": "PATH",
  9591. "type": "string",
  9592. "required": true,
  9593. "enum": null,
  9594. "allowNull": false,
  9595. "mapToData": null,
  9596. "validation": null,
  9597. "alias": null,
  9598. "deprecated": null
  9599. },
  9600. {
  9601. "name": "repo",
  9602. "description": "repo parameter",
  9603. "in": "PATH",
  9604. "type": "string",
  9605. "required": true,
  9606. "enum": null,
  9607. "allowNull": false,
  9608. "mapToData": null,
  9609. "validation": null,
  9610. "alias": null,
  9611. "deprecated": null
  9612. },
  9613. {
  9614. "name": "protected",
  9615. "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.",
  9616. "in": "QUERY",
  9617. "type": "boolean",
  9618. "required": false,
  9619. "enum": null,
  9620. "allowNull": false,
  9621. "mapToData": null,
  9622. "validation": null,
  9623. "alias": null,
  9624. "deprecated": null
  9625. },
  9626. {
  9627. "name": "per_page",
  9628. "description": "Results per page (max 100)",
  9629. "in": "QUERY",
  9630. "type": "integer",
  9631. "required": false,
  9632. "enum": null,
  9633. "allowNull": false,
  9634. "mapToData": null,
  9635. "validation": null,
  9636. "alias": null,
  9637. "deprecated": null
  9638. },
  9639. {
  9640. "name": "page",
  9641. "description": "Page number of the results to fetch.",
  9642. "in": "QUERY",
  9643. "type": "integer",
  9644. "required": false,
  9645. "enum": null,
  9646. "allowNull": false,
  9647. "mapToData": null,
  9648. "validation": null,
  9649. "alias": null,
  9650. "deprecated": null
  9651. }
  9652. ],
  9653. "responses": [
  9654. {
  9655. "code": 200,
  9656. "description": "response",
  9657. "examples": [
  9658. {
  9659. "data": "[{\"name\":\"master\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":true,\"protection\":{\"enabled\":true,\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}]"
  9660. }
  9661. ]
  9662. }
  9663. ],
  9664. "renamed": null
  9665. },
  9666. {
  9667. "name": "Get branch",
  9668. "scope": "repos",
  9669. "id": "getBranch",
  9670. "method": "GET",
  9671. "url": "/repos/{owner}/{repo}/branches/{branch}",
  9672. "isDeprecated": false,
  9673. "description": "",
  9674. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-branch",
  9675. "previews": [],
  9676. "headers": [],
  9677. "parameters": [
  9678. {
  9679. "name": "owner",
  9680. "description": "owner parameter",
  9681. "in": "PATH",
  9682. "type": "string",
  9683. "required": true,
  9684. "enum": null,
  9685. "allowNull": false,
  9686. "mapToData": null,
  9687. "validation": null,
  9688. "alias": null,
  9689. "deprecated": null
  9690. },
  9691. {
  9692. "name": "repo",
  9693. "description": "repo parameter",
  9694. "in": "PATH",
  9695. "type": "string",
  9696. "required": true,
  9697. "enum": null,
  9698. "allowNull": false,
  9699. "mapToData": null,
  9700. "validation": null,
  9701. "alias": null,
  9702. "deprecated": null
  9703. },
  9704. {
  9705. "name": "branch",
  9706. "description": "branch parameter",
  9707. "in": "PATH",
  9708. "type": "string",
  9709. "required": true,
  9710. "enum": null,
  9711. "allowNull": false,
  9712. "mapToData": null,
  9713. "validation": null,
  9714. "alias": null,
  9715. "deprecated": null
  9716. }
  9717. ],
  9718. "responses": [
  9719. {
  9720. "code": 200,
  9721. "description": "response",
  9722. "examples": [
  9723. {
  9724. "data": "{\"name\":\"master\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\"},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}],\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"committer\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\"}},\"_links\":{\"html\":\"https://github.com/octocat/Hello-World/tree/master\",\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/master\"},\"protected\":true,\"protection\":{\"enabled\":true,\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}"
  9725. }
  9726. ]
  9727. }
  9728. ],
  9729. "renamed": null
  9730. },
  9731. {
  9732. "name": "Get branch protection",
  9733. "scope": "repos",
  9734. "id": "getBranchProtection",
  9735. "method": "GET",
  9736. "url": "/repos/{owner}/{repo}/branches/{branch}/protection",
  9737. "isDeprecated": false,
  9738. "description": "",
  9739. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-branch-protection",
  9740. "previews": [],
  9741. "headers": [],
  9742. "parameters": [
  9743. {
  9744. "name": "owner",
  9745. "description": "owner parameter",
  9746. "in": "PATH",
  9747. "type": "string",
  9748. "required": true,
  9749. "enum": null,
  9750. "allowNull": false,
  9751. "mapToData": null,
  9752. "validation": null,
  9753. "alias": null,
  9754. "deprecated": null
  9755. },
  9756. {
  9757. "name": "repo",
  9758. "description": "repo parameter",
  9759. "in": "PATH",
  9760. "type": "string",
  9761. "required": true,
  9762. "enum": null,
  9763. "allowNull": false,
  9764. "mapToData": null,
  9765. "validation": null,
  9766. "alias": null,
  9767. "deprecated": null
  9768. },
  9769. {
  9770. "name": "branch",
  9771. "description": "branch parameter",
  9772. "in": "PATH",
  9773. "type": "string",
  9774. "required": true,
  9775. "enum": null,
  9776. "allowNull": false,
  9777. "mapToData": null,
  9778. "validation": null,
  9779. "alias": null,
  9780. "deprecated": null
  9781. }
  9782. ],
  9783. "responses": [
  9784. {
  9785. "code": 200,
  9786. "description": "response",
  9787. "examples": [
  9788. {
  9789. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}]}"
  9790. }
  9791. ]
  9792. }
  9793. ],
  9794. "renamed": null
  9795. },
  9796. {
  9797. "name": "Update branch protection",
  9798. "scope": "repos",
  9799. "id": "updateBranchProtection",
  9800. "method": "PUT",
  9801. "url": "/repos/{owner}/{repo}/branches/{branch}/protection",
  9802. "isDeprecated": false,
  9803. "description": "Protecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users and teams in total is limited to 100 items.",
  9804. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#update-branch-protection",
  9805. "previews": [],
  9806. "headers": [],
  9807. "parameters": [
  9808. {
  9809. "name": "owner",
  9810. "description": "owner parameter",
  9811. "in": "PATH",
  9812. "type": "string",
  9813. "required": true,
  9814. "enum": null,
  9815. "allowNull": false,
  9816. "mapToData": null,
  9817. "validation": null,
  9818. "alias": null,
  9819. "deprecated": null
  9820. },
  9821. {
  9822. "name": "repo",
  9823. "description": "repo parameter",
  9824. "in": "PATH",
  9825. "type": "string",
  9826. "required": true,
  9827. "enum": null,
  9828. "allowNull": false,
  9829. "mapToData": null,
  9830. "validation": null,
  9831. "alias": null,
  9832. "deprecated": null
  9833. },
  9834. {
  9835. "name": "branch",
  9836. "description": "branch parameter",
  9837. "in": "PATH",
  9838. "type": "string",
  9839. "required": true,
  9840. "enum": null,
  9841. "allowNull": false,
  9842. "mapToData": null,
  9843. "validation": null,
  9844. "alias": null,
  9845. "deprecated": null
  9846. },
  9847. {
  9848. "name": "required_status_checks",
  9849. "description": "Require status checks to pass before merging. Set to `null` to disable.",
  9850. "in": "BODY",
  9851. "type": "object",
  9852. "required": true,
  9853. "enum": null,
  9854. "allowNull": true,
  9855. "mapToData": null,
  9856. "validation": null,
  9857. "alias": null,
  9858. "deprecated": null
  9859. },
  9860. {
  9861. "name": "required_status_checks.strict",
  9862. "description": "Require branches to be up to date before merging.",
  9863. "in": "BODY",
  9864. "type": "boolean",
  9865. "required": true,
  9866. "enum": null,
  9867. "allowNull": false,
  9868. "mapToData": null,
  9869. "validation": null,
  9870. "alias": null,
  9871. "deprecated": null
  9872. },
  9873. {
  9874. "name": "required_status_checks.contexts",
  9875. "description": "The list of status checks to require in order to merge into this branch",
  9876. "in": "BODY",
  9877. "type": "string[]",
  9878. "required": true,
  9879. "enum": null,
  9880. "allowNull": false,
  9881. "mapToData": null,
  9882. "validation": null,
  9883. "alias": null,
  9884. "deprecated": null
  9885. },
  9886. {
  9887. "name": "enforce_admins",
  9888. "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.",
  9889. "in": "BODY",
  9890. "type": "boolean",
  9891. "required": true,
  9892. "enum": null,
  9893. "allowNull": true,
  9894. "mapToData": null,
  9895. "validation": null,
  9896. "alias": null,
  9897. "deprecated": null
  9898. },
  9899. {
  9900. "name": "required_pull_request_reviews",
  9901. "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.",
  9902. "in": "BODY",
  9903. "type": "object",
  9904. "required": true,
  9905. "enum": null,
  9906. "allowNull": true,
  9907. "mapToData": null,
  9908. "validation": null,
  9909. "alias": null,
  9910. "deprecated": null
  9911. },
  9912. {
  9913. "name": "required_pull_request_reviews.dismissal_restrictions",
  9914. "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.",
  9915. "in": "BODY",
  9916. "type": "object",
  9917. "required": false,
  9918. "enum": null,
  9919. "allowNull": false,
  9920. "mapToData": null,
  9921. "validation": null,
  9922. "alias": null,
  9923. "deprecated": null
  9924. },
  9925. {
  9926. "name": "required_pull_request_reviews.dismissal_restrictions.users",
  9927. "description": "The list of user `login`s with dismissal access",
  9928. "in": "BODY",
  9929. "type": "string[]",
  9930. "required": false,
  9931. "enum": null,
  9932. "allowNull": false,
  9933. "mapToData": null,
  9934. "validation": null,
  9935. "alias": null,
  9936. "deprecated": null
  9937. },
  9938. {
  9939. "name": "required_pull_request_reviews.dismissal_restrictions.teams",
  9940. "description": "The list of team `slug`s with dismissal access",
  9941. "in": "BODY",
  9942. "type": "string[]",
  9943. "required": false,
  9944. "enum": null,
  9945. "allowNull": false,
  9946. "mapToData": null,
  9947. "validation": null,
  9948. "alias": null,
  9949. "deprecated": null
  9950. },
  9951. {
  9952. "name": "required_pull_request_reviews.dismiss_stale_reviews",
  9953. "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
  9954. "in": "BODY",
  9955. "type": "boolean",
  9956. "required": false,
  9957. "enum": null,
  9958. "allowNull": false,
  9959. "mapToData": null,
  9960. "validation": null,
  9961. "alias": null,
  9962. "deprecated": null
  9963. },
  9964. {
  9965. "name": "required_pull_request_reviews.require_code_owner_reviews",
  9966. "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.",
  9967. "in": "BODY",
  9968. "type": "boolean",
  9969. "required": false,
  9970. "enum": null,
  9971. "allowNull": false,
  9972. "mapToData": null,
  9973. "validation": null,
  9974. "alias": null,
  9975. "deprecated": null
  9976. },
  9977. {
  9978. "name": "required_pull_request_reviews.required_approving_review_count",
  9979. "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
  9980. "in": "BODY",
  9981. "type": "integer",
  9982. "required": false,
  9983. "enum": null,
  9984. "allowNull": false,
  9985. "mapToData": null,
  9986. "validation": null,
  9987. "alias": null,
  9988. "deprecated": null
  9989. },
  9990. {
  9991. "name": "restrictions",
  9992. "description": "Restrict who can push to the protected branch. User and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.",
  9993. "in": "BODY",
  9994. "type": "object",
  9995. "required": true,
  9996. "enum": null,
  9997. "allowNull": true,
  9998. "mapToData": null,
  9999. "validation": null,
  10000. "alias": null,
  10001. "deprecated": null
  10002. },
  10003. {
  10004. "name": "restrictions.users",
  10005. "description": "The list of user `login`s with push access",
  10006. "in": "BODY",
  10007. "type": "string[]",
  10008. "required": true,
  10009. "enum": null,
  10010. "allowNull": false,
  10011. "mapToData": null,
  10012. "validation": null,
  10013. "alias": null,
  10014. "deprecated": null
  10015. },
  10016. {
  10017. "name": "restrictions.teams",
  10018. "description": "The list of team `slug`s with push access",
  10019. "in": "BODY",
  10020. "type": "string[]",
  10021. "required": true,
  10022. "enum": null,
  10023. "allowNull": false,
  10024. "mapToData": null,
  10025. "validation": null,
  10026. "alias": null,
  10027. "deprecated": null
  10028. }
  10029. ],
  10030. "responses": [
  10031. {
  10032. "code": 200,
  10033. "description": "response",
  10034. "examples": [
  10035. {
  10036. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}]}"
  10037. }
  10038. ]
  10039. }
  10040. ],
  10041. "renamed": null
  10042. },
  10043. {
  10044. "name": "Remove branch protection",
  10045. "scope": "repos",
  10046. "id": "removeBranchProtection",
  10047. "method": "DELETE",
  10048. "url": "/repos/{owner}/{repo}/branches/{branch}/protection",
  10049. "isDeprecated": false,
  10050. "description": "",
  10051. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-branch-protection",
  10052. "previews": [],
  10053. "headers": [],
  10054. "parameters": [
  10055. {
  10056. "name": "owner",
  10057. "description": "owner parameter",
  10058. "in": "PATH",
  10059. "type": "string",
  10060. "required": true,
  10061. "enum": null,
  10062. "allowNull": false,
  10063. "mapToData": null,
  10064. "validation": null,
  10065. "alias": null,
  10066. "deprecated": null
  10067. },
  10068. {
  10069. "name": "repo",
  10070. "description": "repo parameter",
  10071. "in": "PATH",
  10072. "type": "string",
  10073. "required": true,
  10074. "enum": null,
  10075. "allowNull": false,
  10076. "mapToData": null,
  10077. "validation": null,
  10078. "alias": null,
  10079. "deprecated": null
  10080. },
  10081. {
  10082. "name": "branch",
  10083. "description": "branch parameter",
  10084. "in": "PATH",
  10085. "type": "string",
  10086. "required": true,
  10087. "enum": null,
  10088. "allowNull": false,
  10089. "mapToData": null,
  10090. "validation": null,
  10091. "alias": null,
  10092. "deprecated": null
  10093. }
  10094. ],
  10095. "responses": [],
  10096. "renamed": null
  10097. },
  10098. {
  10099. "name": "Get admin enforcement of protected branch",
  10100. "scope": "repos",
  10101. "id": "getProtectedBranchAdminEnforcement",
  10102. "method": "GET",
  10103. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
  10104. "isDeprecated": false,
  10105. "description": "",
  10106. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-admin-enforcement-of-protected-branch",
  10107. "previews": [],
  10108. "headers": [],
  10109. "parameters": [
  10110. {
  10111. "name": "owner",
  10112. "description": "owner parameter",
  10113. "in": "PATH",
  10114. "type": "string",
  10115. "required": true,
  10116. "enum": null,
  10117. "allowNull": false,
  10118. "mapToData": null,
  10119. "validation": null,
  10120. "alias": null,
  10121. "deprecated": null
  10122. },
  10123. {
  10124. "name": "repo",
  10125. "description": "repo parameter",
  10126. "in": "PATH",
  10127. "type": "string",
  10128. "required": true,
  10129. "enum": null,
  10130. "allowNull": false,
  10131. "mapToData": null,
  10132. "validation": null,
  10133. "alias": null,
  10134. "deprecated": null
  10135. },
  10136. {
  10137. "name": "branch",
  10138. "description": "branch parameter",
  10139. "in": "PATH",
  10140. "type": "string",
  10141. "required": true,
  10142. "enum": null,
  10143. "allowNull": false,
  10144. "mapToData": null,
  10145. "validation": null,
  10146. "alias": null,
  10147. "deprecated": null
  10148. }
  10149. ],
  10150. "responses": [
  10151. {
  10152. "code": 200,
  10153. "description": "response",
  10154. "examples": [
  10155. {
  10156. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}"
  10157. }
  10158. ]
  10159. }
  10160. ],
  10161. "renamed": null
  10162. },
  10163. {
  10164. "name": "Add admin enforcement of protected branch",
  10165. "scope": "repos",
  10166. "id": "addProtectedBranchAdminEnforcement",
  10167. "method": "POST",
  10168. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
  10169. "isDeprecated": false,
  10170. "description": "Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
  10171. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#add-admin-enforcement-of-protected-branch",
  10172. "previews": [],
  10173. "headers": [],
  10174. "parameters": [
  10175. {
  10176. "name": "owner",
  10177. "description": "owner parameter",
  10178. "in": "PATH",
  10179. "type": "string",
  10180. "required": true,
  10181. "enum": null,
  10182. "allowNull": false,
  10183. "mapToData": null,
  10184. "validation": null,
  10185. "alias": null,
  10186. "deprecated": null
  10187. },
  10188. {
  10189. "name": "repo",
  10190. "description": "repo parameter",
  10191. "in": "PATH",
  10192. "type": "string",
  10193. "required": true,
  10194. "enum": null,
  10195. "allowNull": false,
  10196. "mapToData": null,
  10197. "validation": null,
  10198. "alias": null,
  10199. "deprecated": null
  10200. },
  10201. {
  10202. "name": "branch",
  10203. "description": "branch parameter",
  10204. "in": "PATH",
  10205. "type": "string",
  10206. "required": true,
  10207. "enum": null,
  10208. "allowNull": false,
  10209. "mapToData": null,
  10210. "validation": null,
  10211. "alias": null,
  10212. "deprecated": null
  10213. }
  10214. ],
  10215. "responses": [
  10216. {
  10217. "code": 200,
  10218. "description": "response",
  10219. "examples": [
  10220. {
  10221. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}"
  10222. }
  10223. ]
  10224. }
  10225. ],
  10226. "renamed": null
  10227. },
  10228. {
  10229. "name": "Remove admin enforcement of protected branch",
  10230. "scope": "repos",
  10231. "id": "removeProtectedBranchAdminEnforcement",
  10232. "method": "DELETE",
  10233. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins",
  10234. "isDeprecated": false,
  10235. "description": "Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.",
  10236. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-admin-enforcement-of-protected-branch",
  10237. "previews": [],
  10238. "headers": [],
  10239. "parameters": [
  10240. {
  10241. "name": "owner",
  10242. "description": "owner parameter",
  10243. "in": "PATH",
  10244. "type": "string",
  10245. "required": true,
  10246. "enum": null,
  10247. "allowNull": false,
  10248. "mapToData": null,
  10249. "validation": null,
  10250. "alias": null,
  10251. "deprecated": null
  10252. },
  10253. {
  10254. "name": "repo",
  10255. "description": "repo parameter",
  10256. "in": "PATH",
  10257. "type": "string",
  10258. "required": true,
  10259. "enum": null,
  10260. "allowNull": false,
  10261. "mapToData": null,
  10262. "validation": null,
  10263. "alias": null,
  10264. "deprecated": null
  10265. },
  10266. {
  10267. "name": "branch",
  10268. "description": "branch parameter",
  10269. "in": "PATH",
  10270. "type": "string",
  10271. "required": true,
  10272. "enum": null,
  10273. "allowNull": false,
  10274. "mapToData": null,
  10275. "validation": null,
  10276. "alias": null,
  10277. "deprecated": null
  10278. }
  10279. ],
  10280. "responses": [],
  10281. "renamed": null
  10282. },
  10283. {
  10284. "name": "Get pull request review enforcement of protected branch",
  10285. "scope": "repos",
  10286. "id": "getProtectedBranchPullRequestReviewEnforcement",
  10287. "method": "GET",
  10288. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
  10289. "isDeprecated": false,
  10290. "description": "",
  10291. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch",
  10292. "previews": [],
  10293. "headers": [],
  10294. "parameters": [
  10295. {
  10296. "name": "owner",
  10297. "description": "owner parameter",
  10298. "in": "PATH",
  10299. "type": "string",
  10300. "required": true,
  10301. "enum": null,
  10302. "allowNull": false,
  10303. "mapToData": null,
  10304. "validation": null,
  10305. "alias": null,
  10306. "deprecated": null
  10307. },
  10308. {
  10309. "name": "repo",
  10310. "description": "repo parameter",
  10311. "in": "PATH",
  10312. "type": "string",
  10313. "required": true,
  10314. "enum": null,
  10315. "allowNull": false,
  10316. "mapToData": null,
  10317. "validation": null,
  10318. "alias": null,
  10319. "deprecated": null
  10320. },
  10321. {
  10322. "name": "branch",
  10323. "description": "branch parameter",
  10324. "in": "PATH",
  10325. "type": "string",
  10326. "required": true,
  10327. "enum": null,
  10328. "allowNull": false,
  10329. "mapToData": null,
  10330. "validation": null,
  10331. "alias": null,
  10332. "deprecated": null
  10333. }
  10334. ],
  10335. "responses": [
  10336. {
  10337. "code": 200,
  10338. "description": "response",
  10339. "examples": [
  10340. {
  10341. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}"
  10342. }
  10343. ]
  10344. }
  10345. ],
  10346. "renamed": null
  10347. },
  10348. {
  10349. "name": "Update pull request review enforcement of protected branch",
  10350. "scope": "repos",
  10351. "id": "updateProtectedBranchPullRequestReviewEnforcement",
  10352. "method": "PATCH",
  10353. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
  10354. "isDeprecated": false,
  10355. "description": "Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.",
  10356. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch",
  10357. "previews": [],
  10358. "headers": [],
  10359. "parameters": [
  10360. {
  10361. "name": "owner",
  10362. "description": "owner parameter",
  10363. "in": "PATH",
  10364. "type": "string",
  10365. "required": true,
  10366. "enum": null,
  10367. "allowNull": false,
  10368. "mapToData": null,
  10369. "validation": null,
  10370. "alias": null,
  10371. "deprecated": null
  10372. },
  10373. {
  10374. "name": "repo",
  10375. "description": "repo parameter",
  10376. "in": "PATH",
  10377. "type": "string",
  10378. "required": true,
  10379. "enum": null,
  10380. "allowNull": false,
  10381. "mapToData": null,
  10382. "validation": null,
  10383. "alias": null,
  10384. "deprecated": null
  10385. },
  10386. {
  10387. "name": "branch",
  10388. "description": "branch parameter",
  10389. "in": "PATH",
  10390. "type": "string",
  10391. "required": true,
  10392. "enum": null,
  10393. "allowNull": false,
  10394. "mapToData": null,
  10395. "validation": null,
  10396. "alias": null,
  10397. "deprecated": null
  10398. },
  10399. {
  10400. "name": "dismissal_restrictions",
  10401. "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.",
  10402. "in": "BODY",
  10403. "type": "object",
  10404. "required": false,
  10405. "enum": null,
  10406. "allowNull": false,
  10407. "mapToData": null,
  10408. "validation": null,
  10409. "alias": null,
  10410. "deprecated": null
  10411. },
  10412. {
  10413. "name": "dismissal_restrictions.users",
  10414. "description": "The list of user `login`s with dismissal access",
  10415. "in": "BODY",
  10416. "type": "string[]",
  10417. "required": false,
  10418. "enum": null,
  10419. "allowNull": false,
  10420. "mapToData": null,
  10421. "validation": null,
  10422. "alias": null,
  10423. "deprecated": null
  10424. },
  10425. {
  10426. "name": "dismissal_restrictions.teams",
  10427. "description": "The list of team `slug`s with dismissal access",
  10428. "in": "BODY",
  10429. "type": "string[]",
  10430. "required": false,
  10431. "enum": null,
  10432. "allowNull": false,
  10433. "mapToData": null,
  10434. "validation": null,
  10435. "alias": null,
  10436. "deprecated": null
  10437. },
  10438. {
  10439. "name": "dismiss_stale_reviews",
  10440. "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.",
  10441. "in": "BODY",
  10442. "type": "boolean",
  10443. "required": false,
  10444. "enum": null,
  10445. "allowNull": false,
  10446. "mapToData": null,
  10447. "validation": null,
  10448. "alias": null,
  10449. "deprecated": null
  10450. },
  10451. {
  10452. "name": "require_code_owner_reviews",
  10453. "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.",
  10454. "in": "BODY",
  10455. "type": "boolean",
  10456. "required": false,
  10457. "enum": null,
  10458. "allowNull": false,
  10459. "mapToData": null,
  10460. "validation": null,
  10461. "alias": null,
  10462. "deprecated": null
  10463. },
  10464. {
  10465. "name": "required_approving_review_count",
  10466. "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.",
  10467. "in": "BODY",
  10468. "type": "integer",
  10469. "required": false,
  10470. "enum": null,
  10471. "allowNull": false,
  10472. "mapToData": null,
  10473. "validation": null,
  10474. "alias": null,
  10475. "deprecated": null
  10476. }
  10477. ],
  10478. "responses": [
  10479. {
  10480. "code": 200,
  10481. "description": "response",
  10482. "examples": [
  10483. {
  10484. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}"
  10485. }
  10486. ]
  10487. }
  10488. ],
  10489. "renamed": null
  10490. },
  10491. {
  10492. "name": "Remove pull request review enforcement of protected branch",
  10493. "scope": "repos",
  10494. "id": "removeProtectedBranchPullRequestReviewEnforcement",
  10495. "method": "DELETE",
  10496. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews",
  10497. "isDeprecated": false,
  10498. "description": "",
  10499. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch",
  10500. "previews": [],
  10501. "headers": [],
  10502. "parameters": [
  10503. {
  10504. "name": "owner",
  10505. "description": "owner parameter",
  10506. "in": "PATH",
  10507. "type": "string",
  10508. "required": true,
  10509. "enum": null,
  10510. "allowNull": false,
  10511. "mapToData": null,
  10512. "validation": null,
  10513. "alias": null,
  10514. "deprecated": null
  10515. },
  10516. {
  10517. "name": "repo",
  10518. "description": "repo parameter",
  10519. "in": "PATH",
  10520. "type": "string",
  10521. "required": true,
  10522. "enum": null,
  10523. "allowNull": false,
  10524. "mapToData": null,
  10525. "validation": null,
  10526. "alias": null,
  10527. "deprecated": null
  10528. },
  10529. {
  10530. "name": "branch",
  10531. "description": "branch parameter",
  10532. "in": "PATH",
  10533. "type": "string",
  10534. "required": true,
  10535. "enum": null,
  10536. "allowNull": false,
  10537. "mapToData": null,
  10538. "validation": null,
  10539. "alias": null,
  10540. "deprecated": null
  10541. }
  10542. ],
  10543. "responses": [],
  10544. "renamed": null
  10545. },
  10546. {
  10547. "name": "Get required signatures of protected branch",
  10548. "scope": "repos",
  10549. "id": "getProtectedBranchRequiredSignatures",
  10550. "method": "GET",
  10551. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
  10552. "isDeprecated": false,
  10553. "description": "When authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.",
  10554. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-required-signatures-of-protected-branch",
  10555. "previews": [{ "name": "zzzax" }],
  10556. "headers": [
  10557. { "name": "accept", "value": "application/vnd.github.zzzax-preview+json" }
  10558. ],
  10559. "parameters": [
  10560. {
  10561. "name": "owner",
  10562. "description": "owner parameter",
  10563. "in": "PATH",
  10564. "type": "string",
  10565. "required": true,
  10566. "enum": null,
  10567. "allowNull": false,
  10568. "mapToData": null,
  10569. "validation": null,
  10570. "alias": null,
  10571. "deprecated": null
  10572. },
  10573. {
  10574. "name": "repo",
  10575. "description": "repo parameter",
  10576. "in": "PATH",
  10577. "type": "string",
  10578. "required": true,
  10579. "enum": null,
  10580. "allowNull": false,
  10581. "mapToData": null,
  10582. "validation": null,
  10583. "alias": null,
  10584. "deprecated": null
  10585. },
  10586. {
  10587. "name": "branch",
  10588. "description": "branch parameter",
  10589. "in": "PATH",
  10590. "type": "string",
  10591. "required": true,
  10592. "enum": null,
  10593. "allowNull": false,
  10594. "mapToData": null,
  10595. "validation": null,
  10596. "alias": null,
  10597. "deprecated": null
  10598. }
  10599. ],
  10600. "responses": [
  10601. {
  10602. "code": 200,
  10603. "description": "response",
  10604. "examples": [
  10605. {
  10606. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}"
  10607. }
  10608. ]
  10609. }
  10610. ],
  10611. "renamed": null
  10612. },
  10613. {
  10614. "name": "Add required signatures of protected branch",
  10615. "scope": "repos",
  10616. "id": "addProtectedBranchRequiredSignatures",
  10617. "method": "POST",
  10618. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
  10619. "isDeprecated": false,
  10620. "description": "When authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.",
  10621. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#add-required-signatures-of-protected-branch",
  10622. "previews": [{ "name": "zzzax" }],
  10623. "headers": [
  10624. { "name": "accept", "value": "application/vnd.github.zzzax-preview+json" }
  10625. ],
  10626. "parameters": [
  10627. {
  10628. "name": "owner",
  10629. "description": "owner parameter",
  10630. "in": "PATH",
  10631. "type": "string",
  10632. "required": true,
  10633. "enum": null,
  10634. "allowNull": false,
  10635. "mapToData": null,
  10636. "validation": null,
  10637. "alias": null,
  10638. "deprecated": null
  10639. },
  10640. {
  10641. "name": "repo",
  10642. "description": "repo parameter",
  10643. "in": "PATH",
  10644. "type": "string",
  10645. "required": true,
  10646. "enum": null,
  10647. "allowNull": false,
  10648. "mapToData": null,
  10649. "validation": null,
  10650. "alias": null,
  10651. "deprecated": null
  10652. },
  10653. {
  10654. "name": "branch",
  10655. "description": "branch parameter",
  10656. "in": "PATH",
  10657. "type": "string",
  10658. "required": true,
  10659. "enum": null,
  10660. "allowNull": false,
  10661. "mapToData": null,
  10662. "validation": null,
  10663. "alias": null,
  10664. "deprecated": null
  10665. }
  10666. ],
  10667. "responses": [
  10668. {
  10669. "code": 200,
  10670. "description": "response",
  10671. "examples": [
  10672. {
  10673. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}"
  10674. }
  10675. ]
  10676. }
  10677. ],
  10678. "renamed": null
  10679. },
  10680. {
  10681. "name": "Remove required signatures of protected branch",
  10682. "scope": "repos",
  10683. "id": "removeProtectedBranchRequiredSignatures",
  10684. "method": "DELETE",
  10685. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures",
  10686. "isDeprecated": false,
  10687. "description": "When authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.",
  10688. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-required-signatures-of-protected-branch",
  10689. "previews": [{ "name": "zzzax" }],
  10690. "headers": [
  10691. { "name": "accept", "value": "application/vnd.github.zzzax-preview+json" }
  10692. ],
  10693. "parameters": [
  10694. {
  10695. "name": "owner",
  10696. "description": "owner parameter",
  10697. "in": "PATH",
  10698. "type": "string",
  10699. "required": true,
  10700. "enum": null,
  10701. "allowNull": false,
  10702. "mapToData": null,
  10703. "validation": null,
  10704. "alias": null,
  10705. "deprecated": null
  10706. },
  10707. {
  10708. "name": "repo",
  10709. "description": "repo parameter",
  10710. "in": "PATH",
  10711. "type": "string",
  10712. "required": true,
  10713. "enum": null,
  10714. "allowNull": false,
  10715. "mapToData": null,
  10716. "validation": null,
  10717. "alias": null,
  10718. "deprecated": null
  10719. },
  10720. {
  10721. "name": "branch",
  10722. "description": "branch parameter",
  10723. "in": "PATH",
  10724. "type": "string",
  10725. "required": true,
  10726. "enum": null,
  10727. "allowNull": false,
  10728. "mapToData": null,
  10729. "validation": null,
  10730. "alias": null,
  10731. "deprecated": null
  10732. }
  10733. ],
  10734. "responses": [],
  10735. "renamed": null
  10736. },
  10737. {
  10738. "name": "Get required status checks of protected branch",
  10739. "scope": "repos",
  10740. "id": "getProtectedBranchRequiredStatusChecks",
  10741. "method": "GET",
  10742. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
  10743. "isDeprecated": false,
  10744. "description": "",
  10745. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-required-status-checks-of-protected-branch",
  10746. "previews": [],
  10747. "headers": [],
  10748. "parameters": [
  10749. {
  10750. "name": "owner",
  10751. "description": "owner parameter",
  10752. "in": "PATH",
  10753. "type": "string",
  10754. "required": true,
  10755. "enum": null,
  10756. "allowNull": false,
  10757. "mapToData": null,
  10758. "validation": null,
  10759. "alias": null,
  10760. "deprecated": null
  10761. },
  10762. {
  10763. "name": "repo",
  10764. "description": "repo parameter",
  10765. "in": "PATH",
  10766. "type": "string",
  10767. "required": true,
  10768. "enum": null,
  10769. "allowNull": false,
  10770. "mapToData": null,
  10771. "validation": null,
  10772. "alias": null,
  10773. "deprecated": null
  10774. },
  10775. {
  10776. "name": "branch",
  10777. "description": "branch parameter",
  10778. "in": "PATH",
  10779. "type": "string",
  10780. "required": true,
  10781. "enum": null,
  10782. "allowNull": false,
  10783. "mapToData": null,
  10784. "validation": null,
  10785. "alias": null,
  10786. "deprecated": null
  10787. }
  10788. ],
  10789. "responses": [
  10790. {
  10791. "code": 200,
  10792. "description": "response",
  10793. "examples": [
  10794. {
  10795. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}"
  10796. }
  10797. ]
  10798. }
  10799. ],
  10800. "renamed": null
  10801. },
  10802. {
  10803. "name": "Update required status checks of protected branch",
  10804. "scope": "repos",
  10805. "id": "updateProtectedBranchRequiredStatusChecks",
  10806. "method": "PATCH",
  10807. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
  10808. "isDeprecated": false,
  10809. "description": "Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.",
  10810. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#update-required-status-checks-of-protected-branch",
  10811. "previews": [],
  10812. "headers": [],
  10813. "parameters": [
  10814. {
  10815. "name": "owner",
  10816. "description": "owner parameter",
  10817. "in": "PATH",
  10818. "type": "string",
  10819. "required": true,
  10820. "enum": null,
  10821. "allowNull": false,
  10822. "mapToData": null,
  10823. "validation": null,
  10824. "alias": null,
  10825. "deprecated": null
  10826. },
  10827. {
  10828. "name": "repo",
  10829. "description": "repo parameter",
  10830. "in": "PATH",
  10831. "type": "string",
  10832. "required": true,
  10833. "enum": null,
  10834. "allowNull": false,
  10835. "mapToData": null,
  10836. "validation": null,
  10837. "alias": null,
  10838. "deprecated": null
  10839. },
  10840. {
  10841. "name": "branch",
  10842. "description": "branch parameter",
  10843. "in": "PATH",
  10844. "type": "string",
  10845. "required": true,
  10846. "enum": null,
  10847. "allowNull": false,
  10848. "mapToData": null,
  10849. "validation": null,
  10850. "alias": null,
  10851. "deprecated": null
  10852. },
  10853. {
  10854. "name": "strict",
  10855. "description": "Require branches to be up to date before merging.",
  10856. "in": "BODY",
  10857. "type": "boolean",
  10858. "required": false,
  10859. "enum": null,
  10860. "allowNull": false,
  10861. "mapToData": null,
  10862. "validation": null,
  10863. "alias": null,
  10864. "deprecated": null
  10865. },
  10866. {
  10867. "name": "contexts",
  10868. "description": "The list of status checks to require in order to merge into this branch",
  10869. "in": "BODY",
  10870. "type": "string[]",
  10871. "required": false,
  10872. "enum": null,
  10873. "allowNull": false,
  10874. "mapToData": null,
  10875. "validation": null,
  10876. "alias": null,
  10877. "deprecated": null
  10878. }
  10879. ],
  10880. "responses": [
  10881. {
  10882. "code": 200,
  10883. "description": "response",
  10884. "examples": [
  10885. {
  10886. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}"
  10887. }
  10888. ]
  10889. }
  10890. ],
  10891. "renamed": null
  10892. },
  10893. {
  10894. "name": "Remove required status checks of protected branch",
  10895. "scope": "repos",
  10896. "id": "removeProtectedBranchRequiredStatusChecks",
  10897. "method": "DELETE",
  10898. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks",
  10899. "isDeprecated": false,
  10900. "description": "",
  10901. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-required-status-checks-of-protected-branch",
  10902. "previews": [],
  10903. "headers": [],
  10904. "parameters": [
  10905. {
  10906. "name": "owner",
  10907. "description": "owner parameter",
  10908. "in": "PATH",
  10909. "type": "string",
  10910. "required": true,
  10911. "enum": null,
  10912. "allowNull": false,
  10913. "mapToData": null,
  10914. "validation": null,
  10915. "alias": null,
  10916. "deprecated": null
  10917. },
  10918. {
  10919. "name": "repo",
  10920. "description": "repo parameter",
  10921. "in": "PATH",
  10922. "type": "string",
  10923. "required": true,
  10924. "enum": null,
  10925. "allowNull": false,
  10926. "mapToData": null,
  10927. "validation": null,
  10928. "alias": null,
  10929. "deprecated": null
  10930. },
  10931. {
  10932. "name": "branch",
  10933. "description": "branch parameter",
  10934. "in": "PATH",
  10935. "type": "string",
  10936. "required": true,
  10937. "enum": null,
  10938. "allowNull": false,
  10939. "mapToData": null,
  10940. "validation": null,
  10941. "alias": null,
  10942. "deprecated": null
  10943. }
  10944. ],
  10945. "responses": [],
  10946. "renamed": null
  10947. },
  10948. {
  10949. "name": "List required status checks contexts of protected branch",
  10950. "scope": "repos",
  10951. "id": "listProtectedBranchRequiredStatusChecksContexts",
  10952. "method": "GET",
  10953. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
  10954. "isDeprecated": false,
  10955. "description": "",
  10956. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch",
  10957. "previews": [],
  10958. "headers": [],
  10959. "parameters": [
  10960. {
  10961. "name": "owner",
  10962. "description": "owner parameter",
  10963. "in": "PATH",
  10964. "type": "string",
  10965. "required": true,
  10966. "enum": null,
  10967. "allowNull": false,
  10968. "mapToData": null,
  10969. "validation": null,
  10970. "alias": null,
  10971. "deprecated": null
  10972. },
  10973. {
  10974. "name": "repo",
  10975. "description": "repo parameter",
  10976. "in": "PATH",
  10977. "type": "string",
  10978. "required": true,
  10979. "enum": null,
  10980. "allowNull": false,
  10981. "mapToData": null,
  10982. "validation": null,
  10983. "alias": null,
  10984. "deprecated": null
  10985. },
  10986. {
  10987. "name": "branch",
  10988. "description": "branch parameter",
  10989. "in": "PATH",
  10990. "type": "string",
  10991. "required": true,
  10992. "enum": null,
  10993. "allowNull": false,
  10994. "mapToData": null,
  10995. "validation": null,
  10996. "alias": null,
  10997. "deprecated": null
  10998. }
  10999. ],
  11000. "responses": [
  11001. {
  11002. "code": 200,
  11003. "description": "response",
  11004. "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }]
  11005. }
  11006. ],
  11007. "renamed": null
  11008. },
  11009. {
  11010. "name": "Replace required status checks contexts of protected branch",
  11011. "scope": "repos",
  11012. "id": "replaceProtectedBranchRequiredStatusChecksContexts",
  11013. "method": "PUT",
  11014. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
  11015. "isDeprecated": false,
  11016. "description": "",
  11017. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch",
  11018. "previews": [],
  11019. "headers": [],
  11020. "parameters": [
  11021. {
  11022. "name": "owner",
  11023. "description": "owner parameter",
  11024. "in": "PATH",
  11025. "type": "string",
  11026. "required": true,
  11027. "enum": null,
  11028. "allowNull": false,
  11029. "mapToData": null,
  11030. "validation": null,
  11031. "alias": null,
  11032. "deprecated": null
  11033. },
  11034. {
  11035. "name": "repo",
  11036. "description": "repo parameter",
  11037. "in": "PATH",
  11038. "type": "string",
  11039. "required": true,
  11040. "enum": null,
  11041. "allowNull": false,
  11042. "mapToData": null,
  11043. "validation": null,
  11044. "alias": null,
  11045. "deprecated": null
  11046. },
  11047. {
  11048. "name": "branch",
  11049. "description": "branch parameter",
  11050. "in": "PATH",
  11051. "type": "string",
  11052. "required": true,
  11053. "enum": null,
  11054. "allowNull": false,
  11055. "mapToData": null,
  11056. "validation": null,
  11057. "alias": null,
  11058. "deprecated": null
  11059. },
  11060. {
  11061. "name": "contexts",
  11062. "description": "contexts parameter",
  11063. "in": "BODY",
  11064. "type": "string[]",
  11065. "required": true,
  11066. "enum": null,
  11067. "allowNull": false,
  11068. "mapToData": true,
  11069. "validation": null,
  11070. "alias": null,
  11071. "deprecated": null
  11072. }
  11073. ],
  11074. "responses": [
  11075. {
  11076. "code": 200,
  11077. "description": "response",
  11078. "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }]
  11079. }
  11080. ],
  11081. "renamed": null
  11082. },
  11083. {
  11084. "name": "Add required status checks contexts of protected branch",
  11085. "scope": "repos",
  11086. "id": "addProtectedBranchRequiredStatusChecksContexts",
  11087. "method": "POST",
  11088. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
  11089. "isDeprecated": false,
  11090. "description": "",
  11091. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch",
  11092. "previews": [],
  11093. "headers": [],
  11094. "parameters": [
  11095. {
  11096. "name": "owner",
  11097. "description": "owner parameter",
  11098. "in": "PATH",
  11099. "type": "string",
  11100. "required": true,
  11101. "enum": null,
  11102. "allowNull": false,
  11103. "mapToData": null,
  11104. "validation": null,
  11105. "alias": null,
  11106. "deprecated": null
  11107. },
  11108. {
  11109. "name": "repo",
  11110. "description": "repo parameter",
  11111. "in": "PATH",
  11112. "type": "string",
  11113. "required": true,
  11114. "enum": null,
  11115. "allowNull": false,
  11116. "mapToData": null,
  11117. "validation": null,
  11118. "alias": null,
  11119. "deprecated": null
  11120. },
  11121. {
  11122. "name": "branch",
  11123. "description": "branch parameter",
  11124. "in": "PATH",
  11125. "type": "string",
  11126. "required": true,
  11127. "enum": null,
  11128. "allowNull": false,
  11129. "mapToData": null,
  11130. "validation": null,
  11131. "alias": null,
  11132. "deprecated": null
  11133. },
  11134. {
  11135. "name": "contexts",
  11136. "description": "contexts parameter",
  11137. "in": "BODY",
  11138. "type": "string[]",
  11139. "required": true,
  11140. "enum": null,
  11141. "allowNull": false,
  11142. "mapToData": true,
  11143. "validation": null,
  11144. "alias": null,
  11145. "deprecated": null
  11146. }
  11147. ],
  11148. "responses": [
  11149. {
  11150. "code": 200,
  11151. "description": "response",
  11152. "examples": [
  11153. {
  11154. "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]"
  11155. }
  11156. ]
  11157. }
  11158. ],
  11159. "renamed": null
  11160. },
  11161. {
  11162. "name": "Remove required status checks contexts of protected branch",
  11163. "scope": "repos",
  11164. "id": "removeProtectedBranchRequiredStatusChecksContexts",
  11165. "method": "DELETE",
  11166. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts",
  11167. "isDeprecated": false,
  11168. "description": "",
  11169. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch",
  11170. "previews": [],
  11171. "headers": [],
  11172. "parameters": [
  11173. {
  11174. "name": "owner",
  11175. "description": "owner parameter",
  11176. "in": "PATH",
  11177. "type": "string",
  11178. "required": true,
  11179. "enum": null,
  11180. "allowNull": false,
  11181. "mapToData": null,
  11182. "validation": null,
  11183. "alias": null,
  11184. "deprecated": null
  11185. },
  11186. {
  11187. "name": "repo",
  11188. "description": "repo parameter",
  11189. "in": "PATH",
  11190. "type": "string",
  11191. "required": true,
  11192. "enum": null,
  11193. "allowNull": false,
  11194. "mapToData": null,
  11195. "validation": null,
  11196. "alias": null,
  11197. "deprecated": null
  11198. },
  11199. {
  11200. "name": "branch",
  11201. "description": "branch parameter",
  11202. "in": "PATH",
  11203. "type": "string",
  11204. "required": true,
  11205. "enum": null,
  11206. "allowNull": false,
  11207. "mapToData": null,
  11208. "validation": null,
  11209. "alias": null,
  11210. "deprecated": null
  11211. },
  11212. {
  11213. "name": "contexts",
  11214. "description": "contexts parameter",
  11215. "in": "BODY",
  11216. "type": "string[]",
  11217. "required": true,
  11218. "enum": null,
  11219. "allowNull": false,
  11220. "mapToData": true,
  11221. "validation": null,
  11222. "alias": null,
  11223. "deprecated": null
  11224. }
  11225. ],
  11226. "responses": [
  11227. {
  11228. "code": 200,
  11229. "description": "response",
  11230. "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }]
  11231. }
  11232. ],
  11233. "renamed": null
  11234. },
  11235. {
  11236. "name": "Get restrictions of protected branch",
  11237. "scope": "repos",
  11238. "id": "getProtectedBranchRestrictions",
  11239. "method": "GET",
  11240. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
  11241. "isDeprecated": false,
  11242. "description": "Lists who has access to this protected branch. {{#note}}\n\n**Note**: Users and teams `restrictions` are only available for organization-owned repositories.",
  11243. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#get-restrictions-of-protected-branch",
  11244. "previews": [],
  11245. "headers": [],
  11246. "parameters": [
  11247. {
  11248. "name": "owner",
  11249. "description": "owner parameter",
  11250. "in": "PATH",
  11251. "type": "string",
  11252. "required": true,
  11253. "enum": null,
  11254. "allowNull": false,
  11255. "mapToData": null,
  11256. "validation": null,
  11257. "alias": null,
  11258. "deprecated": null
  11259. },
  11260. {
  11261. "name": "repo",
  11262. "description": "repo parameter",
  11263. "in": "PATH",
  11264. "type": "string",
  11265. "required": true,
  11266. "enum": null,
  11267. "allowNull": false,
  11268. "mapToData": null,
  11269. "validation": null,
  11270. "alias": null,
  11271. "deprecated": null
  11272. },
  11273. {
  11274. "name": "branch",
  11275. "description": "branch parameter",
  11276. "in": "PATH",
  11277. "type": "string",
  11278. "required": true,
  11279. "enum": null,
  11280. "allowNull": false,
  11281. "mapToData": null,
  11282. "validation": null,
  11283. "alias": null,
  11284. "deprecated": null
  11285. }
  11286. ],
  11287. "responses": [
  11288. {
  11289. "code": 200,
  11290. "description": "response",
  11291. "examples": [
  11292. {
  11293. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}"
  11294. }
  11295. ]
  11296. }
  11297. ],
  11298. "renamed": null
  11299. },
  11300. {
  11301. "name": "Remove restrictions of protected branch",
  11302. "scope": "repos",
  11303. "id": "removeProtectedBranchRestrictions",
  11304. "method": "DELETE",
  11305. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions",
  11306. "isDeprecated": false,
  11307. "description": "Disables the ability to restrict who can push to this branch.",
  11308. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-restrictions-of-protected-branch",
  11309. "previews": [],
  11310. "headers": [],
  11311. "parameters": [
  11312. {
  11313. "name": "owner",
  11314. "description": "owner parameter",
  11315. "in": "PATH",
  11316. "type": "string",
  11317. "required": true,
  11318. "enum": null,
  11319. "allowNull": false,
  11320. "mapToData": null,
  11321. "validation": null,
  11322. "alias": null,
  11323. "deprecated": null
  11324. },
  11325. {
  11326. "name": "repo",
  11327. "description": "repo parameter",
  11328. "in": "PATH",
  11329. "type": "string",
  11330. "required": true,
  11331. "enum": null,
  11332. "allowNull": false,
  11333. "mapToData": null,
  11334. "validation": null,
  11335. "alias": null,
  11336. "deprecated": null
  11337. },
  11338. {
  11339. "name": "branch",
  11340. "description": "branch parameter",
  11341. "in": "PATH",
  11342. "type": "string",
  11343. "required": true,
  11344. "enum": null,
  11345. "allowNull": false,
  11346. "mapToData": null,
  11347. "validation": null,
  11348. "alias": null,
  11349. "deprecated": null
  11350. }
  11351. ],
  11352. "responses": [],
  11353. "renamed": null
  11354. },
  11355. {
  11356. "name": "Get teams with access to protected branch",
  11357. "scope": "repos",
  11358. "id": "getTeamsWithAccessToProtectedBranch",
  11359. "method": "GET",
  11360. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
  11361. "isDeprecated": false,
  11362. "description": "Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams.",
  11363. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-teams-with-access-to-protected-branch",
  11364. "previews": [],
  11365. "headers": [],
  11366. "parameters": [
  11367. {
  11368. "name": "owner",
  11369. "description": "owner parameter",
  11370. "in": "PATH",
  11371. "type": "string",
  11372. "required": true,
  11373. "enum": null,
  11374. "allowNull": false,
  11375. "mapToData": null,
  11376. "validation": null,
  11377. "alias": null,
  11378. "deprecated": null
  11379. },
  11380. {
  11381. "name": "repo",
  11382. "description": "repo parameter",
  11383. "in": "PATH",
  11384. "type": "string",
  11385. "required": true,
  11386. "enum": null,
  11387. "allowNull": false,
  11388. "mapToData": null,
  11389. "validation": null,
  11390. "alias": null,
  11391. "deprecated": null
  11392. },
  11393. {
  11394. "name": "branch",
  11395. "description": "branch parameter",
  11396. "in": "PATH",
  11397. "type": "string",
  11398. "required": true,
  11399. "enum": null,
  11400. "allowNull": false,
  11401. "mapToData": null,
  11402. "validation": null,
  11403. "alias": null,
  11404. "deprecated": null
  11405. }
  11406. ],
  11407. "responses": [
  11408. {
  11409. "code": 200,
  11410. "description": "response",
  11411. "examples": [
  11412. {
  11413. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  11414. }
  11415. ]
  11416. }
  11417. ],
  11418. "renamed": null
  11419. },
  11420. {
  11421. "name": "Get teams with access to protected branch",
  11422. "scope": "repos",
  11423. "id": "listProtectedBranchTeamRestrictions",
  11424. "method": "GET",
  11425. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
  11426. "isDeprecated": false,
  11427. "description": "Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams.",
  11428. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-teams-with-access-to-protected-branch",
  11429. "previews": [],
  11430. "headers": [],
  11431. "parameters": [
  11432. {
  11433. "name": "owner",
  11434. "description": "owner parameter",
  11435. "in": "PATH",
  11436. "type": "string",
  11437. "required": true,
  11438. "enum": null,
  11439. "allowNull": false,
  11440. "mapToData": null,
  11441. "validation": null,
  11442. "alias": null,
  11443. "deprecated": null
  11444. },
  11445. {
  11446. "name": "repo",
  11447. "description": "repo parameter",
  11448. "in": "PATH",
  11449. "type": "string",
  11450. "required": true,
  11451. "enum": null,
  11452. "allowNull": false,
  11453. "mapToData": null,
  11454. "validation": null,
  11455. "alias": null,
  11456. "deprecated": null
  11457. },
  11458. {
  11459. "name": "branch",
  11460. "description": "branch parameter",
  11461. "in": "PATH",
  11462. "type": "string",
  11463. "required": true,
  11464. "enum": null,
  11465. "allowNull": false,
  11466. "mapToData": null,
  11467. "validation": null,
  11468. "alias": null,
  11469. "deprecated": null
  11470. }
  11471. ],
  11472. "responses": [
  11473. {
  11474. "code": 200,
  11475. "description": "response",
  11476. "examples": [
  11477. {
  11478. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  11479. }
  11480. ]
  11481. }
  11482. ],
  11483. "renamed": {
  11484. "before": {
  11485. "scope": "repos",
  11486. "id": "listProtectedBranchTeamRestrictions"
  11487. },
  11488. "after": {
  11489. "scope": "repos",
  11490. "id": "getTeamsWithAccessToProtectedBranch"
  11491. },
  11492. "date": "2019-09-09",
  11493. "note": "\"List team restrictions of protected branch\" is now \"Get teams with access to protected branch\""
  11494. }
  11495. },
  11496. {
  11497. "name": "Get teams with access to protected branch",
  11498. "scope": "repos",
  11499. "id": "listTeamsWithAccessToProtectedBranch",
  11500. "method": "GET",
  11501. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
  11502. "isDeprecated": false,
  11503. "description": "Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams.",
  11504. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-teams-with-access-to-protected-branch",
  11505. "previews": [],
  11506. "headers": [],
  11507. "parameters": [
  11508. {
  11509. "name": "owner",
  11510. "description": "owner parameter",
  11511. "in": "PATH",
  11512. "type": "string",
  11513. "required": true,
  11514. "enum": null,
  11515. "allowNull": false,
  11516. "mapToData": null,
  11517. "validation": null,
  11518. "alias": null,
  11519. "deprecated": null
  11520. },
  11521. {
  11522. "name": "repo",
  11523. "description": "repo parameter",
  11524. "in": "PATH",
  11525. "type": "string",
  11526. "required": true,
  11527. "enum": null,
  11528. "allowNull": false,
  11529. "mapToData": null,
  11530. "validation": null,
  11531. "alias": null,
  11532. "deprecated": null
  11533. },
  11534. {
  11535. "name": "branch",
  11536. "description": "branch parameter",
  11537. "in": "PATH",
  11538. "type": "string",
  11539. "required": true,
  11540. "enum": null,
  11541. "allowNull": false,
  11542. "mapToData": null,
  11543. "validation": null,
  11544. "alias": null,
  11545. "deprecated": null
  11546. }
  11547. ],
  11548. "responses": [
  11549. {
  11550. "code": 200,
  11551. "description": "response",
  11552. "examples": [
  11553. {
  11554. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  11555. }
  11556. ]
  11557. }
  11558. ],
  11559. "renamed": {
  11560. "before": {
  11561. "scope": "repos",
  11562. "id": "listTeamsWithAccessToProtectedBranch"
  11563. },
  11564. "after": {
  11565. "scope": "repos",
  11566. "id": "getTeamsWithAccessToProtectedBranch"
  11567. },
  11568. "date": "2019-09-13",
  11569. "note": "\"List teams with access to protected branch\" is now \"Get teams with access to protected branch\""
  11570. }
  11571. },
  11572. {
  11573. "name": "Replace team restrictions of protected branch",
  11574. "scope": "repos",
  11575. "id": "replaceProtectedBranchTeamRestrictions",
  11576. "method": "PUT",
  11577. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
  11578. "isDeprecated": false,
  11579. "description": "Replaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. If you pass the `hellcat-preview` media type, team restrictions include child teams.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users and teams in total is limited to 100 items. |",
  11580. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#replace-team-restrictions-of-protected-branch",
  11581. "previews": [],
  11582. "headers": [],
  11583. "parameters": [
  11584. {
  11585. "name": "owner",
  11586. "description": "owner parameter",
  11587. "in": "PATH",
  11588. "type": "string",
  11589. "required": true,
  11590. "enum": null,
  11591. "allowNull": false,
  11592. "mapToData": null,
  11593. "validation": null,
  11594. "alias": null,
  11595. "deprecated": null
  11596. },
  11597. {
  11598. "name": "repo",
  11599. "description": "repo parameter",
  11600. "in": "PATH",
  11601. "type": "string",
  11602. "required": true,
  11603. "enum": null,
  11604. "allowNull": false,
  11605. "mapToData": null,
  11606. "validation": null,
  11607. "alias": null,
  11608. "deprecated": null
  11609. },
  11610. {
  11611. "name": "branch",
  11612. "description": "branch parameter",
  11613. "in": "PATH",
  11614. "type": "string",
  11615. "required": true,
  11616. "enum": null,
  11617. "allowNull": false,
  11618. "mapToData": null,
  11619. "validation": null,
  11620. "alias": null,
  11621. "deprecated": null
  11622. },
  11623. {
  11624. "name": "teams",
  11625. "description": "teams parameter",
  11626. "in": "BODY",
  11627. "type": "string[]",
  11628. "required": true,
  11629. "enum": null,
  11630. "allowNull": false,
  11631. "mapToData": true,
  11632. "validation": null,
  11633. "alias": null,
  11634. "deprecated": null
  11635. }
  11636. ],
  11637. "responses": [
  11638. {
  11639. "code": 200,
  11640. "description": "response",
  11641. "examples": [
  11642. {
  11643. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  11644. }
  11645. ]
  11646. }
  11647. ],
  11648. "renamed": null
  11649. },
  11650. {
  11651. "name": "Add team restrictions of protected branch",
  11652. "scope": "repos",
  11653. "id": "addProtectedBranchTeamRestrictions",
  11654. "method": "POST",
  11655. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
  11656. "isDeprecated": false,
  11657. "description": "Grants the specified teams push access for this branch. If you pass the `hellcat-preview` media type, you can also give push access to child teams.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users and teams in total is limited to 100 items. |",
  11658. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#add-team-restrictions-of-protected-branch",
  11659. "previews": [],
  11660. "headers": [],
  11661. "parameters": [
  11662. {
  11663. "name": "owner",
  11664. "description": "owner parameter",
  11665. "in": "PATH",
  11666. "type": "string",
  11667. "required": true,
  11668. "enum": null,
  11669. "allowNull": false,
  11670. "mapToData": null,
  11671. "validation": null,
  11672. "alias": null,
  11673. "deprecated": null
  11674. },
  11675. {
  11676. "name": "repo",
  11677. "description": "repo parameter",
  11678. "in": "PATH",
  11679. "type": "string",
  11680. "required": true,
  11681. "enum": null,
  11682. "allowNull": false,
  11683. "mapToData": null,
  11684. "validation": null,
  11685. "alias": null,
  11686. "deprecated": null
  11687. },
  11688. {
  11689. "name": "branch",
  11690. "description": "branch parameter",
  11691. "in": "PATH",
  11692. "type": "string",
  11693. "required": true,
  11694. "enum": null,
  11695. "allowNull": false,
  11696. "mapToData": null,
  11697. "validation": null,
  11698. "alias": null,
  11699. "deprecated": null
  11700. },
  11701. {
  11702. "name": "teams",
  11703. "description": "teams parameter",
  11704. "in": "BODY",
  11705. "type": "string[]",
  11706. "required": true,
  11707. "enum": null,
  11708. "allowNull": false,
  11709. "mapToData": true,
  11710. "validation": null,
  11711. "alias": null,
  11712. "deprecated": null
  11713. }
  11714. ],
  11715. "responses": [
  11716. {
  11717. "code": 200,
  11718. "description": "response",
  11719. "examples": [
  11720. {
  11721. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  11722. }
  11723. ]
  11724. }
  11725. ],
  11726. "renamed": null
  11727. },
  11728. {
  11729. "name": "Remove team restrictions of protected branch",
  11730. "scope": "repos",
  11731. "id": "removeProtectedBranchTeamRestrictions",
  11732. "method": "DELETE",
  11733. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams",
  11734. "isDeprecated": false,
  11735. "description": "Removes the ability of a team to push to this branch. If you pass the `hellcat-preview` media type, you can also remove push access for child teams.\n\n| Type | Description |\n| ------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users and teams in total is limited to 100 items. |",
  11736. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-team-restrictions-of-protected-branch",
  11737. "previews": [],
  11738. "headers": [],
  11739. "parameters": [
  11740. {
  11741. "name": "owner",
  11742. "description": "owner parameter",
  11743. "in": "PATH",
  11744. "type": "string",
  11745. "required": true,
  11746. "enum": null,
  11747. "allowNull": false,
  11748. "mapToData": null,
  11749. "validation": null,
  11750. "alias": null,
  11751. "deprecated": null
  11752. },
  11753. {
  11754. "name": "repo",
  11755. "description": "repo parameter",
  11756. "in": "PATH",
  11757. "type": "string",
  11758. "required": true,
  11759. "enum": null,
  11760. "allowNull": false,
  11761. "mapToData": null,
  11762. "validation": null,
  11763. "alias": null,
  11764. "deprecated": null
  11765. },
  11766. {
  11767. "name": "branch",
  11768. "description": "branch parameter",
  11769. "in": "PATH",
  11770. "type": "string",
  11771. "required": true,
  11772. "enum": null,
  11773. "allowNull": false,
  11774. "mapToData": null,
  11775. "validation": null,
  11776. "alias": null,
  11777. "deprecated": null
  11778. },
  11779. {
  11780. "name": "teams",
  11781. "description": "teams parameter",
  11782. "in": "BODY",
  11783. "type": "string[]",
  11784. "required": true,
  11785. "enum": null,
  11786. "allowNull": false,
  11787. "mapToData": true,
  11788. "validation": null,
  11789. "alias": null,
  11790. "deprecated": null
  11791. }
  11792. ],
  11793. "responses": [
  11794. {
  11795. "code": 200,
  11796. "description": "response",
  11797. "examples": [
  11798. {
  11799. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  11800. }
  11801. ]
  11802. }
  11803. ],
  11804. "renamed": null
  11805. },
  11806. {
  11807. "name": "Get users with access to protected branch",
  11808. "scope": "repos",
  11809. "id": "getUsersWithAccessToProtectedBranch",
  11810. "method": "GET",
  11811. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
  11812. "isDeprecated": false,
  11813. "description": "Lists the people who have push access to this branch.",
  11814. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-users-with-access-to-protected-branch",
  11815. "previews": [],
  11816. "headers": [],
  11817. "parameters": [
  11818. {
  11819. "name": "owner",
  11820. "description": "owner parameter",
  11821. "in": "PATH",
  11822. "type": "string",
  11823. "required": true,
  11824. "enum": null,
  11825. "allowNull": false,
  11826. "mapToData": null,
  11827. "validation": null,
  11828. "alias": null,
  11829. "deprecated": null
  11830. },
  11831. {
  11832. "name": "repo",
  11833. "description": "repo parameter",
  11834. "in": "PATH",
  11835. "type": "string",
  11836. "required": true,
  11837. "enum": null,
  11838. "allowNull": false,
  11839. "mapToData": null,
  11840. "validation": null,
  11841. "alias": null,
  11842. "deprecated": null
  11843. },
  11844. {
  11845. "name": "branch",
  11846. "description": "branch parameter",
  11847. "in": "PATH",
  11848. "type": "string",
  11849. "required": true,
  11850. "enum": null,
  11851. "allowNull": false,
  11852. "mapToData": null,
  11853. "validation": null,
  11854. "alias": null,
  11855. "deprecated": null
  11856. }
  11857. ],
  11858. "responses": [
  11859. {
  11860. "code": 200,
  11861. "description": "response",
  11862. "examples": [
  11863. {
  11864. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  11865. }
  11866. ]
  11867. }
  11868. ],
  11869. "renamed": null
  11870. },
  11871. {
  11872. "name": "Get users with access to protected branch",
  11873. "scope": "repos",
  11874. "id": "listProtectedBranchUserRestrictions",
  11875. "method": "GET",
  11876. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
  11877. "isDeprecated": false,
  11878. "description": "Lists the people who have push access to this branch.",
  11879. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-users-with-access-to-protected-branch",
  11880. "previews": [],
  11881. "headers": [],
  11882. "parameters": [
  11883. {
  11884. "name": "owner",
  11885. "description": "owner parameter",
  11886. "in": "PATH",
  11887. "type": "string",
  11888. "required": true,
  11889. "enum": null,
  11890. "allowNull": false,
  11891. "mapToData": null,
  11892. "validation": null,
  11893. "alias": null,
  11894. "deprecated": null
  11895. },
  11896. {
  11897. "name": "repo",
  11898. "description": "repo parameter",
  11899. "in": "PATH",
  11900. "type": "string",
  11901. "required": true,
  11902. "enum": null,
  11903. "allowNull": false,
  11904. "mapToData": null,
  11905. "validation": null,
  11906. "alias": null,
  11907. "deprecated": null
  11908. },
  11909. {
  11910. "name": "branch",
  11911. "description": "branch parameter",
  11912. "in": "PATH",
  11913. "type": "string",
  11914. "required": true,
  11915. "enum": null,
  11916. "allowNull": false,
  11917. "mapToData": null,
  11918. "validation": null,
  11919. "alias": null,
  11920. "deprecated": null
  11921. }
  11922. ],
  11923. "responses": [
  11924. {
  11925. "code": 200,
  11926. "description": "response",
  11927. "examples": [
  11928. {
  11929. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  11930. }
  11931. ]
  11932. }
  11933. ],
  11934. "renamed": {
  11935. "before": {
  11936. "scope": "repos",
  11937. "id": "listProtectedBranchUserRestrictions"
  11938. },
  11939. "after": {
  11940. "scope": "repos",
  11941. "id": "getUsersWithAccessToProtectedBranch"
  11942. },
  11943. "date": "2019-09-09",
  11944. "note": "\"List user restrictions of protected branch\" is now \"Get users with access to protected branch\""
  11945. }
  11946. },
  11947. {
  11948. "name": "Get users with access to protected branch",
  11949. "scope": "repos",
  11950. "id": "listUsersWithAccessToProtectedBranch",
  11951. "method": "GET",
  11952. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
  11953. "isDeprecated": false,
  11954. "description": "Lists the people who have push access to this branch.",
  11955. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#list-users-with-access-to-protected-branch",
  11956. "previews": [],
  11957. "headers": [],
  11958. "parameters": [
  11959. {
  11960. "name": "owner",
  11961. "description": "owner parameter",
  11962. "in": "PATH",
  11963. "type": "string",
  11964. "required": true,
  11965. "enum": null,
  11966. "allowNull": false,
  11967. "mapToData": null,
  11968. "validation": null,
  11969. "alias": null,
  11970. "deprecated": null
  11971. },
  11972. {
  11973. "name": "repo",
  11974. "description": "repo parameter",
  11975. "in": "PATH",
  11976. "type": "string",
  11977. "required": true,
  11978. "enum": null,
  11979. "allowNull": false,
  11980. "mapToData": null,
  11981. "validation": null,
  11982. "alias": null,
  11983. "deprecated": null
  11984. },
  11985. {
  11986. "name": "branch",
  11987. "description": "branch parameter",
  11988. "in": "PATH",
  11989. "type": "string",
  11990. "required": true,
  11991. "enum": null,
  11992. "allowNull": false,
  11993. "mapToData": null,
  11994. "validation": null,
  11995. "alias": null,
  11996. "deprecated": null
  11997. }
  11998. ],
  11999. "responses": [
  12000. {
  12001. "code": 200,
  12002. "description": "response",
  12003. "examples": [
  12004. {
  12005. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  12006. }
  12007. ]
  12008. }
  12009. ],
  12010. "renamed": {
  12011. "before": {
  12012. "scope": "repos",
  12013. "id": "listUsersWithAccessToProtectedBranch"
  12014. },
  12015. "after": {
  12016. "scope": "repos",
  12017. "id": "getUsersWithAccessToProtectedBranch"
  12018. },
  12019. "date": "2019-09-13",
  12020. "note": "\"List users with access to protected branch\" is now \"Get users with access to protected branch\""
  12021. }
  12022. },
  12023. {
  12024. "name": "Replace user restrictions of protected branch",
  12025. "scope": "repos",
  12026. "id": "replaceProtectedBranchUserRestrictions",
  12027. "method": "PUT",
  12028. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
  12029. "isDeprecated": false,
  12030. "description": "Replaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users and teams in total is limited to 100 items. |",
  12031. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#replace-user-restrictions-of-protected-branch",
  12032. "previews": [],
  12033. "headers": [],
  12034. "parameters": [
  12035. {
  12036. "name": "owner",
  12037. "description": "owner parameter",
  12038. "in": "PATH",
  12039. "type": "string",
  12040. "required": true,
  12041. "enum": null,
  12042. "allowNull": false,
  12043. "mapToData": null,
  12044. "validation": null,
  12045. "alias": null,
  12046. "deprecated": null
  12047. },
  12048. {
  12049. "name": "repo",
  12050. "description": "repo parameter",
  12051. "in": "PATH",
  12052. "type": "string",
  12053. "required": true,
  12054. "enum": null,
  12055. "allowNull": false,
  12056. "mapToData": null,
  12057. "validation": null,
  12058. "alias": null,
  12059. "deprecated": null
  12060. },
  12061. {
  12062. "name": "branch",
  12063. "description": "branch parameter",
  12064. "in": "PATH",
  12065. "type": "string",
  12066. "required": true,
  12067. "enum": null,
  12068. "allowNull": false,
  12069. "mapToData": null,
  12070. "validation": null,
  12071. "alias": null,
  12072. "deprecated": null
  12073. },
  12074. {
  12075. "name": "users",
  12076. "description": "users parameter",
  12077. "in": "BODY",
  12078. "type": "string[]",
  12079. "required": true,
  12080. "enum": null,
  12081. "allowNull": false,
  12082. "mapToData": true,
  12083. "validation": null,
  12084. "alias": null,
  12085. "deprecated": null
  12086. }
  12087. ],
  12088. "responses": [
  12089. {
  12090. "code": 200,
  12091. "description": "response",
  12092. "examples": [
  12093. {
  12094. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  12095. }
  12096. ]
  12097. }
  12098. ],
  12099. "renamed": null
  12100. },
  12101. {
  12102. "name": "Add user restrictions of protected branch",
  12103. "scope": "repos",
  12104. "id": "addProtectedBranchUserRestrictions",
  12105. "method": "POST",
  12106. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
  12107. "isDeprecated": false,
  12108. "description": "Grants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users and teams in total is limited to 100 items. |",
  12109. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#add-user-restrictions-of-protected-branch",
  12110. "previews": [],
  12111. "headers": [],
  12112. "parameters": [
  12113. {
  12114. "name": "owner",
  12115. "description": "owner parameter",
  12116. "in": "PATH",
  12117. "type": "string",
  12118. "required": true,
  12119. "enum": null,
  12120. "allowNull": false,
  12121. "mapToData": null,
  12122. "validation": null,
  12123. "alias": null,
  12124. "deprecated": null
  12125. },
  12126. {
  12127. "name": "repo",
  12128. "description": "repo parameter",
  12129. "in": "PATH",
  12130. "type": "string",
  12131. "required": true,
  12132. "enum": null,
  12133. "allowNull": false,
  12134. "mapToData": null,
  12135. "validation": null,
  12136. "alias": null,
  12137. "deprecated": null
  12138. },
  12139. {
  12140. "name": "branch",
  12141. "description": "branch parameter",
  12142. "in": "PATH",
  12143. "type": "string",
  12144. "required": true,
  12145. "enum": null,
  12146. "allowNull": false,
  12147. "mapToData": null,
  12148. "validation": null,
  12149. "alias": null,
  12150. "deprecated": null
  12151. },
  12152. {
  12153. "name": "users",
  12154. "description": "users parameter",
  12155. "in": "BODY",
  12156. "type": "string[]",
  12157. "required": true,
  12158. "enum": null,
  12159. "allowNull": false,
  12160. "mapToData": true,
  12161. "validation": null,
  12162. "alias": null,
  12163. "deprecated": null
  12164. }
  12165. ],
  12166. "responses": [
  12167. {
  12168. "code": 200,
  12169. "description": "response",
  12170. "examples": [
  12171. {
  12172. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  12173. }
  12174. ]
  12175. }
  12176. ],
  12177. "renamed": null
  12178. },
  12179. {
  12180. "name": "Remove user restrictions of protected branch",
  12181. "scope": "repos",
  12182. "id": "removeProtectedBranchUserRestrictions",
  12183. "method": "DELETE",
  12184. "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users",
  12185. "isDeprecated": false,
  12186. "description": "Removes the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | -------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users and teams in total is limited to 100 items. |",
  12187. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/branches/#remove-user-restrictions-of-protected-branch",
  12188. "previews": [],
  12189. "headers": [],
  12190. "parameters": [
  12191. {
  12192. "name": "owner",
  12193. "description": "owner parameter",
  12194. "in": "PATH",
  12195. "type": "string",
  12196. "required": true,
  12197. "enum": null,
  12198. "allowNull": false,
  12199. "mapToData": null,
  12200. "validation": null,
  12201. "alias": null,
  12202. "deprecated": null
  12203. },
  12204. {
  12205. "name": "repo",
  12206. "description": "repo parameter",
  12207. "in": "PATH",
  12208. "type": "string",
  12209. "required": true,
  12210. "enum": null,
  12211. "allowNull": false,
  12212. "mapToData": null,
  12213. "validation": null,
  12214. "alias": null,
  12215. "deprecated": null
  12216. },
  12217. {
  12218. "name": "branch",
  12219. "description": "branch parameter",
  12220. "in": "PATH",
  12221. "type": "string",
  12222. "required": true,
  12223. "enum": null,
  12224. "allowNull": false,
  12225. "mapToData": null,
  12226. "validation": null,
  12227. "alias": null,
  12228. "deprecated": null
  12229. },
  12230. {
  12231. "name": "users",
  12232. "description": "users parameter",
  12233. "in": "BODY",
  12234. "type": "string[]",
  12235. "required": true,
  12236. "enum": null,
  12237. "allowNull": false,
  12238. "mapToData": true,
  12239. "validation": null,
  12240. "alias": null,
  12241. "deprecated": null
  12242. }
  12243. ],
  12244. "responses": [
  12245. {
  12246. "code": 200,
  12247. "description": "response",
  12248. "examples": [
  12249. {
  12250. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  12251. }
  12252. ]
  12253. }
  12254. ],
  12255. "renamed": null
  12256. },
  12257. {
  12258. "name": "Create a check run",
  12259. "scope": "checks",
  12260. "id": "create",
  12261. "method": "POST",
  12262. "url": "/repos/{owner}/{repo}/check-runs",
  12263. "isDeprecated": false,
  12264. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.",
  12265. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/runs/#create-a-check-run",
  12266. "previews": [{ "name": "antiope" }],
  12267. "headers": [
  12268. {
  12269. "name": "accept",
  12270. "value": "application/vnd.github.antiope-preview+json"
  12271. }
  12272. ],
  12273. "parameters": [
  12274. {
  12275. "name": "owner",
  12276. "description": "owner parameter",
  12277. "in": "PATH",
  12278. "type": "string",
  12279. "required": true,
  12280. "enum": null,
  12281. "allowNull": false,
  12282. "mapToData": null,
  12283. "validation": null,
  12284. "alias": null,
  12285. "deprecated": null
  12286. },
  12287. {
  12288. "name": "repo",
  12289. "description": "repo parameter",
  12290. "in": "PATH",
  12291. "type": "string",
  12292. "required": true,
  12293. "enum": null,
  12294. "allowNull": false,
  12295. "mapToData": null,
  12296. "validation": null,
  12297. "alias": null,
  12298. "deprecated": null
  12299. },
  12300. {
  12301. "name": "name",
  12302. "description": "The name of the check. For example, \"code-coverage\".",
  12303. "in": "BODY",
  12304. "type": "string",
  12305. "required": true,
  12306. "enum": null,
  12307. "allowNull": false,
  12308. "mapToData": null,
  12309. "validation": null,
  12310. "alias": null,
  12311. "deprecated": null
  12312. },
  12313. {
  12314. "name": "head_sha",
  12315. "description": "The SHA of the commit.",
  12316. "in": "BODY",
  12317. "type": "string",
  12318. "required": true,
  12319. "enum": null,
  12320. "allowNull": false,
  12321. "mapToData": null,
  12322. "validation": null,
  12323. "alias": null,
  12324. "deprecated": null
  12325. },
  12326. {
  12327. "name": "details_url",
  12328. "description": "The URL of the integrator's site that has the full details of the check.",
  12329. "in": "BODY",
  12330. "type": "string",
  12331. "required": false,
  12332. "enum": null,
  12333. "allowNull": false,
  12334. "mapToData": null,
  12335. "validation": null,
  12336. "alias": null,
  12337. "deprecated": null
  12338. },
  12339. {
  12340. "name": "external_id",
  12341. "description": "A reference for the run on the integrator's system.",
  12342. "in": "BODY",
  12343. "type": "string",
  12344. "required": false,
  12345. "enum": null,
  12346. "allowNull": false,
  12347. "mapToData": null,
  12348. "validation": null,
  12349. "alias": null,
  12350. "deprecated": null
  12351. },
  12352. {
  12353. "name": "status",
  12354. "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
  12355. "in": "BODY",
  12356. "type": "string",
  12357. "required": false,
  12358. "enum": ["queued", "in_progress", "completed"],
  12359. "allowNull": false,
  12360. "mapToData": null,
  12361. "validation": null,
  12362. "alias": null,
  12363. "deprecated": null
  12364. },
  12365. {
  12366. "name": "started_at",
  12367. "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  12368. "in": "BODY",
  12369. "type": "string",
  12370. "required": false,
  12371. "enum": null,
  12372. "allowNull": false,
  12373. "mapToData": null,
  12374. "validation": null,
  12375. "alias": null,
  12376. "deprecated": null
  12377. },
  12378. {
  12379. "name": "conclusion",
  12380. "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.",
  12381. "in": "BODY",
  12382. "type": "string",
  12383. "required": false,
  12384. "enum": [
  12385. "success",
  12386. "failure",
  12387. "neutral",
  12388. "cancelled",
  12389. "timed_out",
  12390. "action_required"
  12391. ],
  12392. "allowNull": false,
  12393. "mapToData": null,
  12394. "validation": null,
  12395. "alias": null,
  12396. "deprecated": null
  12397. },
  12398. {
  12399. "name": "completed_at",
  12400. "description": "**Required if you provide `conclusion`**. The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  12401. "in": "BODY",
  12402. "type": "string",
  12403. "required": false,
  12404. "enum": null,
  12405. "allowNull": false,
  12406. "mapToData": null,
  12407. "validation": null,
  12408. "alias": null,
  12409. "deprecated": null
  12410. },
  12411. {
  12412. "name": "output",
  12413. "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#output-object) description.",
  12414. "in": "BODY",
  12415. "type": "object",
  12416. "required": false,
  12417. "enum": null,
  12418. "allowNull": false,
  12419. "mapToData": null,
  12420. "validation": null,
  12421. "alias": null,
  12422. "deprecated": null
  12423. },
  12424. {
  12425. "name": "output.title",
  12426. "description": "The title of the check run.",
  12427. "in": "BODY",
  12428. "type": "string",
  12429. "required": true,
  12430. "enum": null,
  12431. "allowNull": false,
  12432. "mapToData": null,
  12433. "validation": null,
  12434. "alias": null,
  12435. "deprecated": null
  12436. },
  12437. {
  12438. "name": "output.summary",
  12439. "description": "The summary of the check run. This parameter supports Markdown.",
  12440. "in": "BODY",
  12441. "type": "string",
  12442. "required": true,
  12443. "enum": null,
  12444. "allowNull": false,
  12445. "mapToData": null,
  12446. "validation": null,
  12447. "alias": null,
  12448. "deprecated": null
  12449. },
  12450. {
  12451. "name": "output.text",
  12452. "description": "The details of the check run. This parameter supports Markdown.",
  12453. "in": "BODY",
  12454. "type": "string",
  12455. "required": false,
  12456. "enum": null,
  12457. "allowNull": false,
  12458. "mapToData": null,
  12459. "validation": null,
  12460. "alias": null,
  12461. "deprecated": null
  12462. },
  12463. {
  12464. "name": "output.annotations",
  12465. "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/enterprise/2.17/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#annotations-object) description for details about how to use this parameter.",
  12466. "in": "BODY",
  12467. "type": "object[]",
  12468. "required": false,
  12469. "enum": null,
  12470. "allowNull": false,
  12471. "mapToData": null,
  12472. "validation": null,
  12473. "alias": null,
  12474. "deprecated": null
  12475. },
  12476. {
  12477. "name": "output.annotations[].path",
  12478. "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
  12479. "in": "BODY",
  12480. "type": "string",
  12481. "required": true,
  12482. "enum": null,
  12483. "allowNull": false,
  12484. "mapToData": null,
  12485. "validation": null,
  12486. "alias": null,
  12487. "deprecated": null
  12488. },
  12489. {
  12490. "name": "output.annotations[].start_line",
  12491. "description": "The start line of the annotation.",
  12492. "in": "BODY",
  12493. "type": "integer",
  12494. "required": true,
  12495. "enum": null,
  12496. "allowNull": false,
  12497. "mapToData": null,
  12498. "validation": null,
  12499. "alias": null,
  12500. "deprecated": null
  12501. },
  12502. {
  12503. "name": "output.annotations[].end_line",
  12504. "description": "The end line of the annotation.",
  12505. "in": "BODY",
  12506. "type": "integer",
  12507. "required": true,
  12508. "enum": null,
  12509. "allowNull": false,
  12510. "mapToData": null,
  12511. "validation": null,
  12512. "alias": null,
  12513. "deprecated": null
  12514. },
  12515. {
  12516. "name": "output.annotations[].start_column",
  12517. "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.",
  12518. "in": "BODY",
  12519. "type": "integer",
  12520. "required": false,
  12521. "enum": null,
  12522. "allowNull": false,
  12523. "mapToData": null,
  12524. "validation": null,
  12525. "alias": null,
  12526. "deprecated": null
  12527. },
  12528. {
  12529. "name": "output.annotations[].end_column",
  12530. "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.",
  12531. "in": "BODY",
  12532. "type": "integer",
  12533. "required": false,
  12534. "enum": null,
  12535. "allowNull": false,
  12536. "mapToData": null,
  12537. "validation": null,
  12538. "alias": null,
  12539. "deprecated": null
  12540. },
  12541. {
  12542. "name": "output.annotations[].annotation_level",
  12543. "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
  12544. "in": "BODY",
  12545. "type": "string",
  12546. "required": true,
  12547. "enum": ["notice", "warning", "failure"],
  12548. "allowNull": false,
  12549. "mapToData": null,
  12550. "validation": null,
  12551. "alias": null,
  12552. "deprecated": null
  12553. },
  12554. {
  12555. "name": "output.annotations[].message",
  12556. "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
  12557. "in": "BODY",
  12558. "type": "string",
  12559. "required": true,
  12560. "enum": null,
  12561. "allowNull": false,
  12562. "mapToData": null,
  12563. "validation": null,
  12564. "alias": null,
  12565. "deprecated": null
  12566. },
  12567. {
  12568. "name": "output.annotations[].title",
  12569. "description": "The title that represents the annotation. The maximum size is 255 characters.",
  12570. "in": "BODY",
  12571. "type": "string",
  12572. "required": false,
  12573. "enum": null,
  12574. "allowNull": false,
  12575. "mapToData": null,
  12576. "validation": null,
  12577. "alias": null,
  12578. "deprecated": null
  12579. },
  12580. {
  12581. "name": "output.annotations[].raw_details",
  12582. "description": "Details about this annotation. The maximum size is 64 KB.",
  12583. "in": "BODY",
  12584. "type": "string",
  12585. "required": false,
  12586. "enum": null,
  12587. "allowNull": false,
  12588. "mapToData": null,
  12589. "validation": null,
  12590. "alias": null,
  12591. "deprecated": null
  12592. },
  12593. {
  12594. "name": "output.images",
  12595. "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#images-object) description for details.",
  12596. "in": "BODY",
  12597. "type": "object[]",
  12598. "required": false,
  12599. "enum": null,
  12600. "allowNull": false,
  12601. "mapToData": null,
  12602. "validation": null,
  12603. "alias": null,
  12604. "deprecated": null
  12605. },
  12606. {
  12607. "name": "output.images[].alt",
  12608. "description": "The alternative text for the image.",
  12609. "in": "BODY",
  12610. "type": "string",
  12611. "required": true,
  12612. "enum": null,
  12613. "allowNull": false,
  12614. "mapToData": null,
  12615. "validation": null,
  12616. "alias": null,
  12617. "deprecated": null
  12618. },
  12619. {
  12620. "name": "output.images[].image_url",
  12621. "description": "The full URL of the image.",
  12622. "in": "BODY",
  12623. "type": "string",
  12624. "required": true,
  12625. "enum": null,
  12626. "allowNull": false,
  12627. "mapToData": null,
  12628. "validation": null,
  12629. "alias": null,
  12630. "deprecated": null
  12631. },
  12632. {
  12633. "name": "output.images[].caption",
  12634. "description": "A short image description.",
  12635. "in": "BODY",
  12636. "type": "string",
  12637. "required": false,
  12638. "enum": null,
  12639. "allowNull": false,
  12640. "mapToData": null,
  12641. "validation": null,
  12642. "alias": null,
  12643. "deprecated": null
  12644. },
  12645. {
  12646. "name": "actions",
  12647. "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/enterprise/2.17/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\"",
  12648. "in": "BODY",
  12649. "type": "object[]",
  12650. "required": false,
  12651. "enum": null,
  12652. "allowNull": false,
  12653. "mapToData": null,
  12654. "validation": null,
  12655. "alias": null,
  12656. "deprecated": null
  12657. },
  12658. {
  12659. "name": "actions[].label",
  12660. "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
  12661. "in": "BODY",
  12662. "type": "string",
  12663. "required": true,
  12664. "enum": null,
  12665. "allowNull": false,
  12666. "mapToData": null,
  12667. "validation": null,
  12668. "alias": null,
  12669. "deprecated": null
  12670. },
  12671. {
  12672. "name": "actions[].description",
  12673. "description": "A short explanation of what this action would do. The maximum size is 40 characters.",
  12674. "in": "BODY",
  12675. "type": "string",
  12676. "required": true,
  12677. "enum": null,
  12678. "allowNull": false,
  12679. "mapToData": null,
  12680. "validation": null,
  12681. "alias": null,
  12682. "deprecated": null
  12683. },
  12684. {
  12685. "name": "actions[].identifier",
  12686. "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
  12687. "in": "BODY",
  12688. "type": "string",
  12689. "required": true,
  12690. "enum": null,
  12691. "allowNull": false,
  12692. "mapToData": null,
  12693. "validation": null,
  12694. "alias": null,
  12695. "deprecated": null
  12696. }
  12697. ],
  12698. "responses": [
  12699. {
  12700. "code": 201,
  12701. "description": "response",
  12702. "examples": [
  12703. {
  12704. "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"in_progress\",\"conclusion\":null,\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":null,\"output\":{\"title\":\"Mighty Readme Report\",\"summary\":\"\",\"text\":\"\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}"
  12705. },
  12706. {
  12707. "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}"
  12708. }
  12709. ]
  12710. }
  12711. ],
  12712. "renamed": null
  12713. },
  12714. {
  12715. "name": "Update a check run",
  12716. "scope": "checks",
  12717. "id": "update",
  12718. "method": "PATCH",
  12719. "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}",
  12720. "isDeprecated": false,
  12721. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.",
  12722. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/runs/#update-a-check-run",
  12723. "previews": [{ "name": "antiope" }],
  12724. "headers": [
  12725. {
  12726. "name": "accept",
  12727. "value": "application/vnd.github.antiope-preview+json"
  12728. }
  12729. ],
  12730. "parameters": [
  12731. {
  12732. "name": "owner",
  12733. "description": "owner parameter",
  12734. "in": "PATH",
  12735. "type": "string",
  12736. "required": true,
  12737. "enum": null,
  12738. "allowNull": false,
  12739. "mapToData": null,
  12740. "validation": null,
  12741. "alias": null,
  12742. "deprecated": null
  12743. },
  12744. {
  12745. "name": "repo",
  12746. "description": "repo parameter",
  12747. "in": "PATH",
  12748. "type": "string",
  12749. "required": true,
  12750. "enum": null,
  12751. "allowNull": false,
  12752. "mapToData": null,
  12753. "validation": null,
  12754. "alias": null,
  12755. "deprecated": null
  12756. },
  12757. {
  12758. "name": "check_run_id",
  12759. "description": "check_run_id parameter",
  12760. "in": "PATH",
  12761. "type": "integer",
  12762. "required": true,
  12763. "enum": null,
  12764. "allowNull": false,
  12765. "mapToData": null,
  12766. "validation": null,
  12767. "alias": null,
  12768. "deprecated": null
  12769. },
  12770. {
  12771. "name": "name",
  12772. "description": "The name of the check. For example, \"code-coverage\".",
  12773. "in": "BODY",
  12774. "type": "string",
  12775. "required": false,
  12776. "enum": null,
  12777. "allowNull": false,
  12778. "mapToData": null,
  12779. "validation": null,
  12780. "alias": null,
  12781. "deprecated": null
  12782. },
  12783. {
  12784. "name": "details_url",
  12785. "description": "The URL of the integrator's site that has the full details of the check.",
  12786. "in": "BODY",
  12787. "type": "string",
  12788. "required": false,
  12789. "enum": null,
  12790. "allowNull": false,
  12791. "mapToData": null,
  12792. "validation": null,
  12793. "alias": null,
  12794. "deprecated": null
  12795. },
  12796. {
  12797. "name": "external_id",
  12798. "description": "A reference for the run on the integrator's system.",
  12799. "in": "BODY",
  12800. "type": "string",
  12801. "required": false,
  12802. "enum": null,
  12803. "allowNull": false,
  12804. "mapToData": null,
  12805. "validation": null,
  12806. "alias": null,
  12807. "deprecated": null
  12808. },
  12809. {
  12810. "name": "started_at",
  12811. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  12812. "in": "BODY",
  12813. "type": "string",
  12814. "required": false,
  12815. "enum": null,
  12816. "allowNull": false,
  12817. "mapToData": null,
  12818. "validation": null,
  12819. "alias": null,
  12820. "deprecated": null
  12821. },
  12822. {
  12823. "name": "status",
  12824. "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.",
  12825. "in": "BODY",
  12826. "type": "string",
  12827. "required": false,
  12828. "enum": ["queued", "in_progress", "completed"],
  12829. "allowNull": false,
  12830. "mapToData": null,
  12831. "validation": null,
  12832. "alias": null,
  12833. "deprecated": null
  12834. },
  12835. {
  12836. "name": "conclusion",
  12837. "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.",
  12838. "in": "BODY",
  12839. "type": "string",
  12840. "required": false,
  12841. "enum": [
  12842. "success",
  12843. "failure",
  12844. "neutral",
  12845. "cancelled",
  12846. "timed_out",
  12847. "action_required"
  12848. ],
  12849. "allowNull": false,
  12850. "mapToData": null,
  12851. "validation": null,
  12852. "alias": null,
  12853. "deprecated": null
  12854. },
  12855. {
  12856. "name": "completed_at",
  12857. "description": "**Required if you provide `conclusion`**. The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  12858. "in": "BODY",
  12859. "type": "string",
  12860. "required": false,
  12861. "enum": null,
  12862. "allowNull": false,
  12863. "mapToData": null,
  12864. "validation": null,
  12865. "alias": null,
  12866. "deprecated": null
  12867. },
  12868. {
  12869. "name": "output",
  12870. "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#output-object-1) description.",
  12871. "in": "BODY",
  12872. "type": "object",
  12873. "required": false,
  12874. "enum": null,
  12875. "allowNull": false,
  12876. "mapToData": null,
  12877. "validation": null,
  12878. "alias": null,
  12879. "deprecated": null
  12880. },
  12881. {
  12882. "name": "output.title",
  12883. "description": "**Required**.",
  12884. "in": "BODY",
  12885. "type": "string",
  12886. "required": false,
  12887. "enum": null,
  12888. "allowNull": false,
  12889. "mapToData": null,
  12890. "validation": null,
  12891. "alias": null,
  12892. "deprecated": null
  12893. },
  12894. {
  12895. "name": "output.summary",
  12896. "description": "Can contain Markdown.",
  12897. "in": "BODY",
  12898. "type": "string",
  12899. "required": true,
  12900. "enum": null,
  12901. "allowNull": false,
  12902. "mapToData": null,
  12903. "validation": null,
  12904. "alias": null,
  12905. "deprecated": null
  12906. },
  12907. {
  12908. "name": "output.text",
  12909. "description": "Can contain Markdown.",
  12910. "in": "BODY",
  12911. "type": "string",
  12912. "required": false,
  12913. "enum": null,
  12914. "allowNull": false,
  12915. "mapToData": null,
  12916. "validation": null,
  12917. "alias": null,
  12918. "deprecated": null
  12919. },
  12920. {
  12921. "name": "output.annotations",
  12922. "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/enterprise/2.17/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#annotations-object-1) description for details.",
  12923. "in": "BODY",
  12924. "type": "object[]",
  12925. "required": false,
  12926. "enum": null,
  12927. "allowNull": false,
  12928. "mapToData": null,
  12929. "validation": null,
  12930. "alias": null,
  12931. "deprecated": null
  12932. },
  12933. {
  12934. "name": "output.annotations[].path",
  12935. "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.",
  12936. "in": "BODY",
  12937. "type": "string",
  12938. "required": true,
  12939. "enum": null,
  12940. "allowNull": false,
  12941. "mapToData": null,
  12942. "validation": null,
  12943. "alias": null,
  12944. "deprecated": null
  12945. },
  12946. {
  12947. "name": "output.annotations[].start_line",
  12948. "description": "The start line of the annotation.",
  12949. "in": "BODY",
  12950. "type": "integer",
  12951. "required": true,
  12952. "enum": null,
  12953. "allowNull": false,
  12954. "mapToData": null,
  12955. "validation": null,
  12956. "alias": null,
  12957. "deprecated": null
  12958. },
  12959. {
  12960. "name": "output.annotations[].end_line",
  12961. "description": "The end line of the annotation.",
  12962. "in": "BODY",
  12963. "type": "integer",
  12964. "required": true,
  12965. "enum": null,
  12966. "allowNull": false,
  12967. "mapToData": null,
  12968. "validation": null,
  12969. "alias": null,
  12970. "deprecated": null
  12971. },
  12972. {
  12973. "name": "output.annotations[].start_column",
  12974. "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.",
  12975. "in": "BODY",
  12976. "type": "integer",
  12977. "required": false,
  12978. "enum": null,
  12979. "allowNull": false,
  12980. "mapToData": null,
  12981. "validation": null,
  12982. "alias": null,
  12983. "deprecated": null
  12984. },
  12985. {
  12986. "name": "output.annotations[].end_column",
  12987. "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.",
  12988. "in": "BODY",
  12989. "type": "integer",
  12990. "required": false,
  12991. "enum": null,
  12992. "allowNull": false,
  12993. "mapToData": null,
  12994. "validation": null,
  12995. "alias": null,
  12996. "deprecated": null
  12997. },
  12998. {
  12999. "name": "output.annotations[].annotation_level",
  13000. "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.",
  13001. "in": "BODY",
  13002. "type": "string",
  13003. "required": true,
  13004. "enum": ["notice", "warning", "failure"],
  13005. "allowNull": false,
  13006. "mapToData": null,
  13007. "validation": null,
  13008. "alias": null,
  13009. "deprecated": null
  13010. },
  13011. {
  13012. "name": "output.annotations[].message",
  13013. "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.",
  13014. "in": "BODY",
  13015. "type": "string",
  13016. "required": true,
  13017. "enum": null,
  13018. "allowNull": false,
  13019. "mapToData": null,
  13020. "validation": null,
  13021. "alias": null,
  13022. "deprecated": null
  13023. },
  13024. {
  13025. "name": "output.annotations[].title",
  13026. "description": "The title that represents the annotation. The maximum size is 255 characters.",
  13027. "in": "BODY",
  13028. "type": "string",
  13029. "required": false,
  13030. "enum": null,
  13031. "allowNull": false,
  13032. "mapToData": null,
  13033. "validation": null,
  13034. "alias": null,
  13035. "deprecated": null
  13036. },
  13037. {
  13038. "name": "output.annotations[].raw_details",
  13039. "description": "Details about this annotation. The maximum size is 64 KB.",
  13040. "in": "BODY",
  13041. "type": "string",
  13042. "required": false,
  13043. "enum": null,
  13044. "allowNull": false,
  13045. "mapToData": null,
  13046. "validation": null,
  13047. "alias": null,
  13048. "deprecated": null
  13049. },
  13050. {
  13051. "name": "output.images",
  13052. "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#annotations-object-1) description for details.",
  13053. "in": "BODY",
  13054. "type": "object[]",
  13055. "required": false,
  13056. "enum": null,
  13057. "allowNull": false,
  13058. "mapToData": null,
  13059. "validation": null,
  13060. "alias": null,
  13061. "deprecated": null
  13062. },
  13063. {
  13064. "name": "output.images[].alt",
  13065. "description": "The alternative text for the image.",
  13066. "in": "BODY",
  13067. "type": "string",
  13068. "required": true,
  13069. "enum": null,
  13070. "allowNull": false,
  13071. "mapToData": null,
  13072. "validation": null,
  13073. "alias": null,
  13074. "deprecated": null
  13075. },
  13076. {
  13077. "name": "output.images[].image_url",
  13078. "description": "The full URL of the image.",
  13079. "in": "BODY",
  13080. "type": "string",
  13081. "required": true,
  13082. "enum": null,
  13083. "allowNull": false,
  13084. "mapToData": null,
  13085. "validation": null,
  13086. "alias": null,
  13087. "deprecated": null
  13088. },
  13089. {
  13090. "name": "output.images[].caption",
  13091. "description": "A short image description.",
  13092. "in": "BODY",
  13093. "type": "string",
  13094. "required": false,
  13095. "enum": null,
  13096. "allowNull": false,
  13097. "mapToData": null,
  13098. "validation": null,
  13099. "alias": null,
  13100. "deprecated": null
  13101. },
  13102. {
  13103. "name": "actions",
  13104. "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/enterprise/2.17/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/enterprise/2.17/v3/checks/runs/#check-runs-and-requested-actions).\"",
  13105. "in": "BODY",
  13106. "type": "object[]",
  13107. "required": false,
  13108. "enum": null,
  13109. "allowNull": false,
  13110. "mapToData": null,
  13111. "validation": null,
  13112. "alias": null,
  13113. "deprecated": null
  13114. },
  13115. {
  13116. "name": "actions[].label",
  13117. "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.",
  13118. "in": "BODY",
  13119. "type": "string",
  13120. "required": true,
  13121. "enum": null,
  13122. "allowNull": false,
  13123. "mapToData": null,
  13124. "validation": null,
  13125. "alias": null,
  13126. "deprecated": null
  13127. },
  13128. {
  13129. "name": "actions[].description",
  13130. "description": "A short explanation of what this action would do. The maximum size is 40 characters.",
  13131. "in": "BODY",
  13132. "type": "string",
  13133. "required": true,
  13134. "enum": null,
  13135. "allowNull": false,
  13136. "mapToData": null,
  13137. "validation": null,
  13138. "alias": null,
  13139. "deprecated": null
  13140. },
  13141. {
  13142. "name": "actions[].identifier",
  13143. "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.",
  13144. "in": "BODY",
  13145. "type": "string",
  13146. "required": true,
  13147. "enum": null,
  13148. "allowNull": false,
  13149. "mapToData": null,
  13150. "validation": null,
  13151. "alias": null,
  13152. "deprecated": null
  13153. }
  13154. ],
  13155. "responses": [
  13156. {
  13157. "code": 200,
  13158. "description": "response",
  13159. "examples": [
  13160. {
  13161. "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}"
  13162. }
  13163. ]
  13164. }
  13165. ],
  13166. "renamed": null
  13167. },
  13168. {
  13169. "name": "Get a single check run",
  13170. "scope": "checks",
  13171. "id": "get",
  13172. "method": "GET",
  13173. "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}",
  13174. "isDeprecated": false,
  13175. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
  13176. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/runs/#get-a-single-check-run",
  13177. "previews": [{ "name": "antiope" }],
  13178. "headers": [
  13179. {
  13180. "name": "accept",
  13181. "value": "application/vnd.github.antiope-preview+json"
  13182. }
  13183. ],
  13184. "parameters": [
  13185. {
  13186. "name": "owner",
  13187. "description": "owner parameter",
  13188. "in": "PATH",
  13189. "type": "string",
  13190. "required": true,
  13191. "enum": null,
  13192. "allowNull": false,
  13193. "mapToData": null,
  13194. "validation": null,
  13195. "alias": null,
  13196. "deprecated": null
  13197. },
  13198. {
  13199. "name": "repo",
  13200. "description": "repo parameter",
  13201. "in": "PATH",
  13202. "type": "string",
  13203. "required": true,
  13204. "enum": null,
  13205. "allowNull": false,
  13206. "mapToData": null,
  13207. "validation": null,
  13208. "alias": null,
  13209. "deprecated": null
  13210. },
  13211. {
  13212. "name": "check_run_id",
  13213. "description": "check_run_id parameter",
  13214. "in": "PATH",
  13215. "type": "integer",
  13216. "required": true,
  13217. "enum": null,
  13218. "allowNull": false,
  13219. "mapToData": null,
  13220. "validation": null,
  13221. "alias": null,
  13222. "deprecated": null
  13223. }
  13224. ],
  13225. "responses": [
  13226. {
  13227. "code": 200,
  13228. "description": "response",
  13229. "examples": [
  13230. {
  13231. "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}"
  13232. }
  13233. ]
  13234. }
  13235. ],
  13236. "renamed": null
  13237. },
  13238. {
  13239. "name": "List annotations for a check run",
  13240. "scope": "checks",
  13241. "id": "listAnnotations",
  13242. "method": "GET",
  13243. "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations",
  13244. "isDeprecated": false,
  13245. "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.",
  13246. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/runs/#list-annotations-for-a-check-run",
  13247. "previews": [{ "name": "antiope" }],
  13248. "headers": [
  13249. {
  13250. "name": "accept",
  13251. "value": "application/vnd.github.antiope-preview+json"
  13252. }
  13253. ],
  13254. "parameters": [
  13255. {
  13256. "name": "owner",
  13257. "description": "owner parameter",
  13258. "in": "PATH",
  13259. "type": "string",
  13260. "required": true,
  13261. "enum": null,
  13262. "allowNull": false,
  13263. "mapToData": null,
  13264. "validation": null,
  13265. "alias": null,
  13266. "deprecated": null
  13267. },
  13268. {
  13269. "name": "repo",
  13270. "description": "repo parameter",
  13271. "in": "PATH",
  13272. "type": "string",
  13273. "required": true,
  13274. "enum": null,
  13275. "allowNull": false,
  13276. "mapToData": null,
  13277. "validation": null,
  13278. "alias": null,
  13279. "deprecated": null
  13280. },
  13281. {
  13282. "name": "check_run_id",
  13283. "description": "check_run_id parameter",
  13284. "in": "PATH",
  13285. "type": "integer",
  13286. "required": true,
  13287. "enum": null,
  13288. "allowNull": false,
  13289. "mapToData": null,
  13290. "validation": null,
  13291. "alias": null,
  13292. "deprecated": null
  13293. },
  13294. {
  13295. "name": "per_page",
  13296. "description": "Results per page (max 100)",
  13297. "in": "QUERY",
  13298. "type": "integer",
  13299. "required": false,
  13300. "enum": null,
  13301. "allowNull": false,
  13302. "mapToData": null,
  13303. "validation": null,
  13304. "alias": null,
  13305. "deprecated": null
  13306. },
  13307. {
  13308. "name": "page",
  13309. "description": "Page number of the results to fetch.",
  13310. "in": "QUERY",
  13311. "type": "integer",
  13312. "required": false,
  13313. "enum": null,
  13314. "allowNull": false,
  13315. "mapToData": null,
  13316. "validation": null,
  13317. "alias": null,
  13318. "deprecated": null
  13319. }
  13320. ],
  13321. "responses": [
  13322. {
  13323. "code": 200,
  13324. "description": "response",
  13325. "examples": [
  13326. {
  13327. "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\"}]"
  13328. }
  13329. ]
  13330. }
  13331. ],
  13332. "renamed": null
  13333. },
  13334. {
  13335. "name": "Create a check suite",
  13336. "scope": "checks",
  13337. "id": "createSuite",
  13338. "method": "POST",
  13339. "url": "/repos/{owner}/{repo}/check-suites",
  13340. "isDeprecated": false,
  13341. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://developer.github.com/enterprise/2.17/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Set preferences for check suites on a repository](https://developer.github.com/enterprise/2.17/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)\". Your GitHub App must have the `checks:write` permission to create check suites.",
  13342. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/suites/#create-a-check-suite",
  13343. "previews": [{ "name": "antiope" }],
  13344. "headers": [
  13345. {
  13346. "name": "accept",
  13347. "value": "application/vnd.github.antiope-preview+json"
  13348. }
  13349. ],
  13350. "parameters": [
  13351. {
  13352. "name": "owner",
  13353. "description": "owner parameter",
  13354. "in": "PATH",
  13355. "type": "string",
  13356. "required": true,
  13357. "enum": null,
  13358. "allowNull": false,
  13359. "mapToData": null,
  13360. "validation": null,
  13361. "alias": null,
  13362. "deprecated": null
  13363. },
  13364. {
  13365. "name": "repo",
  13366. "description": "repo parameter",
  13367. "in": "PATH",
  13368. "type": "string",
  13369. "required": true,
  13370. "enum": null,
  13371. "allowNull": false,
  13372. "mapToData": null,
  13373. "validation": null,
  13374. "alias": null,
  13375. "deprecated": null
  13376. },
  13377. {
  13378. "name": "head_sha",
  13379. "description": "The sha of the head commit.",
  13380. "in": "BODY",
  13381. "type": "string",
  13382. "required": true,
  13383. "enum": null,
  13384. "allowNull": false,
  13385. "mapToData": null,
  13386. "validation": null,
  13387. "alias": null,
  13388. "deprecated": null
  13389. }
  13390. ],
  13391. "responses": [
  13392. {
  13393. "code": 201,
  13394. "description": "response",
  13395. "examples": [
  13396. {
  13397. "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}"
  13398. }
  13399. ]
  13400. }
  13401. ],
  13402. "renamed": null
  13403. },
  13404. {
  13405. "name": "Set preferences for check suites on a repository",
  13406. "scope": "checks",
  13407. "id": "setSuitesPreferences",
  13408. "method": "PATCH",
  13409. "url": "/repos/{owner}/{repo}/check-suites/preferences",
  13410. "isDeprecated": false,
  13411. "description": "Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/enterprise/2.17/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.",
  13412. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository",
  13413. "previews": [{ "name": "antiope" }],
  13414. "headers": [
  13415. {
  13416. "name": "accept",
  13417. "value": "application/vnd.github.antiope-preview+json"
  13418. }
  13419. ],
  13420. "parameters": [
  13421. {
  13422. "name": "owner",
  13423. "description": "owner parameter",
  13424. "in": "PATH",
  13425. "type": "string",
  13426. "required": true,
  13427. "enum": null,
  13428. "allowNull": false,
  13429. "mapToData": null,
  13430. "validation": null,
  13431. "alias": null,
  13432. "deprecated": null
  13433. },
  13434. {
  13435. "name": "repo",
  13436. "description": "repo parameter",
  13437. "in": "PATH",
  13438. "type": "string",
  13439. "required": true,
  13440. "enum": null,
  13441. "allowNull": false,
  13442. "mapToData": null,
  13443. "validation": null,
  13444. "alias": null,
  13445. "deprecated": null
  13446. },
  13447. {
  13448. "name": "auto_trigger_checks",
  13449. "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/enterprise/2.17/v3/checks/suites/#auto_trigger_checks-object) description for details.",
  13450. "in": "BODY",
  13451. "type": "object[]",
  13452. "required": false,
  13453. "enum": null,
  13454. "allowNull": false,
  13455. "mapToData": null,
  13456. "validation": null,
  13457. "alias": null,
  13458. "deprecated": null
  13459. },
  13460. {
  13461. "name": "auto_trigger_checks[].app_id",
  13462. "description": "The `id` of the GitHub App.",
  13463. "in": "BODY",
  13464. "type": "integer",
  13465. "required": true,
  13466. "enum": null,
  13467. "allowNull": false,
  13468. "mapToData": null,
  13469. "validation": null,
  13470. "alias": null,
  13471. "deprecated": null
  13472. },
  13473. {
  13474. "name": "auto_trigger_checks[].setting",
  13475. "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.",
  13476. "in": "BODY",
  13477. "type": "boolean",
  13478. "required": true,
  13479. "enum": null,
  13480. "allowNull": false,
  13481. "mapToData": null,
  13482. "validation": null,
  13483. "alias": null,
  13484. "deprecated": null
  13485. }
  13486. ],
  13487. "responses": [
  13488. {
  13489. "code": 200,
  13490. "description": "response",
  13491. "examples": [
  13492. {
  13493. "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}"
  13494. }
  13495. ]
  13496. }
  13497. ],
  13498. "renamed": null
  13499. },
  13500. {
  13501. "name": "Get a single check suite",
  13502. "scope": "checks",
  13503. "id": "getSuite",
  13504. "method": "GET",
  13505. "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}",
  13506. "isDeprecated": false,
  13507. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
  13508. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/suites/#get-a-single-check-suite",
  13509. "previews": [{ "name": "antiope" }],
  13510. "headers": [
  13511. {
  13512. "name": "accept",
  13513. "value": "application/vnd.github.antiope-preview+json"
  13514. }
  13515. ],
  13516. "parameters": [
  13517. {
  13518. "name": "owner",
  13519. "description": "owner parameter",
  13520. "in": "PATH",
  13521. "type": "string",
  13522. "required": true,
  13523. "enum": null,
  13524. "allowNull": false,
  13525. "mapToData": null,
  13526. "validation": null,
  13527. "alias": null,
  13528. "deprecated": null
  13529. },
  13530. {
  13531. "name": "repo",
  13532. "description": "repo parameter",
  13533. "in": "PATH",
  13534. "type": "string",
  13535. "required": true,
  13536. "enum": null,
  13537. "allowNull": false,
  13538. "mapToData": null,
  13539. "validation": null,
  13540. "alias": null,
  13541. "deprecated": null
  13542. },
  13543. {
  13544. "name": "check_suite_id",
  13545. "description": "check_suite_id parameter",
  13546. "in": "PATH",
  13547. "type": "integer",
  13548. "required": true,
  13549. "enum": null,
  13550. "allowNull": false,
  13551. "mapToData": null,
  13552. "validation": null,
  13553. "alias": null,
  13554. "deprecated": null
  13555. }
  13556. ],
  13557. "responses": [
  13558. {
  13559. "code": 200,
  13560. "description": "response",
  13561. "examples": [
  13562. {
  13563. "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}"
  13564. }
  13565. ]
  13566. }
  13567. ],
  13568. "renamed": null
  13569. },
  13570. {
  13571. "name": "List check runs in a check suite",
  13572. "scope": "checks",
  13573. "id": "listForSuite",
  13574. "method": "GET",
  13575. "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs",
  13576. "isDeprecated": false,
  13577. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
  13578. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/runs/#list-check-runs-in-a-check-suite",
  13579. "previews": [{ "name": "antiope" }],
  13580. "headers": [
  13581. {
  13582. "name": "accept",
  13583. "value": "application/vnd.github.antiope-preview+json"
  13584. }
  13585. ],
  13586. "parameters": [
  13587. {
  13588. "name": "owner",
  13589. "description": "owner parameter",
  13590. "in": "PATH",
  13591. "type": "string",
  13592. "required": true,
  13593. "enum": null,
  13594. "allowNull": false,
  13595. "mapToData": null,
  13596. "validation": null,
  13597. "alias": null,
  13598. "deprecated": null
  13599. },
  13600. {
  13601. "name": "repo",
  13602. "description": "repo parameter",
  13603. "in": "PATH",
  13604. "type": "string",
  13605. "required": true,
  13606. "enum": null,
  13607. "allowNull": false,
  13608. "mapToData": null,
  13609. "validation": null,
  13610. "alias": null,
  13611. "deprecated": null
  13612. },
  13613. {
  13614. "name": "check_suite_id",
  13615. "description": "check_suite_id parameter",
  13616. "in": "PATH",
  13617. "type": "integer",
  13618. "required": true,
  13619. "enum": null,
  13620. "allowNull": false,
  13621. "mapToData": null,
  13622. "validation": null,
  13623. "alias": null,
  13624. "deprecated": null
  13625. },
  13626. {
  13627. "name": "check_name",
  13628. "description": "Returns check runs with the specified `name`.",
  13629. "in": "QUERY",
  13630. "type": "string",
  13631. "required": false,
  13632. "enum": null,
  13633. "allowNull": false,
  13634. "mapToData": null,
  13635. "validation": null,
  13636. "alias": null,
  13637. "deprecated": null
  13638. },
  13639. {
  13640. "name": "status",
  13641. "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.",
  13642. "in": "QUERY",
  13643. "type": "string",
  13644. "required": false,
  13645. "enum": ["queued", "in_progress", "completed"],
  13646. "allowNull": false,
  13647. "mapToData": null,
  13648. "validation": null,
  13649. "alias": null,
  13650. "deprecated": null
  13651. },
  13652. {
  13653. "name": "filter",
  13654. "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.",
  13655. "in": "QUERY",
  13656. "type": "string",
  13657. "required": false,
  13658. "enum": ["latest", "all"],
  13659. "allowNull": false,
  13660. "mapToData": null,
  13661. "validation": null,
  13662. "alias": null,
  13663. "deprecated": null
  13664. },
  13665. {
  13666. "name": "per_page",
  13667. "description": "Results per page (max 100)",
  13668. "in": "QUERY",
  13669. "type": "integer",
  13670. "required": false,
  13671. "enum": null,
  13672. "allowNull": false,
  13673. "mapToData": null,
  13674. "validation": null,
  13675. "alias": null,
  13676. "deprecated": null
  13677. },
  13678. {
  13679. "name": "page",
  13680. "description": "Page number of the results to fetch.",
  13681. "in": "QUERY",
  13682. "type": "integer",
  13683. "required": false,
  13684. "enum": null,
  13685. "allowNull": false,
  13686. "mapToData": null,
  13687. "validation": null,
  13688. "alias": null,
  13689. "deprecated": null
  13690. }
  13691. ],
  13692. "responses": [
  13693. {
  13694. "code": 200,
  13695. "description": "response",
  13696. "examples": [
  13697. {
  13698. "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}"
  13699. }
  13700. ]
  13701. }
  13702. ],
  13703. "renamed": null
  13704. },
  13705. {
  13706. "name": "Rerequest check suite",
  13707. "scope": "checks",
  13708. "id": "rerequestSuite",
  13709. "method": "POST",
  13710. "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest",
  13711. "isDeprecated": false,
  13712. "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/enterprise/2.17/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.",
  13713. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/suites/#rerequest-check-suite",
  13714. "previews": [{ "name": "antiope" }],
  13715. "headers": [
  13716. {
  13717. "name": "accept",
  13718. "value": "application/vnd.github.antiope-preview+json"
  13719. }
  13720. ],
  13721. "parameters": [
  13722. {
  13723. "name": "owner",
  13724. "description": "owner parameter",
  13725. "in": "PATH",
  13726. "type": "string",
  13727. "required": true,
  13728. "enum": null,
  13729. "allowNull": false,
  13730. "mapToData": null,
  13731. "validation": null,
  13732. "alias": null,
  13733. "deprecated": null
  13734. },
  13735. {
  13736. "name": "repo",
  13737. "description": "repo parameter",
  13738. "in": "PATH",
  13739. "type": "string",
  13740. "required": true,
  13741. "enum": null,
  13742. "allowNull": false,
  13743. "mapToData": null,
  13744. "validation": null,
  13745. "alias": null,
  13746. "deprecated": null
  13747. },
  13748. {
  13749. "name": "check_suite_id",
  13750. "description": "check_suite_id parameter",
  13751. "in": "PATH",
  13752. "type": "integer",
  13753. "required": true,
  13754. "enum": null,
  13755. "allowNull": false,
  13756. "mapToData": null,
  13757. "validation": null,
  13758. "alias": null,
  13759. "deprecated": null
  13760. }
  13761. ],
  13762. "responses": [],
  13763. "renamed": null
  13764. },
  13765. {
  13766. "name": "List collaborators",
  13767. "scope": "repos",
  13768. "id": "listCollaborators",
  13769. "method": "GET",
  13770. "url": "/repos/{owner}/{repo}/collaborators",
  13771. "isDeprecated": false,
  13772. "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nIf you pass the `hellcat-preview` media type, team members will include the members of child teams.",
  13773. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/collaborators/#list-collaborators",
  13774. "previews": [],
  13775. "headers": [],
  13776. "parameters": [
  13777. {
  13778. "name": "owner",
  13779. "description": "owner parameter",
  13780. "in": "PATH",
  13781. "type": "string",
  13782. "required": true,
  13783. "enum": null,
  13784. "allowNull": false,
  13785. "mapToData": null,
  13786. "validation": null,
  13787. "alias": null,
  13788. "deprecated": null
  13789. },
  13790. {
  13791. "name": "repo",
  13792. "description": "repo parameter",
  13793. "in": "PATH",
  13794. "type": "string",
  13795. "required": true,
  13796. "enum": null,
  13797. "allowNull": false,
  13798. "mapToData": null,
  13799. "validation": null,
  13800. "alias": null,
  13801. "deprecated": null
  13802. },
  13803. {
  13804. "name": "affiliation",
  13805. "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.",
  13806. "in": "QUERY",
  13807. "type": "string",
  13808. "required": false,
  13809. "enum": ["outside", "direct", "all"],
  13810. "allowNull": false,
  13811. "mapToData": null,
  13812. "validation": null,
  13813. "alias": null,
  13814. "deprecated": null
  13815. },
  13816. {
  13817. "name": "per_page",
  13818. "description": "Results per page (max 100)",
  13819. "in": "QUERY",
  13820. "type": "integer",
  13821. "required": false,
  13822. "enum": null,
  13823. "allowNull": false,
  13824. "mapToData": null,
  13825. "validation": null,
  13826. "alias": null,
  13827. "deprecated": null
  13828. },
  13829. {
  13830. "name": "page",
  13831. "description": "Page number of the results to fetch.",
  13832. "in": "QUERY",
  13833. "type": "integer",
  13834. "required": false,
  13835. "enum": null,
  13836. "allowNull": false,
  13837. "mapToData": null,
  13838. "validation": null,
  13839. "alias": null,
  13840. "deprecated": null
  13841. }
  13842. ],
  13843. "responses": [
  13844. {
  13845. "code": 200,
  13846. "description": "response",
  13847. "examples": [
  13848. {
  13849. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]"
  13850. }
  13851. ]
  13852. }
  13853. ],
  13854. "renamed": null
  13855. },
  13856. {
  13857. "name": "Check if a user is a collaborator",
  13858. "scope": "repos",
  13859. "id": "checkCollaborator",
  13860. "method": "GET",
  13861. "url": "/repos/{owner}/{repo}/collaborators/{username}",
  13862. "isDeprecated": false,
  13863. "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nIf you pass the `hellcat-preview` media type, team members will include the members of child teams.",
  13864. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/collaborators/#check-if-a-user-is-a-collaborator",
  13865. "previews": [],
  13866. "headers": [],
  13867. "parameters": [
  13868. {
  13869. "name": "owner",
  13870. "description": "owner parameter",
  13871. "in": "PATH",
  13872. "type": "string",
  13873. "required": true,
  13874. "enum": null,
  13875. "allowNull": false,
  13876. "mapToData": null,
  13877. "validation": null,
  13878. "alias": null,
  13879. "deprecated": null
  13880. },
  13881. {
  13882. "name": "repo",
  13883. "description": "repo parameter",
  13884. "in": "PATH",
  13885. "type": "string",
  13886. "required": true,
  13887. "enum": null,
  13888. "allowNull": false,
  13889. "mapToData": null,
  13890. "validation": null,
  13891. "alias": null,
  13892. "deprecated": null
  13893. },
  13894. {
  13895. "name": "username",
  13896. "description": "username parameter",
  13897. "in": "PATH",
  13898. "type": "string",
  13899. "required": true,
  13900. "enum": null,
  13901. "allowNull": false,
  13902. "mapToData": null,
  13903. "validation": null,
  13904. "alias": null,
  13905. "deprecated": null
  13906. }
  13907. ],
  13908. "responses": [],
  13909. "renamed": null
  13910. },
  13911. {
  13912. "name": "Add user as a collaborator",
  13913. "scope": "repos",
  13914. "id": "addCollaborator",
  13915. "method": "PUT",
  13916. "url": "/repos/{owner}/{repo}/collaborators/{username}",
  13917. "isDeprecated": false,
  13918. "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  13919. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/collaborators/#add-user-as-a-collaborator",
  13920. "previews": [],
  13921. "headers": [],
  13922. "parameters": [
  13923. {
  13924. "name": "owner",
  13925. "description": "owner parameter",
  13926. "in": "PATH",
  13927. "type": "string",
  13928. "required": true,
  13929. "enum": null,
  13930. "allowNull": false,
  13931. "mapToData": null,
  13932. "validation": null,
  13933. "alias": null,
  13934. "deprecated": null
  13935. },
  13936. {
  13937. "name": "repo",
  13938. "description": "repo parameter",
  13939. "in": "PATH",
  13940. "type": "string",
  13941. "required": true,
  13942. "enum": null,
  13943. "allowNull": false,
  13944. "mapToData": null,
  13945. "validation": null,
  13946. "alias": null,
  13947. "deprecated": null
  13948. },
  13949. {
  13950. "name": "username",
  13951. "description": "username parameter",
  13952. "in": "PATH",
  13953. "type": "string",
  13954. "required": true,
  13955. "enum": null,
  13956. "allowNull": false,
  13957. "mapToData": null,
  13958. "validation": null,
  13959. "alias": null,
  13960. "deprecated": null
  13961. },
  13962. {
  13963. "name": "permission",
  13964. "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.",
  13965. "in": "BODY",
  13966. "type": "string",
  13967. "required": false,
  13968. "enum": ["pull", "push", "admin"],
  13969. "allowNull": false,
  13970. "mapToData": null,
  13971. "validation": null,
  13972. "alias": null,
  13973. "deprecated": null
  13974. }
  13975. ],
  13976. "responses": [],
  13977. "renamed": null
  13978. },
  13979. {
  13980. "name": "Remove user as a collaborator",
  13981. "scope": "repos",
  13982. "id": "removeCollaborator",
  13983. "method": "DELETE",
  13984. "url": "/repos/{owner}/{repo}/collaborators/{username}",
  13985. "isDeprecated": false,
  13986. "description": "",
  13987. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/collaborators/#remove-user-as-a-collaborator",
  13988. "previews": [],
  13989. "headers": [],
  13990. "parameters": [
  13991. {
  13992. "name": "owner",
  13993. "description": "owner parameter",
  13994. "in": "PATH",
  13995. "type": "string",
  13996. "required": true,
  13997. "enum": null,
  13998. "allowNull": false,
  13999. "mapToData": null,
  14000. "validation": null,
  14001. "alias": null,
  14002. "deprecated": null
  14003. },
  14004. {
  14005. "name": "repo",
  14006. "description": "repo parameter",
  14007. "in": "PATH",
  14008. "type": "string",
  14009. "required": true,
  14010. "enum": null,
  14011. "allowNull": false,
  14012. "mapToData": null,
  14013. "validation": null,
  14014. "alias": null,
  14015. "deprecated": null
  14016. },
  14017. {
  14018. "name": "username",
  14019. "description": "username parameter",
  14020. "in": "PATH",
  14021. "type": "string",
  14022. "required": true,
  14023. "enum": null,
  14024. "allowNull": false,
  14025. "mapToData": null,
  14026. "validation": null,
  14027. "alias": null,
  14028. "deprecated": null
  14029. }
  14030. ],
  14031. "responses": [],
  14032. "renamed": null
  14033. },
  14034. {
  14035. "name": "Review a user's permission level",
  14036. "scope": "repos",
  14037. "id": "getCollaboratorPermissionLevel",
  14038. "method": "GET",
  14039. "url": "/repos/{owner}/{repo}/collaborators/{username}/permission",
  14040. "isDeprecated": false,
  14041. "description": "Possible values for the `permission` key: `admin`, `write`, `read`, `none`.",
  14042. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/collaborators/#review-a-users-permission-level",
  14043. "previews": [],
  14044. "headers": [],
  14045. "parameters": [
  14046. {
  14047. "name": "owner",
  14048. "description": "owner parameter",
  14049. "in": "PATH",
  14050. "type": "string",
  14051. "required": true,
  14052. "enum": null,
  14053. "allowNull": false,
  14054. "mapToData": null,
  14055. "validation": null,
  14056. "alias": null,
  14057. "deprecated": null
  14058. },
  14059. {
  14060. "name": "repo",
  14061. "description": "repo parameter",
  14062. "in": "PATH",
  14063. "type": "string",
  14064. "required": true,
  14065. "enum": null,
  14066. "allowNull": false,
  14067. "mapToData": null,
  14068. "validation": null,
  14069. "alias": null,
  14070. "deprecated": null
  14071. },
  14072. {
  14073. "name": "username",
  14074. "description": "username parameter",
  14075. "in": "PATH",
  14076. "type": "string",
  14077. "required": true,
  14078. "enum": null,
  14079. "allowNull": false,
  14080. "mapToData": null,
  14081. "validation": null,
  14082. "alias": null,
  14083. "deprecated": null
  14084. }
  14085. ],
  14086. "responses": [
  14087. {
  14088. "code": 200,
  14089. "description": "Response if user has admin permissions",
  14090. "examples": [
  14091. {
  14092. "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  14093. }
  14094. ]
  14095. }
  14096. ],
  14097. "renamed": null
  14098. },
  14099. {
  14100. "name": "List commit comments for a repository",
  14101. "scope": "repos",
  14102. "id": "listCommitComments",
  14103. "method": "GET",
  14104. "url": "/repos/{owner}/{repo}/comments",
  14105. "isDeprecated": false,
  14106. "description": "Commit Comments use [these custom media types](https://developer.github.com/enterprise/2.17/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/enterprise/2.17/v3/media/).\n\nComments are ordered by ascending ID.",
  14107. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/comments/#list-commit-comments-for-a-repository",
  14108. "previews": [],
  14109. "headers": [],
  14110. "parameters": [
  14111. {
  14112. "name": "owner",
  14113. "description": "owner parameter",
  14114. "in": "PATH",
  14115. "type": "string",
  14116. "required": true,
  14117. "enum": null,
  14118. "allowNull": false,
  14119. "mapToData": null,
  14120. "validation": null,
  14121. "alias": null,
  14122. "deprecated": null
  14123. },
  14124. {
  14125. "name": "repo",
  14126. "description": "repo parameter",
  14127. "in": "PATH",
  14128. "type": "string",
  14129. "required": true,
  14130. "enum": null,
  14131. "allowNull": false,
  14132. "mapToData": null,
  14133. "validation": null,
  14134. "alias": null,
  14135. "deprecated": null
  14136. },
  14137. {
  14138. "name": "per_page",
  14139. "description": "Results per page (max 100)",
  14140. "in": "QUERY",
  14141. "type": "integer",
  14142. "required": false,
  14143. "enum": null,
  14144. "allowNull": false,
  14145. "mapToData": null,
  14146. "validation": null,
  14147. "alias": null,
  14148. "deprecated": null
  14149. },
  14150. {
  14151. "name": "page",
  14152. "description": "Page number of the results to fetch.",
  14153. "in": "QUERY",
  14154. "type": "integer",
  14155. "required": false,
  14156. "enum": null,
  14157. "allowNull": false,
  14158. "mapToData": null,
  14159. "validation": null,
  14160. "alias": null,
  14161. "deprecated": null
  14162. }
  14163. ],
  14164. "responses": [
  14165. {
  14166. "code": 200,
  14167. "description": "response",
  14168. "examples": [
  14169. {
  14170. "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]"
  14171. }
  14172. ]
  14173. }
  14174. ],
  14175. "renamed": null
  14176. },
  14177. {
  14178. "name": "Get a single commit comment",
  14179. "scope": "repos",
  14180. "id": "getCommitComment",
  14181. "method": "GET",
  14182. "url": "/repos/{owner}/{repo}/comments/{comment_id}",
  14183. "isDeprecated": false,
  14184. "description": "",
  14185. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/comments/#get-a-single-commit-comment",
  14186. "previews": [],
  14187. "headers": [],
  14188. "parameters": [
  14189. {
  14190. "name": "owner",
  14191. "description": "owner parameter",
  14192. "in": "PATH",
  14193. "type": "string",
  14194. "required": true,
  14195. "enum": null,
  14196. "allowNull": false,
  14197. "mapToData": null,
  14198. "validation": null,
  14199. "alias": null,
  14200. "deprecated": null
  14201. },
  14202. {
  14203. "name": "repo",
  14204. "description": "repo parameter",
  14205. "in": "PATH",
  14206. "type": "string",
  14207. "required": true,
  14208. "enum": null,
  14209. "allowNull": false,
  14210. "mapToData": null,
  14211. "validation": null,
  14212. "alias": null,
  14213. "deprecated": null
  14214. },
  14215. {
  14216. "name": "comment_id",
  14217. "description": "comment_id parameter",
  14218. "in": "PATH",
  14219. "type": "integer",
  14220. "required": true,
  14221. "enum": null,
  14222. "allowNull": false,
  14223. "mapToData": null,
  14224. "validation": null,
  14225. "alias": null,
  14226. "deprecated": null
  14227. }
  14228. ],
  14229. "responses": [
  14230. {
  14231. "code": 200,
  14232. "description": "response",
  14233. "examples": [
  14234. {
  14235. "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}"
  14236. }
  14237. ]
  14238. }
  14239. ],
  14240. "renamed": null
  14241. },
  14242. {
  14243. "name": "Update a commit comment",
  14244. "scope": "repos",
  14245. "id": "updateCommitComment",
  14246. "method": "PATCH",
  14247. "url": "/repos/{owner}/{repo}/comments/{comment_id}",
  14248. "isDeprecated": false,
  14249. "description": "",
  14250. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/comments/#update-a-commit-comment",
  14251. "previews": [],
  14252. "headers": [],
  14253. "parameters": [
  14254. {
  14255. "name": "owner",
  14256. "description": "owner parameter",
  14257. "in": "PATH",
  14258. "type": "string",
  14259. "required": true,
  14260. "enum": null,
  14261. "allowNull": false,
  14262. "mapToData": null,
  14263. "validation": null,
  14264. "alias": null,
  14265. "deprecated": null
  14266. },
  14267. {
  14268. "name": "repo",
  14269. "description": "repo parameter",
  14270. "in": "PATH",
  14271. "type": "string",
  14272. "required": true,
  14273. "enum": null,
  14274. "allowNull": false,
  14275. "mapToData": null,
  14276. "validation": null,
  14277. "alias": null,
  14278. "deprecated": null
  14279. },
  14280. {
  14281. "name": "comment_id",
  14282. "description": "comment_id parameter",
  14283. "in": "PATH",
  14284. "type": "integer",
  14285. "required": true,
  14286. "enum": null,
  14287. "allowNull": false,
  14288. "mapToData": null,
  14289. "validation": null,
  14290. "alias": null,
  14291. "deprecated": null
  14292. },
  14293. {
  14294. "name": "body",
  14295. "description": "The contents of the comment",
  14296. "in": "BODY",
  14297. "type": "string",
  14298. "required": true,
  14299. "enum": null,
  14300. "allowNull": false,
  14301. "mapToData": null,
  14302. "validation": null,
  14303. "alias": null,
  14304. "deprecated": null
  14305. }
  14306. ],
  14307. "responses": [
  14308. {
  14309. "code": 200,
  14310. "description": "response",
  14311. "examples": [
  14312. {
  14313. "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Nice change\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}"
  14314. }
  14315. ]
  14316. }
  14317. ],
  14318. "renamed": null
  14319. },
  14320. {
  14321. "name": "Delete a commit comment",
  14322. "scope": "repos",
  14323. "id": "deleteCommitComment",
  14324. "method": "DELETE",
  14325. "url": "/repos/{owner}/{repo}/comments/{comment_id}",
  14326. "isDeprecated": false,
  14327. "description": "",
  14328. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/comments/#delete-a-commit-comment",
  14329. "previews": [],
  14330. "headers": [],
  14331. "parameters": [
  14332. {
  14333. "name": "owner",
  14334. "description": "owner parameter",
  14335. "in": "PATH",
  14336. "type": "string",
  14337. "required": true,
  14338. "enum": null,
  14339. "allowNull": false,
  14340. "mapToData": null,
  14341. "validation": null,
  14342. "alias": null,
  14343. "deprecated": null
  14344. },
  14345. {
  14346. "name": "repo",
  14347. "description": "repo parameter",
  14348. "in": "PATH",
  14349. "type": "string",
  14350. "required": true,
  14351. "enum": null,
  14352. "allowNull": false,
  14353. "mapToData": null,
  14354. "validation": null,
  14355. "alias": null,
  14356. "deprecated": null
  14357. },
  14358. {
  14359. "name": "comment_id",
  14360. "description": "comment_id parameter",
  14361. "in": "PATH",
  14362. "type": "integer",
  14363. "required": true,
  14364. "enum": null,
  14365. "allowNull": false,
  14366. "mapToData": null,
  14367. "validation": null,
  14368. "alias": null,
  14369. "deprecated": null
  14370. }
  14371. ],
  14372. "responses": [],
  14373. "renamed": null
  14374. },
  14375. {
  14376. "name": "List reactions for a commit comment",
  14377. "scope": "reactions",
  14378. "id": "listForCommitComment",
  14379. "method": "GET",
  14380. "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions",
  14381. "isDeprecated": false,
  14382. "description": "List the reactions to a [commit comment](https://developer.github.com/enterprise/2.17/v3/repos/comments/).",
  14383. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#list-reactions-for-a-commit-comment",
  14384. "previews": [{ "name": "squirrel-girl" }],
  14385. "headers": [
  14386. {
  14387. "name": "accept",
  14388. "value": "application/vnd.github.squirrel-girl-preview+json"
  14389. }
  14390. ],
  14391. "parameters": [
  14392. {
  14393. "name": "owner",
  14394. "description": "owner parameter",
  14395. "in": "PATH",
  14396. "type": "string",
  14397. "required": true,
  14398. "enum": null,
  14399. "allowNull": false,
  14400. "mapToData": null,
  14401. "validation": null,
  14402. "alias": null,
  14403. "deprecated": null
  14404. },
  14405. {
  14406. "name": "repo",
  14407. "description": "repo parameter",
  14408. "in": "PATH",
  14409. "type": "string",
  14410. "required": true,
  14411. "enum": null,
  14412. "allowNull": false,
  14413. "mapToData": null,
  14414. "validation": null,
  14415. "alias": null,
  14416. "deprecated": null
  14417. },
  14418. {
  14419. "name": "comment_id",
  14420. "description": "comment_id parameter",
  14421. "in": "PATH",
  14422. "type": "integer",
  14423. "required": true,
  14424. "enum": null,
  14425. "allowNull": false,
  14426. "mapToData": null,
  14427. "validation": null,
  14428. "alias": null,
  14429. "deprecated": null
  14430. },
  14431. {
  14432. "name": "content",
  14433. "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.",
  14434. "in": "QUERY",
  14435. "type": "string",
  14436. "required": false,
  14437. "enum": [
  14438. "+1",
  14439. "-1",
  14440. "laugh",
  14441. "confused",
  14442. "heart",
  14443. "hooray",
  14444. "rocket",
  14445. "eyes"
  14446. ],
  14447. "allowNull": false,
  14448. "mapToData": null,
  14449. "validation": null,
  14450. "alias": null,
  14451. "deprecated": null
  14452. },
  14453. {
  14454. "name": "per_page",
  14455. "description": "Results per page (max 100)",
  14456. "in": "QUERY",
  14457. "type": "integer",
  14458. "required": false,
  14459. "enum": null,
  14460. "allowNull": false,
  14461. "mapToData": null,
  14462. "validation": null,
  14463. "alias": null,
  14464. "deprecated": null
  14465. },
  14466. {
  14467. "name": "page",
  14468. "description": "Page number of the results to fetch.",
  14469. "in": "QUERY",
  14470. "type": "integer",
  14471. "required": false,
  14472. "enum": null,
  14473. "allowNull": false,
  14474. "mapToData": null,
  14475. "validation": null,
  14476. "alias": null,
  14477. "deprecated": null
  14478. }
  14479. ],
  14480. "responses": [
  14481. {
  14482. "code": 200,
  14483. "description": "response",
  14484. "examples": [
  14485. {
  14486. "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]"
  14487. }
  14488. ]
  14489. }
  14490. ],
  14491. "renamed": null
  14492. },
  14493. {
  14494. "name": "Create reaction for a commit comment",
  14495. "scope": "reactions",
  14496. "id": "createForCommitComment",
  14497. "method": "POST",
  14498. "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions",
  14499. "isDeprecated": false,
  14500. "description": "Create a reaction to a [commit comment](https://developer.github.com/enterprise/2.17/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.",
  14501. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#create-reaction-for-a-commit-comment",
  14502. "previews": [{ "name": "squirrel-girl" }],
  14503. "headers": [
  14504. {
  14505. "name": "accept",
  14506. "value": "application/vnd.github.squirrel-girl-preview+json"
  14507. }
  14508. ],
  14509. "parameters": [
  14510. {
  14511. "name": "owner",
  14512. "description": "owner parameter",
  14513. "in": "PATH",
  14514. "type": "string",
  14515. "required": true,
  14516. "enum": null,
  14517. "allowNull": false,
  14518. "mapToData": null,
  14519. "validation": null,
  14520. "alias": null,
  14521. "deprecated": null
  14522. },
  14523. {
  14524. "name": "repo",
  14525. "description": "repo parameter",
  14526. "in": "PATH",
  14527. "type": "string",
  14528. "required": true,
  14529. "enum": null,
  14530. "allowNull": false,
  14531. "mapToData": null,
  14532. "validation": null,
  14533. "alias": null,
  14534. "deprecated": null
  14535. },
  14536. {
  14537. "name": "comment_id",
  14538. "description": "comment_id parameter",
  14539. "in": "PATH",
  14540. "type": "integer",
  14541. "required": true,
  14542. "enum": null,
  14543. "allowNull": false,
  14544. "mapToData": null,
  14545. "validation": null,
  14546. "alias": null,
  14547. "deprecated": null
  14548. },
  14549. {
  14550. "name": "content",
  14551. "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the commit comment.",
  14552. "in": "BODY",
  14553. "type": "string",
  14554. "required": true,
  14555. "enum": [
  14556. "+1",
  14557. "-1",
  14558. "laugh",
  14559. "confused",
  14560. "heart",
  14561. "hooray",
  14562. "rocket",
  14563. "eyes"
  14564. ],
  14565. "allowNull": false,
  14566. "mapToData": null,
  14567. "validation": null,
  14568. "alias": null,
  14569. "deprecated": null
  14570. }
  14571. ],
  14572. "responses": [
  14573. {
  14574. "code": 201,
  14575. "description": "response",
  14576. "examples": [
  14577. {
  14578. "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}"
  14579. }
  14580. ]
  14581. }
  14582. ],
  14583. "renamed": null
  14584. },
  14585. {
  14586. "name": "List commits on a repository",
  14587. "scope": "repos",
  14588. "id": "listCommits",
  14589. "method": "GET",
  14590. "url": "/repos/{owner}/{repo}/commits",
  14591. "isDeprecated": false,
  14592. "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
  14593. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/commits/#list-commits-on-a-repository",
  14594. "previews": [],
  14595. "headers": [],
  14596. "parameters": [
  14597. {
  14598. "name": "owner",
  14599. "description": "owner parameter",
  14600. "in": "PATH",
  14601. "type": "string",
  14602. "required": true,
  14603. "enum": null,
  14604. "allowNull": false,
  14605. "mapToData": null,
  14606. "validation": null,
  14607. "alias": null,
  14608. "deprecated": null
  14609. },
  14610. {
  14611. "name": "repo",
  14612. "description": "repo parameter",
  14613. "in": "PATH",
  14614. "type": "string",
  14615. "required": true,
  14616. "enum": null,
  14617. "allowNull": false,
  14618. "mapToData": null,
  14619. "validation": null,
  14620. "alias": null,
  14621. "deprecated": null
  14622. },
  14623. {
  14624. "name": "sha",
  14625. "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).",
  14626. "in": "QUERY",
  14627. "type": "string",
  14628. "required": false,
  14629. "enum": null,
  14630. "allowNull": false,
  14631. "mapToData": null,
  14632. "validation": null,
  14633. "alias": null,
  14634. "deprecated": null
  14635. },
  14636. {
  14637. "name": "path",
  14638. "description": "Only commits containing this file path will be returned.",
  14639. "in": "QUERY",
  14640. "type": "string",
  14641. "required": false,
  14642. "enum": null,
  14643. "allowNull": false,
  14644. "mapToData": null,
  14645. "validation": null,
  14646. "alias": null,
  14647. "deprecated": null
  14648. },
  14649. {
  14650. "name": "author",
  14651. "description": "GitHub login or email address by which to filter by commit author.",
  14652. "in": "QUERY",
  14653. "type": "string",
  14654. "required": false,
  14655. "enum": null,
  14656. "allowNull": false,
  14657. "mapToData": null,
  14658. "validation": null,
  14659. "alias": null,
  14660. "deprecated": null
  14661. },
  14662. {
  14663. "name": "since",
  14664. "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  14665. "in": "QUERY",
  14666. "type": "string",
  14667. "required": false,
  14668. "enum": null,
  14669. "allowNull": false,
  14670. "mapToData": null,
  14671. "validation": null,
  14672. "alias": null,
  14673. "deprecated": null
  14674. },
  14675. {
  14676. "name": "until",
  14677. "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  14678. "in": "QUERY",
  14679. "type": "string",
  14680. "required": false,
  14681. "enum": null,
  14682. "allowNull": false,
  14683. "mapToData": null,
  14684. "validation": null,
  14685. "alias": null,
  14686. "deprecated": null
  14687. },
  14688. {
  14689. "name": "per_page",
  14690. "description": "Results per page (max 100)",
  14691. "in": "QUERY",
  14692. "type": "integer",
  14693. "required": false,
  14694. "enum": null,
  14695. "allowNull": false,
  14696. "mapToData": null,
  14697. "validation": null,
  14698. "alias": null,
  14699. "deprecated": null
  14700. },
  14701. {
  14702. "name": "page",
  14703. "description": "Page number of the results to fetch.",
  14704. "in": "QUERY",
  14705. "type": "integer",
  14706. "required": false,
  14707. "enum": null,
  14708. "allowNull": false,
  14709. "mapToData": null,
  14710. "validation": null,
  14711. "alias": null,
  14712. "deprecated": null
  14713. }
  14714. ],
  14715. "responses": [
  14716. {
  14717. "code": 200,
  14718. "description": "response",
  14719. "examples": [
  14720. {
  14721. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]"
  14722. }
  14723. ]
  14724. }
  14725. ],
  14726. "renamed": null
  14727. },
  14728. {
  14729. "name": "List branches for HEAD commit",
  14730. "scope": "repos",
  14731. "id": "listBranchesForHeadCommit",
  14732. "method": "GET",
  14733. "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head",
  14734. "isDeprecated": false,
  14735. "description": "Returns all branches where the given commit SHA is the HEAD, or latest commit for the branch.",
  14736. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/commits/#list-branches-for-head-commit",
  14737. "previews": [{ "name": "groot" }],
  14738. "headers": [
  14739. { "name": "accept", "value": "application/vnd.github.groot-preview+json" }
  14740. ],
  14741. "parameters": [
  14742. {
  14743. "name": "owner",
  14744. "description": "owner parameter",
  14745. "in": "PATH",
  14746. "type": "string",
  14747. "required": true,
  14748. "enum": null,
  14749. "allowNull": false,
  14750. "mapToData": null,
  14751. "validation": null,
  14752. "alias": null,
  14753. "deprecated": null
  14754. },
  14755. {
  14756. "name": "repo",
  14757. "description": "repo parameter",
  14758. "in": "PATH",
  14759. "type": "string",
  14760. "required": true,
  14761. "enum": null,
  14762. "allowNull": false,
  14763. "mapToData": null,
  14764. "validation": null,
  14765. "alias": null,
  14766. "deprecated": null
  14767. },
  14768. {
  14769. "name": "commit_sha",
  14770. "description": "commit_sha parameter",
  14771. "in": "PATH",
  14772. "type": "string",
  14773. "required": true,
  14774. "enum": null,
  14775. "allowNull": false,
  14776. "mapToData": null,
  14777. "validation": null,
  14778. "alias": null,
  14779. "deprecated": null
  14780. }
  14781. ],
  14782. "responses": [
  14783. {
  14784. "code": 200,
  14785. "description": "response",
  14786. "examples": [
  14787. {
  14788. "data": "[{\"name\":\"branch_5\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":\"false\"}]"
  14789. }
  14790. ]
  14791. }
  14792. ],
  14793. "renamed": null
  14794. },
  14795. {
  14796. "name": "List comments for a single commit",
  14797. "scope": "repos",
  14798. "id": "listCommentsForCommit",
  14799. "method": "GET",
  14800. "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments",
  14801. "isDeprecated": false,
  14802. "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.",
  14803. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/comments/#list-comments-for-a-single-commit",
  14804. "previews": [],
  14805. "headers": [],
  14806. "parameters": [
  14807. {
  14808. "name": "owner",
  14809. "description": "owner parameter",
  14810. "in": "PATH",
  14811. "type": "string",
  14812. "required": true,
  14813. "enum": null,
  14814. "allowNull": false,
  14815. "mapToData": null,
  14816. "validation": null,
  14817. "alias": null,
  14818. "deprecated": null
  14819. },
  14820. {
  14821. "name": "repo",
  14822. "description": "repo parameter",
  14823. "in": "PATH",
  14824. "type": "string",
  14825. "required": true,
  14826. "enum": null,
  14827. "allowNull": false,
  14828. "mapToData": null,
  14829. "validation": null,
  14830. "alias": null,
  14831. "deprecated": null
  14832. },
  14833. {
  14834. "name": "commit_sha",
  14835. "description": "commit_sha parameter",
  14836. "in": "PATH",
  14837. "type": "string",
  14838. "required": true,
  14839. "enum": null,
  14840. "allowNull": false,
  14841. "mapToData": null,
  14842. "validation": null,
  14843. "alias": null,
  14844. "deprecated": null
  14845. },
  14846. {
  14847. "name": "per_page",
  14848. "description": "Results per page (max 100)",
  14849. "in": "QUERY",
  14850. "type": "integer",
  14851. "required": false,
  14852. "enum": null,
  14853. "allowNull": false,
  14854. "mapToData": null,
  14855. "validation": null,
  14856. "alias": null,
  14857. "deprecated": null
  14858. },
  14859. {
  14860. "name": "page",
  14861. "description": "Page number of the results to fetch.",
  14862. "in": "QUERY",
  14863. "type": "integer",
  14864. "required": false,
  14865. "enum": null,
  14866. "allowNull": false,
  14867. "mapToData": null,
  14868. "validation": null,
  14869. "alias": null,
  14870. "deprecated": null
  14871. },
  14872. {
  14873. "name": "ref",
  14874. "description": null,
  14875. "in": null,
  14876. "type": null,
  14877. "required": null,
  14878. "enum": null,
  14879. "allowNull": null,
  14880. "mapToData": null,
  14881. "validation": null,
  14882. "alias": "commit_sha",
  14883. "deprecated": true
  14884. }
  14885. ],
  14886. "responses": [
  14887. {
  14888. "code": 200,
  14889. "description": "response",
  14890. "examples": [
  14891. {
  14892. "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]"
  14893. }
  14894. ]
  14895. }
  14896. ],
  14897. "renamed": null
  14898. },
  14899. {
  14900. "name": "Create a commit comment",
  14901. "scope": "repos",
  14902. "id": "createCommitComment",
  14903. "method": "POST",
  14904. "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments",
  14905. "isDeprecated": false,
  14906. "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  14907. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/comments/#create-a-commit-comment",
  14908. "previews": [],
  14909. "headers": [],
  14910. "parameters": [
  14911. {
  14912. "name": "owner",
  14913. "description": "owner parameter",
  14914. "in": "PATH",
  14915. "type": "string",
  14916. "required": true,
  14917. "enum": null,
  14918. "allowNull": false,
  14919. "mapToData": null,
  14920. "validation": null,
  14921. "alias": null,
  14922. "deprecated": null
  14923. },
  14924. {
  14925. "name": "repo",
  14926. "description": "repo parameter",
  14927. "in": "PATH",
  14928. "type": "string",
  14929. "required": true,
  14930. "enum": null,
  14931. "allowNull": false,
  14932. "mapToData": null,
  14933. "validation": null,
  14934. "alias": null,
  14935. "deprecated": null
  14936. },
  14937. {
  14938. "name": "commit_sha",
  14939. "description": "commit_sha parameter",
  14940. "in": "PATH",
  14941. "type": "string",
  14942. "required": true,
  14943. "enum": null,
  14944. "allowNull": false,
  14945. "mapToData": null,
  14946. "validation": null,
  14947. "alias": null,
  14948. "deprecated": null
  14949. },
  14950. {
  14951. "name": "body",
  14952. "description": "The contents of the comment.",
  14953. "in": "BODY",
  14954. "type": "string",
  14955. "required": true,
  14956. "enum": null,
  14957. "allowNull": false,
  14958. "mapToData": null,
  14959. "validation": null,
  14960. "alias": null,
  14961. "deprecated": null
  14962. },
  14963. {
  14964. "name": "path",
  14965. "description": "Relative path of the file to comment on.",
  14966. "in": "BODY",
  14967. "type": "string",
  14968. "required": false,
  14969. "enum": null,
  14970. "allowNull": false,
  14971. "mapToData": null,
  14972. "validation": null,
  14973. "alias": null,
  14974. "deprecated": null
  14975. },
  14976. {
  14977. "name": "position",
  14978. "description": "Line index in the diff to comment on.",
  14979. "in": "BODY",
  14980. "type": "integer",
  14981. "required": false,
  14982. "enum": null,
  14983. "allowNull": false,
  14984. "mapToData": null,
  14985. "validation": null,
  14986. "alias": null,
  14987. "deprecated": null
  14988. },
  14989. {
  14990. "name": "line",
  14991. "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.",
  14992. "in": "BODY",
  14993. "type": "integer",
  14994. "required": false,
  14995. "enum": null,
  14996. "allowNull": false,
  14997. "mapToData": null,
  14998. "validation": null,
  14999. "alias": null,
  15000. "deprecated": null
  15001. },
  15002. {
  15003. "name": "sha",
  15004. "description": null,
  15005. "in": null,
  15006. "type": null,
  15007. "required": null,
  15008. "enum": null,
  15009. "allowNull": null,
  15010. "mapToData": null,
  15011. "validation": null,
  15012. "alias": "commit_sha",
  15013. "deprecated": true
  15014. }
  15015. ],
  15016. "responses": [
  15017. {
  15018. "code": 201,
  15019. "description": "response",
  15020. "examples": [
  15021. {
  15022. "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}"
  15023. }
  15024. ]
  15025. }
  15026. ],
  15027. "renamed": null
  15028. },
  15029. {
  15030. "name": "List pull requests associated with commit",
  15031. "scope": "repos",
  15032. "id": "listPullRequestsAssociatedWithCommit",
  15033. "method": "GET",
  15034. "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls",
  15035. "isDeprecated": false,
  15036. "description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests) endpoint.",
  15037. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/commits/#list-pull-requests-associated-with-commit",
  15038. "previews": [{ "name": "groot" }],
  15039. "headers": [
  15040. { "name": "accept", "value": "application/vnd.github.groot-preview+json" }
  15041. ],
  15042. "parameters": [
  15043. {
  15044. "name": "owner",
  15045. "description": "owner parameter",
  15046. "in": "PATH",
  15047. "type": "string",
  15048. "required": true,
  15049. "enum": null,
  15050. "allowNull": false,
  15051. "mapToData": null,
  15052. "validation": null,
  15053. "alias": null,
  15054. "deprecated": null
  15055. },
  15056. {
  15057. "name": "repo",
  15058. "description": "repo parameter",
  15059. "in": "PATH",
  15060. "type": "string",
  15061. "required": true,
  15062. "enum": null,
  15063. "allowNull": false,
  15064. "mapToData": null,
  15065. "validation": null,
  15066. "alias": null,
  15067. "deprecated": null
  15068. },
  15069. {
  15070. "name": "commit_sha",
  15071. "description": "commit_sha parameter",
  15072. "in": "PATH",
  15073. "type": "string",
  15074. "required": true,
  15075. "enum": null,
  15076. "allowNull": false,
  15077. "mapToData": null,
  15078. "validation": null,
  15079. "alias": null,
  15080. "deprecated": null
  15081. },
  15082. {
  15083. "name": "per_page",
  15084. "description": "Results per page (max 100)",
  15085. "in": "QUERY",
  15086. "type": "integer",
  15087. "required": false,
  15088. "enum": null,
  15089. "allowNull": false,
  15090. "mapToData": null,
  15091. "validation": null,
  15092. "alias": null,
  15093. "deprecated": null
  15094. },
  15095. {
  15096. "name": "page",
  15097. "description": "Page number of the results to fetch.",
  15098. "in": "QUERY",
  15099. "type": "integer",
  15100. "required": false,
  15101. "enum": null,
  15102. "allowNull": false,
  15103. "mapToData": null,
  15104. "validation": null,
  15105. "alias": null,
  15106. "deprecated": null
  15107. }
  15108. ],
  15109. "responses": [
  15110. {
  15111. "code": 200,
  15112. "description": "response",
  15113. "examples": [
  15114. {
  15115. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]"
  15116. }
  15117. ]
  15118. }
  15119. ],
  15120. "renamed": null
  15121. },
  15122. {
  15123. "name": "Get a single commit",
  15124. "scope": "repos",
  15125. "id": "getCommit",
  15126. "method": "GET",
  15127. "url": "/repos/{owner}/{repo}/commits/{ref}",
  15128. "isDeprecated": false,
  15129. "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\nYou can pass the appropriate [media type](https://developer.github.com/enterprise/2.17/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/enterprise/2.17/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |\n\n",
  15130. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/commits/#get-a-single-commit",
  15131. "previews": [],
  15132. "headers": [],
  15133. "parameters": [
  15134. {
  15135. "name": "owner",
  15136. "description": "owner parameter",
  15137. "in": "PATH",
  15138. "type": "string",
  15139. "required": true,
  15140. "enum": null,
  15141. "allowNull": false,
  15142. "mapToData": null,
  15143. "validation": null,
  15144. "alias": null,
  15145. "deprecated": null
  15146. },
  15147. {
  15148. "name": "repo",
  15149. "description": "repo parameter",
  15150. "in": "PATH",
  15151. "type": "string",
  15152. "required": true,
  15153. "enum": null,
  15154. "allowNull": false,
  15155. "mapToData": null,
  15156. "validation": null,
  15157. "alias": null,
  15158. "deprecated": null
  15159. },
  15160. {
  15161. "name": "ref",
  15162. "description": "ref parameter",
  15163. "in": "PATH",
  15164. "type": "string",
  15165. "required": true,
  15166. "enum": null,
  15167. "allowNull": false,
  15168. "mapToData": null,
  15169. "validation": null,
  15170. "alias": null,
  15171. "deprecated": null
  15172. },
  15173. {
  15174. "name": "sha",
  15175. "description": null,
  15176. "in": null,
  15177. "type": null,
  15178. "required": null,
  15179. "enum": null,
  15180. "allowNull": null,
  15181. "mapToData": null,
  15182. "validation": null,
  15183. "alias": "ref",
  15184. "deprecated": true
  15185. },
  15186. {
  15187. "name": "commit_sha",
  15188. "description": null,
  15189. "in": null,
  15190. "type": null,
  15191. "required": null,
  15192. "enum": null,
  15193. "allowNull": null,
  15194. "mapToData": null,
  15195. "validation": null,
  15196. "alias": "ref",
  15197. "deprecated": true
  15198. }
  15199. ],
  15200. "responses": [
  15201. {
  15202. "code": 200,
  15203. "description": "response",
  15204. "examples": [
  15205. {
  15206. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}"
  15207. }
  15208. ]
  15209. }
  15210. ],
  15211. "renamed": null
  15212. },
  15213. {
  15214. "name": "List check runs for a specific ref",
  15215. "scope": "checks",
  15216. "id": "listForRef",
  15217. "method": "GET",
  15218. "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs",
  15219. "isDeprecated": false,
  15220. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.",
  15221. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/runs/#list-check-runs-for-a-specific-ref",
  15222. "previews": [{ "name": "antiope" }],
  15223. "headers": [
  15224. {
  15225. "name": "accept",
  15226. "value": "application/vnd.github.antiope-preview+json"
  15227. }
  15228. ],
  15229. "parameters": [
  15230. {
  15231. "name": "owner",
  15232. "description": "owner parameter",
  15233. "in": "PATH",
  15234. "type": "string",
  15235. "required": true,
  15236. "enum": null,
  15237. "allowNull": false,
  15238. "mapToData": null,
  15239. "validation": null,
  15240. "alias": null,
  15241. "deprecated": null
  15242. },
  15243. {
  15244. "name": "repo",
  15245. "description": "repo parameter",
  15246. "in": "PATH",
  15247. "type": "string",
  15248. "required": true,
  15249. "enum": null,
  15250. "allowNull": false,
  15251. "mapToData": null,
  15252. "validation": null,
  15253. "alias": null,
  15254. "deprecated": null
  15255. },
  15256. {
  15257. "name": "ref",
  15258. "description": "ref parameter",
  15259. "in": "PATH",
  15260. "type": "string",
  15261. "required": true,
  15262. "enum": null,
  15263. "allowNull": false,
  15264. "mapToData": null,
  15265. "validation": null,
  15266. "alias": null,
  15267. "deprecated": null
  15268. },
  15269. {
  15270. "name": "check_name",
  15271. "description": "Returns check runs with the specified `name`.",
  15272. "in": "QUERY",
  15273. "type": "string",
  15274. "required": false,
  15275. "enum": null,
  15276. "allowNull": false,
  15277. "mapToData": null,
  15278. "validation": null,
  15279. "alias": null,
  15280. "deprecated": null
  15281. },
  15282. {
  15283. "name": "status",
  15284. "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.",
  15285. "in": "QUERY",
  15286. "type": "string",
  15287. "required": false,
  15288. "enum": ["queued", "in_progress", "completed"],
  15289. "allowNull": false,
  15290. "mapToData": null,
  15291. "validation": null,
  15292. "alias": null,
  15293. "deprecated": null
  15294. },
  15295. {
  15296. "name": "filter",
  15297. "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.",
  15298. "in": "QUERY",
  15299. "type": "string",
  15300. "required": false,
  15301. "enum": ["latest", "all"],
  15302. "allowNull": false,
  15303. "mapToData": null,
  15304. "validation": null,
  15305. "alias": null,
  15306. "deprecated": null
  15307. },
  15308. {
  15309. "name": "per_page",
  15310. "description": "Results per page (max 100)",
  15311. "in": "QUERY",
  15312. "type": "integer",
  15313. "required": false,
  15314. "enum": null,
  15315. "allowNull": false,
  15316. "mapToData": null,
  15317. "validation": null,
  15318. "alias": null,
  15319. "deprecated": null
  15320. },
  15321. {
  15322. "name": "page",
  15323. "description": "Page number of the results to fetch.",
  15324. "in": "QUERY",
  15325. "type": "integer",
  15326. "required": false,
  15327. "enum": null,
  15328. "allowNull": false,
  15329. "mapToData": null,
  15330. "validation": null,
  15331. "alias": null,
  15332. "deprecated": null
  15333. }
  15334. ],
  15335. "responses": [
  15336. {
  15337. "code": 200,
  15338. "description": "response",
  15339. "examples": [
  15340. {
  15341. "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}"
  15342. }
  15343. ]
  15344. }
  15345. ],
  15346. "renamed": null
  15347. },
  15348. {
  15349. "name": "List check suites for a specific ref",
  15350. "scope": "checks",
  15351. "id": "listSuitesForRef",
  15352. "method": "GET",
  15353. "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites",
  15354. "isDeprecated": false,
  15355. "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.",
  15356. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/checks/suites/#list-check-suites-for-a-specific-ref",
  15357. "previews": [{ "name": "antiope" }],
  15358. "headers": [
  15359. {
  15360. "name": "accept",
  15361. "value": "application/vnd.github.antiope-preview+json"
  15362. }
  15363. ],
  15364. "parameters": [
  15365. {
  15366. "name": "owner",
  15367. "description": "owner parameter",
  15368. "in": "PATH",
  15369. "type": "string",
  15370. "required": true,
  15371. "enum": null,
  15372. "allowNull": false,
  15373. "mapToData": null,
  15374. "validation": null,
  15375. "alias": null,
  15376. "deprecated": null
  15377. },
  15378. {
  15379. "name": "repo",
  15380. "description": "repo parameter",
  15381. "in": "PATH",
  15382. "type": "string",
  15383. "required": true,
  15384. "enum": null,
  15385. "allowNull": false,
  15386. "mapToData": null,
  15387. "validation": null,
  15388. "alias": null,
  15389. "deprecated": null
  15390. },
  15391. {
  15392. "name": "ref",
  15393. "description": "ref parameter",
  15394. "in": "PATH",
  15395. "type": "string",
  15396. "required": true,
  15397. "enum": null,
  15398. "allowNull": false,
  15399. "mapToData": null,
  15400. "validation": null,
  15401. "alias": null,
  15402. "deprecated": null
  15403. },
  15404. {
  15405. "name": "app_id",
  15406. "description": "Filters check suites by GitHub App `id`.",
  15407. "in": "QUERY",
  15408. "type": "integer",
  15409. "required": false,
  15410. "enum": null,
  15411. "allowNull": false,
  15412. "mapToData": null,
  15413. "validation": null,
  15414. "alias": null,
  15415. "deprecated": null
  15416. },
  15417. {
  15418. "name": "check_name",
  15419. "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.17/v3/checks/runs/).",
  15420. "in": "QUERY",
  15421. "type": "string",
  15422. "required": false,
  15423. "enum": null,
  15424. "allowNull": false,
  15425. "mapToData": null,
  15426. "validation": null,
  15427. "alias": null,
  15428. "deprecated": null
  15429. },
  15430. {
  15431. "name": "per_page",
  15432. "description": "Results per page (max 100)",
  15433. "in": "QUERY",
  15434. "type": "integer",
  15435. "required": false,
  15436. "enum": null,
  15437. "allowNull": false,
  15438. "mapToData": null,
  15439. "validation": null,
  15440. "alias": null,
  15441. "deprecated": null
  15442. },
  15443. {
  15444. "name": "page",
  15445. "description": "Page number of the results to fetch.",
  15446. "in": "QUERY",
  15447. "type": "integer",
  15448. "required": false,
  15449. "enum": null,
  15450. "allowNull": false,
  15451. "mapToData": null,
  15452. "validation": null,
  15453. "alias": null,
  15454. "deprecated": null
  15455. }
  15456. ],
  15457. "responses": [
  15458. {
  15459. "code": 200,
  15460. "description": "response",
  15461. "examples": [
  15462. {
  15463. "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}]}"
  15464. }
  15465. ]
  15466. }
  15467. ],
  15468. "renamed": null
  15469. },
  15470. {
  15471. "name": "Get the combined status for a specific ref",
  15472. "scope": "repos",
  15473. "id": "getCombinedStatusForRef",
  15474. "method": "GET",
  15475. "url": "/repos/{owner}/{repo}/commits/{ref}/status",
  15476. "isDeprecated": false,
  15477. "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://developer.github.com/enterprise/2.17/v3/#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`",
  15478. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref",
  15479. "previews": [],
  15480. "headers": [],
  15481. "parameters": [
  15482. {
  15483. "name": "owner",
  15484. "description": "owner parameter",
  15485. "in": "PATH",
  15486. "type": "string",
  15487. "required": true,
  15488. "enum": null,
  15489. "allowNull": false,
  15490. "mapToData": null,
  15491. "validation": null,
  15492. "alias": null,
  15493. "deprecated": null
  15494. },
  15495. {
  15496. "name": "repo",
  15497. "description": "repo parameter",
  15498. "in": "PATH",
  15499. "type": "string",
  15500. "required": true,
  15501. "enum": null,
  15502. "allowNull": false,
  15503. "mapToData": null,
  15504. "validation": null,
  15505. "alias": null,
  15506. "deprecated": null
  15507. },
  15508. {
  15509. "name": "ref",
  15510. "description": "ref parameter",
  15511. "in": "PATH",
  15512. "type": "string",
  15513. "required": true,
  15514. "enum": null,
  15515. "allowNull": false,
  15516. "mapToData": null,
  15517. "validation": null,
  15518. "alias": null,
  15519. "deprecated": null
  15520. }
  15521. ],
  15522. "responses": [
  15523. {
  15524. "code": 200,
  15525. "description": "response",
  15526. "examples": [
  15527. {
  15528. "data": "{\"state\":\"success\",\"statuses\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\"},{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"id\":2,\"node_id\":\"MDY6U3RhdHVzMg==\",\"state\":\"success\",\"description\":\"Testing has completed successfully\",\"target_url\":\"https://ci.example.com/2000/output\",\"context\":\"security/brakeman\",\"created_at\":\"2012-08-20T01:19:13Z\",\"updated_at\":\"2012-08-20T01:19:13Z\"}],\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"total_count\":2,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"}"
  15529. }
  15530. ]
  15531. }
  15532. ],
  15533. "renamed": null
  15534. },
  15535. {
  15536. "name": "List statuses for a specific ref",
  15537. "scope": "repos",
  15538. "id": "listStatusesForRef",
  15539. "method": "GET",
  15540. "url": "/repos/{owner}/{repo}/commits/{ref}/statuses",
  15541. "isDeprecated": false,
  15542. "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.",
  15543. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statuses/#list-statuses-for-a-specific-ref",
  15544. "previews": [],
  15545. "headers": [],
  15546. "parameters": [
  15547. {
  15548. "name": "owner",
  15549. "description": "owner parameter",
  15550. "in": "PATH",
  15551. "type": "string",
  15552. "required": true,
  15553. "enum": null,
  15554. "allowNull": false,
  15555. "mapToData": null,
  15556. "validation": null,
  15557. "alias": null,
  15558. "deprecated": null
  15559. },
  15560. {
  15561. "name": "repo",
  15562. "description": "repo parameter",
  15563. "in": "PATH",
  15564. "type": "string",
  15565. "required": true,
  15566. "enum": null,
  15567. "allowNull": false,
  15568. "mapToData": null,
  15569. "validation": null,
  15570. "alias": null,
  15571. "deprecated": null
  15572. },
  15573. {
  15574. "name": "ref",
  15575. "description": "ref parameter",
  15576. "in": "PATH",
  15577. "type": "string",
  15578. "required": true,
  15579. "enum": null,
  15580. "allowNull": false,
  15581. "mapToData": null,
  15582. "validation": null,
  15583. "alias": null,
  15584. "deprecated": null
  15585. },
  15586. {
  15587. "name": "per_page",
  15588. "description": "Results per page (max 100)",
  15589. "in": "QUERY",
  15590. "type": "integer",
  15591. "required": false,
  15592. "enum": null,
  15593. "allowNull": false,
  15594. "mapToData": null,
  15595. "validation": null,
  15596. "alias": null,
  15597. "deprecated": null
  15598. },
  15599. {
  15600. "name": "page",
  15601. "description": "Page number of the results to fetch.",
  15602. "in": "QUERY",
  15603. "type": "integer",
  15604. "required": false,
  15605. "enum": null,
  15606. "allowNull": false,
  15607. "mapToData": null,
  15608. "validation": null,
  15609. "alias": null,
  15610. "deprecated": null
  15611. }
  15612. ],
  15613. "responses": [
  15614. {
  15615. "code": 200,
  15616. "description": "response",
  15617. "examples": [
  15618. {
  15619. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]"
  15620. }
  15621. ]
  15622. }
  15623. ],
  15624. "renamed": null
  15625. },
  15626. {
  15627. "name": "Get the contents of a repository's code of conduct",
  15628. "scope": "codesOfConduct",
  15629. "id": "getForRepo",
  15630. "method": "GET",
  15631. "url": "/repos/{owner}/{repo}/community/code_of_conduct",
  15632. "isDeprecated": false,
  15633. "description": "This method returns the contents of the repository's code of conduct file, if one is detected.",
  15634. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct",
  15635. "previews": [{ "name": "scarlet-witch" }],
  15636. "headers": [
  15637. {
  15638. "name": "accept",
  15639. "value": "application/vnd.github.scarlet-witch-preview+json"
  15640. }
  15641. ],
  15642. "parameters": [
  15643. {
  15644. "name": "owner",
  15645. "description": "owner parameter",
  15646. "in": "PATH",
  15647. "type": "string",
  15648. "required": true,
  15649. "enum": null,
  15650. "allowNull": false,
  15651. "mapToData": null,
  15652. "validation": null,
  15653. "alias": null,
  15654. "deprecated": null
  15655. },
  15656. {
  15657. "name": "repo",
  15658. "description": "repo parameter",
  15659. "in": "PATH",
  15660. "type": "string",
  15661. "required": true,
  15662. "enum": null,
  15663. "allowNull": false,
  15664. "mapToData": null,
  15665. "validation": null,
  15666. "alias": null,
  15667. "deprecated": null
  15668. }
  15669. ],
  15670. "responses": [
  15671. {
  15672. "code": 200,
  15673. "description": "response",
  15674. "examples": [
  15675. {
  15676. "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include=>\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include=>\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\"}"
  15677. }
  15678. ]
  15679. }
  15680. ],
  15681. "renamed": null
  15682. },
  15683. {
  15684. "name": "Compare two commits",
  15685. "scope": "repos",
  15686. "id": "compareCommits",
  15687. "method": "GET",
  15688. "url": "/repos/{owner}/{repo}/compare/{base}...{head}",
  15689. "isDeprecated": false,
  15690. "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `<USERNAME>:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/enterprise/2.17/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [Commit List API](https://developer.github.com/enterprise/2.17/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
  15691. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/commits/#compare-two-commits",
  15692. "previews": [],
  15693. "headers": [],
  15694. "parameters": [
  15695. {
  15696. "name": "owner",
  15697. "description": "owner parameter",
  15698. "in": "PATH",
  15699. "type": "string",
  15700. "required": true,
  15701. "enum": null,
  15702. "allowNull": false,
  15703. "mapToData": null,
  15704. "validation": null,
  15705. "alias": null,
  15706. "deprecated": null
  15707. },
  15708. {
  15709. "name": "repo",
  15710. "description": "repo parameter",
  15711. "in": "PATH",
  15712. "type": "string",
  15713. "required": true,
  15714. "enum": null,
  15715. "allowNull": false,
  15716. "mapToData": null,
  15717. "validation": null,
  15718. "alias": null,
  15719. "deprecated": null
  15720. },
  15721. {
  15722. "name": "base",
  15723. "description": "base parameter",
  15724. "in": "PATH",
  15725. "type": "string",
  15726. "required": true,
  15727. "enum": null,
  15728. "allowNull": false,
  15729. "mapToData": null,
  15730. "validation": null,
  15731. "alias": null,
  15732. "deprecated": null
  15733. },
  15734. {
  15735. "name": "head",
  15736. "description": "head parameter",
  15737. "in": "PATH",
  15738. "type": "string",
  15739. "required": true,
  15740. "enum": null,
  15741. "allowNull": false,
  15742. "mapToData": null,
  15743. "validation": null,
  15744. "alias": null,
  15745. "deprecated": null
  15746. }
  15747. ],
  15748. "responses": [
  15749. {
  15750. "code": 200,
  15751. "description": "response",
  15752. "examples": [
  15753. {
  15754. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}"
  15755. }
  15756. ]
  15757. }
  15758. ],
  15759. "renamed": null
  15760. },
  15761. {
  15762. "name": "Get contents",
  15763. "scope": "repos",
  15764. "id": "getContents",
  15765. "method": "GET",
  15766. "url": "/repos/{owner}/{repo}/contents/{path}",
  15767. "isDeprecated": false,
  15768. "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of all files in the repository.\n\nFiles and symlinks support [a custom media type](https://developer.github.com/enterprise/2.17/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media type](https://developer.github.com/enterprise/2.17/v3/repos/contents/#custom-media-types) to ensure the content is returned in a consistent object format.\n\n**Note**:\n\n* To get a repository's contents recursively, you can [recursively get the tree](https://developer.github.com/enterprise/2.17/v3/git/trees/).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://developer.github.com/enterprise/2.17/v3/git/trees/#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\nThe response will be an array of objects, one object for each item in the directory.\n\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](https://developer.github.com/enterprise/2.17/v3/repos/contents/#response-if-content-is-a-file)).\n\nOtherwise, the API responds with an object describing the symlink itself:\n\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.",
  15769. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#get-contents",
  15770. "previews": [],
  15771. "headers": [],
  15772. "parameters": [
  15773. {
  15774. "name": "owner",
  15775. "description": "owner parameter",
  15776. "in": "PATH",
  15777. "type": "string",
  15778. "required": true,
  15779. "enum": null,
  15780. "allowNull": false,
  15781. "mapToData": null,
  15782. "validation": null,
  15783. "alias": null,
  15784. "deprecated": null
  15785. },
  15786. {
  15787. "name": "repo",
  15788. "description": "repo parameter",
  15789. "in": "PATH",
  15790. "type": "string",
  15791. "required": true,
  15792. "enum": null,
  15793. "allowNull": false,
  15794. "mapToData": null,
  15795. "validation": null,
  15796. "alias": null,
  15797. "deprecated": null
  15798. },
  15799. {
  15800. "name": "path",
  15801. "description": "path parameter",
  15802. "in": "PATH",
  15803. "type": "string",
  15804. "required": true,
  15805. "enum": null,
  15806. "allowNull": false,
  15807. "mapToData": null,
  15808. "validation": null,
  15809. "alias": null,
  15810. "deprecated": null
  15811. },
  15812. {
  15813. "name": "ref",
  15814. "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
  15815. "in": "QUERY",
  15816. "type": "string",
  15817. "required": false,
  15818. "enum": null,
  15819. "allowNull": false,
  15820. "mapToData": null,
  15821. "validation": null,
  15822. "alias": null,
  15823. "deprecated": null
  15824. }
  15825. ],
  15826. "responses": [
  15827. {
  15828. "code": 200,
  15829. "description": "response",
  15830. "examples": [
  15831. {
  15832. "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}"
  15833. },
  15834. {
  15835. "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]"
  15836. },
  15837. {
  15838. "data": "{\"type\":\"symlink\",\"target\":\"/path/to/symlink/target\",\"size\":23,\"name\":\"some-symlink\",\"path\":\"bin/some-symlink\",\"sha\":\"452a98979c88e093d682cab404a3ec82babebb48\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"}}"
  15839. },
  15840. {
  15841. "data": "{\"type\":\"submodule\",\"submodule_git_url\":\"git://github.com/jquery/qunit.git\",\"size\":0,\"name\":\"qunit\",\"path\":\"test/qunit\",\"sha\":\"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"url\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"git_url\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"html_url\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"download_url\":null,\"_links\":{\"git\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"self\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"html\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"}}"
  15842. }
  15843. ]
  15844. }
  15845. ],
  15846. "renamed": null
  15847. },
  15848. {
  15849. "name": "Create or update a file",
  15850. "scope": "repos",
  15851. "id": "createOrUpdateFile",
  15852. "method": "PUT",
  15853. "url": "/repos/{owner}/{repo}/contents/{path}",
  15854. "isDeprecated": false,
  15855. "description": "Creates a new file or updates an existing file in a repository.",
  15856. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#create-or-update-a-file",
  15857. "previews": [],
  15858. "headers": [],
  15859. "parameters": [
  15860. {
  15861. "name": "owner",
  15862. "description": "owner parameter",
  15863. "in": "PATH",
  15864. "type": "string",
  15865. "required": true,
  15866. "enum": null,
  15867. "allowNull": false,
  15868. "mapToData": null,
  15869. "validation": null,
  15870. "alias": null,
  15871. "deprecated": null
  15872. },
  15873. {
  15874. "name": "repo",
  15875. "description": "repo parameter",
  15876. "in": "PATH",
  15877. "type": "string",
  15878. "required": true,
  15879. "enum": null,
  15880. "allowNull": false,
  15881. "mapToData": null,
  15882. "validation": null,
  15883. "alias": null,
  15884. "deprecated": null
  15885. },
  15886. {
  15887. "name": "path",
  15888. "description": "path parameter",
  15889. "in": "PATH",
  15890. "type": "string",
  15891. "required": true,
  15892. "enum": null,
  15893. "allowNull": false,
  15894. "mapToData": null,
  15895. "validation": null,
  15896. "alias": null,
  15897. "deprecated": null
  15898. },
  15899. {
  15900. "name": "message",
  15901. "description": "The commit message.",
  15902. "in": "BODY",
  15903. "type": "string",
  15904. "required": true,
  15905. "enum": null,
  15906. "allowNull": false,
  15907. "mapToData": null,
  15908. "validation": null,
  15909. "alias": null,
  15910. "deprecated": null
  15911. },
  15912. {
  15913. "name": "content",
  15914. "description": "The new file content, using Base64 encoding.",
  15915. "in": "BODY",
  15916. "type": "string",
  15917. "required": true,
  15918. "enum": null,
  15919. "allowNull": false,
  15920. "mapToData": null,
  15921. "validation": null,
  15922. "alias": null,
  15923. "deprecated": null
  15924. },
  15925. {
  15926. "name": "sha",
  15927. "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
  15928. "in": "BODY",
  15929. "type": "string",
  15930. "required": false,
  15931. "enum": null,
  15932. "allowNull": false,
  15933. "mapToData": null,
  15934. "validation": null,
  15935. "alias": null,
  15936. "deprecated": null
  15937. },
  15938. {
  15939. "name": "branch",
  15940. "description": "The branch name. Default: the repository’s default branch (usually `master`)",
  15941. "in": "BODY",
  15942. "type": "string",
  15943. "required": false,
  15944. "enum": null,
  15945. "allowNull": false,
  15946. "mapToData": null,
  15947. "validation": null,
  15948. "alias": null,
  15949. "deprecated": null
  15950. },
  15951. {
  15952. "name": "committer",
  15953. "description": "The person that committed the file. Default: the authenticated user.",
  15954. "in": "BODY",
  15955. "type": "object",
  15956. "required": false,
  15957. "enum": null,
  15958. "allowNull": false,
  15959. "mapToData": null,
  15960. "validation": null,
  15961. "alias": null,
  15962. "deprecated": null
  15963. },
  15964. {
  15965. "name": "committer.name",
  15966. "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
  15967. "in": "BODY",
  15968. "type": "string",
  15969. "required": true,
  15970. "enum": null,
  15971. "allowNull": false,
  15972. "mapToData": null,
  15973. "validation": null,
  15974. "alias": null,
  15975. "deprecated": null
  15976. },
  15977. {
  15978. "name": "committer.email",
  15979. "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
  15980. "in": "BODY",
  15981. "type": "string",
  15982. "required": true,
  15983. "enum": null,
  15984. "allowNull": false,
  15985. "mapToData": null,
  15986. "validation": null,
  15987. "alias": null,
  15988. "deprecated": null
  15989. },
  15990. {
  15991. "name": "author",
  15992. "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
  15993. "in": "BODY",
  15994. "type": "object",
  15995. "required": false,
  15996. "enum": null,
  15997. "allowNull": false,
  15998. "mapToData": null,
  15999. "validation": null,
  16000. "alias": null,
  16001. "deprecated": null
  16002. },
  16003. {
  16004. "name": "author.name",
  16005. "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
  16006. "in": "BODY",
  16007. "type": "string",
  16008. "required": true,
  16009. "enum": null,
  16010. "allowNull": false,
  16011. "mapToData": null,
  16012. "validation": null,
  16013. "alias": null,
  16014. "deprecated": null
  16015. },
  16016. {
  16017. "name": "author.email",
  16018. "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
  16019. "in": "BODY",
  16020. "type": "string",
  16021. "required": true,
  16022. "enum": null,
  16023. "allowNull": false,
  16024. "mapToData": null,
  16025. "validation": null,
  16026. "alias": null,
  16027. "deprecated": null
  16028. }
  16029. ],
  16030. "responses": [
  16031. {
  16032. "code": 200,
  16033. "description": "response",
  16034. "examples": [
  16035. {
  16036. "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16037. }
  16038. ]
  16039. },
  16040. {
  16041. "code": 201,
  16042. "description": "response",
  16043. "examples": [
  16044. {
  16045. "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16046. }
  16047. ]
  16048. }
  16049. ],
  16050. "renamed": null
  16051. },
  16052. {
  16053. "name": "Create or update a file",
  16054. "scope": "repos",
  16055. "id": "createFile",
  16056. "method": "PUT",
  16057. "url": "/repos/{owner}/{repo}/contents/{path}",
  16058. "isDeprecated": false,
  16059. "description": "Creates a new file or updates an existing file in a repository.",
  16060. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#create-or-update-a-file",
  16061. "previews": [],
  16062. "headers": [],
  16063. "parameters": [
  16064. {
  16065. "name": "owner",
  16066. "description": "owner parameter",
  16067. "in": "PATH",
  16068. "type": "string",
  16069. "required": true,
  16070. "enum": null,
  16071. "allowNull": false,
  16072. "mapToData": null,
  16073. "validation": null,
  16074. "alias": null,
  16075. "deprecated": null
  16076. },
  16077. {
  16078. "name": "repo",
  16079. "description": "repo parameter",
  16080. "in": "PATH",
  16081. "type": "string",
  16082. "required": true,
  16083. "enum": null,
  16084. "allowNull": false,
  16085. "mapToData": null,
  16086. "validation": null,
  16087. "alias": null,
  16088. "deprecated": null
  16089. },
  16090. {
  16091. "name": "path",
  16092. "description": "path parameter",
  16093. "in": "PATH",
  16094. "type": "string",
  16095. "required": true,
  16096. "enum": null,
  16097. "allowNull": false,
  16098. "mapToData": null,
  16099. "validation": null,
  16100. "alias": null,
  16101. "deprecated": null
  16102. },
  16103. {
  16104. "name": "message",
  16105. "description": "The commit message.",
  16106. "in": "BODY",
  16107. "type": "string",
  16108. "required": true,
  16109. "enum": null,
  16110. "allowNull": false,
  16111. "mapToData": null,
  16112. "validation": null,
  16113. "alias": null,
  16114. "deprecated": null
  16115. },
  16116. {
  16117. "name": "content",
  16118. "description": "The new file content, using Base64 encoding.",
  16119. "in": "BODY",
  16120. "type": "string",
  16121. "required": true,
  16122. "enum": null,
  16123. "allowNull": false,
  16124. "mapToData": null,
  16125. "validation": null,
  16126. "alias": null,
  16127. "deprecated": null
  16128. },
  16129. {
  16130. "name": "sha",
  16131. "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
  16132. "in": "BODY",
  16133. "type": "string",
  16134. "required": false,
  16135. "enum": null,
  16136. "allowNull": false,
  16137. "mapToData": null,
  16138. "validation": null,
  16139. "alias": null,
  16140. "deprecated": null
  16141. },
  16142. {
  16143. "name": "branch",
  16144. "description": "The branch name. Default: the repository’s default branch (usually `master`)",
  16145. "in": "BODY",
  16146. "type": "string",
  16147. "required": false,
  16148. "enum": null,
  16149. "allowNull": false,
  16150. "mapToData": null,
  16151. "validation": null,
  16152. "alias": null,
  16153. "deprecated": null
  16154. },
  16155. {
  16156. "name": "committer",
  16157. "description": "The person that committed the file. Default: the authenticated user.",
  16158. "in": "BODY",
  16159. "type": "object",
  16160. "required": false,
  16161. "enum": null,
  16162. "allowNull": false,
  16163. "mapToData": null,
  16164. "validation": null,
  16165. "alias": null,
  16166. "deprecated": null
  16167. },
  16168. {
  16169. "name": "committer.name",
  16170. "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
  16171. "in": "BODY",
  16172. "type": "string",
  16173. "required": true,
  16174. "enum": null,
  16175. "allowNull": false,
  16176. "mapToData": null,
  16177. "validation": null,
  16178. "alias": null,
  16179. "deprecated": null
  16180. },
  16181. {
  16182. "name": "committer.email",
  16183. "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
  16184. "in": "BODY",
  16185. "type": "string",
  16186. "required": true,
  16187. "enum": null,
  16188. "allowNull": false,
  16189. "mapToData": null,
  16190. "validation": null,
  16191. "alias": null,
  16192. "deprecated": null
  16193. },
  16194. {
  16195. "name": "author",
  16196. "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
  16197. "in": "BODY",
  16198. "type": "object",
  16199. "required": false,
  16200. "enum": null,
  16201. "allowNull": false,
  16202. "mapToData": null,
  16203. "validation": null,
  16204. "alias": null,
  16205. "deprecated": null
  16206. },
  16207. {
  16208. "name": "author.name",
  16209. "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
  16210. "in": "BODY",
  16211. "type": "string",
  16212. "required": true,
  16213. "enum": null,
  16214. "allowNull": false,
  16215. "mapToData": null,
  16216. "validation": null,
  16217. "alias": null,
  16218. "deprecated": null
  16219. },
  16220. {
  16221. "name": "author.email",
  16222. "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
  16223. "in": "BODY",
  16224. "type": "string",
  16225. "required": true,
  16226. "enum": null,
  16227. "allowNull": false,
  16228. "mapToData": null,
  16229. "validation": null,
  16230. "alias": null,
  16231. "deprecated": null
  16232. }
  16233. ],
  16234. "responses": [
  16235. {
  16236. "code": 200,
  16237. "description": "response",
  16238. "examples": [
  16239. {
  16240. "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16241. }
  16242. ]
  16243. },
  16244. {
  16245. "code": 201,
  16246. "description": "response",
  16247. "examples": [
  16248. {
  16249. "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16250. }
  16251. ]
  16252. }
  16253. ],
  16254. "renamed": {
  16255. "before": { "scope": "repos", "id": "createFile" },
  16256. "after": { "scope": "repos", "id": "createOrUpdateFile" },
  16257. "date": "2019-06-07",
  16258. "note": "\"Create a file\" replaced by \"Create or update a file\""
  16259. }
  16260. },
  16261. {
  16262. "name": "Create or update a file",
  16263. "scope": "repos",
  16264. "id": "updateFile",
  16265. "method": "PUT",
  16266. "url": "/repos/{owner}/{repo}/contents/{path}",
  16267. "isDeprecated": false,
  16268. "description": "Creates a new file or updates an existing file in a repository.",
  16269. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#create-or-update-a-file",
  16270. "previews": [],
  16271. "headers": [],
  16272. "parameters": [
  16273. {
  16274. "name": "owner",
  16275. "description": "owner parameter",
  16276. "in": "PATH",
  16277. "type": "string",
  16278. "required": true,
  16279. "enum": null,
  16280. "allowNull": false,
  16281. "mapToData": null,
  16282. "validation": null,
  16283. "alias": null,
  16284. "deprecated": null
  16285. },
  16286. {
  16287. "name": "repo",
  16288. "description": "repo parameter",
  16289. "in": "PATH",
  16290. "type": "string",
  16291. "required": true,
  16292. "enum": null,
  16293. "allowNull": false,
  16294. "mapToData": null,
  16295. "validation": null,
  16296. "alias": null,
  16297. "deprecated": null
  16298. },
  16299. {
  16300. "name": "path",
  16301. "description": "path parameter",
  16302. "in": "PATH",
  16303. "type": "string",
  16304. "required": true,
  16305. "enum": null,
  16306. "allowNull": false,
  16307. "mapToData": null,
  16308. "validation": null,
  16309. "alias": null,
  16310. "deprecated": null
  16311. },
  16312. {
  16313. "name": "message",
  16314. "description": "The commit message.",
  16315. "in": "BODY",
  16316. "type": "string",
  16317. "required": true,
  16318. "enum": null,
  16319. "allowNull": false,
  16320. "mapToData": null,
  16321. "validation": null,
  16322. "alias": null,
  16323. "deprecated": null
  16324. },
  16325. {
  16326. "name": "content",
  16327. "description": "The new file content, using Base64 encoding.",
  16328. "in": "BODY",
  16329. "type": "string",
  16330. "required": true,
  16331. "enum": null,
  16332. "allowNull": false,
  16333. "mapToData": null,
  16334. "validation": null,
  16335. "alias": null,
  16336. "deprecated": null
  16337. },
  16338. {
  16339. "name": "sha",
  16340. "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.",
  16341. "in": "BODY",
  16342. "type": "string",
  16343. "required": false,
  16344. "enum": null,
  16345. "allowNull": false,
  16346. "mapToData": null,
  16347. "validation": null,
  16348. "alias": null,
  16349. "deprecated": null
  16350. },
  16351. {
  16352. "name": "branch",
  16353. "description": "The branch name. Default: the repository’s default branch (usually `master`)",
  16354. "in": "BODY",
  16355. "type": "string",
  16356. "required": false,
  16357. "enum": null,
  16358. "allowNull": false,
  16359. "mapToData": null,
  16360. "validation": null,
  16361. "alias": null,
  16362. "deprecated": null
  16363. },
  16364. {
  16365. "name": "committer",
  16366. "description": "The person that committed the file. Default: the authenticated user.",
  16367. "in": "BODY",
  16368. "type": "object",
  16369. "required": false,
  16370. "enum": null,
  16371. "allowNull": false,
  16372. "mapToData": null,
  16373. "validation": null,
  16374. "alias": null,
  16375. "deprecated": null
  16376. },
  16377. {
  16378. "name": "committer.name",
  16379. "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
  16380. "in": "BODY",
  16381. "type": "string",
  16382. "required": true,
  16383. "enum": null,
  16384. "allowNull": false,
  16385. "mapToData": null,
  16386. "validation": null,
  16387. "alias": null,
  16388. "deprecated": null
  16389. },
  16390. {
  16391. "name": "committer.email",
  16392. "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
  16393. "in": "BODY",
  16394. "type": "string",
  16395. "required": true,
  16396. "enum": null,
  16397. "allowNull": false,
  16398. "mapToData": null,
  16399. "validation": null,
  16400. "alias": null,
  16401. "deprecated": null
  16402. },
  16403. {
  16404. "name": "author",
  16405. "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.",
  16406. "in": "BODY",
  16407. "type": "object",
  16408. "required": false,
  16409. "enum": null,
  16410. "allowNull": false,
  16411. "mapToData": null,
  16412. "validation": null,
  16413. "alias": null,
  16414. "deprecated": null
  16415. },
  16416. {
  16417. "name": "author.name",
  16418. "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.",
  16419. "in": "BODY",
  16420. "type": "string",
  16421. "required": true,
  16422. "enum": null,
  16423. "allowNull": false,
  16424. "mapToData": null,
  16425. "validation": null,
  16426. "alias": null,
  16427. "deprecated": null
  16428. },
  16429. {
  16430. "name": "author.email",
  16431. "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.",
  16432. "in": "BODY",
  16433. "type": "string",
  16434. "required": true,
  16435. "enum": null,
  16436. "allowNull": false,
  16437. "mapToData": null,
  16438. "validation": null,
  16439. "alias": null,
  16440. "deprecated": null
  16441. }
  16442. ],
  16443. "responses": [
  16444. {
  16445. "code": 200,
  16446. "description": "response",
  16447. "examples": [
  16448. {
  16449. "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16450. }
  16451. ]
  16452. },
  16453. {
  16454. "code": 201,
  16455. "description": "response",
  16456. "examples": [
  16457. {
  16458. "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16459. }
  16460. ]
  16461. }
  16462. ],
  16463. "renamed": {
  16464. "before": { "scope": "repos", "id": "updateFile" },
  16465. "after": { "scope": "repos", "id": "createOrUpdateFile" },
  16466. "date": "2019-06-07",
  16467. "note": "\"Update a file\" replaced by \"Create or update a file\""
  16468. }
  16469. },
  16470. {
  16471. "name": "Delete a file",
  16472. "scope": "repos",
  16473. "id": "deleteFile",
  16474. "method": "DELETE",
  16475. "url": "/repos/{owner}/{repo}/contents/{path}",
  16476. "isDeprecated": false,
  16477. "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.",
  16478. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#delete-a-file",
  16479. "previews": [],
  16480. "headers": [],
  16481. "parameters": [
  16482. {
  16483. "name": "owner",
  16484. "description": "owner parameter",
  16485. "in": "PATH",
  16486. "type": "string",
  16487. "required": true,
  16488. "enum": null,
  16489. "allowNull": false,
  16490. "mapToData": null,
  16491. "validation": null,
  16492. "alias": null,
  16493. "deprecated": null
  16494. },
  16495. {
  16496. "name": "repo",
  16497. "description": "repo parameter",
  16498. "in": "PATH",
  16499. "type": "string",
  16500. "required": true,
  16501. "enum": null,
  16502. "allowNull": false,
  16503. "mapToData": null,
  16504. "validation": null,
  16505. "alias": null,
  16506. "deprecated": null
  16507. },
  16508. {
  16509. "name": "path",
  16510. "description": "path parameter",
  16511. "in": "PATH",
  16512. "type": "string",
  16513. "required": true,
  16514. "enum": null,
  16515. "allowNull": false,
  16516. "mapToData": null,
  16517. "validation": null,
  16518. "alias": null,
  16519. "deprecated": null
  16520. },
  16521. {
  16522. "name": "message",
  16523. "description": "The commit message.",
  16524. "in": "BODY",
  16525. "type": "string",
  16526. "required": true,
  16527. "enum": null,
  16528. "allowNull": false,
  16529. "mapToData": null,
  16530. "validation": null,
  16531. "alias": null,
  16532. "deprecated": null
  16533. },
  16534. {
  16535. "name": "sha",
  16536. "description": "The blob SHA of the file being replaced.",
  16537. "in": "BODY",
  16538. "type": "string",
  16539. "required": true,
  16540. "enum": null,
  16541. "allowNull": false,
  16542. "mapToData": null,
  16543. "validation": null,
  16544. "alias": null,
  16545. "deprecated": null
  16546. },
  16547. {
  16548. "name": "branch",
  16549. "description": "The branch name. Default: the repository’s default branch (usually `master`)",
  16550. "in": "BODY",
  16551. "type": "string",
  16552. "required": false,
  16553. "enum": null,
  16554. "allowNull": false,
  16555. "mapToData": null,
  16556. "validation": null,
  16557. "alias": null,
  16558. "deprecated": null
  16559. },
  16560. {
  16561. "name": "committer",
  16562. "description": "object containing information about the committer.",
  16563. "in": "BODY",
  16564. "type": "object",
  16565. "required": false,
  16566. "enum": null,
  16567. "allowNull": false,
  16568. "mapToData": null,
  16569. "validation": null,
  16570. "alias": null,
  16571. "deprecated": null
  16572. },
  16573. {
  16574. "name": "committer.name",
  16575. "description": "The name of the author (or committer) of the commit",
  16576. "in": "BODY",
  16577. "type": "string",
  16578. "required": false,
  16579. "enum": null,
  16580. "allowNull": false,
  16581. "mapToData": null,
  16582. "validation": null,
  16583. "alias": null,
  16584. "deprecated": null
  16585. },
  16586. {
  16587. "name": "committer.email",
  16588. "description": "The email of the author (or committer) of the commit",
  16589. "in": "BODY",
  16590. "type": "string",
  16591. "required": false,
  16592. "enum": null,
  16593. "allowNull": false,
  16594. "mapToData": null,
  16595. "validation": null,
  16596. "alias": null,
  16597. "deprecated": null
  16598. },
  16599. {
  16600. "name": "author",
  16601. "description": "object containing information about the author.",
  16602. "in": "BODY",
  16603. "type": "object",
  16604. "required": false,
  16605. "enum": null,
  16606. "allowNull": false,
  16607. "mapToData": null,
  16608. "validation": null,
  16609. "alias": null,
  16610. "deprecated": null
  16611. },
  16612. {
  16613. "name": "author.name",
  16614. "description": "The name of the author (or committer) of the commit",
  16615. "in": "BODY",
  16616. "type": "string",
  16617. "required": false,
  16618. "enum": null,
  16619. "allowNull": false,
  16620. "mapToData": null,
  16621. "validation": null,
  16622. "alias": null,
  16623. "deprecated": null
  16624. },
  16625. {
  16626. "name": "author.email",
  16627. "description": "The email of the author (or committer) of the commit",
  16628. "in": "BODY",
  16629. "type": "string",
  16630. "required": false,
  16631. "enum": null,
  16632. "allowNull": false,
  16633. "mapToData": null,
  16634. "validation": null,
  16635. "alias": null,
  16636. "deprecated": null
  16637. }
  16638. ],
  16639. "responses": [
  16640. {
  16641. "code": 200,
  16642. "description": "response",
  16643. "examples": [
  16644. {
  16645. "data": "{\"content\":null,\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}"
  16646. }
  16647. ]
  16648. }
  16649. ],
  16650. "renamed": null
  16651. },
  16652. {
  16653. "name": "List contributors",
  16654. "scope": "repos",
  16655. "id": "listContributors",
  16656. "method": "GET",
  16657. "url": "/repos/{owner}/{repo}/contributors",
  16658. "isDeprecated": false,
  16659. "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.",
  16660. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-contributors",
  16661. "previews": [],
  16662. "headers": [],
  16663. "parameters": [
  16664. {
  16665. "name": "owner",
  16666. "description": "owner parameter",
  16667. "in": "PATH",
  16668. "type": "string",
  16669. "required": true,
  16670. "enum": null,
  16671. "allowNull": false,
  16672. "mapToData": null,
  16673. "validation": null,
  16674. "alias": null,
  16675. "deprecated": null
  16676. },
  16677. {
  16678. "name": "repo",
  16679. "description": "repo parameter",
  16680. "in": "PATH",
  16681. "type": "string",
  16682. "required": true,
  16683. "enum": null,
  16684. "allowNull": false,
  16685. "mapToData": null,
  16686. "validation": null,
  16687. "alias": null,
  16688. "deprecated": null
  16689. },
  16690. {
  16691. "name": "anon",
  16692. "description": "Set to `1` or `true` to include anonymous contributors in results.",
  16693. "in": "QUERY",
  16694. "type": "string",
  16695. "required": false,
  16696. "enum": null,
  16697. "allowNull": false,
  16698. "mapToData": null,
  16699. "validation": null,
  16700. "alias": null,
  16701. "deprecated": null
  16702. },
  16703. {
  16704. "name": "per_page",
  16705. "description": "Results per page (max 100)",
  16706. "in": "QUERY",
  16707. "type": "integer",
  16708. "required": false,
  16709. "enum": null,
  16710. "allowNull": false,
  16711. "mapToData": null,
  16712. "validation": null,
  16713. "alias": null,
  16714. "deprecated": null
  16715. },
  16716. {
  16717. "name": "page",
  16718. "description": "Page number of the results to fetch.",
  16719. "in": "QUERY",
  16720. "type": "integer",
  16721. "required": false,
  16722. "enum": null,
  16723. "allowNull": false,
  16724. "mapToData": null,
  16725. "validation": null,
  16726. "alias": null,
  16727. "deprecated": null
  16728. }
  16729. ],
  16730. "responses": [
  16731. {
  16732. "code": 200,
  16733. "description": "Response if repository contains content",
  16734. "examples": [
  16735. {
  16736. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"contributions\":32}]"
  16737. }
  16738. ]
  16739. }
  16740. ],
  16741. "renamed": null
  16742. },
  16743. {
  16744. "name": "List deployments",
  16745. "scope": "repos",
  16746. "id": "listDeployments",
  16747. "method": "GET",
  16748. "url": "/repos/{owner}/{repo}/deployments",
  16749. "isDeprecated": false,
  16750. "description": "Simple filtering of deployments is available via query parameters:",
  16751. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/deployments/#list-deployments",
  16752. "previews": [],
  16753. "headers": [],
  16754. "parameters": [
  16755. {
  16756. "name": "owner",
  16757. "description": "owner parameter",
  16758. "in": "PATH",
  16759. "type": "string",
  16760. "required": true,
  16761. "enum": null,
  16762. "allowNull": false,
  16763. "mapToData": null,
  16764. "validation": null,
  16765. "alias": null,
  16766. "deprecated": null
  16767. },
  16768. {
  16769. "name": "repo",
  16770. "description": "repo parameter",
  16771. "in": "PATH",
  16772. "type": "string",
  16773. "required": true,
  16774. "enum": null,
  16775. "allowNull": false,
  16776. "mapToData": null,
  16777. "validation": null,
  16778. "alias": null,
  16779. "deprecated": null
  16780. },
  16781. {
  16782. "name": "sha",
  16783. "description": "The SHA recorded at creation time.",
  16784. "in": "QUERY",
  16785. "type": "string",
  16786. "required": false,
  16787. "enum": null,
  16788. "allowNull": false,
  16789. "mapToData": null,
  16790. "validation": null,
  16791. "alias": null,
  16792. "deprecated": null
  16793. },
  16794. {
  16795. "name": "ref",
  16796. "description": "The name of the ref. This can be a branch, tag, or SHA.",
  16797. "in": "QUERY",
  16798. "type": "string",
  16799. "required": false,
  16800. "enum": null,
  16801. "allowNull": false,
  16802. "mapToData": null,
  16803. "validation": null,
  16804. "alias": null,
  16805. "deprecated": null
  16806. },
  16807. {
  16808. "name": "task",
  16809. "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).",
  16810. "in": "QUERY",
  16811. "type": "string",
  16812. "required": false,
  16813. "enum": null,
  16814. "allowNull": false,
  16815. "mapToData": null,
  16816. "validation": null,
  16817. "alias": null,
  16818. "deprecated": null
  16819. },
  16820. {
  16821. "name": "environment",
  16822. "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).",
  16823. "in": "QUERY",
  16824. "type": "string",
  16825. "required": false,
  16826. "enum": null,
  16827. "allowNull": false,
  16828. "mapToData": null,
  16829. "validation": null,
  16830. "alias": null,
  16831. "deprecated": null
  16832. },
  16833. {
  16834. "name": "per_page",
  16835. "description": "Results per page (max 100)",
  16836. "in": "QUERY",
  16837. "type": "integer",
  16838. "required": false,
  16839. "enum": null,
  16840. "allowNull": false,
  16841. "mapToData": null,
  16842. "validation": null,
  16843. "alias": null,
  16844. "deprecated": null
  16845. },
  16846. {
  16847. "name": "page",
  16848. "description": "Page number of the results to fetch.",
  16849. "in": "QUERY",
  16850. "type": "integer",
  16851. "required": false,
  16852. "enum": null,
  16853. "allowNull": false,
  16854. "mapToData": null,
  16855. "validation": null,
  16856. "alias": null,
  16857. "deprecated": null
  16858. }
  16859. ],
  16860. "responses": [
  16861. {
  16862. "code": 200,
  16863. "description": "response",
  16864. "examples": [
  16865. {
  16866. "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]"
  16867. }
  16868. ]
  16869. }
  16870. ],
  16871. "renamed": null
  16872. },
  16873. {
  16874. "name": "Create a deployment",
  16875. "scope": "repos",
  16876. "id": "createDeployment",
  16877. "method": "POST",
  16878. "url": "/repos/{owner}/{repo}/deployments",
  16879. "isDeprecated": false,
  16880. "description": "Deployments offer a few configurable parameters with sane defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.\n\nBy default, [commit statuses](https://developer.github.com/enterprise/2.17/v3/repos/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref:\n\nA simple example putting the user and room into the payload to notify back to chat networks.\n\nA more advanced example specifying required commit statuses and bypassing auto-merging.\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:\n\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master`in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful response.\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.",
  16881. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/deployments/#create-a-deployment",
  16882. "previews": [],
  16883. "headers": [],
  16884. "parameters": [
  16885. {
  16886. "name": "owner",
  16887. "description": "owner parameter",
  16888. "in": "PATH",
  16889. "type": "string",
  16890. "required": true,
  16891. "enum": null,
  16892. "allowNull": false,
  16893. "mapToData": null,
  16894. "validation": null,
  16895. "alias": null,
  16896. "deprecated": null
  16897. },
  16898. {
  16899. "name": "repo",
  16900. "description": "repo parameter",
  16901. "in": "PATH",
  16902. "type": "string",
  16903. "required": true,
  16904. "enum": null,
  16905. "allowNull": false,
  16906. "mapToData": null,
  16907. "validation": null,
  16908. "alias": null,
  16909. "deprecated": null
  16910. },
  16911. {
  16912. "name": "ref",
  16913. "description": "The ref to deploy. This can be a branch, tag, or SHA.",
  16914. "in": "BODY",
  16915. "type": "string",
  16916. "required": true,
  16917. "enum": null,
  16918. "allowNull": false,
  16919. "mapToData": null,
  16920. "validation": null,
  16921. "alias": null,
  16922. "deprecated": null
  16923. },
  16924. {
  16925. "name": "task",
  16926. "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).",
  16927. "in": "BODY",
  16928. "type": "string",
  16929. "required": false,
  16930. "enum": null,
  16931. "allowNull": false,
  16932. "mapToData": null,
  16933. "validation": null,
  16934. "alias": null,
  16935. "deprecated": null
  16936. },
  16937. {
  16938. "name": "auto_merge",
  16939. "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.",
  16940. "in": "BODY",
  16941. "type": "boolean",
  16942. "required": false,
  16943. "enum": null,
  16944. "allowNull": false,
  16945. "mapToData": null,
  16946. "validation": null,
  16947. "alias": null,
  16948. "deprecated": null
  16949. },
  16950. {
  16951. "name": "required_contexts",
  16952. "description": "The [status](https://developer.github.com/enterprise/2.17/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.",
  16953. "in": "BODY",
  16954. "type": "string[]",
  16955. "required": false,
  16956. "enum": null,
  16957. "allowNull": false,
  16958. "mapToData": null,
  16959. "validation": null,
  16960. "alias": null,
  16961. "deprecated": null
  16962. },
  16963. {
  16964. "name": "payload",
  16965. "description": "JSON payload with extra information about the deployment.",
  16966. "in": "BODY",
  16967. "type": "string",
  16968. "required": false,
  16969. "enum": null,
  16970. "allowNull": false,
  16971. "mapToData": null,
  16972. "validation": null,
  16973. "alias": null,
  16974. "deprecated": null
  16975. },
  16976. {
  16977. "name": "environment",
  16978. "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).",
  16979. "in": "BODY",
  16980. "type": "string",
  16981. "required": false,
  16982. "enum": null,
  16983. "allowNull": false,
  16984. "mapToData": null,
  16985. "validation": null,
  16986. "alias": null,
  16987. "deprecated": null
  16988. },
  16989. {
  16990. "name": "description",
  16991. "description": "Short description of the deployment.",
  16992. "in": "BODY",
  16993. "type": "string",
  16994. "required": false,
  16995. "enum": null,
  16996. "allowNull": false,
  16997. "mapToData": null,
  16998. "validation": null,
  16999. "alias": null,
  17000. "deprecated": null
  17001. },
  17002. {
  17003. "name": "transient_environment",
  17004. "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.",
  17005. "in": "BODY",
  17006. "type": "boolean",
  17007. "required": false,
  17008. "enum": null,
  17009. "allowNull": false,
  17010. "mapToData": null,
  17011. "validation": null,
  17012. "alias": null,
  17013. "deprecated": null
  17014. },
  17015. {
  17016. "name": "production_environment",
  17017. "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.",
  17018. "in": "BODY",
  17019. "type": "boolean",
  17020. "required": false,
  17021. "enum": null,
  17022. "allowNull": false,
  17023. "mapToData": null,
  17024. "validation": null,
  17025. "alias": null,
  17026. "deprecated": null
  17027. }
  17028. ],
  17029. "responses": [
  17030. {
  17031. "code": 201,
  17032. "description": "response",
  17033. "examples": [
  17034. {
  17035. "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}"
  17036. },
  17037. {
  17038. "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}"
  17039. }
  17040. ]
  17041. },
  17042. {
  17043. "code": 202,
  17044. "description": "Merged branch response",
  17045. "examples": [
  17046. {
  17047. "data": "{\"message\":\"Auto-merged master into topic-branch on deployment.\"}"
  17048. }
  17049. ]
  17050. },
  17051. {
  17052. "code": 409,
  17053. "description": "response",
  17054. "examples": [
  17055. {
  17056. "data": "{\"message\":\"Conflict merging master into topic-branch\"}"
  17057. },
  17058. {
  17059. "data": "{\"message\":\"Conflict: Commit status checks failed for topic-branch.\"}"
  17060. }
  17061. ]
  17062. }
  17063. ],
  17064. "renamed": null
  17065. },
  17066. {
  17067. "name": "Get a single deployment",
  17068. "scope": "repos",
  17069. "id": "getDeployment",
  17070. "method": "GET",
  17071. "url": "/repos/{owner}/{repo}/deployments/{deployment_id}",
  17072. "isDeprecated": false,
  17073. "description": "",
  17074. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/deployments/#get-a-single-deployment",
  17075. "previews": [],
  17076. "headers": [],
  17077. "parameters": [
  17078. {
  17079. "name": "owner",
  17080. "description": "owner parameter",
  17081. "in": "PATH",
  17082. "type": "string",
  17083. "required": true,
  17084. "enum": null,
  17085. "allowNull": false,
  17086. "mapToData": null,
  17087. "validation": null,
  17088. "alias": null,
  17089. "deprecated": null
  17090. },
  17091. {
  17092. "name": "repo",
  17093. "description": "repo parameter",
  17094. "in": "PATH",
  17095. "type": "string",
  17096. "required": true,
  17097. "enum": null,
  17098. "allowNull": false,
  17099. "mapToData": null,
  17100. "validation": null,
  17101. "alias": null,
  17102. "deprecated": null
  17103. },
  17104. {
  17105. "name": "deployment_id",
  17106. "description": "deployment_id parameter",
  17107. "in": "PATH",
  17108. "type": "integer",
  17109. "required": true,
  17110. "enum": null,
  17111. "allowNull": false,
  17112. "mapToData": null,
  17113. "validation": null,
  17114. "alias": null,
  17115. "deprecated": null
  17116. }
  17117. ],
  17118. "responses": [
  17119. {
  17120. "code": 200,
  17121. "description": "response",
  17122. "examples": [
  17123. {
  17124. "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}"
  17125. }
  17126. ]
  17127. }
  17128. ],
  17129. "renamed": null
  17130. },
  17131. {
  17132. "name": "List deployment statuses",
  17133. "scope": "repos",
  17134. "id": "listDeploymentStatuses",
  17135. "method": "GET",
  17136. "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
  17137. "isDeprecated": false,
  17138. "description": "Users with pull access can view deployment statuses for a deployment:",
  17139. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/deployments/#list-deployment-statuses",
  17140. "previews": [],
  17141. "headers": [],
  17142. "parameters": [
  17143. {
  17144. "name": "owner",
  17145. "description": "owner parameter",
  17146. "in": "PATH",
  17147. "type": "string",
  17148. "required": true,
  17149. "enum": null,
  17150. "allowNull": false,
  17151. "mapToData": null,
  17152. "validation": null,
  17153. "alias": null,
  17154. "deprecated": null
  17155. },
  17156. {
  17157. "name": "repo",
  17158. "description": "repo parameter",
  17159. "in": "PATH",
  17160. "type": "string",
  17161. "required": true,
  17162. "enum": null,
  17163. "allowNull": false,
  17164. "mapToData": null,
  17165. "validation": null,
  17166. "alias": null,
  17167. "deprecated": null
  17168. },
  17169. {
  17170. "name": "deployment_id",
  17171. "description": "deployment_id parameter",
  17172. "in": "PATH",
  17173. "type": "integer",
  17174. "required": true,
  17175. "enum": null,
  17176. "allowNull": false,
  17177. "mapToData": null,
  17178. "validation": null,
  17179. "alias": null,
  17180. "deprecated": null
  17181. },
  17182. {
  17183. "name": "per_page",
  17184. "description": "Results per page (max 100)",
  17185. "in": "QUERY",
  17186. "type": "integer",
  17187. "required": false,
  17188. "enum": null,
  17189. "allowNull": false,
  17190. "mapToData": null,
  17191. "validation": null,
  17192. "alias": null,
  17193. "deprecated": null
  17194. },
  17195. {
  17196. "name": "page",
  17197. "description": "Page number of the results to fetch.",
  17198. "in": "QUERY",
  17199. "type": "integer",
  17200. "required": false,
  17201. "enum": null,
  17202. "allowNull": false,
  17203. "mapToData": null,
  17204. "validation": null,
  17205. "alias": null,
  17206. "deprecated": null
  17207. }
  17208. ],
  17209. "responses": [
  17210. {
  17211. "code": 200,
  17212. "description": "response",
  17213. "examples": [
  17214. {
  17215. "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}]"
  17216. }
  17217. ]
  17218. }
  17219. ],
  17220. "renamed": null
  17221. },
  17222. {
  17223. "name": "Create a deployment status",
  17224. "scope": "repos",
  17225. "id": "createDeploymentStatus",
  17226. "method": "POST",
  17227. "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses",
  17228. "isDeprecated": false,
  17229. "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.",
  17230. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/deployments/#create-a-deployment-status",
  17231. "previews": [],
  17232. "headers": [],
  17233. "parameters": [
  17234. {
  17235. "name": "owner",
  17236. "description": "owner parameter",
  17237. "in": "PATH",
  17238. "type": "string",
  17239. "required": true,
  17240. "enum": null,
  17241. "allowNull": false,
  17242. "mapToData": null,
  17243. "validation": null,
  17244. "alias": null,
  17245. "deprecated": null
  17246. },
  17247. {
  17248. "name": "repo",
  17249. "description": "repo parameter",
  17250. "in": "PATH",
  17251. "type": "string",
  17252. "required": true,
  17253. "enum": null,
  17254. "allowNull": false,
  17255. "mapToData": null,
  17256. "validation": null,
  17257. "alias": null,
  17258. "deprecated": null
  17259. },
  17260. {
  17261. "name": "deployment_id",
  17262. "description": "deployment_id parameter",
  17263. "in": "PATH",
  17264. "type": "integer",
  17265. "required": true,
  17266. "enum": null,
  17267. "allowNull": false,
  17268. "mapToData": null,
  17269. "validation": null,
  17270. "alias": null,
  17271. "deprecated": null
  17272. },
  17273. {
  17274. "name": "state",
  17275. "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.",
  17276. "in": "BODY",
  17277. "type": "string",
  17278. "required": true,
  17279. "enum": [
  17280. "error",
  17281. "failure",
  17282. "inactive",
  17283. "in_progress",
  17284. "queued",
  17285. "pending",
  17286. "success"
  17287. ],
  17288. "allowNull": false,
  17289. "mapToData": null,
  17290. "validation": null,
  17291. "alias": null,
  17292. "deprecated": null
  17293. },
  17294. {
  17295. "name": "target_url",
  17296. "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.",
  17297. "in": "BODY",
  17298. "type": "string",
  17299. "required": false,
  17300. "enum": null,
  17301. "allowNull": false,
  17302. "mapToData": null,
  17303. "validation": null,
  17304. "alias": null,
  17305. "deprecated": null
  17306. },
  17307. {
  17308. "name": "log_url",
  17309. "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value.",
  17310. "in": "BODY",
  17311. "type": "string",
  17312. "required": false,
  17313. "enum": null,
  17314. "allowNull": false,
  17315. "mapToData": null,
  17316. "validation": null,
  17317. "alias": null,
  17318. "deprecated": null
  17319. },
  17320. {
  17321. "name": "description",
  17322. "description": "A short description of the status. The maximum description length is 140 characters.",
  17323. "in": "BODY",
  17324. "type": "string",
  17325. "required": false,
  17326. "enum": null,
  17327. "allowNull": false,
  17328. "mapToData": null,
  17329. "validation": null,
  17330. "alias": null,
  17331. "deprecated": null
  17332. },
  17333. {
  17334. "name": "environment",
  17335. "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.",
  17336. "in": "BODY",
  17337. "type": "string",
  17338. "required": false,
  17339. "enum": ["production", "staging", "qa"],
  17340. "allowNull": false,
  17341. "mapToData": null,
  17342. "validation": null,
  17343. "alias": null,
  17344. "deprecated": null
  17345. },
  17346. {
  17347. "name": "environment_url",
  17348. "description": "Sets the URL for accessing your environment.",
  17349. "in": "BODY",
  17350. "type": "string",
  17351. "required": false,
  17352. "enum": null,
  17353. "allowNull": false,
  17354. "mapToData": null,
  17355. "validation": null,
  17356. "alias": null,
  17357. "deprecated": null
  17358. },
  17359. {
  17360. "name": "auto_inactive",
  17361. "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type. **Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/enterprise/2.17/v3/previews/#deployment-statuses) custom media type.",
  17362. "in": "BODY",
  17363. "type": "boolean",
  17364. "required": false,
  17365. "enum": null,
  17366. "allowNull": false,
  17367. "mapToData": null,
  17368. "validation": null,
  17369. "alias": null,
  17370. "deprecated": null
  17371. }
  17372. ],
  17373. "responses": [
  17374. {
  17375. "code": 201,
  17376. "description": "response",
  17377. "examples": [
  17378. {
  17379. "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}"
  17380. }
  17381. ]
  17382. }
  17383. ],
  17384. "renamed": null
  17385. },
  17386. {
  17387. "name": "Get a single deployment status",
  17388. "scope": "repos",
  17389. "id": "getDeploymentStatus",
  17390. "method": "GET",
  17391. "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}",
  17392. "isDeprecated": false,
  17393. "description": "Users with pull access can view a deployment status for a deployment:",
  17394. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/deployments/#get-a-single-deployment-status",
  17395. "previews": [],
  17396. "headers": [],
  17397. "parameters": [
  17398. {
  17399. "name": "owner",
  17400. "description": "owner parameter",
  17401. "in": "PATH",
  17402. "type": "string",
  17403. "required": true,
  17404. "enum": null,
  17405. "allowNull": false,
  17406. "mapToData": null,
  17407. "validation": null,
  17408. "alias": null,
  17409. "deprecated": null
  17410. },
  17411. {
  17412. "name": "repo",
  17413. "description": "repo parameter",
  17414. "in": "PATH",
  17415. "type": "string",
  17416. "required": true,
  17417. "enum": null,
  17418. "allowNull": false,
  17419. "mapToData": null,
  17420. "validation": null,
  17421. "alias": null,
  17422. "deprecated": null
  17423. },
  17424. {
  17425. "name": "deployment_id",
  17426. "description": "deployment_id parameter",
  17427. "in": "PATH",
  17428. "type": "integer",
  17429. "required": true,
  17430. "enum": null,
  17431. "allowNull": false,
  17432. "mapToData": null,
  17433. "validation": null,
  17434. "alias": null,
  17435. "deprecated": null
  17436. },
  17437. {
  17438. "name": "status_id",
  17439. "description": "status_id parameter",
  17440. "in": "PATH",
  17441. "type": "integer",
  17442. "required": true,
  17443. "enum": null,
  17444. "allowNull": false,
  17445. "mapToData": null,
  17446. "validation": null,
  17447. "alias": null,
  17448. "deprecated": null
  17449. }
  17450. ],
  17451. "responses": [
  17452. {
  17453. "code": 200,
  17454. "description": "response",
  17455. "examples": [
  17456. {
  17457. "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}"
  17458. }
  17459. ]
  17460. }
  17461. ],
  17462. "renamed": null
  17463. },
  17464. {
  17465. "name": "List downloads for a repository",
  17466. "scope": "repos",
  17467. "id": "listDownloads",
  17468. "method": "GET",
  17469. "url": "/repos/{owner}/{repo}/downloads",
  17470. "isDeprecated": false,
  17471. "description": "",
  17472. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/downloads/#list-downloads-for-a-repository",
  17473. "previews": [],
  17474. "headers": [],
  17475. "parameters": [
  17476. {
  17477. "name": "owner",
  17478. "description": "owner parameter",
  17479. "in": "PATH",
  17480. "type": "string",
  17481. "required": true,
  17482. "enum": null,
  17483. "allowNull": false,
  17484. "mapToData": null,
  17485. "validation": null,
  17486. "alias": null,
  17487. "deprecated": null
  17488. },
  17489. {
  17490. "name": "repo",
  17491. "description": "repo parameter",
  17492. "in": "PATH",
  17493. "type": "string",
  17494. "required": true,
  17495. "enum": null,
  17496. "allowNull": false,
  17497. "mapToData": null,
  17498. "validation": null,
  17499. "alias": null,
  17500. "deprecated": null
  17501. },
  17502. {
  17503. "name": "per_page",
  17504. "description": "Results per page (max 100)",
  17505. "in": "QUERY",
  17506. "type": "integer",
  17507. "required": false,
  17508. "enum": null,
  17509. "allowNull": false,
  17510. "mapToData": null,
  17511. "validation": null,
  17512. "alias": null,
  17513. "deprecated": null
  17514. },
  17515. {
  17516. "name": "page",
  17517. "description": "Page number of the results to fetch.",
  17518. "in": "QUERY",
  17519. "type": "integer",
  17520. "required": false,
  17521. "enum": null,
  17522. "allowNull": false,
  17523. "mapToData": null,
  17524. "validation": null,
  17525. "alias": null,
  17526. "deprecated": null
  17527. }
  17528. ],
  17529. "responses": [
  17530. {
  17531. "code": 200,
  17532. "description": "response",
  17533. "examples": [
  17534. {
  17535. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/downloads/1\",\"html_url\":\"https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg\",\"id\":1,\"name\":\"new_file.jpg\",\"description\":\"Description of your download\",\"size\":1024,\"download_count\":40,\"content_type\":\".jpg\"}]"
  17536. }
  17537. ]
  17538. }
  17539. ],
  17540. "renamed": null
  17541. },
  17542. {
  17543. "name": "Get a single download",
  17544. "scope": "repos",
  17545. "id": "getDownload",
  17546. "method": "GET",
  17547. "url": "/repos/{owner}/{repo}/downloads/{download_id}",
  17548. "isDeprecated": false,
  17549. "description": "",
  17550. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/downloads/#get-a-single-download",
  17551. "previews": [],
  17552. "headers": [],
  17553. "parameters": [
  17554. {
  17555. "name": "owner",
  17556. "description": "owner parameter",
  17557. "in": "PATH",
  17558. "type": "string",
  17559. "required": true,
  17560. "enum": null,
  17561. "allowNull": false,
  17562. "mapToData": null,
  17563. "validation": null,
  17564. "alias": null,
  17565. "deprecated": null
  17566. },
  17567. {
  17568. "name": "repo",
  17569. "description": "repo parameter",
  17570. "in": "PATH",
  17571. "type": "string",
  17572. "required": true,
  17573. "enum": null,
  17574. "allowNull": false,
  17575. "mapToData": null,
  17576. "validation": null,
  17577. "alias": null,
  17578. "deprecated": null
  17579. },
  17580. {
  17581. "name": "download_id",
  17582. "description": "download_id parameter",
  17583. "in": "PATH",
  17584. "type": "integer",
  17585. "required": true,
  17586. "enum": null,
  17587. "allowNull": false,
  17588. "mapToData": null,
  17589. "validation": null,
  17590. "alias": null,
  17591. "deprecated": null
  17592. }
  17593. ],
  17594. "responses": [
  17595. {
  17596. "code": 200,
  17597. "description": "response",
  17598. "examples": [
  17599. {
  17600. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/downloads/1\",\"html_url\":\"https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg\",\"id\":1,\"name\":\"new_file.jpg\",\"description\":\"Description of your download\",\"size\":1024,\"download_count\":40,\"content_type\":\".jpg\"}"
  17601. }
  17602. ]
  17603. }
  17604. ],
  17605. "renamed": null
  17606. },
  17607. {
  17608. "name": "Delete a download",
  17609. "scope": "repos",
  17610. "id": "deleteDownload",
  17611. "method": "DELETE",
  17612. "url": "/repos/{owner}/{repo}/downloads/{download_id}",
  17613. "isDeprecated": false,
  17614. "description": "",
  17615. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/downloads/#delete-a-download",
  17616. "previews": [],
  17617. "headers": [],
  17618. "parameters": [
  17619. {
  17620. "name": "owner",
  17621. "description": "owner parameter",
  17622. "in": "PATH",
  17623. "type": "string",
  17624. "required": true,
  17625. "enum": null,
  17626. "allowNull": false,
  17627. "mapToData": null,
  17628. "validation": null,
  17629. "alias": null,
  17630. "deprecated": null
  17631. },
  17632. {
  17633. "name": "repo",
  17634. "description": "repo parameter",
  17635. "in": "PATH",
  17636. "type": "string",
  17637. "required": true,
  17638. "enum": null,
  17639. "allowNull": false,
  17640. "mapToData": null,
  17641. "validation": null,
  17642. "alias": null,
  17643. "deprecated": null
  17644. },
  17645. {
  17646. "name": "download_id",
  17647. "description": "download_id parameter",
  17648. "in": "PATH",
  17649. "type": "integer",
  17650. "required": true,
  17651. "enum": null,
  17652. "allowNull": false,
  17653. "mapToData": null,
  17654. "validation": null,
  17655. "alias": null,
  17656. "deprecated": null
  17657. }
  17658. ],
  17659. "responses": [],
  17660. "renamed": null
  17661. },
  17662. {
  17663. "name": "List repository events",
  17664. "scope": "activity",
  17665. "id": "listRepoEvents",
  17666. "method": "GET",
  17667. "url": "/repos/{owner}/{repo}/events",
  17668. "isDeprecated": false,
  17669. "description": "",
  17670. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-repository-events",
  17671. "previews": [],
  17672. "headers": [],
  17673. "parameters": [
  17674. {
  17675. "name": "owner",
  17676. "description": "owner parameter",
  17677. "in": "PATH",
  17678. "type": "string",
  17679. "required": true,
  17680. "enum": null,
  17681. "allowNull": false,
  17682. "mapToData": null,
  17683. "validation": null,
  17684. "alias": null,
  17685. "deprecated": null
  17686. },
  17687. {
  17688. "name": "repo",
  17689. "description": "repo parameter",
  17690. "in": "PATH",
  17691. "type": "string",
  17692. "required": true,
  17693. "enum": null,
  17694. "allowNull": false,
  17695. "mapToData": null,
  17696. "validation": null,
  17697. "alias": null,
  17698. "deprecated": null
  17699. },
  17700. {
  17701. "name": "per_page",
  17702. "description": "Results per page (max 100)",
  17703. "in": "QUERY",
  17704. "type": "integer",
  17705. "required": false,
  17706. "enum": null,
  17707. "allowNull": false,
  17708. "mapToData": null,
  17709. "validation": null,
  17710. "alias": null,
  17711. "deprecated": null
  17712. },
  17713. {
  17714. "name": "page",
  17715. "description": "Page number of the results to fetch.",
  17716. "in": "QUERY",
  17717. "type": "integer",
  17718. "required": false,
  17719. "enum": null,
  17720. "allowNull": false,
  17721. "mapToData": null,
  17722. "validation": null,
  17723. "alias": null,
  17724. "deprecated": null
  17725. }
  17726. ],
  17727. "responses": [],
  17728. "renamed": null
  17729. },
  17730. {
  17731. "name": "List forks",
  17732. "scope": "repos",
  17733. "id": "listForks",
  17734. "method": "GET",
  17735. "url": "/repos/{owner}/{repo}/forks",
  17736. "isDeprecated": false,
  17737. "description": "",
  17738. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/forks/#list-forks",
  17739. "previews": [],
  17740. "headers": [],
  17741. "parameters": [
  17742. {
  17743. "name": "owner",
  17744. "description": "owner parameter",
  17745. "in": "PATH",
  17746. "type": "string",
  17747. "required": true,
  17748. "enum": null,
  17749. "allowNull": false,
  17750. "mapToData": null,
  17751. "validation": null,
  17752. "alias": null,
  17753. "deprecated": null
  17754. },
  17755. {
  17756. "name": "repo",
  17757. "description": "repo parameter",
  17758. "in": "PATH",
  17759. "type": "string",
  17760. "required": true,
  17761. "enum": null,
  17762. "allowNull": false,
  17763. "mapToData": null,
  17764. "validation": null,
  17765. "alias": null,
  17766. "deprecated": null
  17767. },
  17768. {
  17769. "name": "sort",
  17770. "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.",
  17771. "in": "QUERY",
  17772. "type": "string",
  17773. "required": false,
  17774. "enum": ["newest", "oldest", "stargazers"],
  17775. "allowNull": false,
  17776. "mapToData": null,
  17777. "validation": null,
  17778. "alias": null,
  17779. "deprecated": null
  17780. },
  17781. {
  17782. "name": "per_page",
  17783. "description": "Results per page (max 100)",
  17784. "in": "QUERY",
  17785. "type": "integer",
  17786. "required": false,
  17787. "enum": null,
  17788. "allowNull": false,
  17789. "mapToData": null,
  17790. "validation": null,
  17791. "alias": null,
  17792. "deprecated": null
  17793. },
  17794. {
  17795. "name": "page",
  17796. "description": "Page number of the results to fetch.",
  17797. "in": "QUERY",
  17798. "type": "integer",
  17799. "required": false,
  17800. "enum": null,
  17801. "allowNull": false,
  17802. "mapToData": null,
  17803. "validation": null,
  17804. "alias": null,
  17805. "deprecated": null
  17806. }
  17807. ],
  17808. "responses": [
  17809. {
  17810. "code": 200,
  17811. "description": "response",
  17812. "examples": [
  17813. {
  17814. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]"
  17815. }
  17816. ]
  17817. }
  17818. ],
  17819. "renamed": null
  17820. },
  17821. {
  17822. "name": "Create a fork",
  17823. "scope": "repos",
  17824. "id": "createFork",
  17825. "method": "POST",
  17826. "url": "/repos/{owner}/{repo}/forks",
  17827. "isDeprecated": false,
  17828. "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Support](https://enterprise.github.com/support).",
  17829. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/forks/#create-a-fork",
  17830. "previews": [],
  17831. "headers": [],
  17832. "parameters": [
  17833. {
  17834. "name": "owner",
  17835. "description": "owner parameter",
  17836. "in": "PATH",
  17837. "type": "string",
  17838. "required": true,
  17839. "enum": null,
  17840. "allowNull": false,
  17841. "mapToData": null,
  17842. "validation": null,
  17843. "alias": null,
  17844. "deprecated": null
  17845. },
  17846. {
  17847. "name": "repo",
  17848. "description": "repo parameter",
  17849. "in": "PATH",
  17850. "type": "string",
  17851. "required": true,
  17852. "enum": null,
  17853. "allowNull": false,
  17854. "mapToData": null,
  17855. "validation": null,
  17856. "alias": null,
  17857. "deprecated": null
  17858. },
  17859. {
  17860. "name": "organization",
  17861. "description": "Optional parameter to specify the organization name if forking into an organization.",
  17862. "in": "BODY",
  17863. "type": "string",
  17864. "required": false,
  17865. "enum": null,
  17866. "allowNull": false,
  17867. "mapToData": null,
  17868. "validation": null,
  17869. "alias": null,
  17870. "deprecated": null
  17871. }
  17872. ],
  17873. "responses": [
  17874. {
  17875. "code": 202,
  17876. "description": "response",
  17877. "examples": [
  17878. {
  17879. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}"
  17880. }
  17881. ]
  17882. }
  17883. ],
  17884. "renamed": null
  17885. },
  17886. {
  17887. "name": "Create a blob",
  17888. "scope": "git",
  17889. "id": "createBlob",
  17890. "method": "POST",
  17891. "url": "/repos/{owner}/{repo}/git/blobs",
  17892. "isDeprecated": false,
  17893. "description": "",
  17894. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/blobs/#create-a-blob",
  17895. "previews": [],
  17896. "headers": [],
  17897. "parameters": [
  17898. {
  17899. "name": "owner",
  17900. "description": "owner parameter",
  17901. "in": "PATH",
  17902. "type": "string",
  17903. "required": true,
  17904. "enum": null,
  17905. "allowNull": false,
  17906. "mapToData": null,
  17907. "validation": null,
  17908. "alias": null,
  17909. "deprecated": null
  17910. },
  17911. {
  17912. "name": "repo",
  17913. "description": "repo parameter",
  17914. "in": "PATH",
  17915. "type": "string",
  17916. "required": true,
  17917. "enum": null,
  17918. "allowNull": false,
  17919. "mapToData": null,
  17920. "validation": null,
  17921. "alias": null,
  17922. "deprecated": null
  17923. },
  17924. {
  17925. "name": "content",
  17926. "description": "The new blob's content.",
  17927. "in": "BODY",
  17928. "type": "string",
  17929. "required": true,
  17930. "enum": null,
  17931. "allowNull": false,
  17932. "mapToData": null,
  17933. "validation": null,
  17934. "alias": null,
  17935. "deprecated": null
  17936. },
  17937. {
  17938. "name": "encoding",
  17939. "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.",
  17940. "in": "BODY",
  17941. "type": "string",
  17942. "required": false,
  17943. "enum": null,
  17944. "allowNull": false,
  17945. "mapToData": null,
  17946. "validation": null,
  17947. "alias": null,
  17948. "deprecated": null
  17949. }
  17950. ],
  17951. "responses": [
  17952. {
  17953. "code": 201,
  17954. "description": "response",
  17955. "examples": [
  17956. {
  17957. "data": "{\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}"
  17958. }
  17959. ]
  17960. }
  17961. ],
  17962. "renamed": null
  17963. },
  17964. {
  17965. "name": "Get a blob",
  17966. "scope": "git",
  17967. "id": "getBlob",
  17968. "method": "GET",
  17969. "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}",
  17970. "isDeprecated": false,
  17971. "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.",
  17972. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/blobs/#get-a-blob",
  17973. "previews": [],
  17974. "headers": [],
  17975. "parameters": [
  17976. {
  17977. "name": "owner",
  17978. "description": "owner parameter",
  17979. "in": "PATH",
  17980. "type": "string",
  17981. "required": true,
  17982. "enum": null,
  17983. "allowNull": false,
  17984. "mapToData": null,
  17985. "validation": null,
  17986. "alias": null,
  17987. "deprecated": null
  17988. },
  17989. {
  17990. "name": "repo",
  17991. "description": "repo parameter",
  17992. "in": "PATH",
  17993. "type": "string",
  17994. "required": true,
  17995. "enum": null,
  17996. "allowNull": false,
  17997. "mapToData": null,
  17998. "validation": null,
  17999. "alias": null,
  18000. "deprecated": null
  18001. },
  18002. {
  18003. "name": "file_sha",
  18004. "description": "file_sha parameter",
  18005. "in": "PATH",
  18006. "type": "string",
  18007. "required": true,
  18008. "enum": null,
  18009. "allowNull": false,
  18010. "mapToData": null,
  18011. "validation": null,
  18012. "alias": null,
  18013. "deprecated": null
  18014. }
  18015. ],
  18016. "responses": [
  18017. {
  18018. "code": 200,
  18019. "description": "response",
  18020. "examples": [
  18021. {
  18022. "data": "{\"content\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\\n\",\"encoding\":\"base64\",\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"size\":19}"
  18023. }
  18024. ]
  18025. }
  18026. ],
  18027. "renamed": null
  18028. },
  18029. {
  18030. "name": "Create a commit",
  18031. "scope": "git",
  18032. "id": "createCommit",
  18033. "method": "POST",
  18034. "url": "/repos/{owner}/{repo}/git/commits",
  18035. "isDeprecated": false,
  18036. "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\nIn this example, the payload of the signature would be:\n\n\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
  18037. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/commits/#create-a-commit",
  18038. "previews": [],
  18039. "headers": [],
  18040. "parameters": [
  18041. {
  18042. "name": "owner",
  18043. "description": "owner parameter",
  18044. "in": "PATH",
  18045. "type": "string",
  18046. "required": true,
  18047. "enum": null,
  18048. "allowNull": false,
  18049. "mapToData": null,
  18050. "validation": null,
  18051. "alias": null,
  18052. "deprecated": null
  18053. },
  18054. {
  18055. "name": "repo",
  18056. "description": "repo parameter",
  18057. "in": "PATH",
  18058. "type": "string",
  18059. "required": true,
  18060. "enum": null,
  18061. "allowNull": false,
  18062. "mapToData": null,
  18063. "validation": null,
  18064. "alias": null,
  18065. "deprecated": null
  18066. },
  18067. {
  18068. "name": "message",
  18069. "description": "The commit message",
  18070. "in": "BODY",
  18071. "type": "string",
  18072. "required": true,
  18073. "enum": null,
  18074. "allowNull": false,
  18075. "mapToData": null,
  18076. "validation": null,
  18077. "alias": null,
  18078. "deprecated": null
  18079. },
  18080. {
  18081. "name": "tree",
  18082. "description": "The SHA of the tree object this commit points to",
  18083. "in": "BODY",
  18084. "type": "string",
  18085. "required": true,
  18086. "enum": null,
  18087. "allowNull": false,
  18088. "mapToData": null,
  18089. "validation": null,
  18090. "alias": null,
  18091. "deprecated": null
  18092. },
  18093. {
  18094. "name": "parents",
  18095. "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.",
  18096. "in": "BODY",
  18097. "type": "string[]",
  18098. "required": true,
  18099. "enum": null,
  18100. "allowNull": false,
  18101. "mapToData": null,
  18102. "validation": null,
  18103. "alias": null,
  18104. "deprecated": null
  18105. },
  18106. {
  18107. "name": "author",
  18108. "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.",
  18109. "in": "BODY",
  18110. "type": "object",
  18111. "required": false,
  18112. "enum": null,
  18113. "allowNull": false,
  18114. "mapToData": null,
  18115. "validation": null,
  18116. "alias": null,
  18117. "deprecated": null
  18118. },
  18119. {
  18120. "name": "author.name",
  18121. "description": "The name of the author (or committer) of the commit",
  18122. "in": "BODY",
  18123. "type": "string",
  18124. "required": false,
  18125. "enum": null,
  18126. "allowNull": false,
  18127. "mapToData": null,
  18128. "validation": null,
  18129. "alias": null,
  18130. "deprecated": null
  18131. },
  18132. {
  18133. "name": "author.email",
  18134. "description": "The email of the author (or committer) of the commit",
  18135. "in": "BODY",
  18136. "type": "string",
  18137. "required": false,
  18138. "enum": null,
  18139. "allowNull": false,
  18140. "mapToData": null,
  18141. "validation": null,
  18142. "alias": null,
  18143. "deprecated": null
  18144. },
  18145. {
  18146. "name": "author.date",
  18147. "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  18148. "in": "BODY",
  18149. "type": "string",
  18150. "required": false,
  18151. "enum": null,
  18152. "allowNull": false,
  18153. "mapToData": null,
  18154. "validation": null,
  18155. "alias": null,
  18156. "deprecated": null
  18157. },
  18158. {
  18159. "name": "committer",
  18160. "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.",
  18161. "in": "BODY",
  18162. "type": "object",
  18163. "required": false,
  18164. "enum": null,
  18165. "allowNull": false,
  18166. "mapToData": null,
  18167. "validation": null,
  18168. "alias": null,
  18169. "deprecated": null
  18170. },
  18171. {
  18172. "name": "committer.name",
  18173. "description": "The name of the author (or committer) of the commit",
  18174. "in": "BODY",
  18175. "type": "string",
  18176. "required": false,
  18177. "enum": null,
  18178. "allowNull": false,
  18179. "mapToData": null,
  18180. "validation": null,
  18181. "alias": null,
  18182. "deprecated": null
  18183. },
  18184. {
  18185. "name": "committer.email",
  18186. "description": "The email of the author (or committer) of the commit",
  18187. "in": "BODY",
  18188. "type": "string",
  18189. "required": false,
  18190. "enum": null,
  18191. "allowNull": false,
  18192. "mapToData": null,
  18193. "validation": null,
  18194. "alias": null,
  18195. "deprecated": null
  18196. },
  18197. {
  18198. "name": "committer.date",
  18199. "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  18200. "in": "BODY",
  18201. "type": "string",
  18202. "required": false,
  18203. "enum": null,
  18204. "allowNull": false,
  18205. "mapToData": null,
  18206. "validation": null,
  18207. "alias": null,
  18208. "deprecated": null
  18209. },
  18210. {
  18211. "name": "signature",
  18212. "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.",
  18213. "in": "BODY",
  18214. "type": "string",
  18215. "required": false,
  18216. "enum": null,
  18217. "allowNull": false,
  18218. "mapToData": null,
  18219. "validation": null,
  18220. "alias": null,
  18221. "deprecated": null
  18222. }
  18223. ],
  18224. "responses": [
  18225. {
  18226. "code": 201,
  18227. "description": "response",
  18228. "examples": [
  18229. {
  18230. "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\"sha\":\"827efc6d56897b048c772eb4087f854f46256132\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"sha\":\"7d1b31e74ee336d15cbd21741bc88a537ed063a0\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}"
  18231. }
  18232. ]
  18233. }
  18234. ],
  18235. "renamed": null
  18236. },
  18237. {
  18238. "name": "Get a commit",
  18239. "scope": "git",
  18240. "id": "getCommit",
  18241. "method": "GET",
  18242. "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}",
  18243. "isDeprecated": false,
  18244. "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
  18245. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/commits/#get-a-commit",
  18246. "previews": [],
  18247. "headers": [],
  18248. "parameters": [
  18249. {
  18250. "name": "owner",
  18251. "description": "owner parameter",
  18252. "in": "PATH",
  18253. "type": "string",
  18254. "required": true,
  18255. "enum": null,
  18256. "allowNull": false,
  18257. "mapToData": null,
  18258. "validation": null,
  18259. "alias": null,
  18260. "deprecated": null
  18261. },
  18262. {
  18263. "name": "repo",
  18264. "description": "repo parameter",
  18265. "in": "PATH",
  18266. "type": "string",
  18267. "required": true,
  18268. "enum": null,
  18269. "allowNull": false,
  18270. "mapToData": null,
  18271. "validation": null,
  18272. "alias": null,
  18273. "deprecated": null
  18274. },
  18275. {
  18276. "name": "commit_sha",
  18277. "description": "commit_sha parameter",
  18278. "in": "PATH",
  18279. "type": "string",
  18280. "required": true,
  18281. "enum": null,
  18282. "allowNull": false,
  18283. "mapToData": null,
  18284. "validation": null,
  18285. "alias": null,
  18286. "deprecated": null
  18287. }
  18288. ],
  18289. "responses": [
  18290. {
  18291. "code": 200,
  18292. "description": "response",
  18293. "examples": [
  18294. {
  18295. "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"added readme, because im a good github citizen\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}"
  18296. }
  18297. ]
  18298. }
  18299. ],
  18300. "renamed": null
  18301. },
  18302. {
  18303. "name": "Create a reference",
  18304. "scope": "git",
  18305. "id": "createRef",
  18306. "method": "POST",
  18307. "url": "/repos/{owner}/{repo}/git/refs",
  18308. "isDeprecated": false,
  18309. "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.",
  18310. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/refs/#create-a-reference",
  18311. "previews": [],
  18312. "headers": [],
  18313. "parameters": [
  18314. {
  18315. "name": "owner",
  18316. "description": "owner parameter",
  18317. "in": "PATH",
  18318. "type": "string",
  18319. "required": true,
  18320. "enum": null,
  18321. "allowNull": false,
  18322. "mapToData": null,
  18323. "validation": null,
  18324. "alias": null,
  18325. "deprecated": null
  18326. },
  18327. {
  18328. "name": "repo",
  18329. "description": "repo parameter",
  18330. "in": "PATH",
  18331. "type": "string",
  18332. "required": true,
  18333. "enum": null,
  18334. "allowNull": false,
  18335. "mapToData": null,
  18336. "validation": null,
  18337. "alias": null,
  18338. "deprecated": null
  18339. },
  18340. {
  18341. "name": "ref",
  18342. "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.",
  18343. "in": "BODY",
  18344. "type": "string",
  18345. "required": true,
  18346. "enum": null,
  18347. "allowNull": false,
  18348. "mapToData": null,
  18349. "validation": null,
  18350. "alias": null,
  18351. "deprecated": null
  18352. },
  18353. {
  18354. "name": "sha",
  18355. "description": "The SHA1 value for this reference.",
  18356. "in": "BODY",
  18357. "type": "string",
  18358. "required": true,
  18359. "enum": null,
  18360. "allowNull": false,
  18361. "mapToData": null,
  18362. "validation": null,
  18363. "alias": null,
  18364. "deprecated": null
  18365. }
  18366. ],
  18367. "responses": [
  18368. {
  18369. "code": 201,
  18370. "description": "response",
  18371. "examples": [
  18372. {
  18373. "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}"
  18374. }
  18375. ]
  18376. }
  18377. ],
  18378. "renamed": null
  18379. },
  18380. {
  18381. "name": "Get a reference",
  18382. "scope": "git",
  18383. "id": "getRef",
  18384. "method": "GET",
  18385. "url": "/repos/{owner}/{repo}/git/refs/{ref}",
  18386. "isDeprecated": false,
  18387. "description": "Returns a branch or tag reference. Other than the [REST API](https://developer.github.com/enterprise/2.17/v3/git/refs/#get-a-reference) it always returns a single reference. If the REST API returns with an array then the method responds with an error.",
  18388. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/refs/#get-a-reference",
  18389. "previews": [],
  18390. "headers": [],
  18391. "parameters": [
  18392. {
  18393. "name": "owner",
  18394. "description": "owner parameter",
  18395. "in": "PATH",
  18396. "type": "string",
  18397. "required": true,
  18398. "enum": null,
  18399. "allowNull": false,
  18400. "mapToData": null,
  18401. "validation": null,
  18402. "alias": null,
  18403. "deprecated": null
  18404. },
  18405. {
  18406. "name": "repo",
  18407. "description": "repo parameter",
  18408. "in": "PATH",
  18409. "type": "string",
  18410. "required": true,
  18411. "enum": null,
  18412. "allowNull": false,
  18413. "mapToData": null,
  18414. "validation": null,
  18415. "alias": null,
  18416. "deprecated": null
  18417. },
  18418. {
  18419. "name": "ref",
  18420. "description": "Must be formatted as `heads/branch`, not just `branch`",
  18421. "in": "PATH",
  18422. "type": "string",
  18423. "required": true,
  18424. "enum": null,
  18425. "allowNull": false,
  18426. "mapToData": null,
  18427. "validation": null,
  18428. "alias": null,
  18429. "deprecated": null
  18430. }
  18431. ],
  18432. "responses": [{ "code": 200, "description": "response", "examples": null }],
  18433. "renamed": null
  18434. },
  18435. {
  18436. "name": "Update a reference",
  18437. "scope": "git",
  18438. "id": "updateRef",
  18439. "method": "PATCH",
  18440. "url": "/repos/{owner}/{repo}/git/refs/{ref}",
  18441. "isDeprecated": false,
  18442. "description": "",
  18443. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/refs/#update-a-reference",
  18444. "previews": [],
  18445. "headers": [],
  18446. "parameters": [
  18447. {
  18448. "name": "owner",
  18449. "description": "owner parameter",
  18450. "in": "PATH",
  18451. "type": "string",
  18452. "required": true,
  18453. "enum": null,
  18454. "allowNull": false,
  18455. "mapToData": null,
  18456. "validation": null,
  18457. "alias": null,
  18458. "deprecated": null
  18459. },
  18460. {
  18461. "name": "repo",
  18462. "description": "repo parameter",
  18463. "in": "PATH",
  18464. "type": "string",
  18465. "required": true,
  18466. "enum": null,
  18467. "allowNull": false,
  18468. "mapToData": null,
  18469. "validation": null,
  18470. "alias": null,
  18471. "deprecated": null
  18472. },
  18473. {
  18474. "name": "ref",
  18475. "description": "ref parameter",
  18476. "in": "PATH",
  18477. "type": "string",
  18478. "required": true,
  18479. "enum": null,
  18480. "allowNull": false,
  18481. "mapToData": null,
  18482. "validation": null,
  18483. "alias": null,
  18484. "deprecated": null
  18485. },
  18486. {
  18487. "name": "sha",
  18488. "description": "The SHA1 value to set this reference to",
  18489. "in": "BODY",
  18490. "type": "string",
  18491. "required": true,
  18492. "enum": null,
  18493. "allowNull": false,
  18494. "mapToData": null,
  18495. "validation": null,
  18496. "alias": null,
  18497. "deprecated": null
  18498. },
  18499. {
  18500. "name": "force",
  18501. "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.",
  18502. "in": "BODY",
  18503. "type": "boolean",
  18504. "required": false,
  18505. "enum": null,
  18506. "allowNull": false,
  18507. "mapToData": null,
  18508. "validation": null,
  18509. "alias": null,
  18510. "deprecated": null
  18511. }
  18512. ],
  18513. "responses": [
  18514. {
  18515. "code": 200,
  18516. "description": "response",
  18517. "examples": [
  18518. {
  18519. "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}"
  18520. }
  18521. ]
  18522. }
  18523. ],
  18524. "renamed": null
  18525. },
  18526. {
  18527. "name": "Delete a reference",
  18528. "scope": "git",
  18529. "id": "deleteRef",
  18530. "method": "DELETE",
  18531. "url": "/repos/{owner}/{repo}/git/refs/{ref}",
  18532. "isDeprecated": false,
  18533. "description": "```\nDELETE /repos/octocat/Hello-World/git/refs/heads/feature-a\n```\n\n```\nDELETE /repos/octocat/Hello-World/git/refs/tags/v1.0\n```",
  18534. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/refs/#delete-a-reference",
  18535. "previews": [],
  18536. "headers": [],
  18537. "parameters": [
  18538. {
  18539. "name": "owner",
  18540. "description": "owner parameter",
  18541. "in": "PATH",
  18542. "type": "string",
  18543. "required": true,
  18544. "enum": null,
  18545. "allowNull": false,
  18546. "mapToData": null,
  18547. "validation": null,
  18548. "alias": null,
  18549. "deprecated": null
  18550. },
  18551. {
  18552. "name": "repo",
  18553. "description": "repo parameter",
  18554. "in": "PATH",
  18555. "type": "string",
  18556. "required": true,
  18557. "enum": null,
  18558. "allowNull": false,
  18559. "mapToData": null,
  18560. "validation": null,
  18561. "alias": null,
  18562. "deprecated": null
  18563. },
  18564. {
  18565. "name": "ref",
  18566. "description": "ref parameter",
  18567. "in": "PATH",
  18568. "type": "string",
  18569. "required": true,
  18570. "enum": null,
  18571. "allowNull": false,
  18572. "mapToData": null,
  18573. "validation": null,
  18574. "alias": null,
  18575. "deprecated": null
  18576. }
  18577. ],
  18578. "responses": [],
  18579. "renamed": null
  18580. },
  18581. {
  18582. "name": "Create a tag object",
  18583. "scope": "git",
  18584. "id": "createTag",
  18585. "method": "POST",
  18586. "url": "/repos/{owner}/{repo}/git/tags",
  18587. "isDeprecated": false,
  18588. "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/enterprise/2.17/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/enterprise/2.17/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
  18589. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/tags/#create-a-tag-object",
  18590. "previews": [],
  18591. "headers": [],
  18592. "parameters": [
  18593. {
  18594. "name": "owner",
  18595. "description": "owner parameter",
  18596. "in": "PATH",
  18597. "type": "string",
  18598. "required": true,
  18599. "enum": null,
  18600. "allowNull": false,
  18601. "mapToData": null,
  18602. "validation": null,
  18603. "alias": null,
  18604. "deprecated": null
  18605. },
  18606. {
  18607. "name": "repo",
  18608. "description": "repo parameter",
  18609. "in": "PATH",
  18610. "type": "string",
  18611. "required": true,
  18612. "enum": null,
  18613. "allowNull": false,
  18614. "mapToData": null,
  18615. "validation": null,
  18616. "alias": null,
  18617. "deprecated": null
  18618. },
  18619. {
  18620. "name": "tag",
  18621. "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").",
  18622. "in": "BODY",
  18623. "type": "string",
  18624. "required": true,
  18625. "enum": null,
  18626. "allowNull": false,
  18627. "mapToData": null,
  18628. "validation": null,
  18629. "alias": null,
  18630. "deprecated": null
  18631. },
  18632. {
  18633. "name": "message",
  18634. "description": "The tag message.",
  18635. "in": "BODY",
  18636. "type": "string",
  18637. "required": true,
  18638. "enum": null,
  18639. "allowNull": false,
  18640. "mapToData": null,
  18641. "validation": null,
  18642. "alias": null,
  18643. "deprecated": null
  18644. },
  18645. {
  18646. "name": "object",
  18647. "description": "The SHA of the git object this is tagging.",
  18648. "in": "BODY",
  18649. "type": "string",
  18650. "required": true,
  18651. "enum": null,
  18652. "allowNull": false,
  18653. "mapToData": null,
  18654. "validation": null,
  18655. "alias": null,
  18656. "deprecated": null
  18657. },
  18658. {
  18659. "name": "type",
  18660. "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.",
  18661. "in": "BODY",
  18662. "type": "string",
  18663. "required": true,
  18664. "enum": ["commit", "tree", "blob"],
  18665. "allowNull": false,
  18666. "mapToData": null,
  18667. "validation": null,
  18668. "alias": null,
  18669. "deprecated": null
  18670. },
  18671. {
  18672. "name": "tagger",
  18673. "description": "An object with information about the individual creating the tag.",
  18674. "in": "BODY",
  18675. "type": "object",
  18676. "required": false,
  18677. "enum": null,
  18678. "allowNull": false,
  18679. "mapToData": null,
  18680. "validation": null,
  18681. "alias": null,
  18682. "deprecated": null
  18683. },
  18684. {
  18685. "name": "tagger.name",
  18686. "description": "The name of the author of the tag",
  18687. "in": "BODY",
  18688. "type": "string",
  18689. "required": false,
  18690. "enum": null,
  18691. "allowNull": false,
  18692. "mapToData": null,
  18693. "validation": null,
  18694. "alias": null,
  18695. "deprecated": null
  18696. },
  18697. {
  18698. "name": "tagger.email",
  18699. "description": "The email of the author of the tag",
  18700. "in": "BODY",
  18701. "type": "string",
  18702. "required": false,
  18703. "enum": null,
  18704. "allowNull": false,
  18705. "mapToData": null,
  18706. "validation": null,
  18707. "alias": null,
  18708. "deprecated": null
  18709. },
  18710. {
  18711. "name": "tagger.date",
  18712. "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  18713. "in": "BODY",
  18714. "type": "string",
  18715. "required": false,
  18716. "enum": null,
  18717. "allowNull": false,
  18718. "mapToData": null,
  18719. "validation": null,
  18720. "alias": null,
  18721. "deprecated": null
  18722. }
  18723. ],
  18724. "responses": [
  18725. {
  18726. "code": 201,
  18727. "description": "response",
  18728. "examples": [
  18729. {
  18730. "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}"
  18731. }
  18732. ]
  18733. }
  18734. ],
  18735. "renamed": null
  18736. },
  18737. {
  18738. "name": "Get a tag",
  18739. "scope": "git",
  18740. "id": "getTag",
  18741. "method": "GET",
  18742. "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}",
  18743. "isDeprecated": false,
  18744. "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |",
  18745. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/tags/#get-a-tag",
  18746. "previews": [],
  18747. "headers": [],
  18748. "parameters": [
  18749. {
  18750. "name": "owner",
  18751. "description": "owner parameter",
  18752. "in": "PATH",
  18753. "type": "string",
  18754. "required": true,
  18755. "enum": null,
  18756. "allowNull": false,
  18757. "mapToData": null,
  18758. "validation": null,
  18759. "alias": null,
  18760. "deprecated": null
  18761. },
  18762. {
  18763. "name": "repo",
  18764. "description": "repo parameter",
  18765. "in": "PATH",
  18766. "type": "string",
  18767. "required": true,
  18768. "enum": null,
  18769. "allowNull": false,
  18770. "mapToData": null,
  18771. "validation": null,
  18772. "alias": null,
  18773. "deprecated": null
  18774. },
  18775. {
  18776. "name": "tag_sha",
  18777. "description": "tag_sha parameter",
  18778. "in": "PATH",
  18779. "type": "string",
  18780. "required": true,
  18781. "enum": null,
  18782. "allowNull": false,
  18783. "mapToData": null,
  18784. "validation": null,
  18785. "alias": null,
  18786. "deprecated": null
  18787. }
  18788. ],
  18789. "responses": [
  18790. {
  18791. "code": 200,
  18792. "description": "response",
  18793. "examples": [
  18794. {
  18795. "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}"
  18796. }
  18797. ]
  18798. }
  18799. ],
  18800. "renamed": null
  18801. },
  18802. {
  18803. "name": "Create a tree",
  18804. "scope": "git",
  18805. "id": "createTree",
  18806. "method": "POST",
  18807. "url": "/repos/{owner}/{repo}/git/trees",
  18808. "isDeprecated": false,
  18809. "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://developer.github.com/enterprise/2.17/v3/git/commits/#create-a-commit)\" and \"[Update a reference](https://developer.github.com/enterprise/2.17/v3/git/refs/#update-a-reference).\"",
  18810. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/trees/#create-a-tree",
  18811. "previews": [],
  18812. "headers": [],
  18813. "parameters": [
  18814. {
  18815. "name": "owner",
  18816. "description": "owner parameter",
  18817. "in": "PATH",
  18818. "type": "string",
  18819. "required": true,
  18820. "enum": null,
  18821. "allowNull": false,
  18822. "mapToData": null,
  18823. "validation": null,
  18824. "alias": null,
  18825. "deprecated": null
  18826. },
  18827. {
  18828. "name": "repo",
  18829. "description": "repo parameter",
  18830. "in": "PATH",
  18831. "type": "string",
  18832. "required": true,
  18833. "enum": null,
  18834. "allowNull": false,
  18835. "mapToData": null,
  18836. "validation": null,
  18837. "alias": null,
  18838. "deprecated": null
  18839. },
  18840. {
  18841. "name": "tree",
  18842. "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.",
  18843. "in": "BODY",
  18844. "type": "object[]",
  18845. "required": true,
  18846. "enum": null,
  18847. "allowNull": false,
  18848. "mapToData": null,
  18849. "validation": null,
  18850. "alias": null,
  18851. "deprecated": null
  18852. },
  18853. {
  18854. "name": "tree[].path",
  18855. "description": "The file referenced in the tree.",
  18856. "in": "BODY",
  18857. "type": "string",
  18858. "required": false,
  18859. "enum": null,
  18860. "allowNull": false,
  18861. "mapToData": null,
  18862. "validation": null,
  18863. "alias": null,
  18864. "deprecated": null
  18865. },
  18866. {
  18867. "name": "tree[].mode",
  18868. "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.",
  18869. "in": "BODY",
  18870. "type": "string",
  18871. "required": false,
  18872. "enum": ["100644", "100755", "040000", "160000", "120000"],
  18873. "allowNull": false,
  18874. "mapToData": null,
  18875. "validation": null,
  18876. "alias": null,
  18877. "deprecated": null
  18878. },
  18879. {
  18880. "name": "tree[].type",
  18881. "description": "Either `blob`, `tree`, or `commit`.",
  18882. "in": "BODY",
  18883. "type": "string",
  18884. "required": false,
  18885. "enum": ["blob", "tree", "commit"],
  18886. "allowNull": false,
  18887. "mapToData": null,
  18888. "validation": null,
  18889. "alias": null,
  18890. "deprecated": null
  18891. },
  18892. {
  18893. "name": "tree[].sha",
  18894. "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.",
  18895. "in": "BODY",
  18896. "type": "string",
  18897. "required": false,
  18898. "enum": null,
  18899. "allowNull": true,
  18900. "mapToData": null,
  18901. "validation": null,
  18902. "alias": null,
  18903. "deprecated": null
  18904. },
  18905. {
  18906. "name": "tree[].content",
  18907. "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.",
  18908. "in": "BODY",
  18909. "type": "string",
  18910. "required": false,
  18911. "enum": null,
  18912. "allowNull": false,
  18913. "mapToData": null,
  18914. "validation": null,
  18915. "alias": null,
  18916. "deprecated": null
  18917. },
  18918. {
  18919. "name": "base_tree",
  18920. "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.",
  18921. "in": "BODY",
  18922. "type": "string",
  18923. "required": false,
  18924. "enum": null,
  18925. "allowNull": false,
  18926. "mapToData": null,
  18927. "validation": null,
  18928. "alias": null,
  18929. "deprecated": null
  18930. }
  18931. ],
  18932. "responses": [
  18933. {
  18934. "code": 201,
  18935. "description": "response",
  18936. "examples": [
  18937. {
  18938. "data": "{\"sha\":\"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}]}"
  18939. }
  18940. ]
  18941. }
  18942. ],
  18943. "renamed": null
  18944. },
  18945. {
  18946. "name": "Get a tree",
  18947. "scope": "git",
  18948. "id": "getTree",
  18949. "method": "GET",
  18950. "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}",
  18951. "isDeprecated": false,
  18952. "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.",
  18953. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/git/trees/#get-a-tree",
  18954. "previews": [],
  18955. "headers": [],
  18956. "parameters": [
  18957. {
  18958. "name": "owner",
  18959. "description": "owner parameter",
  18960. "in": "PATH",
  18961. "type": "string",
  18962. "required": true,
  18963. "enum": null,
  18964. "allowNull": false,
  18965. "mapToData": null,
  18966. "validation": null,
  18967. "alias": null,
  18968. "deprecated": null
  18969. },
  18970. {
  18971. "name": "repo",
  18972. "description": "repo parameter",
  18973. "in": "PATH",
  18974. "type": "string",
  18975. "required": true,
  18976. "enum": null,
  18977. "allowNull": false,
  18978. "mapToData": null,
  18979. "validation": null,
  18980. "alias": null,
  18981. "deprecated": null
  18982. },
  18983. {
  18984. "name": "tree_sha",
  18985. "description": "tree_sha parameter",
  18986. "in": "PATH",
  18987. "type": "string",
  18988. "required": true,
  18989. "enum": null,
  18990. "allowNull": false,
  18991. "mapToData": null,
  18992. "validation": null,
  18993. "alias": null,
  18994. "deprecated": null
  18995. },
  18996. {
  18997. "name": "recursive",
  18998. "description": "recursive parameter",
  18999. "in": "QUERY",
  19000. "type": "integer",
  19001. "required": false,
  19002. "enum": ["1"],
  19003. "allowNull": false,
  19004. "mapToData": null,
  19005. "validation": null,
  19006. "alias": null,
  19007. "deprecated": null
  19008. }
  19009. ],
  19010. "responses": [
  19011. {
  19012. "code": 200,
  19013. "description": "If `truncated` is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.",
  19014. "examples": null
  19015. }
  19016. ],
  19017. "renamed": null
  19018. },
  19019. {
  19020. "name": "List hooks",
  19021. "scope": "repos",
  19022. "id": "listHooks",
  19023. "method": "GET",
  19024. "url": "/repos/{owner}/{repo}/hooks",
  19025. "isDeprecated": false,
  19026. "description": "",
  19027. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#list-hooks",
  19028. "previews": [],
  19029. "headers": [],
  19030. "parameters": [
  19031. {
  19032. "name": "owner",
  19033. "description": "owner parameter",
  19034. "in": "PATH",
  19035. "type": "string",
  19036. "required": true,
  19037. "enum": null,
  19038. "allowNull": false,
  19039. "mapToData": null,
  19040. "validation": null,
  19041. "alias": null,
  19042. "deprecated": null
  19043. },
  19044. {
  19045. "name": "repo",
  19046. "description": "repo parameter",
  19047. "in": "PATH",
  19048. "type": "string",
  19049. "required": true,
  19050. "enum": null,
  19051. "allowNull": false,
  19052. "mapToData": null,
  19053. "validation": null,
  19054. "alias": null,
  19055. "deprecated": null
  19056. },
  19057. {
  19058. "name": "per_page",
  19059. "description": "Results per page (max 100)",
  19060. "in": "QUERY",
  19061. "type": "integer",
  19062. "required": false,
  19063. "enum": null,
  19064. "allowNull": false,
  19065. "mapToData": null,
  19066. "validation": null,
  19067. "alias": null,
  19068. "deprecated": null
  19069. },
  19070. {
  19071. "name": "page",
  19072. "description": "Page number of the results to fetch.",
  19073. "in": "QUERY",
  19074. "type": "integer",
  19075. "required": false,
  19076. "enum": null,
  19077. "allowNull": false,
  19078. "mapToData": null,
  19079. "validation": null,
  19080. "alias": null,
  19081. "deprecated": null
  19082. }
  19083. ],
  19084. "responses": [
  19085. {
  19086. "code": 200,
  19087. "description": "response",
  19088. "examples": [
  19089. {
  19090. "data": "[{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}]"
  19091. }
  19092. ]
  19093. }
  19094. ],
  19095. "renamed": null
  19096. },
  19097. {
  19098. "name": "Create a hook",
  19099. "scope": "repos",
  19100. "id": "createHook",
  19101. "method": "POST",
  19102. "url": "/repos/{owner}/{repo}/hooks",
  19103. "isDeprecated": false,
  19104. "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap.\n\n**Note:** GitHub Enterprise release 2.17 and higher no longer allows admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.17/v3/guides/replacing-github-services) to help you update your services to webhooks.\n\nHere's how you can create a hook that posts payloads in JSON format:",
  19105. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-a-hook",
  19106. "previews": [],
  19107. "headers": [],
  19108. "parameters": [
  19109. {
  19110. "name": "owner",
  19111. "description": "owner parameter",
  19112. "in": "PATH",
  19113. "type": "string",
  19114. "required": true,
  19115. "enum": null,
  19116. "allowNull": false,
  19117. "mapToData": null,
  19118. "validation": null,
  19119. "alias": null,
  19120. "deprecated": null
  19121. },
  19122. {
  19123. "name": "repo",
  19124. "description": "repo parameter",
  19125. "in": "PATH",
  19126. "type": "string",
  19127. "required": true,
  19128. "enum": null,
  19129. "allowNull": false,
  19130. "mapToData": null,
  19131. "validation": null,
  19132. "alias": null,
  19133. "deprecated": null
  19134. },
  19135. {
  19136. "name": "name",
  19137. "description": "Use `web` to create a webhook.",
  19138. "in": "BODY",
  19139. "type": "string",
  19140. "required": false,
  19141. "enum": null,
  19142. "allowNull": false,
  19143. "mapToData": null,
  19144. "validation": null,
  19145. "alias": null,
  19146. "deprecated": null
  19147. },
  19148. {
  19149. "name": "config",
  19150. "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-hook-config-params).",
  19151. "in": "BODY",
  19152. "type": "object",
  19153. "required": true,
  19154. "enum": null,
  19155. "allowNull": false,
  19156. "mapToData": null,
  19157. "validation": null,
  19158. "alias": null,
  19159. "deprecated": null
  19160. },
  19161. {
  19162. "name": "config.url",
  19163. "description": "The URL to which the payloads will be delivered.",
  19164. "in": "BODY",
  19165. "type": "string",
  19166. "required": true,
  19167. "enum": null,
  19168. "allowNull": false,
  19169. "mapToData": null,
  19170. "validation": null,
  19171. "alias": null,
  19172. "deprecated": null
  19173. },
  19174. {
  19175. "name": "config.content_type",
  19176. "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
  19177. "in": "BODY",
  19178. "type": "string",
  19179. "required": false,
  19180. "enum": null,
  19181. "allowNull": false,
  19182. "mapToData": null,
  19183. "validation": null,
  19184. "alias": null,
  19185. "deprecated": null
  19186. },
  19187. {
  19188. "name": "config.secret",
  19189. "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/enterprise/2.17/webhooks/#delivery-headers) header.",
  19190. "in": "BODY",
  19191. "type": "string",
  19192. "required": false,
  19193. "enum": null,
  19194. "allowNull": false,
  19195. "mapToData": null,
  19196. "validation": null,
  19197. "alias": null,
  19198. "deprecated": null
  19199. },
  19200. {
  19201. "name": "config.insecure_ssl",
  19202. "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
  19203. "in": "BODY",
  19204. "type": "string",
  19205. "required": false,
  19206. "enum": null,
  19207. "allowNull": false,
  19208. "mapToData": null,
  19209. "validation": null,
  19210. "alias": null,
  19211. "deprecated": null
  19212. },
  19213. {
  19214. "name": "events",
  19215. "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for.",
  19216. "in": "BODY",
  19217. "type": "string[]",
  19218. "required": false,
  19219. "enum": null,
  19220. "allowNull": false,
  19221. "mapToData": null,
  19222. "validation": null,
  19223. "alias": null,
  19224. "deprecated": null
  19225. },
  19226. {
  19227. "name": "active",
  19228. "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
  19229. "in": "BODY",
  19230. "type": "boolean",
  19231. "required": false,
  19232. "enum": null,
  19233. "allowNull": false,
  19234. "mapToData": null,
  19235. "validation": null,
  19236. "alias": null,
  19237. "deprecated": null
  19238. }
  19239. ],
  19240. "responses": [
  19241. {
  19242. "code": 201,
  19243. "description": "response",
  19244. "examples": [
  19245. {
  19246. "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}"
  19247. }
  19248. ]
  19249. }
  19250. ],
  19251. "renamed": null
  19252. },
  19253. {
  19254. "name": "Get single hook",
  19255. "scope": "repos",
  19256. "id": "getHook",
  19257. "method": "GET",
  19258. "url": "/repos/{owner}/{repo}/hooks/{hook_id}",
  19259. "isDeprecated": false,
  19260. "description": "",
  19261. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#get-single-hook",
  19262. "previews": [],
  19263. "headers": [],
  19264. "parameters": [
  19265. {
  19266. "name": "owner",
  19267. "description": "owner parameter",
  19268. "in": "PATH",
  19269. "type": "string",
  19270. "required": true,
  19271. "enum": null,
  19272. "allowNull": false,
  19273. "mapToData": null,
  19274. "validation": null,
  19275. "alias": null,
  19276. "deprecated": null
  19277. },
  19278. {
  19279. "name": "repo",
  19280. "description": "repo parameter",
  19281. "in": "PATH",
  19282. "type": "string",
  19283. "required": true,
  19284. "enum": null,
  19285. "allowNull": false,
  19286. "mapToData": null,
  19287. "validation": null,
  19288. "alias": null,
  19289. "deprecated": null
  19290. },
  19291. {
  19292. "name": "hook_id",
  19293. "description": "hook_id parameter",
  19294. "in": "PATH",
  19295. "type": "integer",
  19296. "required": true,
  19297. "enum": null,
  19298. "allowNull": false,
  19299. "mapToData": null,
  19300. "validation": null,
  19301. "alias": null,
  19302. "deprecated": null
  19303. }
  19304. ],
  19305. "responses": [
  19306. {
  19307. "code": 200,
  19308. "description": "response",
  19309. "examples": [
  19310. {
  19311. "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}"
  19312. }
  19313. ]
  19314. }
  19315. ],
  19316. "renamed": null
  19317. },
  19318. {
  19319. "name": "Edit a hook",
  19320. "scope": "repos",
  19321. "id": "updateHook",
  19322. "method": "PATCH",
  19323. "url": "/repos/{owner}/{repo}/hooks/{hook_id}",
  19324. "isDeprecated": false,
  19325. "description": "**Note:** GitHub Enterprise release 2.17 and higher no longer allows admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.17/v3/guides/replacing-github-services) to help you update your services to webhooks.",
  19326. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#edit-a-hook",
  19327. "previews": [],
  19328. "headers": [],
  19329. "parameters": [
  19330. {
  19331. "name": "owner",
  19332. "description": "owner parameter",
  19333. "in": "PATH",
  19334. "type": "string",
  19335. "required": true,
  19336. "enum": null,
  19337. "allowNull": false,
  19338. "mapToData": null,
  19339. "validation": null,
  19340. "alias": null,
  19341. "deprecated": null
  19342. },
  19343. {
  19344. "name": "repo",
  19345. "description": "repo parameter",
  19346. "in": "PATH",
  19347. "type": "string",
  19348. "required": true,
  19349. "enum": null,
  19350. "allowNull": false,
  19351. "mapToData": null,
  19352. "validation": null,
  19353. "alias": null,
  19354. "deprecated": null
  19355. },
  19356. {
  19357. "name": "hook_id",
  19358. "description": "hook_id parameter",
  19359. "in": "PATH",
  19360. "type": "integer",
  19361. "required": true,
  19362. "enum": null,
  19363. "allowNull": false,
  19364. "mapToData": null,
  19365. "validation": null,
  19366. "alias": null,
  19367. "deprecated": null
  19368. },
  19369. {
  19370. "name": "config",
  19371. "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.17/v3/repos/hooks/#create-hook-config-params).",
  19372. "in": "BODY",
  19373. "type": "object",
  19374. "required": false,
  19375. "enum": null,
  19376. "allowNull": false,
  19377. "mapToData": null,
  19378. "validation": null,
  19379. "alias": null,
  19380. "deprecated": null
  19381. },
  19382. {
  19383. "name": "config.url",
  19384. "description": "The URL to which the payloads will be delivered.",
  19385. "in": "BODY",
  19386. "type": "string",
  19387. "required": true,
  19388. "enum": null,
  19389. "allowNull": false,
  19390. "mapToData": null,
  19391. "validation": null,
  19392. "alias": null,
  19393. "deprecated": null
  19394. },
  19395. {
  19396. "name": "config.content_type",
  19397. "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.",
  19398. "in": "BODY",
  19399. "type": "string",
  19400. "required": false,
  19401. "enum": null,
  19402. "allowNull": false,
  19403. "mapToData": null,
  19404. "validation": null,
  19405. "alias": null,
  19406. "deprecated": null
  19407. },
  19408. {
  19409. "name": "config.secret",
  19410. "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/enterprise/2.17/webhooks/#delivery-headers) header.",
  19411. "in": "BODY",
  19412. "type": "string",
  19413. "required": false,
  19414. "enum": null,
  19415. "allowNull": false,
  19416. "mapToData": null,
  19417. "validation": null,
  19418. "alias": null,
  19419. "deprecated": null
  19420. },
  19421. {
  19422. "name": "config.insecure_ssl",
  19423. "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**",
  19424. "in": "BODY",
  19425. "type": "string",
  19426. "required": false,
  19427. "enum": null,
  19428. "allowNull": false,
  19429. "mapToData": null,
  19430. "validation": null,
  19431. "alias": null,
  19432. "deprecated": null
  19433. },
  19434. {
  19435. "name": "events",
  19436. "description": "Determines what [events](https://developer.github.com/enterprise/2.17/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.",
  19437. "in": "BODY",
  19438. "type": "string[]",
  19439. "required": false,
  19440. "enum": null,
  19441. "allowNull": false,
  19442. "mapToData": null,
  19443. "validation": null,
  19444. "alias": null,
  19445. "deprecated": null
  19446. },
  19447. {
  19448. "name": "add_events",
  19449. "description": "Determines a list of events to be added to the list of events that the Hook triggers for.",
  19450. "in": "BODY",
  19451. "type": "string[]",
  19452. "required": false,
  19453. "enum": null,
  19454. "allowNull": false,
  19455. "mapToData": null,
  19456. "validation": null,
  19457. "alias": null,
  19458. "deprecated": null
  19459. },
  19460. {
  19461. "name": "remove_events",
  19462. "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.",
  19463. "in": "BODY",
  19464. "type": "string[]",
  19465. "required": false,
  19466. "enum": null,
  19467. "allowNull": false,
  19468. "mapToData": null,
  19469. "validation": null,
  19470. "alias": null,
  19471. "deprecated": null
  19472. },
  19473. {
  19474. "name": "active",
  19475. "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.",
  19476. "in": "BODY",
  19477. "type": "boolean",
  19478. "required": false,
  19479. "enum": null,
  19480. "allowNull": false,
  19481. "mapToData": null,
  19482. "validation": null,
  19483. "alias": null,
  19484. "deprecated": null
  19485. }
  19486. ],
  19487. "responses": [
  19488. {
  19489. "code": 200,
  19490. "description": "response",
  19491. "examples": [
  19492. {
  19493. "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}"
  19494. }
  19495. ]
  19496. }
  19497. ],
  19498. "renamed": null
  19499. },
  19500. {
  19501. "name": "Delete a hook",
  19502. "scope": "repos",
  19503. "id": "deleteHook",
  19504. "method": "DELETE",
  19505. "url": "/repos/{owner}/{repo}/hooks/{hook_id}",
  19506. "isDeprecated": false,
  19507. "description": "",
  19508. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#delete-a-hook",
  19509. "previews": [],
  19510. "headers": [],
  19511. "parameters": [
  19512. {
  19513. "name": "owner",
  19514. "description": "owner parameter",
  19515. "in": "PATH",
  19516. "type": "string",
  19517. "required": true,
  19518. "enum": null,
  19519. "allowNull": false,
  19520. "mapToData": null,
  19521. "validation": null,
  19522. "alias": null,
  19523. "deprecated": null
  19524. },
  19525. {
  19526. "name": "repo",
  19527. "description": "repo parameter",
  19528. "in": "PATH",
  19529. "type": "string",
  19530. "required": true,
  19531. "enum": null,
  19532. "allowNull": false,
  19533. "mapToData": null,
  19534. "validation": null,
  19535. "alias": null,
  19536. "deprecated": null
  19537. },
  19538. {
  19539. "name": "hook_id",
  19540. "description": "hook_id parameter",
  19541. "in": "PATH",
  19542. "type": "integer",
  19543. "required": true,
  19544. "enum": null,
  19545. "allowNull": false,
  19546. "mapToData": null,
  19547. "validation": null,
  19548. "alias": null,
  19549. "deprecated": null
  19550. }
  19551. ],
  19552. "responses": [],
  19553. "renamed": null
  19554. },
  19555. {
  19556. "name": "Ping a hook",
  19557. "scope": "repos",
  19558. "id": "pingHook",
  19559. "method": "POST",
  19560. "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings",
  19561. "isDeprecated": false,
  19562. "description": "**Note:** GitHub Enterprise release 2.17 and higher no longer allows admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.17/v3/guides/replacing-github-services) to help you update your services to webhooks.\n\nThis will trigger a [ping event](https://developer.github.com/enterprise/2.17/webhooks/#ping-event) to be sent to the hook.",
  19563. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#ping-a-hook",
  19564. "previews": [],
  19565. "headers": [],
  19566. "parameters": [
  19567. {
  19568. "name": "owner",
  19569. "description": "owner parameter",
  19570. "in": "PATH",
  19571. "type": "string",
  19572. "required": true,
  19573. "enum": null,
  19574. "allowNull": false,
  19575. "mapToData": null,
  19576. "validation": null,
  19577. "alias": null,
  19578. "deprecated": null
  19579. },
  19580. {
  19581. "name": "repo",
  19582. "description": "repo parameter",
  19583. "in": "PATH",
  19584. "type": "string",
  19585. "required": true,
  19586. "enum": null,
  19587. "allowNull": false,
  19588. "mapToData": null,
  19589. "validation": null,
  19590. "alias": null,
  19591. "deprecated": null
  19592. },
  19593. {
  19594. "name": "hook_id",
  19595. "description": "hook_id parameter",
  19596. "in": "PATH",
  19597. "type": "integer",
  19598. "required": true,
  19599. "enum": null,
  19600. "allowNull": false,
  19601. "mapToData": null,
  19602. "validation": null,
  19603. "alias": null,
  19604. "deprecated": null
  19605. }
  19606. ],
  19607. "responses": [],
  19608. "renamed": null
  19609. },
  19610. {
  19611. "name": "Test a push hook",
  19612. "scope": "repos",
  19613. "id": "testPushHook",
  19614. "method": "POST",
  19615. "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests",
  19616. "isDeprecated": false,
  19617. "description": "**Note:** GitHub Enterprise release 2.17 and higher no longer allows admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.17/v3/guides/replacing-github-services) to help you update your services to webhooks.\n\nThis will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`",
  19618. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/hooks/#test-a-push-hook",
  19619. "previews": [],
  19620. "headers": [],
  19621. "parameters": [
  19622. {
  19623. "name": "owner",
  19624. "description": "owner parameter",
  19625. "in": "PATH",
  19626. "type": "string",
  19627. "required": true,
  19628. "enum": null,
  19629. "allowNull": false,
  19630. "mapToData": null,
  19631. "validation": null,
  19632. "alias": null,
  19633. "deprecated": null
  19634. },
  19635. {
  19636. "name": "repo",
  19637. "description": "repo parameter",
  19638. "in": "PATH",
  19639. "type": "string",
  19640. "required": true,
  19641. "enum": null,
  19642. "allowNull": false,
  19643. "mapToData": null,
  19644. "validation": null,
  19645. "alias": null,
  19646. "deprecated": null
  19647. },
  19648. {
  19649. "name": "hook_id",
  19650. "description": "hook_id parameter",
  19651. "in": "PATH",
  19652. "type": "integer",
  19653. "required": true,
  19654. "enum": null,
  19655. "allowNull": false,
  19656. "mapToData": null,
  19657. "validation": null,
  19658. "alias": null,
  19659. "deprecated": null
  19660. }
  19661. ],
  19662. "responses": [],
  19663. "renamed": null
  19664. },
  19665. {
  19666. "name": "Get a repository installation",
  19667. "scope": "apps",
  19668. "id": "getRepoInstallation",
  19669. "method": "GET",
  19670. "url": "/repos/{owner}/{repo}/installation",
  19671. "isDeprecated": false,
  19672. "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  19673. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-a-repository-installation",
  19674. "previews": [{ "name": "machine-man" }],
  19675. "headers": [
  19676. {
  19677. "name": "accept",
  19678. "value": "application/vnd.github.machine-man-preview+json"
  19679. }
  19680. ],
  19681. "parameters": [
  19682. {
  19683. "name": "owner",
  19684. "description": "owner parameter",
  19685. "in": "PATH",
  19686. "type": "string",
  19687. "required": true,
  19688. "enum": null,
  19689. "allowNull": false,
  19690. "mapToData": null,
  19691. "validation": null,
  19692. "alias": null,
  19693. "deprecated": null
  19694. },
  19695. {
  19696. "name": "repo",
  19697. "description": "repo parameter",
  19698. "in": "PATH",
  19699. "type": "string",
  19700. "required": true,
  19701. "enum": null,
  19702. "allowNull": false,
  19703. "mapToData": null,
  19704. "validation": null,
  19705. "alias": null,
  19706. "deprecated": null
  19707. }
  19708. ],
  19709. "responses": [
  19710. {
  19711. "code": 200,
  19712. "description": "response",
  19713. "examples": [
  19714. {
  19715. "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}"
  19716. }
  19717. ]
  19718. }
  19719. ],
  19720. "renamed": null
  19721. },
  19722. {
  19723. "name": "Get a repository installation",
  19724. "scope": "apps",
  19725. "id": "findRepoInstallation",
  19726. "method": "GET",
  19727. "url": "/repos/{owner}/{repo}/installation",
  19728. "isDeprecated": false,
  19729. "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  19730. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-a-repository-installation",
  19731. "previews": [{ "name": "machine-man" }],
  19732. "headers": [
  19733. {
  19734. "name": "accept",
  19735. "value": "application/vnd.github.machine-man-preview+json"
  19736. }
  19737. ],
  19738. "parameters": [
  19739. {
  19740. "name": "owner",
  19741. "description": "owner parameter",
  19742. "in": "PATH",
  19743. "type": "string",
  19744. "required": true,
  19745. "enum": null,
  19746. "allowNull": false,
  19747. "mapToData": null,
  19748. "validation": null,
  19749. "alias": null,
  19750. "deprecated": null
  19751. },
  19752. {
  19753. "name": "repo",
  19754. "description": "repo parameter",
  19755. "in": "PATH",
  19756. "type": "string",
  19757. "required": true,
  19758. "enum": null,
  19759. "allowNull": false,
  19760. "mapToData": null,
  19761. "validation": null,
  19762. "alias": null,
  19763. "deprecated": null
  19764. }
  19765. ],
  19766. "responses": [
  19767. {
  19768. "code": 200,
  19769. "description": "response",
  19770. "examples": [
  19771. {
  19772. "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}"
  19773. }
  19774. ]
  19775. }
  19776. ],
  19777. "renamed": {
  19778. "before": { "scope": "apps", "id": "findRepoInstallation" },
  19779. "after": { "scope": "apps", "id": "getRepoInstallation" },
  19780. "date": "2019-04-10",
  19781. "note": "\"Find repository installation\" renamed to \"Get a repository installation\""
  19782. }
  19783. },
  19784. {
  19785. "name": "List invitations for a repository",
  19786. "scope": "repos",
  19787. "id": "listInvitations",
  19788. "method": "GET",
  19789. "url": "/repos/{owner}/{repo}/invitations",
  19790. "isDeprecated": false,
  19791. "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.\n\n",
  19792. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/invitations/#list-invitations-for-a-repository",
  19793. "previews": [],
  19794. "headers": [],
  19795. "parameters": [
  19796. {
  19797. "name": "owner",
  19798. "description": "owner parameter",
  19799. "in": "PATH",
  19800. "type": "string",
  19801. "required": true,
  19802. "enum": null,
  19803. "allowNull": false,
  19804. "mapToData": null,
  19805. "validation": null,
  19806. "alias": null,
  19807. "deprecated": null
  19808. },
  19809. {
  19810. "name": "repo",
  19811. "description": "repo parameter",
  19812. "in": "PATH",
  19813. "type": "string",
  19814. "required": true,
  19815. "enum": null,
  19816. "allowNull": false,
  19817. "mapToData": null,
  19818. "validation": null,
  19819. "alias": null,
  19820. "deprecated": null
  19821. },
  19822. {
  19823. "name": "per_page",
  19824. "description": "Results per page (max 100)",
  19825. "in": "QUERY",
  19826. "type": "integer",
  19827. "required": false,
  19828. "enum": null,
  19829. "allowNull": false,
  19830. "mapToData": null,
  19831. "validation": null,
  19832. "alias": null,
  19833. "deprecated": null
  19834. },
  19835. {
  19836. "name": "page",
  19837. "description": "Page number of the results to fetch.",
  19838. "in": "QUERY",
  19839. "type": "integer",
  19840. "required": false,
  19841. "enum": null,
  19842. "allowNull": false,
  19843. "mapToData": null,
  19844. "validation": null,
  19845. "alias": null,
  19846. "deprecated": null
  19847. }
  19848. ],
  19849. "responses": [
  19850. {
  19851. "code": 200,
  19852. "description": "response",
  19853. "examples": [
  19854. {
  19855. "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}]"
  19856. }
  19857. ]
  19858. }
  19859. ],
  19860. "renamed": null
  19861. },
  19862. {
  19863. "name": "Delete a repository invitation",
  19864. "scope": "repos",
  19865. "id": "deleteInvitation",
  19866. "method": "DELETE",
  19867. "url": "/repos/{owner}/{repo}/invitations/{invitation_id}",
  19868. "isDeprecated": false,
  19869. "description": "",
  19870. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/invitations/#delete-a-repository-invitation",
  19871. "previews": [],
  19872. "headers": [],
  19873. "parameters": [
  19874. {
  19875. "name": "owner",
  19876. "description": "owner parameter",
  19877. "in": "PATH",
  19878. "type": "string",
  19879. "required": true,
  19880. "enum": null,
  19881. "allowNull": false,
  19882. "mapToData": null,
  19883. "validation": null,
  19884. "alias": null,
  19885. "deprecated": null
  19886. },
  19887. {
  19888. "name": "repo",
  19889. "description": "repo parameter",
  19890. "in": "PATH",
  19891. "type": "string",
  19892. "required": true,
  19893. "enum": null,
  19894. "allowNull": false,
  19895. "mapToData": null,
  19896. "validation": null,
  19897. "alias": null,
  19898. "deprecated": null
  19899. },
  19900. {
  19901. "name": "invitation_id",
  19902. "description": "invitation_id parameter",
  19903. "in": "PATH",
  19904. "type": "integer",
  19905. "required": true,
  19906. "enum": null,
  19907. "allowNull": false,
  19908. "mapToData": null,
  19909. "validation": null,
  19910. "alias": null,
  19911. "deprecated": null
  19912. }
  19913. ],
  19914. "responses": [],
  19915. "renamed": null
  19916. },
  19917. {
  19918. "name": "Update a repository invitation",
  19919. "scope": "repos",
  19920. "id": "updateInvitation",
  19921. "method": "PATCH",
  19922. "url": "/repos/{owner}/{repo}/invitations/{invitation_id}",
  19923. "isDeprecated": false,
  19924. "description": "",
  19925. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/invitations/#update-a-repository-invitation",
  19926. "previews": [],
  19927. "headers": [],
  19928. "parameters": [
  19929. {
  19930. "name": "owner",
  19931. "description": "owner parameter",
  19932. "in": "PATH",
  19933. "type": "string",
  19934. "required": true,
  19935. "enum": null,
  19936. "allowNull": false,
  19937. "mapToData": null,
  19938. "validation": null,
  19939. "alias": null,
  19940. "deprecated": null
  19941. },
  19942. {
  19943. "name": "repo",
  19944. "description": "repo parameter",
  19945. "in": "PATH",
  19946. "type": "string",
  19947. "required": true,
  19948. "enum": null,
  19949. "allowNull": false,
  19950. "mapToData": null,
  19951. "validation": null,
  19952. "alias": null,
  19953. "deprecated": null
  19954. },
  19955. {
  19956. "name": "invitation_id",
  19957. "description": "invitation_id parameter",
  19958. "in": "PATH",
  19959. "type": "integer",
  19960. "required": true,
  19961. "enum": null,
  19962. "allowNull": false,
  19963. "mapToData": null,
  19964. "validation": null,
  19965. "alias": null,
  19966. "deprecated": null
  19967. },
  19968. {
  19969. "name": "permissions",
  19970. "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.",
  19971. "in": "BODY",
  19972. "type": "string",
  19973. "required": false,
  19974. "enum": ["read", "write", "admin"],
  19975. "allowNull": false,
  19976. "mapToData": null,
  19977. "validation": null,
  19978. "alias": null,
  19979. "deprecated": null
  19980. }
  19981. ],
  19982. "responses": [
  19983. {
  19984. "code": 200,
  19985. "description": "response",
  19986. "examples": [
  19987. {
  19988. "data": "{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}"
  19989. }
  19990. ]
  19991. }
  19992. ],
  19993. "renamed": null
  19994. },
  19995. {
  19996. "name": "List issues for a repository",
  19997. "scope": "issues",
  19998. "id": "listForRepo",
  19999. "method": "GET",
  20000. "url": "/repos/{owner}/{repo}/issues",
  20001. "isDeprecated": false,
  20002. "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests)\" endpoint.",
  20003. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#list-issues-for-a-repository",
  20004. "previews": [],
  20005. "headers": [],
  20006. "parameters": [
  20007. {
  20008. "name": "owner",
  20009. "description": "owner parameter",
  20010. "in": "PATH",
  20011. "type": "string",
  20012. "required": true,
  20013. "enum": null,
  20014. "allowNull": false,
  20015. "mapToData": null,
  20016. "validation": null,
  20017. "alias": null,
  20018. "deprecated": null
  20019. },
  20020. {
  20021. "name": "repo",
  20022. "description": "repo parameter",
  20023. "in": "PATH",
  20024. "type": "string",
  20025. "required": true,
  20026. "enum": null,
  20027. "allowNull": false,
  20028. "mapToData": null,
  20029. "validation": null,
  20030. "alias": null,
  20031. "deprecated": null
  20032. },
  20033. {
  20034. "name": "milestone",
  20035. "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.",
  20036. "in": "QUERY",
  20037. "type": "string",
  20038. "required": false,
  20039. "enum": null,
  20040. "allowNull": false,
  20041. "mapToData": null,
  20042. "validation": null,
  20043. "alias": null,
  20044. "deprecated": null
  20045. },
  20046. {
  20047. "name": "state",
  20048. "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
  20049. "in": "QUERY",
  20050. "type": "string",
  20051. "required": false,
  20052. "enum": ["open", "closed", "all"],
  20053. "allowNull": false,
  20054. "mapToData": null,
  20055. "validation": null,
  20056. "alias": null,
  20057. "deprecated": null
  20058. },
  20059. {
  20060. "name": "assignee",
  20061. "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.",
  20062. "in": "QUERY",
  20063. "type": "string",
  20064. "required": false,
  20065. "enum": null,
  20066. "allowNull": false,
  20067. "mapToData": null,
  20068. "validation": null,
  20069. "alias": null,
  20070. "deprecated": null
  20071. },
  20072. {
  20073. "name": "creator",
  20074. "description": "The user that created the issue.",
  20075. "in": "QUERY",
  20076. "type": "string",
  20077. "required": false,
  20078. "enum": null,
  20079. "allowNull": false,
  20080. "mapToData": null,
  20081. "validation": null,
  20082. "alias": null,
  20083. "deprecated": null
  20084. },
  20085. {
  20086. "name": "mentioned",
  20087. "description": "A user that's mentioned in the issue.",
  20088. "in": "QUERY",
  20089. "type": "string",
  20090. "required": false,
  20091. "enum": null,
  20092. "allowNull": false,
  20093. "mapToData": null,
  20094. "validation": null,
  20095. "alias": null,
  20096. "deprecated": null
  20097. },
  20098. {
  20099. "name": "labels",
  20100. "description": "A list of comma separated label names. Example: `bug,ui,@high`",
  20101. "in": "QUERY",
  20102. "type": "string",
  20103. "required": false,
  20104. "enum": null,
  20105. "allowNull": false,
  20106. "mapToData": null,
  20107. "validation": null,
  20108. "alias": null,
  20109. "deprecated": null
  20110. },
  20111. {
  20112. "name": "sort",
  20113. "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
  20114. "in": "QUERY",
  20115. "type": "string",
  20116. "required": false,
  20117. "enum": ["created", "updated", "comments"],
  20118. "allowNull": false,
  20119. "mapToData": null,
  20120. "validation": null,
  20121. "alias": null,
  20122. "deprecated": null
  20123. },
  20124. {
  20125. "name": "direction",
  20126. "description": "The direction of the sort. Can be either `asc` or `desc`.",
  20127. "in": "QUERY",
  20128. "type": "string",
  20129. "required": false,
  20130. "enum": ["asc", "desc"],
  20131. "allowNull": false,
  20132. "mapToData": null,
  20133. "validation": null,
  20134. "alias": null,
  20135. "deprecated": null
  20136. },
  20137. {
  20138. "name": "since",
  20139. "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  20140. "in": "QUERY",
  20141. "type": "string",
  20142. "required": false,
  20143. "enum": null,
  20144. "allowNull": false,
  20145. "mapToData": null,
  20146. "validation": null,
  20147. "alias": null,
  20148. "deprecated": null
  20149. },
  20150. {
  20151. "name": "per_page",
  20152. "description": "Results per page (max 100)",
  20153. "in": "QUERY",
  20154. "type": "integer",
  20155. "required": false,
  20156. "enum": null,
  20157. "allowNull": false,
  20158. "mapToData": null,
  20159. "validation": null,
  20160. "alias": null,
  20161. "deprecated": null
  20162. },
  20163. {
  20164. "name": "page",
  20165. "description": "Page number of the results to fetch.",
  20166. "in": "QUERY",
  20167. "type": "integer",
  20168. "required": false,
  20169. "enum": null,
  20170. "allowNull": false,
  20171. "mapToData": null,
  20172. "validation": null,
  20173. "alias": null,
  20174. "deprecated": null
  20175. }
  20176. ],
  20177. "responses": [
  20178. {
  20179. "code": 200,
  20180. "description": "response",
  20181. "examples": [
  20182. {
  20183. "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}]"
  20184. }
  20185. ]
  20186. }
  20187. ],
  20188. "renamed": null
  20189. },
  20190. {
  20191. "name": "Create an issue",
  20192. "scope": "issues",
  20193. "id": "create",
  20194. "method": "POST",
  20195. "url": "/repos/{owner}/{repo}/issues",
  20196. "isDeprecated": false,
  20197. "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  20198. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#create-an-issue",
  20199. "previews": [],
  20200. "headers": [],
  20201. "parameters": [
  20202. {
  20203. "name": "owner",
  20204. "description": "owner parameter",
  20205. "in": "PATH",
  20206. "type": "string",
  20207. "required": true,
  20208. "enum": null,
  20209. "allowNull": false,
  20210. "mapToData": null,
  20211. "validation": null,
  20212. "alias": null,
  20213. "deprecated": null
  20214. },
  20215. {
  20216. "name": "repo",
  20217. "description": "repo parameter",
  20218. "in": "PATH",
  20219. "type": "string",
  20220. "required": true,
  20221. "enum": null,
  20222. "allowNull": false,
  20223. "mapToData": null,
  20224. "validation": null,
  20225. "alias": null,
  20226. "deprecated": null
  20227. },
  20228. {
  20229. "name": "title",
  20230. "description": "The title of the issue.",
  20231. "in": "BODY",
  20232. "type": "string",
  20233. "required": true,
  20234. "enum": null,
  20235. "allowNull": false,
  20236. "mapToData": null,
  20237. "validation": null,
  20238. "alias": null,
  20239. "deprecated": null
  20240. },
  20241. {
  20242. "name": "body",
  20243. "description": "The contents of the issue.",
  20244. "in": "BODY",
  20245. "type": "string",
  20246. "required": false,
  20247. "enum": null,
  20248. "allowNull": false,
  20249. "mapToData": null,
  20250. "validation": null,
  20251. "alias": null,
  20252. "deprecated": null
  20253. },
  20254. {
  20255. "name": "assignee",
  20256. "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_",
  20257. "in": "BODY",
  20258. "type": "string",
  20259. "required": false,
  20260. "enum": null,
  20261. "allowNull": false,
  20262. "mapToData": null,
  20263. "validation": null,
  20264. "alias": null,
  20265. "deprecated": null
  20266. },
  20267. {
  20268. "name": "milestone",
  20269. "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._",
  20270. "in": "BODY",
  20271. "type": "integer",
  20272. "required": false,
  20273. "enum": null,
  20274. "allowNull": false,
  20275. "mapToData": null,
  20276. "validation": null,
  20277. "alias": null,
  20278. "deprecated": null
  20279. },
  20280. {
  20281. "name": "labels",
  20282. "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._",
  20283. "in": "BODY",
  20284. "type": "string[]",
  20285. "required": false,
  20286. "enum": null,
  20287. "allowNull": false,
  20288. "mapToData": null,
  20289. "validation": null,
  20290. "alias": null,
  20291. "deprecated": null
  20292. },
  20293. {
  20294. "name": "assignees",
  20295. "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._",
  20296. "in": "BODY",
  20297. "type": "string[]",
  20298. "required": false,
  20299. "enum": null,
  20300. "allowNull": false,
  20301. "mapToData": null,
  20302. "validation": null,
  20303. "alias": null,
  20304. "deprecated": null
  20305. }
  20306. ],
  20307. "responses": [
  20308. {
  20309. "code": 201,
  20310. "description": "response",
  20311. "examples": [
  20312. {
  20313. "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  20314. }
  20315. ]
  20316. }
  20317. ],
  20318. "renamed": null
  20319. },
  20320. {
  20321. "name": "List comments in a repository",
  20322. "scope": "issues",
  20323. "id": "listCommentsForRepo",
  20324. "method": "GET",
  20325. "url": "/repos/{owner}/{repo}/issues/comments",
  20326. "isDeprecated": false,
  20327. "description": "By default, Issue Comments are ordered by ascending ID.",
  20328. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/comments/#list-comments-in-a-repository",
  20329. "previews": [],
  20330. "headers": [],
  20331. "parameters": [
  20332. {
  20333. "name": "owner",
  20334. "description": "owner parameter",
  20335. "in": "PATH",
  20336. "type": "string",
  20337. "required": true,
  20338. "enum": null,
  20339. "allowNull": false,
  20340. "mapToData": null,
  20341. "validation": null,
  20342. "alias": null,
  20343. "deprecated": null
  20344. },
  20345. {
  20346. "name": "repo",
  20347. "description": "repo parameter",
  20348. "in": "PATH",
  20349. "type": "string",
  20350. "required": true,
  20351. "enum": null,
  20352. "allowNull": false,
  20353. "mapToData": null,
  20354. "validation": null,
  20355. "alias": null,
  20356. "deprecated": null
  20357. },
  20358. {
  20359. "name": "sort",
  20360. "description": "Either `created` or `updated`.",
  20361. "in": "QUERY",
  20362. "type": "string",
  20363. "required": false,
  20364. "enum": ["created", "updated"],
  20365. "allowNull": false,
  20366. "mapToData": null,
  20367. "validation": null,
  20368. "alias": null,
  20369. "deprecated": null
  20370. },
  20371. {
  20372. "name": "direction",
  20373. "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.",
  20374. "in": "QUERY",
  20375. "type": "string",
  20376. "required": false,
  20377. "enum": ["asc", "desc"],
  20378. "allowNull": false,
  20379. "mapToData": null,
  20380. "validation": null,
  20381. "alias": null,
  20382. "deprecated": null
  20383. },
  20384. {
  20385. "name": "since",
  20386. "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  20387. "in": "QUERY",
  20388. "type": "string",
  20389. "required": false,
  20390. "enum": null,
  20391. "allowNull": false,
  20392. "mapToData": null,
  20393. "validation": null,
  20394. "alias": null,
  20395. "deprecated": null
  20396. }
  20397. ],
  20398. "responses": [
  20399. {
  20400. "code": 200,
  20401. "description": "response",
  20402. "examples": [
  20403. {
  20404. "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]"
  20405. }
  20406. ]
  20407. }
  20408. ],
  20409. "renamed": null
  20410. },
  20411. {
  20412. "name": "Get a single comment",
  20413. "scope": "issues",
  20414. "id": "getComment",
  20415. "method": "GET",
  20416. "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
  20417. "isDeprecated": false,
  20418. "description": "",
  20419. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/comments/#get-a-single-comment",
  20420. "previews": [],
  20421. "headers": [],
  20422. "parameters": [
  20423. {
  20424. "name": "owner",
  20425. "description": "owner parameter",
  20426. "in": "PATH",
  20427. "type": "string",
  20428. "required": true,
  20429. "enum": null,
  20430. "allowNull": false,
  20431. "mapToData": null,
  20432. "validation": null,
  20433. "alias": null,
  20434. "deprecated": null
  20435. },
  20436. {
  20437. "name": "repo",
  20438. "description": "repo parameter",
  20439. "in": "PATH",
  20440. "type": "string",
  20441. "required": true,
  20442. "enum": null,
  20443. "allowNull": false,
  20444. "mapToData": null,
  20445. "validation": null,
  20446. "alias": null,
  20447. "deprecated": null
  20448. },
  20449. {
  20450. "name": "comment_id",
  20451. "description": "comment_id parameter",
  20452. "in": "PATH",
  20453. "type": "integer",
  20454. "required": true,
  20455. "enum": null,
  20456. "allowNull": false,
  20457. "mapToData": null,
  20458. "validation": null,
  20459. "alias": null,
  20460. "deprecated": null
  20461. },
  20462. {
  20463. "name": "per_page",
  20464. "description": "Results per page (max 100)",
  20465. "in": "QUERY",
  20466. "type": "integer",
  20467. "required": false,
  20468. "enum": null,
  20469. "allowNull": false,
  20470. "mapToData": null,
  20471. "validation": null,
  20472. "alias": null,
  20473. "deprecated": null
  20474. },
  20475. {
  20476. "name": "page",
  20477. "description": "Page number of the results to fetch.",
  20478. "in": "QUERY",
  20479. "type": "integer",
  20480. "required": false,
  20481. "enum": null,
  20482. "allowNull": false,
  20483. "mapToData": null,
  20484. "validation": null,
  20485. "alias": null,
  20486. "deprecated": null
  20487. }
  20488. ],
  20489. "responses": [
  20490. {
  20491. "code": 200,
  20492. "description": "response",
  20493. "examples": [
  20494. {
  20495. "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}"
  20496. }
  20497. ]
  20498. }
  20499. ],
  20500. "renamed": null
  20501. },
  20502. {
  20503. "name": "Edit a comment",
  20504. "scope": "issues",
  20505. "id": "updateComment",
  20506. "method": "PATCH",
  20507. "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
  20508. "isDeprecated": false,
  20509. "description": "",
  20510. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/comments/#edit-a-comment",
  20511. "previews": [],
  20512. "headers": [],
  20513. "parameters": [
  20514. {
  20515. "name": "owner",
  20516. "description": "owner parameter",
  20517. "in": "PATH",
  20518. "type": "string",
  20519. "required": true,
  20520. "enum": null,
  20521. "allowNull": false,
  20522. "mapToData": null,
  20523. "validation": null,
  20524. "alias": null,
  20525. "deprecated": null
  20526. },
  20527. {
  20528. "name": "repo",
  20529. "description": "repo parameter",
  20530. "in": "PATH",
  20531. "type": "string",
  20532. "required": true,
  20533. "enum": null,
  20534. "allowNull": false,
  20535. "mapToData": null,
  20536. "validation": null,
  20537. "alias": null,
  20538. "deprecated": null
  20539. },
  20540. {
  20541. "name": "comment_id",
  20542. "description": "comment_id parameter",
  20543. "in": "PATH",
  20544. "type": "integer",
  20545. "required": true,
  20546. "enum": null,
  20547. "allowNull": false,
  20548. "mapToData": null,
  20549. "validation": null,
  20550. "alias": null,
  20551. "deprecated": null
  20552. },
  20553. {
  20554. "name": "body",
  20555. "description": "The contents of the comment.",
  20556. "in": "BODY",
  20557. "type": "string",
  20558. "required": true,
  20559. "enum": null,
  20560. "allowNull": false,
  20561. "mapToData": null,
  20562. "validation": null,
  20563. "alias": null,
  20564. "deprecated": null
  20565. }
  20566. ],
  20567. "responses": [
  20568. {
  20569. "code": 200,
  20570. "description": "response",
  20571. "examples": [
  20572. {
  20573. "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}"
  20574. }
  20575. ]
  20576. }
  20577. ],
  20578. "renamed": null
  20579. },
  20580. {
  20581. "name": "Delete a comment",
  20582. "scope": "issues",
  20583. "id": "deleteComment",
  20584. "method": "DELETE",
  20585. "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}",
  20586. "isDeprecated": false,
  20587. "description": "",
  20588. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/comments/#delete-a-comment",
  20589. "previews": [],
  20590. "headers": [],
  20591. "parameters": [
  20592. {
  20593. "name": "owner",
  20594. "description": "owner parameter",
  20595. "in": "PATH",
  20596. "type": "string",
  20597. "required": true,
  20598. "enum": null,
  20599. "allowNull": false,
  20600. "mapToData": null,
  20601. "validation": null,
  20602. "alias": null,
  20603. "deprecated": null
  20604. },
  20605. {
  20606. "name": "repo",
  20607. "description": "repo parameter",
  20608. "in": "PATH",
  20609. "type": "string",
  20610. "required": true,
  20611. "enum": null,
  20612. "allowNull": false,
  20613. "mapToData": null,
  20614. "validation": null,
  20615. "alias": null,
  20616. "deprecated": null
  20617. },
  20618. {
  20619. "name": "comment_id",
  20620. "description": "comment_id parameter",
  20621. "in": "PATH",
  20622. "type": "integer",
  20623. "required": true,
  20624. "enum": null,
  20625. "allowNull": false,
  20626. "mapToData": null,
  20627. "validation": null,
  20628. "alias": null,
  20629. "deprecated": null
  20630. }
  20631. ],
  20632. "responses": [],
  20633. "renamed": null
  20634. },
  20635. {
  20636. "name": "List reactions for an issue comment",
  20637. "scope": "reactions",
  20638. "id": "listForIssueComment",
  20639. "method": "GET",
  20640. "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
  20641. "isDeprecated": false,
  20642. "description": "List the reactions to an [issue comment](https://developer.github.com/enterprise/2.17/v3/issues/comments/).",
  20643. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#list-reactions-for-an-issue-comment",
  20644. "previews": [{ "name": "squirrel-girl" }],
  20645. "headers": [
  20646. {
  20647. "name": "accept",
  20648. "value": "application/vnd.github.squirrel-girl-preview+json"
  20649. }
  20650. ],
  20651. "parameters": [
  20652. {
  20653. "name": "owner",
  20654. "description": "owner parameter",
  20655. "in": "PATH",
  20656. "type": "string",
  20657. "required": true,
  20658. "enum": null,
  20659. "allowNull": false,
  20660. "mapToData": null,
  20661. "validation": null,
  20662. "alias": null,
  20663. "deprecated": null
  20664. },
  20665. {
  20666. "name": "repo",
  20667. "description": "repo parameter",
  20668. "in": "PATH",
  20669. "type": "string",
  20670. "required": true,
  20671. "enum": null,
  20672. "allowNull": false,
  20673. "mapToData": null,
  20674. "validation": null,
  20675. "alias": null,
  20676. "deprecated": null
  20677. },
  20678. {
  20679. "name": "comment_id",
  20680. "description": "comment_id parameter",
  20681. "in": "PATH",
  20682. "type": "integer",
  20683. "required": true,
  20684. "enum": null,
  20685. "allowNull": false,
  20686. "mapToData": null,
  20687. "validation": null,
  20688. "alias": null,
  20689. "deprecated": null
  20690. },
  20691. {
  20692. "name": "content",
  20693. "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.",
  20694. "in": "QUERY",
  20695. "type": "string",
  20696. "required": false,
  20697. "enum": [
  20698. "+1",
  20699. "-1",
  20700. "laugh",
  20701. "confused",
  20702. "heart",
  20703. "hooray",
  20704. "rocket",
  20705. "eyes"
  20706. ],
  20707. "allowNull": false,
  20708. "mapToData": null,
  20709. "validation": null,
  20710. "alias": null,
  20711. "deprecated": null
  20712. },
  20713. {
  20714. "name": "per_page",
  20715. "description": "Results per page (max 100)",
  20716. "in": "QUERY",
  20717. "type": "integer",
  20718. "required": false,
  20719. "enum": null,
  20720. "allowNull": false,
  20721. "mapToData": null,
  20722. "validation": null,
  20723. "alias": null,
  20724. "deprecated": null
  20725. },
  20726. {
  20727. "name": "page",
  20728. "description": "Page number of the results to fetch.",
  20729. "in": "QUERY",
  20730. "type": "integer",
  20731. "required": false,
  20732. "enum": null,
  20733. "allowNull": false,
  20734. "mapToData": null,
  20735. "validation": null,
  20736. "alias": null,
  20737. "deprecated": null
  20738. }
  20739. ],
  20740. "responses": [
  20741. {
  20742. "code": 200,
  20743. "description": "response",
  20744. "examples": [
  20745. {
  20746. "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]"
  20747. }
  20748. ]
  20749. }
  20750. ],
  20751. "renamed": null
  20752. },
  20753. {
  20754. "name": "Create reaction for an issue comment",
  20755. "scope": "reactions",
  20756. "id": "createForIssueComment",
  20757. "method": "POST",
  20758. "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions",
  20759. "isDeprecated": false,
  20760. "description": "Create a reaction to an [issue comment](https://developer.github.com/enterprise/2.17/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.",
  20761. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#create-reaction-for-an-issue-comment",
  20762. "previews": [{ "name": "squirrel-girl" }],
  20763. "headers": [
  20764. {
  20765. "name": "accept",
  20766. "value": "application/vnd.github.squirrel-girl-preview+json"
  20767. }
  20768. ],
  20769. "parameters": [
  20770. {
  20771. "name": "owner",
  20772. "description": "owner parameter",
  20773. "in": "PATH",
  20774. "type": "string",
  20775. "required": true,
  20776. "enum": null,
  20777. "allowNull": false,
  20778. "mapToData": null,
  20779. "validation": null,
  20780. "alias": null,
  20781. "deprecated": null
  20782. },
  20783. {
  20784. "name": "repo",
  20785. "description": "repo parameter",
  20786. "in": "PATH",
  20787. "type": "string",
  20788. "required": true,
  20789. "enum": null,
  20790. "allowNull": false,
  20791. "mapToData": null,
  20792. "validation": null,
  20793. "alias": null,
  20794. "deprecated": null
  20795. },
  20796. {
  20797. "name": "comment_id",
  20798. "description": "comment_id parameter",
  20799. "in": "PATH",
  20800. "type": "integer",
  20801. "required": true,
  20802. "enum": null,
  20803. "allowNull": false,
  20804. "mapToData": null,
  20805. "validation": null,
  20806. "alias": null,
  20807. "deprecated": null
  20808. },
  20809. {
  20810. "name": "content",
  20811. "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the issue comment.",
  20812. "in": "BODY",
  20813. "type": "string",
  20814. "required": true,
  20815. "enum": [
  20816. "+1",
  20817. "-1",
  20818. "laugh",
  20819. "confused",
  20820. "heart",
  20821. "hooray",
  20822. "rocket",
  20823. "eyes"
  20824. ],
  20825. "allowNull": false,
  20826. "mapToData": null,
  20827. "validation": null,
  20828. "alias": null,
  20829. "deprecated": null
  20830. }
  20831. ],
  20832. "responses": [
  20833. {
  20834. "code": 201,
  20835. "description": "response",
  20836. "examples": [
  20837. {
  20838. "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}"
  20839. }
  20840. ]
  20841. }
  20842. ],
  20843. "renamed": null
  20844. },
  20845. {
  20846. "name": "List events for a repository",
  20847. "scope": "issues",
  20848. "id": "listEventsForRepo",
  20849. "method": "GET",
  20850. "url": "/repos/{owner}/{repo}/issues/events",
  20851. "isDeprecated": false,
  20852. "description": "",
  20853. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/events/#list-events-for-a-repository",
  20854. "previews": [],
  20855. "headers": [],
  20856. "parameters": [
  20857. {
  20858. "name": "owner",
  20859. "description": "owner parameter",
  20860. "in": "PATH",
  20861. "type": "string",
  20862. "required": true,
  20863. "enum": null,
  20864. "allowNull": false,
  20865. "mapToData": null,
  20866. "validation": null,
  20867. "alias": null,
  20868. "deprecated": null
  20869. },
  20870. {
  20871. "name": "repo",
  20872. "description": "repo parameter",
  20873. "in": "PATH",
  20874. "type": "string",
  20875. "required": true,
  20876. "enum": null,
  20877. "allowNull": false,
  20878. "mapToData": null,
  20879. "validation": null,
  20880. "alias": null,
  20881. "deprecated": null
  20882. },
  20883. {
  20884. "name": "per_page",
  20885. "description": "Results per page (max 100)",
  20886. "in": "QUERY",
  20887. "type": "integer",
  20888. "required": false,
  20889. "enum": null,
  20890. "allowNull": false,
  20891. "mapToData": null,
  20892. "validation": null,
  20893. "alias": null,
  20894. "deprecated": null
  20895. },
  20896. {
  20897. "name": "page",
  20898. "description": "Page number of the results to fetch.",
  20899. "in": "QUERY",
  20900. "type": "integer",
  20901. "required": false,
  20902. "enum": null,
  20903. "allowNull": false,
  20904. "mapToData": null,
  20905. "validation": null,
  20906. "alias": null,
  20907. "deprecated": null
  20908. }
  20909. ],
  20910. "responses": [
  20911. {
  20912. "code": 200,
  20913. "description": "response",
  20914. "examples": [
  20915. {
  20916. "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}}]"
  20917. }
  20918. ]
  20919. }
  20920. ],
  20921. "renamed": null
  20922. },
  20923. {
  20924. "name": "Get a single event",
  20925. "scope": "issues",
  20926. "id": "getEvent",
  20927. "method": "GET",
  20928. "url": "/repos/{owner}/{repo}/issues/events/{event_id}",
  20929. "isDeprecated": false,
  20930. "description": "",
  20931. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/events/#get-a-single-event",
  20932. "previews": [],
  20933. "headers": [],
  20934. "parameters": [
  20935. {
  20936. "name": "owner",
  20937. "description": "owner parameter",
  20938. "in": "PATH",
  20939. "type": "string",
  20940. "required": true,
  20941. "enum": null,
  20942. "allowNull": false,
  20943. "mapToData": null,
  20944. "validation": null,
  20945. "alias": null,
  20946. "deprecated": null
  20947. },
  20948. {
  20949. "name": "repo",
  20950. "description": "repo parameter",
  20951. "in": "PATH",
  20952. "type": "string",
  20953. "required": true,
  20954. "enum": null,
  20955. "allowNull": false,
  20956. "mapToData": null,
  20957. "validation": null,
  20958. "alias": null,
  20959. "deprecated": null
  20960. },
  20961. {
  20962. "name": "event_id",
  20963. "description": "event_id parameter",
  20964. "in": "PATH",
  20965. "type": "integer",
  20966. "required": true,
  20967. "enum": null,
  20968. "allowNull": false,
  20969. "mapToData": null,
  20970. "validation": null,
  20971. "alias": null,
  20972. "deprecated": null
  20973. }
  20974. ],
  20975. "responses": [
  20976. {
  20977. "code": 200,
  20978. "description": "response",
  20979. "examples": [
  20980. {
  20981. "data": "{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}}"
  20982. }
  20983. ]
  20984. }
  20985. ],
  20986. "renamed": null
  20987. },
  20988. {
  20989. "name": "Get a single issue",
  20990. "scope": "issues",
  20991. "id": "get",
  20992. "method": "GET",
  20993. "url": "/repos/{owner}/{repo}/issues/{issue_number}",
  20994. "isDeprecated": false,
  20995. "description": "The API returns a [`301 Moved Permanently` status](https://developer.github.com/enterprise/2.17/v3/#http-redirects) if the issue was [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://developer.github.com/enterprise/2.17/v3/activity/events/types/#issuesevent) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests)\" endpoint.",
  20996. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#get-a-single-issue",
  20997. "previews": [],
  20998. "headers": [],
  20999. "parameters": [
  21000. {
  21001. "name": "owner",
  21002. "description": "owner parameter",
  21003. "in": "PATH",
  21004. "type": "string",
  21005. "required": true,
  21006. "enum": null,
  21007. "allowNull": false,
  21008. "mapToData": null,
  21009. "validation": null,
  21010. "alias": null,
  21011. "deprecated": null
  21012. },
  21013. {
  21014. "name": "repo",
  21015. "description": "repo parameter",
  21016. "in": "PATH",
  21017. "type": "string",
  21018. "required": true,
  21019. "enum": null,
  21020. "allowNull": false,
  21021. "mapToData": null,
  21022. "validation": null,
  21023. "alias": null,
  21024. "deprecated": null
  21025. },
  21026. {
  21027. "name": "issue_number",
  21028. "description": "issue_number parameter",
  21029. "in": "PATH",
  21030. "type": "integer",
  21031. "required": true,
  21032. "enum": null,
  21033. "allowNull": false,
  21034. "mapToData": null,
  21035. "validation": null,
  21036. "alias": null,
  21037. "deprecated": null
  21038. },
  21039. {
  21040. "name": "number",
  21041. "description": null,
  21042. "in": null,
  21043. "type": null,
  21044. "required": null,
  21045. "enum": null,
  21046. "allowNull": null,
  21047. "mapToData": null,
  21048. "validation": null,
  21049. "alias": "issue_number",
  21050. "deprecated": true
  21051. }
  21052. ],
  21053. "responses": [
  21054. {
  21055. "code": 200,
  21056. "description": "response",
  21057. "examples": [
  21058. {
  21059. "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  21060. }
  21061. ]
  21062. }
  21063. ],
  21064. "renamed": null
  21065. },
  21066. {
  21067. "name": "Edit an issue",
  21068. "scope": "issues",
  21069. "id": "update",
  21070. "method": "PATCH",
  21071. "url": "/repos/{owner}/{repo}/issues/{issue_number}",
  21072. "isDeprecated": false,
  21073. "description": "Issue owners and users with push access can edit an issue.",
  21074. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#edit-an-issue",
  21075. "previews": [],
  21076. "headers": [],
  21077. "parameters": [
  21078. {
  21079. "name": "owner",
  21080. "description": "owner parameter",
  21081. "in": "PATH",
  21082. "type": "string",
  21083. "required": true,
  21084. "enum": null,
  21085. "allowNull": false,
  21086. "mapToData": null,
  21087. "validation": null,
  21088. "alias": null,
  21089. "deprecated": null
  21090. },
  21091. {
  21092. "name": "repo",
  21093. "description": "repo parameter",
  21094. "in": "PATH",
  21095. "type": "string",
  21096. "required": true,
  21097. "enum": null,
  21098. "allowNull": false,
  21099. "mapToData": null,
  21100. "validation": null,
  21101. "alias": null,
  21102. "deprecated": null
  21103. },
  21104. {
  21105. "name": "issue_number",
  21106. "description": "issue_number parameter",
  21107. "in": "PATH",
  21108. "type": "integer",
  21109. "required": true,
  21110. "enum": null,
  21111. "allowNull": false,
  21112. "mapToData": null,
  21113. "validation": null,
  21114. "alias": null,
  21115. "deprecated": null
  21116. },
  21117. {
  21118. "name": "title",
  21119. "description": "The title of the issue.",
  21120. "in": "BODY",
  21121. "type": "string",
  21122. "required": false,
  21123. "enum": null,
  21124. "allowNull": false,
  21125. "mapToData": null,
  21126. "validation": null,
  21127. "alias": null,
  21128. "deprecated": null
  21129. },
  21130. {
  21131. "name": "body",
  21132. "description": "The contents of the issue.",
  21133. "in": "BODY",
  21134. "type": "string",
  21135. "required": false,
  21136. "enum": null,
  21137. "allowNull": false,
  21138. "mapToData": null,
  21139. "validation": null,
  21140. "alias": null,
  21141. "deprecated": null
  21142. },
  21143. {
  21144. "name": "assignee",
  21145. "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**",
  21146. "in": "BODY",
  21147. "type": "string",
  21148. "required": false,
  21149. "enum": null,
  21150. "allowNull": false,
  21151. "mapToData": null,
  21152. "validation": null,
  21153. "alias": null,
  21154. "deprecated": null
  21155. },
  21156. {
  21157. "name": "state",
  21158. "description": "State of the issue. Either `open` or `closed`.",
  21159. "in": "BODY",
  21160. "type": "string",
  21161. "required": false,
  21162. "enum": ["open", "closed"],
  21163. "allowNull": false,
  21164. "mapToData": null,
  21165. "validation": null,
  21166. "alias": null,
  21167. "deprecated": null
  21168. },
  21169. {
  21170. "name": "milestone",
  21171. "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._",
  21172. "in": "BODY",
  21173. "type": "integer",
  21174. "required": false,
  21175. "enum": null,
  21176. "allowNull": true,
  21177. "mapToData": null,
  21178. "validation": null,
  21179. "alias": null,
  21180. "deprecated": null
  21181. },
  21182. {
  21183. "name": "labels",
  21184. "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._",
  21185. "in": "BODY",
  21186. "type": "string[]",
  21187. "required": false,
  21188. "enum": null,
  21189. "allowNull": false,
  21190. "mapToData": null,
  21191. "validation": null,
  21192. "alias": null,
  21193. "deprecated": null
  21194. },
  21195. {
  21196. "name": "assignees",
  21197. "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._",
  21198. "in": "BODY",
  21199. "type": "string[]",
  21200. "required": false,
  21201. "enum": null,
  21202. "allowNull": false,
  21203. "mapToData": null,
  21204. "validation": null,
  21205. "alias": null,
  21206. "deprecated": null
  21207. },
  21208. {
  21209. "name": "number",
  21210. "description": null,
  21211. "in": null,
  21212. "type": null,
  21213. "required": null,
  21214. "enum": null,
  21215. "allowNull": null,
  21216. "mapToData": null,
  21217. "validation": null,
  21218. "alias": "issue_number",
  21219. "deprecated": true
  21220. }
  21221. ],
  21222. "responses": [
  21223. {
  21224. "code": 200,
  21225. "description": "response",
  21226. "examples": [
  21227. {
  21228. "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  21229. }
  21230. ]
  21231. }
  21232. ],
  21233. "renamed": null
  21234. },
  21235. {
  21236. "name": "Add assignees to an issue",
  21237. "scope": "issues",
  21238. "id": "addAssignees",
  21239. "method": "POST",
  21240. "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
  21241. "isDeprecated": false,
  21242. "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.\n\nThis example adds two assignees to the existing `octocat` assignee.",
  21243. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/assignees/#add-assignees-to-an-issue",
  21244. "previews": [],
  21245. "headers": [],
  21246. "parameters": [
  21247. {
  21248. "name": "owner",
  21249. "description": "owner parameter",
  21250. "in": "PATH",
  21251. "type": "string",
  21252. "required": true,
  21253. "enum": null,
  21254. "allowNull": false,
  21255. "mapToData": null,
  21256. "validation": null,
  21257. "alias": null,
  21258. "deprecated": null
  21259. },
  21260. {
  21261. "name": "repo",
  21262. "description": "repo parameter",
  21263. "in": "PATH",
  21264. "type": "string",
  21265. "required": true,
  21266. "enum": null,
  21267. "allowNull": false,
  21268. "mapToData": null,
  21269. "validation": null,
  21270. "alias": null,
  21271. "deprecated": null
  21272. },
  21273. {
  21274. "name": "issue_number",
  21275. "description": "issue_number parameter",
  21276. "in": "PATH",
  21277. "type": "integer",
  21278. "required": true,
  21279. "enum": null,
  21280. "allowNull": false,
  21281. "mapToData": null,
  21282. "validation": null,
  21283. "alias": null,
  21284. "deprecated": null
  21285. },
  21286. {
  21287. "name": "assignees",
  21288. "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._",
  21289. "in": "BODY",
  21290. "type": "string[]",
  21291. "required": false,
  21292. "enum": null,
  21293. "allowNull": false,
  21294. "mapToData": null,
  21295. "validation": null,
  21296. "alias": null,
  21297. "deprecated": null
  21298. },
  21299. {
  21300. "name": "number",
  21301. "description": null,
  21302. "in": null,
  21303. "type": null,
  21304. "required": null,
  21305. "enum": null,
  21306. "allowNull": null,
  21307. "mapToData": null,
  21308. "validation": null,
  21309. "alias": "issue_number",
  21310. "deprecated": true
  21311. }
  21312. ],
  21313. "responses": [
  21314. {
  21315. "code": 201,
  21316. "description": "response",
  21317. "examples": [
  21318. {
  21319. "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}"
  21320. }
  21321. ]
  21322. }
  21323. ],
  21324. "renamed": null
  21325. },
  21326. {
  21327. "name": "Remove assignees from an issue",
  21328. "scope": "issues",
  21329. "id": "removeAssignees",
  21330. "method": "DELETE",
  21331. "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees",
  21332. "isDeprecated": false,
  21333. "description": "Removes one or more assignees from an issue.\n\nThis example removes two of three assignees, leaving the `octocat` assignee.",
  21334. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/assignees/#remove-assignees-from-an-issue",
  21335. "previews": [],
  21336. "headers": [],
  21337. "parameters": [
  21338. {
  21339. "name": "owner",
  21340. "description": "owner parameter",
  21341. "in": "PATH",
  21342. "type": "string",
  21343. "required": true,
  21344. "enum": null,
  21345. "allowNull": false,
  21346. "mapToData": null,
  21347. "validation": null,
  21348. "alias": null,
  21349. "deprecated": null
  21350. },
  21351. {
  21352. "name": "repo",
  21353. "description": "repo parameter",
  21354. "in": "PATH",
  21355. "type": "string",
  21356. "required": true,
  21357. "enum": null,
  21358. "allowNull": false,
  21359. "mapToData": null,
  21360. "validation": null,
  21361. "alias": null,
  21362. "deprecated": null
  21363. },
  21364. {
  21365. "name": "issue_number",
  21366. "description": "issue_number parameter",
  21367. "in": "PATH",
  21368. "type": "integer",
  21369. "required": true,
  21370. "enum": null,
  21371. "allowNull": false,
  21372. "mapToData": null,
  21373. "validation": null,
  21374. "alias": null,
  21375. "deprecated": null
  21376. },
  21377. {
  21378. "name": "assignees",
  21379. "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._",
  21380. "in": "BODY",
  21381. "type": "string[]",
  21382. "required": false,
  21383. "enum": null,
  21384. "allowNull": false,
  21385. "mapToData": null,
  21386. "validation": null,
  21387. "alias": null,
  21388. "deprecated": null
  21389. },
  21390. {
  21391. "name": "number",
  21392. "description": null,
  21393. "in": null,
  21394. "type": null,
  21395. "required": null,
  21396. "enum": null,
  21397. "allowNull": null,
  21398. "mapToData": null,
  21399. "validation": null,
  21400. "alias": "issue_number",
  21401. "deprecated": true
  21402. }
  21403. ],
  21404. "responses": [
  21405. {
  21406. "code": 200,
  21407. "description": "response",
  21408. "examples": [
  21409. {
  21410. "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}"
  21411. }
  21412. ]
  21413. }
  21414. ],
  21415. "renamed": null
  21416. },
  21417. {
  21418. "name": "List comments on an issue",
  21419. "scope": "issues",
  21420. "id": "listComments",
  21421. "method": "GET",
  21422. "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
  21423. "isDeprecated": false,
  21424. "description": "Issue Comments are ordered by ascending ID.",
  21425. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/comments/#list-comments-on-an-issue",
  21426. "previews": [],
  21427. "headers": [],
  21428. "parameters": [
  21429. {
  21430. "name": "owner",
  21431. "description": "owner parameter",
  21432. "in": "PATH",
  21433. "type": "string",
  21434. "required": true,
  21435. "enum": null,
  21436. "allowNull": false,
  21437. "mapToData": null,
  21438. "validation": null,
  21439. "alias": null,
  21440. "deprecated": null
  21441. },
  21442. {
  21443. "name": "repo",
  21444. "description": "repo parameter",
  21445. "in": "PATH",
  21446. "type": "string",
  21447. "required": true,
  21448. "enum": null,
  21449. "allowNull": false,
  21450. "mapToData": null,
  21451. "validation": null,
  21452. "alias": null,
  21453. "deprecated": null
  21454. },
  21455. {
  21456. "name": "issue_number",
  21457. "description": "issue_number parameter",
  21458. "in": "PATH",
  21459. "type": "integer",
  21460. "required": true,
  21461. "enum": null,
  21462. "allowNull": false,
  21463. "mapToData": null,
  21464. "validation": null,
  21465. "alias": null,
  21466. "deprecated": null
  21467. },
  21468. {
  21469. "name": "since",
  21470. "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  21471. "in": "QUERY",
  21472. "type": "string",
  21473. "required": false,
  21474. "enum": null,
  21475. "allowNull": false,
  21476. "mapToData": null,
  21477. "validation": null,
  21478. "alias": null,
  21479. "deprecated": null
  21480. },
  21481. {
  21482. "name": "per_page",
  21483. "description": "Results per page (max 100)",
  21484. "in": "QUERY",
  21485. "type": "integer",
  21486. "required": false,
  21487. "enum": null,
  21488. "allowNull": false,
  21489. "mapToData": null,
  21490. "validation": null,
  21491. "alias": null,
  21492. "deprecated": null
  21493. },
  21494. {
  21495. "name": "page",
  21496. "description": "Page number of the results to fetch.",
  21497. "in": "QUERY",
  21498. "type": "integer",
  21499. "required": false,
  21500. "enum": null,
  21501. "allowNull": false,
  21502. "mapToData": null,
  21503. "validation": null,
  21504. "alias": null,
  21505. "deprecated": null
  21506. },
  21507. {
  21508. "name": "number",
  21509. "description": null,
  21510. "in": null,
  21511. "type": null,
  21512. "required": null,
  21513. "enum": null,
  21514. "allowNull": null,
  21515. "mapToData": null,
  21516. "validation": null,
  21517. "alias": "issue_number",
  21518. "deprecated": true
  21519. }
  21520. ],
  21521. "responses": [
  21522. {
  21523. "code": 200,
  21524. "description": "response",
  21525. "examples": [
  21526. {
  21527. "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]"
  21528. }
  21529. ]
  21530. }
  21531. ],
  21532. "renamed": null
  21533. },
  21534. {
  21535. "name": "Create a comment",
  21536. "scope": "issues",
  21537. "id": "createComment",
  21538. "method": "POST",
  21539. "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments",
  21540. "isDeprecated": false,
  21541. "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  21542. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/comments/#create-a-comment",
  21543. "previews": [],
  21544. "headers": [],
  21545. "parameters": [
  21546. {
  21547. "name": "owner",
  21548. "description": "owner parameter",
  21549. "in": "PATH",
  21550. "type": "string",
  21551. "required": true,
  21552. "enum": null,
  21553. "allowNull": false,
  21554. "mapToData": null,
  21555. "validation": null,
  21556. "alias": null,
  21557. "deprecated": null
  21558. },
  21559. {
  21560. "name": "repo",
  21561. "description": "repo parameter",
  21562. "in": "PATH",
  21563. "type": "string",
  21564. "required": true,
  21565. "enum": null,
  21566. "allowNull": false,
  21567. "mapToData": null,
  21568. "validation": null,
  21569. "alias": null,
  21570. "deprecated": null
  21571. },
  21572. {
  21573. "name": "issue_number",
  21574. "description": "issue_number parameter",
  21575. "in": "PATH",
  21576. "type": "integer",
  21577. "required": true,
  21578. "enum": null,
  21579. "allowNull": false,
  21580. "mapToData": null,
  21581. "validation": null,
  21582. "alias": null,
  21583. "deprecated": null
  21584. },
  21585. {
  21586. "name": "body",
  21587. "description": "The contents of the comment.",
  21588. "in": "BODY",
  21589. "type": "string",
  21590. "required": true,
  21591. "enum": null,
  21592. "allowNull": false,
  21593. "mapToData": null,
  21594. "validation": null,
  21595. "alias": null,
  21596. "deprecated": null
  21597. },
  21598. {
  21599. "name": "number",
  21600. "description": null,
  21601. "in": null,
  21602. "type": null,
  21603. "required": null,
  21604. "enum": null,
  21605. "allowNull": null,
  21606. "mapToData": null,
  21607. "validation": null,
  21608. "alias": "issue_number",
  21609. "deprecated": true
  21610. }
  21611. ],
  21612. "responses": [
  21613. {
  21614. "code": 201,
  21615. "description": "response",
  21616. "examples": [
  21617. {
  21618. "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}"
  21619. }
  21620. ]
  21621. }
  21622. ],
  21623. "renamed": null
  21624. },
  21625. {
  21626. "name": "List events for an issue",
  21627. "scope": "issues",
  21628. "id": "listEvents",
  21629. "method": "GET",
  21630. "url": "/repos/{owner}/{repo}/issues/{issue_number}/events",
  21631. "isDeprecated": false,
  21632. "description": "",
  21633. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/events/#list-events-for-an-issue",
  21634. "previews": [],
  21635. "headers": [],
  21636. "parameters": [
  21637. {
  21638. "name": "owner",
  21639. "description": "owner parameter",
  21640. "in": "PATH",
  21641. "type": "string",
  21642. "required": true,
  21643. "enum": null,
  21644. "allowNull": false,
  21645. "mapToData": null,
  21646. "validation": null,
  21647. "alias": null,
  21648. "deprecated": null
  21649. },
  21650. {
  21651. "name": "repo",
  21652. "description": "repo parameter",
  21653. "in": "PATH",
  21654. "type": "string",
  21655. "required": true,
  21656. "enum": null,
  21657. "allowNull": false,
  21658. "mapToData": null,
  21659. "validation": null,
  21660. "alias": null,
  21661. "deprecated": null
  21662. },
  21663. {
  21664. "name": "issue_number",
  21665. "description": "issue_number parameter",
  21666. "in": "PATH",
  21667. "type": "integer",
  21668. "required": true,
  21669. "enum": null,
  21670. "allowNull": false,
  21671. "mapToData": null,
  21672. "validation": null,
  21673. "alias": null,
  21674. "deprecated": null
  21675. },
  21676. {
  21677. "name": "per_page",
  21678. "description": "Results per page (max 100)",
  21679. "in": "QUERY",
  21680. "type": "integer",
  21681. "required": false,
  21682. "enum": null,
  21683. "allowNull": false,
  21684. "mapToData": null,
  21685. "validation": null,
  21686. "alias": null,
  21687. "deprecated": null
  21688. },
  21689. {
  21690. "name": "page",
  21691. "description": "Page number of the results to fetch.",
  21692. "in": "QUERY",
  21693. "type": "integer",
  21694. "required": false,
  21695. "enum": null,
  21696. "allowNull": false,
  21697. "mapToData": null,
  21698. "validation": null,
  21699. "alias": null,
  21700. "deprecated": null
  21701. },
  21702. {
  21703. "name": "number",
  21704. "description": null,
  21705. "in": null,
  21706. "type": null,
  21707. "required": null,
  21708. "enum": null,
  21709. "allowNull": null,
  21710. "mapToData": null,
  21711. "validation": null,
  21712. "alias": "issue_number",
  21713. "deprecated": true
  21714. }
  21715. ],
  21716. "responses": [
  21717. {
  21718. "code": 200,
  21719. "description": "response",
  21720. "examples": [
  21721. {
  21722. "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\"}]"
  21723. }
  21724. ]
  21725. }
  21726. ],
  21727. "renamed": null
  21728. },
  21729. {
  21730. "name": "List labels on an issue",
  21731. "scope": "issues",
  21732. "id": "listLabelsOnIssue",
  21733. "method": "GET",
  21734. "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
  21735. "isDeprecated": false,
  21736. "description": "",
  21737. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#list-labels-on-an-issue",
  21738. "previews": [],
  21739. "headers": [],
  21740. "parameters": [
  21741. {
  21742. "name": "owner",
  21743. "description": "owner parameter",
  21744. "in": "PATH",
  21745. "type": "string",
  21746. "required": true,
  21747. "enum": null,
  21748. "allowNull": false,
  21749. "mapToData": null,
  21750. "validation": null,
  21751. "alias": null,
  21752. "deprecated": null
  21753. },
  21754. {
  21755. "name": "repo",
  21756. "description": "repo parameter",
  21757. "in": "PATH",
  21758. "type": "string",
  21759. "required": true,
  21760. "enum": null,
  21761. "allowNull": false,
  21762. "mapToData": null,
  21763. "validation": null,
  21764. "alias": null,
  21765. "deprecated": null
  21766. },
  21767. {
  21768. "name": "issue_number",
  21769. "description": "issue_number parameter",
  21770. "in": "PATH",
  21771. "type": "integer",
  21772. "required": true,
  21773. "enum": null,
  21774. "allowNull": false,
  21775. "mapToData": null,
  21776. "validation": null,
  21777. "alias": null,
  21778. "deprecated": null
  21779. },
  21780. {
  21781. "name": "per_page",
  21782. "description": "Results per page (max 100)",
  21783. "in": "QUERY",
  21784. "type": "integer",
  21785. "required": false,
  21786. "enum": null,
  21787. "allowNull": false,
  21788. "mapToData": null,
  21789. "validation": null,
  21790. "alias": null,
  21791. "deprecated": null
  21792. },
  21793. {
  21794. "name": "page",
  21795. "description": "Page number of the results to fetch.",
  21796. "in": "QUERY",
  21797. "type": "integer",
  21798. "required": false,
  21799. "enum": null,
  21800. "allowNull": false,
  21801. "mapToData": null,
  21802. "validation": null,
  21803. "alias": null,
  21804. "deprecated": null
  21805. },
  21806. {
  21807. "name": "number",
  21808. "description": null,
  21809. "in": null,
  21810. "type": null,
  21811. "required": null,
  21812. "enum": null,
  21813. "allowNull": null,
  21814. "mapToData": null,
  21815. "validation": null,
  21816. "alias": "issue_number",
  21817. "deprecated": true
  21818. }
  21819. ],
  21820. "responses": [
  21821. {
  21822. "code": 200,
  21823. "description": "response",
  21824. "examples": [
  21825. {
  21826. "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
  21827. }
  21828. ]
  21829. }
  21830. ],
  21831. "renamed": null
  21832. },
  21833. {
  21834. "name": "Add labels to an issue",
  21835. "scope": "issues",
  21836. "id": "addLabels",
  21837. "method": "POST",
  21838. "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
  21839. "isDeprecated": false,
  21840. "description": "",
  21841. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#add-labels-to-an-issue",
  21842. "previews": [],
  21843. "headers": [],
  21844. "parameters": [
  21845. {
  21846. "name": "owner",
  21847. "description": "owner parameter",
  21848. "in": "PATH",
  21849. "type": "string",
  21850. "required": true,
  21851. "enum": null,
  21852. "allowNull": false,
  21853. "mapToData": null,
  21854. "validation": null,
  21855. "alias": null,
  21856. "deprecated": null
  21857. },
  21858. {
  21859. "name": "repo",
  21860. "description": "repo parameter",
  21861. "in": "PATH",
  21862. "type": "string",
  21863. "required": true,
  21864. "enum": null,
  21865. "allowNull": false,
  21866. "mapToData": null,
  21867. "validation": null,
  21868. "alias": null,
  21869. "deprecated": null
  21870. },
  21871. {
  21872. "name": "issue_number",
  21873. "description": "issue_number parameter",
  21874. "in": "PATH",
  21875. "type": "integer",
  21876. "required": true,
  21877. "enum": null,
  21878. "allowNull": false,
  21879. "mapToData": null,
  21880. "validation": null,
  21881. "alias": null,
  21882. "deprecated": null
  21883. },
  21884. {
  21885. "name": "labels",
  21886. "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.",
  21887. "in": "BODY",
  21888. "type": "string[]",
  21889. "required": true,
  21890. "enum": null,
  21891. "allowNull": false,
  21892. "mapToData": null,
  21893. "validation": null,
  21894. "alias": null,
  21895. "deprecated": null
  21896. },
  21897. {
  21898. "name": "number",
  21899. "description": null,
  21900. "in": null,
  21901. "type": null,
  21902. "required": null,
  21903. "enum": null,
  21904. "allowNull": null,
  21905. "mapToData": null,
  21906. "validation": null,
  21907. "alias": "issue_number",
  21908. "deprecated": true
  21909. }
  21910. ],
  21911. "responses": [
  21912. {
  21913. "code": 200,
  21914. "description": "response",
  21915. "examples": [
  21916. {
  21917. "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
  21918. }
  21919. ]
  21920. }
  21921. ],
  21922. "renamed": null
  21923. },
  21924. {
  21925. "name": "Replace all labels for an issue",
  21926. "scope": "issues",
  21927. "id": "replaceLabels",
  21928. "method": "PUT",
  21929. "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
  21930. "isDeprecated": false,
  21931. "description": "",
  21932. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#replace-all-labels-for-an-issue",
  21933. "previews": [],
  21934. "headers": [],
  21935. "parameters": [
  21936. {
  21937. "name": "owner",
  21938. "description": "owner parameter",
  21939. "in": "PATH",
  21940. "type": "string",
  21941. "required": true,
  21942. "enum": null,
  21943. "allowNull": false,
  21944. "mapToData": null,
  21945. "validation": null,
  21946. "alias": null,
  21947. "deprecated": null
  21948. },
  21949. {
  21950. "name": "repo",
  21951. "description": "repo parameter",
  21952. "in": "PATH",
  21953. "type": "string",
  21954. "required": true,
  21955. "enum": null,
  21956. "allowNull": false,
  21957. "mapToData": null,
  21958. "validation": null,
  21959. "alias": null,
  21960. "deprecated": null
  21961. },
  21962. {
  21963. "name": "issue_number",
  21964. "description": "issue_number parameter",
  21965. "in": "PATH",
  21966. "type": "integer",
  21967. "required": true,
  21968. "enum": null,
  21969. "allowNull": false,
  21970. "mapToData": null,
  21971. "validation": null,
  21972. "alias": null,
  21973. "deprecated": null
  21974. },
  21975. {
  21976. "name": "labels",
  21977. "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.",
  21978. "in": "BODY",
  21979. "type": "string[]",
  21980. "required": false,
  21981. "enum": null,
  21982. "allowNull": false,
  21983. "mapToData": null,
  21984. "validation": null,
  21985. "alias": null,
  21986. "deprecated": null
  21987. },
  21988. {
  21989. "name": "number",
  21990. "description": null,
  21991. "in": null,
  21992. "type": null,
  21993. "required": null,
  21994. "enum": null,
  21995. "allowNull": null,
  21996. "mapToData": null,
  21997. "validation": null,
  21998. "alias": "issue_number",
  21999. "deprecated": true
  22000. }
  22001. ],
  22002. "responses": [
  22003. {
  22004. "code": 200,
  22005. "description": "response",
  22006. "examples": [
  22007. {
  22008. "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
  22009. }
  22010. ]
  22011. }
  22012. ],
  22013. "renamed": null
  22014. },
  22015. {
  22016. "name": "Remove all labels from an issue",
  22017. "scope": "issues",
  22018. "id": "removeLabels",
  22019. "method": "DELETE",
  22020. "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels",
  22021. "isDeprecated": false,
  22022. "description": "",
  22023. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#remove-all-labels-from-an-issue",
  22024. "previews": [],
  22025. "headers": [],
  22026. "parameters": [
  22027. {
  22028. "name": "owner",
  22029. "description": "owner parameter",
  22030. "in": "PATH",
  22031. "type": "string",
  22032. "required": true,
  22033. "enum": null,
  22034. "allowNull": false,
  22035. "mapToData": null,
  22036. "validation": null,
  22037. "alias": null,
  22038. "deprecated": null
  22039. },
  22040. {
  22041. "name": "repo",
  22042. "description": "repo parameter",
  22043. "in": "PATH",
  22044. "type": "string",
  22045. "required": true,
  22046. "enum": null,
  22047. "allowNull": false,
  22048. "mapToData": null,
  22049. "validation": null,
  22050. "alias": null,
  22051. "deprecated": null
  22052. },
  22053. {
  22054. "name": "issue_number",
  22055. "description": "issue_number parameter",
  22056. "in": "PATH",
  22057. "type": "integer",
  22058. "required": true,
  22059. "enum": null,
  22060. "allowNull": false,
  22061. "mapToData": null,
  22062. "validation": null,
  22063. "alias": null,
  22064. "deprecated": null
  22065. },
  22066. {
  22067. "name": "number",
  22068. "description": null,
  22069. "in": null,
  22070. "type": null,
  22071. "required": null,
  22072. "enum": null,
  22073. "allowNull": null,
  22074. "mapToData": null,
  22075. "validation": null,
  22076. "alias": "issue_number",
  22077. "deprecated": true
  22078. }
  22079. ],
  22080. "responses": [],
  22081. "renamed": null
  22082. },
  22083. {
  22084. "name": "Remove a label from an issue",
  22085. "scope": "issues",
  22086. "id": "removeLabel",
  22087. "method": "DELETE",
  22088. "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}",
  22089. "isDeprecated": false,
  22090. "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.",
  22091. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#remove-a-label-from-an-issue",
  22092. "previews": [],
  22093. "headers": [],
  22094. "parameters": [
  22095. {
  22096. "name": "owner",
  22097. "description": "owner parameter",
  22098. "in": "PATH",
  22099. "type": "string",
  22100. "required": true,
  22101. "enum": null,
  22102. "allowNull": false,
  22103. "mapToData": null,
  22104. "validation": null,
  22105. "alias": null,
  22106. "deprecated": null
  22107. },
  22108. {
  22109. "name": "repo",
  22110. "description": "repo parameter",
  22111. "in": "PATH",
  22112. "type": "string",
  22113. "required": true,
  22114. "enum": null,
  22115. "allowNull": false,
  22116. "mapToData": null,
  22117. "validation": null,
  22118. "alias": null,
  22119. "deprecated": null
  22120. },
  22121. {
  22122. "name": "issue_number",
  22123. "description": "issue_number parameter",
  22124. "in": "PATH",
  22125. "type": "integer",
  22126. "required": true,
  22127. "enum": null,
  22128. "allowNull": false,
  22129. "mapToData": null,
  22130. "validation": null,
  22131. "alias": null,
  22132. "deprecated": null
  22133. },
  22134. {
  22135. "name": "name",
  22136. "description": "name parameter",
  22137. "in": "PATH",
  22138. "type": "string",
  22139. "required": true,
  22140. "enum": null,
  22141. "allowNull": false,
  22142. "mapToData": null,
  22143. "validation": null,
  22144. "alias": null,
  22145. "deprecated": null
  22146. },
  22147. {
  22148. "name": "number",
  22149. "description": null,
  22150. "in": null,
  22151. "type": null,
  22152. "required": null,
  22153. "enum": null,
  22154. "allowNull": null,
  22155. "mapToData": null,
  22156. "validation": null,
  22157. "alias": "issue_number",
  22158. "deprecated": true
  22159. }
  22160. ],
  22161. "responses": [
  22162. {
  22163. "code": 200,
  22164. "description": "response",
  22165. "examples": [
  22166. {
  22167. "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}]"
  22168. }
  22169. ]
  22170. }
  22171. ],
  22172. "renamed": null
  22173. },
  22174. {
  22175. "name": "Lock an issue",
  22176. "scope": "issues",
  22177. "id": "lock",
  22178. "method": "PUT",
  22179. "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock",
  22180. "isDeprecated": false,
  22181. "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  22182. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#lock-an-issue",
  22183. "previews": [],
  22184. "headers": [],
  22185. "parameters": [
  22186. {
  22187. "name": "owner",
  22188. "description": "owner parameter",
  22189. "in": "PATH",
  22190. "type": "string",
  22191. "required": true,
  22192. "enum": null,
  22193. "allowNull": false,
  22194. "mapToData": null,
  22195. "validation": null,
  22196. "alias": null,
  22197. "deprecated": null
  22198. },
  22199. {
  22200. "name": "repo",
  22201. "description": "repo parameter",
  22202. "in": "PATH",
  22203. "type": "string",
  22204. "required": true,
  22205. "enum": null,
  22206. "allowNull": false,
  22207. "mapToData": null,
  22208. "validation": null,
  22209. "alias": null,
  22210. "deprecated": null
  22211. },
  22212. {
  22213. "name": "issue_number",
  22214. "description": "issue_number parameter",
  22215. "in": "PATH",
  22216. "type": "integer",
  22217. "required": true,
  22218. "enum": null,
  22219. "allowNull": false,
  22220. "mapToData": null,
  22221. "validation": null,
  22222. "alias": null,
  22223. "deprecated": null
  22224. },
  22225. {
  22226. "name": "lock_reason",
  22227. "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`",
  22228. "in": "BODY",
  22229. "type": "string",
  22230. "required": false,
  22231. "enum": ["off-topic", "too heated", "resolved", "spam"],
  22232. "allowNull": false,
  22233. "mapToData": null,
  22234. "validation": null,
  22235. "alias": null,
  22236. "deprecated": null
  22237. },
  22238. {
  22239. "name": "number",
  22240. "description": null,
  22241. "in": null,
  22242. "type": null,
  22243. "required": null,
  22244. "enum": null,
  22245. "allowNull": null,
  22246. "mapToData": null,
  22247. "validation": null,
  22248. "alias": "issue_number",
  22249. "deprecated": true
  22250. }
  22251. ],
  22252. "responses": [],
  22253. "renamed": null
  22254. },
  22255. {
  22256. "name": "Unlock an issue",
  22257. "scope": "issues",
  22258. "id": "unlock",
  22259. "method": "DELETE",
  22260. "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock",
  22261. "isDeprecated": false,
  22262. "description": "Users with push access can unlock an issue's conversation.",
  22263. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#unlock-an-issue",
  22264. "previews": [],
  22265. "headers": [],
  22266. "parameters": [
  22267. {
  22268. "name": "owner",
  22269. "description": "owner parameter",
  22270. "in": "PATH",
  22271. "type": "string",
  22272. "required": true,
  22273. "enum": null,
  22274. "allowNull": false,
  22275. "mapToData": null,
  22276. "validation": null,
  22277. "alias": null,
  22278. "deprecated": null
  22279. },
  22280. {
  22281. "name": "repo",
  22282. "description": "repo parameter",
  22283. "in": "PATH",
  22284. "type": "string",
  22285. "required": true,
  22286. "enum": null,
  22287. "allowNull": false,
  22288. "mapToData": null,
  22289. "validation": null,
  22290. "alias": null,
  22291. "deprecated": null
  22292. },
  22293. {
  22294. "name": "issue_number",
  22295. "description": "issue_number parameter",
  22296. "in": "PATH",
  22297. "type": "integer",
  22298. "required": true,
  22299. "enum": null,
  22300. "allowNull": false,
  22301. "mapToData": null,
  22302. "validation": null,
  22303. "alias": null,
  22304. "deprecated": null
  22305. },
  22306. {
  22307. "name": "number",
  22308. "description": null,
  22309. "in": null,
  22310. "type": null,
  22311. "required": null,
  22312. "enum": null,
  22313. "allowNull": null,
  22314. "mapToData": null,
  22315. "validation": null,
  22316. "alias": "issue_number",
  22317. "deprecated": true
  22318. }
  22319. ],
  22320. "responses": [],
  22321. "renamed": null
  22322. },
  22323. {
  22324. "name": "List reactions for an issue",
  22325. "scope": "reactions",
  22326. "id": "listForIssue",
  22327. "method": "GET",
  22328. "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions",
  22329. "isDeprecated": false,
  22330. "description": "List the reactions to an [issue](https://developer.github.com/enterprise/2.17/v3/issues/).",
  22331. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#list-reactions-for-an-issue",
  22332. "previews": [{ "name": "squirrel-girl" }],
  22333. "headers": [
  22334. {
  22335. "name": "accept",
  22336. "value": "application/vnd.github.squirrel-girl-preview+json"
  22337. }
  22338. ],
  22339. "parameters": [
  22340. {
  22341. "name": "owner",
  22342. "description": "owner parameter",
  22343. "in": "PATH",
  22344. "type": "string",
  22345. "required": true,
  22346. "enum": null,
  22347. "allowNull": false,
  22348. "mapToData": null,
  22349. "validation": null,
  22350. "alias": null,
  22351. "deprecated": null
  22352. },
  22353. {
  22354. "name": "repo",
  22355. "description": "repo parameter",
  22356. "in": "PATH",
  22357. "type": "string",
  22358. "required": true,
  22359. "enum": null,
  22360. "allowNull": false,
  22361. "mapToData": null,
  22362. "validation": null,
  22363. "alias": null,
  22364. "deprecated": null
  22365. },
  22366. {
  22367. "name": "issue_number",
  22368. "description": "issue_number parameter",
  22369. "in": "PATH",
  22370. "type": "integer",
  22371. "required": true,
  22372. "enum": null,
  22373. "allowNull": false,
  22374. "mapToData": null,
  22375. "validation": null,
  22376. "alias": null,
  22377. "deprecated": null
  22378. },
  22379. {
  22380. "name": "content",
  22381. "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.",
  22382. "in": "QUERY",
  22383. "type": "string",
  22384. "required": false,
  22385. "enum": [
  22386. "+1",
  22387. "-1",
  22388. "laugh",
  22389. "confused",
  22390. "heart",
  22391. "hooray",
  22392. "rocket",
  22393. "eyes"
  22394. ],
  22395. "allowNull": false,
  22396. "mapToData": null,
  22397. "validation": null,
  22398. "alias": null,
  22399. "deprecated": null
  22400. },
  22401. {
  22402. "name": "per_page",
  22403. "description": "Results per page (max 100)",
  22404. "in": "QUERY",
  22405. "type": "integer",
  22406. "required": false,
  22407. "enum": null,
  22408. "allowNull": false,
  22409. "mapToData": null,
  22410. "validation": null,
  22411. "alias": null,
  22412. "deprecated": null
  22413. },
  22414. {
  22415. "name": "page",
  22416. "description": "Page number of the results to fetch.",
  22417. "in": "QUERY",
  22418. "type": "integer",
  22419. "required": false,
  22420. "enum": null,
  22421. "allowNull": false,
  22422. "mapToData": null,
  22423. "validation": null,
  22424. "alias": null,
  22425. "deprecated": null
  22426. },
  22427. {
  22428. "name": "number",
  22429. "description": null,
  22430. "in": null,
  22431. "type": null,
  22432. "required": null,
  22433. "enum": null,
  22434. "allowNull": null,
  22435. "mapToData": null,
  22436. "validation": null,
  22437. "alias": "issue_number",
  22438. "deprecated": true
  22439. }
  22440. ],
  22441. "responses": [
  22442. {
  22443. "code": 200,
  22444. "description": "response",
  22445. "examples": [
  22446. {
  22447. "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]"
  22448. }
  22449. ]
  22450. }
  22451. ],
  22452. "renamed": null
  22453. },
  22454. {
  22455. "name": "Create reaction for an issue",
  22456. "scope": "reactions",
  22457. "id": "createForIssue",
  22458. "method": "POST",
  22459. "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions",
  22460. "isDeprecated": false,
  22461. "description": "Create a reaction to an [issue](https://developer.github.com/enterprise/2.17/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.",
  22462. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#create-reaction-for-an-issue",
  22463. "previews": [{ "name": "squirrel-girl" }],
  22464. "headers": [
  22465. {
  22466. "name": "accept",
  22467. "value": "application/vnd.github.squirrel-girl-preview+json"
  22468. }
  22469. ],
  22470. "parameters": [
  22471. {
  22472. "name": "owner",
  22473. "description": "owner parameter",
  22474. "in": "PATH",
  22475. "type": "string",
  22476. "required": true,
  22477. "enum": null,
  22478. "allowNull": false,
  22479. "mapToData": null,
  22480. "validation": null,
  22481. "alias": null,
  22482. "deprecated": null
  22483. },
  22484. {
  22485. "name": "repo",
  22486. "description": "repo parameter",
  22487. "in": "PATH",
  22488. "type": "string",
  22489. "required": true,
  22490. "enum": null,
  22491. "allowNull": false,
  22492. "mapToData": null,
  22493. "validation": null,
  22494. "alias": null,
  22495. "deprecated": null
  22496. },
  22497. {
  22498. "name": "issue_number",
  22499. "description": "issue_number parameter",
  22500. "in": "PATH",
  22501. "type": "integer",
  22502. "required": true,
  22503. "enum": null,
  22504. "allowNull": false,
  22505. "mapToData": null,
  22506. "validation": null,
  22507. "alias": null,
  22508. "deprecated": null
  22509. },
  22510. {
  22511. "name": "content",
  22512. "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the issue.",
  22513. "in": "BODY",
  22514. "type": "string",
  22515. "required": true,
  22516. "enum": [
  22517. "+1",
  22518. "-1",
  22519. "laugh",
  22520. "confused",
  22521. "heart",
  22522. "hooray",
  22523. "rocket",
  22524. "eyes"
  22525. ],
  22526. "allowNull": false,
  22527. "mapToData": null,
  22528. "validation": null,
  22529. "alias": null,
  22530. "deprecated": null
  22531. },
  22532. {
  22533. "name": "number",
  22534. "description": null,
  22535. "in": null,
  22536. "type": null,
  22537. "required": null,
  22538. "enum": null,
  22539. "allowNull": null,
  22540. "mapToData": null,
  22541. "validation": null,
  22542. "alias": "issue_number",
  22543. "deprecated": true
  22544. }
  22545. ],
  22546. "responses": [
  22547. {
  22548. "code": 201,
  22549. "description": "response",
  22550. "examples": [
  22551. {
  22552. "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}"
  22553. }
  22554. ]
  22555. }
  22556. ],
  22557. "renamed": null
  22558. },
  22559. {
  22560. "name": "List events for an issue",
  22561. "scope": "issues",
  22562. "id": "listEventsForTimeline",
  22563. "method": "GET",
  22564. "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline",
  22565. "isDeprecated": false,
  22566. "description": "",
  22567. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/timeline/#list-events-for-an-issue",
  22568. "previews": [{ "name": "mockingbird" }],
  22569. "headers": [
  22570. {
  22571. "name": "accept",
  22572. "value": "application/vnd.github.mockingbird-preview+json"
  22573. }
  22574. ],
  22575. "parameters": [
  22576. {
  22577. "name": "owner",
  22578. "description": "owner parameter",
  22579. "in": "PATH",
  22580. "type": "string",
  22581. "required": true,
  22582. "enum": null,
  22583. "allowNull": false,
  22584. "mapToData": null,
  22585. "validation": null,
  22586. "alias": null,
  22587. "deprecated": null
  22588. },
  22589. {
  22590. "name": "repo",
  22591. "description": "repo parameter",
  22592. "in": "PATH",
  22593. "type": "string",
  22594. "required": true,
  22595. "enum": null,
  22596. "allowNull": false,
  22597. "mapToData": null,
  22598. "validation": null,
  22599. "alias": null,
  22600. "deprecated": null
  22601. },
  22602. {
  22603. "name": "issue_number",
  22604. "description": "issue_number parameter",
  22605. "in": "PATH",
  22606. "type": "integer",
  22607. "required": true,
  22608. "enum": null,
  22609. "allowNull": false,
  22610. "mapToData": null,
  22611. "validation": null,
  22612. "alias": null,
  22613. "deprecated": null
  22614. },
  22615. {
  22616. "name": "per_page",
  22617. "description": "Results per page (max 100)",
  22618. "in": "QUERY",
  22619. "type": "integer",
  22620. "required": false,
  22621. "enum": null,
  22622. "allowNull": false,
  22623. "mapToData": null,
  22624. "validation": null,
  22625. "alias": null,
  22626. "deprecated": null
  22627. },
  22628. {
  22629. "name": "page",
  22630. "description": "Page number of the results to fetch.",
  22631. "in": "QUERY",
  22632. "type": "integer",
  22633. "required": false,
  22634. "enum": null,
  22635. "allowNull": false,
  22636. "mapToData": null,
  22637. "validation": null,
  22638. "alias": null,
  22639. "deprecated": null
  22640. },
  22641. {
  22642. "name": "number",
  22643. "description": null,
  22644. "in": null,
  22645. "type": null,
  22646. "required": null,
  22647. "enum": null,
  22648. "allowNull": null,
  22649. "mapToData": null,
  22650. "validation": null,
  22651. "alias": "issue_number",
  22652. "deprecated": true
  22653. }
  22654. ],
  22655. "responses": [
  22656. {
  22657. "code": 200,
  22658. "description": "response",
  22659. "examples": [
  22660. {
  22661. "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\"}]"
  22662. }
  22663. ]
  22664. }
  22665. ],
  22666. "renamed": null
  22667. },
  22668. {
  22669. "name": "List deploy keys",
  22670. "scope": "repos",
  22671. "id": "listDeployKeys",
  22672. "method": "GET",
  22673. "url": "/repos/{owner}/{repo}/keys",
  22674. "isDeprecated": false,
  22675. "description": "",
  22676. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/keys/#list-deploy-keys",
  22677. "previews": [],
  22678. "headers": [],
  22679. "parameters": [
  22680. {
  22681. "name": "owner",
  22682. "description": "owner parameter",
  22683. "in": "PATH",
  22684. "type": "string",
  22685. "required": true,
  22686. "enum": null,
  22687. "allowNull": false,
  22688. "mapToData": null,
  22689. "validation": null,
  22690. "alias": null,
  22691. "deprecated": null
  22692. },
  22693. {
  22694. "name": "repo",
  22695. "description": "repo parameter",
  22696. "in": "PATH",
  22697. "type": "string",
  22698. "required": true,
  22699. "enum": null,
  22700. "allowNull": false,
  22701. "mapToData": null,
  22702. "validation": null,
  22703. "alias": null,
  22704. "deprecated": null
  22705. },
  22706. {
  22707. "name": "per_page",
  22708. "description": "Results per page (max 100)",
  22709. "in": "QUERY",
  22710. "type": "integer",
  22711. "required": false,
  22712. "enum": null,
  22713. "allowNull": false,
  22714. "mapToData": null,
  22715. "validation": null,
  22716. "alias": null,
  22717. "deprecated": null
  22718. },
  22719. {
  22720. "name": "page",
  22721. "description": "Page number of the results to fetch.",
  22722. "in": "QUERY",
  22723. "type": "integer",
  22724. "required": false,
  22725. "enum": null,
  22726. "allowNull": false,
  22727. "mapToData": null,
  22728. "validation": null,
  22729. "alias": null,
  22730. "deprecated": null
  22731. }
  22732. ],
  22733. "responses": [
  22734. {
  22735. "code": 200,
  22736. "description": "response",
  22737. "examples": [
  22738. {
  22739. "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}]"
  22740. }
  22741. ]
  22742. }
  22743. ],
  22744. "renamed": null
  22745. },
  22746. {
  22747. "name": "Add a new deploy key",
  22748. "scope": "repos",
  22749. "id": "addDeployKey",
  22750. "method": "POST",
  22751. "url": "/repos/{owner}/{repo}/keys",
  22752. "isDeprecated": false,
  22753. "description": "Here's how you can create a read-only deploy key:\n\n",
  22754. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/keys/#add-a-new-deploy-key",
  22755. "previews": [],
  22756. "headers": [],
  22757. "parameters": [
  22758. {
  22759. "name": "owner",
  22760. "description": "owner parameter",
  22761. "in": "PATH",
  22762. "type": "string",
  22763. "required": true,
  22764. "enum": null,
  22765. "allowNull": false,
  22766. "mapToData": null,
  22767. "validation": null,
  22768. "alias": null,
  22769. "deprecated": null
  22770. },
  22771. {
  22772. "name": "repo",
  22773. "description": "repo parameter",
  22774. "in": "PATH",
  22775. "type": "string",
  22776. "required": true,
  22777. "enum": null,
  22778. "allowNull": false,
  22779. "mapToData": null,
  22780. "validation": null,
  22781. "alias": null,
  22782. "deprecated": null
  22783. },
  22784. {
  22785. "name": "title",
  22786. "description": "A name for the key.",
  22787. "in": "BODY",
  22788. "type": "string",
  22789. "required": false,
  22790. "enum": null,
  22791. "allowNull": false,
  22792. "mapToData": null,
  22793. "validation": null,
  22794. "alias": null,
  22795. "deprecated": null
  22796. },
  22797. {
  22798. "name": "key",
  22799. "description": "The contents of the key.",
  22800. "in": "BODY",
  22801. "type": "string",
  22802. "required": true,
  22803. "enum": null,
  22804. "allowNull": false,
  22805. "mapToData": null,
  22806. "validation": null,
  22807. "alias": null,
  22808. "deprecated": null
  22809. },
  22810. {
  22811. "name": "read_only",
  22812. "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"",
  22813. "in": "BODY",
  22814. "type": "boolean",
  22815. "required": false,
  22816. "enum": null,
  22817. "allowNull": false,
  22818. "mapToData": null,
  22819. "validation": null,
  22820. "alias": null,
  22821. "deprecated": null
  22822. }
  22823. ],
  22824. "responses": [
  22825. {
  22826. "code": 201,
  22827. "description": "response",
  22828. "examples": [
  22829. {
  22830. "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}"
  22831. }
  22832. ]
  22833. }
  22834. ],
  22835. "renamed": null
  22836. },
  22837. {
  22838. "name": "Get a deploy key",
  22839. "scope": "repos",
  22840. "id": "getDeployKey",
  22841. "method": "GET",
  22842. "url": "/repos/{owner}/{repo}/keys/{key_id}",
  22843. "isDeprecated": false,
  22844. "description": "",
  22845. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/keys/#get-a-deploy-key",
  22846. "previews": [],
  22847. "headers": [],
  22848. "parameters": [
  22849. {
  22850. "name": "owner",
  22851. "description": "owner parameter",
  22852. "in": "PATH",
  22853. "type": "string",
  22854. "required": true,
  22855. "enum": null,
  22856. "allowNull": false,
  22857. "mapToData": null,
  22858. "validation": null,
  22859. "alias": null,
  22860. "deprecated": null
  22861. },
  22862. {
  22863. "name": "repo",
  22864. "description": "repo parameter",
  22865. "in": "PATH",
  22866. "type": "string",
  22867. "required": true,
  22868. "enum": null,
  22869. "allowNull": false,
  22870. "mapToData": null,
  22871. "validation": null,
  22872. "alias": null,
  22873. "deprecated": null
  22874. },
  22875. {
  22876. "name": "key_id",
  22877. "description": "key_id parameter",
  22878. "in": "PATH",
  22879. "type": "integer",
  22880. "required": true,
  22881. "enum": null,
  22882. "allowNull": false,
  22883. "mapToData": null,
  22884. "validation": null,
  22885. "alias": null,
  22886. "deprecated": null
  22887. }
  22888. ],
  22889. "responses": [
  22890. {
  22891. "code": 200,
  22892. "description": "response",
  22893. "examples": [
  22894. {
  22895. "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}"
  22896. }
  22897. ]
  22898. }
  22899. ],
  22900. "renamed": null
  22901. },
  22902. {
  22903. "name": "Remove a deploy key",
  22904. "scope": "repos",
  22905. "id": "removeDeployKey",
  22906. "method": "DELETE",
  22907. "url": "/repos/{owner}/{repo}/keys/{key_id}",
  22908. "isDeprecated": false,
  22909. "description": "",
  22910. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/keys/#remove-a-deploy-key",
  22911. "previews": [],
  22912. "headers": [],
  22913. "parameters": [
  22914. {
  22915. "name": "owner",
  22916. "description": "owner parameter",
  22917. "in": "PATH",
  22918. "type": "string",
  22919. "required": true,
  22920. "enum": null,
  22921. "allowNull": false,
  22922. "mapToData": null,
  22923. "validation": null,
  22924. "alias": null,
  22925. "deprecated": null
  22926. },
  22927. {
  22928. "name": "repo",
  22929. "description": "repo parameter",
  22930. "in": "PATH",
  22931. "type": "string",
  22932. "required": true,
  22933. "enum": null,
  22934. "allowNull": false,
  22935. "mapToData": null,
  22936. "validation": null,
  22937. "alias": null,
  22938. "deprecated": null
  22939. },
  22940. {
  22941. "name": "key_id",
  22942. "description": "key_id parameter",
  22943. "in": "PATH",
  22944. "type": "integer",
  22945. "required": true,
  22946. "enum": null,
  22947. "allowNull": false,
  22948. "mapToData": null,
  22949. "validation": null,
  22950. "alias": null,
  22951. "deprecated": null
  22952. }
  22953. ],
  22954. "responses": [],
  22955. "renamed": null
  22956. },
  22957. {
  22958. "name": "List all labels for this repository",
  22959. "scope": "issues",
  22960. "id": "listLabelsForRepo",
  22961. "method": "GET",
  22962. "url": "/repos/{owner}/{repo}/labels",
  22963. "isDeprecated": false,
  22964. "description": "",
  22965. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#list-all-labels-for-this-repository",
  22966. "previews": [],
  22967. "headers": [],
  22968. "parameters": [
  22969. {
  22970. "name": "owner",
  22971. "description": "owner parameter",
  22972. "in": "PATH",
  22973. "type": "string",
  22974. "required": true,
  22975. "enum": null,
  22976. "allowNull": false,
  22977. "mapToData": null,
  22978. "validation": null,
  22979. "alias": null,
  22980. "deprecated": null
  22981. },
  22982. {
  22983. "name": "repo",
  22984. "description": "repo parameter",
  22985. "in": "PATH",
  22986. "type": "string",
  22987. "required": true,
  22988. "enum": null,
  22989. "allowNull": false,
  22990. "mapToData": null,
  22991. "validation": null,
  22992. "alias": null,
  22993. "deprecated": null
  22994. },
  22995. {
  22996. "name": "per_page",
  22997. "description": "Results per page (max 100)",
  22998. "in": "QUERY",
  22999. "type": "integer",
  23000. "required": false,
  23001. "enum": null,
  23002. "allowNull": false,
  23003. "mapToData": null,
  23004. "validation": null,
  23005. "alias": null,
  23006. "deprecated": null
  23007. },
  23008. {
  23009. "name": "page",
  23010. "description": "Page number of the results to fetch.",
  23011. "in": "QUERY",
  23012. "type": "integer",
  23013. "required": false,
  23014. "enum": null,
  23015. "allowNull": false,
  23016. "mapToData": null,
  23017. "validation": null,
  23018. "alias": null,
  23019. "deprecated": null
  23020. }
  23021. ],
  23022. "responses": [
  23023. {
  23024. "code": 200,
  23025. "description": "response",
  23026. "examples": [
  23027. {
  23028. "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
  23029. }
  23030. ]
  23031. }
  23032. ],
  23033. "renamed": null
  23034. },
  23035. {
  23036. "name": "Create a label",
  23037. "scope": "issues",
  23038. "id": "createLabel",
  23039. "method": "POST",
  23040. "url": "/repos/{owner}/{repo}/labels",
  23041. "isDeprecated": false,
  23042. "description": "",
  23043. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#create-a-label",
  23044. "previews": [],
  23045. "headers": [],
  23046. "parameters": [
  23047. {
  23048. "name": "owner",
  23049. "description": "owner parameter",
  23050. "in": "PATH",
  23051. "type": "string",
  23052. "required": true,
  23053. "enum": null,
  23054. "allowNull": false,
  23055. "mapToData": null,
  23056. "validation": null,
  23057. "alias": null,
  23058. "deprecated": null
  23059. },
  23060. {
  23061. "name": "repo",
  23062. "description": "repo parameter",
  23063. "in": "PATH",
  23064. "type": "string",
  23065. "required": true,
  23066. "enum": null,
  23067. "allowNull": false,
  23068. "mapToData": null,
  23069. "validation": null,
  23070. "alias": null,
  23071. "deprecated": null
  23072. },
  23073. {
  23074. "name": "name",
  23075. "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).",
  23076. "in": "BODY",
  23077. "type": "string",
  23078. "required": true,
  23079. "enum": null,
  23080. "allowNull": false,
  23081. "mapToData": null,
  23082. "validation": null,
  23083. "alias": null,
  23084. "deprecated": null
  23085. },
  23086. {
  23087. "name": "color",
  23088. "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
  23089. "in": "BODY",
  23090. "type": "string",
  23091. "required": true,
  23092. "enum": null,
  23093. "allowNull": false,
  23094. "mapToData": null,
  23095. "validation": null,
  23096. "alias": null,
  23097. "deprecated": null
  23098. },
  23099. {
  23100. "name": "description",
  23101. "description": "A short description of the label.",
  23102. "in": "BODY",
  23103. "type": "string",
  23104. "required": false,
  23105. "enum": null,
  23106. "allowNull": false,
  23107. "mapToData": null,
  23108. "validation": null,
  23109. "alias": null,
  23110. "deprecated": null
  23111. }
  23112. ],
  23113. "responses": [
  23114. {
  23115. "code": 201,
  23116. "description": "response",
  23117. "examples": [
  23118. {
  23119. "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}"
  23120. }
  23121. ]
  23122. }
  23123. ],
  23124. "renamed": null
  23125. },
  23126. {
  23127. "name": "Update a label",
  23128. "scope": "issues",
  23129. "id": "updateLabel",
  23130. "method": "PATCH",
  23131. "url": "/repos/{owner}/{repo}/labels/{current_name}",
  23132. "isDeprecated": false,
  23133. "description": "",
  23134. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#update-a-label",
  23135. "previews": [],
  23136. "headers": [],
  23137. "parameters": [
  23138. {
  23139. "name": "owner",
  23140. "description": "owner parameter",
  23141. "in": "PATH",
  23142. "type": "string",
  23143. "required": true,
  23144. "enum": null,
  23145. "allowNull": false,
  23146. "mapToData": null,
  23147. "validation": null,
  23148. "alias": null,
  23149. "deprecated": null
  23150. },
  23151. {
  23152. "name": "repo",
  23153. "description": "repo parameter",
  23154. "in": "PATH",
  23155. "type": "string",
  23156. "required": true,
  23157. "enum": null,
  23158. "allowNull": false,
  23159. "mapToData": null,
  23160. "validation": null,
  23161. "alias": null,
  23162. "deprecated": null
  23163. },
  23164. {
  23165. "name": "current_name",
  23166. "description": "current_name parameter",
  23167. "in": "PATH",
  23168. "type": "string",
  23169. "required": true,
  23170. "enum": null,
  23171. "allowNull": false,
  23172. "mapToData": null,
  23173. "validation": null,
  23174. "alias": null,
  23175. "deprecated": null
  23176. },
  23177. {
  23178. "name": "name",
  23179. "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).",
  23180. "in": "BODY",
  23181. "type": "string",
  23182. "required": false,
  23183. "enum": null,
  23184. "allowNull": false,
  23185. "mapToData": null,
  23186. "validation": null,
  23187. "alias": null,
  23188. "deprecated": null
  23189. },
  23190. {
  23191. "name": "color",
  23192. "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.",
  23193. "in": "BODY",
  23194. "type": "string",
  23195. "required": false,
  23196. "enum": null,
  23197. "allowNull": false,
  23198. "mapToData": null,
  23199. "validation": null,
  23200. "alias": null,
  23201. "deprecated": null
  23202. },
  23203. {
  23204. "name": "description",
  23205. "description": "A short description of the label.",
  23206. "in": "BODY",
  23207. "type": "string",
  23208. "required": false,
  23209. "enum": null,
  23210. "allowNull": false,
  23211. "mapToData": null,
  23212. "validation": null,
  23213. "alias": null,
  23214. "deprecated": null
  23215. }
  23216. ],
  23217. "responses": [
  23218. {
  23219. "code": 200,
  23220. "description": "response",
  23221. "examples": [
  23222. {
  23223. "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\"name\":\"bug :bug:\",\"description\":\"Small bug fix required\",\"color\":\"b01f26\",\"default\":true}"
  23224. }
  23225. ]
  23226. }
  23227. ],
  23228. "renamed": null
  23229. },
  23230. {
  23231. "name": "Get a single label",
  23232. "scope": "issues",
  23233. "id": "getLabel",
  23234. "method": "GET",
  23235. "url": "/repos/{owner}/{repo}/labels/{name}",
  23236. "isDeprecated": false,
  23237. "description": "",
  23238. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#get-a-single-label",
  23239. "previews": [],
  23240. "headers": [],
  23241. "parameters": [
  23242. {
  23243. "name": "owner",
  23244. "description": "owner parameter",
  23245. "in": "PATH",
  23246. "type": "string",
  23247. "required": true,
  23248. "enum": null,
  23249. "allowNull": false,
  23250. "mapToData": null,
  23251. "validation": null,
  23252. "alias": null,
  23253. "deprecated": null
  23254. },
  23255. {
  23256. "name": "repo",
  23257. "description": "repo parameter",
  23258. "in": "PATH",
  23259. "type": "string",
  23260. "required": true,
  23261. "enum": null,
  23262. "allowNull": false,
  23263. "mapToData": null,
  23264. "validation": null,
  23265. "alias": null,
  23266. "deprecated": null
  23267. },
  23268. {
  23269. "name": "name",
  23270. "description": "name parameter",
  23271. "in": "PATH",
  23272. "type": "string",
  23273. "required": true,
  23274. "enum": null,
  23275. "allowNull": false,
  23276. "mapToData": null,
  23277. "validation": null,
  23278. "alias": null,
  23279. "deprecated": null
  23280. }
  23281. ],
  23282. "responses": [
  23283. {
  23284. "code": 200,
  23285. "description": "response",
  23286. "examples": [
  23287. {
  23288. "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}"
  23289. }
  23290. ]
  23291. }
  23292. ],
  23293. "renamed": null
  23294. },
  23295. {
  23296. "name": "Delete a label",
  23297. "scope": "issues",
  23298. "id": "deleteLabel",
  23299. "method": "DELETE",
  23300. "url": "/repos/{owner}/{repo}/labels/{name}",
  23301. "isDeprecated": false,
  23302. "description": "",
  23303. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#delete-a-label",
  23304. "previews": [],
  23305. "headers": [],
  23306. "parameters": [
  23307. {
  23308. "name": "owner",
  23309. "description": "owner parameter",
  23310. "in": "PATH",
  23311. "type": "string",
  23312. "required": true,
  23313. "enum": null,
  23314. "allowNull": false,
  23315. "mapToData": null,
  23316. "validation": null,
  23317. "alias": null,
  23318. "deprecated": null
  23319. },
  23320. {
  23321. "name": "repo",
  23322. "description": "repo parameter",
  23323. "in": "PATH",
  23324. "type": "string",
  23325. "required": true,
  23326. "enum": null,
  23327. "allowNull": false,
  23328. "mapToData": null,
  23329. "validation": null,
  23330. "alias": null,
  23331. "deprecated": null
  23332. },
  23333. {
  23334. "name": "name",
  23335. "description": "name parameter",
  23336. "in": "PATH",
  23337. "type": "string",
  23338. "required": true,
  23339. "enum": null,
  23340. "allowNull": false,
  23341. "mapToData": null,
  23342. "validation": null,
  23343. "alias": null,
  23344. "deprecated": null
  23345. }
  23346. ],
  23347. "responses": [],
  23348. "renamed": null
  23349. },
  23350. {
  23351. "name": "List languages",
  23352. "scope": "repos",
  23353. "id": "listLanguages",
  23354. "method": "GET",
  23355. "url": "/repos/{owner}/{repo}/languages",
  23356. "isDeprecated": false,
  23357. "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.",
  23358. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-languages",
  23359. "previews": [],
  23360. "headers": [],
  23361. "parameters": [
  23362. {
  23363. "name": "owner",
  23364. "description": "owner parameter",
  23365. "in": "PATH",
  23366. "type": "string",
  23367. "required": true,
  23368. "enum": null,
  23369. "allowNull": false,
  23370. "mapToData": null,
  23371. "validation": null,
  23372. "alias": null,
  23373. "deprecated": null
  23374. },
  23375. {
  23376. "name": "repo",
  23377. "description": "repo parameter",
  23378. "in": "PATH",
  23379. "type": "string",
  23380. "required": true,
  23381. "enum": null,
  23382. "allowNull": false,
  23383. "mapToData": null,
  23384. "validation": null,
  23385. "alias": null,
  23386. "deprecated": null
  23387. }
  23388. ],
  23389. "responses": [
  23390. {
  23391. "code": 200,
  23392. "description": "response",
  23393. "examples": [{ "data": "{\"C\":78769,\"Python\":7769}" }]
  23394. }
  23395. ],
  23396. "renamed": null
  23397. },
  23398. {
  23399. "name": "Get the contents of a repository's license",
  23400. "scope": "licenses",
  23401. "id": "getForRepo",
  23402. "method": "GET",
  23403. "url": "/repos/{owner}/{repo}/license",
  23404. "isDeprecated": false,
  23405. "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [the repository contents API](https://developer.github.com/enterprise/2.17/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/enterprise/2.17/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.",
  23406. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/licenses/#get-the-contents-of-a-repositorys-license",
  23407. "previews": [],
  23408. "headers": [],
  23409. "parameters": [
  23410. {
  23411. "name": "owner",
  23412. "description": "owner parameter",
  23413. "in": "PATH",
  23414. "type": "string",
  23415. "required": true,
  23416. "enum": null,
  23417. "allowNull": false,
  23418. "mapToData": null,
  23419. "validation": null,
  23420. "alias": null,
  23421. "deprecated": null
  23422. },
  23423. {
  23424. "name": "repo",
  23425. "description": "repo parameter",
  23426. "in": "PATH",
  23427. "type": "string",
  23428. "required": true,
  23429. "enum": null,
  23430. "allowNull": false,
  23431. "mapToData": null,
  23432. "validation": null,
  23433. "alias": null,
  23434. "deprecated": null
  23435. }
  23436. ],
  23437. "responses": [
  23438. {
  23439. "code": 200,
  23440. "description": "response",
  23441. "examples": [
  23442. {
  23443. "data": "{\"name\":\"LICENSE\",\"path\":\"LICENSE\",\"sha\":\"401c59dcc4570b954dd6d345e76199e1f4e76266\",\"size\":1077,\"url\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"html_url\":\"https://github.com/benbalter/gman/blob/master/LICENSE\",\"git_url\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"download_url\":\"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\"type\":\"file\",\"content\":\"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\"encoding\":\"base64\",\"_links\":{\"self\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"git\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"html\":\"https://github.com/benbalter/gman/blob/master/LICENSE\"},\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}"
  23444. }
  23445. ]
  23446. }
  23447. ],
  23448. "renamed": null
  23449. },
  23450. {
  23451. "name": "Perform a merge",
  23452. "scope": "repos",
  23453. "id": "merge",
  23454. "method": "POST",
  23455. "url": "/repos/{owner}/{repo}/merges",
  23456. "isDeprecated": false,
  23457. "description": "",
  23458. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/merging/#perform-a-merge",
  23459. "previews": [],
  23460. "headers": [],
  23461. "parameters": [
  23462. {
  23463. "name": "owner",
  23464. "description": "owner parameter",
  23465. "in": "PATH",
  23466. "type": "string",
  23467. "required": true,
  23468. "enum": null,
  23469. "allowNull": false,
  23470. "mapToData": null,
  23471. "validation": null,
  23472. "alias": null,
  23473. "deprecated": null
  23474. },
  23475. {
  23476. "name": "repo",
  23477. "description": "repo parameter",
  23478. "in": "PATH",
  23479. "type": "string",
  23480. "required": true,
  23481. "enum": null,
  23482. "allowNull": false,
  23483. "mapToData": null,
  23484. "validation": null,
  23485. "alias": null,
  23486. "deprecated": null
  23487. },
  23488. {
  23489. "name": "base",
  23490. "description": "The name of the base branch that the head will be merged into.",
  23491. "in": "BODY",
  23492. "type": "string",
  23493. "required": true,
  23494. "enum": null,
  23495. "allowNull": false,
  23496. "mapToData": null,
  23497. "validation": null,
  23498. "alias": null,
  23499. "deprecated": null
  23500. },
  23501. {
  23502. "name": "head",
  23503. "description": "The head to merge. This can be a branch name or a commit SHA1.",
  23504. "in": "BODY",
  23505. "type": "string",
  23506. "required": true,
  23507. "enum": null,
  23508. "allowNull": false,
  23509. "mapToData": null,
  23510. "validation": null,
  23511. "alias": null,
  23512. "deprecated": null
  23513. },
  23514. {
  23515. "name": "commit_message",
  23516. "description": "Commit message to use for the merge commit. If omitted, a default message will be used.",
  23517. "in": "BODY",
  23518. "type": "string",
  23519. "required": false,
  23520. "enum": null,
  23521. "allowNull": false,
  23522. "mapToData": null,
  23523. "validation": null,
  23524. "alias": null,
  23525. "deprecated": null
  23526. }
  23527. ],
  23528. "responses": [
  23529. {
  23530. "code": 201,
  23531. "description": "Successful Response (The resulting merge commit)",
  23532. "examples": [
  23533. {
  23534. "data": "{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Shipped cool_feature!\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}]}"
  23535. }
  23536. ]
  23537. },
  23538. {
  23539. "code": 404,
  23540. "description": "response",
  23541. "examples": [
  23542. { "data": "{\"message\":\"Base does not exist\"}" },
  23543. { "data": "{\"message\":\"Head does not exist\"}" }
  23544. ]
  23545. },
  23546. {
  23547. "code": 409,
  23548. "description": "Merge conflict response",
  23549. "examples": [{ "data": "{\"message\":\"Merge Conflict\"}" }]
  23550. }
  23551. ],
  23552. "renamed": null
  23553. },
  23554. {
  23555. "name": "List milestones for a repository",
  23556. "scope": "issues",
  23557. "id": "listMilestonesForRepo",
  23558. "method": "GET",
  23559. "url": "/repos/{owner}/{repo}/milestones",
  23560. "isDeprecated": false,
  23561. "description": "",
  23562. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/milestones/#list-milestones-for-a-repository",
  23563. "previews": [],
  23564. "headers": [],
  23565. "parameters": [
  23566. {
  23567. "name": "owner",
  23568. "description": "owner parameter",
  23569. "in": "PATH",
  23570. "type": "string",
  23571. "required": true,
  23572. "enum": null,
  23573. "allowNull": false,
  23574. "mapToData": null,
  23575. "validation": null,
  23576. "alias": null,
  23577. "deprecated": null
  23578. },
  23579. {
  23580. "name": "repo",
  23581. "description": "repo parameter",
  23582. "in": "PATH",
  23583. "type": "string",
  23584. "required": true,
  23585. "enum": null,
  23586. "allowNull": false,
  23587. "mapToData": null,
  23588. "validation": null,
  23589. "alias": null,
  23590. "deprecated": null
  23591. },
  23592. {
  23593. "name": "state",
  23594. "description": "The state of the milestone. Either `open`, `closed`, or `all`.",
  23595. "in": "QUERY",
  23596. "type": "string",
  23597. "required": false,
  23598. "enum": ["open", "closed", "all"],
  23599. "allowNull": false,
  23600. "mapToData": null,
  23601. "validation": null,
  23602. "alias": null,
  23603. "deprecated": null
  23604. },
  23605. {
  23606. "name": "sort",
  23607. "description": "What to sort results by. Either `due_on` or `completeness`.",
  23608. "in": "QUERY",
  23609. "type": "string",
  23610. "required": false,
  23611. "enum": ["due_on", "completeness"],
  23612. "allowNull": false,
  23613. "mapToData": null,
  23614. "validation": null,
  23615. "alias": null,
  23616. "deprecated": null
  23617. },
  23618. {
  23619. "name": "direction",
  23620. "description": "The direction of the sort. Either `asc` or `desc`.",
  23621. "in": "QUERY",
  23622. "type": "string",
  23623. "required": false,
  23624. "enum": ["asc", "desc"],
  23625. "allowNull": false,
  23626. "mapToData": null,
  23627. "validation": null,
  23628. "alias": null,
  23629. "deprecated": null
  23630. },
  23631. {
  23632. "name": "per_page",
  23633. "description": "Results per page (max 100)",
  23634. "in": "QUERY",
  23635. "type": "integer",
  23636. "required": false,
  23637. "enum": null,
  23638. "allowNull": false,
  23639. "mapToData": null,
  23640. "validation": null,
  23641. "alias": null,
  23642. "deprecated": null
  23643. },
  23644. {
  23645. "name": "page",
  23646. "description": "Page number of the results to fetch.",
  23647. "in": "QUERY",
  23648. "type": "integer",
  23649. "required": false,
  23650. "enum": null,
  23651. "allowNull": false,
  23652. "mapToData": null,
  23653. "validation": null,
  23654. "alias": null,
  23655. "deprecated": null
  23656. }
  23657. ],
  23658. "responses": [
  23659. {
  23660. "code": 200,
  23661. "description": "response",
  23662. "examples": [
  23663. {
  23664. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}]"
  23665. }
  23666. ]
  23667. }
  23668. ],
  23669. "renamed": null
  23670. },
  23671. {
  23672. "name": "Create a milestone",
  23673. "scope": "issues",
  23674. "id": "createMilestone",
  23675. "method": "POST",
  23676. "url": "/repos/{owner}/{repo}/milestones",
  23677. "isDeprecated": false,
  23678. "description": "",
  23679. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/milestones/#create-a-milestone",
  23680. "previews": [],
  23681. "headers": [],
  23682. "parameters": [
  23683. {
  23684. "name": "owner",
  23685. "description": "owner parameter",
  23686. "in": "PATH",
  23687. "type": "string",
  23688. "required": true,
  23689. "enum": null,
  23690. "allowNull": false,
  23691. "mapToData": null,
  23692. "validation": null,
  23693. "alias": null,
  23694. "deprecated": null
  23695. },
  23696. {
  23697. "name": "repo",
  23698. "description": "repo parameter",
  23699. "in": "PATH",
  23700. "type": "string",
  23701. "required": true,
  23702. "enum": null,
  23703. "allowNull": false,
  23704. "mapToData": null,
  23705. "validation": null,
  23706. "alias": null,
  23707. "deprecated": null
  23708. },
  23709. {
  23710. "name": "title",
  23711. "description": "The title of the milestone.",
  23712. "in": "BODY",
  23713. "type": "string",
  23714. "required": true,
  23715. "enum": null,
  23716. "allowNull": false,
  23717. "mapToData": null,
  23718. "validation": null,
  23719. "alias": null,
  23720. "deprecated": null
  23721. },
  23722. {
  23723. "name": "state",
  23724. "description": "The state of the milestone. Either `open` or `closed`.",
  23725. "in": "BODY",
  23726. "type": "string",
  23727. "required": false,
  23728. "enum": ["open", "closed"],
  23729. "allowNull": false,
  23730. "mapToData": null,
  23731. "validation": null,
  23732. "alias": null,
  23733. "deprecated": null
  23734. },
  23735. {
  23736. "name": "description",
  23737. "description": "A description of the milestone.",
  23738. "in": "BODY",
  23739. "type": "string",
  23740. "required": false,
  23741. "enum": null,
  23742. "allowNull": false,
  23743. "mapToData": null,
  23744. "validation": null,
  23745. "alias": null,
  23746. "deprecated": null
  23747. },
  23748. {
  23749. "name": "due_on",
  23750. "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  23751. "in": "BODY",
  23752. "type": "string",
  23753. "required": false,
  23754. "enum": null,
  23755. "allowNull": false,
  23756. "mapToData": null,
  23757. "validation": null,
  23758. "alias": null,
  23759. "deprecated": null
  23760. }
  23761. ],
  23762. "responses": [
  23763. {
  23764. "code": 201,
  23765. "description": "response",
  23766. "examples": [
  23767. {
  23768. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}"
  23769. }
  23770. ]
  23771. }
  23772. ],
  23773. "renamed": null
  23774. },
  23775. {
  23776. "name": "Get a single milestone",
  23777. "scope": "issues",
  23778. "id": "getMilestone",
  23779. "method": "GET",
  23780. "url": "/repos/{owner}/{repo}/milestones/{milestone_number}",
  23781. "isDeprecated": false,
  23782. "description": "",
  23783. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/milestones/#get-a-single-milestone",
  23784. "previews": [],
  23785. "headers": [],
  23786. "parameters": [
  23787. {
  23788. "name": "owner",
  23789. "description": "owner parameter",
  23790. "in": "PATH",
  23791. "type": "string",
  23792. "required": true,
  23793. "enum": null,
  23794. "allowNull": false,
  23795. "mapToData": null,
  23796. "validation": null,
  23797. "alias": null,
  23798. "deprecated": null
  23799. },
  23800. {
  23801. "name": "repo",
  23802. "description": "repo parameter",
  23803. "in": "PATH",
  23804. "type": "string",
  23805. "required": true,
  23806. "enum": null,
  23807. "allowNull": false,
  23808. "mapToData": null,
  23809. "validation": null,
  23810. "alias": null,
  23811. "deprecated": null
  23812. },
  23813. {
  23814. "name": "milestone_number",
  23815. "description": "milestone_number parameter",
  23816. "in": "PATH",
  23817. "type": "integer",
  23818. "required": true,
  23819. "enum": null,
  23820. "allowNull": false,
  23821. "mapToData": null,
  23822. "validation": null,
  23823. "alias": null,
  23824. "deprecated": null
  23825. },
  23826. {
  23827. "name": "number",
  23828. "description": null,
  23829. "in": null,
  23830. "type": null,
  23831. "required": null,
  23832. "enum": null,
  23833. "allowNull": null,
  23834. "mapToData": null,
  23835. "validation": null,
  23836. "alias": "milestone_number",
  23837. "deprecated": true
  23838. }
  23839. ],
  23840. "responses": [
  23841. {
  23842. "code": 200,
  23843. "description": "response",
  23844. "examples": [
  23845. {
  23846. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}"
  23847. }
  23848. ]
  23849. }
  23850. ],
  23851. "renamed": null
  23852. },
  23853. {
  23854. "name": "Update a milestone",
  23855. "scope": "issues",
  23856. "id": "updateMilestone",
  23857. "method": "PATCH",
  23858. "url": "/repos/{owner}/{repo}/milestones/{milestone_number}",
  23859. "isDeprecated": false,
  23860. "description": "",
  23861. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/milestones/#update-a-milestone",
  23862. "previews": [],
  23863. "headers": [],
  23864. "parameters": [
  23865. {
  23866. "name": "owner",
  23867. "description": "owner parameter",
  23868. "in": "PATH",
  23869. "type": "string",
  23870. "required": true,
  23871. "enum": null,
  23872. "allowNull": false,
  23873. "mapToData": null,
  23874. "validation": null,
  23875. "alias": null,
  23876. "deprecated": null
  23877. },
  23878. {
  23879. "name": "repo",
  23880. "description": "repo parameter",
  23881. "in": "PATH",
  23882. "type": "string",
  23883. "required": true,
  23884. "enum": null,
  23885. "allowNull": false,
  23886. "mapToData": null,
  23887. "validation": null,
  23888. "alias": null,
  23889. "deprecated": null
  23890. },
  23891. {
  23892. "name": "milestone_number",
  23893. "description": "milestone_number parameter",
  23894. "in": "PATH",
  23895. "type": "integer",
  23896. "required": true,
  23897. "enum": null,
  23898. "allowNull": false,
  23899. "mapToData": null,
  23900. "validation": null,
  23901. "alias": null,
  23902. "deprecated": null
  23903. },
  23904. {
  23905. "name": "title",
  23906. "description": "The title of the milestone.",
  23907. "in": "BODY",
  23908. "type": "string",
  23909. "required": false,
  23910. "enum": null,
  23911. "allowNull": false,
  23912. "mapToData": null,
  23913. "validation": null,
  23914. "alias": null,
  23915. "deprecated": null
  23916. },
  23917. {
  23918. "name": "state",
  23919. "description": "The state of the milestone. Either `open` or `closed`.",
  23920. "in": "BODY",
  23921. "type": "string",
  23922. "required": false,
  23923. "enum": ["open", "closed"],
  23924. "allowNull": false,
  23925. "mapToData": null,
  23926. "validation": null,
  23927. "alias": null,
  23928. "deprecated": null
  23929. },
  23930. {
  23931. "name": "description",
  23932. "description": "A description of the milestone.",
  23933. "in": "BODY",
  23934. "type": "string",
  23935. "required": false,
  23936. "enum": null,
  23937. "allowNull": false,
  23938. "mapToData": null,
  23939. "validation": null,
  23940. "alias": null,
  23941. "deprecated": null
  23942. },
  23943. {
  23944. "name": "due_on",
  23945. "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  23946. "in": "BODY",
  23947. "type": "string",
  23948. "required": false,
  23949. "enum": null,
  23950. "allowNull": false,
  23951. "mapToData": null,
  23952. "validation": null,
  23953. "alias": null,
  23954. "deprecated": null
  23955. },
  23956. {
  23957. "name": "number",
  23958. "description": null,
  23959. "in": null,
  23960. "type": null,
  23961. "required": null,
  23962. "enum": null,
  23963. "allowNull": null,
  23964. "mapToData": null,
  23965. "validation": null,
  23966. "alias": "milestone_number",
  23967. "deprecated": true
  23968. }
  23969. ],
  23970. "responses": [
  23971. {
  23972. "code": 200,
  23973. "description": "response",
  23974. "examples": [
  23975. {
  23976. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}"
  23977. }
  23978. ]
  23979. }
  23980. ],
  23981. "renamed": null
  23982. },
  23983. {
  23984. "name": "Delete a milestone",
  23985. "scope": "issues",
  23986. "id": "deleteMilestone",
  23987. "method": "DELETE",
  23988. "url": "/repos/{owner}/{repo}/milestones/{milestone_number}",
  23989. "isDeprecated": false,
  23990. "description": "",
  23991. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/milestones/#delete-a-milestone",
  23992. "previews": [],
  23993. "headers": [],
  23994. "parameters": [
  23995. {
  23996. "name": "owner",
  23997. "description": "owner parameter",
  23998. "in": "PATH",
  23999. "type": "string",
  24000. "required": true,
  24001. "enum": null,
  24002. "allowNull": false,
  24003. "mapToData": null,
  24004. "validation": null,
  24005. "alias": null,
  24006. "deprecated": null
  24007. },
  24008. {
  24009. "name": "repo",
  24010. "description": "repo parameter",
  24011. "in": "PATH",
  24012. "type": "string",
  24013. "required": true,
  24014. "enum": null,
  24015. "allowNull": false,
  24016. "mapToData": null,
  24017. "validation": null,
  24018. "alias": null,
  24019. "deprecated": null
  24020. },
  24021. {
  24022. "name": "milestone_number",
  24023. "description": "milestone_number parameter",
  24024. "in": "PATH",
  24025. "type": "integer",
  24026. "required": true,
  24027. "enum": null,
  24028. "allowNull": false,
  24029. "mapToData": null,
  24030. "validation": null,
  24031. "alias": null,
  24032. "deprecated": null
  24033. },
  24034. {
  24035. "name": "number",
  24036. "description": null,
  24037. "in": null,
  24038. "type": null,
  24039. "required": null,
  24040. "enum": null,
  24041. "allowNull": null,
  24042. "mapToData": null,
  24043. "validation": null,
  24044. "alias": "milestone_number",
  24045. "deprecated": true
  24046. }
  24047. ],
  24048. "responses": [],
  24049. "renamed": null
  24050. },
  24051. {
  24052. "name": "Get labels for every issue in a milestone",
  24053. "scope": "issues",
  24054. "id": "listLabelsForMilestone",
  24055. "method": "GET",
  24056. "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels",
  24057. "isDeprecated": false,
  24058. "description": "",
  24059. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone",
  24060. "previews": [],
  24061. "headers": [],
  24062. "parameters": [
  24063. {
  24064. "name": "owner",
  24065. "description": "owner parameter",
  24066. "in": "PATH",
  24067. "type": "string",
  24068. "required": true,
  24069. "enum": null,
  24070. "allowNull": false,
  24071. "mapToData": null,
  24072. "validation": null,
  24073. "alias": null,
  24074. "deprecated": null
  24075. },
  24076. {
  24077. "name": "repo",
  24078. "description": "repo parameter",
  24079. "in": "PATH",
  24080. "type": "string",
  24081. "required": true,
  24082. "enum": null,
  24083. "allowNull": false,
  24084. "mapToData": null,
  24085. "validation": null,
  24086. "alias": null,
  24087. "deprecated": null
  24088. },
  24089. {
  24090. "name": "milestone_number",
  24091. "description": "milestone_number parameter",
  24092. "in": "PATH",
  24093. "type": "integer",
  24094. "required": true,
  24095. "enum": null,
  24096. "allowNull": false,
  24097. "mapToData": null,
  24098. "validation": null,
  24099. "alias": null,
  24100. "deprecated": null
  24101. },
  24102. {
  24103. "name": "per_page",
  24104. "description": "Results per page (max 100)",
  24105. "in": "QUERY",
  24106. "type": "integer",
  24107. "required": false,
  24108. "enum": null,
  24109. "allowNull": false,
  24110. "mapToData": null,
  24111. "validation": null,
  24112. "alias": null,
  24113. "deprecated": null
  24114. },
  24115. {
  24116. "name": "page",
  24117. "description": "Page number of the results to fetch.",
  24118. "in": "QUERY",
  24119. "type": "integer",
  24120. "required": false,
  24121. "enum": null,
  24122. "allowNull": false,
  24123. "mapToData": null,
  24124. "validation": null,
  24125. "alias": null,
  24126. "deprecated": null
  24127. },
  24128. {
  24129. "name": "number",
  24130. "description": null,
  24131. "in": null,
  24132. "type": null,
  24133. "required": null,
  24134. "enum": null,
  24135. "allowNull": null,
  24136. "mapToData": null,
  24137. "validation": null,
  24138. "alias": "milestone_number",
  24139. "deprecated": true
  24140. }
  24141. ],
  24142. "responses": [
  24143. {
  24144. "code": 200,
  24145. "description": "response",
  24146. "examples": [
  24147. {
  24148. "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]"
  24149. }
  24150. ]
  24151. }
  24152. ],
  24153. "renamed": null
  24154. },
  24155. {
  24156. "name": "List your notifications in a repository",
  24157. "scope": "activity",
  24158. "id": "listNotificationsForRepo",
  24159. "method": "GET",
  24160. "url": "/repos/{owner}/{repo}/notifications",
  24161. "isDeprecated": false,
  24162. "description": "List all notifications for the current user.",
  24163. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#list-your-notifications-in-a-repository",
  24164. "previews": [],
  24165. "headers": [],
  24166. "parameters": [
  24167. {
  24168. "name": "owner",
  24169. "description": "owner parameter",
  24170. "in": "PATH",
  24171. "type": "string",
  24172. "required": true,
  24173. "enum": null,
  24174. "allowNull": false,
  24175. "mapToData": null,
  24176. "validation": null,
  24177. "alias": null,
  24178. "deprecated": null
  24179. },
  24180. {
  24181. "name": "repo",
  24182. "description": "repo parameter",
  24183. "in": "PATH",
  24184. "type": "string",
  24185. "required": true,
  24186. "enum": null,
  24187. "allowNull": false,
  24188. "mapToData": null,
  24189. "validation": null,
  24190. "alias": null,
  24191. "deprecated": null
  24192. },
  24193. {
  24194. "name": "all",
  24195. "description": "If `true`, show notifications marked as read.",
  24196. "in": "QUERY",
  24197. "type": "boolean",
  24198. "required": false,
  24199. "enum": null,
  24200. "allowNull": false,
  24201. "mapToData": null,
  24202. "validation": null,
  24203. "alias": null,
  24204. "deprecated": null
  24205. },
  24206. {
  24207. "name": "participating",
  24208. "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.",
  24209. "in": "QUERY",
  24210. "type": "boolean",
  24211. "required": false,
  24212. "enum": null,
  24213. "allowNull": false,
  24214. "mapToData": null,
  24215. "validation": null,
  24216. "alias": null,
  24217. "deprecated": null
  24218. },
  24219. {
  24220. "name": "since",
  24221. "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  24222. "in": "QUERY",
  24223. "type": "string",
  24224. "required": false,
  24225. "enum": null,
  24226. "allowNull": false,
  24227. "mapToData": null,
  24228. "validation": null,
  24229. "alias": null,
  24230. "deprecated": null
  24231. },
  24232. {
  24233. "name": "before",
  24234. "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  24235. "in": "QUERY",
  24236. "type": "string",
  24237. "required": false,
  24238. "enum": null,
  24239. "allowNull": false,
  24240. "mapToData": null,
  24241. "validation": null,
  24242. "alias": null,
  24243. "deprecated": null
  24244. },
  24245. {
  24246. "name": "per_page",
  24247. "description": "Results per page (max 100)",
  24248. "in": "QUERY",
  24249. "type": "integer",
  24250. "required": false,
  24251. "enum": null,
  24252. "allowNull": false,
  24253. "mapToData": null,
  24254. "validation": null,
  24255. "alias": null,
  24256. "deprecated": null
  24257. },
  24258. {
  24259. "name": "page",
  24260. "description": "Page number of the results to fetch.",
  24261. "in": "QUERY",
  24262. "type": "integer",
  24263. "required": false,
  24264. "enum": null,
  24265. "allowNull": false,
  24266. "mapToData": null,
  24267. "validation": null,
  24268. "alias": null,
  24269. "deprecated": null
  24270. }
  24271. ],
  24272. "responses": [
  24273. {
  24274. "code": 200,
  24275. "description": "response",
  24276. "examples": [
  24277. {
  24278. "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}]"
  24279. }
  24280. ]
  24281. }
  24282. ],
  24283. "renamed": null
  24284. },
  24285. {
  24286. "name": "Mark notifications as read in a repository",
  24287. "scope": "activity",
  24288. "id": "markNotificationsAsReadForRepo",
  24289. "method": "PUT",
  24290. "url": "/repos/{owner}/{repo}/notifications",
  24291. "isDeprecated": false,
  24292. "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise Server](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications in a repository](https://developer.github.com/enterprise/2.17/v3/activity/notifications/#list-your-notifications-in-a-repository) endpoint and pass the query parameter `all=false`.",
  24293. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/notifications/#mark-notifications-as-read-in-a-repository",
  24294. "previews": [],
  24295. "headers": [],
  24296. "parameters": [
  24297. {
  24298. "name": "owner",
  24299. "description": "owner parameter",
  24300. "in": "PATH",
  24301. "type": "string",
  24302. "required": true,
  24303. "enum": null,
  24304. "allowNull": false,
  24305. "mapToData": null,
  24306. "validation": null,
  24307. "alias": null,
  24308. "deprecated": null
  24309. },
  24310. {
  24311. "name": "repo",
  24312. "description": "repo parameter",
  24313. "in": "PATH",
  24314. "type": "string",
  24315. "required": true,
  24316. "enum": null,
  24317. "allowNull": false,
  24318. "mapToData": null,
  24319. "validation": null,
  24320. "alias": null,
  24321. "deprecated": null
  24322. },
  24323. {
  24324. "name": "last_read_at",
  24325. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.",
  24326. "in": "BODY",
  24327. "type": "string",
  24328. "required": false,
  24329. "enum": null,
  24330. "allowNull": false,
  24331. "mapToData": null,
  24332. "validation": null,
  24333. "alias": null,
  24334. "deprecated": null
  24335. }
  24336. ],
  24337. "responses": [],
  24338. "renamed": null
  24339. },
  24340. {
  24341. "name": "Get information about a Pages site",
  24342. "scope": "repos",
  24343. "id": "getPages",
  24344. "method": "GET",
  24345. "url": "/repos/{owner}/{repo}/pages",
  24346. "isDeprecated": false,
  24347. "description": "",
  24348. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#get-information-about-a-pages-site",
  24349. "previews": [],
  24350. "headers": [],
  24351. "parameters": [
  24352. {
  24353. "name": "owner",
  24354. "description": "owner parameter",
  24355. "in": "PATH",
  24356. "type": "string",
  24357. "required": true,
  24358. "enum": null,
  24359. "allowNull": false,
  24360. "mapToData": null,
  24361. "validation": null,
  24362. "alias": null,
  24363. "deprecated": null
  24364. },
  24365. {
  24366. "name": "repo",
  24367. "description": "repo parameter",
  24368. "in": "PATH",
  24369. "type": "string",
  24370. "required": true,
  24371. "enum": null,
  24372. "allowNull": false,
  24373. "mapToData": null,
  24374. "validation": null,
  24375. "alias": null,
  24376. "deprecated": null
  24377. }
  24378. ],
  24379. "responses": [
  24380. {
  24381. "code": 200,
  24382. "description": "response",
  24383. "examples": [
  24384. {
  24385. "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"directory\":\"/\"}}"
  24386. }
  24387. ]
  24388. }
  24389. ],
  24390. "renamed": null
  24391. },
  24392. {
  24393. "name": "Enable a Pages site",
  24394. "scope": "repos",
  24395. "id": "enablePagesSite",
  24396. "method": "POST",
  24397. "url": "/repos/{owner}/{repo}/pages",
  24398. "isDeprecated": false,
  24399. "description": "",
  24400. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#enable-a-pages-site",
  24401. "previews": [{ "name": "switcheroo" }],
  24402. "headers": [
  24403. {
  24404. "name": "accept",
  24405. "value": "application/vnd.github.switcheroo-preview+json"
  24406. }
  24407. ],
  24408. "parameters": [
  24409. {
  24410. "name": "owner",
  24411. "description": "owner parameter",
  24412. "in": "PATH",
  24413. "type": "string",
  24414. "required": true,
  24415. "enum": null,
  24416. "allowNull": false,
  24417. "mapToData": null,
  24418. "validation": null,
  24419. "alias": null,
  24420. "deprecated": null
  24421. },
  24422. {
  24423. "name": "repo",
  24424. "description": "repo parameter",
  24425. "in": "PATH",
  24426. "type": "string",
  24427. "required": true,
  24428. "enum": null,
  24429. "allowNull": false,
  24430. "mapToData": null,
  24431. "validation": null,
  24432. "alias": null,
  24433. "deprecated": null
  24434. },
  24435. {
  24436. "name": "source",
  24437. "description": "source parameter",
  24438. "in": "BODY",
  24439. "type": "object",
  24440. "required": false,
  24441. "enum": null,
  24442. "allowNull": false,
  24443. "mapToData": null,
  24444. "validation": null,
  24445. "alias": null,
  24446. "deprecated": null
  24447. },
  24448. {
  24449. "name": "source.branch",
  24450. "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.",
  24451. "in": "BODY",
  24452. "type": "string",
  24453. "required": false,
  24454. "enum": ["master", "gh-pages"],
  24455. "allowNull": false,
  24456. "mapToData": null,
  24457. "validation": null,
  24458. "alias": null,
  24459. "deprecated": null
  24460. },
  24461. {
  24462. "name": "source.path",
  24463. "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.",
  24464. "in": "BODY",
  24465. "type": "string",
  24466. "required": false,
  24467. "enum": null,
  24468. "allowNull": false,
  24469. "mapToData": null,
  24470. "validation": null,
  24471. "alias": null,
  24472. "deprecated": null
  24473. }
  24474. ],
  24475. "responses": [
  24476. {
  24477. "code": 201,
  24478. "description": "response",
  24479. "examples": [
  24480. {
  24481. "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"directory\":\"/\"}}"
  24482. }
  24483. ]
  24484. }
  24485. ],
  24486. "renamed": null
  24487. },
  24488. {
  24489. "name": "Disable a Pages site",
  24490. "scope": "repos",
  24491. "id": "disablePagesSite",
  24492. "method": "DELETE",
  24493. "url": "/repos/{owner}/{repo}/pages",
  24494. "isDeprecated": false,
  24495. "description": "",
  24496. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#disable-a-pages-site",
  24497. "previews": [{ "name": "switcheroo" }],
  24498. "headers": [
  24499. {
  24500. "name": "accept",
  24501. "value": "application/vnd.github.switcheroo-preview+json"
  24502. }
  24503. ],
  24504. "parameters": [
  24505. {
  24506. "name": "owner",
  24507. "description": "owner parameter",
  24508. "in": "PATH",
  24509. "type": "string",
  24510. "required": true,
  24511. "enum": null,
  24512. "allowNull": false,
  24513. "mapToData": null,
  24514. "validation": null,
  24515. "alias": null,
  24516. "deprecated": null
  24517. },
  24518. {
  24519. "name": "repo",
  24520. "description": "repo parameter",
  24521. "in": "PATH",
  24522. "type": "string",
  24523. "required": true,
  24524. "enum": null,
  24525. "allowNull": false,
  24526. "mapToData": null,
  24527. "validation": null,
  24528. "alias": null,
  24529. "deprecated": null
  24530. }
  24531. ],
  24532. "responses": [],
  24533. "renamed": null
  24534. },
  24535. {
  24536. "name": "Update information about a Pages site",
  24537. "scope": "repos",
  24538. "id": "updateInformationAboutPagesSite",
  24539. "method": "PUT",
  24540. "url": "/repos/{owner}/{repo}/pages",
  24541. "isDeprecated": false,
  24542. "description": "",
  24543. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#update-information-about-a-pages-site",
  24544. "previews": [],
  24545. "headers": [],
  24546. "parameters": [
  24547. {
  24548. "name": "owner",
  24549. "description": "owner parameter",
  24550. "in": "PATH",
  24551. "type": "string",
  24552. "required": true,
  24553. "enum": null,
  24554. "allowNull": false,
  24555. "mapToData": null,
  24556. "validation": null,
  24557. "alias": null,
  24558. "deprecated": null
  24559. },
  24560. {
  24561. "name": "repo",
  24562. "description": "repo parameter",
  24563. "in": "PATH",
  24564. "type": "string",
  24565. "required": true,
  24566. "enum": null,
  24567. "allowNull": false,
  24568. "mapToData": null,
  24569. "validation": null,
  24570. "alias": null,
  24571. "deprecated": null
  24572. },
  24573. {
  24574. "name": "source",
  24575. "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.",
  24576. "in": "BODY",
  24577. "type": "string",
  24578. "required": false,
  24579. "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""],
  24580. "allowNull": false,
  24581. "mapToData": null,
  24582. "validation": null,
  24583. "alias": null,
  24584. "deprecated": null
  24585. }
  24586. ],
  24587. "responses": [],
  24588. "renamed": null
  24589. },
  24590. {
  24591. "name": "Request a page build",
  24592. "scope": "repos",
  24593. "id": "requestPageBuild",
  24594. "method": "POST",
  24595. "url": "/repos/{owner}/{repo}/pages/builds",
  24596. "isDeprecated": false,
  24597. "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.",
  24598. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#request-a-page-build",
  24599. "previews": [{ "name": "mister-fantastic" }],
  24600. "headers": [
  24601. {
  24602. "name": "accept",
  24603. "value": "application/vnd.github.mister-fantastic-preview+json"
  24604. }
  24605. ],
  24606. "parameters": [
  24607. {
  24608. "name": "owner",
  24609. "description": "owner parameter",
  24610. "in": "PATH",
  24611. "type": "string",
  24612. "required": true,
  24613. "enum": null,
  24614. "allowNull": false,
  24615. "mapToData": null,
  24616. "validation": null,
  24617. "alias": null,
  24618. "deprecated": null
  24619. },
  24620. {
  24621. "name": "repo",
  24622. "description": "repo parameter",
  24623. "in": "PATH",
  24624. "type": "string",
  24625. "required": true,
  24626. "enum": null,
  24627. "allowNull": false,
  24628. "mapToData": null,
  24629. "validation": null,
  24630. "alias": null,
  24631. "deprecated": null
  24632. }
  24633. ],
  24634. "responses": [
  24635. {
  24636. "code": 200,
  24637. "description": "response",
  24638. "examples": [
  24639. {
  24640. "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\"status\":\"queued\"}"
  24641. }
  24642. ]
  24643. }
  24644. ],
  24645. "renamed": null
  24646. },
  24647. {
  24648. "name": "List Pages builds",
  24649. "scope": "repos",
  24650. "id": "listPagesBuilds",
  24651. "method": "GET",
  24652. "url": "/repos/{owner}/{repo}/pages/builds",
  24653. "isDeprecated": false,
  24654. "description": "",
  24655. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#list-pages-builds",
  24656. "previews": [],
  24657. "headers": [],
  24658. "parameters": [
  24659. {
  24660. "name": "owner",
  24661. "description": "owner parameter",
  24662. "in": "PATH",
  24663. "type": "string",
  24664. "required": true,
  24665. "enum": null,
  24666. "allowNull": false,
  24667. "mapToData": null,
  24668. "validation": null,
  24669. "alias": null,
  24670. "deprecated": null
  24671. },
  24672. {
  24673. "name": "repo",
  24674. "description": "repo parameter",
  24675. "in": "PATH",
  24676. "type": "string",
  24677. "required": true,
  24678. "enum": null,
  24679. "allowNull": false,
  24680. "mapToData": null,
  24681. "validation": null,
  24682. "alias": null,
  24683. "deprecated": null
  24684. },
  24685. {
  24686. "name": "per_page",
  24687. "description": "Results per page (max 100)",
  24688. "in": "QUERY",
  24689. "type": "integer",
  24690. "required": false,
  24691. "enum": null,
  24692. "allowNull": false,
  24693. "mapToData": null,
  24694. "validation": null,
  24695. "alias": null,
  24696. "deprecated": null
  24697. },
  24698. {
  24699. "name": "page",
  24700. "description": "Page number of the results to fetch.",
  24701. "in": "QUERY",
  24702. "type": "integer",
  24703. "required": false,
  24704. "enum": null,
  24705. "allowNull": false,
  24706. "mapToData": null,
  24707. "validation": null,
  24708. "alias": null,
  24709. "deprecated": null
  24710. }
  24711. ],
  24712. "responses": [
  24713. {
  24714. "code": 200,
  24715. "description": "response",
  24716. "examples": [
  24717. {
  24718. "data": "[{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}]"
  24719. }
  24720. ]
  24721. }
  24722. ],
  24723. "renamed": null
  24724. },
  24725. {
  24726. "name": "Get latest Pages build",
  24727. "scope": "repos",
  24728. "id": "getLatestPagesBuild",
  24729. "method": "GET",
  24730. "url": "/repos/{owner}/{repo}/pages/builds/latest",
  24731. "isDeprecated": false,
  24732. "description": "",
  24733. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#get-latest-pages-build",
  24734. "previews": [],
  24735. "headers": [],
  24736. "parameters": [
  24737. {
  24738. "name": "owner",
  24739. "description": "owner parameter",
  24740. "in": "PATH",
  24741. "type": "string",
  24742. "required": true,
  24743. "enum": null,
  24744. "allowNull": false,
  24745. "mapToData": null,
  24746. "validation": null,
  24747. "alias": null,
  24748. "deprecated": null
  24749. },
  24750. {
  24751. "name": "repo",
  24752. "description": "repo parameter",
  24753. "in": "PATH",
  24754. "type": "string",
  24755. "required": true,
  24756. "enum": null,
  24757. "allowNull": false,
  24758. "mapToData": null,
  24759. "validation": null,
  24760. "alias": null,
  24761. "deprecated": null
  24762. }
  24763. ],
  24764. "responses": [
  24765. {
  24766. "code": 200,
  24767. "description": "response",
  24768. "examples": [
  24769. {
  24770. "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}"
  24771. }
  24772. ]
  24773. }
  24774. ],
  24775. "renamed": null
  24776. },
  24777. {
  24778. "name": "Get a specific Pages build",
  24779. "scope": "repos",
  24780. "id": "getPagesBuild",
  24781. "method": "GET",
  24782. "url": "/repos/{owner}/{repo}/pages/builds/{build_id}",
  24783. "isDeprecated": false,
  24784. "description": "",
  24785. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/pages/#get-a-specific-pages-build",
  24786. "previews": [],
  24787. "headers": [],
  24788. "parameters": [
  24789. {
  24790. "name": "owner",
  24791. "description": "owner parameter",
  24792. "in": "PATH",
  24793. "type": "string",
  24794. "required": true,
  24795. "enum": null,
  24796. "allowNull": false,
  24797. "mapToData": null,
  24798. "validation": null,
  24799. "alias": null,
  24800. "deprecated": null
  24801. },
  24802. {
  24803. "name": "repo",
  24804. "description": "repo parameter",
  24805. "in": "PATH",
  24806. "type": "string",
  24807. "required": true,
  24808. "enum": null,
  24809. "allowNull": false,
  24810. "mapToData": null,
  24811. "validation": null,
  24812. "alias": null,
  24813. "deprecated": null
  24814. },
  24815. {
  24816. "name": "build_id",
  24817. "description": "build_id parameter",
  24818. "in": "PATH",
  24819. "type": "integer",
  24820. "required": true,
  24821. "enum": null,
  24822. "allowNull": false,
  24823. "mapToData": null,
  24824. "validation": null,
  24825. "alias": null,
  24826. "deprecated": null
  24827. }
  24828. ],
  24829. "responses": [
  24830. {
  24831. "code": 200,
  24832. "description": "response",
  24833. "examples": [
  24834. {
  24835. "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}"
  24836. }
  24837. ]
  24838. }
  24839. ],
  24840. "renamed": null
  24841. },
  24842. {
  24843. "name": "List pre-receive hooks for repository",
  24844. "scope": "enterpriseAdmin",
  24845. "id": "listPreReceiveHooksForRepo",
  24846. "method": "GET",
  24847. "url": "/repos/{owner}/{repo}/pre-receive-hooks",
  24848. "isDeprecated": false,
  24849. "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.",
  24850. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/repo_pre_receive_hooks/#list-pre-receive-hooks",
  24851. "previews": [],
  24852. "headers": [],
  24853. "parameters": [
  24854. {
  24855. "name": "owner",
  24856. "description": "owner parameter",
  24857. "in": "PATH",
  24858. "type": "string",
  24859. "required": true,
  24860. "enum": null,
  24861. "allowNull": false,
  24862. "mapToData": null,
  24863. "validation": null,
  24864. "alias": null,
  24865. "deprecated": null
  24866. },
  24867. {
  24868. "name": "repo",
  24869. "description": "repo parameter",
  24870. "in": "PATH",
  24871. "type": "string",
  24872. "required": true,
  24873. "enum": null,
  24874. "allowNull": false,
  24875. "mapToData": null,
  24876. "validation": null,
  24877. "alias": null,
  24878. "deprecated": null
  24879. },
  24880. {
  24881. "name": "per_page",
  24882. "description": "Results per page (max 100)",
  24883. "in": "QUERY",
  24884. "type": "integer",
  24885. "required": false,
  24886. "enum": null,
  24887. "allowNull": false,
  24888. "mapToData": null,
  24889. "validation": null,
  24890. "alias": null,
  24891. "deprecated": null
  24892. },
  24893. {
  24894. "name": "page",
  24895. "description": "Page number of the results to fetch.",
  24896. "in": "QUERY",
  24897. "type": "integer",
  24898. "required": false,
  24899. "enum": null,
  24900. "allowNull": false,
  24901. "mapToData": null,
  24902. "validation": null,
  24903. "alias": null,
  24904. "deprecated": null
  24905. }
  24906. ],
  24907. "responses": [
  24908. {
  24909. "code": 200,
  24910. "description": "response",
  24911. "examples": [
  24912. {
  24913. "data": "[{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}]"
  24914. }
  24915. ]
  24916. }
  24917. ],
  24918. "renamed": null
  24919. },
  24920. {
  24921. "name": "Get a single pre-receive hook for repository",
  24922. "scope": "enterpriseAdmin",
  24923. "id": "getPreReceiveHookForRepo",
  24924. "method": "GET",
  24925. "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
  24926. "isDeprecated": false,
  24927. "description": "",
  24928. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/repo_pre_receive_hooks/#get-a-single-pre-receive-hook",
  24929. "previews": [],
  24930. "headers": [],
  24931. "parameters": [
  24932. {
  24933. "name": "owner",
  24934. "description": "owner parameter",
  24935. "in": "PATH",
  24936. "type": "string",
  24937. "required": true,
  24938. "enum": null,
  24939. "allowNull": false,
  24940. "mapToData": null,
  24941. "validation": null,
  24942. "alias": null,
  24943. "deprecated": null
  24944. },
  24945. {
  24946. "name": "repo",
  24947. "description": "repo parameter",
  24948. "in": "PATH",
  24949. "type": "string",
  24950. "required": true,
  24951. "enum": null,
  24952. "allowNull": false,
  24953. "mapToData": null,
  24954. "validation": null,
  24955. "alias": null,
  24956. "deprecated": null
  24957. },
  24958. {
  24959. "name": "pre_receive_hook_id",
  24960. "description": "pre_receive_hook_id parameter",
  24961. "in": "PATH",
  24962. "type": "integer",
  24963. "required": true,
  24964. "enum": null,
  24965. "allowNull": false,
  24966. "mapToData": null,
  24967. "validation": null,
  24968. "alias": null,
  24969. "deprecated": null
  24970. }
  24971. ],
  24972. "responses": [
  24973. {
  24974. "code": 200,
  24975. "description": "response",
  24976. "examples": [
  24977. {
  24978. "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}"
  24979. }
  24980. ]
  24981. }
  24982. ],
  24983. "renamed": null
  24984. },
  24985. {
  24986. "name": "Update pre-receive hook enforcement for repository",
  24987. "scope": "enterpriseAdmin",
  24988. "id": "updatePreReceiveHookEnforcementForRepo",
  24989. "method": "PATCH",
  24990. "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
  24991. "isDeprecated": false,
  24992. "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`",
  24993. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/repo_pre_receive_hooks/#update-pre-receive-hook-enforcement",
  24994. "previews": [],
  24995. "headers": [],
  24996. "parameters": [
  24997. {
  24998. "name": "owner",
  24999. "description": "owner parameter",
  25000. "in": "PATH",
  25001. "type": "string",
  25002. "required": true,
  25003. "enum": null,
  25004. "allowNull": false,
  25005. "mapToData": null,
  25006. "validation": null,
  25007. "alias": null,
  25008. "deprecated": null
  25009. },
  25010. {
  25011. "name": "repo",
  25012. "description": "repo parameter",
  25013. "in": "PATH",
  25014. "type": "string",
  25015. "required": true,
  25016. "enum": null,
  25017. "allowNull": false,
  25018. "mapToData": null,
  25019. "validation": null,
  25020. "alias": null,
  25021. "deprecated": null
  25022. },
  25023. {
  25024. "name": "pre_receive_hook_id",
  25025. "description": "pre_receive_hook_id parameter",
  25026. "in": "PATH",
  25027. "type": "integer",
  25028. "required": true,
  25029. "enum": null,
  25030. "allowNull": false,
  25031. "mapToData": null,
  25032. "validation": null,
  25033. "alias": null,
  25034. "deprecated": null
  25035. }
  25036. ],
  25037. "responses": [
  25038. {
  25039. "code": 200,
  25040. "description": "response",
  25041. "examples": [
  25042. {
  25043. "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"enabled\",\"configuration_url\":\"https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42\"}"
  25044. }
  25045. ]
  25046. }
  25047. ],
  25048. "renamed": null
  25049. },
  25050. {
  25051. "name": "Remove enforcement overrides for a pre-receive hook for repository",
  25052. "scope": "enterpriseAdmin",
  25053. "id": "removeEnforcementOverridesForPreReceiveHookForRepo",
  25054. "method": "DELETE",
  25055. "url": "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}",
  25056. "isDeprecated": false,
  25057. "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.",
  25058. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/repo_pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook",
  25059. "previews": [],
  25060. "headers": [],
  25061. "parameters": [
  25062. {
  25063. "name": "owner",
  25064. "description": "owner parameter",
  25065. "in": "PATH",
  25066. "type": "string",
  25067. "required": true,
  25068. "enum": null,
  25069. "allowNull": false,
  25070. "mapToData": null,
  25071. "validation": null,
  25072. "alias": null,
  25073. "deprecated": null
  25074. },
  25075. {
  25076. "name": "repo",
  25077. "description": "repo parameter",
  25078. "in": "PATH",
  25079. "type": "string",
  25080. "required": true,
  25081. "enum": null,
  25082. "allowNull": false,
  25083. "mapToData": null,
  25084. "validation": null,
  25085. "alias": null,
  25086. "deprecated": null
  25087. },
  25088. {
  25089. "name": "pre_receive_hook_id",
  25090. "description": "pre_receive_hook_id parameter",
  25091. "in": "PATH",
  25092. "type": "integer",
  25093. "required": true,
  25094. "enum": null,
  25095. "allowNull": false,
  25096. "mapToData": null,
  25097. "validation": null,
  25098. "alias": null,
  25099. "deprecated": null
  25100. }
  25101. ],
  25102. "responses": [
  25103. {
  25104. "code": 200,
  25105. "description": "Responds with effective values inherited from owner and/or global level.",
  25106. "examples": [
  25107. {
  25108. "data": "{\"id\":42,\"name\":\"Check Commits\",\"enforcement\":\"disabled\",\"configuration_url\":\"https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42\"}"
  25109. }
  25110. ]
  25111. }
  25112. ],
  25113. "renamed": null
  25114. },
  25115. {
  25116. "name": "List repository projects",
  25117. "scope": "projects",
  25118. "id": "listForRepo",
  25119. "method": "GET",
  25120. "url": "/repos/{owner}/{repo}/projects",
  25121. "isDeprecated": false,
  25122. "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
  25123. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#list-repository-projects",
  25124. "previews": [{ "name": "inertia" }],
  25125. "headers": [
  25126. {
  25127. "name": "accept",
  25128. "value": "application/vnd.github.inertia-preview+json"
  25129. }
  25130. ],
  25131. "parameters": [
  25132. {
  25133. "name": "owner",
  25134. "description": "owner parameter",
  25135. "in": "PATH",
  25136. "type": "string",
  25137. "required": true,
  25138. "enum": null,
  25139. "allowNull": false,
  25140. "mapToData": null,
  25141. "validation": null,
  25142. "alias": null,
  25143. "deprecated": null
  25144. },
  25145. {
  25146. "name": "repo",
  25147. "description": "repo parameter",
  25148. "in": "PATH",
  25149. "type": "string",
  25150. "required": true,
  25151. "enum": null,
  25152. "allowNull": false,
  25153. "mapToData": null,
  25154. "validation": null,
  25155. "alias": null,
  25156. "deprecated": null
  25157. },
  25158. {
  25159. "name": "state",
  25160. "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
  25161. "in": "QUERY",
  25162. "type": "string",
  25163. "required": false,
  25164. "enum": ["open", "closed", "all"],
  25165. "allowNull": false,
  25166. "mapToData": null,
  25167. "validation": null,
  25168. "alias": null,
  25169. "deprecated": null
  25170. },
  25171. {
  25172. "name": "per_page",
  25173. "description": "Results per page (max 100)",
  25174. "in": "QUERY",
  25175. "type": "integer",
  25176. "required": false,
  25177. "enum": null,
  25178. "allowNull": false,
  25179. "mapToData": null,
  25180. "validation": null,
  25181. "alias": null,
  25182. "deprecated": null
  25183. },
  25184. {
  25185. "name": "page",
  25186. "description": "Page number of the results to fetch.",
  25187. "in": "QUERY",
  25188. "type": "integer",
  25189. "required": false,
  25190. "enum": null,
  25191. "allowNull": false,
  25192. "mapToData": null,
  25193. "validation": null,
  25194. "alias": null,
  25195. "deprecated": null
  25196. }
  25197. ],
  25198. "responses": [
  25199. {
  25200. "code": 200,
  25201. "description": "response",
  25202. "examples": [
  25203. {
  25204. "data": "[{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]"
  25205. }
  25206. ]
  25207. }
  25208. ],
  25209. "renamed": null
  25210. },
  25211. {
  25212. "name": "Create a repository project",
  25213. "scope": "projects",
  25214. "id": "createForRepo",
  25215. "method": "POST",
  25216. "url": "/repos/{owner}/{repo}/projects",
  25217. "isDeprecated": false,
  25218. "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.",
  25219. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#create-a-repository-project",
  25220. "previews": [{ "name": "inertia" }],
  25221. "headers": [
  25222. {
  25223. "name": "accept",
  25224. "value": "application/vnd.github.inertia-preview+json"
  25225. }
  25226. ],
  25227. "parameters": [
  25228. {
  25229. "name": "owner",
  25230. "description": "owner parameter",
  25231. "in": "PATH",
  25232. "type": "string",
  25233. "required": true,
  25234. "enum": null,
  25235. "allowNull": false,
  25236. "mapToData": null,
  25237. "validation": null,
  25238. "alias": null,
  25239. "deprecated": null
  25240. },
  25241. {
  25242. "name": "repo",
  25243. "description": "repo parameter",
  25244. "in": "PATH",
  25245. "type": "string",
  25246. "required": true,
  25247. "enum": null,
  25248. "allowNull": false,
  25249. "mapToData": null,
  25250. "validation": null,
  25251. "alias": null,
  25252. "deprecated": null
  25253. },
  25254. {
  25255. "name": "name",
  25256. "description": "The name of the project.",
  25257. "in": "BODY",
  25258. "type": "string",
  25259. "required": true,
  25260. "enum": null,
  25261. "allowNull": false,
  25262. "mapToData": null,
  25263. "validation": null,
  25264. "alias": null,
  25265. "deprecated": null
  25266. },
  25267. {
  25268. "name": "body",
  25269. "description": "The description of the project.",
  25270. "in": "BODY",
  25271. "type": "string",
  25272. "required": false,
  25273. "enum": null,
  25274. "allowNull": false,
  25275. "mapToData": null,
  25276. "validation": null,
  25277. "alias": null,
  25278. "deprecated": null
  25279. }
  25280. ],
  25281. "responses": [
  25282. {
  25283. "code": 201,
  25284. "description": "response",
  25285. "examples": [
  25286. {
  25287. "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}"
  25288. }
  25289. ]
  25290. }
  25291. ],
  25292. "renamed": null
  25293. },
  25294. {
  25295. "name": "List pull requests",
  25296. "scope": "pulls",
  25297. "id": "list",
  25298. "method": "GET",
  25299. "url": "/repos/{owner}/{repo}/pulls",
  25300. "isDeprecated": false,
  25301. "description": "",
  25302. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests",
  25303. "previews": [],
  25304. "headers": [],
  25305. "parameters": [
  25306. {
  25307. "name": "owner",
  25308. "description": "owner parameter",
  25309. "in": "PATH",
  25310. "type": "string",
  25311. "required": true,
  25312. "enum": null,
  25313. "allowNull": false,
  25314. "mapToData": null,
  25315. "validation": null,
  25316. "alias": null,
  25317. "deprecated": null
  25318. },
  25319. {
  25320. "name": "repo",
  25321. "description": "repo parameter",
  25322. "in": "PATH",
  25323. "type": "string",
  25324. "required": true,
  25325. "enum": null,
  25326. "allowNull": false,
  25327. "mapToData": null,
  25328. "validation": null,
  25329. "alias": null,
  25330. "deprecated": null
  25331. },
  25332. {
  25333. "name": "state",
  25334. "description": "Either `open`, `closed`, or `all` to filter by state.",
  25335. "in": "QUERY",
  25336. "type": "string",
  25337. "required": false,
  25338. "enum": ["open", "closed", "all"],
  25339. "allowNull": false,
  25340. "mapToData": null,
  25341. "validation": null,
  25342. "alias": null,
  25343. "deprecated": null
  25344. },
  25345. {
  25346. "name": "head",
  25347. "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.",
  25348. "in": "QUERY",
  25349. "type": "string",
  25350. "required": false,
  25351. "enum": null,
  25352. "allowNull": false,
  25353. "mapToData": null,
  25354. "validation": null,
  25355. "alias": null,
  25356. "deprecated": null
  25357. },
  25358. {
  25359. "name": "base",
  25360. "description": "Filter pulls by base branch name. Example: `gh-pages`.",
  25361. "in": "QUERY",
  25362. "type": "string",
  25363. "required": false,
  25364. "enum": null,
  25365. "allowNull": false,
  25366. "mapToData": null,
  25367. "validation": null,
  25368. "alias": null,
  25369. "deprecated": null
  25370. },
  25371. {
  25372. "name": "sort",
  25373. "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).",
  25374. "in": "QUERY",
  25375. "type": "string",
  25376. "required": false,
  25377. "enum": ["created", "updated", "popularity", "long-running"],
  25378. "allowNull": false,
  25379. "mapToData": null,
  25380. "validation": null,
  25381. "alias": null,
  25382. "deprecated": null
  25383. },
  25384. {
  25385. "name": "direction",
  25386. "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.",
  25387. "in": "QUERY",
  25388. "type": "string",
  25389. "required": false,
  25390. "enum": ["asc", "desc"],
  25391. "allowNull": false,
  25392. "mapToData": null,
  25393. "validation": null,
  25394. "alias": null,
  25395. "deprecated": null
  25396. },
  25397. {
  25398. "name": "per_page",
  25399. "description": "Results per page (max 100)",
  25400. "in": "QUERY",
  25401. "type": "integer",
  25402. "required": false,
  25403. "enum": null,
  25404. "allowNull": false,
  25405. "mapToData": null,
  25406. "validation": null,
  25407. "alias": null,
  25408. "deprecated": null
  25409. },
  25410. {
  25411. "name": "page",
  25412. "description": "Page number of the results to fetch.",
  25413. "in": "QUERY",
  25414. "type": "integer",
  25415. "required": false,
  25416. "enum": null,
  25417. "allowNull": false,
  25418. "mapToData": null,
  25419. "validation": null,
  25420. "alias": null,
  25421. "deprecated": null
  25422. }
  25423. ],
  25424. "responses": [
  25425. {
  25426. "code": 200,
  25427. "description": "response",
  25428. "examples": [
  25429. {
  25430. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]"
  25431. }
  25432. ]
  25433. }
  25434. ],
  25435. "renamed": null
  25436. },
  25437. {
  25438. "name": "Create a pull request",
  25439. "scope": "pulls",
  25440. "id": "create",
  25441. "method": "POST",
  25442. "url": "/repos/{owner}/{repo}/pulls",
  25443. "isDeprecated": false,
  25444. "description": "You can create a new pull request.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  25445. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#create-a-pull-request",
  25446. "previews": [],
  25447. "headers": [],
  25448. "parameters": [
  25449. {
  25450. "name": "owner",
  25451. "description": "owner parameter",
  25452. "in": "PATH",
  25453. "type": "string",
  25454. "required": true,
  25455. "enum": null,
  25456. "allowNull": false,
  25457. "mapToData": null,
  25458. "validation": null,
  25459. "alias": null,
  25460. "deprecated": null
  25461. },
  25462. {
  25463. "name": "repo",
  25464. "description": "repo parameter",
  25465. "in": "PATH",
  25466. "type": "string",
  25467. "required": true,
  25468. "enum": null,
  25469. "allowNull": false,
  25470. "mapToData": null,
  25471. "validation": null,
  25472. "alias": null,
  25473. "deprecated": null
  25474. },
  25475. {
  25476. "name": "title",
  25477. "description": "The title of the new pull request.",
  25478. "in": "BODY",
  25479. "type": "string",
  25480. "required": true,
  25481. "enum": null,
  25482. "allowNull": false,
  25483. "mapToData": null,
  25484. "validation": null,
  25485. "alias": null,
  25486. "deprecated": null
  25487. },
  25488. {
  25489. "name": "head",
  25490. "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.",
  25491. "in": "BODY",
  25492. "type": "string",
  25493. "required": true,
  25494. "enum": null,
  25495. "allowNull": false,
  25496. "mapToData": null,
  25497. "validation": null,
  25498. "alias": null,
  25499. "deprecated": null
  25500. },
  25501. {
  25502. "name": "base",
  25503. "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.",
  25504. "in": "BODY",
  25505. "type": "string",
  25506. "required": true,
  25507. "enum": null,
  25508. "allowNull": false,
  25509. "mapToData": null,
  25510. "validation": null,
  25511. "alias": null,
  25512. "deprecated": null
  25513. },
  25514. {
  25515. "name": "body",
  25516. "description": "The contents of the pull request.",
  25517. "in": "BODY",
  25518. "type": "string",
  25519. "required": false,
  25520. "enum": null,
  25521. "allowNull": false,
  25522. "mapToData": null,
  25523. "validation": null,
  25524. "alias": null,
  25525. "deprecated": null
  25526. },
  25527. {
  25528. "name": "maintainer_can_modify",
  25529. "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
  25530. "in": "BODY",
  25531. "type": "boolean",
  25532. "required": false,
  25533. "enum": null,
  25534. "allowNull": false,
  25535. "mapToData": null,
  25536. "validation": null,
  25537. "alias": null,
  25538. "deprecated": null
  25539. },
  25540. {
  25541. "name": "draft",
  25542. "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.",
  25543. "in": "BODY",
  25544. "type": "boolean",
  25545. "required": false,
  25546. "enum": null,
  25547. "allowNull": false,
  25548. "mapToData": null,
  25549. "validation": null,
  25550. "alias": null,
  25551. "deprecated": null
  25552. }
  25553. ],
  25554. "responses": [
  25555. {
  25556. "code": 201,
  25557. "description": "response",
  25558. "examples": [
  25559. {
  25560. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
  25561. }
  25562. ]
  25563. }
  25564. ],
  25565. "renamed": null
  25566. },
  25567. {
  25568. "name": "List comments in a repository",
  25569. "scope": "pulls",
  25570. "id": "listCommentsForRepo",
  25571. "method": "GET",
  25572. "url": "/repos/{owner}/{repo}/pulls/comments",
  25573. "isDeprecated": false,
  25574. "description": "Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.",
  25575. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/comments/#list-comments-in-a-repository",
  25576. "previews": [],
  25577. "headers": [],
  25578. "parameters": [
  25579. {
  25580. "name": "owner",
  25581. "description": "owner parameter",
  25582. "in": "PATH",
  25583. "type": "string",
  25584. "required": true,
  25585. "enum": null,
  25586. "allowNull": false,
  25587. "mapToData": null,
  25588. "validation": null,
  25589. "alias": null,
  25590. "deprecated": null
  25591. },
  25592. {
  25593. "name": "repo",
  25594. "description": "repo parameter",
  25595. "in": "PATH",
  25596. "type": "string",
  25597. "required": true,
  25598. "enum": null,
  25599. "allowNull": false,
  25600. "mapToData": null,
  25601. "validation": null,
  25602. "alias": null,
  25603. "deprecated": null
  25604. },
  25605. {
  25606. "name": "sort",
  25607. "description": "Can be either `created` or `updated` comments.",
  25608. "in": "QUERY",
  25609. "type": "string",
  25610. "required": false,
  25611. "enum": ["created", "updated"],
  25612. "allowNull": false,
  25613. "mapToData": null,
  25614. "validation": null,
  25615. "alias": null,
  25616. "deprecated": null
  25617. },
  25618. {
  25619. "name": "direction",
  25620. "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
  25621. "in": "QUERY",
  25622. "type": "string",
  25623. "required": false,
  25624. "enum": ["asc", "desc"],
  25625. "allowNull": false,
  25626. "mapToData": null,
  25627. "validation": null,
  25628. "alias": null,
  25629. "deprecated": null
  25630. },
  25631. {
  25632. "name": "since",
  25633. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.",
  25634. "in": "QUERY",
  25635. "type": "string",
  25636. "required": false,
  25637. "enum": null,
  25638. "allowNull": false,
  25639. "mapToData": null,
  25640. "validation": null,
  25641. "alias": null,
  25642. "deprecated": null
  25643. },
  25644. {
  25645. "name": "per_page",
  25646. "description": "Results per page (max 100)",
  25647. "in": "QUERY",
  25648. "type": "integer",
  25649. "required": false,
  25650. "enum": null,
  25651. "allowNull": false,
  25652. "mapToData": null,
  25653. "validation": null,
  25654. "alias": null,
  25655. "deprecated": null
  25656. },
  25657. {
  25658. "name": "page",
  25659. "description": "Page number of the results to fetch.",
  25660. "in": "QUERY",
  25661. "type": "integer",
  25662. "required": false,
  25663. "enum": null,
  25664. "allowNull": false,
  25665. "mapToData": null,
  25666. "validation": null,
  25667. "alias": null,
  25668. "deprecated": null
  25669. }
  25670. ],
  25671. "responses": [
  25672. {
  25673. "code": 200,
  25674. "description": "response",
  25675. "examples": [
  25676. {
  25677. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]"
  25678. }
  25679. ]
  25680. }
  25681. ],
  25682. "renamed": null
  25683. },
  25684. {
  25685. "name": "Get a single comment",
  25686. "scope": "pulls",
  25687. "id": "getComment",
  25688. "method": "GET",
  25689. "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
  25690. "isDeprecated": false,
  25691. "description": "Provides details for a review comment.",
  25692. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/comments/#get-a-single-comment",
  25693. "previews": [],
  25694. "headers": [],
  25695. "parameters": [
  25696. {
  25697. "name": "owner",
  25698. "description": "owner parameter",
  25699. "in": "PATH",
  25700. "type": "string",
  25701. "required": true,
  25702. "enum": null,
  25703. "allowNull": false,
  25704. "mapToData": null,
  25705. "validation": null,
  25706. "alias": null,
  25707. "deprecated": null
  25708. },
  25709. {
  25710. "name": "repo",
  25711. "description": "repo parameter",
  25712. "in": "PATH",
  25713. "type": "string",
  25714. "required": true,
  25715. "enum": null,
  25716. "allowNull": false,
  25717. "mapToData": null,
  25718. "validation": null,
  25719. "alias": null,
  25720. "deprecated": null
  25721. },
  25722. {
  25723. "name": "comment_id",
  25724. "description": "comment_id parameter",
  25725. "in": "PATH",
  25726. "type": "integer",
  25727. "required": true,
  25728. "enum": null,
  25729. "allowNull": false,
  25730. "mapToData": null,
  25731. "validation": null,
  25732. "alias": null,
  25733. "deprecated": null
  25734. }
  25735. ],
  25736. "responses": [
  25737. {
  25738. "code": 200,
  25739. "description": "response",
  25740. "examples": [
  25741. {
  25742. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}"
  25743. }
  25744. ]
  25745. }
  25746. ],
  25747. "renamed": null
  25748. },
  25749. {
  25750. "name": "Edit a comment",
  25751. "scope": "pulls",
  25752. "id": "updateComment",
  25753. "method": "PATCH",
  25754. "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
  25755. "isDeprecated": false,
  25756. "description": "Enables you to edit a review comment.",
  25757. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/comments/#edit-a-comment",
  25758. "previews": [],
  25759. "headers": [],
  25760. "parameters": [
  25761. {
  25762. "name": "owner",
  25763. "description": "owner parameter",
  25764. "in": "PATH",
  25765. "type": "string",
  25766. "required": true,
  25767. "enum": null,
  25768. "allowNull": false,
  25769. "mapToData": null,
  25770. "validation": null,
  25771. "alias": null,
  25772. "deprecated": null
  25773. },
  25774. {
  25775. "name": "repo",
  25776. "description": "repo parameter",
  25777. "in": "PATH",
  25778. "type": "string",
  25779. "required": true,
  25780. "enum": null,
  25781. "allowNull": false,
  25782. "mapToData": null,
  25783. "validation": null,
  25784. "alias": null,
  25785. "deprecated": null
  25786. },
  25787. {
  25788. "name": "comment_id",
  25789. "description": "comment_id parameter",
  25790. "in": "PATH",
  25791. "type": "integer",
  25792. "required": true,
  25793. "enum": null,
  25794. "allowNull": false,
  25795. "mapToData": null,
  25796. "validation": null,
  25797. "alias": null,
  25798. "deprecated": null
  25799. },
  25800. {
  25801. "name": "body",
  25802. "description": "The text of the reply to the review comment.",
  25803. "in": "BODY",
  25804. "type": "string",
  25805. "required": true,
  25806. "enum": null,
  25807. "allowNull": false,
  25808. "mapToData": null,
  25809. "validation": null,
  25810. "alias": null,
  25811. "deprecated": null
  25812. }
  25813. ],
  25814. "responses": [
  25815. {
  25816. "code": 200,
  25817. "description": "response",
  25818. "examples": [
  25819. {
  25820. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}"
  25821. }
  25822. ]
  25823. }
  25824. ],
  25825. "renamed": null
  25826. },
  25827. {
  25828. "name": "Delete a comment",
  25829. "scope": "pulls",
  25830. "id": "deleteComment",
  25831. "method": "DELETE",
  25832. "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}",
  25833. "isDeprecated": false,
  25834. "description": "Deletes a review comment.",
  25835. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/comments/#delete-a-comment",
  25836. "previews": [],
  25837. "headers": [],
  25838. "parameters": [
  25839. {
  25840. "name": "owner",
  25841. "description": "owner parameter",
  25842. "in": "PATH",
  25843. "type": "string",
  25844. "required": true,
  25845. "enum": null,
  25846. "allowNull": false,
  25847. "mapToData": null,
  25848. "validation": null,
  25849. "alias": null,
  25850. "deprecated": null
  25851. },
  25852. {
  25853. "name": "repo",
  25854. "description": "repo parameter",
  25855. "in": "PATH",
  25856. "type": "string",
  25857. "required": true,
  25858. "enum": null,
  25859. "allowNull": false,
  25860. "mapToData": null,
  25861. "validation": null,
  25862. "alias": null,
  25863. "deprecated": null
  25864. },
  25865. {
  25866. "name": "comment_id",
  25867. "description": "comment_id parameter",
  25868. "in": "PATH",
  25869. "type": "integer",
  25870. "required": true,
  25871. "enum": null,
  25872. "allowNull": false,
  25873. "mapToData": null,
  25874. "validation": null,
  25875. "alias": null,
  25876. "deprecated": null
  25877. }
  25878. ],
  25879. "responses": [],
  25880. "renamed": null
  25881. },
  25882. {
  25883. "name": "List reactions for a pull request review comment",
  25884. "scope": "reactions",
  25885. "id": "listForPullRequestReviewComment",
  25886. "method": "GET",
  25887. "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
  25888. "isDeprecated": false,
  25889. "description": "List the reactions to a [pull request review comment](https://developer.github.com/enterprise/2.17/v3/pulls/comments/).",
  25890. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#list-reactions-for-a-pull-request-review-comment",
  25891. "previews": [{ "name": "squirrel-girl" }],
  25892. "headers": [
  25893. {
  25894. "name": "accept",
  25895. "value": "application/vnd.github.squirrel-girl-preview+json"
  25896. }
  25897. ],
  25898. "parameters": [
  25899. {
  25900. "name": "owner",
  25901. "description": "owner parameter",
  25902. "in": "PATH",
  25903. "type": "string",
  25904. "required": true,
  25905. "enum": null,
  25906. "allowNull": false,
  25907. "mapToData": null,
  25908. "validation": null,
  25909. "alias": null,
  25910. "deprecated": null
  25911. },
  25912. {
  25913. "name": "repo",
  25914. "description": "repo parameter",
  25915. "in": "PATH",
  25916. "type": "string",
  25917. "required": true,
  25918. "enum": null,
  25919. "allowNull": false,
  25920. "mapToData": null,
  25921. "validation": null,
  25922. "alias": null,
  25923. "deprecated": null
  25924. },
  25925. {
  25926. "name": "comment_id",
  25927. "description": "comment_id parameter",
  25928. "in": "PATH",
  25929. "type": "integer",
  25930. "required": true,
  25931. "enum": null,
  25932. "allowNull": false,
  25933. "mapToData": null,
  25934. "validation": null,
  25935. "alias": null,
  25936. "deprecated": null
  25937. },
  25938. {
  25939. "name": "content",
  25940. "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.",
  25941. "in": "QUERY",
  25942. "type": "string",
  25943. "required": false,
  25944. "enum": [
  25945. "+1",
  25946. "-1",
  25947. "laugh",
  25948. "confused",
  25949. "heart",
  25950. "hooray",
  25951. "rocket",
  25952. "eyes"
  25953. ],
  25954. "allowNull": false,
  25955. "mapToData": null,
  25956. "validation": null,
  25957. "alias": null,
  25958. "deprecated": null
  25959. },
  25960. {
  25961. "name": "per_page",
  25962. "description": "Results per page (max 100)",
  25963. "in": "QUERY",
  25964. "type": "integer",
  25965. "required": false,
  25966. "enum": null,
  25967. "allowNull": false,
  25968. "mapToData": null,
  25969. "validation": null,
  25970. "alias": null,
  25971. "deprecated": null
  25972. },
  25973. {
  25974. "name": "page",
  25975. "description": "Page number of the results to fetch.",
  25976. "in": "QUERY",
  25977. "type": "integer",
  25978. "required": false,
  25979. "enum": null,
  25980. "allowNull": false,
  25981. "mapToData": null,
  25982. "validation": null,
  25983. "alias": null,
  25984. "deprecated": null
  25985. }
  25986. ],
  25987. "responses": [
  25988. {
  25989. "code": 200,
  25990. "description": "response",
  25991. "examples": [
  25992. {
  25993. "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]"
  25994. }
  25995. ]
  25996. }
  25997. ],
  25998. "renamed": null
  25999. },
  26000. {
  26001. "name": "Create reaction for a pull request review comment",
  26002. "scope": "reactions",
  26003. "id": "createForPullRequestReviewComment",
  26004. "method": "POST",
  26005. "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions",
  26006. "isDeprecated": false,
  26007. "description": "Create a reaction to a [pull request review comment](https://developer.github.com/enterprise/2.17/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.",
  26008. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#create-reaction-for-a-pull-request-review-comment",
  26009. "previews": [{ "name": "squirrel-girl" }],
  26010. "headers": [
  26011. {
  26012. "name": "accept",
  26013. "value": "application/vnd.github.squirrel-girl-preview+json"
  26014. }
  26015. ],
  26016. "parameters": [
  26017. {
  26018. "name": "owner",
  26019. "description": "owner parameter",
  26020. "in": "PATH",
  26021. "type": "string",
  26022. "required": true,
  26023. "enum": null,
  26024. "allowNull": false,
  26025. "mapToData": null,
  26026. "validation": null,
  26027. "alias": null,
  26028. "deprecated": null
  26029. },
  26030. {
  26031. "name": "repo",
  26032. "description": "repo parameter",
  26033. "in": "PATH",
  26034. "type": "string",
  26035. "required": true,
  26036. "enum": null,
  26037. "allowNull": false,
  26038. "mapToData": null,
  26039. "validation": null,
  26040. "alias": null,
  26041. "deprecated": null
  26042. },
  26043. {
  26044. "name": "comment_id",
  26045. "description": "comment_id parameter",
  26046. "in": "PATH",
  26047. "type": "integer",
  26048. "required": true,
  26049. "enum": null,
  26050. "allowNull": false,
  26051. "mapToData": null,
  26052. "validation": null,
  26053. "alias": null,
  26054. "deprecated": null
  26055. },
  26056. {
  26057. "name": "content",
  26058. "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the pull request review comment.",
  26059. "in": "BODY",
  26060. "type": "string",
  26061. "required": true,
  26062. "enum": [
  26063. "+1",
  26064. "-1",
  26065. "laugh",
  26066. "confused",
  26067. "heart",
  26068. "hooray",
  26069. "rocket",
  26070. "eyes"
  26071. ],
  26072. "allowNull": false,
  26073. "mapToData": null,
  26074. "validation": null,
  26075. "alias": null,
  26076. "deprecated": null
  26077. }
  26078. ],
  26079. "responses": [
  26080. {
  26081. "code": 201,
  26082. "description": "response",
  26083. "examples": [
  26084. {
  26085. "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}"
  26086. }
  26087. ]
  26088. }
  26089. ],
  26090. "renamed": null
  26091. },
  26092. {
  26093. "name": "Get a single pull request",
  26094. "scope": "pulls",
  26095. "id": "get",
  26096. "method": "GET",
  26097. "url": "/repos/{owner}/{repo}/pulls/{pull_number}",
  26098. "isDeprecated": false,
  26099. "description": "Lists details of a pull request by providing its number.\n\nWhen you get, [create](https://developer.github.com/enterprise/2.17/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/enterprise/2.17/v3/pulls/#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/enterprise/2.17/v3/git/#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://developer.github.com/enterprise/2.17/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
  26100. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#get-a-single-pull-request",
  26101. "previews": [],
  26102. "headers": [],
  26103. "parameters": [
  26104. {
  26105. "name": "owner",
  26106. "description": "owner parameter",
  26107. "in": "PATH",
  26108. "type": "string",
  26109. "required": true,
  26110. "enum": null,
  26111. "allowNull": false,
  26112. "mapToData": null,
  26113. "validation": null,
  26114. "alias": null,
  26115. "deprecated": null
  26116. },
  26117. {
  26118. "name": "repo",
  26119. "description": "repo parameter",
  26120. "in": "PATH",
  26121. "type": "string",
  26122. "required": true,
  26123. "enum": null,
  26124. "allowNull": false,
  26125. "mapToData": null,
  26126. "validation": null,
  26127. "alias": null,
  26128. "deprecated": null
  26129. },
  26130. {
  26131. "name": "pull_number",
  26132. "description": "pull_number parameter",
  26133. "in": "PATH",
  26134. "type": "integer",
  26135. "required": true,
  26136. "enum": null,
  26137. "allowNull": false,
  26138. "mapToData": null,
  26139. "validation": null,
  26140. "alias": null,
  26141. "deprecated": null
  26142. },
  26143. {
  26144. "name": "number",
  26145. "description": null,
  26146. "in": null,
  26147. "type": null,
  26148. "required": null,
  26149. "enum": null,
  26150. "allowNull": null,
  26151. "mapToData": null,
  26152. "validation": null,
  26153. "alias": "pull_number",
  26154. "deprecated": true
  26155. }
  26156. ],
  26157. "responses": [
  26158. {
  26159. "code": 200,
  26160. "description": "Pass the appropriate [media type](https://developer.github.com/enterprise/2.17/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.",
  26161. "examples": [
  26162. {
  26163. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
  26164. }
  26165. ]
  26166. }
  26167. ],
  26168. "renamed": null
  26169. },
  26170. {
  26171. "name": "Update a pull request",
  26172. "scope": "pulls",
  26173. "id": "update",
  26174. "method": "PATCH",
  26175. "url": "/repos/{owner}/{repo}/pulls/{pull_number}",
  26176. "isDeprecated": false,
  26177. "description": "",
  26178. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#update-a-pull-request",
  26179. "previews": [],
  26180. "headers": [],
  26181. "parameters": [
  26182. {
  26183. "name": "owner",
  26184. "description": "owner parameter",
  26185. "in": "PATH",
  26186. "type": "string",
  26187. "required": true,
  26188. "enum": null,
  26189. "allowNull": false,
  26190. "mapToData": null,
  26191. "validation": null,
  26192. "alias": null,
  26193. "deprecated": null
  26194. },
  26195. {
  26196. "name": "repo",
  26197. "description": "repo parameter",
  26198. "in": "PATH",
  26199. "type": "string",
  26200. "required": true,
  26201. "enum": null,
  26202. "allowNull": false,
  26203. "mapToData": null,
  26204. "validation": null,
  26205. "alias": null,
  26206. "deprecated": null
  26207. },
  26208. {
  26209. "name": "pull_number",
  26210. "description": "pull_number parameter",
  26211. "in": "PATH",
  26212. "type": "integer",
  26213. "required": true,
  26214. "enum": null,
  26215. "allowNull": false,
  26216. "mapToData": null,
  26217. "validation": null,
  26218. "alias": null,
  26219. "deprecated": null
  26220. },
  26221. {
  26222. "name": "title",
  26223. "description": "The title of the pull request.",
  26224. "in": "BODY",
  26225. "type": "string",
  26226. "required": false,
  26227. "enum": null,
  26228. "allowNull": false,
  26229. "mapToData": null,
  26230. "validation": null,
  26231. "alias": null,
  26232. "deprecated": null
  26233. },
  26234. {
  26235. "name": "body",
  26236. "description": "The contents of the pull request.",
  26237. "in": "BODY",
  26238. "type": "string",
  26239. "required": false,
  26240. "enum": null,
  26241. "allowNull": false,
  26242. "mapToData": null,
  26243. "validation": null,
  26244. "alias": null,
  26245. "deprecated": null
  26246. },
  26247. {
  26248. "name": "state",
  26249. "description": "State of this Pull Request. Either `open` or `closed`.",
  26250. "in": "BODY",
  26251. "type": "string",
  26252. "required": false,
  26253. "enum": ["open", "closed"],
  26254. "allowNull": false,
  26255. "mapToData": null,
  26256. "validation": null,
  26257. "alias": null,
  26258. "deprecated": null
  26259. },
  26260. {
  26261. "name": "base",
  26262. "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.",
  26263. "in": "BODY",
  26264. "type": "string",
  26265. "required": false,
  26266. "enum": null,
  26267. "allowNull": false,
  26268. "mapToData": null,
  26269. "validation": null,
  26270. "alias": null,
  26271. "deprecated": null
  26272. },
  26273. {
  26274. "name": "maintainer_can_modify",
  26275. "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.",
  26276. "in": "BODY",
  26277. "type": "boolean",
  26278. "required": false,
  26279. "enum": null,
  26280. "allowNull": false,
  26281. "mapToData": null,
  26282. "validation": null,
  26283. "alias": null,
  26284. "deprecated": null
  26285. },
  26286. {
  26287. "name": "number",
  26288. "description": null,
  26289. "in": null,
  26290. "type": null,
  26291. "required": null,
  26292. "enum": null,
  26293. "allowNull": null,
  26294. "mapToData": null,
  26295. "validation": null,
  26296. "alias": "pull_number",
  26297. "deprecated": true
  26298. }
  26299. ],
  26300. "responses": [
  26301. {
  26302. "code": 200,
  26303. "description": "response",
  26304. "examples": [
  26305. {
  26306. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}"
  26307. }
  26308. ]
  26309. }
  26310. ],
  26311. "renamed": null
  26312. },
  26313. {
  26314. "name": "List comments on a pull request",
  26315. "scope": "pulls",
  26316. "id": "listComments",
  26317. "method": "GET",
  26318. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
  26319. "isDeprecated": false,
  26320. "description": "Lists review comments for a pull request. By default, review comments are in ascending order by ID.",
  26321. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/comments/#list-comments-on-a-pull-request",
  26322. "previews": [],
  26323. "headers": [],
  26324. "parameters": [
  26325. {
  26326. "name": "owner",
  26327. "description": "owner parameter",
  26328. "in": "PATH",
  26329. "type": "string",
  26330. "required": true,
  26331. "enum": null,
  26332. "allowNull": false,
  26333. "mapToData": null,
  26334. "validation": null,
  26335. "alias": null,
  26336. "deprecated": null
  26337. },
  26338. {
  26339. "name": "repo",
  26340. "description": "repo parameter",
  26341. "in": "PATH",
  26342. "type": "string",
  26343. "required": true,
  26344. "enum": null,
  26345. "allowNull": false,
  26346. "mapToData": null,
  26347. "validation": null,
  26348. "alias": null,
  26349. "deprecated": null
  26350. },
  26351. {
  26352. "name": "pull_number",
  26353. "description": "pull_number parameter",
  26354. "in": "PATH",
  26355. "type": "integer",
  26356. "required": true,
  26357. "enum": null,
  26358. "allowNull": false,
  26359. "mapToData": null,
  26360. "validation": null,
  26361. "alias": null,
  26362. "deprecated": null
  26363. },
  26364. {
  26365. "name": "sort",
  26366. "description": "Can be either `created` or `updated` comments.",
  26367. "in": "QUERY",
  26368. "type": "string",
  26369. "required": false,
  26370. "enum": ["created", "updated"],
  26371. "allowNull": false,
  26372. "mapToData": null,
  26373. "validation": null,
  26374. "alias": null,
  26375. "deprecated": null
  26376. },
  26377. {
  26378. "name": "direction",
  26379. "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.",
  26380. "in": "QUERY",
  26381. "type": "string",
  26382. "required": false,
  26383. "enum": ["asc", "desc"],
  26384. "allowNull": false,
  26385. "mapToData": null,
  26386. "validation": null,
  26387. "alias": null,
  26388. "deprecated": null
  26389. },
  26390. {
  26391. "name": "since",
  26392. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.",
  26393. "in": "QUERY",
  26394. "type": "string",
  26395. "required": false,
  26396. "enum": null,
  26397. "allowNull": false,
  26398. "mapToData": null,
  26399. "validation": null,
  26400. "alias": null,
  26401. "deprecated": null
  26402. },
  26403. {
  26404. "name": "per_page",
  26405. "description": "Results per page (max 100)",
  26406. "in": "QUERY",
  26407. "type": "integer",
  26408. "required": false,
  26409. "enum": null,
  26410. "allowNull": false,
  26411. "mapToData": null,
  26412. "validation": null,
  26413. "alias": null,
  26414. "deprecated": null
  26415. },
  26416. {
  26417. "name": "page",
  26418. "description": "Page number of the results to fetch.",
  26419. "in": "QUERY",
  26420. "type": "integer",
  26421. "required": false,
  26422. "enum": null,
  26423. "allowNull": false,
  26424. "mapToData": null,
  26425. "validation": null,
  26426. "alias": null,
  26427. "deprecated": null
  26428. },
  26429. {
  26430. "name": "number",
  26431. "description": null,
  26432. "in": null,
  26433. "type": null,
  26434. "required": null,
  26435. "enum": null,
  26436. "allowNull": null,
  26437. "mapToData": null,
  26438. "validation": null,
  26439. "alias": "pull_number",
  26440. "deprecated": true
  26441. }
  26442. ],
  26443. "responses": [
  26444. {
  26445. "code": 200,
  26446. "description": "response",
  26447. "examples": [
  26448. {
  26449. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]"
  26450. }
  26451. ]
  26452. }
  26453. ],
  26454. "renamed": null
  26455. },
  26456. {
  26457. "name": "Create a comment reply",
  26458. "scope": "pulls",
  26459. "id": "createCommentReply",
  26460. "method": "POST",
  26461. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments",
  26462. "isDeprecated": false,
  26463. "description": "Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Comments](https://developer.github.com/enterprise/2.17/v3/issues/comments/#create-a-comment).\"\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  26464. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/comments/#create-a-comment",
  26465. "previews": [],
  26466. "headers": [],
  26467. "parameters": [
  26468. {
  26469. "name": "owner",
  26470. "description": "owner parameter",
  26471. "in": "PATH",
  26472. "type": "string",
  26473. "required": true,
  26474. "enum": null,
  26475. "allowNull": false,
  26476. "mapToData": null,
  26477. "validation": null,
  26478. "alias": null,
  26479. "deprecated": null
  26480. },
  26481. {
  26482. "name": "repo",
  26483. "description": "repo parameter",
  26484. "in": "PATH",
  26485. "type": "string",
  26486. "required": true,
  26487. "enum": null,
  26488. "allowNull": false,
  26489. "mapToData": null,
  26490. "validation": null,
  26491. "alias": null,
  26492. "deprecated": null
  26493. },
  26494. {
  26495. "name": "pull_number",
  26496. "description": "pull_number parameter",
  26497. "in": "PATH",
  26498. "type": "integer",
  26499. "required": true,
  26500. "enum": null,
  26501. "allowNull": false,
  26502. "mapToData": null,
  26503. "validation": null,
  26504. "alias": null,
  26505. "deprecated": null
  26506. },
  26507. {
  26508. "name": "body",
  26509. "description": "The text of the comment.",
  26510. "in": "BODY",
  26511. "type": "string",
  26512. "required": true,
  26513. "enum": null,
  26514. "allowNull": false,
  26515. "mapToData": null,
  26516. "validation": null,
  26517. "alias": null,
  26518. "deprecated": null
  26519. },
  26520. {
  26521. "name": "in_reply_to",
  26522. "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.",
  26523. "in": "BODY",
  26524. "type": "integer",
  26525. "required": true,
  26526. "enum": null,
  26527. "allowNull": false,
  26528. "mapToData": null,
  26529. "validation": null,
  26530. "alias": null,
  26531. "deprecated": null
  26532. },
  26533. {
  26534. "name": "number",
  26535. "description": null,
  26536. "in": null,
  26537. "type": null,
  26538. "required": null,
  26539. "enum": null,
  26540. "allowNull": null,
  26541. "mapToData": null,
  26542. "validation": null,
  26543. "alias": "pull_number",
  26544. "deprecated": true
  26545. }
  26546. ],
  26547. "responses": [
  26548. {
  26549. "code": 201,
  26550. "description": "response",
  26551. "examples": [
  26552. {
  26553. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}"
  26554. }
  26555. ]
  26556. }
  26557. ],
  26558. "renamed": null
  26559. },
  26560. {
  26561. "name": "List commits on a pull request",
  26562. "scope": "pulls",
  26563. "id": "listCommits",
  26564. "method": "GET",
  26565. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits",
  26566. "isDeprecated": false,
  26567. "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/enterprise/2.17/v3/repos/commits/#list-commits-on-a-repository).",
  26568. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#list-commits-on-a-pull-request",
  26569. "previews": [],
  26570. "headers": [],
  26571. "parameters": [
  26572. {
  26573. "name": "owner",
  26574. "description": "owner parameter",
  26575. "in": "PATH",
  26576. "type": "string",
  26577. "required": true,
  26578. "enum": null,
  26579. "allowNull": false,
  26580. "mapToData": null,
  26581. "validation": null,
  26582. "alias": null,
  26583. "deprecated": null
  26584. },
  26585. {
  26586. "name": "repo",
  26587. "description": "repo parameter",
  26588. "in": "PATH",
  26589. "type": "string",
  26590. "required": true,
  26591. "enum": null,
  26592. "allowNull": false,
  26593. "mapToData": null,
  26594. "validation": null,
  26595. "alias": null,
  26596. "deprecated": null
  26597. },
  26598. {
  26599. "name": "pull_number",
  26600. "description": "pull_number parameter",
  26601. "in": "PATH",
  26602. "type": "integer",
  26603. "required": true,
  26604. "enum": null,
  26605. "allowNull": false,
  26606. "mapToData": null,
  26607. "validation": null,
  26608. "alias": null,
  26609. "deprecated": null
  26610. },
  26611. {
  26612. "name": "per_page",
  26613. "description": "Results per page (max 100)",
  26614. "in": "QUERY",
  26615. "type": "integer",
  26616. "required": false,
  26617. "enum": null,
  26618. "allowNull": false,
  26619. "mapToData": null,
  26620. "validation": null,
  26621. "alias": null,
  26622. "deprecated": null
  26623. },
  26624. {
  26625. "name": "page",
  26626. "description": "Page number of the results to fetch.",
  26627. "in": "QUERY",
  26628. "type": "integer",
  26629. "required": false,
  26630. "enum": null,
  26631. "allowNull": false,
  26632. "mapToData": null,
  26633. "validation": null,
  26634. "alias": null,
  26635. "deprecated": null
  26636. },
  26637. {
  26638. "name": "number",
  26639. "description": null,
  26640. "in": null,
  26641. "type": null,
  26642. "required": null,
  26643. "enum": null,
  26644. "allowNull": null,
  26645. "mapToData": null,
  26646. "validation": null,
  26647. "alias": "pull_number",
  26648. "deprecated": true
  26649. }
  26650. ],
  26651. "responses": [
  26652. {
  26653. "code": 200,
  26654. "description": "response",
  26655. "examples": [
  26656. {
  26657. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]"
  26658. }
  26659. ]
  26660. }
  26661. ],
  26662. "renamed": null
  26663. },
  26664. {
  26665. "name": "List pull requests files",
  26666. "scope": "pulls",
  26667. "id": "listFiles",
  26668. "method": "GET",
  26669. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files",
  26670. "isDeprecated": false,
  26671. "description": "**Note:** The response includes a maximum of 300 files.",
  26672. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests-files",
  26673. "previews": [],
  26674. "headers": [],
  26675. "parameters": [
  26676. {
  26677. "name": "owner",
  26678. "description": "owner parameter",
  26679. "in": "PATH",
  26680. "type": "string",
  26681. "required": true,
  26682. "enum": null,
  26683. "allowNull": false,
  26684. "mapToData": null,
  26685. "validation": null,
  26686. "alias": null,
  26687. "deprecated": null
  26688. },
  26689. {
  26690. "name": "repo",
  26691. "description": "repo parameter",
  26692. "in": "PATH",
  26693. "type": "string",
  26694. "required": true,
  26695. "enum": null,
  26696. "allowNull": false,
  26697. "mapToData": null,
  26698. "validation": null,
  26699. "alias": null,
  26700. "deprecated": null
  26701. },
  26702. {
  26703. "name": "pull_number",
  26704. "description": "pull_number parameter",
  26705. "in": "PATH",
  26706. "type": "integer",
  26707. "required": true,
  26708. "enum": null,
  26709. "allowNull": false,
  26710. "mapToData": null,
  26711. "validation": null,
  26712. "alias": null,
  26713. "deprecated": null
  26714. },
  26715. {
  26716. "name": "per_page",
  26717. "description": "Results per page (max 100)",
  26718. "in": "QUERY",
  26719. "type": "integer",
  26720. "required": false,
  26721. "enum": null,
  26722. "allowNull": false,
  26723. "mapToData": null,
  26724. "validation": null,
  26725. "alias": null,
  26726. "deprecated": null
  26727. },
  26728. {
  26729. "name": "page",
  26730. "description": "Page number of the results to fetch.",
  26731. "in": "QUERY",
  26732. "type": "integer",
  26733. "required": false,
  26734. "enum": null,
  26735. "allowNull": false,
  26736. "mapToData": null,
  26737. "validation": null,
  26738. "alias": null,
  26739. "deprecated": null
  26740. },
  26741. {
  26742. "name": "number",
  26743. "description": null,
  26744. "in": null,
  26745. "type": null,
  26746. "required": null,
  26747. "enum": null,
  26748. "allowNull": null,
  26749. "mapToData": null,
  26750. "validation": null,
  26751. "alias": "pull_number",
  26752. "deprecated": true
  26753. }
  26754. ],
  26755. "responses": [
  26756. {
  26757. "code": 200,
  26758. "description": "response",
  26759. "examples": [
  26760. {
  26761. "data": "[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]"
  26762. }
  26763. ]
  26764. }
  26765. ],
  26766. "renamed": null
  26767. },
  26768. {
  26769. "name": "Get if a pull request has been merged",
  26770. "scope": "pulls",
  26771. "id": "checkIfMerged",
  26772. "method": "GET",
  26773. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
  26774. "isDeprecated": false,
  26775. "description": "",
  26776. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#get-if-a-pull-request-has-been-merged",
  26777. "previews": [],
  26778. "headers": [],
  26779. "parameters": [
  26780. {
  26781. "name": "owner",
  26782. "description": "owner parameter",
  26783. "in": "PATH",
  26784. "type": "string",
  26785. "required": true,
  26786. "enum": null,
  26787. "allowNull": false,
  26788. "mapToData": null,
  26789. "validation": null,
  26790. "alias": null,
  26791. "deprecated": null
  26792. },
  26793. {
  26794. "name": "repo",
  26795. "description": "repo parameter",
  26796. "in": "PATH",
  26797. "type": "string",
  26798. "required": true,
  26799. "enum": null,
  26800. "allowNull": false,
  26801. "mapToData": null,
  26802. "validation": null,
  26803. "alias": null,
  26804. "deprecated": null
  26805. },
  26806. {
  26807. "name": "pull_number",
  26808. "description": "pull_number parameter",
  26809. "in": "PATH",
  26810. "type": "integer",
  26811. "required": true,
  26812. "enum": null,
  26813. "allowNull": false,
  26814. "mapToData": null,
  26815. "validation": null,
  26816. "alias": null,
  26817. "deprecated": null
  26818. },
  26819. {
  26820. "name": "number",
  26821. "description": null,
  26822. "in": null,
  26823. "type": null,
  26824. "required": null,
  26825. "enum": null,
  26826. "allowNull": null,
  26827. "mapToData": null,
  26828. "validation": null,
  26829. "alias": "pull_number",
  26830. "deprecated": true
  26831. }
  26832. ],
  26833. "responses": [],
  26834. "renamed": null
  26835. },
  26836. {
  26837. "name": "Merge a pull request (Merge Button)",
  26838. "scope": "pulls",
  26839. "id": "merge",
  26840. "method": "PUT",
  26841. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
  26842. "isDeprecated": false,
  26843. "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  26844. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/#merge-a-pull-request-merge-button",
  26845. "previews": [],
  26846. "headers": [],
  26847. "parameters": [
  26848. {
  26849. "name": "owner",
  26850. "description": "owner parameter",
  26851. "in": "PATH",
  26852. "type": "string",
  26853. "required": true,
  26854. "enum": null,
  26855. "allowNull": false,
  26856. "mapToData": null,
  26857. "validation": null,
  26858. "alias": null,
  26859. "deprecated": null
  26860. },
  26861. {
  26862. "name": "repo",
  26863. "description": "repo parameter",
  26864. "in": "PATH",
  26865. "type": "string",
  26866. "required": true,
  26867. "enum": null,
  26868. "allowNull": false,
  26869. "mapToData": null,
  26870. "validation": null,
  26871. "alias": null,
  26872. "deprecated": null
  26873. },
  26874. {
  26875. "name": "pull_number",
  26876. "description": "pull_number parameter",
  26877. "in": "PATH",
  26878. "type": "integer",
  26879. "required": true,
  26880. "enum": null,
  26881. "allowNull": false,
  26882. "mapToData": null,
  26883. "validation": null,
  26884. "alias": null,
  26885. "deprecated": null
  26886. },
  26887. {
  26888. "name": "commit_title",
  26889. "description": "Title for the automatic commit message.",
  26890. "in": "BODY",
  26891. "type": "string",
  26892. "required": false,
  26893. "enum": null,
  26894. "allowNull": false,
  26895. "mapToData": null,
  26896. "validation": null,
  26897. "alias": null,
  26898. "deprecated": null
  26899. },
  26900. {
  26901. "name": "commit_message",
  26902. "description": "Extra detail to append to automatic commit message.",
  26903. "in": "BODY",
  26904. "type": "string",
  26905. "required": false,
  26906. "enum": null,
  26907. "allowNull": false,
  26908. "mapToData": null,
  26909. "validation": null,
  26910. "alias": null,
  26911. "deprecated": null
  26912. },
  26913. {
  26914. "name": "sha",
  26915. "description": "SHA that pull request head must match to allow merge.",
  26916. "in": "BODY",
  26917. "type": "string",
  26918. "required": false,
  26919. "enum": null,
  26920. "allowNull": false,
  26921. "mapToData": null,
  26922. "validation": null,
  26923. "alias": null,
  26924. "deprecated": null
  26925. },
  26926. {
  26927. "name": "merge_method",
  26928. "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.",
  26929. "in": "BODY",
  26930. "type": "string",
  26931. "required": false,
  26932. "enum": ["merge", "squash", "rebase"],
  26933. "allowNull": false,
  26934. "mapToData": null,
  26935. "validation": null,
  26936. "alias": null,
  26937. "deprecated": null
  26938. },
  26939. {
  26940. "name": "number",
  26941. "description": null,
  26942. "in": null,
  26943. "type": null,
  26944. "required": null,
  26945. "enum": null,
  26946. "allowNull": null,
  26947. "mapToData": null,
  26948. "validation": null,
  26949. "alias": "pull_number",
  26950. "deprecated": true
  26951. }
  26952. ],
  26953. "responses": [
  26954. {
  26955. "code": 200,
  26956. "description": "Response if merge was successful",
  26957. "examples": [
  26958. {
  26959. "data": "{\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"merged\":true,\"message\":\"Pull Request successfully merged\"}"
  26960. }
  26961. ]
  26962. },
  26963. {
  26964. "code": 405,
  26965. "description": "Response if merge cannot be performed",
  26966. "examples": [
  26967. {
  26968. "data": "{\"message\":\"Pull Request is not mergeable\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/pulls/#merge-a-pull-request-merge-button\"}"
  26969. }
  26970. ]
  26971. },
  26972. {
  26973. "code": 409,
  26974. "description": "Response if sha was provided and pull request head did not match",
  26975. "examples": [
  26976. {
  26977. "data": "{\"message\":\"Head branch was modified. Review and try the merge again.\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/pulls/#merge-a-pull-request-merge-button\"}"
  26978. }
  26979. ]
  26980. }
  26981. ],
  26982. "renamed": null
  26983. },
  26984. {
  26985. "name": "List review requests",
  26986. "scope": "pulls",
  26987. "id": "listReviewRequests",
  26988. "method": "GET",
  26989. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
  26990. "isDeprecated": false,
  26991. "description": "",
  26992. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/review_requests/#list-review-requests",
  26993. "previews": [],
  26994. "headers": [],
  26995. "parameters": [
  26996. {
  26997. "name": "owner",
  26998. "description": "owner parameter",
  26999. "in": "PATH",
  27000. "type": "string",
  27001. "required": true,
  27002. "enum": null,
  27003. "allowNull": false,
  27004. "mapToData": null,
  27005. "validation": null,
  27006. "alias": null,
  27007. "deprecated": null
  27008. },
  27009. {
  27010. "name": "repo",
  27011. "description": "repo parameter",
  27012. "in": "PATH",
  27013. "type": "string",
  27014. "required": true,
  27015. "enum": null,
  27016. "allowNull": false,
  27017. "mapToData": null,
  27018. "validation": null,
  27019. "alias": null,
  27020. "deprecated": null
  27021. },
  27022. {
  27023. "name": "pull_number",
  27024. "description": "pull_number parameter",
  27025. "in": "PATH",
  27026. "type": "integer",
  27027. "required": true,
  27028. "enum": null,
  27029. "allowNull": false,
  27030. "mapToData": null,
  27031. "validation": null,
  27032. "alias": null,
  27033. "deprecated": null
  27034. },
  27035. {
  27036. "name": "per_page",
  27037. "description": "Results per page (max 100)",
  27038. "in": "QUERY",
  27039. "type": "integer",
  27040. "required": false,
  27041. "enum": null,
  27042. "allowNull": false,
  27043. "mapToData": null,
  27044. "validation": null,
  27045. "alias": null,
  27046. "deprecated": null
  27047. },
  27048. {
  27049. "name": "page",
  27050. "description": "Page number of the results to fetch.",
  27051. "in": "QUERY",
  27052. "type": "integer",
  27053. "required": false,
  27054. "enum": null,
  27055. "allowNull": false,
  27056. "mapToData": null,
  27057. "validation": null,
  27058. "alias": null,
  27059. "deprecated": null
  27060. },
  27061. {
  27062. "name": "number",
  27063. "description": null,
  27064. "in": null,
  27065. "type": null,
  27066. "required": null,
  27067. "enum": null,
  27068. "allowNull": null,
  27069. "mapToData": null,
  27070. "validation": null,
  27071. "alias": "pull_number",
  27072. "deprecated": true
  27073. }
  27074. ],
  27075. "responses": [
  27076. {
  27077. "code": 200,
  27078. "description": "response",
  27079. "examples": [
  27080. {
  27081. "data": "{\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}"
  27082. }
  27083. ]
  27084. }
  27085. ],
  27086. "renamed": null
  27087. },
  27088. {
  27089. "name": "Create a review request",
  27090. "scope": "pulls",
  27091. "id": "createReviewRequest",
  27092. "method": "POST",
  27093. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
  27094. "isDeprecated": false,
  27095. "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  27096. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/review_requests/#create-a-review-request",
  27097. "previews": [],
  27098. "headers": [],
  27099. "parameters": [
  27100. {
  27101. "name": "owner",
  27102. "description": "owner parameter",
  27103. "in": "PATH",
  27104. "type": "string",
  27105. "required": true,
  27106. "enum": null,
  27107. "allowNull": false,
  27108. "mapToData": null,
  27109. "validation": null,
  27110. "alias": null,
  27111. "deprecated": null
  27112. },
  27113. {
  27114. "name": "repo",
  27115. "description": "repo parameter",
  27116. "in": "PATH",
  27117. "type": "string",
  27118. "required": true,
  27119. "enum": null,
  27120. "allowNull": false,
  27121. "mapToData": null,
  27122. "validation": null,
  27123. "alias": null,
  27124. "deprecated": null
  27125. },
  27126. {
  27127. "name": "pull_number",
  27128. "description": "pull_number parameter",
  27129. "in": "PATH",
  27130. "type": "integer",
  27131. "required": true,
  27132. "enum": null,
  27133. "allowNull": false,
  27134. "mapToData": null,
  27135. "validation": null,
  27136. "alias": null,
  27137. "deprecated": null
  27138. },
  27139. {
  27140. "name": "reviewers",
  27141. "description": "An array of user `login`s that will be requested.",
  27142. "in": "BODY",
  27143. "type": "string[]",
  27144. "required": false,
  27145. "enum": null,
  27146. "allowNull": false,
  27147. "mapToData": null,
  27148. "validation": null,
  27149. "alias": null,
  27150. "deprecated": null
  27151. },
  27152. {
  27153. "name": "team_reviewers",
  27154. "description": "An array of team `slug`s that will be requested.",
  27155. "in": "BODY",
  27156. "type": "string[]",
  27157. "required": false,
  27158. "enum": null,
  27159. "allowNull": false,
  27160. "mapToData": null,
  27161. "validation": null,
  27162. "alias": null,
  27163. "deprecated": null
  27164. },
  27165. {
  27166. "name": "number",
  27167. "description": null,
  27168. "in": null,
  27169. "type": null,
  27170. "required": null,
  27171. "enum": null,
  27172. "allowNull": null,
  27173. "mapToData": null,
  27174. "validation": null,
  27175. "alias": "pull_number",
  27176. "deprecated": true
  27177. }
  27178. ],
  27179. "responses": [
  27180. {
  27181. "code": 201,
  27182. "description": "response",
  27183. "examples": [
  27184. {
  27185. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}"
  27186. }
  27187. ]
  27188. }
  27189. ],
  27190. "renamed": null
  27191. },
  27192. {
  27193. "name": "Delete a review request",
  27194. "scope": "pulls",
  27195. "id": "deleteReviewRequest",
  27196. "method": "DELETE",
  27197. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers",
  27198. "isDeprecated": false,
  27199. "description": "",
  27200. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/review_requests/#delete-a-review-request",
  27201. "previews": [],
  27202. "headers": [],
  27203. "parameters": [
  27204. {
  27205. "name": "owner",
  27206. "description": "owner parameter",
  27207. "in": "PATH",
  27208. "type": "string",
  27209. "required": true,
  27210. "enum": null,
  27211. "allowNull": false,
  27212. "mapToData": null,
  27213. "validation": null,
  27214. "alias": null,
  27215. "deprecated": null
  27216. },
  27217. {
  27218. "name": "repo",
  27219. "description": "repo parameter",
  27220. "in": "PATH",
  27221. "type": "string",
  27222. "required": true,
  27223. "enum": null,
  27224. "allowNull": false,
  27225. "mapToData": null,
  27226. "validation": null,
  27227. "alias": null,
  27228. "deprecated": null
  27229. },
  27230. {
  27231. "name": "pull_number",
  27232. "description": "pull_number parameter",
  27233. "in": "PATH",
  27234. "type": "integer",
  27235. "required": true,
  27236. "enum": null,
  27237. "allowNull": false,
  27238. "mapToData": null,
  27239. "validation": null,
  27240. "alias": null,
  27241. "deprecated": null
  27242. },
  27243. {
  27244. "name": "reviewers",
  27245. "description": "An array of user `login`s that will be removed.",
  27246. "in": "BODY",
  27247. "type": "string[]",
  27248. "required": false,
  27249. "enum": null,
  27250. "allowNull": false,
  27251. "mapToData": null,
  27252. "validation": null,
  27253. "alias": null,
  27254. "deprecated": null
  27255. },
  27256. {
  27257. "name": "team_reviewers",
  27258. "description": "An array of team `slug`s that will be removed.",
  27259. "in": "BODY",
  27260. "type": "string[]",
  27261. "required": false,
  27262. "enum": null,
  27263. "allowNull": false,
  27264. "mapToData": null,
  27265. "validation": null,
  27266. "alias": null,
  27267. "deprecated": null
  27268. },
  27269. {
  27270. "name": "number",
  27271. "description": null,
  27272. "in": null,
  27273. "type": null,
  27274. "required": null,
  27275. "enum": null,
  27276. "allowNull": null,
  27277. "mapToData": null,
  27278. "validation": null,
  27279. "alias": "pull_number",
  27280. "deprecated": true
  27281. }
  27282. ],
  27283. "responses": [],
  27284. "renamed": null
  27285. },
  27286. {
  27287. "name": "List reviews on a pull request",
  27288. "scope": "pulls",
  27289. "id": "listReviews",
  27290. "method": "GET",
  27291. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
  27292. "isDeprecated": false,
  27293. "description": "The list of reviews returns in chronological order.",
  27294. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#list-reviews-on-a-pull-request",
  27295. "previews": [],
  27296. "headers": [],
  27297. "parameters": [
  27298. {
  27299. "name": "owner",
  27300. "description": "owner parameter",
  27301. "in": "PATH",
  27302. "type": "string",
  27303. "required": true,
  27304. "enum": null,
  27305. "allowNull": false,
  27306. "mapToData": null,
  27307. "validation": null,
  27308. "alias": null,
  27309. "deprecated": null
  27310. },
  27311. {
  27312. "name": "repo",
  27313. "description": "repo parameter",
  27314. "in": "PATH",
  27315. "type": "string",
  27316. "required": true,
  27317. "enum": null,
  27318. "allowNull": false,
  27319. "mapToData": null,
  27320. "validation": null,
  27321. "alias": null,
  27322. "deprecated": null
  27323. },
  27324. {
  27325. "name": "pull_number",
  27326. "description": "pull_number parameter",
  27327. "in": "PATH",
  27328. "type": "integer",
  27329. "required": true,
  27330. "enum": null,
  27331. "allowNull": false,
  27332. "mapToData": null,
  27333. "validation": null,
  27334. "alias": null,
  27335. "deprecated": null
  27336. },
  27337. {
  27338. "name": "per_page",
  27339. "description": "Results per page (max 100)",
  27340. "in": "QUERY",
  27341. "type": "integer",
  27342. "required": false,
  27343. "enum": null,
  27344. "allowNull": false,
  27345. "mapToData": null,
  27346. "validation": null,
  27347. "alias": null,
  27348. "deprecated": null
  27349. },
  27350. {
  27351. "name": "page",
  27352. "description": "Page number of the results to fetch.",
  27353. "in": "QUERY",
  27354. "type": "integer",
  27355. "required": false,
  27356. "enum": null,
  27357. "allowNull": false,
  27358. "mapToData": null,
  27359. "validation": null,
  27360. "alias": null,
  27361. "deprecated": null
  27362. },
  27363. {
  27364. "name": "number",
  27365. "description": null,
  27366. "in": null,
  27367. "type": null,
  27368. "required": null,
  27369. "enum": null,
  27370. "allowNull": null,
  27371. "mapToData": null,
  27372. "validation": null,
  27373. "alias": "pull_number",
  27374. "deprecated": true
  27375. }
  27376. ],
  27377. "responses": [
  27378. {
  27379. "code": 200,
  27380. "description": "The list of reviews returns in chronological order.",
  27381. "examples": [
  27382. {
  27383. "data": "[{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}]"
  27384. }
  27385. ]
  27386. }
  27387. ],
  27388. "renamed": null
  27389. },
  27390. {
  27391. "name": "Create a pull request review",
  27392. "scope": "pulls",
  27393. "id": "createReview",
  27394. "method": "POST",
  27395. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews",
  27396. "isDeprecated": false,
  27397. "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://developer.github.com/enterprise/2.17/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://developer.github.com/enterprise/2.17/v3/pulls/#get-a-single-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.",
  27398. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#create-a-pull-request-review",
  27399. "previews": [],
  27400. "headers": [],
  27401. "parameters": [
  27402. {
  27403. "name": "owner",
  27404. "description": "owner parameter",
  27405. "in": "PATH",
  27406. "type": "string",
  27407. "required": true,
  27408. "enum": null,
  27409. "allowNull": false,
  27410. "mapToData": null,
  27411. "validation": null,
  27412. "alias": null,
  27413. "deprecated": null
  27414. },
  27415. {
  27416. "name": "repo",
  27417. "description": "repo parameter",
  27418. "in": "PATH",
  27419. "type": "string",
  27420. "required": true,
  27421. "enum": null,
  27422. "allowNull": false,
  27423. "mapToData": null,
  27424. "validation": null,
  27425. "alias": null,
  27426. "deprecated": null
  27427. },
  27428. {
  27429. "name": "pull_number",
  27430. "description": "pull_number parameter",
  27431. "in": "PATH",
  27432. "type": "integer",
  27433. "required": true,
  27434. "enum": null,
  27435. "allowNull": false,
  27436. "mapToData": null,
  27437. "validation": null,
  27438. "alias": null,
  27439. "deprecated": null
  27440. },
  27441. {
  27442. "name": "commit_id",
  27443. "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.",
  27444. "in": "BODY",
  27445. "type": "string",
  27446. "required": false,
  27447. "enum": null,
  27448. "allowNull": false,
  27449. "mapToData": null,
  27450. "validation": null,
  27451. "alias": null,
  27452. "deprecated": null
  27453. },
  27454. {
  27455. "name": "body",
  27456. "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.",
  27457. "in": "BODY",
  27458. "type": "string",
  27459. "required": false,
  27460. "enum": null,
  27461. "allowNull": false,
  27462. "mapToData": null,
  27463. "validation": null,
  27464. "alias": null,
  27465. "deprecated": null
  27466. },
  27467. {
  27468. "name": "event",
  27469. "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.",
  27470. "in": "BODY",
  27471. "type": "string",
  27472. "required": false,
  27473. "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  27474. "allowNull": false,
  27475. "mapToData": null,
  27476. "validation": null,
  27477. "alias": null,
  27478. "deprecated": null
  27479. },
  27480. {
  27481. "name": "comments",
  27482. "description": "Use the following table to specify the location, destination, and contents of the draft review comment.",
  27483. "in": "BODY",
  27484. "type": "object[]",
  27485. "required": false,
  27486. "enum": null,
  27487. "allowNull": false,
  27488. "mapToData": null,
  27489. "validation": null,
  27490. "alias": null,
  27491. "deprecated": null
  27492. },
  27493. {
  27494. "name": "comments[].path",
  27495. "description": "The relative path to the file that necessitates a review comment.",
  27496. "in": "BODY",
  27497. "type": "string",
  27498. "required": true,
  27499. "enum": null,
  27500. "allowNull": false,
  27501. "mapToData": null,
  27502. "validation": null,
  27503. "alias": null,
  27504. "deprecated": null
  27505. },
  27506. {
  27507. "name": "comments[].position",
  27508. "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.",
  27509. "in": "BODY",
  27510. "type": "integer",
  27511. "required": true,
  27512. "enum": null,
  27513. "allowNull": false,
  27514. "mapToData": null,
  27515. "validation": null,
  27516. "alias": null,
  27517. "deprecated": null
  27518. },
  27519. {
  27520. "name": "comments[].body",
  27521. "description": "Text of the review comment.",
  27522. "in": "BODY",
  27523. "type": "string",
  27524. "required": true,
  27525. "enum": null,
  27526. "allowNull": false,
  27527. "mapToData": null,
  27528. "validation": null,
  27529. "alias": null,
  27530. "deprecated": null
  27531. },
  27532. {
  27533. "name": "number",
  27534. "description": null,
  27535. "in": null,
  27536. "type": null,
  27537. "required": null,
  27538. "enum": null,
  27539. "allowNull": null,
  27540. "mapToData": null,
  27541. "validation": null,
  27542. "alias": "pull_number",
  27543. "deprecated": true
  27544. }
  27545. ],
  27546. "responses": [
  27547. {
  27548. "code": 200,
  27549. "description": "response",
  27550. "examples": [
  27551. {
  27552. "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}"
  27553. }
  27554. ]
  27555. }
  27556. ],
  27557. "renamed": null
  27558. },
  27559. {
  27560. "name": "Get a single review",
  27561. "scope": "pulls",
  27562. "id": "getReview",
  27563. "method": "GET",
  27564. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
  27565. "isDeprecated": false,
  27566. "description": "",
  27567. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#get-a-single-review",
  27568. "previews": [],
  27569. "headers": [],
  27570. "parameters": [
  27571. {
  27572. "name": "owner",
  27573. "description": "owner parameter",
  27574. "in": "PATH",
  27575. "type": "string",
  27576. "required": true,
  27577. "enum": null,
  27578. "allowNull": false,
  27579. "mapToData": null,
  27580. "validation": null,
  27581. "alias": null,
  27582. "deprecated": null
  27583. },
  27584. {
  27585. "name": "repo",
  27586. "description": "repo parameter",
  27587. "in": "PATH",
  27588. "type": "string",
  27589. "required": true,
  27590. "enum": null,
  27591. "allowNull": false,
  27592. "mapToData": null,
  27593. "validation": null,
  27594. "alias": null,
  27595. "deprecated": null
  27596. },
  27597. {
  27598. "name": "pull_number",
  27599. "description": "pull_number parameter",
  27600. "in": "PATH",
  27601. "type": "integer",
  27602. "required": true,
  27603. "enum": null,
  27604. "allowNull": false,
  27605. "mapToData": null,
  27606. "validation": null,
  27607. "alias": null,
  27608. "deprecated": null
  27609. },
  27610. {
  27611. "name": "review_id",
  27612. "description": "review_id parameter",
  27613. "in": "PATH",
  27614. "type": "integer",
  27615. "required": true,
  27616. "enum": null,
  27617. "allowNull": false,
  27618. "mapToData": null,
  27619. "validation": null,
  27620. "alias": null,
  27621. "deprecated": null
  27622. },
  27623. {
  27624. "name": "number",
  27625. "description": null,
  27626. "in": null,
  27627. "type": null,
  27628. "required": null,
  27629. "enum": null,
  27630. "allowNull": null,
  27631. "mapToData": null,
  27632. "validation": null,
  27633. "alias": "pull_number",
  27634. "deprecated": true
  27635. }
  27636. ],
  27637. "responses": [
  27638. {
  27639. "code": 200,
  27640. "description": "response",
  27641. "examples": [
  27642. {
  27643. "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}"
  27644. }
  27645. ]
  27646. }
  27647. ],
  27648. "renamed": null
  27649. },
  27650. {
  27651. "name": "Delete a pending review",
  27652. "scope": "pulls",
  27653. "id": "deletePendingReview",
  27654. "method": "DELETE",
  27655. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
  27656. "isDeprecated": false,
  27657. "description": "",
  27658. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#delete-a-pending-review",
  27659. "previews": [],
  27660. "headers": [],
  27661. "parameters": [
  27662. {
  27663. "name": "owner",
  27664. "description": "owner parameter",
  27665. "in": "PATH",
  27666. "type": "string",
  27667. "required": true,
  27668. "enum": null,
  27669. "allowNull": false,
  27670. "mapToData": null,
  27671. "validation": null,
  27672. "alias": null,
  27673. "deprecated": null
  27674. },
  27675. {
  27676. "name": "repo",
  27677. "description": "repo parameter",
  27678. "in": "PATH",
  27679. "type": "string",
  27680. "required": true,
  27681. "enum": null,
  27682. "allowNull": false,
  27683. "mapToData": null,
  27684. "validation": null,
  27685. "alias": null,
  27686. "deprecated": null
  27687. },
  27688. {
  27689. "name": "pull_number",
  27690. "description": "pull_number parameter",
  27691. "in": "PATH",
  27692. "type": "integer",
  27693. "required": true,
  27694. "enum": null,
  27695. "allowNull": false,
  27696. "mapToData": null,
  27697. "validation": null,
  27698. "alias": null,
  27699. "deprecated": null
  27700. },
  27701. {
  27702. "name": "review_id",
  27703. "description": "review_id parameter",
  27704. "in": "PATH",
  27705. "type": "integer",
  27706. "required": true,
  27707. "enum": null,
  27708. "allowNull": false,
  27709. "mapToData": null,
  27710. "validation": null,
  27711. "alias": null,
  27712. "deprecated": null
  27713. },
  27714. {
  27715. "name": "number",
  27716. "description": null,
  27717. "in": null,
  27718. "type": null,
  27719. "required": null,
  27720. "enum": null,
  27721. "allowNull": null,
  27722. "mapToData": null,
  27723. "validation": null,
  27724. "alias": "pull_number",
  27725. "deprecated": true
  27726. }
  27727. ],
  27728. "responses": [
  27729. {
  27730. "code": 200,
  27731. "description": "response",
  27732. "examples": [
  27733. {
  27734. "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"PENDING\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}"
  27735. }
  27736. ]
  27737. }
  27738. ],
  27739. "renamed": null
  27740. },
  27741. {
  27742. "name": "Update a pull request review",
  27743. "scope": "pulls",
  27744. "id": "updateReview",
  27745. "method": "PUT",
  27746. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}",
  27747. "isDeprecated": false,
  27748. "description": "Update the review summary comment with new text.",
  27749. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#update-a-pull-request-review",
  27750. "previews": [],
  27751. "headers": [],
  27752. "parameters": [
  27753. {
  27754. "name": "owner",
  27755. "description": "owner parameter",
  27756. "in": "PATH",
  27757. "type": "string",
  27758. "required": true,
  27759. "enum": null,
  27760. "allowNull": false,
  27761. "mapToData": null,
  27762. "validation": null,
  27763. "alias": null,
  27764. "deprecated": null
  27765. },
  27766. {
  27767. "name": "repo",
  27768. "description": "repo parameter",
  27769. "in": "PATH",
  27770. "type": "string",
  27771. "required": true,
  27772. "enum": null,
  27773. "allowNull": false,
  27774. "mapToData": null,
  27775. "validation": null,
  27776. "alias": null,
  27777. "deprecated": null
  27778. },
  27779. {
  27780. "name": "pull_number",
  27781. "description": "pull_number parameter",
  27782. "in": "PATH",
  27783. "type": "integer",
  27784. "required": true,
  27785. "enum": null,
  27786. "allowNull": false,
  27787. "mapToData": null,
  27788. "validation": null,
  27789. "alias": null,
  27790. "deprecated": null
  27791. },
  27792. {
  27793. "name": "review_id",
  27794. "description": "review_id parameter",
  27795. "in": "PATH",
  27796. "type": "integer",
  27797. "required": true,
  27798. "enum": null,
  27799. "allowNull": false,
  27800. "mapToData": null,
  27801. "validation": null,
  27802. "alias": null,
  27803. "deprecated": null
  27804. },
  27805. {
  27806. "name": "body",
  27807. "description": "The body text of the pull request review.",
  27808. "in": "BODY",
  27809. "type": "string",
  27810. "required": true,
  27811. "enum": null,
  27812. "allowNull": false,
  27813. "mapToData": null,
  27814. "validation": null,
  27815. "alias": null,
  27816. "deprecated": null
  27817. },
  27818. {
  27819. "name": "number",
  27820. "description": null,
  27821. "in": null,
  27822. "type": null,
  27823. "required": null,
  27824. "enum": null,
  27825. "allowNull": null,
  27826. "mapToData": null,
  27827. "validation": null,
  27828. "alias": "pull_number",
  27829. "deprecated": true
  27830. }
  27831. ],
  27832. "responses": [
  27833. {
  27834. "code": 200,
  27835. "description": "response",
  27836. "examples": [
  27837. {
  27838. "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change. And add more about this.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}"
  27839. }
  27840. ]
  27841. }
  27842. ],
  27843. "renamed": null
  27844. },
  27845. {
  27846. "name": "Get comments for a single review",
  27847. "scope": "pulls",
  27848. "id": "getCommentsForReview",
  27849. "method": "GET",
  27850. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments",
  27851. "isDeprecated": false,
  27852. "description": "",
  27853. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#get-comments-for-a-single-review",
  27854. "previews": [],
  27855. "headers": [],
  27856. "parameters": [
  27857. {
  27858. "name": "owner",
  27859. "description": "owner parameter",
  27860. "in": "PATH",
  27861. "type": "string",
  27862. "required": true,
  27863. "enum": null,
  27864. "allowNull": false,
  27865. "mapToData": null,
  27866. "validation": null,
  27867. "alias": null,
  27868. "deprecated": null
  27869. },
  27870. {
  27871. "name": "repo",
  27872. "description": "repo parameter",
  27873. "in": "PATH",
  27874. "type": "string",
  27875. "required": true,
  27876. "enum": null,
  27877. "allowNull": false,
  27878. "mapToData": null,
  27879. "validation": null,
  27880. "alias": null,
  27881. "deprecated": null
  27882. },
  27883. {
  27884. "name": "pull_number",
  27885. "description": "pull_number parameter",
  27886. "in": "PATH",
  27887. "type": "integer",
  27888. "required": true,
  27889. "enum": null,
  27890. "allowNull": false,
  27891. "mapToData": null,
  27892. "validation": null,
  27893. "alias": null,
  27894. "deprecated": null
  27895. },
  27896. {
  27897. "name": "review_id",
  27898. "description": "review_id parameter",
  27899. "in": "PATH",
  27900. "type": "integer",
  27901. "required": true,
  27902. "enum": null,
  27903. "allowNull": false,
  27904. "mapToData": null,
  27905. "validation": null,
  27906. "alias": null,
  27907. "deprecated": null
  27908. },
  27909. {
  27910. "name": "per_page",
  27911. "description": "Results per page (max 100)",
  27912. "in": "QUERY",
  27913. "type": "integer",
  27914. "required": false,
  27915. "enum": null,
  27916. "allowNull": false,
  27917. "mapToData": null,
  27918. "validation": null,
  27919. "alias": null,
  27920. "deprecated": null
  27921. },
  27922. {
  27923. "name": "page",
  27924. "description": "Page number of the results to fetch.",
  27925. "in": "QUERY",
  27926. "type": "integer",
  27927. "required": false,
  27928. "enum": null,
  27929. "allowNull": false,
  27930. "mapToData": null,
  27931. "validation": null,
  27932. "alias": null,
  27933. "deprecated": null
  27934. },
  27935. {
  27936. "name": "number",
  27937. "description": null,
  27938. "in": null,
  27939. "type": null,
  27940. "required": null,
  27941. "enum": null,
  27942. "allowNull": null,
  27943. "mapToData": null,
  27944. "validation": null,
  27945. "alias": "pull_number",
  27946. "deprecated": true
  27947. }
  27948. ],
  27949. "responses": [
  27950. {
  27951. "code": 200,
  27952. "description": "response",
  27953. "examples": [
  27954. {
  27955. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]"
  27956. }
  27957. ]
  27958. }
  27959. ],
  27960. "renamed": null
  27961. },
  27962. {
  27963. "name": "Dismiss a pull request review",
  27964. "scope": "pulls",
  27965. "id": "dismissReview",
  27966. "method": "PUT",
  27967. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals",
  27968. "isDeprecated": false,
  27969. "description": "**Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/enterprise/2.17/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.",
  27970. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#dismiss-a-pull-request-review",
  27971. "previews": [],
  27972. "headers": [],
  27973. "parameters": [
  27974. {
  27975. "name": "owner",
  27976. "description": "owner parameter",
  27977. "in": "PATH",
  27978. "type": "string",
  27979. "required": true,
  27980. "enum": null,
  27981. "allowNull": false,
  27982. "mapToData": null,
  27983. "validation": null,
  27984. "alias": null,
  27985. "deprecated": null
  27986. },
  27987. {
  27988. "name": "repo",
  27989. "description": "repo parameter",
  27990. "in": "PATH",
  27991. "type": "string",
  27992. "required": true,
  27993. "enum": null,
  27994. "allowNull": false,
  27995. "mapToData": null,
  27996. "validation": null,
  27997. "alias": null,
  27998. "deprecated": null
  27999. },
  28000. {
  28001. "name": "pull_number",
  28002. "description": "pull_number parameter",
  28003. "in": "PATH",
  28004. "type": "integer",
  28005. "required": true,
  28006. "enum": null,
  28007. "allowNull": false,
  28008. "mapToData": null,
  28009. "validation": null,
  28010. "alias": null,
  28011. "deprecated": null
  28012. },
  28013. {
  28014. "name": "review_id",
  28015. "description": "review_id parameter",
  28016. "in": "PATH",
  28017. "type": "integer",
  28018. "required": true,
  28019. "enum": null,
  28020. "allowNull": false,
  28021. "mapToData": null,
  28022. "validation": null,
  28023. "alias": null,
  28024. "deprecated": null
  28025. },
  28026. {
  28027. "name": "message",
  28028. "description": "The message for the pull request review dismissal",
  28029. "in": "BODY",
  28030. "type": "string",
  28031. "required": true,
  28032. "enum": null,
  28033. "allowNull": false,
  28034. "mapToData": null,
  28035. "validation": null,
  28036. "alias": null,
  28037. "deprecated": null
  28038. },
  28039. {
  28040. "name": "number",
  28041. "description": null,
  28042. "in": null,
  28043. "type": null,
  28044. "required": null,
  28045. "enum": null,
  28046. "allowNull": null,
  28047. "mapToData": null,
  28048. "validation": null,
  28049. "alias": "pull_number",
  28050. "deprecated": true
  28051. }
  28052. ],
  28053. "responses": [
  28054. {
  28055. "code": 200,
  28056. "description": "response",
  28057. "examples": [
  28058. {
  28059. "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"DISMISSED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}"
  28060. }
  28061. ]
  28062. }
  28063. ],
  28064. "renamed": null
  28065. },
  28066. {
  28067. "name": "Submit a pull request review",
  28068. "scope": "pulls",
  28069. "id": "submitReview",
  28070. "method": "POST",
  28071. "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events",
  28072. "isDeprecated": false,
  28073. "description": "",
  28074. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/pulls/reviews/#submit-a-pull-request-review",
  28075. "previews": [],
  28076. "headers": [],
  28077. "parameters": [
  28078. {
  28079. "name": "owner",
  28080. "description": "owner parameter",
  28081. "in": "PATH",
  28082. "type": "string",
  28083. "required": true,
  28084. "enum": null,
  28085. "allowNull": false,
  28086. "mapToData": null,
  28087. "validation": null,
  28088. "alias": null,
  28089. "deprecated": null
  28090. },
  28091. {
  28092. "name": "repo",
  28093. "description": "repo parameter",
  28094. "in": "PATH",
  28095. "type": "string",
  28096. "required": true,
  28097. "enum": null,
  28098. "allowNull": false,
  28099. "mapToData": null,
  28100. "validation": null,
  28101. "alias": null,
  28102. "deprecated": null
  28103. },
  28104. {
  28105. "name": "pull_number",
  28106. "description": "pull_number parameter",
  28107. "in": "PATH",
  28108. "type": "integer",
  28109. "required": true,
  28110. "enum": null,
  28111. "allowNull": false,
  28112. "mapToData": null,
  28113. "validation": null,
  28114. "alias": null,
  28115. "deprecated": null
  28116. },
  28117. {
  28118. "name": "review_id",
  28119. "description": "review_id parameter",
  28120. "in": "PATH",
  28121. "type": "integer",
  28122. "required": true,
  28123. "enum": null,
  28124. "allowNull": false,
  28125. "mapToData": null,
  28126. "validation": null,
  28127. "alias": null,
  28128. "deprecated": null
  28129. },
  28130. {
  28131. "name": "body",
  28132. "description": "The body text of the pull request review",
  28133. "in": "BODY",
  28134. "type": "string",
  28135. "required": false,
  28136. "enum": null,
  28137. "allowNull": false,
  28138. "mapToData": null,
  28139. "validation": null,
  28140. "alias": null,
  28141. "deprecated": null
  28142. },
  28143. {
  28144. "name": "event",
  28145. "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.",
  28146. "in": "BODY",
  28147. "type": "string",
  28148. "required": true,
  28149. "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"],
  28150. "allowNull": false,
  28151. "mapToData": null,
  28152. "validation": null,
  28153. "alias": null,
  28154. "deprecated": null
  28155. },
  28156. {
  28157. "name": "number",
  28158. "description": null,
  28159. "in": null,
  28160. "type": null,
  28161. "required": null,
  28162. "enum": null,
  28163. "allowNull": null,
  28164. "mapToData": null,
  28165. "validation": null,
  28166. "alias": "pull_number",
  28167. "deprecated": true
  28168. }
  28169. ],
  28170. "responses": [
  28171. {
  28172. "code": 200,
  28173. "description": "response",
  28174. "examples": [
  28175. {
  28176. "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}"
  28177. }
  28178. ]
  28179. }
  28180. ],
  28181. "renamed": null
  28182. },
  28183. {
  28184. "name": "Get the README",
  28185. "scope": "repos",
  28186. "id": "getReadme",
  28187. "method": "GET",
  28188. "url": "/repos/{owner}/{repo}/readme",
  28189. "isDeprecated": false,
  28190. "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://developer.github.com/enterprise/2.17/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML.",
  28191. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#get-the-readme",
  28192. "previews": [],
  28193. "headers": [],
  28194. "parameters": [
  28195. {
  28196. "name": "owner",
  28197. "description": "owner parameter",
  28198. "in": "PATH",
  28199. "type": "string",
  28200. "required": true,
  28201. "enum": null,
  28202. "allowNull": false,
  28203. "mapToData": null,
  28204. "validation": null,
  28205. "alias": null,
  28206. "deprecated": null
  28207. },
  28208. {
  28209. "name": "repo",
  28210. "description": "repo parameter",
  28211. "in": "PATH",
  28212. "type": "string",
  28213. "required": true,
  28214. "enum": null,
  28215. "allowNull": false,
  28216. "mapToData": null,
  28217. "validation": null,
  28218. "alias": null,
  28219. "deprecated": null
  28220. },
  28221. {
  28222. "name": "ref",
  28223. "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)",
  28224. "in": "QUERY",
  28225. "type": "string",
  28226. "required": false,
  28227. "enum": null,
  28228. "allowNull": false,
  28229. "mapToData": null,
  28230. "validation": null,
  28231. "alias": null,
  28232. "deprecated": null
  28233. }
  28234. ],
  28235. "responses": [
  28236. {
  28237. "code": 200,
  28238. "description": "response",
  28239. "examples": [
  28240. {
  28241. "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}"
  28242. }
  28243. ]
  28244. }
  28245. ],
  28246. "renamed": null
  28247. },
  28248. {
  28249. "name": "List releases for a repository",
  28250. "scope": "repos",
  28251. "id": "listReleases",
  28252. "method": "GET",
  28253. "url": "/repos/{owner}/{repo}/releases",
  28254. "isDeprecated": false,
  28255. "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://developer.github.com/enterprise/2.17/v3/repos/#list-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.",
  28256. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#list-releases-for-a-repository",
  28257. "previews": [],
  28258. "headers": [],
  28259. "parameters": [
  28260. {
  28261. "name": "owner",
  28262. "description": "owner parameter",
  28263. "in": "PATH",
  28264. "type": "string",
  28265. "required": true,
  28266. "enum": null,
  28267. "allowNull": false,
  28268. "mapToData": null,
  28269. "validation": null,
  28270. "alias": null,
  28271. "deprecated": null
  28272. },
  28273. {
  28274. "name": "repo",
  28275. "description": "repo parameter",
  28276. "in": "PATH",
  28277. "type": "string",
  28278. "required": true,
  28279. "enum": null,
  28280. "allowNull": false,
  28281. "mapToData": null,
  28282. "validation": null,
  28283. "alias": null,
  28284. "deprecated": null
  28285. },
  28286. {
  28287. "name": "per_page",
  28288. "description": "Results per page (max 100)",
  28289. "in": "QUERY",
  28290. "type": "integer",
  28291. "required": false,
  28292. "enum": null,
  28293. "allowNull": false,
  28294. "mapToData": null,
  28295. "validation": null,
  28296. "alias": null,
  28297. "deprecated": null
  28298. },
  28299. {
  28300. "name": "page",
  28301. "description": "Page number of the results to fetch.",
  28302. "in": "QUERY",
  28303. "type": "integer",
  28304. "required": false,
  28305. "enum": null,
  28306. "allowNull": false,
  28307. "mapToData": null,
  28308. "validation": null,
  28309. "alias": null,
  28310. "deprecated": null
  28311. }
  28312. ],
  28313. "responses": [
  28314. {
  28315. "code": 200,
  28316. "description": "response",
  28317. "examples": [
  28318. {
  28319. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}]"
  28320. }
  28321. ]
  28322. }
  28323. ],
  28324. "renamed": null
  28325. },
  28326. {
  28327. "name": "Create a release",
  28328. "scope": "repos",
  28329. "id": "createRelease",
  28330. "method": "POST",
  28331. "url": "/repos/{owner}/{repo}/releases",
  28332. "isDeprecated": false,
  28333. "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  28334. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#create-a-release",
  28335. "previews": [],
  28336. "headers": [],
  28337. "parameters": [
  28338. {
  28339. "name": "owner",
  28340. "description": "owner parameter",
  28341. "in": "PATH",
  28342. "type": "string",
  28343. "required": true,
  28344. "enum": null,
  28345. "allowNull": false,
  28346. "mapToData": null,
  28347. "validation": null,
  28348. "alias": null,
  28349. "deprecated": null
  28350. },
  28351. {
  28352. "name": "repo",
  28353. "description": "repo parameter",
  28354. "in": "PATH",
  28355. "type": "string",
  28356. "required": true,
  28357. "enum": null,
  28358. "allowNull": false,
  28359. "mapToData": null,
  28360. "validation": null,
  28361. "alias": null,
  28362. "deprecated": null
  28363. },
  28364. {
  28365. "name": "tag_name",
  28366. "description": "The name of the tag.",
  28367. "in": "BODY",
  28368. "type": "string",
  28369. "required": true,
  28370. "enum": null,
  28371. "allowNull": false,
  28372. "mapToData": null,
  28373. "validation": null,
  28374. "alias": null,
  28375. "deprecated": null
  28376. },
  28377. {
  28378. "name": "target_commitish",
  28379. "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).",
  28380. "in": "BODY",
  28381. "type": "string",
  28382. "required": false,
  28383. "enum": null,
  28384. "allowNull": false,
  28385. "mapToData": null,
  28386. "validation": null,
  28387. "alias": null,
  28388. "deprecated": null
  28389. },
  28390. {
  28391. "name": "name",
  28392. "description": "The name of the release.",
  28393. "in": "BODY",
  28394. "type": "string",
  28395. "required": false,
  28396. "enum": null,
  28397. "allowNull": false,
  28398. "mapToData": null,
  28399. "validation": null,
  28400. "alias": null,
  28401. "deprecated": null
  28402. },
  28403. {
  28404. "name": "body",
  28405. "description": "Text describing the contents of the tag.",
  28406. "in": "BODY",
  28407. "type": "string",
  28408. "required": false,
  28409. "enum": null,
  28410. "allowNull": false,
  28411. "mapToData": null,
  28412. "validation": null,
  28413. "alias": null,
  28414. "deprecated": null
  28415. },
  28416. {
  28417. "name": "draft",
  28418. "description": "`true` to create a draft (unpublished) release, `false` to create a published one.",
  28419. "in": "BODY",
  28420. "type": "boolean",
  28421. "required": false,
  28422. "enum": null,
  28423. "allowNull": false,
  28424. "mapToData": null,
  28425. "validation": null,
  28426. "alias": null,
  28427. "deprecated": null
  28428. },
  28429. {
  28430. "name": "prerelease",
  28431. "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.",
  28432. "in": "BODY",
  28433. "type": "boolean",
  28434. "required": false,
  28435. "enum": null,
  28436. "allowNull": false,
  28437. "mapToData": null,
  28438. "validation": null,
  28439. "alias": null,
  28440. "deprecated": null
  28441. }
  28442. ],
  28443. "responses": [
  28444. {
  28445. "code": 201,
  28446. "description": "response",
  28447. "examples": [
  28448. {
  28449. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[]}"
  28450. }
  28451. ]
  28452. }
  28453. ],
  28454. "renamed": null
  28455. },
  28456. {
  28457. "name": "Get a single release asset",
  28458. "scope": "repos",
  28459. "id": "getReleaseAsset",
  28460. "method": "GET",
  28461. "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
  28462. "isDeprecated": false,
  28463. "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/enterprise/2.17/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
  28464. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#get-a-single-release-asset",
  28465. "previews": [],
  28466. "headers": [],
  28467. "parameters": [
  28468. {
  28469. "name": "owner",
  28470. "description": "owner parameter",
  28471. "in": "PATH",
  28472. "type": "string",
  28473. "required": true,
  28474. "enum": null,
  28475. "allowNull": false,
  28476. "mapToData": null,
  28477. "validation": null,
  28478. "alias": null,
  28479. "deprecated": null
  28480. },
  28481. {
  28482. "name": "repo",
  28483. "description": "repo parameter",
  28484. "in": "PATH",
  28485. "type": "string",
  28486. "required": true,
  28487. "enum": null,
  28488. "allowNull": false,
  28489. "mapToData": null,
  28490. "validation": null,
  28491. "alias": null,
  28492. "deprecated": null
  28493. },
  28494. {
  28495. "name": "asset_id",
  28496. "description": "asset_id parameter",
  28497. "in": "PATH",
  28498. "type": "integer",
  28499. "required": true,
  28500. "enum": null,
  28501. "allowNull": false,
  28502. "mapToData": null,
  28503. "validation": null,
  28504. "alias": null,
  28505. "deprecated": null
  28506. }
  28507. ],
  28508. "responses": [
  28509. {
  28510. "code": 200,
  28511. "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/enterprise/2.17/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.",
  28512. "examples": [
  28513. {
  28514. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  28515. }
  28516. ]
  28517. }
  28518. ],
  28519. "renamed": null
  28520. },
  28521. {
  28522. "name": "Edit a release asset",
  28523. "scope": "repos",
  28524. "id": "updateReleaseAsset",
  28525. "method": "PATCH",
  28526. "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
  28527. "isDeprecated": false,
  28528. "description": "Users with push access to the repository can edit a release asset.",
  28529. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#edit-a-release-asset",
  28530. "previews": [],
  28531. "headers": [],
  28532. "parameters": [
  28533. {
  28534. "name": "owner",
  28535. "description": "owner parameter",
  28536. "in": "PATH",
  28537. "type": "string",
  28538. "required": true,
  28539. "enum": null,
  28540. "allowNull": false,
  28541. "mapToData": null,
  28542. "validation": null,
  28543. "alias": null,
  28544. "deprecated": null
  28545. },
  28546. {
  28547. "name": "repo",
  28548. "description": "repo parameter",
  28549. "in": "PATH",
  28550. "type": "string",
  28551. "required": true,
  28552. "enum": null,
  28553. "allowNull": false,
  28554. "mapToData": null,
  28555. "validation": null,
  28556. "alias": null,
  28557. "deprecated": null
  28558. },
  28559. {
  28560. "name": "asset_id",
  28561. "description": "asset_id parameter",
  28562. "in": "PATH",
  28563. "type": "integer",
  28564. "required": true,
  28565. "enum": null,
  28566. "allowNull": false,
  28567. "mapToData": null,
  28568. "validation": null,
  28569. "alias": null,
  28570. "deprecated": null
  28571. },
  28572. {
  28573. "name": "name",
  28574. "description": "The file name of the asset.",
  28575. "in": "BODY",
  28576. "type": "string",
  28577. "required": false,
  28578. "enum": null,
  28579. "allowNull": false,
  28580. "mapToData": null,
  28581. "validation": null,
  28582. "alias": null,
  28583. "deprecated": null
  28584. },
  28585. {
  28586. "name": "label",
  28587. "description": "An alternate short description of the asset. Used in place of the filename.",
  28588. "in": "BODY",
  28589. "type": "string",
  28590. "required": false,
  28591. "enum": null,
  28592. "allowNull": false,
  28593. "mapToData": null,
  28594. "validation": null,
  28595. "alias": null,
  28596. "deprecated": null
  28597. }
  28598. ],
  28599. "responses": [
  28600. {
  28601. "code": 200,
  28602. "description": "response",
  28603. "examples": [
  28604. {
  28605. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  28606. }
  28607. ]
  28608. }
  28609. ],
  28610. "renamed": null
  28611. },
  28612. {
  28613. "name": "Delete a release asset",
  28614. "scope": "repos",
  28615. "id": "deleteReleaseAsset",
  28616. "method": "DELETE",
  28617. "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}",
  28618. "isDeprecated": false,
  28619. "description": "",
  28620. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#delete-a-release-asset",
  28621. "previews": [],
  28622. "headers": [],
  28623. "parameters": [
  28624. {
  28625. "name": "owner",
  28626. "description": "owner parameter",
  28627. "in": "PATH",
  28628. "type": "string",
  28629. "required": true,
  28630. "enum": null,
  28631. "allowNull": false,
  28632. "mapToData": null,
  28633. "validation": null,
  28634. "alias": null,
  28635. "deprecated": null
  28636. },
  28637. {
  28638. "name": "repo",
  28639. "description": "repo parameter",
  28640. "in": "PATH",
  28641. "type": "string",
  28642. "required": true,
  28643. "enum": null,
  28644. "allowNull": false,
  28645. "mapToData": null,
  28646. "validation": null,
  28647. "alias": null,
  28648. "deprecated": null
  28649. },
  28650. {
  28651. "name": "asset_id",
  28652. "description": "asset_id parameter",
  28653. "in": "PATH",
  28654. "type": "integer",
  28655. "required": true,
  28656. "enum": null,
  28657. "allowNull": false,
  28658. "mapToData": null,
  28659. "validation": null,
  28660. "alias": null,
  28661. "deprecated": null
  28662. }
  28663. ],
  28664. "responses": [],
  28665. "renamed": null
  28666. },
  28667. {
  28668. "name": "Get the latest release",
  28669. "scope": "repos",
  28670. "id": "getLatestRelease",
  28671. "method": "GET",
  28672. "url": "/repos/{owner}/{repo}/releases/latest",
  28673. "isDeprecated": false,
  28674. "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.",
  28675. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#get-the-latest-release",
  28676. "previews": [],
  28677. "headers": [],
  28678. "parameters": [
  28679. {
  28680. "name": "owner",
  28681. "description": "owner parameter",
  28682. "in": "PATH",
  28683. "type": "string",
  28684. "required": true,
  28685. "enum": null,
  28686. "allowNull": false,
  28687. "mapToData": null,
  28688. "validation": null,
  28689. "alias": null,
  28690. "deprecated": null
  28691. },
  28692. {
  28693. "name": "repo",
  28694. "description": "repo parameter",
  28695. "in": "PATH",
  28696. "type": "string",
  28697. "required": true,
  28698. "enum": null,
  28699. "allowNull": false,
  28700. "mapToData": null,
  28701. "validation": null,
  28702. "alias": null,
  28703. "deprecated": null
  28704. }
  28705. ],
  28706. "responses": [
  28707. {
  28708. "code": 200,
  28709. "description": "response",
  28710. "examples": [
  28711. {
  28712. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}"
  28713. }
  28714. ]
  28715. }
  28716. ],
  28717. "renamed": null
  28718. },
  28719. {
  28720. "name": "Get a release by tag name",
  28721. "scope": "repos",
  28722. "id": "getReleaseByTag",
  28723. "method": "GET",
  28724. "url": "/repos/{owner}/{repo}/releases/tags/{tag}",
  28725. "isDeprecated": false,
  28726. "description": "Get a published release with the specified tag.",
  28727. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#get-a-release-by-tag-name",
  28728. "previews": [],
  28729. "headers": [],
  28730. "parameters": [
  28731. {
  28732. "name": "owner",
  28733. "description": "owner parameter",
  28734. "in": "PATH",
  28735. "type": "string",
  28736. "required": true,
  28737. "enum": null,
  28738. "allowNull": false,
  28739. "mapToData": null,
  28740. "validation": null,
  28741. "alias": null,
  28742. "deprecated": null
  28743. },
  28744. {
  28745. "name": "repo",
  28746. "description": "repo parameter",
  28747. "in": "PATH",
  28748. "type": "string",
  28749. "required": true,
  28750. "enum": null,
  28751. "allowNull": false,
  28752. "mapToData": null,
  28753. "validation": null,
  28754. "alias": null,
  28755. "deprecated": null
  28756. },
  28757. {
  28758. "name": "tag",
  28759. "description": "tag parameter",
  28760. "in": "PATH",
  28761. "type": "string",
  28762. "required": true,
  28763. "enum": null,
  28764. "allowNull": false,
  28765. "mapToData": null,
  28766. "validation": null,
  28767. "alias": null,
  28768. "deprecated": null
  28769. }
  28770. ],
  28771. "responses": [
  28772. {
  28773. "code": 200,
  28774. "description": "response",
  28775. "examples": [
  28776. {
  28777. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}"
  28778. }
  28779. ]
  28780. }
  28781. ],
  28782. "renamed": null
  28783. },
  28784. {
  28785. "name": "Get a single release",
  28786. "scope": "repos",
  28787. "id": "getRelease",
  28788. "method": "GET",
  28789. "url": "/repos/{owner}/{repo}/releases/{release_id}",
  28790. "isDeprecated": false,
  28791. "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/enterprise/2.17/v3/#hypermedia).",
  28792. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#get-a-single-release",
  28793. "previews": [],
  28794. "headers": [],
  28795. "parameters": [
  28796. {
  28797. "name": "owner",
  28798. "description": "owner parameter",
  28799. "in": "PATH",
  28800. "type": "string",
  28801. "required": true,
  28802. "enum": null,
  28803. "allowNull": false,
  28804. "mapToData": null,
  28805. "validation": null,
  28806. "alias": null,
  28807. "deprecated": null
  28808. },
  28809. {
  28810. "name": "repo",
  28811. "description": "repo parameter",
  28812. "in": "PATH",
  28813. "type": "string",
  28814. "required": true,
  28815. "enum": null,
  28816. "allowNull": false,
  28817. "mapToData": null,
  28818. "validation": null,
  28819. "alias": null,
  28820. "deprecated": null
  28821. },
  28822. {
  28823. "name": "release_id",
  28824. "description": "release_id parameter",
  28825. "in": "PATH",
  28826. "type": "integer",
  28827. "required": true,
  28828. "enum": null,
  28829. "allowNull": false,
  28830. "mapToData": null,
  28831. "validation": null,
  28832. "alias": null,
  28833. "deprecated": null
  28834. }
  28835. ],
  28836. "responses": [
  28837. {
  28838. "code": 200,
  28839. "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/enterprise/2.17/v3/#hypermedia).",
  28840. "examples": [
  28841. {
  28842. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}"
  28843. }
  28844. ]
  28845. }
  28846. ],
  28847. "renamed": null
  28848. },
  28849. {
  28850. "name": "Edit a release",
  28851. "scope": "repos",
  28852. "id": "updateRelease",
  28853. "method": "PATCH",
  28854. "url": "/repos/{owner}/{repo}/releases/{release_id}",
  28855. "isDeprecated": false,
  28856. "description": "Users with push access to the repository can edit a release.",
  28857. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#edit-a-release",
  28858. "previews": [],
  28859. "headers": [],
  28860. "parameters": [
  28861. {
  28862. "name": "owner",
  28863. "description": "owner parameter",
  28864. "in": "PATH",
  28865. "type": "string",
  28866. "required": true,
  28867. "enum": null,
  28868. "allowNull": false,
  28869. "mapToData": null,
  28870. "validation": null,
  28871. "alias": null,
  28872. "deprecated": null
  28873. },
  28874. {
  28875. "name": "repo",
  28876. "description": "repo parameter",
  28877. "in": "PATH",
  28878. "type": "string",
  28879. "required": true,
  28880. "enum": null,
  28881. "allowNull": false,
  28882. "mapToData": null,
  28883. "validation": null,
  28884. "alias": null,
  28885. "deprecated": null
  28886. },
  28887. {
  28888. "name": "release_id",
  28889. "description": "release_id parameter",
  28890. "in": "PATH",
  28891. "type": "integer",
  28892. "required": true,
  28893. "enum": null,
  28894. "allowNull": false,
  28895. "mapToData": null,
  28896. "validation": null,
  28897. "alias": null,
  28898. "deprecated": null
  28899. },
  28900. {
  28901. "name": "tag_name",
  28902. "description": "The name of the tag.",
  28903. "in": "BODY",
  28904. "type": "string",
  28905. "required": false,
  28906. "enum": null,
  28907. "allowNull": false,
  28908. "mapToData": null,
  28909. "validation": null,
  28910. "alias": null,
  28911. "deprecated": null
  28912. },
  28913. {
  28914. "name": "target_commitish",
  28915. "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).",
  28916. "in": "BODY",
  28917. "type": "string",
  28918. "required": false,
  28919. "enum": null,
  28920. "allowNull": false,
  28921. "mapToData": null,
  28922. "validation": null,
  28923. "alias": null,
  28924. "deprecated": null
  28925. },
  28926. {
  28927. "name": "name",
  28928. "description": "The name of the release.",
  28929. "in": "BODY",
  28930. "type": "string",
  28931. "required": false,
  28932. "enum": null,
  28933. "allowNull": false,
  28934. "mapToData": null,
  28935. "validation": null,
  28936. "alias": null,
  28937. "deprecated": null
  28938. },
  28939. {
  28940. "name": "body",
  28941. "description": "Text describing the contents of the tag.",
  28942. "in": "BODY",
  28943. "type": "string",
  28944. "required": false,
  28945. "enum": null,
  28946. "allowNull": false,
  28947. "mapToData": null,
  28948. "validation": null,
  28949. "alias": null,
  28950. "deprecated": null
  28951. },
  28952. {
  28953. "name": "draft",
  28954. "description": "`true` makes the release a draft, and `false` publishes the release.",
  28955. "in": "BODY",
  28956. "type": "boolean",
  28957. "required": false,
  28958. "enum": null,
  28959. "allowNull": false,
  28960. "mapToData": null,
  28961. "validation": null,
  28962. "alias": null,
  28963. "deprecated": null
  28964. },
  28965. {
  28966. "name": "prerelease",
  28967. "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.",
  28968. "in": "BODY",
  28969. "type": "boolean",
  28970. "required": false,
  28971. "enum": null,
  28972. "allowNull": false,
  28973. "mapToData": null,
  28974. "validation": null,
  28975. "alias": null,
  28976. "deprecated": null
  28977. }
  28978. ],
  28979. "responses": [
  28980. {
  28981. "code": 200,
  28982. "description": "response",
  28983. "examples": [
  28984. {
  28985. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}"
  28986. }
  28987. ]
  28988. }
  28989. ],
  28990. "renamed": null
  28991. },
  28992. {
  28993. "name": "Delete a release",
  28994. "scope": "repos",
  28995. "id": "deleteRelease",
  28996. "method": "DELETE",
  28997. "url": "/repos/{owner}/{repo}/releases/{release_id}",
  28998. "isDeprecated": false,
  28999. "description": "Users with push access to the repository can delete a release.",
  29000. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#delete-a-release",
  29001. "previews": [],
  29002. "headers": [],
  29003. "parameters": [
  29004. {
  29005. "name": "owner",
  29006. "description": "owner parameter",
  29007. "in": "PATH",
  29008. "type": "string",
  29009. "required": true,
  29010. "enum": null,
  29011. "allowNull": false,
  29012. "mapToData": null,
  29013. "validation": null,
  29014. "alias": null,
  29015. "deprecated": null
  29016. },
  29017. {
  29018. "name": "repo",
  29019. "description": "repo parameter",
  29020. "in": "PATH",
  29021. "type": "string",
  29022. "required": true,
  29023. "enum": null,
  29024. "allowNull": false,
  29025. "mapToData": null,
  29026. "validation": null,
  29027. "alias": null,
  29028. "deprecated": null
  29029. },
  29030. {
  29031. "name": "release_id",
  29032. "description": "release_id parameter",
  29033. "in": "PATH",
  29034. "type": "integer",
  29035. "required": true,
  29036. "enum": null,
  29037. "allowNull": false,
  29038. "mapToData": null,
  29039. "validation": null,
  29040. "alias": null,
  29041. "deprecated": null
  29042. }
  29043. ],
  29044. "responses": [],
  29045. "renamed": null
  29046. },
  29047. {
  29048. "name": "List assets for a release",
  29049. "scope": "repos",
  29050. "id": "listAssetsForRelease",
  29051. "method": "GET",
  29052. "url": "/repos/{owner}/{repo}/releases/{release_id}/assets",
  29053. "isDeprecated": false,
  29054. "description": "",
  29055. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/releases/#list-assets-for-a-release",
  29056. "previews": [],
  29057. "headers": [],
  29058. "parameters": [
  29059. {
  29060. "name": "owner",
  29061. "description": "owner parameter",
  29062. "in": "PATH",
  29063. "type": "string",
  29064. "required": true,
  29065. "enum": null,
  29066. "allowNull": false,
  29067. "mapToData": null,
  29068. "validation": null,
  29069. "alias": null,
  29070. "deprecated": null
  29071. },
  29072. {
  29073. "name": "repo",
  29074. "description": "repo parameter",
  29075. "in": "PATH",
  29076. "type": "string",
  29077. "required": true,
  29078. "enum": null,
  29079. "allowNull": false,
  29080. "mapToData": null,
  29081. "validation": null,
  29082. "alias": null,
  29083. "deprecated": null
  29084. },
  29085. {
  29086. "name": "release_id",
  29087. "description": "release_id parameter",
  29088. "in": "PATH",
  29089. "type": "integer",
  29090. "required": true,
  29091. "enum": null,
  29092. "allowNull": false,
  29093. "mapToData": null,
  29094. "validation": null,
  29095. "alias": null,
  29096. "deprecated": null
  29097. },
  29098. {
  29099. "name": "per_page",
  29100. "description": "Results per page (max 100)",
  29101. "in": "QUERY",
  29102. "type": "integer",
  29103. "required": false,
  29104. "enum": null,
  29105. "allowNull": false,
  29106. "mapToData": null,
  29107. "validation": null,
  29108. "alias": null,
  29109. "deprecated": null
  29110. },
  29111. {
  29112. "name": "page",
  29113. "description": "Page number of the results to fetch.",
  29114. "in": "QUERY",
  29115. "type": "integer",
  29116. "required": false,
  29117. "enum": null,
  29118. "allowNull": false,
  29119. "mapToData": null,
  29120. "validation": null,
  29121. "alias": null,
  29122. "deprecated": null
  29123. }
  29124. ],
  29125. "responses": [
  29126. {
  29127. "code": 200,
  29128. "description": "response",
  29129. "examples": [
  29130. {
  29131. "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]"
  29132. }
  29133. ]
  29134. }
  29135. ],
  29136. "renamed": null
  29137. },
  29138. {
  29139. "name": "List Stargazers",
  29140. "scope": "activity",
  29141. "id": "listStargazersForRepo",
  29142. "method": "GET",
  29143. "url": "/repos/{owner}/{repo}/stargazers",
  29144. "isDeprecated": false,
  29145. "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/enterprise/2.17/v3/media/) via the `Accept` header:",
  29146. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/starring/#list-stargazers",
  29147. "previews": [],
  29148. "headers": [],
  29149. "parameters": [
  29150. {
  29151. "name": "owner",
  29152. "description": "owner parameter",
  29153. "in": "PATH",
  29154. "type": "string",
  29155. "required": true,
  29156. "enum": null,
  29157. "allowNull": false,
  29158. "mapToData": null,
  29159. "validation": null,
  29160. "alias": null,
  29161. "deprecated": null
  29162. },
  29163. {
  29164. "name": "repo",
  29165. "description": "repo parameter",
  29166. "in": "PATH",
  29167. "type": "string",
  29168. "required": true,
  29169. "enum": null,
  29170. "allowNull": false,
  29171. "mapToData": null,
  29172. "validation": null,
  29173. "alias": null,
  29174. "deprecated": null
  29175. },
  29176. {
  29177. "name": "per_page",
  29178. "description": "Results per page (max 100)",
  29179. "in": "QUERY",
  29180. "type": "integer",
  29181. "required": false,
  29182. "enum": null,
  29183. "allowNull": false,
  29184. "mapToData": null,
  29185. "validation": null,
  29186. "alias": null,
  29187. "deprecated": null
  29188. },
  29189. {
  29190. "name": "page",
  29191. "description": "Page number of the results to fetch.",
  29192. "in": "QUERY",
  29193. "type": "integer",
  29194. "required": false,
  29195. "enum": null,
  29196. "allowNull": false,
  29197. "mapToData": null,
  29198. "validation": null,
  29199. "alias": null,
  29200. "deprecated": null
  29201. }
  29202. ],
  29203. "responses": [
  29204. {
  29205. "code": 200,
  29206. "description": "response",
  29207. "examples": [
  29208. {
  29209. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  29210. }
  29211. ]
  29212. },
  29213. {
  29214. "code": 200,
  29215. "description": "response",
  29216. "examples": [
  29217. {
  29218. "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]"
  29219. }
  29220. ]
  29221. }
  29222. ],
  29223. "renamed": null
  29224. },
  29225. {
  29226. "name": "Get the number of additions and deletions per week",
  29227. "scope": "repos",
  29228. "id": "getCodeFrequencyStats",
  29229. "method": "GET",
  29230. "url": "/repos/{owner}/{repo}/stats/code_frequency",
  29231. "isDeprecated": false,
  29232. "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n",
  29233. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week",
  29234. "previews": [],
  29235. "headers": [],
  29236. "parameters": [
  29237. {
  29238. "name": "owner",
  29239. "description": "owner parameter",
  29240. "in": "PATH",
  29241. "type": "string",
  29242. "required": true,
  29243. "enum": null,
  29244. "allowNull": false,
  29245. "mapToData": null,
  29246. "validation": null,
  29247. "alias": null,
  29248. "deprecated": null
  29249. },
  29250. {
  29251. "name": "repo",
  29252. "description": "repo parameter",
  29253. "in": "PATH",
  29254. "type": "string",
  29255. "required": true,
  29256. "enum": null,
  29257. "allowNull": false,
  29258. "mapToData": null,
  29259. "validation": null,
  29260. "alias": null,
  29261. "deprecated": null
  29262. }
  29263. ],
  29264. "responses": [
  29265. {
  29266. "code": 200,
  29267. "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.",
  29268. "examples": [{ "data": "[[1302998400,1124,-435]]" }]
  29269. }
  29270. ],
  29271. "renamed": null
  29272. },
  29273. {
  29274. "name": "Get the last year of commit activity data",
  29275. "scope": "repos",
  29276. "id": "getCommitActivityStats",
  29277. "method": "GET",
  29278. "url": "/repos/{owner}/{repo}/stats/commit_activity",
  29279. "isDeprecated": false,
  29280. "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.\n\n",
  29281. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statistics/#get-the-last-year-of-commit-activity-data",
  29282. "previews": [],
  29283. "headers": [],
  29284. "parameters": [
  29285. {
  29286. "name": "owner",
  29287. "description": "owner parameter",
  29288. "in": "PATH",
  29289. "type": "string",
  29290. "required": true,
  29291. "enum": null,
  29292. "allowNull": false,
  29293. "mapToData": null,
  29294. "validation": null,
  29295. "alias": null,
  29296. "deprecated": null
  29297. },
  29298. {
  29299. "name": "repo",
  29300. "description": "repo parameter",
  29301. "in": "PATH",
  29302. "type": "string",
  29303. "required": true,
  29304. "enum": null,
  29305. "allowNull": false,
  29306. "mapToData": null,
  29307. "validation": null,
  29308. "alias": null,
  29309. "deprecated": null
  29310. }
  29311. ],
  29312. "responses": [
  29313. {
  29314. "code": 200,
  29315. "description": "response",
  29316. "examples": [
  29317. {
  29318. "data": "[{\"days\":[0,3,26,20,39,1,0],\"total\":89,\"week\":1336280400}]"
  29319. }
  29320. ]
  29321. }
  29322. ],
  29323. "renamed": null
  29324. },
  29325. {
  29326. "name": "Get contributors list with additions, deletions, and commit counts",
  29327. "scope": "repos",
  29328. "id": "getContributorsStats",
  29329. "method": "GET",
  29330. "url": "/repos/{owner}/{repo}/stats/contributors",
  29331. "isDeprecated": false,
  29332. "description": "* `total` - The Total number of commits authored by the contributor.\n\nWeekly Hash (`weeks` array):\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n",
  29333. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts",
  29334. "previews": [],
  29335. "headers": [],
  29336. "parameters": [
  29337. {
  29338. "name": "owner",
  29339. "description": "owner parameter",
  29340. "in": "PATH",
  29341. "type": "string",
  29342. "required": true,
  29343. "enum": null,
  29344. "allowNull": false,
  29345. "mapToData": null,
  29346. "validation": null,
  29347. "alias": null,
  29348. "deprecated": null
  29349. },
  29350. {
  29351. "name": "repo",
  29352. "description": "repo parameter",
  29353. "in": "PATH",
  29354. "type": "string",
  29355. "required": true,
  29356. "enum": null,
  29357. "allowNull": false,
  29358. "mapToData": null,
  29359. "validation": null,
  29360. "alias": null,
  29361. "deprecated": null
  29362. }
  29363. ],
  29364. "responses": [
  29365. {
  29366. "code": 200,
  29367. "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits",
  29368. "examples": [
  29369. {
  29370. "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"total\":135,\"weeks\":[{\"w\":\"1367712000\",\"a\":6898,\"d\":77,\"c\":10}]}]"
  29371. }
  29372. ]
  29373. }
  29374. ],
  29375. "renamed": null
  29376. },
  29377. {
  29378. "name": "Get the weekly commit count for the repository owner and everyone else",
  29379. "scope": "repos",
  29380. "id": "getParticipationStats",
  29381. "method": "GET",
  29382. "url": "/repos/{owner}/{repo}/stats/participation",
  29383. "isDeprecated": false,
  29384. "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.\n\n",
  29385. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else",
  29386. "previews": [],
  29387. "headers": [],
  29388. "parameters": [
  29389. {
  29390. "name": "owner",
  29391. "description": "owner parameter",
  29392. "in": "PATH",
  29393. "type": "string",
  29394. "required": true,
  29395. "enum": null,
  29396. "allowNull": false,
  29397. "mapToData": null,
  29398. "validation": null,
  29399. "alias": null,
  29400. "deprecated": null
  29401. },
  29402. {
  29403. "name": "repo",
  29404. "description": "repo parameter",
  29405. "in": "PATH",
  29406. "type": "string",
  29407. "required": true,
  29408. "enum": null,
  29409. "allowNull": false,
  29410. "mapToData": null,
  29411. "validation": null,
  29412. "alias": null,
  29413. "deprecated": null
  29414. }
  29415. ],
  29416. "responses": [
  29417. {
  29418. "code": 200,
  29419. "description": "The array order is oldest week (index 0) to most recent week.",
  29420. "examples": [
  29421. {
  29422. "data": "{\"all\":[11,21,15,2,8,1,8,23,17,21,11,10,33,91,38,34,22,23,32,3,43,87,71,18,13,5,13,16,66,27,12,45,110,117,13,8,18,9,19,26,39,12,20,31,46,91,45,10,24,9,29,7],\"owner\":[3,2,3,0,2,0,5,14,7,9,1,5,0,48,19,2,0,1,10,2,23,40,35,8,8,2,10,6,30,0,2,9,53,104,3,3,10,4,7,11,21,4,4,22,26,63,11,2,14,1,10,3]}"
  29423. }
  29424. ]
  29425. }
  29426. ],
  29427. "renamed": null
  29428. },
  29429. {
  29430. "name": "Get the number of commits per hour in each day",
  29431. "scope": "repos",
  29432. "id": "getPunchCardStats",
  29433. "method": "GET",
  29434. "url": "/repos/{owner}/{repo}/stats/punch_card",
  29435. "isDeprecated": false,
  29436. "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
  29437. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day",
  29438. "previews": [],
  29439. "headers": [],
  29440. "parameters": [
  29441. {
  29442. "name": "owner",
  29443. "description": "owner parameter",
  29444. "in": "PATH",
  29445. "type": "string",
  29446. "required": true,
  29447. "enum": null,
  29448. "allowNull": false,
  29449. "mapToData": null,
  29450. "validation": null,
  29451. "alias": null,
  29452. "deprecated": null
  29453. },
  29454. {
  29455. "name": "repo",
  29456. "description": "repo parameter",
  29457. "in": "PATH",
  29458. "type": "string",
  29459. "required": true,
  29460. "enum": null,
  29461. "allowNull": false,
  29462. "mapToData": null,
  29463. "validation": null,
  29464. "alias": null,
  29465. "deprecated": null
  29466. }
  29467. ],
  29468. "responses": [
  29469. {
  29470. "code": 200,
  29471. "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.",
  29472. "examples": [{ "data": "[[0,0,5],[0,1,43],[0,2,21]]" }]
  29473. }
  29474. ],
  29475. "renamed": null
  29476. },
  29477. {
  29478. "name": "Create a status",
  29479. "scope": "repos",
  29480. "id": "createStatus",
  29481. "method": "POST",
  29482. "url": "/repos/{owner}/{repo}/statuses/{sha}",
  29483. "isDeprecated": false,
  29484. "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.",
  29485. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/statuses/#create-a-status",
  29486. "previews": [],
  29487. "headers": [],
  29488. "parameters": [
  29489. {
  29490. "name": "owner",
  29491. "description": "owner parameter",
  29492. "in": "PATH",
  29493. "type": "string",
  29494. "required": true,
  29495. "enum": null,
  29496. "allowNull": false,
  29497. "mapToData": null,
  29498. "validation": null,
  29499. "alias": null,
  29500. "deprecated": null
  29501. },
  29502. {
  29503. "name": "repo",
  29504. "description": "repo parameter",
  29505. "in": "PATH",
  29506. "type": "string",
  29507. "required": true,
  29508. "enum": null,
  29509. "allowNull": false,
  29510. "mapToData": null,
  29511. "validation": null,
  29512. "alias": null,
  29513. "deprecated": null
  29514. },
  29515. {
  29516. "name": "sha",
  29517. "description": "sha parameter",
  29518. "in": "PATH",
  29519. "type": "string",
  29520. "required": true,
  29521. "enum": null,
  29522. "allowNull": false,
  29523. "mapToData": null,
  29524. "validation": null,
  29525. "alias": null,
  29526. "deprecated": null
  29527. },
  29528. {
  29529. "name": "state",
  29530. "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.",
  29531. "in": "BODY",
  29532. "type": "string",
  29533. "required": true,
  29534. "enum": ["error", "failure", "pending", "success"],
  29535. "allowNull": false,
  29536. "mapToData": null,
  29537. "validation": null,
  29538. "alias": null,
  29539. "deprecated": null
  29540. },
  29541. {
  29542. "name": "target_url",
  29543. "description": "The target URL to associate with this status. This URL will be linked from the GitHub Enterprise Server UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`",
  29544. "in": "BODY",
  29545. "type": "string",
  29546. "required": false,
  29547. "enum": null,
  29548. "allowNull": false,
  29549. "mapToData": null,
  29550. "validation": null,
  29551. "alias": null,
  29552. "deprecated": null
  29553. },
  29554. {
  29555. "name": "description",
  29556. "description": "A short description of the status.",
  29557. "in": "BODY",
  29558. "type": "string",
  29559. "required": false,
  29560. "enum": null,
  29561. "allowNull": false,
  29562. "mapToData": null,
  29563. "validation": null,
  29564. "alias": null,
  29565. "deprecated": null
  29566. },
  29567. {
  29568. "name": "context",
  29569. "description": "A string label to differentiate this status from the status of other systems.",
  29570. "in": "BODY",
  29571. "type": "string",
  29572. "required": false,
  29573. "enum": null,
  29574. "allowNull": false,
  29575. "mapToData": null,
  29576. "validation": null,
  29577. "alias": null,
  29578. "deprecated": null
  29579. }
  29580. ],
  29581. "responses": [
  29582. {
  29583. "code": 201,
  29584. "description": "response",
  29585. "examples": [
  29586. {
  29587. "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  29588. }
  29589. ]
  29590. }
  29591. ],
  29592. "renamed": null
  29593. },
  29594. {
  29595. "name": "List watchers",
  29596. "scope": "activity",
  29597. "id": "listWatchersForRepo",
  29598. "method": "GET",
  29599. "url": "/repos/{owner}/{repo}/subscribers",
  29600. "isDeprecated": false,
  29601. "description": "",
  29602. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/watching/#list-watchers",
  29603. "previews": [],
  29604. "headers": [],
  29605. "parameters": [
  29606. {
  29607. "name": "owner",
  29608. "description": "owner parameter",
  29609. "in": "PATH",
  29610. "type": "string",
  29611. "required": true,
  29612. "enum": null,
  29613. "allowNull": false,
  29614. "mapToData": null,
  29615. "validation": null,
  29616. "alias": null,
  29617. "deprecated": null
  29618. },
  29619. {
  29620. "name": "repo",
  29621. "description": "repo parameter",
  29622. "in": "PATH",
  29623. "type": "string",
  29624. "required": true,
  29625. "enum": null,
  29626. "allowNull": false,
  29627. "mapToData": null,
  29628. "validation": null,
  29629. "alias": null,
  29630. "deprecated": null
  29631. },
  29632. {
  29633. "name": "per_page",
  29634. "description": "Results per page (max 100)",
  29635. "in": "QUERY",
  29636. "type": "integer",
  29637. "required": false,
  29638. "enum": null,
  29639. "allowNull": false,
  29640. "mapToData": null,
  29641. "validation": null,
  29642. "alias": null,
  29643. "deprecated": null
  29644. },
  29645. {
  29646. "name": "page",
  29647. "description": "Page number of the results to fetch.",
  29648. "in": "QUERY",
  29649. "type": "integer",
  29650. "required": false,
  29651. "enum": null,
  29652. "allowNull": false,
  29653. "mapToData": null,
  29654. "validation": null,
  29655. "alias": null,
  29656. "deprecated": null
  29657. }
  29658. ],
  29659. "responses": [
  29660. {
  29661. "code": 200,
  29662. "description": "response",
  29663. "examples": [
  29664. {
  29665. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  29666. }
  29667. ]
  29668. }
  29669. ],
  29670. "renamed": null
  29671. },
  29672. {
  29673. "name": "Get a Repository Subscription",
  29674. "scope": "activity",
  29675. "id": "getRepoSubscription",
  29676. "method": "GET",
  29677. "url": "/repos/{owner}/{repo}/subscription",
  29678. "isDeprecated": false,
  29679. "description": "",
  29680. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/watching/#get-a-repository-subscription",
  29681. "previews": [],
  29682. "headers": [],
  29683. "parameters": [
  29684. {
  29685. "name": "owner",
  29686. "description": "owner parameter",
  29687. "in": "PATH",
  29688. "type": "string",
  29689. "required": true,
  29690. "enum": null,
  29691. "allowNull": false,
  29692. "mapToData": null,
  29693. "validation": null,
  29694. "alias": null,
  29695. "deprecated": null
  29696. },
  29697. {
  29698. "name": "repo",
  29699. "description": "repo parameter",
  29700. "in": "PATH",
  29701. "type": "string",
  29702. "required": true,
  29703. "enum": null,
  29704. "allowNull": false,
  29705. "mapToData": null,
  29706. "validation": null,
  29707. "alias": null,
  29708. "deprecated": null
  29709. }
  29710. ],
  29711. "responses": [
  29712. {
  29713. "code": 200,
  29714. "description": "Response if you are subscribed to the repository",
  29715. "examples": [
  29716. {
  29717. "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}"
  29718. }
  29719. ]
  29720. }
  29721. ],
  29722. "renamed": null
  29723. },
  29724. {
  29725. "name": "Set a Repository Subscription",
  29726. "scope": "activity",
  29727. "id": "setRepoSubscription",
  29728. "method": "PUT",
  29729. "url": "/repos/{owner}/{repo}/subscription",
  29730. "isDeprecated": false,
  29731. "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://developer.github.com/enterprise/2.17/v3/activity/watching/#delete-a-repository-subscription) completely.",
  29732. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/watching/#set-a-repository-subscription",
  29733. "previews": [],
  29734. "headers": [],
  29735. "parameters": [
  29736. {
  29737. "name": "owner",
  29738. "description": "owner parameter",
  29739. "in": "PATH",
  29740. "type": "string",
  29741. "required": true,
  29742. "enum": null,
  29743. "allowNull": false,
  29744. "mapToData": null,
  29745. "validation": null,
  29746. "alias": null,
  29747. "deprecated": null
  29748. },
  29749. {
  29750. "name": "repo",
  29751. "description": "repo parameter",
  29752. "in": "PATH",
  29753. "type": "string",
  29754. "required": true,
  29755. "enum": null,
  29756. "allowNull": false,
  29757. "mapToData": null,
  29758. "validation": null,
  29759. "alias": null,
  29760. "deprecated": null
  29761. },
  29762. {
  29763. "name": "subscribed",
  29764. "description": "Determines if notifications should be received from this repository.",
  29765. "in": "BODY",
  29766. "type": "boolean",
  29767. "required": false,
  29768. "enum": null,
  29769. "allowNull": false,
  29770. "mapToData": null,
  29771. "validation": null,
  29772. "alias": null,
  29773. "deprecated": null
  29774. },
  29775. {
  29776. "name": "ignored",
  29777. "description": "Determines if all notifications should be blocked from this repository.",
  29778. "in": "BODY",
  29779. "type": "boolean",
  29780. "required": false,
  29781. "enum": null,
  29782. "allowNull": false,
  29783. "mapToData": null,
  29784. "validation": null,
  29785. "alias": null,
  29786. "deprecated": null
  29787. }
  29788. ],
  29789. "responses": [
  29790. {
  29791. "code": 200,
  29792. "description": "response",
  29793. "examples": [
  29794. {
  29795. "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}"
  29796. }
  29797. ]
  29798. }
  29799. ],
  29800. "renamed": null
  29801. },
  29802. {
  29803. "name": "Delete a Repository Subscription",
  29804. "scope": "activity",
  29805. "id": "deleteRepoSubscription",
  29806. "method": "DELETE",
  29807. "url": "/repos/{owner}/{repo}/subscription",
  29808. "isDeprecated": false,
  29809. "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/enterprise/2.17/v3/activity/watching/#set-a-repository-subscription).",
  29810. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/watching/#delete-a-repository-subscription",
  29811. "previews": [],
  29812. "headers": [],
  29813. "parameters": [
  29814. {
  29815. "name": "owner",
  29816. "description": "owner parameter",
  29817. "in": "PATH",
  29818. "type": "string",
  29819. "required": true,
  29820. "enum": null,
  29821. "allowNull": false,
  29822. "mapToData": null,
  29823. "validation": null,
  29824. "alias": null,
  29825. "deprecated": null
  29826. },
  29827. {
  29828. "name": "repo",
  29829. "description": "repo parameter",
  29830. "in": "PATH",
  29831. "type": "string",
  29832. "required": true,
  29833. "enum": null,
  29834. "allowNull": false,
  29835. "mapToData": null,
  29836. "validation": null,
  29837. "alias": null,
  29838. "deprecated": null
  29839. }
  29840. ],
  29841. "responses": [],
  29842. "renamed": null
  29843. },
  29844. {
  29845. "name": "List tags",
  29846. "scope": "repos",
  29847. "id": "listTags",
  29848. "method": "GET",
  29849. "url": "/repos/{owner}/{repo}/tags",
  29850. "isDeprecated": false,
  29851. "description": "",
  29852. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-tags",
  29853. "previews": [],
  29854. "headers": [],
  29855. "parameters": [
  29856. {
  29857. "name": "owner",
  29858. "description": "owner parameter",
  29859. "in": "PATH",
  29860. "type": "string",
  29861. "required": true,
  29862. "enum": null,
  29863. "allowNull": false,
  29864. "mapToData": null,
  29865. "validation": null,
  29866. "alias": null,
  29867. "deprecated": null
  29868. },
  29869. {
  29870. "name": "repo",
  29871. "description": "repo parameter",
  29872. "in": "PATH",
  29873. "type": "string",
  29874. "required": true,
  29875. "enum": null,
  29876. "allowNull": false,
  29877. "mapToData": null,
  29878. "validation": null,
  29879. "alias": null,
  29880. "deprecated": null
  29881. },
  29882. {
  29883. "name": "per_page",
  29884. "description": "Results per page (max 100)",
  29885. "in": "QUERY",
  29886. "type": "integer",
  29887. "required": false,
  29888. "enum": null,
  29889. "allowNull": false,
  29890. "mapToData": null,
  29891. "validation": null,
  29892. "alias": null,
  29893. "deprecated": null
  29894. },
  29895. {
  29896. "name": "page",
  29897. "description": "Page number of the results to fetch.",
  29898. "in": "QUERY",
  29899. "type": "integer",
  29900. "required": false,
  29901. "enum": null,
  29902. "allowNull": false,
  29903. "mapToData": null,
  29904. "validation": null,
  29905. "alias": null,
  29906. "deprecated": null
  29907. }
  29908. ],
  29909. "responses": [
  29910. {
  29911. "code": 200,
  29912. "description": "response",
  29913. "examples": [
  29914. {
  29915. "data": "[{\"name\":\"v0.1\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"zipball_url\":\"https://github.com/octocat/Hello-World/zipball/v0.1\",\"tarball_url\":\"https://github.com/octocat/Hello-World/tarball/v0.1\"}]"
  29916. }
  29917. ]
  29918. }
  29919. ],
  29920. "renamed": null
  29921. },
  29922. {
  29923. "name": "List teams",
  29924. "scope": "repos",
  29925. "id": "listTeams",
  29926. "method": "GET",
  29927. "url": "/repos/{owner}/{repo}/teams",
  29928. "isDeprecated": false,
  29929. "description": "",
  29930. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-teams",
  29931. "previews": [],
  29932. "headers": [],
  29933. "parameters": [
  29934. {
  29935. "name": "owner",
  29936. "description": "owner parameter",
  29937. "in": "PATH",
  29938. "type": "string",
  29939. "required": true,
  29940. "enum": null,
  29941. "allowNull": false,
  29942. "mapToData": null,
  29943. "validation": null,
  29944. "alias": null,
  29945. "deprecated": null
  29946. },
  29947. {
  29948. "name": "repo",
  29949. "description": "repo parameter",
  29950. "in": "PATH",
  29951. "type": "string",
  29952. "required": true,
  29953. "enum": null,
  29954. "allowNull": false,
  29955. "mapToData": null,
  29956. "validation": null,
  29957. "alias": null,
  29958. "deprecated": null
  29959. },
  29960. {
  29961. "name": "per_page",
  29962. "description": "Results per page (max 100)",
  29963. "in": "QUERY",
  29964. "type": "integer",
  29965. "required": false,
  29966. "enum": null,
  29967. "allowNull": false,
  29968. "mapToData": null,
  29969. "validation": null,
  29970. "alias": null,
  29971. "deprecated": null
  29972. },
  29973. {
  29974. "name": "page",
  29975. "description": "Page number of the results to fetch.",
  29976. "in": "QUERY",
  29977. "type": "integer",
  29978. "required": false,
  29979. "enum": null,
  29980. "allowNull": false,
  29981. "mapToData": null,
  29982. "validation": null,
  29983. "alias": null,
  29984. "deprecated": null
  29985. }
  29986. ],
  29987. "responses": [
  29988. {
  29989. "code": 200,
  29990. "description": "response",
  29991. "examples": [
  29992. {
  29993. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]"
  29994. }
  29995. ]
  29996. }
  29997. ],
  29998. "renamed": null
  29999. },
  30000. {
  30001. "name": "List all topics for a repository",
  30002. "scope": "repos",
  30003. "id": "listTopics",
  30004. "method": "GET",
  30005. "url": "/repos/{owner}/{repo}/topics",
  30006. "isDeprecated": false,
  30007. "description": "",
  30008. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-all-topics-for-a-repository",
  30009. "previews": [{ "name": "mercy" }],
  30010. "headers": [
  30011. { "name": "accept", "value": "application/vnd.github.mercy-preview+json" }
  30012. ],
  30013. "parameters": [
  30014. {
  30015. "name": "owner",
  30016. "description": "owner parameter",
  30017. "in": "PATH",
  30018. "type": "string",
  30019. "required": true,
  30020. "enum": null,
  30021. "allowNull": false,
  30022. "mapToData": null,
  30023. "validation": null,
  30024. "alias": null,
  30025. "deprecated": null
  30026. },
  30027. {
  30028. "name": "repo",
  30029. "description": "repo parameter",
  30030. "in": "PATH",
  30031. "type": "string",
  30032. "required": true,
  30033. "enum": null,
  30034. "allowNull": false,
  30035. "mapToData": null,
  30036. "validation": null,
  30037. "alias": null,
  30038. "deprecated": null
  30039. }
  30040. ],
  30041. "responses": [
  30042. {
  30043. "code": 200,
  30044. "description": "response",
  30045. "examples": [
  30046. { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" }
  30047. ]
  30048. }
  30049. ],
  30050. "renamed": null
  30051. },
  30052. {
  30053. "name": "Replace all topics for a repository",
  30054. "scope": "repos",
  30055. "id": "replaceTopics",
  30056. "method": "PUT",
  30057. "url": "/repos/{owner}/{repo}/topics",
  30058. "isDeprecated": false,
  30059. "description": "",
  30060. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#replace-all-topics-for-a-repository",
  30061. "previews": [{ "name": "mercy" }],
  30062. "headers": [
  30063. { "name": "accept", "value": "application/vnd.github.mercy-preview+json" }
  30064. ],
  30065. "parameters": [
  30066. {
  30067. "name": "owner",
  30068. "description": "owner parameter",
  30069. "in": "PATH",
  30070. "type": "string",
  30071. "required": true,
  30072. "enum": null,
  30073. "allowNull": false,
  30074. "mapToData": null,
  30075. "validation": null,
  30076. "alias": null,
  30077. "deprecated": null
  30078. },
  30079. {
  30080. "name": "repo",
  30081. "description": "repo parameter",
  30082. "in": "PATH",
  30083. "type": "string",
  30084. "required": true,
  30085. "enum": null,
  30086. "allowNull": false,
  30087. "mapToData": null,
  30088. "validation": null,
  30089. "alias": null,
  30090. "deprecated": null
  30091. },
  30092. {
  30093. "name": "names",
  30094. "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.",
  30095. "in": "BODY",
  30096. "type": "string[]",
  30097. "required": true,
  30098. "enum": null,
  30099. "allowNull": false,
  30100. "mapToData": null,
  30101. "validation": null,
  30102. "alias": null,
  30103. "deprecated": null
  30104. }
  30105. ],
  30106. "responses": [
  30107. {
  30108. "code": 200,
  30109. "description": "response",
  30110. "examples": [
  30111. { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" }
  30112. ]
  30113. }
  30114. ],
  30115. "renamed": null
  30116. },
  30117. {
  30118. "name": "Transfer a repository",
  30119. "scope": "repos",
  30120. "id": "transfer",
  30121. "method": "POST",
  30122. "url": "/repos/{owner}/{repo}/transfer",
  30123. "isDeprecated": false,
  30124. "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).",
  30125. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#transfer-a-repository",
  30126. "previews": [{ "name": "nightshade" }],
  30127. "headers": [
  30128. {
  30129. "name": "accept",
  30130. "value": "application/vnd.github.nightshade-preview+json"
  30131. }
  30132. ],
  30133. "parameters": [
  30134. {
  30135. "name": "owner",
  30136. "description": "owner parameter",
  30137. "in": "PATH",
  30138. "type": "string",
  30139. "required": true,
  30140. "enum": null,
  30141. "allowNull": false,
  30142. "mapToData": null,
  30143. "validation": null,
  30144. "alias": null,
  30145. "deprecated": null
  30146. },
  30147. {
  30148. "name": "repo",
  30149. "description": "repo parameter",
  30150. "in": "PATH",
  30151. "type": "string",
  30152. "required": true,
  30153. "enum": null,
  30154. "allowNull": false,
  30155. "mapToData": null,
  30156. "validation": null,
  30157. "alias": null,
  30158. "deprecated": null
  30159. },
  30160. {
  30161. "name": "new_owner",
  30162. "description": "**Required:** The username or organization name the repository will be transferred to.",
  30163. "in": "BODY",
  30164. "type": "string",
  30165. "required": false,
  30166. "enum": null,
  30167. "allowNull": false,
  30168. "mapToData": null,
  30169. "validation": null,
  30170. "alias": null,
  30171. "deprecated": null
  30172. },
  30173. {
  30174. "name": "team_ids",
  30175. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  30176. "in": "BODY",
  30177. "type": "integer[]",
  30178. "required": false,
  30179. "enum": null,
  30180. "allowNull": false,
  30181. "mapToData": null,
  30182. "validation": null,
  30183. "alias": null,
  30184. "deprecated": null
  30185. }
  30186. ],
  30187. "responses": [
  30188. {
  30189. "code": 202,
  30190. "description": "response",
  30191. "examples": [
  30192. {
  30193. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}"
  30194. }
  30195. ]
  30196. }
  30197. ],
  30198. "renamed": null
  30199. },
  30200. {
  30201. "name": "Get archive link",
  30202. "scope": "repos",
  30203. "id": "getArchiveLink",
  30204. "method": "GET",
  30205. "url": "/repos/{owner}/{repo}/{archive_format}/{ref}",
  30206. "isDeprecated": false,
  30207. "description": "Gets a redirect URL to download an archive for a repository. The `:archive_format` can be either `tarball` or `zipball`. The `:ref` must be a valid Git reference. If you omit `:ref`, the repository’s default branch (usually `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request.\n\n_Note_: For private repositories, these links are temporary and expire after five minutes.\n\nTo follow redirects with curl, use the `-L` switch:\n\n",
  30208. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/contents/#get-archive-link",
  30209. "previews": [],
  30210. "headers": [],
  30211. "parameters": [
  30212. {
  30213. "name": "owner",
  30214. "description": "owner parameter",
  30215. "in": "PATH",
  30216. "type": "string",
  30217. "required": true,
  30218. "enum": null,
  30219. "allowNull": false,
  30220. "mapToData": null,
  30221. "validation": null,
  30222. "alias": null,
  30223. "deprecated": null
  30224. },
  30225. {
  30226. "name": "repo",
  30227. "description": "repo parameter",
  30228. "in": "PATH",
  30229. "type": "string",
  30230. "required": true,
  30231. "enum": null,
  30232. "allowNull": false,
  30233. "mapToData": null,
  30234. "validation": null,
  30235. "alias": null,
  30236. "deprecated": null
  30237. },
  30238. {
  30239. "name": "archive_format",
  30240. "description": "archive_format parameter",
  30241. "in": "PATH",
  30242. "type": "string",
  30243. "required": true,
  30244. "enum": null,
  30245. "allowNull": false,
  30246. "mapToData": null,
  30247. "validation": null,
  30248. "alias": null,
  30249. "deprecated": null
  30250. },
  30251. {
  30252. "name": "ref",
  30253. "description": "ref parameter",
  30254. "in": "PATH",
  30255. "type": "string",
  30256. "required": true,
  30257. "enum": null,
  30258. "allowNull": false,
  30259. "mapToData": null,
  30260. "validation": null,
  30261. "alias": null,
  30262. "deprecated": null
  30263. }
  30264. ],
  30265. "responses": [],
  30266. "renamed": null
  30267. },
  30268. {
  30269. "name": "List all public repositories",
  30270. "scope": "repos",
  30271. "id": "listPublic",
  30272. "method": "GET",
  30273. "url": "/repositories",
  30274. "isDeprecated": false,
  30275. "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/enterprise/2.17/v3/#link-header) to get the URL for the next page of repositories.\n\nIf you are an [authenticated](https://developer.github.com/enterprise/2.17/v3/#authentication) site administrator for your Enterprise appliance, you will be able to list all repositories including private repositories.",
  30276. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-all-public-repositories",
  30277. "previews": [],
  30278. "headers": [],
  30279. "parameters": [
  30280. {
  30281. "name": "since",
  30282. "description": "The integer ID of the last Repository that you've seen.",
  30283. "in": "QUERY",
  30284. "type": "string",
  30285. "required": false,
  30286. "enum": null,
  30287. "allowNull": false,
  30288. "mapToData": null,
  30289. "validation": null,
  30290. "alias": null,
  30291. "deprecated": null
  30292. },
  30293. {
  30294. "name": "visibility",
  30295. "description": "To include private repositories as well set to `all`.",
  30296. "in": "QUERY",
  30297. "type": "string",
  30298. "required": false,
  30299. "enum": null,
  30300. "allowNull": false,
  30301. "mapToData": null,
  30302. "validation": null,
  30303. "alias": null,
  30304. "deprecated": null
  30305. },
  30306. {
  30307. "name": "per_page",
  30308. "description": "Results per page (max 100)",
  30309. "in": "QUERY",
  30310. "type": "integer",
  30311. "required": false,
  30312. "enum": null,
  30313. "allowNull": false,
  30314. "mapToData": null,
  30315. "validation": null,
  30316. "alias": null,
  30317. "deprecated": null
  30318. },
  30319. {
  30320. "name": "page",
  30321. "description": "Page number of the results to fetch.",
  30322. "in": "QUERY",
  30323. "type": "integer",
  30324. "required": false,
  30325. "enum": null,
  30326. "allowNull": false,
  30327. "mapToData": null,
  30328. "validation": null,
  30329. "alias": null,
  30330. "deprecated": null
  30331. }
  30332. ],
  30333. "responses": [
  30334. {
  30335. "code": 200,
  30336. "description": "response",
  30337. "examples": [
  30338. {
  30339. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"}]"
  30340. }
  30341. ]
  30342. }
  30343. ],
  30344. "renamed": null
  30345. },
  30346. {
  30347. "name": "Search code",
  30348. "scope": "search",
  30349. "id": "code",
  30350. "method": "GET",
  30351. "url": "/search/code",
  30352. "isDeprecated": false,
  30353. "description": "Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\n**Note:** You must [authenticate](https://developer.github.com/enterprise/2.17/v3/#authentication) to search for code across all public repositories.\n\n**Considerations for code search**\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 10 MB are searchable.\n\nSuppose you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery). Your query would look something like this:\n\nHere, we're searching for the keyword `addClass` within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the `repo:jquery/jquery` repository.",
  30354. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-code",
  30355. "previews": [],
  30356. "headers": [],
  30357. "parameters": [
  30358. {
  30359. "name": "q",
  30360. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.",
  30361. "in": "QUERY",
  30362. "type": "string",
  30363. "required": true,
  30364. "enum": null,
  30365. "allowNull": false,
  30366. "mapToData": null,
  30367. "validation": null,
  30368. "alias": null,
  30369. "deprecated": null
  30370. },
  30371. {
  30372. "name": "sort",
  30373. "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise Server search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30374. "in": "QUERY",
  30375. "type": "string",
  30376. "required": false,
  30377. "enum": ["indexed"],
  30378. "allowNull": false,
  30379. "mapToData": null,
  30380. "validation": null,
  30381. "alias": null,
  30382. "deprecated": null
  30383. },
  30384. {
  30385. "name": "order",
  30386. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30387. "in": "QUERY",
  30388. "type": "string",
  30389. "required": false,
  30390. "enum": ["desc", "asc"],
  30391. "allowNull": false,
  30392. "mapToData": null,
  30393. "validation": null,
  30394. "alias": null,
  30395. "deprecated": null
  30396. },
  30397. {
  30398. "name": "per_page",
  30399. "description": "Results per page (max 100)",
  30400. "in": "QUERY",
  30401. "type": "integer",
  30402. "required": false,
  30403. "enum": null,
  30404. "allowNull": false,
  30405. "mapToData": null,
  30406. "validation": null,
  30407. "alias": null,
  30408. "deprecated": null
  30409. },
  30410. {
  30411. "name": "page",
  30412. "description": "Page number of the results to fetch.",
  30413. "in": "QUERY",
  30414. "type": "integer",
  30415. "required": false,
  30416. "enum": null,
  30417. "allowNull": false,
  30418. "mapToData": null,
  30419. "validation": null,
  30420. "alias": null,
  30421. "deprecated": null
  30422. }
  30423. ],
  30424. "responses": [
  30425. {
  30426. "code": 200,
  30427. "description": "response",
  30428. "examples": [
  30429. {
  30430. "data": "{\"total_count\":7,\"incomplete_results\":false,\"items\":[{\"name\":\"classes.js\",\"path\":\"src/attributes/classes.js\",\"sha\":\"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"url\":\"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\"git_url\":\"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"html_url\":\"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\"repository\":{\"id\":167174,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\"name\":\"jquery\",\"full_name\":\"jquery/jquery\",\"owner\":{\"login\":\"jquery\",\"id\":70142,\"node_id\":\"MDQ6VXNlcjcwMTQy\",\"avatar_url\":\"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/jquery\",\"html_url\":\"https://github.com/jquery\",\"followers_url\":\"https://api.github.com/users/jquery/followers\",\"following_url\":\"https://api.github.com/users/jquery/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/jquery/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/jquery/subscriptions\",\"organizations_url\":\"https://api.github.com/users/jquery/orgs\",\"repos_url\":\"https://api.github.com/users/jquery/repos\",\"events_url\":\"https://api.github.com/users/jquery/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/jquery/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/jquery/jquery\",\"description\":\"jQuery JavaScript Library\",\"fork\":false,\"url\":\"https://api.github.com/repos/jquery/jquery\",\"forks_url\":\"https://api.github.com/repos/jquery/jquery/forks\",\"keys_url\":\"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/jquery/jquery/teams\",\"hooks_url\":\"https://api.github.com/repos/jquery/jquery/hooks\",\"issue_events_url\":\"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/jquery/jquery/events\",\"assignees_url\":\"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/jquery/jquery/tags\",\"blobs_url\":\"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/jquery/jquery/languages\",\"stargazers_url\":\"https://api.github.com/repos/jquery/jquery/stargazers\",\"contributors_url\":\"https://api.github.com/repos/jquery/jquery/contributors\",\"subscribers_url\":\"https://api.github.com/repos/jquery/jquery/subscribers\",\"subscription_url\":\"https://api.github.com/repos/jquery/jquery/subscription\",\"commits_url\":\"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/jquery/jquery/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\"contents_url\":\"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/jquery/jquery/merges\",\"archive_url\":\"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/jquery/jquery/downloads\",\"issues_url\":\"https://api.github.com/repos/jquery/jquery/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/jquery/jquery/labels{/name}\"},\"score\":0.5269679}]}"
  30431. }
  30432. ]
  30433. }
  30434. ],
  30435. "renamed": null
  30436. },
  30437. {
  30438. "name": "Search commits",
  30439. "scope": "search",
  30440. "id": "commits",
  30441. "method": "GET",
  30442. "url": "/search/commits",
  30443. "isDeprecated": false,
  30444. "description": "Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\n**Considerations for commit search**\n\nOnly the _default branch_ is considered. In most cases, this will be the `master` branch.\n\nSuppose you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:",
  30445. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-commits",
  30446. "previews": [{ "name": "cloak" }],
  30447. "headers": [
  30448. { "name": "accept", "value": "application/vnd.github.cloak-preview+json" }
  30449. ],
  30450. "parameters": [
  30451. {
  30452. "name": "q",
  30453. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.",
  30454. "in": "QUERY",
  30455. "type": "string",
  30456. "required": true,
  30457. "enum": null,
  30458. "allowNull": false,
  30459. "mapToData": null,
  30460. "validation": null,
  30461. "alias": null,
  30462. "deprecated": null
  30463. },
  30464. {
  30465. "name": "sort",
  30466. "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30467. "in": "QUERY",
  30468. "type": "string",
  30469. "required": false,
  30470. "enum": ["author-date", "committer-date"],
  30471. "allowNull": false,
  30472. "mapToData": null,
  30473. "validation": null,
  30474. "alias": null,
  30475. "deprecated": null
  30476. },
  30477. {
  30478. "name": "order",
  30479. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30480. "in": "QUERY",
  30481. "type": "string",
  30482. "required": false,
  30483. "enum": ["desc", "asc"],
  30484. "allowNull": false,
  30485. "mapToData": null,
  30486. "validation": null,
  30487. "alias": null,
  30488. "deprecated": null
  30489. },
  30490. {
  30491. "name": "per_page",
  30492. "description": "Results per page (max 100)",
  30493. "in": "QUERY",
  30494. "type": "integer",
  30495. "required": false,
  30496. "enum": null,
  30497. "allowNull": false,
  30498. "mapToData": null,
  30499. "validation": null,
  30500. "alias": null,
  30501. "deprecated": null
  30502. },
  30503. {
  30504. "name": "page",
  30505. "description": "Page number of the results to fetch.",
  30506. "in": "QUERY",
  30507. "type": "integer",
  30508. "required": false,
  30509. "enum": null,
  30510. "allowNull": false,
  30511. "mapToData": null,
  30512. "validation": null,
  30513. "alias": null,
  30514. "deprecated": null
  30515. }
  30516. ],
  30517. "responses": [
  30518. {
  30519. "code": 200,
  30520. "description": "response",
  30521. "examples": [
  30522. {
  30523. "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":4.9971514}]}"
  30524. }
  30525. ]
  30526. }
  30527. ],
  30528. "renamed": null
  30529. },
  30530. {
  30531. "name": "Search issues and pull requests",
  30532. "scope": "search",
  30533. "id": "issuesAndPullRequests",
  30534. "method": "GET",
  30535. "url": "/search/issues",
  30536. "isDeprecated": false,
  30537. "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.",
  30538. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-issues-and-pull-requests",
  30539. "previews": [],
  30540. "headers": [],
  30541. "parameters": [
  30542. {
  30543. "name": "q",
  30544. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.",
  30545. "in": "QUERY",
  30546. "type": "string",
  30547. "required": true,
  30548. "enum": null,
  30549. "allowNull": false,
  30550. "mapToData": null,
  30551. "validation": null,
  30552. "alias": null,
  30553. "deprecated": null
  30554. },
  30555. {
  30556. "name": "sort",
  30557. "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30558. "in": "QUERY",
  30559. "type": "string",
  30560. "required": false,
  30561. "enum": [
  30562. "comments",
  30563. "reactions",
  30564. "reactions-+1",
  30565. "reactions--1",
  30566. "reactions-smile",
  30567. "reactions-thinking_face",
  30568. "reactions-heart",
  30569. "reactions-tada",
  30570. "interactions",
  30571. "created",
  30572. "updated"
  30573. ],
  30574. "allowNull": false,
  30575. "mapToData": null,
  30576. "validation": null,
  30577. "alias": null,
  30578. "deprecated": null
  30579. },
  30580. {
  30581. "name": "order",
  30582. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30583. "in": "QUERY",
  30584. "type": "string",
  30585. "required": false,
  30586. "enum": ["desc", "asc"],
  30587. "allowNull": false,
  30588. "mapToData": null,
  30589. "validation": null,
  30590. "alias": null,
  30591. "deprecated": null
  30592. },
  30593. {
  30594. "name": "per_page",
  30595. "description": "Results per page (max 100)",
  30596. "in": "QUERY",
  30597. "type": "integer",
  30598. "required": false,
  30599. "enum": null,
  30600. "allowNull": false,
  30601. "mapToData": null,
  30602. "validation": null,
  30603. "alias": null,
  30604. "deprecated": null
  30605. },
  30606. {
  30607. "name": "page",
  30608. "description": "Page number of the results to fetch.",
  30609. "in": "QUERY",
  30610. "type": "integer",
  30611. "required": false,
  30612. "enum": null,
  30613. "allowNull": false,
  30614. "mapToData": null,
  30615. "validation": null,
  30616. "alias": null,
  30617. "deprecated": null
  30618. }
  30619. ],
  30620. "responses": [
  30621. {
  30622. "code": 200,
  30623. "description": "response",
  30624. "examples": [
  30625. {
  30626. "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\"},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":null,\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"html_url\":null,\"diff_url\":null,\"patch_url\":null},\"body\":\"...\",\"score\":1.3859273}]}"
  30627. }
  30628. ]
  30629. }
  30630. ],
  30631. "renamed": null
  30632. },
  30633. {
  30634. "name": "Search issues and pull requests",
  30635. "scope": "search",
  30636. "id": "issues",
  30637. "method": "GET",
  30638. "url": "/search/issues",
  30639. "isDeprecated": false,
  30640. "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.",
  30641. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-issues-and-pull-requests",
  30642. "previews": [],
  30643. "headers": [],
  30644. "parameters": [
  30645. {
  30646. "name": "q",
  30647. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.",
  30648. "in": "QUERY",
  30649. "type": "string",
  30650. "required": true,
  30651. "enum": null,
  30652. "allowNull": false,
  30653. "mapToData": null,
  30654. "validation": null,
  30655. "alias": null,
  30656. "deprecated": null
  30657. },
  30658. {
  30659. "name": "sort",
  30660. "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30661. "in": "QUERY",
  30662. "type": "string",
  30663. "required": false,
  30664. "enum": [
  30665. "comments",
  30666. "reactions",
  30667. "reactions-+1",
  30668. "reactions--1",
  30669. "reactions-smile",
  30670. "reactions-thinking_face",
  30671. "reactions-heart",
  30672. "reactions-tada",
  30673. "interactions",
  30674. "created",
  30675. "updated"
  30676. ],
  30677. "allowNull": false,
  30678. "mapToData": null,
  30679. "validation": null,
  30680. "alias": null,
  30681. "deprecated": null
  30682. },
  30683. {
  30684. "name": "order",
  30685. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30686. "in": "QUERY",
  30687. "type": "string",
  30688. "required": false,
  30689. "enum": ["desc", "asc"],
  30690. "allowNull": false,
  30691. "mapToData": null,
  30692. "validation": null,
  30693. "alias": null,
  30694. "deprecated": null
  30695. },
  30696. {
  30697. "name": "per_page",
  30698. "description": "Results per page (max 100)",
  30699. "in": "QUERY",
  30700. "type": "integer",
  30701. "required": false,
  30702. "enum": null,
  30703. "allowNull": false,
  30704. "mapToData": null,
  30705. "validation": null,
  30706. "alias": null,
  30707. "deprecated": null
  30708. },
  30709. {
  30710. "name": "page",
  30711. "description": "Page number of the results to fetch.",
  30712. "in": "QUERY",
  30713. "type": "integer",
  30714. "required": false,
  30715. "enum": null,
  30716. "allowNull": false,
  30717. "mapToData": null,
  30718. "validation": null,
  30719. "alias": null,
  30720. "deprecated": null
  30721. }
  30722. ],
  30723. "responses": [
  30724. {
  30725. "code": 200,
  30726. "description": "response",
  30727. "examples": [
  30728. {
  30729. "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\"},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":null,\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"html_url\":null,\"diff_url\":null,\"patch_url\":null},\"body\":\"...\",\"score\":1.3859273}]}"
  30730. }
  30731. ]
  30732. }
  30733. ],
  30734. "renamed": {
  30735. "before": { "scope": "search", "id": "issues" },
  30736. "after": { "scope": "search", "id": "issuesAndPullRequests" },
  30737. "date": "2018-12-27",
  30738. "note": "\"Search issues\" has been renamed to \"Search issues and pull requests\""
  30739. }
  30740. },
  30741. {
  30742. "name": "Search labels",
  30743. "scope": "search",
  30744. "id": "labels",
  30745. "method": "GET",
  30746. "url": "/search/labels",
  30747. "isDeprecated": false,
  30748. "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\nSuppose you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\nThe labels that best match for the query appear first in the search results.",
  30749. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-labels",
  30750. "previews": [],
  30751. "headers": [],
  30752. "parameters": [
  30753. {
  30754. "name": "repository_id",
  30755. "description": "The id of the repository.",
  30756. "in": "QUERY",
  30757. "type": "integer",
  30758. "required": true,
  30759. "enum": null,
  30760. "allowNull": false,
  30761. "mapToData": null,
  30762. "validation": null,
  30763. "alias": null,
  30764. "deprecated": null
  30765. },
  30766. {
  30767. "name": "q",
  30768. "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query).",
  30769. "in": "QUERY",
  30770. "type": "string",
  30771. "required": true,
  30772. "enum": null,
  30773. "allowNull": false,
  30774. "mapToData": null,
  30775. "validation": null,
  30776. "alias": null,
  30777. "deprecated": null
  30778. },
  30779. {
  30780. "name": "sort",
  30781. "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30782. "in": "QUERY",
  30783. "type": "string",
  30784. "required": false,
  30785. "enum": ["created", "updated"],
  30786. "allowNull": false,
  30787. "mapToData": null,
  30788. "validation": null,
  30789. "alias": null,
  30790. "deprecated": null
  30791. },
  30792. {
  30793. "name": "order",
  30794. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30795. "in": "QUERY",
  30796. "type": "string",
  30797. "required": false,
  30798. "enum": ["desc", "asc"],
  30799. "allowNull": false,
  30800. "mapToData": null,
  30801. "validation": null,
  30802. "alias": null,
  30803. "deprecated": null
  30804. }
  30805. ],
  30806. "responses": [
  30807. {
  30808. "code": 200,
  30809. "description": "response",
  30810. "examples": [
  30811. {
  30812. "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":0.1193385},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":0.11928606}]}"
  30813. }
  30814. ]
  30815. }
  30816. ],
  30817. "renamed": null
  30818. },
  30819. {
  30820. "name": "Search repositories",
  30821. "scope": "search",
  30822. "id": "repos",
  30823. "method": "GET",
  30824. "url": "/search/repositories",
  30825. "isDeprecated": false,
  30826. "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\nSuppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this.\n\nYou can search for multiple topics by adding more `topic:` instances, and including the `mercy-preview` header. For example:\n\nIn this request, we're searching for repositories with the word `tetris` in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results.",
  30827. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-repositories",
  30828. "previews": [],
  30829. "headers": [],
  30830. "parameters": [
  30831. {
  30832. "name": "q",
  30833. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.",
  30834. "in": "QUERY",
  30835. "type": "string",
  30836. "required": true,
  30837. "enum": null,
  30838. "allowNull": false,
  30839. "mapToData": null,
  30840. "validation": null,
  30841. "alias": null,
  30842. "deprecated": null
  30843. },
  30844. {
  30845. "name": "sort",
  30846. "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30847. "in": "QUERY",
  30848. "type": "string",
  30849. "required": false,
  30850. "enum": ["stars", "forks", "help-wanted-issues", "updated"],
  30851. "allowNull": false,
  30852. "mapToData": null,
  30853. "validation": null,
  30854. "alias": null,
  30855. "deprecated": null
  30856. },
  30857. {
  30858. "name": "order",
  30859. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30860. "in": "QUERY",
  30861. "type": "string",
  30862. "required": false,
  30863. "enum": ["desc", "asc"],
  30864. "allowNull": false,
  30865. "mapToData": null,
  30866. "validation": null,
  30867. "alias": null,
  30868. "deprecated": null
  30869. },
  30870. {
  30871. "name": "per_page",
  30872. "description": "Results per page (max 100)",
  30873. "in": "QUERY",
  30874. "type": "integer",
  30875. "required": false,
  30876. "enum": null,
  30877. "allowNull": false,
  30878. "mapToData": null,
  30879. "validation": null,
  30880. "alias": null,
  30881. "deprecated": null
  30882. },
  30883. {
  30884. "name": "page",
  30885. "description": "Page number of the results to fetch.",
  30886. "in": "QUERY",
  30887. "type": "integer",
  30888. "required": false,
  30889. "enum": null,
  30890. "allowNull": false,
  30891. "mapToData": null,
  30892. "validation": null,
  30893. "alias": null,
  30894. "deprecated": null
  30895. }
  30896. ],
  30897. "responses": [
  30898. {
  30899. "code": 200,
  30900. "description": "response",
  30901. "examples": [
  30902. {
  30903. "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\"},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":10.309712}]}"
  30904. }
  30905. ]
  30906. }
  30907. ],
  30908. "renamed": null
  30909. },
  30910. {
  30911. "name": "Search topics",
  30912. "scope": "search",
  30913. "id": "topics",
  30914. "method": "GET",
  30915. "url": "/search/topics",
  30916. "isDeprecated": false,
  30917. "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\nSee \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nSuppose you want to search for topics related to Ruby that are featured on [https://github.com/topics](https://github.com/topics). Your query might look like this:\n\nIn this request, we're searching for topics with the keyword `ruby`, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.\n\n**Note:** A search for featured Ruby topics only has 6 total results, so a [Link header](https://developer.github.com/enterprise/2.17/v3/#link-header) indicating pagination is not included in the response.",
  30918. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-topics",
  30919. "previews": [],
  30920. "headers": [],
  30921. "parameters": [
  30922. {
  30923. "name": "q",
  30924. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query).",
  30925. "in": "QUERY",
  30926. "type": "string",
  30927. "required": true,
  30928. "enum": null,
  30929. "allowNull": false,
  30930. "mapToData": null,
  30931. "validation": null,
  30932. "alias": null,
  30933. "deprecated": null
  30934. }
  30935. ],
  30936. "responses": [
  30937. {
  30938. "code": 200,
  30939. "description": "response",
  30940. "examples": [
  30941. {
  30942. "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1750.5872},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":192.49863},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":111.92691},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":45.06729},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":42.455986},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":19.194168}]}"
  30943. }
  30944. ]
  30945. }
  30946. ],
  30947. "renamed": null
  30948. },
  30949. {
  30950. "name": "Search users",
  30951. "scope": "search",
  30952. "id": "users",
  30953. "method": "GET",
  30954. "url": "/search/users",
  30955. "isDeprecated": false,
  30956. "description": "Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.17/v3/#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.17/v3/search/#text-match-metadata).\n\nImagine you're looking for a list of popular users. You might try out this query:\n\nHere, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers.",
  30957. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/search/#search-users",
  30958. "previews": [],
  30959. "headers": [],
  30960. "parameters": [
  30961. {
  30962. "name": "q",
  30963. "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/enterprise/2.17/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.",
  30964. "in": "QUERY",
  30965. "type": "string",
  30966. "required": true,
  30967. "enum": null,
  30968. "allowNull": false,
  30969. "mapToData": null,
  30970. "validation": null,
  30971. "alias": null,
  30972. "deprecated": null
  30973. },
  30974. {
  30975. "name": "sort",
  30976. "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise Server. Default: [best match](https://developer.github.com/enterprise/2.17/v3/search/#ranking-search-results)",
  30977. "in": "QUERY",
  30978. "type": "string",
  30979. "required": false,
  30980. "enum": ["followers", "repositories", "joined"],
  30981. "allowNull": false,
  30982. "mapToData": null,
  30983. "validation": null,
  30984. "alias": null,
  30985. "deprecated": null
  30986. },
  30987. {
  30988. "name": "order",
  30989. "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.",
  30990. "in": "QUERY",
  30991. "type": "string",
  30992. "required": false,
  30993. "enum": ["desc", "asc"],
  30994. "allowNull": false,
  30995. "mapToData": null,
  30996. "validation": null,
  30997. "alias": null,
  30998. "deprecated": null
  30999. },
  31000. {
  31001. "name": "per_page",
  31002. "description": "Results per page (max 100)",
  31003. "in": "QUERY",
  31004. "type": "integer",
  31005. "required": false,
  31006. "enum": null,
  31007. "allowNull": false,
  31008. "mapToData": null,
  31009. "validation": null,
  31010. "alias": null,
  31011. "deprecated": null
  31012. },
  31013. {
  31014. "name": "page",
  31015. "description": "Page number of the results to fetch.",
  31016. "in": "QUERY",
  31017. "type": "integer",
  31018. "required": false,
  31019. "enum": null,
  31020. "allowNull": false,
  31021. "mapToData": null,
  31022. "validation": null,
  31023. "alias": null,
  31024. "deprecated": null
  31025. }
  31026. ],
  31027. "responses": [
  31028. {
  31029. "code": 200,
  31030. "description": "response",
  31031. "examples": [
  31032. {
  31033. "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":105.47857}]}"
  31034. }
  31035. ]
  31036. }
  31037. ],
  31038. "renamed": null
  31039. },
  31040. {
  31041. "name": "Check configuration status",
  31042. "scope": "enterpriseAdmin",
  31043. "id": "checkConfigurationStatus",
  31044. "method": "GET",
  31045. "url": "/setup/api/configcheck",
  31046. "isDeprecated": false,
  31047. "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |",
  31048. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#check-configuration-status",
  31049. "previews": [],
  31050. "headers": [],
  31051. "parameters": [],
  31052. "responses": [
  31053. {
  31054. "code": 200,
  31055. "description": "response",
  31056. "examples": [
  31057. {
  31058. "data": "{\"status\":\"running\",\"progress\":[{\"status\":\"DONE\",\"key\":\"Appliance core components\"},{\"status\":\"DONE\",\"key\":\"GitHub utilities\"},{\"status\":\"DONE\",\"key\":\"GitHub applications\"},{\"status\":\"CONFIGURING\",\"key\":\"GitHub services\"},{\"status\":\"PENDING\",\"key\":\"Reloading appliance services\"}]}"
  31059. }
  31060. ]
  31061. }
  31062. ],
  31063. "renamed": null
  31064. },
  31065. {
  31066. "name": "Start a configuration process",
  31067. "scope": "enterpriseAdmin",
  31068. "id": "startConfigurationProcess",
  31069. "method": "POST",
  31070. "url": "/setup/api/configure",
  31071. "isDeprecated": false,
  31072. "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:",
  31073. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#start-a-configuration-process",
  31074. "previews": [],
  31075. "headers": [],
  31076. "parameters": [],
  31077. "responses": [],
  31078. "renamed": null
  31079. },
  31080. {
  31081. "name": "Check maintenance status",
  31082. "scope": "enterpriseAdmin",
  31083. "id": "checkMaintenanceStatus",
  31084. "method": "GET",
  31085. "url": "/setup/api/maintenance",
  31086. "isDeprecated": false,
  31087. "description": "Check your installation's maintenance status:",
  31088. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#check-maintenance-status",
  31089. "previews": [],
  31090. "headers": [],
  31091. "parameters": [],
  31092. "responses": [
  31093. {
  31094. "code": 200,
  31095. "description": "response",
  31096. "examples": [
  31097. {
  31098. "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15 => 34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"resque jobs\",\"number\":54}]}"
  31099. }
  31100. ]
  31101. }
  31102. ],
  31103. "renamed": null
  31104. },
  31105. {
  31106. "name": "Enable or disable maintenance mode",
  31107. "scope": "enterpriseAdmin",
  31108. "id": "enableOrDisableMaintenanceMode",
  31109. "method": "POST",
  31110. "url": "/setup/api/maintenance",
  31111. "isDeprecated": false,
  31112. "description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).",
  31113. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#enable-or-disable-maintenance-mode",
  31114. "previews": [],
  31115. "headers": [],
  31116. "parameters": [
  31117. {
  31118. "name": "maintenance",
  31119. "description": "A JSON string with the attributes `enabled` and `when`.",
  31120. "in": "BODY",
  31121. "type": "string",
  31122. "required": true,
  31123. "enum": null,
  31124. "allowNull": false,
  31125. "mapToData": null,
  31126. "validation": null,
  31127. "alias": null,
  31128. "deprecated": null
  31129. }
  31130. ],
  31131. "responses": [
  31132. {
  31133. "code": 200,
  31134. "description": "response",
  31135. "examples": [
  31136. {
  31137. "data": "{\"status\":\"scheduled\",\"scheduled_time\":\"Tuesday, January 22 at 15 => 34 -0800\",\"connection_services\":[{\"name\":\"git operations\",\"number\":0},{\"name\":\"mysql queries\",\"number\":233},{\"name\":\"resque jobs\",\"number\":54}]}"
  31138. }
  31139. ]
  31140. }
  31141. ],
  31142. "renamed": null
  31143. },
  31144. {
  31145. "name": "Retrieve settings",
  31146. "scope": "enterpriseAdmin",
  31147. "id": "retrieveSettings",
  31148. "method": "GET",
  31149. "url": "/setup/api/settings",
  31150. "isDeprecated": false,
  31151. "description": "",
  31152. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#retrieve-settings",
  31153. "previews": [],
  31154. "headers": [],
  31155. "parameters": [],
  31156. "responses": [
  31157. {
  31158. "code": 200,
  31159. "description": "response",
  31160. "examples": [
  31161. {
  31162. "data": "{\"enterprise\":{\"private_mode\":false,\"public_pages\":false,\"subdomain_isolation\":true,\"signup_enabled\":false,\"github_hostname\":\"ghe.local\",\"identicons_host\":\"dotcom\",\"http_proxy\":null,\"auth_mode\":\"default\",\"expire_sessions\":false,\"admin_password\":null,\"configuration_id\":1401777404,\"configuration_run_count\":4,\"avatar\":{\"enabled\":false,\"uri\":\"\"},\"customer\":{\"name\":\"GitHub\",\"email\":\"stannis@themannis.biz\",\"uuid\":\"af6cac80-e4e1-012e-d822-1231380e52e9\",\"secret_key_data\":\"-----BEGIN PGP PRIVATE KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nlQcYBE5TCgsBEACk4yHpUcapplebaumBMXYMiLF+nCQ0lxpx...\\n-----END PGP PRIVATE KEY BLOCK-----\\n\",\"public_key_data\":\"-----BEGIN PGP PUBLIC KEY BLOCK-----\\nVersion: GnuPG v1.4.10 (GNU/Linux)\\n\\nmI0ETqzZYgEEALSe6snowdenXyqvLfSQ34HWD6C7....\\n-----END PGP PUBLIC KEY BLOCK-----\\n\"},\"license\":{\"seats\":0,\"evaluation\":false,\"perpetual\":false,\"unlimited_seating\":true,\"support_key\":\"ssh-rsa AAAAB3N....\",\"ssh_allowed\":true,\"cluster_support\":false,\"expire_at\":\"2016-04-27T00:00:00-07:00\"},\"github_ssl\":{\"enabled\":false,\"cert\":null,\"key\":null},\"ldap\":{\"host\":null,\"port\":0,\"base\":[],\"uid\":null,\"bind_dn\":null,\"password\":null,\"method\":\"Plain\",\"search_strategy\":\"detect\",\"user_groups\":[],\"admin_group\":null,\"virtual_attribute_enabled\":false,\"recursive_group_search\":false,\"posix_support\":true,\"user_sync_emails\":false,\"user_sync_keys\":false,\"user_sync_interval\":4,\"team_sync_interval\":4,\"sync_enabled\":false,\"reconciliation\":{\"user\":null,\"org\":null},\"profile\":{\"uid\":\"uid\",\"name\":null,\"mail\":null,\"key\":null}},\"cas\":{\"url\":null},\"saml\":{\"sso_url\":null,\"certificate\":null,\"certificate_path\":null,\"issuer\":null,\"idp_initiated_sso\":false,\"disable_admin_demote\":false},\"github_oauth\":{\"client_id\":\"12313412\",\"client_secret\":\"kj123131132\",\"organization_name\":\"Homestar Runners\",\"organization_team\":\"homestarrunners/characters\"},\"smtp\":{\"enabled\":true,\"address\":\"smtp.example.com\",\"authentication\":\"plain\",\"port\":\"1234\",\"domain\":\"blah\",\"username\":\"foo\",\"user_name\":\"mr_foo\",\"enable_starttls_auto\":true,\"password\":\"bar\",\"discard-to-noreply-address\":true,\"support_address\":\"enterprise@github.com\",\"support_address_type\":\"email\",\"noreply_address\":\"noreply@github.com\"},\"ntp\":{\"primary_server\":\"0.pool.ntp.org\",\"secondary_server\":\"1.pool.ntp.org\"},\"timezone\":null,\"snmp\":{\"enabled\":false,\"community\":\"\"},\"syslog\":{\"enabled\":false,\"server\":null,\"protocol_name\":\"udp\"},\"assets\":null,\"pages\":{\"enabled\":true},\"collectd\":{\"enabled\":false,\"server\":null,\"port\":0,\"encryption\":null,\"username\":null,\"password\":null},\"mapping\":{\"enabled\":true,\"tileserver\":null,\"basemap\":\"company.map-qsz2zrvs\",\"token\":null},\"load_balancer\":null},\"run_list\":[\"recipe[enterprise-configure]\"]}"
  31163. }
  31164. ]
  31165. }
  31166. ],
  31167. "renamed": null
  31168. },
  31169. {
  31170. "name": "Modify settings",
  31171. "scope": "enterpriseAdmin",
  31172. "id": "modifySettings",
  31173. "method": "PUT",
  31174. "url": "/setup/api/settings",
  31175. "isDeprecated": false,
  31176. "description": "For a list of the available settings, see the [Retrieve settings endpoint](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#retrieve-settings).",
  31177. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#modify-settings",
  31178. "previews": [],
  31179. "headers": [],
  31180. "parameters": [
  31181. {
  31182. "name": "settings",
  31183. "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.",
  31184. "in": "BODY",
  31185. "type": "string",
  31186. "required": true,
  31187. "enum": null,
  31188. "allowNull": false,
  31189. "mapToData": null,
  31190. "validation": null,
  31191. "alias": null,
  31192. "deprecated": null
  31193. }
  31194. ],
  31195. "responses": [],
  31196. "renamed": null
  31197. },
  31198. {
  31199. "name": "Retrieve authorized SSH keys",
  31200. "scope": "enterpriseAdmin",
  31201. "id": "retrieveAuthorizedSshKeys",
  31202. "method": "GET",
  31203. "url": "/setup/api/settings/authorized-keys",
  31204. "isDeprecated": false,
  31205. "description": "",
  31206. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#retrieve-authorized-ssh-keys",
  31207. "previews": [],
  31208. "headers": [],
  31209. "parameters": [],
  31210. "responses": [
  31211. {
  31212. "code": 200,
  31213. "description": "response",
  31214. "examples": [
  31215. {
  31216. "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]"
  31217. }
  31218. ]
  31219. }
  31220. ],
  31221. "renamed": null
  31222. },
  31223. {
  31224. "name": "Add a new authorized SSH key",
  31225. "scope": "enterpriseAdmin",
  31226. "id": "addAuthorizedSshKey",
  31227. "method": "POST",
  31228. "url": "/setup/api/settings/authorized-keys",
  31229. "isDeprecated": false,
  31230. "description": "",
  31231. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#add-a-new-authorized-ssh-key",
  31232. "previews": [],
  31233. "headers": [],
  31234. "parameters": [
  31235. {
  31236. "name": "authorized_key",
  31237. "description": "The path to the public SSH key.",
  31238. "in": "BODY",
  31239. "type": "string",
  31240. "required": true,
  31241. "enum": null,
  31242. "allowNull": false,
  31243. "mapToData": null,
  31244. "validation": null,
  31245. "alias": null,
  31246. "deprecated": null
  31247. }
  31248. ],
  31249. "responses": [
  31250. {
  31251. "code": 201,
  31252. "description": "response",
  31253. "examples": [
  31254. {
  31255. "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]"
  31256. }
  31257. ]
  31258. }
  31259. ],
  31260. "renamed": null
  31261. },
  31262. {
  31263. "name": "Remove an authorized SSH key",
  31264. "scope": "enterpriseAdmin",
  31265. "id": "removeAuthorizedSshKey",
  31266. "method": "DELETE",
  31267. "url": "/setup/api/settings/authorized-keys",
  31268. "isDeprecated": false,
  31269. "description": "",
  31270. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#remove-an-authorized-ssh-key",
  31271. "previews": [],
  31272. "headers": [],
  31273. "parameters": [
  31274. {
  31275. "name": "authorized_key",
  31276. "description": "The path to the public SSH key.",
  31277. "in": "BODY",
  31278. "type": "string",
  31279. "required": true,
  31280. "enum": null,
  31281. "allowNull": false,
  31282. "mapToData": null,
  31283. "validation": null,
  31284. "alias": null,
  31285. "deprecated": null
  31286. }
  31287. ],
  31288. "responses": [
  31289. {
  31290. "code": 200,
  31291. "description": "response",
  31292. "examples": [
  31293. {
  31294. "data": "[{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"},{\"key\":\"ssh-rsa AAAAB3NzaC1yc2EAAAAB...\",\"pretty-print\":\"ssh-rsa 01:14:0f:f2:0f:e2:fe:e8:f4:72:62:af:75:f7:1a:88:3e:04:92:64\"}]"
  31295. }
  31296. ]
  31297. }
  31298. ],
  31299. "renamed": null
  31300. },
  31301. {
  31302. "name": "Upload a license for the first time",
  31303. "scope": "enterpriseAdmin",
  31304. "id": "uploadLicenseForFirstTime",
  31305. "method": "POST",
  31306. "url": "/setup/api/start",
  31307. "isDeprecated": false,
  31308. "description": "When you boot a GitHub Enterprise Server instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub Enterprise Server instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Retrieve settings endpoint](https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#retrieve-settings).",
  31309. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#upload-a-license-for-the-first-time",
  31310. "previews": [],
  31311. "headers": [],
  31312. "parameters": [
  31313. {
  31314. "name": "license",
  31315. "description": "The content of your _.ghl_ license file.",
  31316. "in": "BODY",
  31317. "type": "string",
  31318. "required": true,
  31319. "enum": null,
  31320. "allowNull": false,
  31321. "mapToData": null,
  31322. "validation": null,
  31323. "alias": null,
  31324. "deprecated": null
  31325. },
  31326. {
  31327. "name": "password",
  31328. "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.",
  31329. "in": "BODY",
  31330. "type": "string",
  31331. "required": false,
  31332. "enum": null,
  31333. "allowNull": false,
  31334. "mapToData": null,
  31335. "validation": null,
  31336. "alias": null,
  31337. "deprecated": null
  31338. },
  31339. {
  31340. "name": "settings",
  31341. "description": "An optional JSON string containing the installation settings.",
  31342. "in": "BODY",
  31343. "type": "string",
  31344. "required": false,
  31345. "enum": null,
  31346. "allowNull": false,
  31347. "mapToData": null,
  31348. "validation": null,
  31349. "alias": null,
  31350. "deprecated": null
  31351. }
  31352. ],
  31353. "responses": [],
  31354. "renamed": null
  31355. },
  31356. {
  31357. "name": "Upgrade a license",
  31358. "scope": "enterpriseAdmin",
  31359. "id": "upgradeLicense",
  31360. "method": "POST",
  31361. "url": "/setup/api/upgrade",
  31362. "isDeprecated": false,
  31363. "description": "This API upgrades your license and also triggers the configuration process:",
  31364. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/management_console/#upgrade-a-license",
  31365. "previews": [],
  31366. "headers": [],
  31367. "parameters": [
  31368. {
  31369. "name": "license",
  31370. "description": "The content of your new _.ghl_ license file.",
  31371. "in": "BODY",
  31372. "type": "string",
  31373. "required": false,
  31374. "enum": null,
  31375. "allowNull": false,
  31376. "mapToData": null,
  31377. "validation": null,
  31378. "alias": null,
  31379. "deprecated": null
  31380. }
  31381. ],
  31382. "responses": [],
  31383. "renamed": null
  31384. },
  31385. {
  31386. "name": "Queue an indexing job",
  31387. "scope": "enterpriseAdmin",
  31388. "id": "queueIndexingJob",
  31389. "method": "POST",
  31390. "url": "/staff/indexing_jobs",
  31391. "isDeprecated": false,
  31392. "description": "You can index the following targets (replace `:owner` with the name of a user or organization account and `:repository` with the name of a repository):\n\n| Target | Description |\n| --------------------------- | -------------------------------------------------------------------- |\n| `:owner` | A user or organization account. |\n| `:owner/:repository` | A repository. |\n| `:owner/*` | All of a user or organization's repositories. |\n| `:owner/:repository/issues` | All the issues in a repository. |\n| `:owner/*/issues` | All the issues in all of a user or organization's repositories. |\n| `:owner/:repository/code` | All the source code in a repository. |\n| `:owner/*/code` | All the source code in all of a user or organization's repositories. |",
  31393. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/search_indexing/#queue-an-indexing-job",
  31394. "previews": [],
  31395. "headers": [],
  31396. "parameters": [
  31397. {
  31398. "name": "target",
  31399. "description": "A string representing the item to index.",
  31400. "in": "BODY",
  31401. "type": "string",
  31402. "required": true,
  31403. "enum": null,
  31404. "allowNull": false,
  31405. "mapToData": null,
  31406. "validation": null,
  31407. "alias": null,
  31408. "deprecated": null
  31409. }
  31410. ],
  31411. "responses": [
  31412. {
  31413. "code": 202,
  31414. "description": "response",
  31415. "examples": [
  31416. {
  31417. "data": "{\"message\":\"Repository 'kansaichris/japaning' has been added to the indexing queue\"}"
  31418. }
  31419. ]
  31420. }
  31421. ],
  31422. "renamed": null
  31423. },
  31424. {
  31425. "name": "Get team",
  31426. "scope": "teams",
  31427. "id": "get",
  31428. "method": "GET",
  31429. "url": "/teams/{team_id}",
  31430. "isDeprecated": false,
  31431. "description": "",
  31432. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#get-team",
  31433. "previews": [],
  31434. "headers": [],
  31435. "parameters": [
  31436. {
  31437. "name": "team_id",
  31438. "description": "team_id parameter",
  31439. "in": "PATH",
  31440. "type": "integer",
  31441. "required": true,
  31442. "enum": null,
  31443. "allowNull": false,
  31444. "mapToData": null,
  31445. "validation": null,
  31446. "alias": null,
  31447. "deprecated": null
  31448. }
  31449. ],
  31450. "responses": [
  31451. {
  31452. "code": 200,
  31453. "description": "response",
  31454. "examples": [
  31455. {
  31456. "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}"
  31457. }
  31458. ]
  31459. }
  31460. ],
  31461. "renamed": null
  31462. },
  31463. {
  31464. "name": "Edit team",
  31465. "scope": "teams",
  31466. "id": "update",
  31467. "method": "PATCH",
  31468. "url": "/teams/{team_id}",
  31469. "isDeprecated": false,
  31470. "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.",
  31471. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#edit-team",
  31472. "previews": [],
  31473. "headers": [],
  31474. "parameters": [
  31475. {
  31476. "name": "team_id",
  31477. "description": "team_id parameter",
  31478. "in": "PATH",
  31479. "type": "integer",
  31480. "required": true,
  31481. "enum": null,
  31482. "allowNull": false,
  31483. "mapToData": null,
  31484. "validation": null,
  31485. "alias": null,
  31486. "deprecated": null
  31487. },
  31488. {
  31489. "name": "name",
  31490. "description": "The name of the team.",
  31491. "in": "BODY",
  31492. "type": "string",
  31493. "required": true,
  31494. "enum": null,
  31495. "allowNull": false,
  31496. "mapToData": null,
  31497. "validation": null,
  31498. "alias": null,
  31499. "deprecated": null
  31500. },
  31501. {
  31502. "name": "description",
  31503. "description": "The description of the team.",
  31504. "in": "BODY",
  31505. "type": "string",
  31506. "required": false,
  31507. "enum": null,
  31508. "allowNull": false,
  31509. "mapToData": null,
  31510. "validation": null,
  31511. "alias": null,
  31512. "deprecated": null
  31513. },
  31514. {
  31515. "name": "privacy",
  31516. "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.",
  31517. "in": "BODY",
  31518. "type": "string",
  31519. "required": false,
  31520. "enum": ["secret", "closed"],
  31521. "allowNull": false,
  31522. "mapToData": null,
  31523. "validation": null,
  31524. "alias": null,
  31525. "deprecated": null
  31526. },
  31527. {
  31528. "name": "permission",
  31529. "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.",
  31530. "in": "BODY",
  31531. "type": "string",
  31532. "required": false,
  31533. "enum": ["pull", "push", "admin"],
  31534. "allowNull": false,
  31535. "mapToData": null,
  31536. "validation": null,
  31537. "alias": null,
  31538. "deprecated": null
  31539. },
  31540. {
  31541. "name": "parent_team_id",
  31542. "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.",
  31543. "in": "BODY",
  31544. "type": "integer",
  31545. "required": false,
  31546. "enum": null,
  31547. "allowNull": false,
  31548. "mapToData": null,
  31549. "validation": null,
  31550. "alias": null,
  31551. "deprecated": null
  31552. }
  31553. ],
  31554. "responses": [
  31555. {
  31556. "code": 201,
  31557. "description": "response",
  31558. "examples": [
  31559. {
  31560. "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}"
  31561. }
  31562. ]
  31563. }
  31564. ],
  31565. "renamed": null
  31566. },
  31567. {
  31568. "name": "Delete team",
  31569. "scope": "teams",
  31570. "id": "delete",
  31571. "method": "DELETE",
  31572. "url": "/teams/{team_id}",
  31573. "isDeprecated": false,
  31574. "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well.",
  31575. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#delete-team",
  31576. "previews": [],
  31577. "headers": [],
  31578. "parameters": [
  31579. {
  31580. "name": "team_id",
  31581. "description": "team_id parameter",
  31582. "in": "PATH",
  31583. "type": "integer",
  31584. "required": true,
  31585. "enum": null,
  31586. "allowNull": false,
  31587. "mapToData": null,
  31588. "validation": null,
  31589. "alias": null,
  31590. "deprecated": null
  31591. }
  31592. ],
  31593. "responses": [],
  31594. "renamed": null
  31595. },
  31596. {
  31597. "name": "List discussions",
  31598. "scope": "teams",
  31599. "id": "listDiscussions",
  31600. "method": "GET",
  31601. "url": "/teams/{team_id}/discussions",
  31602. "isDeprecated": false,
  31603. "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  31604. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussions/#list-discussions",
  31605. "previews": [{ "name": "echo" }],
  31606. "headers": [
  31607. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  31608. ],
  31609. "parameters": [
  31610. {
  31611. "name": "team_id",
  31612. "description": "team_id parameter",
  31613. "in": "PATH",
  31614. "type": "integer",
  31615. "required": true,
  31616. "enum": null,
  31617. "allowNull": false,
  31618. "mapToData": null,
  31619. "validation": null,
  31620. "alias": null,
  31621. "deprecated": null
  31622. },
  31623. {
  31624. "name": "direction",
  31625. "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.",
  31626. "in": "QUERY",
  31627. "type": "string",
  31628. "required": false,
  31629. "enum": ["asc", "desc"],
  31630. "allowNull": false,
  31631. "mapToData": null,
  31632. "validation": null,
  31633. "alias": null,
  31634. "deprecated": null
  31635. },
  31636. {
  31637. "name": "per_page",
  31638. "description": "Results per page (max 100)",
  31639. "in": "QUERY",
  31640. "type": "integer",
  31641. "required": false,
  31642. "enum": null,
  31643. "allowNull": false,
  31644. "mapToData": null,
  31645. "validation": null,
  31646. "alias": null,
  31647. "deprecated": null
  31648. },
  31649. {
  31650. "name": "page",
  31651. "description": "Page number of the results to fetch.",
  31652. "in": "QUERY",
  31653. "type": "integer",
  31654. "required": false,
  31655. "enum": null,
  31656. "allowNull": false,
  31657. "mapToData": null,
  31658. "validation": null,
  31659. "alias": null,
  31660. "deprecated": null
  31661. }
  31662. ],
  31663. "responses": [
  31664. {
  31665. "code": 200,
  31666. "description": "response",
  31667. "examples": [
  31668. {
  31669. "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"<p>Hi! This is an area for us to collaborate as a team</p>\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]"
  31670. }
  31671. ]
  31672. }
  31673. ],
  31674. "renamed": null
  31675. },
  31676. {
  31677. "name": "Create a discussion",
  31678. "scope": "teams",
  31679. "id": "createDiscussion",
  31680. "method": "POST",
  31681. "url": "/teams/{team_id}/discussions",
  31682. "isDeprecated": false,
  31683. "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  31684. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussions/#create-a-discussion",
  31685. "previews": [{ "name": "echo" }],
  31686. "headers": [
  31687. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  31688. ],
  31689. "parameters": [
  31690. {
  31691. "name": "team_id",
  31692. "description": "team_id parameter",
  31693. "in": "PATH",
  31694. "type": "integer",
  31695. "required": true,
  31696. "enum": null,
  31697. "allowNull": false,
  31698. "mapToData": null,
  31699. "validation": null,
  31700. "alias": null,
  31701. "deprecated": null
  31702. },
  31703. {
  31704. "name": "title",
  31705. "description": "The discussion post's title.",
  31706. "in": "BODY",
  31707. "type": "string",
  31708. "required": true,
  31709. "enum": null,
  31710. "allowNull": false,
  31711. "mapToData": null,
  31712. "validation": null,
  31713. "alias": null,
  31714. "deprecated": null
  31715. },
  31716. {
  31717. "name": "body",
  31718. "description": "The discussion post's body text.",
  31719. "in": "BODY",
  31720. "type": "string",
  31721. "required": true,
  31722. "enum": null,
  31723. "allowNull": false,
  31724. "mapToData": null,
  31725. "validation": null,
  31726. "alias": null,
  31727. "deprecated": null
  31728. },
  31729. {
  31730. "name": "private",
  31731. "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.",
  31732. "in": "BODY",
  31733. "type": "boolean",
  31734. "required": false,
  31735. "enum": null,
  31736. "allowNull": false,
  31737. "mapToData": null,
  31738. "validation": null,
  31739. "alias": null,
  31740. "deprecated": null
  31741. }
  31742. ],
  31743. "responses": [
  31744. {
  31745. "code": 201,
  31746. "description": "response",
  31747. "examples": [
  31748. {
  31749. "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"<p>Hi! This is an area for us to collaborate as a team</p>\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}"
  31750. }
  31751. ]
  31752. }
  31753. ],
  31754. "renamed": null
  31755. },
  31756. {
  31757. "name": "Get a single discussion",
  31758. "scope": "teams",
  31759. "id": "getDiscussion",
  31760. "method": "GET",
  31761. "url": "/teams/{team_id}/discussions/{discussion_number}",
  31762. "isDeprecated": false,
  31763. "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  31764. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussions/#get-a-single-discussion",
  31765. "previews": [{ "name": "echo" }],
  31766. "headers": [
  31767. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  31768. ],
  31769. "parameters": [
  31770. {
  31771. "name": "team_id",
  31772. "description": "team_id parameter",
  31773. "in": "PATH",
  31774. "type": "integer",
  31775. "required": true,
  31776. "enum": null,
  31777. "allowNull": false,
  31778. "mapToData": null,
  31779. "validation": null,
  31780. "alias": null,
  31781. "deprecated": null
  31782. },
  31783. {
  31784. "name": "discussion_number",
  31785. "description": "discussion_number parameter",
  31786. "in": "PATH",
  31787. "type": "integer",
  31788. "required": true,
  31789. "enum": null,
  31790. "allowNull": false,
  31791. "mapToData": null,
  31792. "validation": null,
  31793. "alias": null,
  31794. "deprecated": null
  31795. }
  31796. ],
  31797. "responses": [
  31798. {
  31799. "code": 200,
  31800. "description": "response",
  31801. "examples": [
  31802. {
  31803. "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"<p>Hi! This is an area for us to collaborate as a team</p>\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}"
  31804. }
  31805. ]
  31806. }
  31807. ],
  31808. "renamed": null
  31809. },
  31810. {
  31811. "name": "Edit a discussion",
  31812. "scope": "teams",
  31813. "id": "updateDiscussion",
  31814. "method": "PATCH",
  31815. "url": "/teams/{team_id}/discussions/{discussion_number}",
  31816. "isDeprecated": false,
  31817. "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  31818. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussions/#edit-a-discussion",
  31819. "previews": [{ "name": "echo" }],
  31820. "headers": [
  31821. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  31822. ],
  31823. "parameters": [
  31824. {
  31825. "name": "team_id",
  31826. "description": "team_id parameter",
  31827. "in": "PATH",
  31828. "type": "integer",
  31829. "required": true,
  31830. "enum": null,
  31831. "allowNull": false,
  31832. "mapToData": null,
  31833. "validation": null,
  31834. "alias": null,
  31835. "deprecated": null
  31836. },
  31837. {
  31838. "name": "discussion_number",
  31839. "description": "discussion_number parameter",
  31840. "in": "PATH",
  31841. "type": "integer",
  31842. "required": true,
  31843. "enum": null,
  31844. "allowNull": false,
  31845. "mapToData": null,
  31846. "validation": null,
  31847. "alias": null,
  31848. "deprecated": null
  31849. },
  31850. {
  31851. "name": "title",
  31852. "description": "The discussion post's title.",
  31853. "in": "BODY",
  31854. "type": "string",
  31855. "required": false,
  31856. "enum": null,
  31857. "allowNull": false,
  31858. "mapToData": null,
  31859. "validation": null,
  31860. "alias": null,
  31861. "deprecated": null
  31862. },
  31863. {
  31864. "name": "body",
  31865. "description": "The discussion post's body text.",
  31866. "in": "BODY",
  31867. "type": "string",
  31868. "required": false,
  31869. "enum": null,
  31870. "allowNull": false,
  31871. "mapToData": null,
  31872. "validation": null,
  31873. "alias": null,
  31874. "deprecated": null
  31875. }
  31876. ],
  31877. "responses": [
  31878. {
  31879. "code": 200,
  31880. "description": "response",
  31881. "examples": [
  31882. {
  31883. "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"<p>Hi! This is an area for us to collaborate as a team</p>\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}"
  31884. }
  31885. ]
  31886. }
  31887. ],
  31888. "renamed": null
  31889. },
  31890. {
  31891. "name": "Delete a discussion",
  31892. "scope": "teams",
  31893. "id": "deleteDiscussion",
  31894. "method": "DELETE",
  31895. "url": "/teams/{team_id}/discussions/{discussion_number}",
  31896. "isDeprecated": false,
  31897. "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  31898. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussions/#delete-a-discussion",
  31899. "previews": [{ "name": "echo" }],
  31900. "headers": [
  31901. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  31902. ],
  31903. "parameters": [
  31904. {
  31905. "name": "team_id",
  31906. "description": "team_id parameter",
  31907. "in": "PATH",
  31908. "type": "integer",
  31909. "required": true,
  31910. "enum": null,
  31911. "allowNull": false,
  31912. "mapToData": null,
  31913. "validation": null,
  31914. "alias": null,
  31915. "deprecated": null
  31916. },
  31917. {
  31918. "name": "discussion_number",
  31919. "description": "discussion_number parameter",
  31920. "in": "PATH",
  31921. "type": "integer",
  31922. "required": true,
  31923. "enum": null,
  31924. "allowNull": false,
  31925. "mapToData": null,
  31926. "validation": null,
  31927. "alias": null,
  31928. "deprecated": null
  31929. }
  31930. ],
  31931. "responses": [],
  31932. "renamed": null
  31933. },
  31934. {
  31935. "name": "List comments",
  31936. "scope": "teams",
  31937. "id": "listDiscussionComments",
  31938. "method": "GET",
  31939. "url": "/teams/{team_id}/discussions/{discussion_number}/comments",
  31940. "isDeprecated": false,
  31941. "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  31942. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/#list-comments",
  31943. "previews": [{ "name": "echo" }],
  31944. "headers": [
  31945. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  31946. ],
  31947. "parameters": [
  31948. {
  31949. "name": "team_id",
  31950. "description": "team_id parameter",
  31951. "in": "PATH",
  31952. "type": "integer",
  31953. "required": true,
  31954. "enum": null,
  31955. "allowNull": false,
  31956. "mapToData": null,
  31957. "validation": null,
  31958. "alias": null,
  31959. "deprecated": null
  31960. },
  31961. {
  31962. "name": "discussion_number",
  31963. "description": "discussion_number parameter",
  31964. "in": "PATH",
  31965. "type": "integer",
  31966. "required": true,
  31967. "enum": null,
  31968. "allowNull": false,
  31969. "mapToData": null,
  31970. "validation": null,
  31971. "alias": null,
  31972. "deprecated": null
  31973. },
  31974. {
  31975. "name": "direction",
  31976. "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.",
  31977. "in": "QUERY",
  31978. "type": "string",
  31979. "required": false,
  31980. "enum": ["asc", "desc"],
  31981. "allowNull": false,
  31982. "mapToData": null,
  31983. "validation": null,
  31984. "alias": null,
  31985. "deprecated": null
  31986. },
  31987. {
  31988. "name": "per_page",
  31989. "description": "Results per page (max 100)",
  31990. "in": "QUERY",
  31991. "type": "integer",
  31992. "required": false,
  31993. "enum": null,
  31994. "allowNull": false,
  31995. "mapToData": null,
  31996. "validation": null,
  31997. "alias": null,
  31998. "deprecated": null
  31999. },
  32000. {
  32001. "name": "page",
  32002. "description": "Page number of the results to fetch.",
  32003. "in": "QUERY",
  32004. "type": "integer",
  32005. "required": false,
  32006. "enum": null,
  32007. "allowNull": false,
  32008. "mapToData": null,
  32009. "validation": null,
  32010. "alias": null,
  32011. "deprecated": null
  32012. }
  32013. ],
  32014. "responses": [
  32015. {
  32016. "code": 200,
  32017. "description": "response",
  32018. "examples": [
  32019. {
  32020. "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"<p>Do you like apples?</p>\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]"
  32021. }
  32022. ]
  32023. }
  32024. ],
  32025. "renamed": null
  32026. },
  32027. {
  32028. "name": "Create a comment",
  32029. "scope": "teams",
  32030. "id": "createDiscussionComment",
  32031. "method": "POST",
  32032. "url": "/teams/{team_id}/discussions/{discussion_number}/comments",
  32033. "isDeprecated": false,
  32034. "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/enterprise/2.17/v3/#abuse-rate-limits)\" for details.",
  32035. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/#create-a-comment",
  32036. "previews": [{ "name": "echo" }],
  32037. "headers": [
  32038. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  32039. ],
  32040. "parameters": [
  32041. {
  32042. "name": "team_id",
  32043. "description": "team_id parameter",
  32044. "in": "PATH",
  32045. "type": "integer",
  32046. "required": true,
  32047. "enum": null,
  32048. "allowNull": false,
  32049. "mapToData": null,
  32050. "validation": null,
  32051. "alias": null,
  32052. "deprecated": null
  32053. },
  32054. {
  32055. "name": "discussion_number",
  32056. "description": "discussion_number parameter",
  32057. "in": "PATH",
  32058. "type": "integer",
  32059. "required": true,
  32060. "enum": null,
  32061. "allowNull": false,
  32062. "mapToData": null,
  32063. "validation": null,
  32064. "alias": null,
  32065. "deprecated": null
  32066. },
  32067. {
  32068. "name": "body",
  32069. "description": "The discussion comment's body text.",
  32070. "in": "BODY",
  32071. "type": "string",
  32072. "required": true,
  32073. "enum": null,
  32074. "allowNull": false,
  32075. "mapToData": null,
  32076. "validation": null,
  32077. "alias": null,
  32078. "deprecated": null
  32079. }
  32080. ],
  32081. "responses": [
  32082. {
  32083. "code": 201,
  32084. "description": "response",
  32085. "examples": [
  32086. {
  32087. "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"<p>Do you like apples?</p>\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}"
  32088. }
  32089. ]
  32090. }
  32091. ],
  32092. "renamed": null
  32093. },
  32094. {
  32095. "name": "Get a single comment",
  32096. "scope": "teams",
  32097. "id": "getDiscussionComment",
  32098. "method": "GET",
  32099. "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
  32100. "isDeprecated": false,
  32101. "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  32102. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/#get-a-single-comment",
  32103. "previews": [{ "name": "echo" }],
  32104. "headers": [
  32105. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  32106. ],
  32107. "parameters": [
  32108. {
  32109. "name": "team_id",
  32110. "description": "team_id parameter",
  32111. "in": "PATH",
  32112. "type": "integer",
  32113. "required": true,
  32114. "enum": null,
  32115. "allowNull": false,
  32116. "mapToData": null,
  32117. "validation": null,
  32118. "alias": null,
  32119. "deprecated": null
  32120. },
  32121. {
  32122. "name": "discussion_number",
  32123. "description": "discussion_number parameter",
  32124. "in": "PATH",
  32125. "type": "integer",
  32126. "required": true,
  32127. "enum": null,
  32128. "allowNull": false,
  32129. "mapToData": null,
  32130. "validation": null,
  32131. "alias": null,
  32132. "deprecated": null
  32133. },
  32134. {
  32135. "name": "comment_number",
  32136. "description": "comment_number parameter",
  32137. "in": "PATH",
  32138. "type": "integer",
  32139. "required": true,
  32140. "enum": null,
  32141. "allowNull": false,
  32142. "mapToData": null,
  32143. "validation": null,
  32144. "alias": null,
  32145. "deprecated": null
  32146. }
  32147. ],
  32148. "responses": [
  32149. {
  32150. "code": 200,
  32151. "description": "response",
  32152. "examples": [
  32153. {
  32154. "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"<p>Do you like apples?</p>\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}"
  32155. }
  32156. ]
  32157. }
  32158. ],
  32159. "renamed": null
  32160. },
  32161. {
  32162. "name": "Edit a comment",
  32163. "scope": "teams",
  32164. "id": "updateDiscussionComment",
  32165. "method": "PATCH",
  32166. "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
  32167. "isDeprecated": false,
  32168. "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  32169. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/#edit-a-comment",
  32170. "previews": [{ "name": "echo" }],
  32171. "headers": [
  32172. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  32173. ],
  32174. "parameters": [
  32175. {
  32176. "name": "team_id",
  32177. "description": "team_id parameter",
  32178. "in": "PATH",
  32179. "type": "integer",
  32180. "required": true,
  32181. "enum": null,
  32182. "allowNull": false,
  32183. "mapToData": null,
  32184. "validation": null,
  32185. "alias": null,
  32186. "deprecated": null
  32187. },
  32188. {
  32189. "name": "discussion_number",
  32190. "description": "discussion_number parameter",
  32191. "in": "PATH",
  32192. "type": "integer",
  32193. "required": true,
  32194. "enum": null,
  32195. "allowNull": false,
  32196. "mapToData": null,
  32197. "validation": null,
  32198. "alias": null,
  32199. "deprecated": null
  32200. },
  32201. {
  32202. "name": "comment_number",
  32203. "description": "comment_number parameter",
  32204. "in": "PATH",
  32205. "type": "integer",
  32206. "required": true,
  32207. "enum": null,
  32208. "allowNull": false,
  32209. "mapToData": null,
  32210. "validation": null,
  32211. "alias": null,
  32212. "deprecated": null
  32213. },
  32214. {
  32215. "name": "body",
  32216. "description": "The discussion comment's body text.",
  32217. "in": "BODY",
  32218. "type": "string",
  32219. "required": true,
  32220. "enum": null,
  32221. "allowNull": false,
  32222. "mapToData": null,
  32223. "validation": null,
  32224. "alias": null,
  32225. "deprecated": null
  32226. }
  32227. ],
  32228. "responses": [
  32229. {
  32230. "code": 200,
  32231. "description": "response",
  32232. "examples": [
  32233. {
  32234. "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like pineapples?\",\"body_html\":\"<p>Do you like pineapples?</p>\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}"
  32235. }
  32236. ]
  32237. }
  32238. ],
  32239. "renamed": null
  32240. },
  32241. {
  32242. "name": "Delete a comment",
  32243. "scope": "teams",
  32244. "id": "deleteDiscussionComment",
  32245. "method": "DELETE",
  32246. "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}",
  32247. "isDeprecated": false,
  32248. "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  32249. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/#delete-a-comment",
  32250. "previews": [{ "name": "echo" }],
  32251. "headers": [
  32252. { "name": "accept", "value": "application/vnd.github.echo-preview+json" }
  32253. ],
  32254. "parameters": [
  32255. {
  32256. "name": "team_id",
  32257. "description": "team_id parameter",
  32258. "in": "PATH",
  32259. "type": "integer",
  32260. "required": true,
  32261. "enum": null,
  32262. "allowNull": false,
  32263. "mapToData": null,
  32264. "validation": null,
  32265. "alias": null,
  32266. "deprecated": null
  32267. },
  32268. {
  32269. "name": "discussion_number",
  32270. "description": "discussion_number parameter",
  32271. "in": "PATH",
  32272. "type": "integer",
  32273. "required": true,
  32274. "enum": null,
  32275. "allowNull": false,
  32276. "mapToData": null,
  32277. "validation": null,
  32278. "alias": null,
  32279. "deprecated": null
  32280. },
  32281. {
  32282. "name": "comment_number",
  32283. "description": "comment_number parameter",
  32284. "in": "PATH",
  32285. "type": "integer",
  32286. "required": true,
  32287. "enum": null,
  32288. "allowNull": false,
  32289. "mapToData": null,
  32290. "validation": null,
  32291. "alias": null,
  32292. "deprecated": null
  32293. }
  32294. ],
  32295. "responses": [],
  32296. "renamed": null
  32297. },
  32298. {
  32299. "name": "List reactions for a team discussion comment",
  32300. "scope": "reactions",
  32301. "id": "listForTeamDiscussionComment",
  32302. "method": "GET",
  32303. "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
  32304. "isDeprecated": false,
  32305. "description": "List the reactions to a [team discussion comment](https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  32306. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#list-reactions-for-a-team-discussion-comment",
  32307. "previews": [{ "name": "echo" }, { "name": "squirrel-girl" }],
  32308. "headers": [
  32309. {
  32310. "name": "accept",
  32311. "value": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  32312. }
  32313. ],
  32314. "parameters": [
  32315. {
  32316. "name": "team_id",
  32317. "description": "team_id parameter",
  32318. "in": "PATH",
  32319. "type": "integer",
  32320. "required": true,
  32321. "enum": null,
  32322. "allowNull": false,
  32323. "mapToData": null,
  32324. "validation": null,
  32325. "alias": null,
  32326. "deprecated": null
  32327. },
  32328. {
  32329. "name": "discussion_number",
  32330. "description": "discussion_number parameter",
  32331. "in": "PATH",
  32332. "type": "integer",
  32333. "required": true,
  32334. "enum": null,
  32335. "allowNull": false,
  32336. "mapToData": null,
  32337. "validation": null,
  32338. "alias": null,
  32339. "deprecated": null
  32340. },
  32341. {
  32342. "name": "comment_number",
  32343. "description": "comment_number parameter",
  32344. "in": "PATH",
  32345. "type": "integer",
  32346. "required": true,
  32347. "enum": null,
  32348. "allowNull": false,
  32349. "mapToData": null,
  32350. "validation": null,
  32351. "alias": null,
  32352. "deprecated": null
  32353. },
  32354. {
  32355. "name": "content",
  32356. "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.",
  32357. "in": "QUERY",
  32358. "type": "string",
  32359. "required": false,
  32360. "enum": [
  32361. "+1",
  32362. "-1",
  32363. "laugh",
  32364. "confused",
  32365. "heart",
  32366. "hooray",
  32367. "rocket",
  32368. "eyes"
  32369. ],
  32370. "allowNull": false,
  32371. "mapToData": null,
  32372. "validation": null,
  32373. "alias": null,
  32374. "deprecated": null
  32375. },
  32376. {
  32377. "name": "per_page",
  32378. "description": "Results per page (max 100)",
  32379. "in": "QUERY",
  32380. "type": "integer",
  32381. "required": false,
  32382. "enum": null,
  32383. "allowNull": false,
  32384. "mapToData": null,
  32385. "validation": null,
  32386. "alias": null,
  32387. "deprecated": null
  32388. },
  32389. {
  32390. "name": "page",
  32391. "description": "Page number of the results to fetch.",
  32392. "in": "QUERY",
  32393. "type": "integer",
  32394. "required": false,
  32395. "enum": null,
  32396. "allowNull": false,
  32397. "mapToData": null,
  32398. "validation": null,
  32399. "alias": null,
  32400. "deprecated": null
  32401. }
  32402. ],
  32403. "responses": [
  32404. {
  32405. "code": 200,
  32406. "description": "response",
  32407. "examples": [
  32408. {
  32409. "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]"
  32410. }
  32411. ]
  32412. }
  32413. ],
  32414. "renamed": null
  32415. },
  32416. {
  32417. "name": "Create reaction for a team discussion comment",
  32418. "scope": "reactions",
  32419. "id": "createForTeamDiscussionComment",
  32420. "method": "POST",
  32421. "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions",
  32422. "isDeprecated": false,
  32423. "description": "Create a reaction to a [team discussion comment](https://developer.github.com/enterprise/2.17/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.",
  32424. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#create-reaction-for-a-team-discussion-comment",
  32425. "previews": [{ "name": "echo" }, { "name": "squirrel-girl" }],
  32426. "headers": [
  32427. {
  32428. "name": "accept",
  32429. "value": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  32430. }
  32431. ],
  32432. "parameters": [
  32433. {
  32434. "name": "team_id",
  32435. "description": "team_id parameter",
  32436. "in": "PATH",
  32437. "type": "integer",
  32438. "required": true,
  32439. "enum": null,
  32440. "allowNull": false,
  32441. "mapToData": null,
  32442. "validation": null,
  32443. "alias": null,
  32444. "deprecated": null
  32445. },
  32446. {
  32447. "name": "discussion_number",
  32448. "description": "discussion_number parameter",
  32449. "in": "PATH",
  32450. "type": "integer",
  32451. "required": true,
  32452. "enum": null,
  32453. "allowNull": false,
  32454. "mapToData": null,
  32455. "validation": null,
  32456. "alias": null,
  32457. "deprecated": null
  32458. },
  32459. {
  32460. "name": "comment_number",
  32461. "description": "comment_number parameter",
  32462. "in": "PATH",
  32463. "type": "integer",
  32464. "required": true,
  32465. "enum": null,
  32466. "allowNull": false,
  32467. "mapToData": null,
  32468. "validation": null,
  32469. "alias": null,
  32470. "deprecated": null
  32471. },
  32472. {
  32473. "name": "content",
  32474. "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the team discussion comment.",
  32475. "in": "BODY",
  32476. "type": "string",
  32477. "required": true,
  32478. "enum": [
  32479. "+1",
  32480. "-1",
  32481. "laugh",
  32482. "confused",
  32483. "heart",
  32484. "hooray",
  32485. "rocket",
  32486. "eyes"
  32487. ],
  32488. "allowNull": false,
  32489. "mapToData": null,
  32490. "validation": null,
  32491. "alias": null,
  32492. "deprecated": null
  32493. }
  32494. ],
  32495. "responses": [
  32496. {
  32497. "code": 201,
  32498. "description": "response",
  32499. "examples": [
  32500. {
  32501. "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}"
  32502. }
  32503. ]
  32504. }
  32505. ],
  32506. "renamed": null
  32507. },
  32508. {
  32509. "name": "List reactions for a team discussion",
  32510. "scope": "reactions",
  32511. "id": "listForTeamDiscussion",
  32512. "method": "GET",
  32513. "url": "/teams/{team_id}/discussions/{discussion_number}/reactions",
  32514. "isDeprecated": false,
  32515. "description": "List the reactions to a [team discussion](https://developer.github.com/enterprise/2.17/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  32516. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#list-reactions-for-a-team-discussion",
  32517. "previews": [{ "name": "echo" }, { "name": "squirrel-girl" }],
  32518. "headers": [
  32519. {
  32520. "name": "accept",
  32521. "value": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  32522. }
  32523. ],
  32524. "parameters": [
  32525. {
  32526. "name": "team_id",
  32527. "description": "team_id parameter",
  32528. "in": "PATH",
  32529. "type": "integer",
  32530. "required": true,
  32531. "enum": null,
  32532. "allowNull": false,
  32533. "mapToData": null,
  32534. "validation": null,
  32535. "alias": null,
  32536. "deprecated": null
  32537. },
  32538. {
  32539. "name": "discussion_number",
  32540. "description": "discussion_number parameter",
  32541. "in": "PATH",
  32542. "type": "integer",
  32543. "required": true,
  32544. "enum": null,
  32545. "allowNull": false,
  32546. "mapToData": null,
  32547. "validation": null,
  32548. "alias": null,
  32549. "deprecated": null
  32550. },
  32551. {
  32552. "name": "content",
  32553. "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.",
  32554. "in": "QUERY",
  32555. "type": "string",
  32556. "required": false,
  32557. "enum": [
  32558. "+1",
  32559. "-1",
  32560. "laugh",
  32561. "confused",
  32562. "heart",
  32563. "hooray",
  32564. "rocket",
  32565. "eyes"
  32566. ],
  32567. "allowNull": false,
  32568. "mapToData": null,
  32569. "validation": null,
  32570. "alias": null,
  32571. "deprecated": null
  32572. },
  32573. {
  32574. "name": "per_page",
  32575. "description": "Results per page (max 100)",
  32576. "in": "QUERY",
  32577. "type": "integer",
  32578. "required": false,
  32579. "enum": null,
  32580. "allowNull": false,
  32581. "mapToData": null,
  32582. "validation": null,
  32583. "alias": null,
  32584. "deprecated": null
  32585. },
  32586. {
  32587. "name": "page",
  32588. "description": "Page number of the results to fetch.",
  32589. "in": "QUERY",
  32590. "type": "integer",
  32591. "required": false,
  32592. "enum": null,
  32593. "allowNull": false,
  32594. "mapToData": null,
  32595. "validation": null,
  32596. "alias": null,
  32597. "deprecated": null
  32598. }
  32599. ],
  32600. "responses": [
  32601. {
  32602. "code": 200,
  32603. "description": "response",
  32604. "examples": [
  32605. {
  32606. "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]"
  32607. }
  32608. ]
  32609. }
  32610. ],
  32611. "renamed": null
  32612. },
  32613. {
  32614. "name": "Create reaction for a team discussion",
  32615. "scope": "reactions",
  32616. "id": "createForTeamDiscussion",
  32617. "method": "POST",
  32618. "url": "/teams/{team_id}/discussions/{discussion_number}/reactions",
  32619. "isDeprecated": false,
  32620. "description": "Create a reaction to a [team discussion](https://developer.github.com/enterprise/2.17/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.",
  32621. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/reactions/#create-reaction-for-a-team-discussion",
  32622. "previews": [{ "name": "echo" }, { "name": "squirrel-girl" }],
  32623. "headers": [
  32624. {
  32625. "name": "accept",
  32626. "value": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json"
  32627. }
  32628. ],
  32629. "parameters": [
  32630. {
  32631. "name": "team_id",
  32632. "description": "team_id parameter",
  32633. "in": "PATH",
  32634. "type": "integer",
  32635. "required": true,
  32636. "enum": null,
  32637. "allowNull": false,
  32638. "mapToData": null,
  32639. "validation": null,
  32640. "alias": null,
  32641. "deprecated": null
  32642. },
  32643. {
  32644. "name": "discussion_number",
  32645. "description": "discussion_number parameter",
  32646. "in": "PATH",
  32647. "type": "integer",
  32648. "required": true,
  32649. "enum": null,
  32650. "allowNull": false,
  32651. "mapToData": null,
  32652. "validation": null,
  32653. "alias": null,
  32654. "deprecated": null
  32655. },
  32656. {
  32657. "name": "content",
  32658. "description": "The [reaction type](https://developer.github.com/enterprise/2.17/v3/reactions/#reaction-types) to add to the team discussion.",
  32659. "in": "BODY",
  32660. "type": "string",
  32661. "required": true,
  32662. "enum": [
  32663. "+1",
  32664. "-1",
  32665. "laugh",
  32666. "confused",
  32667. "heart",
  32668. "hooray",
  32669. "rocket",
  32670. "eyes"
  32671. ],
  32672. "allowNull": false,
  32673. "mapToData": null,
  32674. "validation": null,
  32675. "alias": null,
  32676. "deprecated": null
  32677. }
  32678. ],
  32679. "responses": [
  32680. {
  32681. "code": 201,
  32682. "description": "response",
  32683. "examples": [
  32684. {
  32685. "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}"
  32686. }
  32687. ]
  32688. }
  32689. ],
  32690. "renamed": null
  32691. },
  32692. {
  32693. "name": "List team members",
  32694. "scope": "teams",
  32695. "id": "listMembers",
  32696. "method": "GET",
  32697. "url": "/teams/{team_id}/members",
  32698. "isDeprecated": false,
  32699. "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.",
  32700. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#list-team-members",
  32701. "previews": [],
  32702. "headers": [],
  32703. "parameters": [
  32704. {
  32705. "name": "team_id",
  32706. "description": "team_id parameter",
  32707. "in": "PATH",
  32708. "type": "integer",
  32709. "required": true,
  32710. "enum": null,
  32711. "allowNull": false,
  32712. "mapToData": null,
  32713. "validation": null,
  32714. "alias": null,
  32715. "deprecated": null
  32716. },
  32717. {
  32718. "name": "role",
  32719. "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.",
  32720. "in": "QUERY",
  32721. "type": "string",
  32722. "required": false,
  32723. "enum": ["member", "maintainer", "all"],
  32724. "allowNull": false,
  32725. "mapToData": null,
  32726. "validation": null,
  32727. "alias": null,
  32728. "deprecated": null
  32729. },
  32730. {
  32731. "name": "per_page",
  32732. "description": "Results per page (max 100)",
  32733. "in": "QUERY",
  32734. "type": "integer",
  32735. "required": false,
  32736. "enum": null,
  32737. "allowNull": false,
  32738. "mapToData": null,
  32739. "validation": null,
  32740. "alias": null,
  32741. "deprecated": null
  32742. },
  32743. {
  32744. "name": "page",
  32745. "description": "Page number of the results to fetch.",
  32746. "in": "QUERY",
  32747. "type": "integer",
  32748. "required": false,
  32749. "enum": null,
  32750. "allowNull": false,
  32751. "mapToData": null,
  32752. "validation": null,
  32753. "alias": null,
  32754. "deprecated": null
  32755. }
  32756. ],
  32757. "responses": [
  32758. {
  32759. "code": 200,
  32760. "description": "response",
  32761. "examples": [
  32762. {
  32763. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  32764. }
  32765. ]
  32766. }
  32767. ],
  32768. "renamed": null
  32769. },
  32770. {
  32771. "name": "Get team member",
  32772. "scope": "teams",
  32773. "id": "getMember",
  32774. "method": "GET",
  32775. "url": "/teams/{team_id}/members/{username}",
  32776. "isDeprecated": true,
  32777. "description": "The \"Get team member\" API (described below) is deprecated.\n\nWe recommend using the [Get team membership API](https://developer.github.com/enterprise/2.17/v3/teams/members/#get-team-membership) instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.",
  32778. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#get-team-member",
  32779. "previews": [],
  32780. "headers": [],
  32781. "parameters": [
  32782. {
  32783. "name": "team_id",
  32784. "description": "team_id parameter",
  32785. "in": "PATH",
  32786. "type": "integer",
  32787. "required": true,
  32788. "enum": null,
  32789. "allowNull": false,
  32790. "mapToData": null,
  32791. "validation": null,
  32792. "alias": null,
  32793. "deprecated": null
  32794. },
  32795. {
  32796. "name": "username",
  32797. "description": "username parameter",
  32798. "in": "PATH",
  32799. "type": "string",
  32800. "required": true,
  32801. "enum": null,
  32802. "allowNull": false,
  32803. "mapToData": null,
  32804. "validation": null,
  32805. "alias": null,
  32806. "deprecated": null
  32807. }
  32808. ],
  32809. "responses": [],
  32810. "renamed": null
  32811. },
  32812. {
  32813. "name": "Add team member",
  32814. "scope": "teams",
  32815. "id": "addMember",
  32816. "method": "PUT",
  32817. "url": "/teams/{team_id}/members/{username}",
  32818. "isDeprecated": true,
  32819. "description": "The \"Add team member\" API (described below) is deprecated.\n\nWe recommend using the [Add team membership API](https://developer.github.com/enterprise/2.17/v3/teams/members/#add-or-update-team-membership) instead. It allows you to invite new organization members to your teams.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  32820. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#add-team-member",
  32821. "previews": [],
  32822. "headers": [],
  32823. "parameters": [
  32824. {
  32825. "name": "team_id",
  32826. "description": "team_id parameter",
  32827. "in": "PATH",
  32828. "type": "integer",
  32829. "required": true,
  32830. "enum": null,
  32831. "allowNull": false,
  32832. "mapToData": null,
  32833. "validation": null,
  32834. "alias": null,
  32835. "deprecated": null
  32836. },
  32837. {
  32838. "name": "username",
  32839. "description": "username parameter",
  32840. "in": "PATH",
  32841. "type": "string",
  32842. "required": true,
  32843. "enum": null,
  32844. "allowNull": false,
  32845. "mapToData": null,
  32846. "validation": null,
  32847. "alias": null,
  32848. "deprecated": null
  32849. }
  32850. ],
  32851. "responses": [
  32852. {
  32853. "code": 422,
  32854. "description": "response",
  32855. "examples": [
  32856. {
  32857. "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}"
  32858. },
  32859. {
  32860. "data": "{\"message\":\"User isn't a member of this organization. Please invite them first.\",\"errors\":[{\"code\":\"unaffiliated\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}"
  32861. }
  32862. ]
  32863. }
  32864. ],
  32865. "renamed": null
  32866. },
  32867. {
  32868. "name": "Remove team member",
  32869. "scope": "teams",
  32870. "id": "removeMember",
  32871. "method": "DELETE",
  32872. "url": "/teams/{team_id}/members/{username}",
  32873. "isDeprecated": true,
  32874. "description": "The \"Remove team member\" API (described below) is deprecated.\n\nWe recommend using the [Remove team membership endpoint](https://developer.github.com/enterprise/2.17/v3/teams/members/#remove-team-membership) instead. It allows you to remove both active and pending memberships.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.",
  32875. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#remove-team-member",
  32876. "previews": [],
  32877. "headers": [],
  32878. "parameters": [
  32879. {
  32880. "name": "team_id",
  32881. "description": "team_id parameter",
  32882. "in": "PATH",
  32883. "type": "integer",
  32884. "required": true,
  32885. "enum": null,
  32886. "allowNull": false,
  32887. "mapToData": null,
  32888. "validation": null,
  32889. "alias": null,
  32890. "deprecated": null
  32891. },
  32892. {
  32893. "name": "username",
  32894. "description": "username parameter",
  32895. "in": "PATH",
  32896. "type": "string",
  32897. "required": true,
  32898. "enum": null,
  32899. "allowNull": false,
  32900. "mapToData": null,
  32901. "validation": null,
  32902. "alias": null,
  32903. "deprecated": null
  32904. }
  32905. ],
  32906. "responses": [],
  32907. "renamed": null
  32908. },
  32909. {
  32910. "name": "Get team membership",
  32911. "scope": "teams",
  32912. "id": "getMembership",
  32913. "method": "GET",
  32914. "url": "/teams/{team_id}/memberships/{username}",
  32915. "isDeprecated": false,
  32916. "description": "If you pass the `hellcat-preview` media type, team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/enterprise/2.17/v3/teams#create-team).",
  32917. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#get-team-membership",
  32918. "previews": [],
  32919. "headers": [],
  32920. "parameters": [
  32921. {
  32922. "name": "team_id",
  32923. "description": "team_id parameter",
  32924. "in": "PATH",
  32925. "type": "integer",
  32926. "required": true,
  32927. "enum": null,
  32928. "allowNull": false,
  32929. "mapToData": null,
  32930. "validation": null,
  32931. "alias": null,
  32932. "deprecated": null
  32933. },
  32934. {
  32935. "name": "username",
  32936. "description": "username parameter",
  32937. "in": "PATH",
  32938. "type": "string",
  32939. "required": true,
  32940. "enum": null,
  32941. "allowNull": false,
  32942. "mapToData": null,
  32943. "validation": null,
  32944. "alias": null,
  32945. "deprecated": null
  32946. }
  32947. ],
  32948. "responses": [
  32949. {
  32950. "code": 200,
  32951. "description": "response",
  32952. "examples": [
  32953. {
  32954. "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}"
  32955. },
  32956. {
  32957. "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}"
  32958. },
  32959. {
  32960. "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}"
  32961. }
  32962. ]
  32963. }
  32964. ],
  32965. "renamed": null
  32966. },
  32967. {
  32968. "name": "Add or update team membership",
  32969. "scope": "teams",
  32970. "id": "addOrUpdateMembership",
  32971. "method": "PUT",
  32972. "url": "/teams/{team_id}/memberships/{username}",
  32973. "isDeprecated": false,
  32974. "description": "If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.",
  32975. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#add-or-update-team-membership",
  32976. "previews": [],
  32977. "headers": [],
  32978. "parameters": [
  32979. {
  32980. "name": "team_id",
  32981. "description": "team_id parameter",
  32982. "in": "PATH",
  32983. "type": "integer",
  32984. "required": true,
  32985. "enum": null,
  32986. "allowNull": false,
  32987. "mapToData": null,
  32988. "validation": null,
  32989. "alias": null,
  32990. "deprecated": null
  32991. },
  32992. {
  32993. "name": "username",
  32994. "description": "username parameter",
  32995. "in": "PATH",
  32996. "type": "string",
  32997. "required": true,
  32998. "enum": null,
  32999. "allowNull": false,
  33000. "mapToData": null,
  33001. "validation": null,
  33002. "alias": null,
  33003. "deprecated": null
  33004. },
  33005. {
  33006. "name": "role",
  33007. "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.",
  33008. "in": "BODY",
  33009. "type": "string",
  33010. "required": false,
  33011. "enum": ["member", "maintainer"],
  33012. "allowNull": false,
  33013. "mapToData": null,
  33014. "validation": null,
  33015. "alias": null,
  33016. "deprecated": null
  33017. }
  33018. ],
  33019. "responses": [
  33020. {
  33021. "code": 200,
  33022. "description": "response",
  33023. "examples": [
  33024. {
  33025. "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}"
  33026. },
  33027. {
  33028. "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}"
  33029. }
  33030. ]
  33031. },
  33032. {
  33033. "code": 422,
  33034. "description": "Response if you attempt to add an organization to a team",
  33035. "examples": [
  33036. {
  33037. "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}"
  33038. }
  33039. ]
  33040. }
  33041. ],
  33042. "renamed": null
  33043. },
  33044. {
  33045. "name": "Remove team membership",
  33046. "scope": "teams",
  33047. "id": "removeMembership",
  33048. "method": "DELETE",
  33049. "url": "/teams/{team_id}/memberships/{username}",
  33050. "isDeprecated": false,
  33051. "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.",
  33052. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/members/#remove-team-membership",
  33053. "previews": [],
  33054. "headers": [],
  33055. "parameters": [
  33056. {
  33057. "name": "team_id",
  33058. "description": "team_id parameter",
  33059. "in": "PATH",
  33060. "type": "integer",
  33061. "required": true,
  33062. "enum": null,
  33063. "allowNull": false,
  33064. "mapToData": null,
  33065. "validation": null,
  33066. "alias": null,
  33067. "deprecated": null
  33068. },
  33069. {
  33070. "name": "username",
  33071. "description": "username parameter",
  33072. "in": "PATH",
  33073. "type": "string",
  33074. "required": true,
  33075. "enum": null,
  33076. "allowNull": false,
  33077. "mapToData": null,
  33078. "validation": null,
  33079. "alias": null,
  33080. "deprecated": null
  33081. }
  33082. ],
  33083. "responses": [],
  33084. "renamed": null
  33085. },
  33086. {
  33087. "name": "List team projects",
  33088. "scope": "teams",
  33089. "id": "listProjects",
  33090. "method": "GET",
  33091. "url": "/teams/{team_id}/projects",
  33092. "isDeprecated": false,
  33093. "description": "Lists the organization projects for a team. If you are an [authenticated](https://developer.github.com/enterprise/2.17/v3/#authentication) site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
  33094. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#list-team-projects",
  33095. "previews": [{ "name": "inertia" }],
  33096. "headers": [
  33097. {
  33098. "name": "accept",
  33099. "value": "application/vnd.github.inertia-preview+json"
  33100. }
  33101. ],
  33102. "parameters": [
  33103. {
  33104. "name": "team_id",
  33105. "description": "team_id parameter",
  33106. "in": "PATH",
  33107. "type": "integer",
  33108. "required": true,
  33109. "enum": null,
  33110. "allowNull": false,
  33111. "mapToData": null,
  33112. "validation": null,
  33113. "alias": null,
  33114. "deprecated": null
  33115. },
  33116. {
  33117. "name": "per_page",
  33118. "description": "Results per page (max 100)",
  33119. "in": "QUERY",
  33120. "type": "integer",
  33121. "required": false,
  33122. "enum": null,
  33123. "allowNull": false,
  33124. "mapToData": null,
  33125. "validation": null,
  33126. "alias": null,
  33127. "deprecated": null
  33128. },
  33129. {
  33130. "name": "page",
  33131. "description": "Page number of the results to fetch.",
  33132. "in": "QUERY",
  33133. "type": "integer",
  33134. "required": false,
  33135. "enum": null,
  33136. "allowNull": false,
  33137. "mapToData": null,
  33138. "validation": null,
  33139. "alias": null,
  33140. "deprecated": null
  33141. }
  33142. ],
  33143. "responses": [
  33144. {
  33145. "code": 200,
  33146. "description": "response",
  33147. "examples": [
  33148. {
  33149. "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]"
  33150. }
  33151. ]
  33152. }
  33153. ],
  33154. "renamed": null
  33155. },
  33156. {
  33157. "name": "Review a team project",
  33158. "scope": "teams",
  33159. "id": "reviewProject",
  33160. "method": "GET",
  33161. "url": "/teams/{team_id}/projects/{project_id}",
  33162. "isDeprecated": false,
  33163. "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.",
  33164. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#review-a-team-project",
  33165. "previews": [{ "name": "inertia" }],
  33166. "headers": [
  33167. {
  33168. "name": "accept",
  33169. "value": "application/vnd.github.inertia-preview+json"
  33170. }
  33171. ],
  33172. "parameters": [
  33173. {
  33174. "name": "team_id",
  33175. "description": "team_id parameter",
  33176. "in": "PATH",
  33177. "type": "integer",
  33178. "required": true,
  33179. "enum": null,
  33180. "allowNull": false,
  33181. "mapToData": null,
  33182. "validation": null,
  33183. "alias": null,
  33184. "deprecated": null
  33185. },
  33186. {
  33187. "name": "project_id",
  33188. "description": "project_id parameter",
  33189. "in": "PATH",
  33190. "type": "integer",
  33191. "required": true,
  33192. "enum": null,
  33193. "allowNull": false,
  33194. "mapToData": null,
  33195. "validation": null,
  33196. "alias": null,
  33197. "deprecated": null
  33198. }
  33199. ],
  33200. "responses": [
  33201. {
  33202. "code": 200,
  33203. "description": "response",
  33204. "examples": [
  33205. {
  33206. "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}"
  33207. }
  33208. ]
  33209. }
  33210. ],
  33211. "renamed": null
  33212. },
  33213. {
  33214. "name": "Add or update team project",
  33215. "scope": "teams",
  33216. "id": "addOrUpdateProject",
  33217. "method": "PUT",
  33218. "url": "/teams/{team_id}/projects/{project_id}",
  33219. "isDeprecated": false,
  33220. "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.",
  33221. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#add-or-update-team-project",
  33222. "previews": [{ "name": "inertia" }],
  33223. "headers": [
  33224. {
  33225. "name": "accept",
  33226. "value": "application/vnd.github.inertia-preview+json"
  33227. }
  33228. ],
  33229. "parameters": [
  33230. {
  33231. "name": "team_id",
  33232. "description": "team_id parameter",
  33233. "in": "PATH",
  33234. "type": "integer",
  33235. "required": true,
  33236. "enum": null,
  33237. "allowNull": false,
  33238. "mapToData": null,
  33239. "validation": null,
  33240. "alias": null,
  33241. "deprecated": null
  33242. },
  33243. {
  33244. "name": "project_id",
  33245. "description": "project_id parameter",
  33246. "in": "PATH",
  33247. "type": "integer",
  33248. "required": true,
  33249. "enum": null,
  33250. "allowNull": false,
  33251. "mapToData": null,
  33252. "validation": null,
  33253. "alias": null,
  33254. "deprecated": null
  33255. },
  33256. {
  33257. "name": "permission",
  33258. "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.",
  33259. "in": "BODY",
  33260. "type": "string",
  33261. "required": false,
  33262. "enum": ["read", "write", "admin"],
  33263. "allowNull": false,
  33264. "mapToData": null,
  33265. "validation": null,
  33266. "alias": null,
  33267. "deprecated": null
  33268. }
  33269. ],
  33270. "responses": [
  33271. {
  33272. "code": 403,
  33273. "description": "Response if the project is not owned by the organization",
  33274. "examples": [
  33275. {
  33276. "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://developer.github.com/enterprise/2.17/v3/teams/#add-or-update-team-project\"}"
  33277. }
  33278. ]
  33279. }
  33280. ],
  33281. "renamed": null
  33282. },
  33283. {
  33284. "name": "Remove team project",
  33285. "scope": "teams",
  33286. "id": "removeProject",
  33287. "method": "DELETE",
  33288. "url": "/teams/{team_id}/projects/{project_id}",
  33289. "isDeprecated": false,
  33290. "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.",
  33291. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#remove-team-project",
  33292. "previews": [],
  33293. "headers": [],
  33294. "parameters": [
  33295. {
  33296. "name": "team_id",
  33297. "description": "team_id parameter",
  33298. "in": "PATH",
  33299. "type": "integer",
  33300. "required": true,
  33301. "enum": null,
  33302. "allowNull": false,
  33303. "mapToData": null,
  33304. "validation": null,
  33305. "alias": null,
  33306. "deprecated": null
  33307. },
  33308. {
  33309. "name": "project_id",
  33310. "description": "project_id parameter",
  33311. "in": "PATH",
  33312. "type": "integer",
  33313. "required": true,
  33314. "enum": null,
  33315. "allowNull": false,
  33316. "mapToData": null,
  33317. "validation": null,
  33318. "alias": null,
  33319. "deprecated": null
  33320. }
  33321. ],
  33322. "responses": [],
  33323. "renamed": null
  33324. },
  33325. {
  33326. "name": "List team repos",
  33327. "scope": "teams",
  33328. "id": "listRepos",
  33329. "method": "GET",
  33330. "url": "/teams/{team_id}/repos",
  33331. "isDeprecated": false,
  33332. "description": "**Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team.\n\nIf you are an [authenticated](https://developer.github.com/enterprise/2.17/v3/#authentication) site administrator for your Enterprise instance, you will be able to list all repositories for the team.",
  33333. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#list-team-repos",
  33334. "previews": [],
  33335. "headers": [],
  33336. "parameters": [
  33337. {
  33338. "name": "team_id",
  33339. "description": "team_id parameter",
  33340. "in": "PATH",
  33341. "type": "integer",
  33342. "required": true,
  33343. "enum": null,
  33344. "allowNull": false,
  33345. "mapToData": null,
  33346. "validation": null,
  33347. "alias": null,
  33348. "deprecated": null
  33349. },
  33350. {
  33351. "name": "per_page",
  33352. "description": "Results per page (max 100)",
  33353. "in": "QUERY",
  33354. "type": "integer",
  33355. "required": false,
  33356. "enum": null,
  33357. "allowNull": false,
  33358. "mapToData": null,
  33359. "validation": null,
  33360. "alias": null,
  33361. "deprecated": null
  33362. },
  33363. {
  33364. "name": "page",
  33365. "description": "Page number of the results to fetch.",
  33366. "in": "QUERY",
  33367. "type": "integer",
  33368. "required": false,
  33369. "enum": null,
  33370. "allowNull": false,
  33371. "mapToData": null,
  33372. "validation": null,
  33373. "alias": null,
  33374. "deprecated": null
  33375. }
  33376. ],
  33377. "responses": [
  33378. {
  33379. "code": 200,
  33380. "description": "response",
  33381. "examples": [
  33382. {
  33383. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]"
  33384. }
  33385. ]
  33386. }
  33387. ],
  33388. "renamed": null
  33389. },
  33390. {
  33391. "name": "Check if a team manages a repository",
  33392. "scope": "teams",
  33393. "id": "checkManagesRepo",
  33394. "method": "GET",
  33395. "url": "/teams/{team_id}/repos/{owner}/{repo}",
  33396. "isDeprecated": false,
  33397. "description": "**Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/enterprise/2.17/v3/media/) via the `Accept` header:",
  33398. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#check-if-a-team-manages-a-repository",
  33399. "previews": [],
  33400. "headers": [],
  33401. "parameters": [
  33402. {
  33403. "name": "team_id",
  33404. "description": "team_id parameter",
  33405. "in": "PATH",
  33406. "type": "integer",
  33407. "required": true,
  33408. "enum": null,
  33409. "allowNull": false,
  33410. "mapToData": null,
  33411. "validation": null,
  33412. "alias": null,
  33413. "deprecated": null
  33414. },
  33415. {
  33416. "name": "owner",
  33417. "description": "owner parameter",
  33418. "in": "PATH",
  33419. "type": "string",
  33420. "required": true,
  33421. "enum": null,
  33422. "allowNull": false,
  33423. "mapToData": null,
  33424. "validation": null,
  33425. "alias": null,
  33426. "deprecated": null
  33427. },
  33428. {
  33429. "name": "repo",
  33430. "description": "repo parameter",
  33431. "in": "PATH",
  33432. "type": "string",
  33433. "required": true,
  33434. "enum": null,
  33435. "allowNull": false,
  33436. "mapToData": null,
  33437. "validation": null,
  33438. "alias": null,
  33439. "deprecated": null
  33440. }
  33441. ],
  33442. "responses": [
  33443. {
  33444. "code": 200,
  33445. "description": "Alternative response with extra repository information",
  33446. "examples": [
  33447. {
  33448. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}"
  33449. }
  33450. ]
  33451. }
  33452. ],
  33453. "renamed": null
  33454. },
  33455. {
  33456. "name": "Add or update team repository",
  33457. "scope": "teams",
  33458. "id": "addOrUpdateRepo",
  33459. "method": "PUT",
  33460. "url": "/teams/{team_id}/repos/{owner}/{repo}",
  33461. "isDeprecated": false,
  33462. "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  33463. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#add-or-update-team-repository",
  33464. "previews": [],
  33465. "headers": [],
  33466. "parameters": [
  33467. {
  33468. "name": "team_id",
  33469. "description": "team_id parameter",
  33470. "in": "PATH",
  33471. "type": "integer",
  33472. "required": true,
  33473. "enum": null,
  33474. "allowNull": false,
  33475. "mapToData": null,
  33476. "validation": null,
  33477. "alias": null,
  33478. "deprecated": null
  33479. },
  33480. {
  33481. "name": "owner",
  33482. "description": "owner parameter",
  33483. "in": "PATH",
  33484. "type": "string",
  33485. "required": true,
  33486. "enum": null,
  33487. "allowNull": false,
  33488. "mapToData": null,
  33489. "validation": null,
  33490. "alias": null,
  33491. "deprecated": null
  33492. },
  33493. {
  33494. "name": "repo",
  33495. "description": "repo parameter",
  33496. "in": "PATH",
  33497. "type": "string",
  33498. "required": true,
  33499. "enum": null,
  33500. "allowNull": false,
  33501. "mapToData": null,
  33502. "validation": null,
  33503. "alias": null,
  33504. "deprecated": null
  33505. },
  33506. {
  33507. "name": "permission",
  33508. "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.",
  33509. "in": "BODY",
  33510. "type": "string",
  33511. "required": false,
  33512. "enum": ["pull", "push", "admin"],
  33513. "allowNull": false,
  33514. "mapToData": null,
  33515. "validation": null,
  33516. "alias": null,
  33517. "deprecated": null
  33518. }
  33519. ],
  33520. "responses": [],
  33521. "renamed": null
  33522. },
  33523. {
  33524. "name": "Remove team repository",
  33525. "scope": "teams",
  33526. "id": "removeRepo",
  33527. "method": "DELETE",
  33528. "url": "/teams/{team_id}/repos/{owner}/{repo}",
  33529. "isDeprecated": false,
  33530. "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.",
  33531. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#remove-team-repository",
  33532. "previews": [],
  33533. "headers": [],
  33534. "parameters": [
  33535. {
  33536. "name": "team_id",
  33537. "description": "team_id parameter",
  33538. "in": "PATH",
  33539. "type": "integer",
  33540. "required": true,
  33541. "enum": null,
  33542. "allowNull": false,
  33543. "mapToData": null,
  33544. "validation": null,
  33545. "alias": null,
  33546. "deprecated": null
  33547. },
  33548. {
  33549. "name": "owner",
  33550. "description": "owner parameter",
  33551. "in": "PATH",
  33552. "type": "string",
  33553. "required": true,
  33554. "enum": null,
  33555. "allowNull": false,
  33556. "mapToData": null,
  33557. "validation": null,
  33558. "alias": null,
  33559. "deprecated": null
  33560. },
  33561. {
  33562. "name": "repo",
  33563. "description": "repo parameter",
  33564. "in": "PATH",
  33565. "type": "string",
  33566. "required": true,
  33567. "enum": null,
  33568. "allowNull": false,
  33569. "mapToData": null,
  33570. "validation": null,
  33571. "alias": null,
  33572. "deprecated": null
  33573. }
  33574. ],
  33575. "responses": [],
  33576. "renamed": null
  33577. },
  33578. {
  33579. "name": "List child teams",
  33580. "scope": "teams",
  33581. "id": "listChild",
  33582. "method": "GET",
  33583. "url": "/teams/{team_id}/teams",
  33584. "isDeprecated": false,
  33585. "description": "At this time, the `hellcat-preview` media type is required to use this endpoint.\n\n",
  33586. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#list-child-teams",
  33587. "previews": [{ "name": "hellcat" }],
  33588. "headers": [
  33589. {
  33590. "name": "accept",
  33591. "value": "application/vnd.github.hellcat-preview+json"
  33592. }
  33593. ],
  33594. "parameters": [
  33595. {
  33596. "name": "team_id",
  33597. "description": "team_id parameter",
  33598. "in": "PATH",
  33599. "type": "integer",
  33600. "required": true,
  33601. "enum": null,
  33602. "allowNull": false,
  33603. "mapToData": null,
  33604. "validation": null,
  33605. "alias": null,
  33606. "deprecated": null
  33607. },
  33608. {
  33609. "name": "per_page",
  33610. "description": "Results per page (max 100)",
  33611. "in": "QUERY",
  33612. "type": "integer",
  33613. "required": false,
  33614. "enum": null,
  33615. "allowNull": false,
  33616. "mapToData": null,
  33617. "validation": null,
  33618. "alias": null,
  33619. "deprecated": null
  33620. },
  33621. {
  33622. "name": "page",
  33623. "description": "Page number of the results to fetch.",
  33624. "in": "QUERY",
  33625. "type": "integer",
  33626. "required": false,
  33627. "enum": null,
  33628. "allowNull": false,
  33629. "mapToData": null,
  33630. "validation": null,
  33631. "alias": null,
  33632. "deprecated": null
  33633. }
  33634. ],
  33635. "responses": [
  33636. {
  33637. "code": 200,
  33638. "description": "Response if child teams exist",
  33639. "examples": [
  33640. {
  33641. "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}}]"
  33642. }
  33643. ]
  33644. }
  33645. ],
  33646. "renamed": null
  33647. },
  33648. {
  33649. "name": "Get the authenticated user",
  33650. "scope": "users",
  33651. "id": "getAuthenticated",
  33652. "method": "GET",
  33653. "url": "/user",
  33654. "isDeprecated": false,
  33655. "description": "Lists public and private profile information when authenticated through basic auth or OAuth with the `user` scope.\n\nLists public profile information when authenticated through OAuth without the `user` scope.",
  33656. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/#get-the-authenticated-user",
  33657. "previews": [],
  33658. "headers": [],
  33659. "parameters": [],
  33660. "responses": [
  33661. {
  33662. "code": 200,
  33663. "description": "response",
  33664. "examples": [
  33665. {
  33666. "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0},\"suspended_at\":null}"
  33667. },
  33668. {
  33669. "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}"
  33670. }
  33671. ]
  33672. }
  33673. ],
  33674. "renamed": null
  33675. },
  33676. {
  33677. "name": "Update the authenticated user",
  33678. "scope": "users",
  33679. "id": "updateAuthenticated",
  33680. "method": "PATCH",
  33681. "url": "/user",
  33682. "isDeprecated": false,
  33683. "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.",
  33684. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/#update-the-authenticated-user",
  33685. "previews": [],
  33686. "headers": [],
  33687. "parameters": [
  33688. {
  33689. "name": "name",
  33690. "description": "The new name of the user.",
  33691. "in": "BODY",
  33692. "type": "string",
  33693. "required": false,
  33694. "enum": null,
  33695. "allowNull": false,
  33696. "mapToData": null,
  33697. "validation": null,
  33698. "alias": null,
  33699. "deprecated": null
  33700. },
  33701. {
  33702. "name": "email",
  33703. "description": "The publicly visible email address of the user.",
  33704. "in": "BODY",
  33705. "type": "string",
  33706. "required": false,
  33707. "enum": null,
  33708. "allowNull": false,
  33709. "mapToData": null,
  33710. "validation": null,
  33711. "alias": null,
  33712. "deprecated": null
  33713. },
  33714. {
  33715. "name": "blog",
  33716. "description": "The new blog URL of the user.",
  33717. "in": "BODY",
  33718. "type": "string",
  33719. "required": false,
  33720. "enum": null,
  33721. "allowNull": false,
  33722. "mapToData": null,
  33723. "validation": null,
  33724. "alias": null,
  33725. "deprecated": null
  33726. },
  33727. {
  33728. "name": "company",
  33729. "description": "The new company of the user.",
  33730. "in": "BODY",
  33731. "type": "string",
  33732. "required": false,
  33733. "enum": null,
  33734. "allowNull": false,
  33735. "mapToData": null,
  33736. "validation": null,
  33737. "alias": null,
  33738. "deprecated": null
  33739. },
  33740. {
  33741. "name": "location",
  33742. "description": "The new location of the user.",
  33743. "in": "BODY",
  33744. "type": "string",
  33745. "required": false,
  33746. "enum": null,
  33747. "allowNull": false,
  33748. "mapToData": null,
  33749. "validation": null,
  33750. "alias": null,
  33751. "deprecated": null
  33752. },
  33753. {
  33754. "name": "hireable",
  33755. "description": "The new hiring availability of the user.",
  33756. "in": "BODY",
  33757. "type": "boolean",
  33758. "required": false,
  33759. "enum": null,
  33760. "allowNull": false,
  33761. "mapToData": null,
  33762. "validation": null,
  33763. "alias": null,
  33764. "deprecated": null
  33765. },
  33766. {
  33767. "name": "bio",
  33768. "description": "The new short biography of the user.",
  33769. "in": "BODY",
  33770. "type": "string",
  33771. "required": false,
  33772. "enum": null,
  33773. "allowNull": false,
  33774. "mapToData": null,
  33775. "validation": null,
  33776. "alias": null,
  33777. "deprecated": null
  33778. }
  33779. ],
  33780. "responses": [
  33781. {
  33782. "code": 200,
  33783. "description": "response",
  33784. "examples": [
  33785. {
  33786. "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\",\"private_gists\":81,\"total_private_repos\":100,\"owned_private_repos\":100,\"disk_usage\":10000,\"collaborators\":8,\"two_factor_authentication\":true,\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20,\"collaborators\":0},\"suspended_at\":null}"
  33787. }
  33788. ]
  33789. }
  33790. ],
  33791. "renamed": null
  33792. },
  33793. {
  33794. "name": "List email addresses for a user",
  33795. "scope": "users",
  33796. "id": "listEmails",
  33797. "method": "GET",
  33798. "url": "/user/emails",
  33799. "isDeprecated": false,
  33800. "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.",
  33801. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/emails/#list-email-addresses-for-a-user",
  33802. "previews": [],
  33803. "headers": [],
  33804. "parameters": [
  33805. {
  33806. "name": "per_page",
  33807. "description": "Results per page (max 100)",
  33808. "in": "QUERY",
  33809. "type": "integer",
  33810. "required": false,
  33811. "enum": null,
  33812. "allowNull": false,
  33813. "mapToData": null,
  33814. "validation": null,
  33815. "alias": null,
  33816. "deprecated": null
  33817. },
  33818. {
  33819. "name": "page",
  33820. "description": "Page number of the results to fetch.",
  33821. "in": "QUERY",
  33822. "type": "integer",
  33823. "required": false,
  33824. "enum": null,
  33825. "allowNull": false,
  33826. "mapToData": null,
  33827. "validation": null,
  33828. "alias": null,
  33829. "deprecated": null
  33830. }
  33831. ],
  33832. "responses": [
  33833. {
  33834. "code": 200,
  33835. "description": "response",
  33836. "examples": [
  33837. {
  33838. "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]"
  33839. }
  33840. ]
  33841. }
  33842. ],
  33843. "renamed": null
  33844. },
  33845. {
  33846. "name": "Add email address(es)",
  33847. "scope": "users",
  33848. "id": "addEmails",
  33849. "method": "POST",
  33850. "url": "/user/emails",
  33851. "isDeprecated": false,
  33852. "description": "If your GitHub Enterprise Server instance has [LDAP Sync enabled and the option to synchronize emails enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync), this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add or delete an email address via the API with these options enabled.\n\nThis endpoint is accessible with the `user` scope.",
  33853. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/emails/#add-email-addresses",
  33854. "previews": [],
  33855. "headers": [],
  33856. "parameters": [
  33857. {
  33858. "name": "emails",
  33859. "description": "Adds one or more email addresses to your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
  33860. "in": "BODY",
  33861. "type": "string[]",
  33862. "required": true,
  33863. "enum": null,
  33864. "allowNull": false,
  33865. "mapToData": null,
  33866. "validation": null,
  33867. "alias": null,
  33868. "deprecated": null
  33869. }
  33870. ],
  33871. "responses": [
  33872. {
  33873. "code": 201,
  33874. "description": "response",
  33875. "examples": [
  33876. {
  33877. "data": "[{\"email\":\"octocat@octocat.org\",\"primary\":false,\"verified\":false,\"visibility\":\"public\"},{\"email\":\"octocat@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null},{\"email\":\"support@github.com\",\"primary\":false,\"verified\":false,\"visibility\":null}]"
  33878. }
  33879. ]
  33880. }
  33881. ],
  33882. "renamed": null
  33883. },
  33884. {
  33885. "name": "Delete email address(es)",
  33886. "scope": "users",
  33887. "id": "deleteEmails",
  33888. "method": "DELETE",
  33889. "url": "/user/emails",
  33890. "isDeprecated": false,
  33891. "description": "If your GitHub Enterprise Server instance has [LDAP Sync enabled and the option to synchronize emails enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync), this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add or delete an email address via the API with these options enabled.\n\nThis endpoint is accessible with the `user` scope.",
  33892. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/emails/#delete-email-addresses",
  33893. "previews": [],
  33894. "headers": [],
  33895. "parameters": [
  33896. {
  33897. "name": "emails",
  33898. "description": "Deletes one or more email addresses from your GitHub Enterprise Server account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key.",
  33899. "in": "BODY",
  33900. "type": "string[]",
  33901. "required": true,
  33902. "enum": null,
  33903. "allowNull": false,
  33904. "mapToData": null,
  33905. "validation": null,
  33906. "alias": null,
  33907. "deprecated": null
  33908. }
  33909. ],
  33910. "responses": [],
  33911. "renamed": null
  33912. },
  33913. {
  33914. "name": "List the authenticated user's followers",
  33915. "scope": "users",
  33916. "id": "listFollowersForAuthenticatedUser",
  33917. "method": "GET",
  33918. "url": "/user/followers",
  33919. "isDeprecated": false,
  33920. "description": "",
  33921. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#list-followers-of-a-user",
  33922. "previews": [],
  33923. "headers": [],
  33924. "parameters": [
  33925. {
  33926. "name": "per_page",
  33927. "description": "Results per page (max 100)",
  33928. "in": "QUERY",
  33929. "type": "integer",
  33930. "required": false,
  33931. "enum": null,
  33932. "allowNull": false,
  33933. "mapToData": null,
  33934. "validation": null,
  33935. "alias": null,
  33936. "deprecated": null
  33937. },
  33938. {
  33939. "name": "page",
  33940. "description": "Page number of the results to fetch.",
  33941. "in": "QUERY",
  33942. "type": "integer",
  33943. "required": false,
  33944. "enum": null,
  33945. "allowNull": false,
  33946. "mapToData": null,
  33947. "validation": null,
  33948. "alias": null,
  33949. "deprecated": null
  33950. }
  33951. ],
  33952. "responses": [
  33953. {
  33954. "code": 200,
  33955. "description": "response",
  33956. "examples": [
  33957. {
  33958. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  33959. }
  33960. ]
  33961. }
  33962. ],
  33963. "renamed": null
  33964. },
  33965. {
  33966. "name": "List who the authenticated user is following",
  33967. "scope": "users",
  33968. "id": "listFollowingForAuthenticatedUser",
  33969. "method": "GET",
  33970. "url": "/user/following",
  33971. "isDeprecated": false,
  33972. "description": "",
  33973. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#list-users-followed-by-another-user",
  33974. "previews": [],
  33975. "headers": [],
  33976. "parameters": [
  33977. {
  33978. "name": "per_page",
  33979. "description": "Results per page (max 100)",
  33980. "in": "QUERY",
  33981. "type": "integer",
  33982. "required": false,
  33983. "enum": null,
  33984. "allowNull": false,
  33985. "mapToData": null,
  33986. "validation": null,
  33987. "alias": null,
  33988. "deprecated": null
  33989. },
  33990. {
  33991. "name": "page",
  33992. "description": "Page number of the results to fetch.",
  33993. "in": "QUERY",
  33994. "type": "integer",
  33995. "required": false,
  33996. "enum": null,
  33997. "allowNull": false,
  33998. "mapToData": null,
  33999. "validation": null,
  34000. "alias": null,
  34001. "deprecated": null
  34002. }
  34003. ],
  34004. "responses": [
  34005. {
  34006. "code": 200,
  34007. "description": "response",
  34008. "examples": [
  34009. {
  34010. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  34011. }
  34012. ]
  34013. }
  34014. ],
  34015. "renamed": null
  34016. },
  34017. {
  34018. "name": "Check if you are following a user",
  34019. "scope": "users",
  34020. "id": "checkFollowing",
  34021. "method": "GET",
  34022. "url": "/user/following/{username}",
  34023. "isDeprecated": false,
  34024. "description": "",
  34025. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#check-if-you-are-following-a-user",
  34026. "previews": [],
  34027. "headers": [],
  34028. "parameters": [
  34029. {
  34030. "name": "username",
  34031. "description": "username parameter",
  34032. "in": "PATH",
  34033. "type": "string",
  34034. "required": true,
  34035. "enum": null,
  34036. "allowNull": false,
  34037. "mapToData": null,
  34038. "validation": null,
  34039. "alias": null,
  34040. "deprecated": null
  34041. }
  34042. ],
  34043. "responses": [],
  34044. "renamed": null
  34045. },
  34046. {
  34047. "name": "Follow a user",
  34048. "scope": "users",
  34049. "id": "follow",
  34050. "method": "PUT",
  34051. "url": "/user/following/{username}",
  34052. "isDeprecated": false,
  34053. "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
  34054. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#follow-a-user",
  34055. "previews": [],
  34056. "headers": [],
  34057. "parameters": [
  34058. {
  34059. "name": "username",
  34060. "description": "username parameter",
  34061. "in": "PATH",
  34062. "type": "string",
  34063. "required": true,
  34064. "enum": null,
  34065. "allowNull": false,
  34066. "mapToData": null,
  34067. "validation": null,
  34068. "alias": null,
  34069. "deprecated": null
  34070. }
  34071. ],
  34072. "responses": [],
  34073. "renamed": null
  34074. },
  34075. {
  34076. "name": "Unfollow a user",
  34077. "scope": "users",
  34078. "id": "unfollow",
  34079. "method": "DELETE",
  34080. "url": "/user/following/{username}",
  34081. "isDeprecated": false,
  34082. "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.",
  34083. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#unfollow-a-user",
  34084. "previews": [],
  34085. "headers": [],
  34086. "parameters": [
  34087. {
  34088. "name": "username",
  34089. "description": "username parameter",
  34090. "in": "PATH",
  34091. "type": "string",
  34092. "required": true,
  34093. "enum": null,
  34094. "allowNull": false,
  34095. "mapToData": null,
  34096. "validation": null,
  34097. "alias": null,
  34098. "deprecated": null
  34099. }
  34100. ],
  34101. "responses": [],
  34102. "renamed": null
  34103. },
  34104. {
  34105. "name": "List your GPG keys",
  34106. "scope": "users",
  34107. "id": "listGpgKeys",
  34108. "method": "GET",
  34109. "url": "/user/gpg_keys",
  34110. "isDeprecated": false,
  34111. "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  34112. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/gpg_keys/#list-your-gpg-keys",
  34113. "previews": [],
  34114. "headers": [],
  34115. "parameters": [
  34116. {
  34117. "name": "per_page",
  34118. "description": "Results per page (max 100)",
  34119. "in": "QUERY",
  34120. "type": "integer",
  34121. "required": false,
  34122. "enum": null,
  34123. "allowNull": false,
  34124. "mapToData": null,
  34125. "validation": null,
  34126. "alias": null,
  34127. "deprecated": null
  34128. },
  34129. {
  34130. "name": "page",
  34131. "description": "Page number of the results to fetch.",
  34132. "in": "QUERY",
  34133. "type": "integer",
  34134. "required": false,
  34135. "enum": null,
  34136. "allowNull": false,
  34137. "mapToData": null,
  34138. "validation": null,
  34139. "alias": null,
  34140. "deprecated": null
  34141. }
  34142. ],
  34143. "responses": [
  34144. {
  34145. "code": 200,
  34146. "description": "response",
  34147. "examples": [
  34148. {
  34149. "data": "[{\"id\":3,\"primary_key_id\":null,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}]"
  34150. }
  34151. ]
  34152. }
  34153. ],
  34154. "renamed": null
  34155. },
  34156. {
  34157. "name": "Create a GPG key",
  34158. "scope": "users",
  34159. "id": "createGpgKey",
  34160. "method": "POST",
  34161. "url": "/user/gpg_keys",
  34162. "isDeprecated": false,
  34163. "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  34164. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/gpg_keys/#create-a-gpg-key",
  34165. "previews": [],
  34166. "headers": [],
  34167. "parameters": [
  34168. {
  34169. "name": "armored_public_key",
  34170. "description": "Your GPG key, generated in ASCII-armored format. See \"[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)\" for help creating a GPG key.",
  34171. "in": "BODY",
  34172. "type": "string",
  34173. "required": false,
  34174. "enum": null,
  34175. "allowNull": false,
  34176. "mapToData": null,
  34177. "validation": null,
  34178. "alias": null,
  34179. "deprecated": null
  34180. }
  34181. ],
  34182. "responses": [
  34183. {
  34184. "code": 201,
  34185. "description": "response",
  34186. "examples": [
  34187. {
  34188. "data": "{\"id\":3,\"primary_key_id\":null,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}"
  34189. }
  34190. ]
  34191. }
  34192. ],
  34193. "renamed": null
  34194. },
  34195. {
  34196. "name": "Get a single GPG key",
  34197. "scope": "users",
  34198. "id": "getGpgKey",
  34199. "method": "GET",
  34200. "url": "/user/gpg_keys/{gpg_key_id}",
  34201. "isDeprecated": false,
  34202. "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  34203. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/gpg_keys/#get-a-single-gpg-key",
  34204. "previews": [],
  34205. "headers": [],
  34206. "parameters": [
  34207. {
  34208. "name": "gpg_key_id",
  34209. "description": "gpg_key_id parameter",
  34210. "in": "PATH",
  34211. "type": "integer",
  34212. "required": true,
  34213. "enum": null,
  34214. "allowNull": false,
  34215. "mapToData": null,
  34216. "validation": null,
  34217. "alias": null,
  34218. "deprecated": null
  34219. }
  34220. ],
  34221. "responses": [
  34222. {
  34223. "code": 200,
  34224. "description": "response",
  34225. "examples": [
  34226. {
  34227. "data": "{\"id\":3,\"primary_key_id\":null,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}"
  34228. }
  34229. ]
  34230. }
  34231. ],
  34232. "renamed": null
  34233. },
  34234. {
  34235. "name": "Delete a GPG key",
  34236. "scope": "users",
  34237. "id": "deleteGpgKey",
  34238. "method": "DELETE",
  34239. "url": "/user/gpg_keys/{gpg_key_id}",
  34240. "isDeprecated": false,
  34241. "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  34242. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/gpg_keys/#delete-a-gpg-key",
  34243. "previews": [],
  34244. "headers": [],
  34245. "parameters": [
  34246. {
  34247. "name": "gpg_key_id",
  34248. "description": "gpg_key_id parameter",
  34249. "in": "PATH",
  34250. "type": "integer",
  34251. "required": true,
  34252. "enum": null,
  34253. "allowNull": false,
  34254. "mapToData": null,
  34255. "validation": null,
  34256. "alias": null,
  34257. "deprecated": null
  34258. }
  34259. ],
  34260. "responses": [],
  34261. "renamed": null
  34262. },
  34263. {
  34264. "name": "List installations for a user",
  34265. "scope": "apps",
  34266. "id": "listInstallationsForAuthenticatedUser",
  34267. "method": "GET",
  34268. "url": "/user/installations",
  34269. "isDeprecated": false,
  34270. "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://developer.github.com/enterprise/2.17/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.",
  34271. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/installations/#list-installations-for-a-user",
  34272. "previews": [{ "name": "machine-man" }],
  34273. "headers": [
  34274. {
  34275. "name": "accept",
  34276. "value": "application/vnd.github.machine-man-preview+json"
  34277. }
  34278. ],
  34279. "parameters": [
  34280. {
  34281. "name": "per_page",
  34282. "description": "Results per page (max 100)",
  34283. "in": "QUERY",
  34284. "type": "integer",
  34285. "required": false,
  34286. "enum": null,
  34287. "allowNull": false,
  34288. "mapToData": null,
  34289. "validation": null,
  34290. "alias": null,
  34291. "deprecated": null
  34292. },
  34293. {
  34294. "name": "page",
  34295. "description": "Page number of the results to fetch.",
  34296. "in": "QUERY",
  34297. "type": "integer",
  34298. "required": false,
  34299. "enum": null,
  34300. "allowNull": false,
  34301. "mapToData": null,
  34302. "validation": null,
  34303. "alias": null,
  34304. "deprecated": null
  34305. }
  34306. ],
  34307. "responses": [
  34308. {
  34309. "code": 200,
  34310. "description": "You can find the permissions for the installation under the `permissions` key.",
  34311. "examples": [
  34312. {
  34313. "data": "{\"total_count\":2,\"installations\":[{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yml\"},{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":2,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"],\"single_file_name\":\"config.yml\"}]}"
  34314. }
  34315. ]
  34316. }
  34317. ],
  34318. "renamed": null
  34319. },
  34320. {
  34321. "name": "List repositories accessible to the user for an installation",
  34322. "scope": "apps",
  34323. "id": "listInstallationReposForAuthenticatedUser",
  34324. "method": "GET",
  34325. "url": "/user/installations/{installation_id}/repositories",
  34326. "isDeprecated": false,
  34327. "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://developer.github.com/enterprise/2.17/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.",
  34328. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation",
  34329. "previews": [{ "name": "machine-man" }],
  34330. "headers": [
  34331. {
  34332. "name": "accept",
  34333. "value": "application/vnd.github.machine-man-preview+json"
  34334. }
  34335. ],
  34336. "parameters": [
  34337. {
  34338. "name": "installation_id",
  34339. "description": "installation_id parameter",
  34340. "in": "PATH",
  34341. "type": "integer",
  34342. "required": true,
  34343. "enum": null,
  34344. "allowNull": false,
  34345. "mapToData": null,
  34346. "validation": null,
  34347. "alias": null,
  34348. "deprecated": null
  34349. },
  34350. {
  34351. "name": "per_page",
  34352. "description": "Results per page (max 100)",
  34353. "in": "QUERY",
  34354. "type": "integer",
  34355. "required": false,
  34356. "enum": null,
  34357. "allowNull": false,
  34358. "mapToData": null,
  34359. "validation": null,
  34360. "alias": null,
  34361. "deprecated": null
  34362. },
  34363. {
  34364. "name": "page",
  34365. "description": "Page number of the results to fetch.",
  34366. "in": "QUERY",
  34367. "type": "integer",
  34368. "required": false,
  34369. "enum": null,
  34370. "allowNull": false,
  34371. "mapToData": null,
  34372. "validation": null,
  34373. "alias": null,
  34374. "deprecated": null
  34375. }
  34376. ],
  34377. "responses": [
  34378. {
  34379. "code": 200,
  34380. "description": "The access the user has to each repository is included in the hash under the `permissions` key.",
  34381. "examples": [
  34382. {
  34383. "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}]}"
  34384. }
  34385. ]
  34386. }
  34387. ],
  34388. "renamed": null
  34389. },
  34390. {
  34391. "name": "Add repository to installation",
  34392. "scope": "apps",
  34393. "id": "addRepoToInstallation",
  34394. "method": "PUT",
  34395. "url": "/user/installations/{installation_id}/repositories/{repository_id}",
  34396. "isDeprecated": false,
  34397. "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth/#basic-authentication) to access this endpoint.",
  34398. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/installations/#add-repository-to-installation",
  34399. "previews": [{ "name": "machine-man" }],
  34400. "headers": [
  34401. {
  34402. "name": "accept",
  34403. "value": "application/vnd.github.machine-man-preview+json"
  34404. }
  34405. ],
  34406. "parameters": [
  34407. {
  34408. "name": "installation_id",
  34409. "description": "installation_id parameter",
  34410. "in": "PATH",
  34411. "type": "integer",
  34412. "required": true,
  34413. "enum": null,
  34414. "allowNull": false,
  34415. "mapToData": null,
  34416. "validation": null,
  34417. "alias": null,
  34418. "deprecated": null
  34419. },
  34420. {
  34421. "name": "repository_id",
  34422. "description": "repository_id parameter",
  34423. "in": "PATH",
  34424. "type": "integer",
  34425. "required": true,
  34426. "enum": null,
  34427. "allowNull": false,
  34428. "mapToData": null,
  34429. "validation": null,
  34430. "alias": null,
  34431. "deprecated": null
  34432. }
  34433. ],
  34434. "responses": [],
  34435. "renamed": null
  34436. },
  34437. {
  34438. "name": "Remove repository from installation",
  34439. "scope": "apps",
  34440. "id": "removeRepoFromInstallation",
  34441. "method": "DELETE",
  34442. "url": "/user/installations/{installation_id}/repositories/{repository_id}",
  34443. "isDeprecated": false,
  34444. "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/enterprise/2.17/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/enterprise/2.17/v3/auth/#basic-authentication) to access this endpoint.",
  34445. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/installations/#remove-repository-from-installation",
  34446. "previews": [{ "name": "machine-man" }],
  34447. "headers": [
  34448. {
  34449. "name": "accept",
  34450. "value": "application/vnd.github.machine-man-preview+json"
  34451. }
  34452. ],
  34453. "parameters": [
  34454. {
  34455. "name": "installation_id",
  34456. "description": "installation_id parameter",
  34457. "in": "PATH",
  34458. "type": "integer",
  34459. "required": true,
  34460. "enum": null,
  34461. "allowNull": false,
  34462. "mapToData": null,
  34463. "validation": null,
  34464. "alias": null,
  34465. "deprecated": null
  34466. },
  34467. {
  34468. "name": "repository_id",
  34469. "description": "repository_id parameter",
  34470. "in": "PATH",
  34471. "type": "integer",
  34472. "required": true,
  34473. "enum": null,
  34474. "allowNull": false,
  34475. "mapToData": null,
  34476. "validation": null,
  34477. "alias": null,
  34478. "deprecated": null
  34479. }
  34480. ],
  34481. "responses": [],
  34482. "renamed": null
  34483. },
  34484. {
  34485. "name": "List all issues across owned and member repositories assigned to the authenticated user",
  34486. "scope": "issues",
  34487. "id": "listForAuthenticatedUser",
  34488. "method": "GET",
  34489. "url": "/user/issues",
  34490. "isDeprecated": false,
  34491. "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/enterprise/2.17/v3/pulls/#list-pull-requests)\" endpoint.",
  34492. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/issues/#list-issues",
  34493. "previews": [],
  34494. "headers": [],
  34495. "parameters": [
  34496. {
  34497. "name": "filter",
  34498. "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation",
  34499. "in": "QUERY",
  34500. "type": "string",
  34501. "required": false,
  34502. "enum": ["assigned", "created", "mentioned", "subscribed", "all"],
  34503. "allowNull": false,
  34504. "mapToData": null,
  34505. "validation": null,
  34506. "alias": null,
  34507. "deprecated": null
  34508. },
  34509. {
  34510. "name": "state",
  34511. "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.",
  34512. "in": "QUERY",
  34513. "type": "string",
  34514. "required": false,
  34515. "enum": ["open", "closed", "all"],
  34516. "allowNull": false,
  34517. "mapToData": null,
  34518. "validation": null,
  34519. "alias": null,
  34520. "deprecated": null
  34521. },
  34522. {
  34523. "name": "labels",
  34524. "description": "A list of comma separated label names. Example: `bug,ui,@high`",
  34525. "in": "QUERY",
  34526. "type": "string",
  34527. "required": false,
  34528. "enum": null,
  34529. "allowNull": false,
  34530. "mapToData": null,
  34531. "validation": null,
  34532. "alias": null,
  34533. "deprecated": null
  34534. },
  34535. {
  34536. "name": "sort",
  34537. "description": "What to sort results by. Can be either `created`, `updated`, `comments`.",
  34538. "in": "QUERY",
  34539. "type": "string",
  34540. "required": false,
  34541. "enum": ["created", "updated", "comments"],
  34542. "allowNull": false,
  34543. "mapToData": null,
  34544. "validation": null,
  34545. "alias": null,
  34546. "deprecated": null
  34547. },
  34548. {
  34549. "name": "direction",
  34550. "description": "The direction of the sort. Can be either `asc` or `desc`.",
  34551. "in": "QUERY",
  34552. "type": "string",
  34553. "required": false,
  34554. "enum": ["asc", "desc"],
  34555. "allowNull": false,
  34556. "mapToData": null,
  34557. "validation": null,
  34558. "alias": null,
  34559. "deprecated": null
  34560. },
  34561. {
  34562. "name": "since",
  34563. "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.",
  34564. "in": "QUERY",
  34565. "type": "string",
  34566. "required": false,
  34567. "enum": null,
  34568. "allowNull": false,
  34569. "mapToData": null,
  34570. "validation": null,
  34571. "alias": null,
  34572. "deprecated": null
  34573. },
  34574. {
  34575. "name": "per_page",
  34576. "description": "Results per page (max 100)",
  34577. "in": "QUERY",
  34578. "type": "integer",
  34579. "required": false,
  34580. "enum": null,
  34581. "allowNull": false,
  34582. "mapToData": null,
  34583. "validation": null,
  34584. "alias": null,
  34585. "deprecated": null
  34586. },
  34587. {
  34588. "name": "page",
  34589. "description": "Page number of the results to fetch.",
  34590. "in": "QUERY",
  34591. "type": "integer",
  34592. "required": false,
  34593. "enum": null,
  34594. "allowNull": false,
  34595. "mapToData": null,
  34596. "validation": null,
  34597. "alias": null,
  34598. "deprecated": null
  34599. }
  34600. ],
  34601. "responses": [
  34602. {
  34603. "code": 200,
  34604. "description": "response",
  34605. "examples": [
  34606. {
  34607. "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}]"
  34608. }
  34609. ]
  34610. }
  34611. ],
  34612. "renamed": null
  34613. },
  34614. {
  34615. "name": "List your public keys",
  34616. "scope": "users",
  34617. "id": "listPublicKeys",
  34618. "method": "GET",
  34619. "url": "/user/keys",
  34620. "isDeprecated": false,
  34621. "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  34622. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/keys/#list-your-public-keys",
  34623. "previews": [],
  34624. "headers": [],
  34625. "parameters": [
  34626. {
  34627. "name": "per_page",
  34628. "description": "Results per page (max 100)",
  34629. "in": "QUERY",
  34630. "type": "integer",
  34631. "required": false,
  34632. "enum": null,
  34633. "allowNull": false,
  34634. "mapToData": null,
  34635. "validation": null,
  34636. "alias": null,
  34637. "deprecated": null
  34638. },
  34639. {
  34640. "name": "page",
  34641. "description": "Page number of the results to fetch.",
  34642. "in": "QUERY",
  34643. "type": "integer",
  34644. "required": false,
  34645. "enum": null,
  34646. "allowNull": false,
  34647. "mapToData": null,
  34648. "validation": null,
  34649. "alias": null,
  34650. "deprecated": null
  34651. }
  34652. ],
  34653. "responses": [
  34654. {
  34655. "code": 200,
  34656. "description": "response",
  34657. "examples": [
  34658. {
  34659. "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/user/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}]"
  34660. }
  34661. ]
  34662. }
  34663. ],
  34664. "renamed": null
  34665. },
  34666. {
  34667. "name": "Create a public key",
  34668. "scope": "users",
  34669. "id": "createPublicKey",
  34670. "method": "POST",
  34671. "url": "/user/keys",
  34672. "isDeprecated": false,
  34673. "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nIf your GitHub Enterprise Server appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add an SSH key address via the API with these options enabled.",
  34674. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/keys/#create-a-public-key",
  34675. "previews": [],
  34676. "headers": [],
  34677. "parameters": [
  34678. {
  34679. "name": "title",
  34680. "description": "A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key \"Personal MacBook Air\".",
  34681. "in": "BODY",
  34682. "type": "string",
  34683. "required": false,
  34684. "enum": null,
  34685. "allowNull": false,
  34686. "mapToData": null,
  34687. "validation": null,
  34688. "alias": null,
  34689. "deprecated": null
  34690. },
  34691. {
  34692. "name": "key",
  34693. "description": "The public SSH key to add to your GitHub account. See \"[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\" for guidance on how to create a public SSH key.",
  34694. "in": "BODY",
  34695. "type": "string",
  34696. "required": false,
  34697. "enum": null,
  34698. "allowNull": false,
  34699. "mapToData": null,
  34700. "validation": null,
  34701. "alias": null,
  34702. "deprecated": null
  34703. }
  34704. ],
  34705. "responses": [
  34706. {
  34707. "code": 201,
  34708. "description": "response",
  34709. "examples": [
  34710. {
  34711. "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/user/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}"
  34712. }
  34713. ]
  34714. }
  34715. ],
  34716. "renamed": null
  34717. },
  34718. {
  34719. "name": "Get a single public key",
  34720. "scope": "users",
  34721. "id": "getPublicKey",
  34722. "method": "GET",
  34723. "url": "/user/keys/{key_id}",
  34724. "isDeprecated": false,
  34725. "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).",
  34726. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/keys/#get-a-single-public-key",
  34727. "previews": [],
  34728. "headers": [],
  34729. "parameters": [
  34730. {
  34731. "name": "key_id",
  34732. "description": "key_id parameter",
  34733. "in": "PATH",
  34734. "type": "integer",
  34735. "required": true,
  34736. "enum": null,
  34737. "allowNull": false,
  34738. "mapToData": null,
  34739. "validation": null,
  34740. "alias": null,
  34741. "deprecated": null
  34742. }
  34743. ],
  34744. "responses": [
  34745. {
  34746. "code": 200,
  34747. "description": "response",
  34748. "examples": [
  34749. {
  34750. "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/user/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}"
  34751. }
  34752. ]
  34753. }
  34754. ],
  34755. "renamed": null
  34756. },
  34757. {
  34758. "name": "Delete a public key",
  34759. "scope": "users",
  34760. "id": "deletePublicKey",
  34761. "method": "DELETE",
  34762. "url": "/user/keys/{key_id}",
  34763. "isDeprecated": false,
  34764. "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nIf your GitHub Enterprise Server appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to remove an SSH key address via the API with these options enabled.",
  34765. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/keys/#delete-a-public-key",
  34766. "previews": [],
  34767. "headers": [],
  34768. "parameters": [
  34769. {
  34770. "name": "key_id",
  34771. "description": "key_id parameter",
  34772. "in": "PATH",
  34773. "type": "integer",
  34774. "required": true,
  34775. "enum": null,
  34776. "allowNull": false,
  34777. "mapToData": null,
  34778. "validation": null,
  34779. "alias": null,
  34780. "deprecated": null
  34781. }
  34782. ],
  34783. "responses": [],
  34784. "renamed": null
  34785. },
  34786. {
  34787. "name": "List your organization memberships",
  34788. "scope": "orgs",
  34789. "id": "listMemberships",
  34790. "method": "GET",
  34791. "url": "/user/memberships/orgs",
  34792. "isDeprecated": false,
  34793. "description": "",
  34794. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#list-your-organization-memberships",
  34795. "previews": [],
  34796. "headers": [],
  34797. "parameters": [
  34798. {
  34799. "name": "state",
  34800. "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships.",
  34801. "in": "QUERY",
  34802. "type": "string",
  34803. "required": false,
  34804. "enum": ["active", "pending"],
  34805. "allowNull": false,
  34806. "mapToData": null,
  34807. "validation": null,
  34808. "alias": null,
  34809. "deprecated": null
  34810. },
  34811. {
  34812. "name": "per_page",
  34813. "description": "Results per page (max 100)",
  34814. "in": "QUERY",
  34815. "type": "integer",
  34816. "required": false,
  34817. "enum": null,
  34818. "allowNull": false,
  34819. "mapToData": null,
  34820. "validation": null,
  34821. "alias": null,
  34822. "deprecated": null
  34823. },
  34824. {
  34825. "name": "page",
  34826. "description": "Page number of the results to fetch.",
  34827. "in": "QUERY",
  34828. "type": "integer",
  34829. "required": false,
  34830. "enum": null,
  34831. "allowNull": false,
  34832. "mapToData": null,
  34833. "validation": null,
  34834. "alias": null,
  34835. "deprecated": null
  34836. }
  34837. ],
  34838. "responses": [
  34839. {
  34840. "code": 200,
  34841. "description": "response",
  34842. "examples": [
  34843. {
  34844. "data": "[{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}},{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]"
  34845. }
  34846. ]
  34847. }
  34848. ],
  34849. "renamed": null
  34850. },
  34851. {
  34852. "name": "Get your organization membership",
  34853. "scope": "orgs",
  34854. "id": "getMembershipForAuthenticatedUser",
  34855. "method": "GET",
  34856. "url": "/user/memberships/orgs/{org}",
  34857. "isDeprecated": false,
  34858. "description": "",
  34859. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#get-your-organization-membership",
  34860. "previews": [],
  34861. "headers": [],
  34862. "parameters": [
  34863. {
  34864. "name": "org",
  34865. "description": "org parameter",
  34866. "in": "PATH",
  34867. "type": "string",
  34868. "required": true,
  34869. "enum": null,
  34870. "allowNull": false,
  34871. "mapToData": null,
  34872. "validation": null,
  34873. "alias": null,
  34874. "deprecated": null
  34875. }
  34876. ],
  34877. "responses": [
  34878. {
  34879. "code": 200,
  34880. "description": "response",
  34881. "examples": [
  34882. {
  34883. "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  34884. }
  34885. ]
  34886. }
  34887. ],
  34888. "renamed": null
  34889. },
  34890. {
  34891. "name": "Edit your organization membership",
  34892. "scope": "orgs",
  34893. "id": "updateMembership",
  34894. "method": "PATCH",
  34895. "url": "/user/memberships/orgs/{org}",
  34896. "isDeprecated": false,
  34897. "description": "",
  34898. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/members/#edit-your-organization-membership",
  34899. "previews": [],
  34900. "headers": [],
  34901. "parameters": [
  34902. {
  34903. "name": "org",
  34904. "description": "org parameter",
  34905. "in": "PATH",
  34906. "type": "string",
  34907. "required": true,
  34908. "enum": null,
  34909. "allowNull": false,
  34910. "mapToData": null,
  34911. "validation": null,
  34912. "alias": null,
  34913. "deprecated": null
  34914. },
  34915. {
  34916. "name": "state",
  34917. "description": "The state that the membership should be in. Only `\"active\"` will be accepted.",
  34918. "in": "BODY",
  34919. "type": "string",
  34920. "required": true,
  34921. "enum": ["active"],
  34922. "allowNull": false,
  34923. "mapToData": null,
  34924. "validation": null,
  34925. "alias": null,
  34926. "deprecated": null
  34927. }
  34928. ],
  34929. "responses": [
  34930. {
  34931. "code": 200,
  34932. "description": "response",
  34933. "examples": [
  34934. {
  34935. "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}"
  34936. }
  34937. ]
  34938. }
  34939. ],
  34940. "renamed": null
  34941. },
  34942. {
  34943. "name": "List your organizations",
  34944. "scope": "orgs",
  34945. "id": "listForAuthenticatedUser",
  34946. "method": "GET",
  34947. "url": "/user/orgs",
  34948. "isDeprecated": false,
  34949. "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.",
  34950. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/#list-your-organizations",
  34951. "previews": [],
  34952. "headers": [],
  34953. "parameters": [
  34954. {
  34955. "name": "per_page",
  34956. "description": "Results per page (max 100)",
  34957. "in": "QUERY",
  34958. "type": "integer",
  34959. "required": false,
  34960. "enum": null,
  34961. "allowNull": false,
  34962. "mapToData": null,
  34963. "validation": null,
  34964. "alias": null,
  34965. "deprecated": null
  34966. },
  34967. {
  34968. "name": "page",
  34969. "description": "Page number of the results to fetch.",
  34970. "in": "QUERY",
  34971. "type": "integer",
  34972. "required": false,
  34973. "enum": null,
  34974. "allowNull": false,
  34975. "mapToData": null,
  34976. "validation": null,
  34977. "alias": null,
  34978. "deprecated": null
  34979. }
  34980. ],
  34981. "responses": [
  34982. {
  34983. "code": 200,
  34984. "description": "response",
  34985. "examples": [
  34986. {
  34987. "data": "[{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]"
  34988. }
  34989. ]
  34990. }
  34991. ],
  34992. "renamed": null
  34993. },
  34994. {
  34995. "name": "Create a user project",
  34996. "scope": "projects",
  34997. "id": "createForAuthenticatedUser",
  34998. "method": "POST",
  34999. "url": "/user/projects",
  35000. "isDeprecated": false,
  35001. "description": "",
  35002. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#create-a-user-project",
  35003. "previews": [{ "name": "inertia" }],
  35004. "headers": [
  35005. {
  35006. "name": "accept",
  35007. "value": "application/vnd.github.inertia-preview+json"
  35008. }
  35009. ],
  35010. "parameters": [
  35011. {
  35012. "name": "name",
  35013. "description": "The name of the project.",
  35014. "in": "BODY",
  35015. "type": "string",
  35016. "required": true,
  35017. "enum": null,
  35018. "allowNull": false,
  35019. "mapToData": null,
  35020. "validation": null,
  35021. "alias": null,
  35022. "deprecated": null
  35023. },
  35024. {
  35025. "name": "body",
  35026. "description": "The description of the project.",
  35027. "in": "BODY",
  35028. "type": "string",
  35029. "required": false,
  35030. "enum": null,
  35031. "allowNull": false,
  35032. "mapToData": null,
  35033. "validation": null,
  35034. "alias": null,
  35035. "deprecated": null
  35036. }
  35037. ],
  35038. "responses": [
  35039. {
  35040. "code": 201,
  35041. "description": "response",
  35042. "examples": [
  35043. {
  35044. "data": "{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}"
  35045. }
  35046. ]
  35047. }
  35048. ],
  35049. "renamed": null
  35050. },
  35051. {
  35052. "name": "List public email addresses for a user",
  35053. "scope": "users",
  35054. "id": "listPublicEmails",
  35055. "method": "GET",
  35056. "url": "/user/public_emails",
  35057. "isDeprecated": false,
  35058. "description": "Lists your publicly visible email address. This endpoint is accessible with the `user:email` scope.",
  35059. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/emails/#list-public-email-addresses-for-a-user",
  35060. "previews": [],
  35061. "headers": [],
  35062. "parameters": [
  35063. {
  35064. "name": "per_page",
  35065. "description": "Results per page (max 100)",
  35066. "in": "QUERY",
  35067. "type": "integer",
  35068. "required": false,
  35069. "enum": null,
  35070. "allowNull": false,
  35071. "mapToData": null,
  35072. "validation": null,
  35073. "alias": null,
  35074. "deprecated": null
  35075. },
  35076. {
  35077. "name": "page",
  35078. "description": "Page number of the results to fetch.",
  35079. "in": "QUERY",
  35080. "type": "integer",
  35081. "required": false,
  35082. "enum": null,
  35083. "allowNull": false,
  35084. "mapToData": null,
  35085. "validation": null,
  35086. "alias": null,
  35087. "deprecated": null
  35088. }
  35089. ],
  35090. "responses": [
  35091. {
  35092. "code": 200,
  35093. "description": "response",
  35094. "examples": [
  35095. {
  35096. "data": "[{\"email\":\"octocat@github.com\",\"verified\":true,\"primary\":true,\"visibility\":\"public\"}]"
  35097. }
  35098. ]
  35099. }
  35100. ],
  35101. "renamed": null
  35102. },
  35103. {
  35104. "name": "List your repositories",
  35105. "scope": "repos",
  35106. "id": "list",
  35107. "method": "GET",
  35108. "url": "/user/repos",
  35109. "isDeprecated": false,
  35110. "description": "Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.",
  35111. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-your-repositories",
  35112. "previews": [],
  35113. "headers": [],
  35114. "parameters": [
  35115. {
  35116. "name": "visibility",
  35117. "description": "Can be one of `all`, `public`, or `private`.",
  35118. "in": "QUERY",
  35119. "type": "string",
  35120. "required": false,
  35121. "enum": ["all", "public", "private"],
  35122. "allowNull": false,
  35123. "mapToData": null,
  35124. "validation": null,
  35125. "alias": null,
  35126. "deprecated": null
  35127. },
  35128. {
  35129. "name": "affiliation",
  35130. "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on.",
  35131. "in": "QUERY",
  35132. "type": "string",
  35133. "required": false,
  35134. "enum": null,
  35135. "allowNull": false,
  35136. "mapToData": null,
  35137. "validation": null,
  35138. "alias": null,
  35139. "deprecated": null
  35140. },
  35141. {
  35142. "name": "type",
  35143. "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.",
  35144. "in": "QUERY",
  35145. "type": "string",
  35146. "required": false,
  35147. "enum": ["all", "owner", "public", "private", "member"],
  35148. "allowNull": false,
  35149. "mapToData": null,
  35150. "validation": null,
  35151. "alias": null,
  35152. "deprecated": null
  35153. },
  35154. {
  35155. "name": "sort",
  35156. "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
  35157. "in": "QUERY",
  35158. "type": "string",
  35159. "required": false,
  35160. "enum": ["created", "updated", "pushed", "full_name"],
  35161. "allowNull": false,
  35162. "mapToData": null,
  35163. "validation": null,
  35164. "alias": null,
  35165. "deprecated": null
  35166. },
  35167. {
  35168. "name": "direction",
  35169. "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`",
  35170. "in": "QUERY",
  35171. "type": "string",
  35172. "required": false,
  35173. "enum": ["asc", "desc"],
  35174. "allowNull": false,
  35175. "mapToData": null,
  35176. "validation": null,
  35177. "alias": null,
  35178. "deprecated": null
  35179. },
  35180. {
  35181. "name": "per_page",
  35182. "description": "Results per page (max 100)",
  35183. "in": "QUERY",
  35184. "type": "integer",
  35185. "required": false,
  35186. "enum": null,
  35187. "allowNull": false,
  35188. "mapToData": null,
  35189. "validation": null,
  35190. "alias": null,
  35191. "deprecated": null
  35192. },
  35193. {
  35194. "name": "page",
  35195. "description": "Page number of the results to fetch.",
  35196. "in": "QUERY",
  35197. "type": "integer",
  35198. "required": false,
  35199. "enum": null,
  35200. "allowNull": false,
  35201. "mapToData": null,
  35202. "validation": null,
  35203. "alias": null,
  35204. "deprecated": null
  35205. }
  35206. ],
  35207. "responses": [],
  35208. "renamed": null
  35209. },
  35210. {
  35211. "name": "Creates a new repository for the authenticated user",
  35212. "scope": "repos",
  35213. "id": "createForAuthenticatedUser",
  35214. "method": "POST",
  35215. "url": "/user/repos",
  35216. "isDeprecated": false,
  35217. "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository",
  35218. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#create",
  35219. "previews": [],
  35220. "headers": [],
  35221. "parameters": [
  35222. {
  35223. "name": "name",
  35224. "description": "The name of the repository.",
  35225. "in": "BODY",
  35226. "type": "string",
  35227. "required": true,
  35228. "enum": null,
  35229. "allowNull": false,
  35230. "mapToData": null,
  35231. "validation": null,
  35232. "alias": null,
  35233. "deprecated": null
  35234. },
  35235. {
  35236. "name": "description",
  35237. "description": "A short description of the repository.",
  35238. "in": "BODY",
  35239. "type": "string",
  35240. "required": false,
  35241. "enum": null,
  35242. "allowNull": false,
  35243. "mapToData": null,
  35244. "validation": null,
  35245. "alias": null,
  35246. "deprecated": null
  35247. },
  35248. {
  35249. "name": "homepage",
  35250. "description": "A URL with more information about the repository.",
  35251. "in": "BODY",
  35252. "type": "string",
  35253. "required": false,
  35254. "enum": null,
  35255. "allowNull": false,
  35256. "mapToData": null,
  35257. "validation": null,
  35258. "alias": null,
  35259. "deprecated": null
  35260. },
  35261. {
  35262. "name": "private",
  35263. "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.",
  35264. "in": "BODY",
  35265. "type": "boolean",
  35266. "required": false,
  35267. "enum": null,
  35268. "allowNull": false,
  35269. "mapToData": null,
  35270. "validation": null,
  35271. "alias": null,
  35272. "deprecated": null
  35273. },
  35274. {
  35275. "name": "has_issues",
  35276. "description": "Either `true` to enable issues for this repository or `false` to disable them.",
  35277. "in": "BODY",
  35278. "type": "boolean",
  35279. "required": false,
  35280. "enum": null,
  35281. "allowNull": false,
  35282. "mapToData": null,
  35283. "validation": null,
  35284. "alias": null,
  35285. "deprecated": null
  35286. },
  35287. {
  35288. "name": "has_projects",
  35289. "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.",
  35290. "in": "BODY",
  35291. "type": "boolean",
  35292. "required": false,
  35293. "enum": null,
  35294. "allowNull": false,
  35295. "mapToData": null,
  35296. "validation": null,
  35297. "alias": null,
  35298. "deprecated": null
  35299. },
  35300. {
  35301. "name": "has_wiki",
  35302. "description": "Either `true` to enable the wiki for this repository or `false` to disable it.",
  35303. "in": "BODY",
  35304. "type": "boolean",
  35305. "required": false,
  35306. "enum": null,
  35307. "allowNull": false,
  35308. "mapToData": null,
  35309. "validation": null,
  35310. "alias": null,
  35311. "deprecated": null
  35312. },
  35313. {
  35314. "name": "team_id",
  35315. "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.",
  35316. "in": "BODY",
  35317. "type": "integer",
  35318. "required": false,
  35319. "enum": null,
  35320. "allowNull": false,
  35321. "mapToData": null,
  35322. "validation": null,
  35323. "alias": null,
  35324. "deprecated": null
  35325. },
  35326. {
  35327. "name": "auto_init",
  35328. "description": "Pass `true` to create an initial commit with empty README.",
  35329. "in": "BODY",
  35330. "type": "boolean",
  35331. "required": false,
  35332. "enum": null,
  35333. "allowNull": false,
  35334. "mapToData": null,
  35335. "validation": null,
  35336. "alias": null,
  35337. "deprecated": null
  35338. },
  35339. {
  35340. "name": "gitignore_template",
  35341. "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".",
  35342. "in": "BODY",
  35343. "type": "string",
  35344. "required": false,
  35345. "enum": null,
  35346. "allowNull": false,
  35347. "mapToData": null,
  35348. "validation": null,
  35349. "alias": null,
  35350. "deprecated": null
  35351. },
  35352. {
  35353. "name": "license_template",
  35354. "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".",
  35355. "in": "BODY",
  35356. "type": "string",
  35357. "required": false,
  35358. "enum": null,
  35359. "allowNull": false,
  35360. "mapToData": null,
  35361. "validation": null,
  35362. "alias": null,
  35363. "deprecated": null
  35364. },
  35365. {
  35366. "name": "allow_squash_merge",
  35367. "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.",
  35368. "in": "BODY",
  35369. "type": "boolean",
  35370. "required": false,
  35371. "enum": null,
  35372. "allowNull": false,
  35373. "mapToData": null,
  35374. "validation": null,
  35375. "alias": null,
  35376. "deprecated": null
  35377. },
  35378. {
  35379. "name": "allow_merge_commit",
  35380. "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.",
  35381. "in": "BODY",
  35382. "type": "boolean",
  35383. "required": false,
  35384. "enum": null,
  35385. "allowNull": false,
  35386. "mapToData": null,
  35387. "validation": null,
  35388. "alias": null,
  35389. "deprecated": null
  35390. },
  35391. {
  35392. "name": "allow_rebase_merge",
  35393. "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.",
  35394. "in": "BODY",
  35395. "type": "boolean",
  35396. "required": false,
  35397. "enum": null,
  35398. "allowNull": false,
  35399. "mapToData": null,
  35400. "validation": null,
  35401. "alias": null,
  35402. "deprecated": null
  35403. }
  35404. ],
  35405. "responses": [
  35406. {
  35407. "code": 201,
  35408. "description": "response",
  35409. "examples": [
  35410. {
  35411. "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}"
  35412. }
  35413. ]
  35414. }
  35415. ],
  35416. "renamed": null
  35417. },
  35418. {
  35419. "name": "List a user's repository invitations",
  35420. "scope": "repos",
  35421. "id": "listInvitationsForAuthenticatedUser",
  35422. "method": "GET",
  35423. "url": "/user/repository_invitations",
  35424. "isDeprecated": false,
  35425. "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.\n\n",
  35426. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/invitations/#list-a-users-repository-invitations",
  35427. "previews": [],
  35428. "headers": [],
  35429. "parameters": [
  35430. {
  35431. "name": "per_page",
  35432. "description": "Results per page (max 100)",
  35433. "in": "QUERY",
  35434. "type": "integer",
  35435. "required": false,
  35436. "enum": null,
  35437. "allowNull": false,
  35438. "mapToData": null,
  35439. "validation": null,
  35440. "alias": null,
  35441. "deprecated": null
  35442. },
  35443. {
  35444. "name": "page",
  35445. "description": "Page number of the results to fetch.",
  35446. "in": "QUERY",
  35447. "type": "integer",
  35448. "required": false,
  35449. "enum": null,
  35450. "allowNull": false,
  35451. "mapToData": null,
  35452. "validation": null,
  35453. "alias": null,
  35454. "deprecated": null
  35455. }
  35456. ],
  35457. "responses": [
  35458. {
  35459. "code": 200,
  35460. "description": "response",
  35461. "examples": [
  35462. {
  35463. "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}]"
  35464. }
  35465. ]
  35466. }
  35467. ],
  35468. "renamed": null
  35469. },
  35470. {
  35471. "name": "Accept a repository invitation",
  35472. "scope": "repos",
  35473. "id": "acceptInvitation",
  35474. "method": "PATCH",
  35475. "url": "/user/repository_invitations/{invitation_id}",
  35476. "isDeprecated": false,
  35477. "description": "",
  35478. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/invitations/#accept-a-repository-invitation",
  35479. "previews": [],
  35480. "headers": [],
  35481. "parameters": [
  35482. {
  35483. "name": "invitation_id",
  35484. "description": "invitation_id parameter",
  35485. "in": "PATH",
  35486. "type": "integer",
  35487. "required": true,
  35488. "enum": null,
  35489. "allowNull": false,
  35490. "mapToData": null,
  35491. "validation": null,
  35492. "alias": null,
  35493. "deprecated": null
  35494. }
  35495. ],
  35496. "responses": [],
  35497. "renamed": null
  35498. },
  35499. {
  35500. "name": "Decline a repository invitation",
  35501. "scope": "repos",
  35502. "id": "declineInvitation",
  35503. "method": "DELETE",
  35504. "url": "/user/repository_invitations/{invitation_id}",
  35505. "isDeprecated": false,
  35506. "description": "",
  35507. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/invitations/#decline-a-repository-invitation",
  35508. "previews": [],
  35509. "headers": [],
  35510. "parameters": [
  35511. {
  35512. "name": "invitation_id",
  35513. "description": "invitation_id parameter",
  35514. "in": "PATH",
  35515. "type": "integer",
  35516. "required": true,
  35517. "enum": null,
  35518. "allowNull": false,
  35519. "mapToData": null,
  35520. "validation": null,
  35521. "alias": null,
  35522. "deprecated": null
  35523. }
  35524. ],
  35525. "responses": [],
  35526. "renamed": null
  35527. },
  35528. {
  35529. "name": "List repositories being starred by the authenticated user",
  35530. "scope": "activity",
  35531. "id": "listReposStarredByAuthenticatedUser",
  35532. "method": "GET",
  35533. "url": "/user/starred",
  35534. "isDeprecated": false,
  35535. "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/enterprise/2.17/v3/media/) via the `Accept` header:",
  35536. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/starring/#list-repositories-being-starred",
  35537. "previews": [],
  35538. "headers": [],
  35539. "parameters": [
  35540. {
  35541. "name": "sort",
  35542. "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).",
  35543. "in": "QUERY",
  35544. "type": "string",
  35545. "required": false,
  35546. "enum": ["created", "updated"],
  35547. "allowNull": false,
  35548. "mapToData": null,
  35549. "validation": null,
  35550. "alias": null,
  35551. "deprecated": null
  35552. },
  35553. {
  35554. "name": "direction",
  35555. "description": "One of `asc` (ascending) or `desc` (descending).",
  35556. "in": "QUERY",
  35557. "type": "string",
  35558. "required": false,
  35559. "enum": ["asc", "desc"],
  35560. "allowNull": false,
  35561. "mapToData": null,
  35562. "validation": null,
  35563. "alias": null,
  35564. "deprecated": null
  35565. },
  35566. {
  35567. "name": "per_page",
  35568. "description": "Results per page (max 100)",
  35569. "in": "QUERY",
  35570. "type": "integer",
  35571. "required": false,
  35572. "enum": null,
  35573. "allowNull": false,
  35574. "mapToData": null,
  35575. "validation": null,
  35576. "alias": null,
  35577. "deprecated": null
  35578. },
  35579. {
  35580. "name": "page",
  35581. "description": "Page number of the results to fetch.",
  35582. "in": "QUERY",
  35583. "type": "integer",
  35584. "required": false,
  35585. "enum": null,
  35586. "allowNull": false,
  35587. "mapToData": null,
  35588. "validation": null,
  35589. "alias": null,
  35590. "deprecated": null
  35591. }
  35592. ],
  35593. "responses": [
  35594. {
  35595. "code": 200,
  35596. "description": "response",
  35597. "examples": [
  35598. {
  35599. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}]"
  35600. }
  35601. ]
  35602. },
  35603. {
  35604. "code": 200,
  35605. "description": "response",
  35606. "examples": [
  35607. {
  35608. "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}]"
  35609. }
  35610. ]
  35611. }
  35612. ],
  35613. "renamed": null
  35614. },
  35615. {
  35616. "name": "Check if you are starring a repository",
  35617. "scope": "activity",
  35618. "id": "checkStarringRepo",
  35619. "method": "GET",
  35620. "url": "/user/starred/{owner}/{repo}",
  35621. "isDeprecated": false,
  35622. "description": "Requires for the user to be authenticated.",
  35623. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/starring/#check-if-you-are-starring-a-repository",
  35624. "previews": [],
  35625. "headers": [],
  35626. "parameters": [
  35627. {
  35628. "name": "owner",
  35629. "description": "owner parameter",
  35630. "in": "PATH",
  35631. "type": "string",
  35632. "required": true,
  35633. "enum": null,
  35634. "allowNull": false,
  35635. "mapToData": null,
  35636. "validation": null,
  35637. "alias": null,
  35638. "deprecated": null
  35639. },
  35640. {
  35641. "name": "repo",
  35642. "description": "repo parameter",
  35643. "in": "PATH",
  35644. "type": "string",
  35645. "required": true,
  35646. "enum": null,
  35647. "allowNull": false,
  35648. "mapToData": null,
  35649. "validation": null,
  35650. "alias": null,
  35651. "deprecated": null
  35652. }
  35653. ],
  35654. "responses": [],
  35655. "renamed": null
  35656. },
  35657. {
  35658. "name": "Star a repository",
  35659. "scope": "activity",
  35660. "id": "starRepo",
  35661. "method": "PUT",
  35662. "url": "/user/starred/{owner}/{repo}",
  35663. "isDeprecated": false,
  35664. "description": "Requires for the user to be authenticated.\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  35665. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/starring/#star-a-repository",
  35666. "previews": [],
  35667. "headers": [],
  35668. "parameters": [
  35669. {
  35670. "name": "owner",
  35671. "description": "owner parameter",
  35672. "in": "PATH",
  35673. "type": "string",
  35674. "required": true,
  35675. "enum": null,
  35676. "allowNull": false,
  35677. "mapToData": null,
  35678. "validation": null,
  35679. "alias": null,
  35680. "deprecated": null
  35681. },
  35682. {
  35683. "name": "repo",
  35684. "description": "repo parameter",
  35685. "in": "PATH",
  35686. "type": "string",
  35687. "required": true,
  35688. "enum": null,
  35689. "allowNull": false,
  35690. "mapToData": null,
  35691. "validation": null,
  35692. "alias": null,
  35693. "deprecated": null
  35694. }
  35695. ],
  35696. "responses": [],
  35697. "renamed": null
  35698. },
  35699. {
  35700. "name": "Unstar a repository",
  35701. "scope": "activity",
  35702. "id": "unstarRepo",
  35703. "method": "DELETE",
  35704. "url": "/user/starred/{owner}/{repo}",
  35705. "isDeprecated": false,
  35706. "description": "Requires for the user to be authenticated.",
  35707. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/starring/#unstar-a-repository",
  35708. "previews": [],
  35709. "headers": [],
  35710. "parameters": [
  35711. {
  35712. "name": "owner",
  35713. "description": "owner parameter",
  35714. "in": "PATH",
  35715. "type": "string",
  35716. "required": true,
  35717. "enum": null,
  35718. "allowNull": false,
  35719. "mapToData": null,
  35720. "validation": null,
  35721. "alias": null,
  35722. "deprecated": null
  35723. },
  35724. {
  35725. "name": "repo",
  35726. "description": "repo parameter",
  35727. "in": "PATH",
  35728. "type": "string",
  35729. "required": true,
  35730. "enum": null,
  35731. "allowNull": false,
  35732. "mapToData": null,
  35733. "validation": null,
  35734. "alias": null,
  35735. "deprecated": null
  35736. }
  35737. ],
  35738. "responses": [],
  35739. "renamed": null
  35740. },
  35741. {
  35742. "name": "List repositories being watched by the authenticated user",
  35743. "scope": "activity",
  35744. "id": "listWatchedReposForAuthenticatedUser",
  35745. "method": "GET",
  35746. "url": "/user/subscriptions",
  35747. "isDeprecated": false,
  35748. "description": "",
  35749. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/watching/#list-repositories-being-watched",
  35750. "previews": [],
  35751. "headers": [],
  35752. "parameters": [
  35753. {
  35754. "name": "per_page",
  35755. "description": "Results per page (max 100)",
  35756. "in": "QUERY",
  35757. "type": "integer",
  35758. "required": false,
  35759. "enum": null,
  35760. "allowNull": false,
  35761. "mapToData": null,
  35762. "validation": null,
  35763. "alias": null,
  35764. "deprecated": null
  35765. },
  35766. {
  35767. "name": "page",
  35768. "description": "Page number of the results to fetch.",
  35769. "in": "QUERY",
  35770. "type": "integer",
  35771. "required": false,
  35772. "enum": null,
  35773. "allowNull": false,
  35774. "mapToData": null,
  35775. "validation": null,
  35776. "alias": null,
  35777. "deprecated": null
  35778. }
  35779. ],
  35780. "responses": [
  35781. {
  35782. "code": 200,
  35783. "description": "response",
  35784. "examples": [
  35785. {
  35786. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]"
  35787. }
  35788. ]
  35789. }
  35790. ],
  35791. "renamed": null
  35792. },
  35793. {
  35794. "name": "List user teams",
  35795. "scope": "teams",
  35796. "id": "listForAuthenticatedUser",
  35797. "method": "GET",
  35798. "url": "/user/teams",
  35799. "isDeprecated": false,
  35800. "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/enterprise/2.17/apps/building-oauth-apps/).",
  35801. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/teams/#list-user-teams",
  35802. "previews": [],
  35803. "headers": [],
  35804. "parameters": [
  35805. {
  35806. "name": "per_page",
  35807. "description": "Results per page (max 100)",
  35808. "in": "QUERY",
  35809. "type": "integer",
  35810. "required": false,
  35811. "enum": null,
  35812. "allowNull": false,
  35813. "mapToData": null,
  35814. "validation": null,
  35815. "alias": null,
  35816. "deprecated": null
  35817. },
  35818. {
  35819. "name": "page",
  35820. "description": "Page number of the results to fetch.",
  35821. "in": "QUERY",
  35822. "type": "integer",
  35823. "required": false,
  35824. "enum": null,
  35825. "allowNull": false,
  35826. "mapToData": null,
  35827. "validation": null,
  35828. "alias": null,
  35829. "deprecated": null
  35830. }
  35831. ],
  35832. "responses": [
  35833. {
  35834. "code": 200,
  35835. "description": "response",
  35836. "examples": [
  35837. {
  35838. "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"},\"ldap_dn\":\"uid=asdf,ou=users,dc=github,dc=com\"}]"
  35839. }
  35840. ]
  35841. }
  35842. ],
  35843. "renamed": null
  35844. },
  35845. {
  35846. "name": "Get all users",
  35847. "scope": "users",
  35848. "id": "list",
  35849. "method": "GET",
  35850. "url": "/users",
  35851. "isDeprecated": false,
  35852. "description": "Lists all users, in the order that they signed up on GitHub Enterprise Server. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/enterprise/2.17/v3/#link-header) to get the URL for the next page of users.",
  35853. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/#get-all-users",
  35854. "previews": [],
  35855. "headers": [],
  35856. "parameters": [
  35857. {
  35858. "name": "since",
  35859. "description": "The integer ID of the last User that you've seen.",
  35860. "in": "QUERY",
  35861. "type": "string",
  35862. "required": false,
  35863. "enum": null,
  35864. "allowNull": false,
  35865. "mapToData": null,
  35866. "validation": null,
  35867. "alias": null,
  35868. "deprecated": null
  35869. },
  35870. {
  35871. "name": "per_page",
  35872. "description": "Results per page (max 100)",
  35873. "in": "QUERY",
  35874. "type": "integer",
  35875. "required": false,
  35876. "enum": null,
  35877. "allowNull": false,
  35878. "mapToData": null,
  35879. "validation": null,
  35880. "alias": null,
  35881. "deprecated": null
  35882. },
  35883. {
  35884. "name": "page",
  35885. "description": "Page number of the results to fetch.",
  35886. "in": "QUERY",
  35887. "type": "integer",
  35888. "required": false,
  35889. "enum": null,
  35890. "allowNull": false,
  35891. "mapToData": null,
  35892. "validation": null,
  35893. "alias": null,
  35894. "deprecated": null
  35895. }
  35896. ],
  35897. "responses": [
  35898. {
  35899. "code": 200,
  35900. "description": "response",
  35901. "examples": [
  35902. {
  35903. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  35904. }
  35905. ]
  35906. }
  35907. ],
  35908. "renamed": null
  35909. },
  35910. {
  35911. "name": "Get a single user",
  35912. "scope": "users",
  35913. "id": "getByUsername",
  35914. "method": "GET",
  35915. "url": "/users/{username}",
  35916. "isDeprecated": false,
  35917. "description": "Provides publicly available information about someone with a GitHub Enterprise Server account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise Server [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise Server. For more information, see [Authentication](https://developer.github.com/enterprise/2.17/v3/#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://developer.github.com/enterprise/2.17/v3/users/emails/)\".",
  35918. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/#get-a-single-user",
  35919. "previews": [],
  35920. "headers": [],
  35921. "parameters": [
  35922. {
  35923. "name": "username",
  35924. "description": "username parameter",
  35925. "in": "PATH",
  35926. "type": "string",
  35927. "required": true,
  35928. "enum": null,
  35929. "allowNull": false,
  35930. "mapToData": null,
  35931. "validation": null,
  35932. "alias": null,
  35933. "deprecated": null
  35934. }
  35935. ],
  35936. "responses": [
  35937. {
  35938. "code": 200,
  35939. "description": "response",
  35940. "examples": [
  35941. {
  35942. "data": "{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"hireable\":false,\"bio\":\"There once was...\",\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"created_at\":\"2008-01-14T04:33:35Z\",\"updated_at\":\"2008-01-14T04:33:35Z\"}"
  35943. }
  35944. ]
  35945. }
  35946. ],
  35947. "renamed": null
  35948. },
  35949. {
  35950. "name": "List events performed by a user",
  35951. "scope": "activity",
  35952. "id": "listEventsForUser",
  35953. "method": "GET",
  35954. "url": "/users/{username}/events",
  35955. "isDeprecated": false,
  35956. "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.",
  35957. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-events-performed-by-a-user",
  35958. "previews": [],
  35959. "headers": [],
  35960. "parameters": [
  35961. {
  35962. "name": "username",
  35963. "description": "username parameter",
  35964. "in": "PATH",
  35965. "type": "string",
  35966. "required": true,
  35967. "enum": null,
  35968. "allowNull": false,
  35969. "mapToData": null,
  35970. "validation": null,
  35971. "alias": null,
  35972. "deprecated": null
  35973. },
  35974. {
  35975. "name": "per_page",
  35976. "description": "Results per page (max 100)",
  35977. "in": "QUERY",
  35978. "type": "integer",
  35979. "required": false,
  35980. "enum": null,
  35981. "allowNull": false,
  35982. "mapToData": null,
  35983. "validation": null,
  35984. "alias": null,
  35985. "deprecated": null
  35986. },
  35987. {
  35988. "name": "page",
  35989. "description": "Page number of the results to fetch.",
  35990. "in": "QUERY",
  35991. "type": "integer",
  35992. "required": false,
  35993. "enum": null,
  35994. "allowNull": false,
  35995. "mapToData": null,
  35996. "validation": null,
  35997. "alias": null,
  35998. "deprecated": null
  35999. }
  36000. ],
  36001. "responses": [],
  36002. "renamed": null
  36003. },
  36004. {
  36005. "name": "List events for an organization",
  36006. "scope": "activity",
  36007. "id": "listEventsForOrg",
  36008. "method": "GET",
  36009. "url": "/users/{username}/events/orgs/{org}",
  36010. "isDeprecated": false,
  36011. "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.",
  36012. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-events-for-an-organization",
  36013. "previews": [],
  36014. "headers": [],
  36015. "parameters": [
  36016. {
  36017. "name": "username",
  36018. "description": "username parameter",
  36019. "in": "PATH",
  36020. "type": "string",
  36021. "required": true,
  36022. "enum": null,
  36023. "allowNull": false,
  36024. "mapToData": null,
  36025. "validation": null,
  36026. "alias": null,
  36027. "deprecated": null
  36028. },
  36029. {
  36030. "name": "org",
  36031. "description": "org parameter",
  36032. "in": "PATH",
  36033. "type": "string",
  36034. "required": true,
  36035. "enum": null,
  36036. "allowNull": false,
  36037. "mapToData": null,
  36038. "validation": null,
  36039. "alias": null,
  36040. "deprecated": null
  36041. },
  36042. {
  36043. "name": "per_page",
  36044. "description": "Results per page (max 100)",
  36045. "in": "QUERY",
  36046. "type": "integer",
  36047. "required": false,
  36048. "enum": null,
  36049. "allowNull": false,
  36050. "mapToData": null,
  36051. "validation": null,
  36052. "alias": null,
  36053. "deprecated": null
  36054. },
  36055. {
  36056. "name": "page",
  36057. "description": "Page number of the results to fetch.",
  36058. "in": "QUERY",
  36059. "type": "integer",
  36060. "required": false,
  36061. "enum": null,
  36062. "allowNull": false,
  36063. "mapToData": null,
  36064. "validation": null,
  36065. "alias": null,
  36066. "deprecated": null
  36067. }
  36068. ],
  36069. "responses": [],
  36070. "renamed": null
  36071. },
  36072. {
  36073. "name": "List public events performed by a user",
  36074. "scope": "activity",
  36075. "id": "listPublicEventsForUser",
  36076. "method": "GET",
  36077. "url": "/users/{username}/events/public",
  36078. "isDeprecated": false,
  36079. "description": "",
  36080. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-public-events-performed-by-a-user",
  36081. "previews": [],
  36082. "headers": [],
  36083. "parameters": [
  36084. {
  36085. "name": "username",
  36086. "description": "username parameter",
  36087. "in": "PATH",
  36088. "type": "string",
  36089. "required": true,
  36090. "enum": null,
  36091. "allowNull": false,
  36092. "mapToData": null,
  36093. "validation": null,
  36094. "alias": null,
  36095. "deprecated": null
  36096. },
  36097. {
  36098. "name": "per_page",
  36099. "description": "Results per page (max 100)",
  36100. "in": "QUERY",
  36101. "type": "integer",
  36102. "required": false,
  36103. "enum": null,
  36104. "allowNull": false,
  36105. "mapToData": null,
  36106. "validation": null,
  36107. "alias": null,
  36108. "deprecated": null
  36109. },
  36110. {
  36111. "name": "page",
  36112. "description": "Page number of the results to fetch.",
  36113. "in": "QUERY",
  36114. "type": "integer",
  36115. "required": false,
  36116. "enum": null,
  36117. "allowNull": false,
  36118. "mapToData": null,
  36119. "validation": null,
  36120. "alias": null,
  36121. "deprecated": null
  36122. }
  36123. ],
  36124. "responses": [],
  36125. "renamed": null
  36126. },
  36127. {
  36128. "name": "List a user's followers",
  36129. "scope": "users",
  36130. "id": "listFollowersForUser",
  36131. "method": "GET",
  36132. "url": "/users/{username}/followers",
  36133. "isDeprecated": false,
  36134. "description": "",
  36135. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#list-followers-of-a-user",
  36136. "previews": [],
  36137. "headers": [],
  36138. "parameters": [
  36139. {
  36140. "name": "username",
  36141. "description": "username parameter",
  36142. "in": "PATH",
  36143. "type": "string",
  36144. "required": true,
  36145. "enum": null,
  36146. "allowNull": false,
  36147. "mapToData": null,
  36148. "validation": null,
  36149. "alias": null,
  36150. "deprecated": null
  36151. },
  36152. {
  36153. "name": "per_page",
  36154. "description": "Results per page (max 100)",
  36155. "in": "QUERY",
  36156. "type": "integer",
  36157. "required": false,
  36158. "enum": null,
  36159. "allowNull": false,
  36160. "mapToData": null,
  36161. "validation": null,
  36162. "alias": null,
  36163. "deprecated": null
  36164. },
  36165. {
  36166. "name": "page",
  36167. "description": "Page number of the results to fetch.",
  36168. "in": "QUERY",
  36169. "type": "integer",
  36170. "required": false,
  36171. "enum": null,
  36172. "allowNull": false,
  36173. "mapToData": null,
  36174. "validation": null,
  36175. "alias": null,
  36176. "deprecated": null
  36177. }
  36178. ],
  36179. "responses": [
  36180. {
  36181. "code": 200,
  36182. "description": "response",
  36183. "examples": [
  36184. {
  36185. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  36186. }
  36187. ]
  36188. }
  36189. ],
  36190. "renamed": null
  36191. },
  36192. {
  36193. "name": "List who a user is following",
  36194. "scope": "users",
  36195. "id": "listFollowingForUser",
  36196. "method": "GET",
  36197. "url": "/users/{username}/following",
  36198. "isDeprecated": false,
  36199. "description": "",
  36200. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#list-users-followed-by-another-user",
  36201. "previews": [],
  36202. "headers": [],
  36203. "parameters": [
  36204. {
  36205. "name": "username",
  36206. "description": "username parameter",
  36207. "in": "PATH",
  36208. "type": "string",
  36209. "required": true,
  36210. "enum": null,
  36211. "allowNull": false,
  36212. "mapToData": null,
  36213. "validation": null,
  36214. "alias": null,
  36215. "deprecated": null
  36216. },
  36217. {
  36218. "name": "per_page",
  36219. "description": "Results per page (max 100)",
  36220. "in": "QUERY",
  36221. "type": "integer",
  36222. "required": false,
  36223. "enum": null,
  36224. "allowNull": false,
  36225. "mapToData": null,
  36226. "validation": null,
  36227. "alias": null,
  36228. "deprecated": null
  36229. },
  36230. {
  36231. "name": "page",
  36232. "description": "Page number of the results to fetch.",
  36233. "in": "QUERY",
  36234. "type": "integer",
  36235. "required": false,
  36236. "enum": null,
  36237. "allowNull": false,
  36238. "mapToData": null,
  36239. "validation": null,
  36240. "alias": null,
  36241. "deprecated": null
  36242. }
  36243. ],
  36244. "responses": [
  36245. {
  36246. "code": 200,
  36247. "description": "response",
  36248. "examples": [
  36249. {
  36250. "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]"
  36251. }
  36252. ]
  36253. }
  36254. ],
  36255. "renamed": null
  36256. },
  36257. {
  36258. "name": "Check if one user follows another",
  36259. "scope": "users",
  36260. "id": "checkFollowingForUser",
  36261. "method": "GET",
  36262. "url": "/users/{username}/following/{target_user}",
  36263. "isDeprecated": false,
  36264. "description": "",
  36265. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/followers/#check-if-one-user-follows-another",
  36266. "previews": [],
  36267. "headers": [],
  36268. "parameters": [
  36269. {
  36270. "name": "username",
  36271. "description": "username parameter",
  36272. "in": "PATH",
  36273. "type": "string",
  36274. "required": true,
  36275. "enum": null,
  36276. "allowNull": false,
  36277. "mapToData": null,
  36278. "validation": null,
  36279. "alias": null,
  36280. "deprecated": null
  36281. },
  36282. {
  36283. "name": "target_user",
  36284. "description": "target_user parameter",
  36285. "in": "PATH",
  36286. "type": "string",
  36287. "required": true,
  36288. "enum": null,
  36289. "allowNull": false,
  36290. "mapToData": null,
  36291. "validation": null,
  36292. "alias": null,
  36293. "deprecated": null
  36294. }
  36295. ],
  36296. "responses": [],
  36297. "renamed": null
  36298. },
  36299. {
  36300. "name": "List public gists for the specified user",
  36301. "scope": "gists",
  36302. "id": "listPublicForUser",
  36303. "method": "GET",
  36304. "url": "/users/{username}/gists",
  36305. "isDeprecated": false,
  36306. "description": "",
  36307. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/gists/#list-a-users-gists",
  36308. "previews": [],
  36309. "headers": [],
  36310. "parameters": [
  36311. {
  36312. "name": "username",
  36313. "description": "username parameter",
  36314. "in": "PATH",
  36315. "type": "string",
  36316. "required": true,
  36317. "enum": null,
  36318. "allowNull": false,
  36319. "mapToData": null,
  36320. "validation": null,
  36321. "alias": null,
  36322. "deprecated": null
  36323. },
  36324. {
  36325. "name": "since",
  36326. "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.",
  36327. "in": "QUERY",
  36328. "type": "string",
  36329. "required": false,
  36330. "enum": null,
  36331. "allowNull": false,
  36332. "mapToData": null,
  36333. "validation": null,
  36334. "alias": null,
  36335. "deprecated": null
  36336. },
  36337. {
  36338. "name": "per_page",
  36339. "description": "Results per page (max 100)",
  36340. "in": "QUERY",
  36341. "type": "integer",
  36342. "required": false,
  36343. "enum": null,
  36344. "allowNull": false,
  36345. "mapToData": null,
  36346. "validation": null,
  36347. "alias": null,
  36348. "deprecated": null
  36349. },
  36350. {
  36351. "name": "page",
  36352. "description": "Page number of the results to fetch.",
  36353. "in": "QUERY",
  36354. "type": "integer",
  36355. "required": false,
  36356. "enum": null,
  36357. "allowNull": false,
  36358. "mapToData": null,
  36359. "validation": null,
  36360. "alias": null,
  36361. "deprecated": null
  36362. }
  36363. ],
  36364. "responses": [
  36365. {
  36366. "code": 200,
  36367. "description": "response",
  36368. "examples": [
  36369. {
  36370. "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]"
  36371. }
  36372. ]
  36373. }
  36374. ],
  36375. "renamed": null
  36376. },
  36377. {
  36378. "name": "List GPG keys for a user",
  36379. "scope": "users",
  36380. "id": "listGpgKeysForUser",
  36381. "method": "GET",
  36382. "url": "/users/{username}/gpg_keys",
  36383. "isDeprecated": false,
  36384. "description": "Lists the GPG keys for a user. This information is accessible by anyone.",
  36385. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/gpg_keys/#list-gpg-keys-for-a-user",
  36386. "previews": [],
  36387. "headers": [],
  36388. "parameters": [
  36389. {
  36390. "name": "username",
  36391. "description": "username parameter",
  36392. "in": "PATH",
  36393. "type": "string",
  36394. "required": true,
  36395. "enum": null,
  36396. "allowNull": false,
  36397. "mapToData": null,
  36398. "validation": null,
  36399. "alias": null,
  36400. "deprecated": null
  36401. },
  36402. {
  36403. "name": "per_page",
  36404. "description": "Results per page (max 100)",
  36405. "in": "QUERY",
  36406. "type": "integer",
  36407. "required": false,
  36408. "enum": null,
  36409. "allowNull": false,
  36410. "mapToData": null,
  36411. "validation": null,
  36412. "alias": null,
  36413. "deprecated": null
  36414. },
  36415. {
  36416. "name": "page",
  36417. "description": "Page number of the results to fetch.",
  36418. "in": "QUERY",
  36419. "type": "integer",
  36420. "required": false,
  36421. "enum": null,
  36422. "allowNull": false,
  36423. "mapToData": null,
  36424. "validation": null,
  36425. "alias": null,
  36426. "deprecated": null
  36427. }
  36428. ],
  36429. "responses": [
  36430. {
  36431. "code": 200,
  36432. "description": "response",
  36433. "examples": [
  36434. {
  36435. "data": "[{\"id\":3,\"primary_key_id\":null,\"key_id\":\"3262EFF25BA0D270\",\"public_key\":\"xsBNBFayYZ...\",\"emails\":[{\"email\":\"mastahyeti@users.noreply.github.com\",\"verified\":true}],\"subkeys\":[{\"id\":4,\"primary_key_id\":3,\"key_id\":\"4A595D4C72EE49C7\",\"public_key\":\"zsBNBFayYZ...\",\"emails\":[],\"subkeys\":[],\"can_sign\":false,\"can_encrypt_comms\":true,\"can_encrypt_storage\":true,\"can_certify\":false,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}],\"can_sign\":true,\"can_encrypt_comms\":false,\"can_encrypt_storage\":false,\"can_certify\":true,\"created_at\":\"2016-03-24T11:31:04-06:00\",\"expires_at\":null}]"
  36436. }
  36437. ]
  36438. }
  36439. ],
  36440. "renamed": null
  36441. },
  36442. {
  36443. "name": "Get contextual information about a user",
  36444. "scope": "users",
  36445. "id": "getContextForUser",
  36446. "method": "GET",
  36447. "url": "/users/{username}/hovercard",
  36448. "isDeprecated": false,
  36449. "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:",
  36450. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/#get-contextual-information-about-a-user",
  36451. "previews": [{ "name": "hagar" }],
  36452. "headers": [
  36453. { "name": "accept", "value": "application/vnd.github.hagar-preview+json" }
  36454. ],
  36455. "parameters": [
  36456. {
  36457. "name": "username",
  36458. "description": "username parameter",
  36459. "in": "PATH",
  36460. "type": "string",
  36461. "required": true,
  36462. "enum": null,
  36463. "allowNull": false,
  36464. "mapToData": null,
  36465. "validation": null,
  36466. "alias": null,
  36467. "deprecated": null
  36468. },
  36469. {
  36470. "name": "subject_type",
  36471. "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`.",
  36472. "in": "QUERY",
  36473. "type": "string",
  36474. "required": false,
  36475. "enum": ["organization", "repository", "issue", "pull_request"],
  36476. "allowNull": false,
  36477. "mapToData": null,
  36478. "validation": null,
  36479. "alias": null,
  36480. "deprecated": null
  36481. },
  36482. {
  36483. "name": "subject_id",
  36484. "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`.",
  36485. "in": "QUERY",
  36486. "type": "string",
  36487. "required": false,
  36488. "enum": null,
  36489. "allowNull": false,
  36490. "mapToData": null,
  36491. "validation": null,
  36492. "alias": null,
  36493. "deprecated": null
  36494. }
  36495. ],
  36496. "responses": [
  36497. {
  36498. "code": 200,
  36499. "description": "response",
  36500. "examples": [
  36501. {
  36502. "data": "{\"contexts\":[{\"message\":\"Owns this repository\",\"octicon\":\"repo\"}]}"
  36503. }
  36504. ]
  36505. }
  36506. ],
  36507. "renamed": null
  36508. },
  36509. {
  36510. "name": "Get a user installation",
  36511. "scope": "apps",
  36512. "id": "getUserInstallation",
  36513. "method": "GET",
  36514. "url": "/users/{username}/installation",
  36515. "isDeprecated": false,
  36516. "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  36517. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-a-user-installation",
  36518. "previews": [{ "name": "machine-man" }],
  36519. "headers": [
  36520. {
  36521. "name": "accept",
  36522. "value": "application/vnd.github.machine-man-preview+json"
  36523. }
  36524. ],
  36525. "parameters": [
  36526. {
  36527. "name": "username",
  36528. "description": "username parameter",
  36529. "in": "PATH",
  36530. "type": "string",
  36531. "required": true,
  36532. "enum": null,
  36533. "allowNull": false,
  36534. "mapToData": null,
  36535. "validation": null,
  36536. "alias": null,
  36537. "deprecated": null
  36538. }
  36539. ],
  36540. "responses": [
  36541. {
  36542. "code": 200,
  36543. "description": "response",
  36544. "examples": [
  36545. {
  36546. "data": "{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/installations/3/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/3\",\"app_id\":2,\"target_id\":1,\"target_type\":\"User\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"label\"],\"created_at\":\"2018-02-22T20:51:14Z\",\"updated_at\":\"2018-02-22T20:51:14Z\",\"single_file_name\":null}"
  36547. }
  36548. ]
  36549. }
  36550. ],
  36551. "renamed": null
  36552. },
  36553. {
  36554. "name": "Get a user installation",
  36555. "scope": "apps",
  36556. "id": "findUserInstallation",
  36557. "method": "GET",
  36558. "url": "/users/{username}/installation",
  36559. "isDeprecated": false,
  36560. "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.17/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.",
  36561. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/apps/#get-a-user-installation",
  36562. "previews": [{ "name": "machine-man" }],
  36563. "headers": [
  36564. {
  36565. "name": "accept",
  36566. "value": "application/vnd.github.machine-man-preview+json"
  36567. }
  36568. ],
  36569. "parameters": [
  36570. {
  36571. "name": "username",
  36572. "description": "username parameter",
  36573. "in": "PATH",
  36574. "type": "string",
  36575. "required": true,
  36576. "enum": null,
  36577. "allowNull": false,
  36578. "mapToData": null,
  36579. "validation": null,
  36580. "alias": null,
  36581. "deprecated": null
  36582. }
  36583. ],
  36584. "responses": [
  36585. {
  36586. "code": 200,
  36587. "description": "response",
  36588. "examples": [
  36589. {
  36590. "data": "{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/installations/3/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/3\",\"app_id\":2,\"target_id\":1,\"target_type\":\"User\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"label\"],\"created_at\":\"2018-02-22T20:51:14Z\",\"updated_at\":\"2018-02-22T20:51:14Z\",\"single_file_name\":null}"
  36591. }
  36592. ]
  36593. }
  36594. ],
  36595. "renamed": {
  36596. "before": { "scope": "apps", "id": "findUserInstallation" },
  36597. "after": { "scope": "apps", "id": "getUserInstallation" },
  36598. "date": "2019-04-10",
  36599. "note": "\"Find repository installation\" renamed to \"Get a repository installation\""
  36600. }
  36601. },
  36602. {
  36603. "name": "List public keys for a user",
  36604. "scope": "users",
  36605. "id": "listPublicKeysForUser",
  36606. "method": "GET",
  36607. "url": "/users/{username}/keys",
  36608. "isDeprecated": false,
  36609. "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.",
  36610. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/users/keys/#list-public-keys-for-a-user",
  36611. "previews": [],
  36612. "headers": [],
  36613. "parameters": [
  36614. {
  36615. "name": "username",
  36616. "description": "username parameter",
  36617. "in": "PATH",
  36618. "type": "string",
  36619. "required": true,
  36620. "enum": null,
  36621. "allowNull": false,
  36622. "mapToData": null,
  36623. "validation": null,
  36624. "alias": null,
  36625. "deprecated": null
  36626. },
  36627. {
  36628. "name": "per_page",
  36629. "description": "Results per page (max 100)",
  36630. "in": "QUERY",
  36631. "type": "integer",
  36632. "required": false,
  36633. "enum": null,
  36634. "allowNull": false,
  36635. "mapToData": null,
  36636. "validation": null,
  36637. "alias": null,
  36638. "deprecated": null
  36639. },
  36640. {
  36641. "name": "page",
  36642. "description": "Page number of the results to fetch.",
  36643. "in": "QUERY",
  36644. "type": "integer",
  36645. "required": false,
  36646. "enum": null,
  36647. "allowNull": false,
  36648. "mapToData": null,
  36649. "validation": null,
  36650. "alias": null,
  36651. "deprecated": null
  36652. }
  36653. ],
  36654. "responses": [
  36655. {
  36656. "code": 200,
  36657. "description": "response",
  36658. "examples": [{ "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\"}]" }]
  36659. }
  36660. ],
  36661. "renamed": null
  36662. },
  36663. {
  36664. "name": "List user organizations",
  36665. "scope": "orgs",
  36666. "id": "listForUser",
  36667. "method": "GET",
  36668. "url": "/users/{username}/orgs",
  36669. "isDeprecated": false,
  36670. "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List your organizations](https://developer.github.com/enterprise/2.17/v3/orgs/#list-your-organizations) API instead.",
  36671. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/orgs/#list-user-organizations",
  36672. "previews": [],
  36673. "headers": [],
  36674. "parameters": [
  36675. {
  36676. "name": "username",
  36677. "description": "username parameter",
  36678. "in": "PATH",
  36679. "type": "string",
  36680. "required": true,
  36681. "enum": null,
  36682. "allowNull": false,
  36683. "mapToData": null,
  36684. "validation": null,
  36685. "alias": null,
  36686. "deprecated": null
  36687. },
  36688. {
  36689. "name": "per_page",
  36690. "description": "Results per page (max 100)",
  36691. "in": "QUERY",
  36692. "type": "integer",
  36693. "required": false,
  36694. "enum": null,
  36695. "allowNull": false,
  36696. "mapToData": null,
  36697. "validation": null,
  36698. "alias": null,
  36699. "deprecated": null
  36700. },
  36701. {
  36702. "name": "page",
  36703. "description": "Page number of the results to fetch.",
  36704. "in": "QUERY",
  36705. "type": "integer",
  36706. "required": false,
  36707. "enum": null,
  36708. "allowNull": false,
  36709. "mapToData": null,
  36710. "validation": null,
  36711. "alias": null,
  36712. "deprecated": null
  36713. }
  36714. ],
  36715. "responses": [
  36716. {
  36717. "code": 200,
  36718. "description": "response",
  36719. "examples": [
  36720. {
  36721. "data": "[{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]"
  36722. }
  36723. ]
  36724. }
  36725. ],
  36726. "renamed": null
  36727. },
  36728. {
  36729. "name": "List user projects",
  36730. "scope": "projects",
  36731. "id": "listForUser",
  36732. "method": "GET",
  36733. "url": "/users/{username}/projects",
  36734. "isDeprecated": false,
  36735. "description": "",
  36736. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/projects/#list-user-projects",
  36737. "previews": [{ "name": "inertia" }],
  36738. "headers": [
  36739. {
  36740. "name": "accept",
  36741. "value": "application/vnd.github.inertia-preview+json"
  36742. }
  36743. ],
  36744. "parameters": [
  36745. {
  36746. "name": "username",
  36747. "description": "username parameter",
  36748. "in": "PATH",
  36749. "type": "string",
  36750. "required": true,
  36751. "enum": null,
  36752. "allowNull": false,
  36753. "mapToData": null,
  36754. "validation": null,
  36755. "alias": null,
  36756. "deprecated": null
  36757. },
  36758. {
  36759. "name": "state",
  36760. "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.",
  36761. "in": "QUERY",
  36762. "type": "string",
  36763. "required": false,
  36764. "enum": ["open", "closed", "all"],
  36765. "allowNull": false,
  36766. "mapToData": null,
  36767. "validation": null,
  36768. "alias": null,
  36769. "deprecated": null
  36770. },
  36771. {
  36772. "name": "per_page",
  36773. "description": "Results per page (max 100)",
  36774. "in": "QUERY",
  36775. "type": "integer",
  36776. "required": false,
  36777. "enum": null,
  36778. "allowNull": false,
  36779. "mapToData": null,
  36780. "validation": null,
  36781. "alias": null,
  36782. "deprecated": null
  36783. },
  36784. {
  36785. "name": "page",
  36786. "description": "Page number of the results to fetch.",
  36787. "in": "QUERY",
  36788. "type": "integer",
  36789. "required": false,
  36790. "enum": null,
  36791. "allowNull": false,
  36792. "mapToData": null,
  36793. "validation": null,
  36794. "alias": null,
  36795. "deprecated": null
  36796. }
  36797. ],
  36798. "responses": [
  36799. {
  36800. "code": 200,
  36801. "description": "response",
  36802. "examples": [
  36803. {
  36804. "data": "[{\"owner_url\":\"https://api.github.com/users/octocat\",\"url\":\"https://api.github.com/projects/1002603\",\"html_url\":\"https://github.com/users/octocat/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002603/columns\",\"id\":1002603,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDM=\",\"name\":\"My Projects\",\"body\":\"A board to manage my personal projects.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]"
  36805. }
  36806. ]
  36807. }
  36808. ],
  36809. "renamed": null
  36810. },
  36811. {
  36812. "name": "List events that a user has received",
  36813. "scope": "activity",
  36814. "id": "listReceivedEventsForUser",
  36815. "method": "GET",
  36816. "url": "/users/{username}/received_events",
  36817. "isDeprecated": false,
  36818. "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.",
  36819. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-events-that-a-user-has-received",
  36820. "previews": [],
  36821. "headers": [],
  36822. "parameters": [
  36823. {
  36824. "name": "username",
  36825. "description": "username parameter",
  36826. "in": "PATH",
  36827. "type": "string",
  36828. "required": true,
  36829. "enum": null,
  36830. "allowNull": false,
  36831. "mapToData": null,
  36832. "validation": null,
  36833. "alias": null,
  36834. "deprecated": null
  36835. },
  36836. {
  36837. "name": "per_page",
  36838. "description": "Results per page (max 100)",
  36839. "in": "QUERY",
  36840. "type": "integer",
  36841. "required": false,
  36842. "enum": null,
  36843. "allowNull": false,
  36844. "mapToData": null,
  36845. "validation": null,
  36846. "alias": null,
  36847. "deprecated": null
  36848. },
  36849. {
  36850. "name": "page",
  36851. "description": "Page number of the results to fetch.",
  36852. "in": "QUERY",
  36853. "type": "integer",
  36854. "required": false,
  36855. "enum": null,
  36856. "allowNull": false,
  36857. "mapToData": null,
  36858. "validation": null,
  36859. "alias": null,
  36860. "deprecated": null
  36861. }
  36862. ],
  36863. "responses": [],
  36864. "renamed": null
  36865. },
  36866. {
  36867. "name": "List public events that a user has received",
  36868. "scope": "activity",
  36869. "id": "listReceivedPublicEventsForUser",
  36870. "method": "GET",
  36871. "url": "/users/{username}/received_events/public",
  36872. "isDeprecated": false,
  36873. "description": "",
  36874. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/events/#list-public-events-that-a-user-has-received",
  36875. "previews": [],
  36876. "headers": [],
  36877. "parameters": [
  36878. {
  36879. "name": "username",
  36880. "description": "username parameter",
  36881. "in": "PATH",
  36882. "type": "string",
  36883. "required": true,
  36884. "enum": null,
  36885. "allowNull": false,
  36886. "mapToData": null,
  36887. "validation": null,
  36888. "alias": null,
  36889. "deprecated": null
  36890. },
  36891. {
  36892. "name": "per_page",
  36893. "description": "Results per page (max 100)",
  36894. "in": "QUERY",
  36895. "type": "integer",
  36896. "required": false,
  36897. "enum": null,
  36898. "allowNull": false,
  36899. "mapToData": null,
  36900. "validation": null,
  36901. "alias": null,
  36902. "deprecated": null
  36903. },
  36904. {
  36905. "name": "page",
  36906. "description": "Page number of the results to fetch.",
  36907. "in": "QUERY",
  36908. "type": "integer",
  36909. "required": false,
  36910. "enum": null,
  36911. "allowNull": false,
  36912. "mapToData": null,
  36913. "validation": null,
  36914. "alias": null,
  36915. "deprecated": null
  36916. }
  36917. ],
  36918. "responses": [],
  36919. "renamed": null
  36920. },
  36921. {
  36922. "name": "List user repositories",
  36923. "scope": "repos",
  36924. "id": "listForUser",
  36925. "method": "GET",
  36926. "url": "/users/{username}/repos",
  36927. "isDeprecated": false,
  36928. "description": "Lists public repositories for the specified user.",
  36929. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/repos/#list-user-repositories",
  36930. "previews": [],
  36931. "headers": [],
  36932. "parameters": [
  36933. {
  36934. "name": "username",
  36935. "description": "username parameter",
  36936. "in": "PATH",
  36937. "type": "string",
  36938. "required": true,
  36939. "enum": null,
  36940. "allowNull": false,
  36941. "mapToData": null,
  36942. "validation": null,
  36943. "alias": null,
  36944. "deprecated": null
  36945. },
  36946. {
  36947. "name": "type",
  36948. "description": "Can be one of `all`, `owner`, `member`.",
  36949. "in": "QUERY",
  36950. "type": "string",
  36951. "required": false,
  36952. "enum": ["all", "owner", "member"],
  36953. "allowNull": false,
  36954. "mapToData": null,
  36955. "validation": null,
  36956. "alias": null,
  36957. "deprecated": null
  36958. },
  36959. {
  36960. "name": "sort",
  36961. "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.",
  36962. "in": "QUERY",
  36963. "type": "string",
  36964. "required": false,
  36965. "enum": ["created", "updated", "pushed", "full_name"],
  36966. "allowNull": false,
  36967. "mapToData": null,
  36968. "validation": null,
  36969. "alias": null,
  36970. "deprecated": null
  36971. },
  36972. {
  36973. "name": "direction",
  36974. "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`",
  36975. "in": "QUERY",
  36976. "type": "string",
  36977. "required": false,
  36978. "enum": ["asc", "desc"],
  36979. "allowNull": false,
  36980. "mapToData": null,
  36981. "validation": null,
  36982. "alias": null,
  36983. "deprecated": null
  36984. },
  36985. {
  36986. "name": "per_page",
  36987. "description": "Results per page (max 100)",
  36988. "in": "QUERY",
  36989. "type": "integer",
  36990. "required": false,
  36991. "enum": null,
  36992. "allowNull": false,
  36993. "mapToData": null,
  36994. "validation": null,
  36995. "alias": null,
  36996. "deprecated": null
  36997. },
  36998. {
  36999. "name": "page",
  37000. "description": "Page number of the results to fetch.",
  37001. "in": "QUERY",
  37002. "type": "integer",
  37003. "required": false,
  37004. "enum": null,
  37005. "allowNull": false,
  37006. "mapToData": null,
  37007. "validation": null,
  37008. "alias": null,
  37009. "deprecated": null
  37010. }
  37011. ],
  37012. "responses": [],
  37013. "renamed": null
  37014. },
  37015. {
  37016. "name": "Promote an ordinary user to a site administrator",
  37017. "scope": "enterpriseAdmin",
  37018. "id": "promoteOrdinaryUserToSiteAdministrator",
  37019. "method": "PUT",
  37020. "url": "/users/{username}/site_admin",
  37021. "isDeprecated": false,
  37022. "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  37023. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator",
  37024. "previews": [],
  37025. "headers": [],
  37026. "parameters": [
  37027. {
  37028. "name": "username",
  37029. "description": "username parameter",
  37030. "in": "PATH",
  37031. "type": "string",
  37032. "required": true,
  37033. "enum": null,
  37034. "allowNull": false,
  37035. "mapToData": null,
  37036. "validation": null,
  37037. "alias": null,
  37038. "deprecated": null
  37039. }
  37040. ],
  37041. "responses": [],
  37042. "renamed": null
  37043. },
  37044. {
  37045. "name": "Demote a site administrator to an ordinary user",
  37046. "scope": "enterpriseAdmin",
  37047. "id": "demoteSiteAdministratorToOrdinaryUser",
  37048. "method": "DELETE",
  37049. "url": "/users/{username}/site_admin",
  37050. "isDeprecated": false,
  37051. "description": "You can demote any user account except your own.",
  37052. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user",
  37053. "previews": [],
  37054. "headers": [],
  37055. "parameters": [
  37056. {
  37057. "name": "username",
  37058. "description": "username parameter",
  37059. "in": "PATH",
  37060. "type": "string",
  37061. "required": true,
  37062. "enum": null,
  37063. "allowNull": false,
  37064. "mapToData": null,
  37065. "validation": null,
  37066. "alias": null,
  37067. "deprecated": null
  37068. }
  37069. ],
  37070. "responses": [],
  37071. "renamed": null
  37072. },
  37073. {
  37074. "name": "List repositories being starred by a user",
  37075. "scope": "activity",
  37076. "id": "listReposStarredByUser",
  37077. "method": "GET",
  37078. "url": "/users/{username}/starred",
  37079. "isDeprecated": false,
  37080. "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/enterprise/2.17/v3/media/) via the `Accept` header:",
  37081. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/starring/#list-repositories-being-starred",
  37082. "previews": [],
  37083. "headers": [],
  37084. "parameters": [
  37085. {
  37086. "name": "username",
  37087. "description": "username parameter",
  37088. "in": "PATH",
  37089. "type": "string",
  37090. "required": true,
  37091. "enum": null,
  37092. "allowNull": false,
  37093. "mapToData": null,
  37094. "validation": null,
  37095. "alias": null,
  37096. "deprecated": null
  37097. },
  37098. {
  37099. "name": "sort",
  37100. "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to).",
  37101. "in": "QUERY",
  37102. "type": "string",
  37103. "required": false,
  37104. "enum": ["created", "updated"],
  37105. "allowNull": false,
  37106. "mapToData": null,
  37107. "validation": null,
  37108. "alias": null,
  37109. "deprecated": null
  37110. },
  37111. {
  37112. "name": "direction",
  37113. "description": "One of `asc` (ascending) or `desc` (descending).",
  37114. "in": "QUERY",
  37115. "type": "string",
  37116. "required": false,
  37117. "enum": ["asc", "desc"],
  37118. "allowNull": false,
  37119. "mapToData": null,
  37120. "validation": null,
  37121. "alias": null,
  37122. "deprecated": null
  37123. },
  37124. {
  37125. "name": "per_page",
  37126. "description": "Results per page (max 100)",
  37127. "in": "QUERY",
  37128. "type": "integer",
  37129. "required": false,
  37130. "enum": null,
  37131. "allowNull": false,
  37132. "mapToData": null,
  37133. "validation": null,
  37134. "alias": null,
  37135. "deprecated": null
  37136. },
  37137. {
  37138. "name": "page",
  37139. "description": "Page number of the results to fetch.",
  37140. "in": "QUERY",
  37141. "type": "integer",
  37142. "required": false,
  37143. "enum": null,
  37144. "allowNull": false,
  37145. "mapToData": null,
  37146. "validation": null,
  37147. "alias": null,
  37148. "deprecated": null
  37149. }
  37150. ],
  37151. "responses": [
  37152. {
  37153. "code": 200,
  37154. "description": "response",
  37155. "examples": [
  37156. {
  37157. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}]"
  37158. }
  37159. ]
  37160. },
  37161. {
  37162. "code": 200,
  37163. "description": "response",
  37164. "examples": [
  37165. {
  37166. "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false}}]"
  37167. }
  37168. ]
  37169. }
  37170. ],
  37171. "renamed": null
  37172. },
  37173. {
  37174. "name": "List repositories being watched by a user",
  37175. "scope": "activity",
  37176. "id": "listReposWatchedByUser",
  37177. "method": "GET",
  37178. "url": "/users/{username}/subscriptions",
  37179. "isDeprecated": false,
  37180. "description": "",
  37181. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/activity/watching/#list-repositories-being-watched",
  37182. "previews": [],
  37183. "headers": [],
  37184. "parameters": [
  37185. {
  37186. "name": "username",
  37187. "description": "username parameter",
  37188. "in": "PATH",
  37189. "type": "string",
  37190. "required": true,
  37191. "enum": null,
  37192. "allowNull": false,
  37193. "mapToData": null,
  37194. "validation": null,
  37195. "alias": null,
  37196. "deprecated": null
  37197. },
  37198. {
  37199. "name": "per_page",
  37200. "description": "Results per page (max 100)",
  37201. "in": "QUERY",
  37202. "type": "integer",
  37203. "required": false,
  37204. "enum": null,
  37205. "allowNull": false,
  37206. "mapToData": null,
  37207. "validation": null,
  37208. "alias": null,
  37209. "deprecated": null
  37210. },
  37211. {
  37212. "name": "page",
  37213. "description": "Page number of the results to fetch.",
  37214. "in": "QUERY",
  37215. "type": "integer",
  37216. "required": false,
  37217. "enum": null,
  37218. "allowNull": false,
  37219. "mapToData": null,
  37220. "validation": null,
  37221. "alias": null,
  37222. "deprecated": null
  37223. }
  37224. ],
  37225. "responses": [
  37226. {
  37227. "code": 200,
  37228. "description": "response",
  37229. "examples": [
  37230. {
  37231. "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"subscribers_count\":42,\"network_count\":0,\"anonymous_access_enabled\":false,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]"
  37232. }
  37233. ]
  37234. }
  37235. ],
  37236. "renamed": null
  37237. },
  37238. {
  37239. "name": "Suspend a user",
  37240. "scope": "enterpriseAdmin",
  37241. "id": "suspendUser",
  37242. "method": "PUT",
  37243. "url": "/users/{username}/suspended",
  37244. "isDeprecated": false,
  37245. "description": "If your GitHub Enterprise Server instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.17/v3/#http-verbs).\"",
  37246. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#suspend-a-user",
  37247. "previews": [],
  37248. "headers": [],
  37249. "parameters": [
  37250. {
  37251. "name": "username",
  37252. "description": "username parameter",
  37253. "in": "PATH",
  37254. "type": "string",
  37255. "required": true,
  37256. "enum": null,
  37257. "allowNull": false,
  37258. "mapToData": null,
  37259. "validation": null,
  37260. "alias": null,
  37261. "deprecated": null
  37262. },
  37263. {
  37264. "name": "reason",
  37265. "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
  37266. "in": "BODY",
  37267. "type": "string",
  37268. "required": false,
  37269. "enum": null,
  37270. "allowNull": false,
  37271. "mapToData": null,
  37272. "validation": null,
  37273. "alias": null,
  37274. "deprecated": null
  37275. }
  37276. ],
  37277. "responses": [],
  37278. "renamed": null
  37279. },
  37280. {
  37281. "name": "Unsuspend a user",
  37282. "scope": "enterpriseAdmin",
  37283. "id": "unsuspendUser",
  37284. "method": "DELETE",
  37285. "url": "/users/{username}/suspended",
  37286. "isDeprecated": false,
  37287. "description": "If your GitHub Enterprise Server instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.",
  37288. "documentationUrl": "https://developer.github.com/enterprise/2.17/v3/enterprise-admin/users/#unsuspend-a-user",
  37289. "previews": [],
  37290. "headers": [],
  37291. "parameters": [
  37292. {
  37293. "name": "username",
  37294. "description": "username parameter",
  37295. "in": "PATH",
  37296. "type": "string",
  37297. "required": true,
  37298. "enum": null,
  37299. "allowNull": false,
  37300. "mapToData": null,
  37301. "validation": null,
  37302. "alias": null,
  37303. "deprecated": null
  37304. },
  37305. {
  37306. "name": "reason",
  37307. "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.",
  37308. "in": "BODY",
  37309. "type": "string",
  37310. "required": false,
  37311. "enum": null,
  37312. "allowNull": false,
  37313. "mapToData": null,
  37314. "validation": null,
  37315. "alias": null,
  37316. "deprecated": null
  37317. }
  37318. ],
  37319. "responses": [],
  37320. "renamed": null
  37321. }
  37322. ]