You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

swagger.v1.json 185KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API.",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "1.1.1"
  23. },
  24. "basePath": "/api/v1",
  25. "paths": {
  26. "/admin/users": {
  27. "post": {
  28. "consumes": [
  29. "application/json"
  30. ],
  31. "produces": [
  32. "application/json"
  33. ],
  34. "tags": [
  35. "admin"
  36. ],
  37. "summary": "Create a user",
  38. "operationId": "adminCreateUser",
  39. "parameters": [
  40. {
  41. "name": "body",
  42. "in": "body",
  43. "schema": {
  44. "$ref": "#/definitions/CreateUserOption"
  45. }
  46. }
  47. ],
  48. "responses": {
  49. "201": {
  50. "$ref": "#/responses/User"
  51. },
  52. "403": {
  53. "$ref": "#/responses/forbidden"
  54. },
  55. "422": {
  56. "$ref": "#/responses/validationError"
  57. }
  58. }
  59. }
  60. },
  61. "/admin/users/{username}": {
  62. "delete": {
  63. "produces": [
  64. "application/json"
  65. ],
  66. "tags": [
  67. "admin"
  68. ],
  69. "summary": "Delete a user",
  70. "operationId": "adminDeleteUser",
  71. "parameters": [
  72. {
  73. "type": "string",
  74. "description": "username of user to delete",
  75. "name": "username",
  76. "in": "path",
  77. "required": true
  78. }
  79. ],
  80. "responses": {
  81. "204": {
  82. "$ref": "#/responses/empty"
  83. },
  84. "403": {
  85. "$ref": "#/responses/forbidden"
  86. },
  87. "422": {
  88. "$ref": "#/responses/validationError"
  89. }
  90. }
  91. },
  92. "patch": {
  93. "consumes": [
  94. "application/json"
  95. ],
  96. "produces": [
  97. "application/json"
  98. ],
  99. "tags": [
  100. "admin"
  101. ],
  102. "summary": "Edit an existing user",
  103. "operationId": "adminEditUser",
  104. "parameters": [
  105. {
  106. "type": "string",
  107. "description": "username of user to edit",
  108. "name": "username",
  109. "in": "path",
  110. "required": true
  111. },
  112. {
  113. "name": "body",
  114. "in": "body",
  115. "schema": {
  116. "$ref": "#/definitions/EditUserOption"
  117. }
  118. }
  119. ],
  120. "responses": {
  121. "200": {
  122. "$ref": "#/responses/User"
  123. },
  124. "403": {
  125. "$ref": "#/responses/forbidden"
  126. },
  127. "422": {
  128. "$ref": "#/responses/validationError"
  129. }
  130. }
  131. }
  132. },
  133. "/admin/users/{username}/keys": {
  134. "post": {
  135. "consumes": [
  136. "application/json"
  137. ],
  138. "produces": [
  139. "application/json"
  140. ],
  141. "tags": [
  142. "admin"
  143. ],
  144. "summary": "Add a public key on behalf of a user",
  145. "operationId": "adminCreatePublicKey",
  146. "parameters": [
  147. {
  148. "type": "string",
  149. "description": "username of the user",
  150. "name": "username",
  151. "in": "path",
  152. "required": true
  153. }
  154. ],
  155. "responses": {
  156. "201": {
  157. "$ref": "#/responses/PublicKey"
  158. },
  159. "403": {
  160. "$ref": "#/responses/forbidden"
  161. },
  162. "422": {
  163. "$ref": "#/responses/validationError"
  164. }
  165. }
  166. }
  167. },
  168. "/admin/users/{username}/keys/{id}": {
  169. "delete": {
  170. "produces": [
  171. "application/json"
  172. ],
  173. "tags": [
  174. "admin"
  175. ],
  176. "summary": "Delete a user's public key",
  177. "operationId": "adminDeleteUserPublicKey",
  178. "parameters": [
  179. {
  180. "type": "string",
  181. "description": "username of user",
  182. "name": "username",
  183. "in": "path",
  184. "required": true
  185. },
  186. {
  187. "type": "integer",
  188. "description": "id of the key to delete",
  189. "name": "id",
  190. "in": "path",
  191. "required": true
  192. }
  193. ],
  194. "responses": {
  195. "204": {
  196. "$ref": "#/responses/empty"
  197. },
  198. "403": {
  199. "$ref": "#/responses/forbidden"
  200. },
  201. "404": {
  202. "$ref": "#/responses/notFound"
  203. }
  204. }
  205. }
  206. },
  207. "/admin/users/{username}/orgs": {
  208. "post": {
  209. "consumes": [
  210. "application/json"
  211. ],
  212. "produces": [
  213. "application/json"
  214. ],
  215. "tags": [
  216. "admin"
  217. ],
  218. "summary": "Create an organization",
  219. "operationId": "adminCreateOrg",
  220. "parameters": [
  221. {
  222. "type": "string",
  223. "description": "username of the user that will own the created organization",
  224. "name": "username",
  225. "in": "path",
  226. "required": true
  227. }
  228. ],
  229. "responses": {
  230. "201": {
  231. "$ref": "#/responses/Organization"
  232. },
  233. "403": {
  234. "$ref": "#/responses/forbidden"
  235. },
  236. "422": {
  237. "$ref": "#/responses/validationError"
  238. }
  239. }
  240. }
  241. },
  242. "/admin/users/{username}/repos": {
  243. "post": {
  244. "consumes": [
  245. "application/json"
  246. ],
  247. "produces": [
  248. "application/json"
  249. ],
  250. "tags": [
  251. "admin"
  252. ],
  253. "summary": "Create a repository on behalf a user",
  254. "operationId": "adminCreateRepo",
  255. "parameters": [
  256. {
  257. "type": "string",
  258. "description": "username of the user. This user will own the created repository",
  259. "name": "username",
  260. "in": "path",
  261. "required": true
  262. }
  263. ],
  264. "responses": {
  265. "201": {
  266. "$ref": "#/responses/Repository"
  267. },
  268. "403": {
  269. "$ref": "#/responses/forbidden"
  270. },
  271. "422": {
  272. "$ref": "#/responses/validationError"
  273. }
  274. }
  275. }
  276. },
  277. "/markdown": {
  278. "post": {
  279. "consumes": [
  280. "application/json"
  281. ],
  282. "produces": [
  283. "text/html"
  284. ],
  285. "tags": [
  286. "miscellaneous"
  287. ],
  288. "summary": "Render a markdown document as HTML",
  289. "operationId": "renderMarkdown",
  290. "parameters": [
  291. {
  292. "name": "body",
  293. "in": "body",
  294. "schema": {
  295. "$ref": "#/definitions/MarkdownOption"
  296. }
  297. }
  298. ],
  299. "responses": {
  300. "200": {
  301. "$ref": "#/responses/MarkdownRender"
  302. },
  303. "422": {
  304. "$ref": "#/responses/validationError"
  305. }
  306. }
  307. }
  308. },
  309. "/markdown/raw": {
  310. "post": {
  311. "consumes": [
  312. "text/plain"
  313. ],
  314. "produces": [
  315. "text/html"
  316. ],
  317. "tags": [
  318. "miscellaneous"
  319. ],
  320. "summary": "Render raw markdown as HTML",
  321. "operationId": "renderMarkdownRaw",
  322. "parameters": [
  323. {
  324. "type": "string",
  325. "name": "body",
  326. "in": "body"
  327. }
  328. ],
  329. "responses": {
  330. "200": {
  331. "$ref": "#/responses/MarkdownRender"
  332. },
  333. "422": {
  334. "$ref": "#/responses/validationError"
  335. }
  336. }
  337. }
  338. },
  339. "/org/{org}/repos": {
  340. "post": {
  341. "consumes": [
  342. "application/json"
  343. ],
  344. "produces": [
  345. "application/json"
  346. ],
  347. "tags": [
  348. "organization"
  349. ],
  350. "summary": "Create a repository in an organization",
  351. "operationId": "createOrgRepo",
  352. "parameters": [
  353. {
  354. "type": "string",
  355. "description": "name of organization",
  356. "name": "org",
  357. "in": "path",
  358. "required": true
  359. },
  360. {
  361. "name": "body",
  362. "in": "body",
  363. "schema": {
  364. "$ref": "#/definitions/CreateRepoOption"
  365. }
  366. }
  367. ],
  368. "responses": {
  369. "201": {
  370. "$ref": "#/responses/Repository"
  371. },
  372. "403": {
  373. "$ref": "#/responses/forbidden"
  374. },
  375. "422": {
  376. "$ref": "#/responses/validationError"
  377. }
  378. }
  379. }
  380. },
  381. "/orgs/{org}": {
  382. "get": {
  383. "produces": [
  384. "application/json"
  385. ],
  386. "tags": [
  387. "organization"
  388. ],
  389. "summary": "Get an organization",
  390. "operationId": "orgGet",
  391. "parameters": [
  392. {
  393. "type": "string",
  394. "description": "name of the organization to get",
  395. "name": "org",
  396. "in": "path",
  397. "required": true
  398. }
  399. ],
  400. "responses": {
  401. "200": {
  402. "$ref": "#/responses/Organization"
  403. }
  404. }
  405. },
  406. "patch": {
  407. "consumes": [
  408. "application/json"
  409. ],
  410. "produces": [
  411. "application/json"
  412. ],
  413. "tags": [
  414. "organization"
  415. ],
  416. "summary": "Edit an organization",
  417. "operationId": "orgEdit",
  418. "parameters": [
  419. {
  420. "type": "string",
  421. "description": "name of the organization to edit",
  422. "name": "org",
  423. "in": "path",
  424. "required": true
  425. },
  426. {
  427. "name": "body",
  428. "in": "body",
  429. "schema": {
  430. "$ref": "#/definitions/EditOrgOption"
  431. }
  432. }
  433. ],
  434. "responses": {
  435. "200": {
  436. "$ref": "#/responses/Organization"
  437. }
  438. }
  439. }
  440. },
  441. "/orgs/{org}/hooks": {
  442. "get": {
  443. "produces": [
  444. "application/json"
  445. ],
  446. "tags": [
  447. "organization"
  448. ],
  449. "summary": "List an organization's webhooks",
  450. "operationId": "orgListHooks",
  451. "responses": {
  452. "200": {
  453. "$ref": "#/responses/HookList"
  454. }
  455. }
  456. }
  457. },
  458. "/orgs/{org}/hooks/": {
  459. "post": {
  460. "consumes": [
  461. "application/json"
  462. ],
  463. "produces": [
  464. "application/json"
  465. ],
  466. "tags": [
  467. "organization"
  468. ],
  469. "summary": "Create a hook",
  470. "operationId": "orgCreateHook",
  471. "responses": {
  472. "201": {
  473. "$ref": "#/responses/Hook"
  474. }
  475. }
  476. }
  477. },
  478. "/orgs/{org}/hooks/{id}": {
  479. "get": {
  480. "produces": [
  481. "application/json"
  482. ],
  483. "tags": [
  484. "organization"
  485. ],
  486. "summary": "Get a hook",
  487. "operationId": "orgGetHook",
  488. "responses": {
  489. "200": {
  490. "$ref": "#/responses/Hook"
  491. }
  492. }
  493. },
  494. "delete": {
  495. "produces": [
  496. "application/json"
  497. ],
  498. "tags": [
  499. "organization"
  500. ],
  501. "summary": "Delete a hook",
  502. "operationId": "orgDeleteHook",
  503. "responses": {
  504. "204": {
  505. "$ref": "#/responses/empty"
  506. }
  507. }
  508. },
  509. "patch": {
  510. "consumes": [
  511. "application/json"
  512. ],
  513. "produces": [
  514. "application/json"
  515. ],
  516. "tags": [
  517. "organization"
  518. ],
  519. "summary": "Update a hook",
  520. "operationId": "orgEditHook",
  521. "responses": {
  522. "200": {
  523. "$ref": "#/responses/Hook"
  524. }
  525. }
  526. }
  527. },
  528. "/orgs/{org}/members": {
  529. "get": {
  530. "produces": [
  531. "application/json"
  532. ],
  533. "tags": [
  534. "organization"
  535. ],
  536. "summary": "List an organization's members",
  537. "operationId": "orgListMembers",
  538. "parameters": [
  539. {
  540. "type": "string",
  541. "description": "name of the organization",
  542. "name": "org",
  543. "in": "path",
  544. "required": true
  545. }
  546. ],
  547. "responses": {
  548. "200": {
  549. "$ref": "#/responses/UserList"
  550. }
  551. }
  552. }
  553. },
  554. "/orgs/{org}/members/{username}": {
  555. "get": {
  556. "tags": [
  557. "organization"
  558. ],
  559. "summary": "Check if a user is a member of an organization",
  560. "operationId": "orgIsMember",
  561. "parameters": [
  562. {
  563. "type": "string",
  564. "description": "name of the organization",
  565. "name": "org",
  566. "in": "path",
  567. "required": true
  568. },
  569. {
  570. "type": "string",
  571. "description": "username of the user",
  572. "name": "username",
  573. "in": "path",
  574. "required": true
  575. }
  576. ],
  577. "responses": {
  578. "204": {
  579. "description": "user is a member",
  580. "schema": {
  581. "$ref": "#/responses/empty"
  582. }
  583. },
  584. "404": {
  585. "description": "user is not a member",
  586. "schema": {
  587. "$ref": "#/responses/empty"
  588. }
  589. }
  590. }
  591. },
  592. "delete": {
  593. "produces": [
  594. "application/json"
  595. ],
  596. "tags": [
  597. "organization"
  598. ],
  599. "summary": "Remove a member from an organization",
  600. "operationId": "orgDeleteMember",
  601. "parameters": [
  602. {
  603. "type": "string",
  604. "description": "name of the organization",
  605. "name": "org",
  606. "in": "path",
  607. "required": true
  608. },
  609. {
  610. "type": "string",
  611. "description": "username of the user",
  612. "name": "username",
  613. "in": "path",
  614. "required": true
  615. }
  616. ],
  617. "responses": {
  618. "204": {
  619. "description": "member removed",
  620. "schema": {
  621. "$ref": "#/responses/empty"
  622. }
  623. }
  624. }
  625. }
  626. },
  627. "/orgs/{org}/public_members": {
  628. "get": {
  629. "produces": [
  630. "application/json"
  631. ],
  632. "tags": [
  633. "organization"
  634. ],
  635. "summary": "List an organization's public members",
  636. "operationId": "orgListPublicMembers",
  637. "parameters": [
  638. {
  639. "type": "string",
  640. "description": "name of the organization",
  641. "name": "org",
  642. "in": "path",
  643. "required": true
  644. }
  645. ],
  646. "responses": {
  647. "200": {
  648. "$ref": "#/responses/UserList"
  649. }
  650. }
  651. }
  652. },
  653. "/orgs/{org}/public_members/{username}": {
  654. "get": {
  655. "tags": [
  656. "organization"
  657. ],
  658. "summary": "Check if a user is a public member of an organization",
  659. "operationId": "orgIsPublicMember",
  660. "parameters": [
  661. {
  662. "type": "string",
  663. "description": "name of the organization",
  664. "name": "org",
  665. "in": "path",
  666. "required": true
  667. },
  668. {
  669. "type": "string",
  670. "description": "username of the user",
  671. "name": "username",
  672. "in": "path",
  673. "required": true
  674. }
  675. ],
  676. "responses": {
  677. "204": {
  678. "description": "user is a public member",
  679. "schema": {
  680. "$ref": "#/responses/empty"
  681. }
  682. },
  683. "404": {
  684. "description": "user is not a public member",
  685. "schema": {
  686. "$ref": "#/responses/empty"
  687. }
  688. }
  689. }
  690. },
  691. "put": {
  692. "produces": [
  693. "application/json"
  694. ],
  695. "tags": [
  696. "organization"
  697. ],
  698. "summary": "Publicize a user's membership",
  699. "operationId": "orgPublicizeMember",
  700. "parameters": [
  701. {
  702. "type": "string",
  703. "description": "name of the organization",
  704. "name": "org",
  705. "in": "path",
  706. "required": true
  707. },
  708. {
  709. "type": "string",
  710. "description": "username of the user",
  711. "name": "username",
  712. "in": "path",
  713. "required": true
  714. }
  715. ],
  716. "responses": {
  717. "204": {
  718. "description": "membership publicized",
  719. "schema": {
  720. "$ref": "#/responses/empty"
  721. }
  722. }
  723. }
  724. },
  725. "delete": {
  726. "produces": [
  727. "application/json"
  728. ],
  729. "tags": [
  730. "organization"
  731. ],
  732. "summary": "Conceal a user's membership",
  733. "operationId": "orgConcealMember",
  734. "parameters": [
  735. {
  736. "type": "string",
  737. "description": "name of the organization",
  738. "name": "org",
  739. "in": "path",
  740. "required": true
  741. },
  742. {
  743. "type": "string",
  744. "description": "username of the user",
  745. "name": "username",
  746. "in": "path",
  747. "required": true
  748. }
  749. ],
  750. "responses": {
  751. "204": {
  752. "$ref": "#/responses/empty"
  753. }
  754. }
  755. }
  756. },
  757. "/orgs/{org}/repos": {
  758. "get": {
  759. "produces": [
  760. "application/json"
  761. ],
  762. "tags": [
  763. "organization"
  764. ],
  765. "summary": "List an organization's repos",
  766. "operationId": "orgListRepos",
  767. "parameters": [
  768. {
  769. "type": "string",
  770. "description": "name of the organization",
  771. "name": "org",
  772. "in": "path",
  773. "required": true
  774. }
  775. ],
  776. "responses": {
  777. "200": {
  778. "$ref": "#/responses/RepositoryList"
  779. }
  780. }
  781. }
  782. },
  783. "/orgs/{org}/teams": {
  784. "get": {
  785. "produces": [
  786. "application/json"
  787. ],
  788. "tags": [
  789. "organization"
  790. ],
  791. "summary": "List an organization's teams",
  792. "operationId": "orgListTeams",
  793. "parameters": [
  794. {
  795. "type": "string",
  796. "description": "name of the organization",
  797. "name": "org",
  798. "in": "path",
  799. "required": true
  800. }
  801. ],
  802. "responses": {
  803. "200": {
  804. "$ref": "#/responses/TeamList"
  805. }
  806. }
  807. },
  808. "post": {
  809. "consumes": [
  810. "application/json"
  811. ],
  812. "produces": [
  813. "application/json"
  814. ],
  815. "tags": [
  816. "organization"
  817. ],
  818. "summary": "Create a team",
  819. "operationId": "orgCreateTeam",
  820. "parameters": [
  821. {
  822. "type": "string",
  823. "description": "name of the organization",
  824. "name": "org",
  825. "in": "path",
  826. "required": true
  827. },
  828. {
  829. "name": "body",
  830. "in": "body",
  831. "schema": {
  832. "$ref": "#/definitions/CreateTeamOption"
  833. }
  834. }
  835. ],
  836. "responses": {
  837. "201": {
  838. "$ref": "#/responses/Team"
  839. }
  840. }
  841. }
  842. },
  843. "/repos/migrate": {
  844. "post": {
  845. "consumes": [
  846. "application/json"
  847. ],
  848. "produces": [
  849. "application/json"
  850. ],
  851. "tags": [
  852. "repository"
  853. ],
  854. "summary": "Migrate a remote git repository",
  855. "operationId": "repoMigrate",
  856. "parameters": [
  857. {
  858. "name": "body",
  859. "in": "body",
  860. "schema": {
  861. "$ref": "#/definitions/MigrateRepoForm"
  862. }
  863. }
  864. ],
  865. "responses": {
  866. "201": {
  867. "$ref": "#/responses/Repository"
  868. }
  869. }
  870. }
  871. },
  872. "/repos/search": {
  873. "get": {
  874. "produces": [
  875. "application/json"
  876. ],
  877. "tags": [
  878. "repository"
  879. ],
  880. "summary": "Search for repositories",
  881. "operationId": "repoSearch",
  882. "parameters": [
  883. {
  884. "type": "string",
  885. "description": "keyword",
  886. "name": "q",
  887. "in": "query"
  888. },
  889. {
  890. "type": "integer",
  891. "description": "search only for repos that the user with the given id owns or contributes to",
  892. "name": "uid",
  893. "in": "query"
  894. },
  895. {
  896. "type": "integer",
  897. "description": "page number of results to return (1-based)",
  898. "name": "page",
  899. "in": "query"
  900. },
  901. {
  902. "type": "integer",
  903. "description": "page size of results, maximum page size is 50",
  904. "name": "limit",
  905. "in": "query"
  906. },
  907. {
  908. "type": "string",
  909. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  910. "name": "mode",
  911. "in": "query"
  912. },
  913. {
  914. "type": "boolean",
  915. "description": "if `uid` is given, search only for repos that the user owns",
  916. "name": "exclusive",
  917. "in": "query"
  918. }
  919. ],
  920. "responses": {
  921. "200": {
  922. "$ref": "#/responses/SearchResults"
  923. },
  924. "422": {
  925. "$ref": "#/responses/validationError"
  926. }
  927. }
  928. }
  929. },
  930. "/repos/{owner}/{repo}": {
  931. "get": {
  932. "produces": [
  933. "application/json"
  934. ],
  935. "tags": [
  936. "repository"
  937. ],
  938. "summary": "Get a repository",
  939. "operationId": "repoGet",
  940. "parameters": [
  941. {
  942. "type": "string",
  943. "description": "owner of the repo",
  944. "name": "owner",
  945. "in": "path",
  946. "required": true
  947. },
  948. {
  949. "type": "string",
  950. "description": "name of the repo",
  951. "name": "repo",
  952. "in": "path",
  953. "required": true
  954. }
  955. ],
  956. "responses": {
  957. "200": {
  958. "$ref": "#/responses/Repository"
  959. }
  960. }
  961. },
  962. "delete": {
  963. "produces": [
  964. "application/json"
  965. ],
  966. "tags": [
  967. "repository"
  968. ],
  969. "summary": "Delete a repository",
  970. "operationId": "repoDelete",
  971. "parameters": [
  972. {
  973. "type": "string",
  974. "description": "owner of the repo to delete",
  975. "name": "owner",
  976. "in": "path",
  977. "required": true
  978. },
  979. {
  980. "type": "string",
  981. "description": "name of the repo to delete",
  982. "name": "repo",
  983. "in": "path",
  984. "required": true
  985. }
  986. ],
  987. "responses": {
  988. "204": {
  989. "$ref": "#/responses/empty"
  990. },
  991. "403": {
  992. "$ref": "#/responses/forbidden"
  993. }
  994. }
  995. }
  996. },
  997. "/repos/{owner}/{repo}/archive/{filepath}": {
  998. "get": {
  999. "produces": [
  1000. "application/json"
  1001. ],
  1002. "tags": [
  1003. "repository"
  1004. ],
  1005. "summary": "Get an archive of a repository",
  1006. "operationId": "repoGetArchive",
  1007. "parameters": [
  1008. {
  1009. "type": "string",
  1010. "description": "owner of the repo",
  1011. "name": "owner",
  1012. "in": "path",
  1013. "required": true
  1014. },
  1015. {
  1016. "type": "string",
  1017. "description": "name of the repo",
  1018. "name": "repo",
  1019. "in": "path",
  1020. "required": true
  1021. },
  1022. {
  1023. "type": "string",
  1024. "description": "archive to download, consisting of a git reference and archive",
  1025. "name": "archive",
  1026. "in": "path",
  1027. "required": true
  1028. }
  1029. ],
  1030. "responses": {
  1031. "200": {}
  1032. }
  1033. }
  1034. },
  1035. "/repos/{owner}/{repo}/branches": {
  1036. "get": {
  1037. "produces": [
  1038. "application/json"
  1039. ],
  1040. "tags": [
  1041. "repository"
  1042. ],
  1043. "summary": "List a repository's branches",
  1044. "operationId": "repoListBranches",
  1045. "parameters": [
  1046. {
  1047. "type": "string",
  1048. "description": "owner of the repo",
  1049. "name": "owner",
  1050. "in": "path",
  1051. "required": true
  1052. },
  1053. {
  1054. "type": "string",
  1055. "description": "name of the repo",
  1056. "name": "repo",
  1057. "in": "path",
  1058. "required": true
  1059. }
  1060. ],
  1061. "responses": {
  1062. "200": {
  1063. "$ref": "#/responses/BranchList"
  1064. }
  1065. }
  1066. }
  1067. },
  1068. "/repos/{owner}/{repo}/branches/{branch}": {
  1069. "get": {
  1070. "produces": [
  1071. "application/json"
  1072. ],
  1073. "tags": [
  1074. "repository"
  1075. ],
  1076. "summary": "List a repository's branches",
  1077. "operationId": "repoGetBranch",
  1078. "parameters": [
  1079. {
  1080. "type": "string",
  1081. "description": "owner of the repo",
  1082. "name": "owner",
  1083. "in": "path",
  1084. "required": true
  1085. },
  1086. {
  1087. "type": "string",
  1088. "description": "name of the repo",
  1089. "name": "repo",
  1090. "in": "path",
  1091. "required": true
  1092. },
  1093. {
  1094. "type": "string",
  1095. "description": "branch to get",
  1096. "name": "branch",
  1097. "in": "path",
  1098. "required": true
  1099. }
  1100. ],
  1101. "responses": {
  1102. "200": {
  1103. "$ref": "#/responses/Branch"
  1104. }
  1105. }
  1106. }
  1107. },
  1108. "/repos/{owner}/{repo}/collaborators": {
  1109. "get": {
  1110. "produces": [
  1111. "application/json"
  1112. ],
  1113. "tags": [
  1114. "repository"
  1115. ],
  1116. "summary": "List a repository's collaborators",
  1117. "operationId": "repoListCollaborators",
  1118. "parameters": [
  1119. {
  1120. "type": "string",
  1121. "description": "owner of the repo",
  1122. "name": "owner",
  1123. "in": "path",
  1124. "required": true
  1125. },
  1126. {
  1127. "type": "string",
  1128. "description": "name of the repo",
  1129. "name": "repo",
  1130. "in": "path",
  1131. "required": true
  1132. }
  1133. ],
  1134. "responses": {
  1135. "200": {
  1136. "$ref": "#/responses/UserList"
  1137. }
  1138. }
  1139. }
  1140. },
  1141. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  1142. "get": {
  1143. "produces": [
  1144. "application/json"
  1145. ],
  1146. "tags": [
  1147. "repository"
  1148. ],
  1149. "summary": "Check if a user is a collaborator of a repository",
  1150. "operationId": "repoCheckCollaborator",
  1151. "parameters": [
  1152. {
  1153. "type": "string",
  1154. "description": "owner of the repo",
  1155. "name": "owner",
  1156. "in": "path",
  1157. "required": true
  1158. },
  1159. {
  1160. "type": "string",
  1161. "description": "name of the repo",
  1162. "name": "repo",
  1163. "in": "path",
  1164. "required": true
  1165. },
  1166. {
  1167. "type": "string",
  1168. "description": "username of the collaborator",
  1169. "name": "collaborator",
  1170. "in": "path",
  1171. "required": true
  1172. }
  1173. ],
  1174. "responses": {
  1175. "204": {
  1176. "$ref": "#/responses/empty"
  1177. },
  1178. "404": {
  1179. "$ref": "#/responses/empty"
  1180. }
  1181. }
  1182. },
  1183. "put": {
  1184. "produces": [
  1185. "application/json"
  1186. ],
  1187. "tags": [
  1188. "repository"
  1189. ],
  1190. "summary": "Add a collaborator to a repository",
  1191. "operationId": "repoAddCollaborator",
  1192. "parameters": [
  1193. {
  1194. "type": "string",
  1195. "description": "owner of the repo",
  1196. "name": "owner",
  1197. "in": "path",
  1198. "required": true
  1199. },
  1200. {
  1201. "type": "string",
  1202. "description": "name of the repo",
  1203. "name": "repo",
  1204. "in": "path",
  1205. "required": true
  1206. },
  1207. {
  1208. "type": "string",
  1209. "description": "username of the collaborator to add",
  1210. "name": "collaborator",
  1211. "in": "path",
  1212. "required": true
  1213. },
  1214. {
  1215. "name": "body",
  1216. "in": "body",
  1217. "schema": {
  1218. "$ref": "#/definitions/AddCollaboratorOption"
  1219. }
  1220. }
  1221. ],
  1222. "responses": {
  1223. "204": {
  1224. "$ref": "#/responses/empty"
  1225. }
  1226. }
  1227. },
  1228. "delete": {
  1229. "produces": [
  1230. "application/json"
  1231. ],
  1232. "tags": [
  1233. "repository"
  1234. ],
  1235. "summary": "Delete a collaborator from a repository",
  1236. "operationId": "repoDeleteCollaborator",
  1237. "parameters": [
  1238. {
  1239. "type": "string",
  1240. "description": "owner of the repo",
  1241. "name": "owner",
  1242. "in": "path",
  1243. "required": true
  1244. },
  1245. {
  1246. "type": "string",
  1247. "description": "name of the repo",
  1248. "name": "repo",
  1249. "in": "path",
  1250. "required": true
  1251. },
  1252. {
  1253. "type": "string",
  1254. "description": "username of the collaborator to delete",
  1255. "name": "collaborator",
  1256. "in": "path",
  1257. "required": true
  1258. }
  1259. ],
  1260. "responses": {
  1261. "204": {
  1262. "$ref": "#/responses/empty"
  1263. }
  1264. }
  1265. }
  1266. },
  1267. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  1268. "get": {
  1269. "produces": [
  1270. "application/json"
  1271. ],
  1272. "tags": [
  1273. "repository"
  1274. ],
  1275. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  1276. "operationId": "repoGetCombinedStatusByRef",
  1277. "parameters": [
  1278. {
  1279. "type": "string",
  1280. "description": "owner of the repo",
  1281. "name": "owner",
  1282. "in": "path",
  1283. "required": true
  1284. },
  1285. {
  1286. "type": "string",
  1287. "description": "name of the repo",
  1288. "name": "repo",
  1289. "in": "path",
  1290. "required": true
  1291. },
  1292. {
  1293. "type": "string",
  1294. "description": "name of branch/tag/commit",
  1295. "name": "ref",
  1296. "in": "path",
  1297. "required": true
  1298. }
  1299. ],
  1300. "responses": {
  1301. "200": {
  1302. "$ref": "#/responses/Status"
  1303. }
  1304. }
  1305. }
  1306. },
  1307. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  1308. "get": {
  1309. "produces": [
  1310. "application/json"
  1311. ],
  1312. "tags": [
  1313. "repository"
  1314. ],
  1315. "summary": "Get the EditorConfig definitions of a file in a repository",
  1316. "operationId": "repoGetEditorConfig",
  1317. "parameters": [
  1318. {
  1319. "type": "string",
  1320. "description": "owner of the repo",
  1321. "name": "owner",
  1322. "in": "path",
  1323. "required": true
  1324. },
  1325. {
  1326. "type": "string",
  1327. "description": "name of the repo",
  1328. "name": "repo",
  1329. "in": "path",
  1330. "required": true
  1331. },
  1332. {
  1333. "type": "string",
  1334. "description": "filepath of file to get",
  1335. "name": "filepath",
  1336. "in": "path",
  1337. "required": true
  1338. }
  1339. ],
  1340. "responses": {
  1341. "200": {}
  1342. }
  1343. }
  1344. },
  1345. "/repos/{owner}/{repo}/forks": {
  1346. "get": {
  1347. "produces": [
  1348. "application/json"
  1349. ],
  1350. "tags": [
  1351. "repository"
  1352. ],
  1353. "summary": "List a repository's forks",
  1354. "operationId": "listForks",
  1355. "parameters": [
  1356. {
  1357. "type": "string",
  1358. "description": "owner of the repo",
  1359. "name": "owner",
  1360. "in": "path",
  1361. "required": true
  1362. },
  1363. {
  1364. "type": "string",
  1365. "description": "name of the repo",
  1366. "name": "repo",
  1367. "in": "path",
  1368. "required": true
  1369. }
  1370. ],
  1371. "responses": {
  1372. "200": {
  1373. "$ref": "#/responses/RepositoryList"
  1374. }
  1375. }
  1376. },
  1377. "post": {
  1378. "produces": [
  1379. "application/json"
  1380. ],
  1381. "tags": [
  1382. "repository"
  1383. ],
  1384. "summary": "Fork a repository",
  1385. "operationId": "createFork",
  1386. "parameters": [
  1387. {
  1388. "type": "string",
  1389. "description": "owner of the repo to fork",
  1390. "name": "owner",
  1391. "in": "path",
  1392. "required": true
  1393. },
  1394. {
  1395. "type": "string",
  1396. "description": "name of the repo to fork",
  1397. "name": "repo",
  1398. "in": "path",
  1399. "required": true
  1400. },
  1401. {
  1402. "name": "body",
  1403. "in": "body",
  1404. "schema": {
  1405. "$ref": "#/definitions/CreateForkOption"
  1406. }
  1407. }
  1408. ],
  1409. "responses": {
  1410. "202": {
  1411. "$ref": "#/responses/Repository"
  1412. }
  1413. }
  1414. }
  1415. },
  1416. "/repos/{owner}/{repo}/hooks": {
  1417. "get": {
  1418. "produces": [
  1419. "application/json"
  1420. ],
  1421. "tags": [
  1422. "repository"
  1423. ],
  1424. "summary": "List the hooks in a repository",
  1425. "operationId": "repoListHooks",
  1426. "parameters": [
  1427. {
  1428. "type": "string",
  1429. "description": "owner of the repo",
  1430. "name": "owner",
  1431. "in": "path",
  1432. "required": true
  1433. },
  1434. {
  1435. "type": "string",
  1436. "description": "name of the repo",
  1437. "name": "repo",
  1438. "in": "path",
  1439. "required": true
  1440. }
  1441. ],
  1442. "responses": {
  1443. "200": {
  1444. "$ref": "#/responses/HookList"
  1445. }
  1446. }
  1447. },
  1448. "post": {
  1449. "consumes": [
  1450. "application/json"
  1451. ],
  1452. "produces": [
  1453. "application/json"
  1454. ],
  1455. "tags": [
  1456. "repository"
  1457. ],
  1458. "summary": "Create a hook",
  1459. "operationId": "repoCreateHook",
  1460. "parameters": [
  1461. {
  1462. "type": "string",
  1463. "description": "owner of the repo",
  1464. "name": "owner",
  1465. "in": "path",
  1466. "required": true
  1467. },
  1468. {
  1469. "type": "string",
  1470. "description": "name of the repo",
  1471. "name": "repo",
  1472. "in": "path",
  1473. "required": true
  1474. },
  1475. {
  1476. "name": "body",
  1477. "in": "body",
  1478. "schema": {
  1479. "$ref": "#/definitions/CreateHookOption"
  1480. }
  1481. }
  1482. ],
  1483. "responses": {
  1484. "201": {
  1485. "$ref": "#/responses/Hook"
  1486. }
  1487. }
  1488. }
  1489. },
  1490. "/repos/{owner}/{repo}/hooks/{id}": {
  1491. "get": {
  1492. "produces": [
  1493. "application/json"
  1494. ],
  1495. "tags": [
  1496. "repository"
  1497. ],
  1498. "summary": "Get a hook",
  1499. "operationId": "repoGetHook",
  1500. "parameters": [
  1501. {
  1502. "type": "string",
  1503. "description": "owner of the repo",
  1504. "name": "owner",
  1505. "in": "path",
  1506. "required": true
  1507. },
  1508. {
  1509. "type": "string",
  1510. "description": "name of the repo",
  1511. "name": "repo",
  1512. "in": "path",
  1513. "required": true
  1514. },
  1515. {
  1516. "type": "integer",
  1517. "description": "id of the hook to get",
  1518. "name": "id",
  1519. "in": "path",
  1520. "required": true
  1521. }
  1522. ],
  1523. "responses": {
  1524. "200": {
  1525. "$ref": "#/responses/Hook"
  1526. }
  1527. }
  1528. },
  1529. "patch": {
  1530. "produces": [
  1531. "application/json"
  1532. ],
  1533. "tags": [
  1534. "repository"
  1535. ],
  1536. "summary": "Edit a hook in a repository",
  1537. "operationId": "repoEditHook",
  1538. "parameters": [
  1539. {
  1540. "type": "string",
  1541. "description": "owner of the repo",
  1542. "name": "owner",
  1543. "in": "path",
  1544. "required": true
  1545. },
  1546. {
  1547. "type": "string",
  1548. "description": "name of the repo",
  1549. "name": "repo",
  1550. "in": "path",
  1551. "required": true
  1552. },
  1553. {
  1554. "name": "body",
  1555. "in": "body",
  1556. "schema": {
  1557. "$ref": "#/definitions/EditHookOption"
  1558. }
  1559. }
  1560. ],
  1561. "responses": {
  1562. "200": {
  1563. "$ref": "#/responses/Hook"
  1564. }
  1565. }
  1566. }
  1567. },
  1568. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  1569. "post": {
  1570. "produces": [
  1571. "application/json"
  1572. ],
  1573. "tags": [
  1574. "repository"
  1575. ],
  1576. "summary": "Test a push webhook",
  1577. "operationId": "repoTestHook",
  1578. "parameters": [
  1579. {
  1580. "type": "string",
  1581. "description": "owner of the repo",
  1582. "name": "owner",
  1583. "in": "path",
  1584. "required": true
  1585. },
  1586. {
  1587. "type": "string",
  1588. "description": "name of the repo",
  1589. "name": "repo",
  1590. "in": "path",
  1591. "required": true
  1592. },
  1593. {
  1594. "type": "integer",
  1595. "description": "id of the hook to test",
  1596. "name": "id",
  1597. "in": "path",
  1598. "required": true
  1599. }
  1600. ],
  1601. "responses": {
  1602. "204": {
  1603. "$ref": "#/responses/empty"
  1604. }
  1605. }
  1606. }
  1607. },
  1608. "/repos/{owner}/{repo}/issue/{index}/comments": {
  1609. "get": {
  1610. "produces": [
  1611. "application/json"
  1612. ],
  1613. "tags": [
  1614. "issue"
  1615. ],
  1616. "summary": "List all comments on an issue",
  1617. "operationId": "issueGetComments",
  1618. "parameters": [
  1619. {
  1620. "type": "string",
  1621. "description": "owner of the repo",
  1622. "name": "owner",
  1623. "in": "path",
  1624. "required": true
  1625. },
  1626. {
  1627. "type": "string",
  1628. "description": "name of the repo",
  1629. "name": "repo",
  1630. "in": "path",
  1631. "required": true
  1632. },
  1633. {
  1634. "type": "integer",
  1635. "description": "index of the issue",
  1636. "name": "id",
  1637. "in": "path",
  1638. "required": true
  1639. },
  1640. {
  1641. "type": "string",
  1642. "description": "if provided, only comments updated since the specified time are returned.",
  1643. "name": "string",
  1644. "in": "query"
  1645. }
  1646. ],
  1647. "responses": {
  1648. "200": {
  1649. "$ref": "#/responses/CommentList"
  1650. }
  1651. }
  1652. }
  1653. },
  1654. "/repos/{owner}/{repo}/issue/{index}/labels": {
  1655. "put": {
  1656. "consumes": [
  1657. "application/json"
  1658. ],
  1659. "produces": [
  1660. "application/json"
  1661. ],
  1662. "tags": [
  1663. "issue"
  1664. ],
  1665. "summary": "Replace an issue's labels",
  1666. "operationId": "issueReplaceLabels",
  1667. "parameters": [
  1668. {
  1669. "type": "string",
  1670. "description": "owner of the repo",
  1671. "name": "owner",
  1672. "in": "path",
  1673. "required": true
  1674. },
  1675. {
  1676. "type": "string",
  1677. "description": "name of the repo",
  1678. "name": "repo",
  1679. "in": "path",
  1680. "required": true
  1681. },
  1682. {
  1683. "type": "integer",
  1684. "description": "index of the issue",
  1685. "name": "index",
  1686. "in": "path",
  1687. "required": true
  1688. },
  1689. {
  1690. "name": "body",
  1691. "in": "body",
  1692. "schema": {
  1693. "$ref": "#/definitions/IssueLabelsOption"
  1694. }
  1695. }
  1696. ],
  1697. "responses": {
  1698. "200": {
  1699. "$ref": "#/responses/LabelList"
  1700. }
  1701. }
  1702. },
  1703. "post": {
  1704. "consumes": [
  1705. "application/json"
  1706. ],
  1707. "produces": [
  1708. "application/json"
  1709. ],
  1710. "tags": [
  1711. "issue"
  1712. ],
  1713. "summary": "Add a label to an issue",
  1714. "operationId": "issueAddLabel",
  1715. "parameters": [
  1716. {
  1717. "type": "string",
  1718. "description": "owner of the repo",
  1719. "name": "owner",
  1720. "in": "path",
  1721. "required": true
  1722. },
  1723. {
  1724. "type": "string",
  1725. "description": "name of the repo",
  1726. "name": "repo",
  1727. "in": "path",
  1728. "required": true
  1729. },
  1730. {
  1731. "type": "integer",
  1732. "description": "index of the issue",
  1733. "name": "index",
  1734. "in": "path",
  1735. "required": true
  1736. },
  1737. {
  1738. "name": "body",
  1739. "in": "body",
  1740. "schema": {
  1741. "$ref": "#/definitions/IssueLabelsOption"
  1742. }
  1743. }
  1744. ],
  1745. "responses": {
  1746. "200": {
  1747. "$ref": "#/responses/LabelList"
  1748. }
  1749. }
  1750. },
  1751. "delete": {
  1752. "produces": [
  1753. "application/json"
  1754. ],
  1755. "tags": [
  1756. "issue"
  1757. ],
  1758. "summary": "Remove all labels from an issue",
  1759. "operationId": "issueClearLabels",
  1760. "parameters": [
  1761. {
  1762. "type": "string",
  1763. "description": "owner of the repo",
  1764. "name": "owner",
  1765. "in": "path",
  1766. "required": true
  1767. },
  1768. {
  1769. "type": "string",
  1770. "description": "name of the repo",
  1771. "name": "repo",
  1772. "in": "path",
  1773. "required": true
  1774. },
  1775. {
  1776. "type": "integer",
  1777. "description": "index of the issue",
  1778. "name": "index",
  1779. "in": "path",
  1780. "required": true
  1781. }
  1782. ],
  1783. "responses": {
  1784. "204": {
  1785. "$ref": "#/responses/empty"
  1786. }
  1787. }
  1788. }
  1789. },
  1790. "/repos/{owner}/{repo}/issue/{index}/labels/{id}": {
  1791. "delete": {
  1792. "produces": [
  1793. "application/json"
  1794. ],
  1795. "tags": [
  1796. "issue"
  1797. ],
  1798. "summary": "Remove a label from an issue",
  1799. "operationId": "issueRemoveLabel",
  1800. "parameters": [
  1801. {
  1802. "type": "string",
  1803. "description": "owner of the repo",
  1804. "name": "owner",
  1805. "in": "path",
  1806. "required": true
  1807. },
  1808. {
  1809. "type": "string",
  1810. "description": "name of the repo",
  1811. "name": "repo",
  1812. "in": "path",
  1813. "required": true
  1814. },
  1815. {
  1816. "type": "integer",
  1817. "description": "index of the issue",
  1818. "name": "index",
  1819. "in": "path",
  1820. "required": true
  1821. },
  1822. {
  1823. "type": "integer",
  1824. "description": "id of the label to remove",
  1825. "name": "id",
  1826. "in": "path",
  1827. "required": true
  1828. }
  1829. ],
  1830. "responses": {
  1831. "204": {
  1832. "$ref": "#/responses/empty"
  1833. }
  1834. }
  1835. }
  1836. },
  1837. "/repos/{owner}/{repo}/issues": {
  1838. "get": {
  1839. "produces": [
  1840. "application/json"
  1841. ],
  1842. "tags": [
  1843. "issue"
  1844. ],
  1845. "summary": "List a repository's issues",
  1846. "operationId": "issueListIssues",
  1847. "parameters": [
  1848. {
  1849. "type": "string",
  1850. "description": "owner of the repo",
  1851. "name": "owner",
  1852. "in": "path",
  1853. "required": true
  1854. },
  1855. {
  1856. "type": "string",
  1857. "description": "name of the repo",
  1858. "name": "repo",
  1859. "in": "path",
  1860. "required": true
  1861. },
  1862. {
  1863. "type": "string",
  1864. "description": "whether issue is open or closed",
  1865. "name": "state",
  1866. "in": "query"
  1867. },
  1868. {
  1869. "type": "integer",
  1870. "description": "page number of requested issues",
  1871. "name": "page",
  1872. "in": "query"
  1873. },
  1874. {
  1875. "type": "string",
  1876. "description": "search string",
  1877. "name": "q",
  1878. "in": "query"
  1879. }
  1880. ],
  1881. "responses": {
  1882. "200": {
  1883. "$ref": "#/responses/IssueList"
  1884. }
  1885. }
  1886. },
  1887. "post": {
  1888. "consumes": [
  1889. "application/json"
  1890. ],
  1891. "produces": [
  1892. "application/json"
  1893. ],
  1894. "tags": [
  1895. "issue"
  1896. ],
  1897. "summary": "Create an issue",
  1898. "operationId": "issueCreateIssue",
  1899. "parameters": [
  1900. {
  1901. "type": "string",
  1902. "description": "owner of the repo",
  1903. "name": "owner",
  1904. "in": "path",
  1905. "required": true
  1906. },
  1907. {
  1908. "type": "string",
  1909. "description": "name of the repo",
  1910. "name": "repo",
  1911. "in": "path",
  1912. "required": true
  1913. },
  1914. {
  1915. "name": "body",
  1916. "in": "body",
  1917. "schema": {
  1918. "$ref": "#/definitions/CreateIssueOption"
  1919. }
  1920. }
  1921. ],
  1922. "responses": {
  1923. "201": {
  1924. "$ref": "#/responses/Issue"
  1925. }
  1926. }
  1927. }
  1928. },
  1929. "/repos/{owner}/{repo}/issues/comments": {
  1930. "get": {
  1931. "produces": [
  1932. "application/json"
  1933. ],
  1934. "tags": [
  1935. "issue"
  1936. ],
  1937. "summary": "List all comments in a repository",
  1938. "operationId": "issueGetRepoComments",
  1939. "parameters": [
  1940. {
  1941. "type": "string",
  1942. "description": "owner of the repo",
  1943. "name": "owner",
  1944. "in": "path",
  1945. "required": true
  1946. },
  1947. {
  1948. "type": "string",
  1949. "description": "name of the repo",
  1950. "name": "repo",
  1951. "in": "path",
  1952. "required": true
  1953. },
  1954. {
  1955. "type": "string",
  1956. "description": "if provided, only comments updated since the provided time are returned.",
  1957. "name": "string",
  1958. "in": "query"
  1959. }
  1960. ],
  1961. "responses": {
  1962. "200": {
  1963. "$ref": "#/responses/CommentList"
  1964. }
  1965. }
  1966. }
  1967. },
  1968. "/repos/{owner}/{repo}/issues/comments/{id}": {
  1969. "delete": {
  1970. "tags": [
  1971. "issue"
  1972. ],
  1973. "summary": "Delete a comment",
  1974. "operationId": "issueDeleteComment",
  1975. "parameters": [
  1976. {
  1977. "type": "string",
  1978. "description": "owner of the repo",
  1979. "name": "owner",
  1980. "in": "path",
  1981. "required": true
  1982. },
  1983. {
  1984. "type": "string",
  1985. "description": "name of the repo",
  1986. "name": "repo",
  1987. "in": "path",
  1988. "required": true
  1989. },
  1990. {
  1991. "type": "integer",
  1992. "description": "id of comment to delete",
  1993. "name": "id",
  1994. "in": "path",
  1995. "required": true
  1996. }
  1997. ],
  1998. "responses": {
  1999. "204": {
  2000. "$ref": "#/responses/empty"
  2001. }
  2002. }
  2003. },
  2004. "patch": {
  2005. "consumes": [
  2006. "application/json"
  2007. ],
  2008. "produces": [
  2009. "application/json"
  2010. ],
  2011. "tags": [
  2012. "issue"
  2013. ],
  2014. "summary": "Edit a comment",
  2015. "operationId": "issueEditComment",
  2016. "parameters": [
  2017. {
  2018. "type": "string",
  2019. "description": "owner of the repo",
  2020. "name": "owner",
  2021. "in": "path",
  2022. "required": true
  2023. },
  2024. {
  2025. "type": "string",
  2026. "description": "name of the repo",
  2027. "name": "repo",
  2028. "in": "path",
  2029. "required": true
  2030. },
  2031. {
  2032. "type": "integer",
  2033. "description": "id of the comment to edit",
  2034. "name": "id",
  2035. "in": "path",
  2036. "required": true
  2037. },
  2038. {
  2039. "name": "body",
  2040. "in": "body",
  2041. "schema": {
  2042. "$ref": "#/definitions/EditIssueCommentOption"
  2043. }
  2044. }
  2045. ],
  2046. "responses": {
  2047. "200": {
  2048. "$ref": "#/responses/Comment"
  2049. }
  2050. }
  2051. }
  2052. },
  2053. "/repos/{owner}/{repo}/issues/{index}": {
  2054. "get": {
  2055. "produces": [
  2056. "application/json"
  2057. ],
  2058. "tags": [
  2059. "issue"
  2060. ],
  2061. "summary": "Get an issue",
  2062. "operationId": "issueGetIssue",
  2063. "parameters": [
  2064. {
  2065. "type": "string",
  2066. "description": "owner of the repo",
  2067. "name": "owner",
  2068. "in": "path",
  2069. "required": true
  2070. },
  2071. {
  2072. "type": "string",
  2073. "description": "name of the repo",
  2074. "name": "repo",
  2075. "in": "path",
  2076. "required": true
  2077. },
  2078. {
  2079. "type": "integer",
  2080. "description": "index of the issue to get",
  2081. "name": "index",
  2082. "in": "path",
  2083. "required": true
  2084. }
  2085. ],
  2086. "responses": {
  2087. "200": {
  2088. "$ref": "#/responses/Issue"
  2089. }
  2090. }
  2091. },
  2092. "patch": {
  2093. "consumes": [
  2094. "application/json"
  2095. ],
  2096. "produces": [
  2097. "application/json"
  2098. ],
  2099. "tags": [
  2100. "issue"
  2101. ],
  2102. "summary": "Edit an issue",
  2103. "operationId": "issueEditIssue",
  2104. "parameters": [
  2105. {
  2106. "type": "string",
  2107. "description": "owner of the repo",
  2108. "name": "owner",
  2109. "in": "path",
  2110. "required": true
  2111. },
  2112. {
  2113. "type": "string",
  2114. "description": "name of the repo",
  2115. "name": "repo",
  2116. "in": "path",
  2117. "required": true
  2118. },
  2119. {
  2120. "type": "integer",
  2121. "description": "index of the issue to edit",
  2122. "name": "index",
  2123. "in": "path",
  2124. "required": true
  2125. },
  2126. {
  2127. "name": "body",
  2128. "in": "body",
  2129. "schema": {
  2130. "$ref": "#/definitions/EditIssueOption"
  2131. }
  2132. }
  2133. ],
  2134. "responses": {
  2135. "201": {
  2136. "$ref": "#/responses/Issue"
  2137. }
  2138. }
  2139. }
  2140. },
  2141. "/repos/{owner}/{repo}/issues/{index}/comments": {
  2142. "post": {
  2143. "consumes": [
  2144. "application/json"
  2145. ],
  2146. "produces": [
  2147. "application/json"
  2148. ],
  2149. "tags": [
  2150. "issue"
  2151. ],
  2152. "summary": "Add a comment to an issue",
  2153. "operationId": "issueCreateComment",
  2154. "parameters": [
  2155. {
  2156. "type": "string",
  2157. "description": "owner of the repo",
  2158. "name": "owner",
  2159. "in": "path",
  2160. "required": true
  2161. },
  2162. {
  2163. "type": "string",
  2164. "description": "name of the repo",
  2165. "name": "repo",
  2166. "in": "path",
  2167. "required": true
  2168. },
  2169. {
  2170. "type": "integer",
  2171. "description": "index of the issue",
  2172. "name": "id",
  2173. "in": "path",
  2174. "required": true
  2175. },
  2176. {
  2177. "name": "body",
  2178. "in": "body",
  2179. "schema": {
  2180. "$ref": "#/definitions/CreateIssueOption"
  2181. }
  2182. }
  2183. ],
  2184. "responses": {
  2185. "201": {
  2186. "$ref": "#/responses/Comment"
  2187. }
  2188. }
  2189. }
  2190. },
  2191. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  2192. "delete": {
  2193. "tags": [
  2194. "issue"
  2195. ],
  2196. "summary": "Delete a comment",
  2197. "operationId": "issueDeleteCommentDeprecated",
  2198. "deprecated": true,
  2199. "parameters": [
  2200. {
  2201. "type": "string",
  2202. "description": "owner of the repo",
  2203. "name": "owner",
  2204. "in": "path",
  2205. "required": true
  2206. },
  2207. {
  2208. "type": "string",
  2209. "description": "name of the repo",
  2210. "name": "repo",
  2211. "in": "path",
  2212. "required": true
  2213. },
  2214. {
  2215. "type": "integer",
  2216. "description": "this parameter is ignored",
  2217. "name": "index",
  2218. "in": "path",
  2219. "required": true
  2220. },
  2221. {
  2222. "type": "integer",
  2223. "description": "id of comment to delete",
  2224. "name": "id",
  2225. "in": "path",
  2226. "required": true
  2227. }
  2228. ],
  2229. "responses": {
  2230. "204": {
  2231. "$ref": "#/responses/empty"
  2232. }
  2233. }
  2234. },
  2235. "patch": {
  2236. "consumes": [
  2237. "application/json"
  2238. ],
  2239. "produces": [
  2240. "application/json"
  2241. ],
  2242. "tags": [
  2243. "issue"
  2244. ],
  2245. "summary": "Edit a comment",
  2246. "operationId": "issueEditCommentDeprecated",
  2247. "deprecated": true,
  2248. "parameters": [
  2249. {
  2250. "type": "string",
  2251. "description": "owner of the repo",
  2252. "name": "owner",
  2253. "in": "path",
  2254. "required": true
  2255. },
  2256. {
  2257. "type": "string",
  2258. "description": "name of the repo",
  2259. "name": "repo",
  2260. "in": "path",
  2261. "required": true
  2262. },
  2263. {
  2264. "type": "integer",
  2265. "description": "this parameter is ignored",
  2266. "name": "index",
  2267. "in": "path",
  2268. "required": true
  2269. },
  2270. {
  2271. "type": "integer",
  2272. "description": "id of the comment to edit",
  2273. "name": "id",
  2274. "in": "path",
  2275. "required": true
  2276. },
  2277. {
  2278. "name": "body",
  2279. "in": "body",
  2280. "schema": {
  2281. "$ref": "#/definitions/EditIssueCommentOption"
  2282. }
  2283. }
  2284. ],
  2285. "responses": {
  2286. "200": {
  2287. "$ref": "#/responses/Comment"
  2288. }
  2289. }
  2290. }
  2291. },
  2292. "/repos/{owner}/{repo}/issues/{index}/labels": {
  2293. "get": {
  2294. "produces": [
  2295. "application/json"
  2296. ],
  2297. "tags": [
  2298. "issue"
  2299. ],
  2300. "summary": "Get an issue's labels",
  2301. "operationId": "issueGetLabels",
  2302. "parameters": [
  2303. {
  2304. "type": "string",
  2305. "description": "owner of the repo",
  2306. "name": "owner",
  2307. "in": "path",
  2308. "required": true
  2309. },
  2310. {
  2311. "type": "string",
  2312. "description": "name of the repo",
  2313. "name": "repo",
  2314. "in": "path",
  2315. "required": true
  2316. },
  2317. {
  2318. "type": "integer",
  2319. "description": "index of the issue",
  2320. "name": "index",
  2321. "in": "path",
  2322. "required": true
  2323. }
  2324. ],
  2325. "responses": {
  2326. "200": {
  2327. "$ref": "#/responses/LabelList"
  2328. },
  2329. "404": {
  2330. "$ref": "#/responses/notFound"
  2331. }
  2332. }
  2333. }
  2334. },
  2335. "/repos/{owner}/{repo}/issues/{index}/times": {
  2336. "get": {
  2337. "produces": [
  2338. "application/json"
  2339. ],
  2340. "tags": [
  2341. "issue"
  2342. ],
  2343. "summary": "List an issue's tracked times",
  2344. "operationId": "issueTrackedTimes",
  2345. "parameters": [
  2346. {
  2347. "type": "string",
  2348. "description": "owner of the repo",
  2349. "name": "owner",
  2350. "in": "path",
  2351. "required": true
  2352. },
  2353. {
  2354. "type": "string",
  2355. "description": "name of the repo",
  2356. "name": "repo",
  2357. "in": "path",
  2358. "required": true
  2359. },
  2360. {
  2361. "type": "integer",
  2362. "description": "index of the issue",
  2363. "name": "repo",
  2364. "in": "path",
  2365. "required": true
  2366. }
  2367. ],
  2368. "responses": {
  2369. "200": {
  2370. "$ref": "#/responses/TrackedTimeList"
  2371. }
  2372. }
  2373. },
  2374. "post": {
  2375. "consumes": [
  2376. "application/json"
  2377. ],
  2378. "produces": [
  2379. "application/json"
  2380. ],
  2381. "tags": [
  2382. "issue"
  2383. ],
  2384. "summary": "Add a tracked time to a issue",
  2385. "operationId": "issueAddTime",
  2386. "parameters": [
  2387. {
  2388. "type": "string",
  2389. "description": "owner of the repo",
  2390. "name": "owner",
  2391. "in": "path",
  2392. "required": true
  2393. },
  2394. {
  2395. "type": "string",
  2396. "description": "name of the repo",
  2397. "name": "repo",
  2398. "in": "path",
  2399. "required": true
  2400. },
  2401. {
  2402. "type": "integer",
  2403. "description": "index of the issue to add tracked time to",
  2404. "name": "id",
  2405. "in": "path",
  2406. "required": true
  2407. },
  2408. {
  2409. "name": "body",
  2410. "in": "body",
  2411. "schema": {
  2412. "$ref": "#/definitions/AddTimeOption"
  2413. }
  2414. }
  2415. ],
  2416. "responses": {
  2417. "200": {
  2418. "$ref": "#/responses/TrackedTime"
  2419. },
  2420. "400": {
  2421. "$ref": "#/responses/error"
  2422. },
  2423. "403": {
  2424. "$ref": "#/responses/error"
  2425. }
  2426. }
  2427. }
  2428. },
  2429. "/repos/{owner}/{repo}/keys": {
  2430. "get": {
  2431. "produces": [
  2432. "application/json"
  2433. ],
  2434. "tags": [
  2435. "repository"
  2436. ],
  2437. "summary": "List a repository's keys",
  2438. "operationId": "repoListKeys",
  2439. "parameters": [
  2440. {
  2441. "type": "string",
  2442. "description": "owner of the repo",
  2443. "name": "owner",
  2444. "in": "path",
  2445. "required": true
  2446. },
  2447. {
  2448. "type": "string",
  2449. "description": "name of the repo",
  2450. "name": "repo",
  2451. "in": "path",
  2452. "required": true
  2453. }
  2454. ],
  2455. "responses": {
  2456. "200": {
  2457. "$ref": "#/responses/DeployKeyList"
  2458. }
  2459. }
  2460. },
  2461. "post": {
  2462. "consumes": [
  2463. "application/json"
  2464. ],
  2465. "produces": [
  2466. "application/json"
  2467. ],
  2468. "tags": [
  2469. "repository"
  2470. ],
  2471. "summary": "Add a key to a repository",
  2472. "operationId": "repoCreateKey",
  2473. "parameters": [
  2474. {
  2475. "type": "string",
  2476. "description": "owner of the repo",
  2477. "name": "owner",
  2478. "in": "path",
  2479. "required": true
  2480. },
  2481. {
  2482. "type": "string",
  2483. "description": "name of the repo",
  2484. "name": "repo",
  2485. "in": "path",
  2486. "required": true
  2487. },
  2488. {
  2489. "name": "body",
  2490. "in": "body",
  2491. "schema": {
  2492. "$ref": "#/definitions/CreateKeyOption"
  2493. }
  2494. }
  2495. ],
  2496. "responses": {
  2497. "201": {
  2498. "$ref": "#/responses/DeployKey"
  2499. }
  2500. }
  2501. }
  2502. },
  2503. "/repos/{owner}/{repo}/keys/{id}": {
  2504. "get": {
  2505. "produces": [
  2506. "application/json"
  2507. ],
  2508. "tags": [
  2509. "repository"
  2510. ],
  2511. "summary": "Get a repository's key by id",
  2512. "operationId": "repoGetKey",
  2513. "parameters": [
  2514. {
  2515. "type": "string",
  2516. "description": "owner of the repo",
  2517. "name": "owner",
  2518. "in": "path",
  2519. "required": true
  2520. },
  2521. {
  2522. "type": "string",
  2523. "description": "name of the repo",
  2524. "name": "repo",
  2525. "in": "path",
  2526. "required": true
  2527. },
  2528. {
  2529. "type": "integer",
  2530. "description": "id of the key to get",
  2531. "name": "id",
  2532. "in": "path",
  2533. "required": true
  2534. }
  2535. ],
  2536. "responses": {
  2537. "200": {
  2538. "$ref": "#/responses/DeployKey"
  2539. }
  2540. }
  2541. },
  2542. "delete": {
  2543. "tags": [
  2544. "repository"
  2545. ],
  2546. "summary": "Delete a key from a repository",
  2547. "operationId": "repoDeleteKey",
  2548. "parameters": [
  2549. {
  2550. "type": "string",
  2551. "description": "owner of the repo",
  2552. "name": "owner",
  2553. "in": "path",
  2554. "required": true
  2555. },
  2556. {
  2557. "type": "string",
  2558. "description": "name of the repo",
  2559. "name": "repo",
  2560. "in": "path",
  2561. "required": true
  2562. },
  2563. {
  2564. "type": "integer",
  2565. "description": "id of the key to delete",
  2566. "name": "id",
  2567. "in": "path",
  2568. "required": true
  2569. }
  2570. ],
  2571. "responses": {
  2572. "204": {
  2573. "$ref": "#/responses/empty"
  2574. }
  2575. }
  2576. }
  2577. },
  2578. "/repos/{owner}/{repo}/labels": {
  2579. "get": {
  2580. "produces": [
  2581. "application/json"
  2582. ],
  2583. "tags": [
  2584. "issue"
  2585. ],
  2586. "summary": "Get all of a repository's labels",
  2587. "operationId": "issueListLabels",
  2588. "parameters": [
  2589. {
  2590. "type": "string",
  2591. "description": "owner of the repo",
  2592. "name": "owner",
  2593. "in": "path",
  2594. "required": true
  2595. },
  2596. {
  2597. "type": "string",
  2598. "description": "name of the repo",
  2599. "name": "repo",
  2600. "in": "path",
  2601. "required": true
  2602. }
  2603. ],
  2604. "responses": {
  2605. "200": {
  2606. "$ref": "#/responses/LabelList"
  2607. }
  2608. }
  2609. },
  2610. "post": {
  2611. "consumes": [
  2612. "application/json"
  2613. ],
  2614. "produces": [
  2615. "application/json"
  2616. ],
  2617. "tags": [
  2618. "issue"
  2619. ],
  2620. "summary": "Create a label",
  2621. "operationId": "issueCreateLabel",
  2622. "parameters": [
  2623. {
  2624. "type": "string",
  2625. "description": "owner of the repo",
  2626. "name": "owner",
  2627. "in": "path",
  2628. "required": true
  2629. },
  2630. {
  2631. "type": "string",
  2632. "description": "name of the repo",
  2633. "name": "repo",
  2634. "in": "path",
  2635. "required": true
  2636. },
  2637. {
  2638. "name": "body",
  2639. "in": "body",
  2640. "schema": {
  2641. "$ref": "#/definitions/CreateLabelOption"
  2642. }
  2643. }
  2644. ],
  2645. "responses": {
  2646. "201": {
  2647. "$ref": "#/responses/Label"
  2648. }
  2649. }
  2650. }
  2651. },
  2652. "/repos/{owner}/{repo}/labels/{id}": {
  2653. "get": {
  2654. "produces": [
  2655. "application/json"
  2656. ],
  2657. "tags": [
  2658. "issue"
  2659. ],
  2660. "summary": "Get a single label",
  2661. "operationId": "issueGetLabel",
  2662. "parameters": [
  2663. {
  2664. "type": "string",
  2665. "description": "owner of the repo",
  2666. "name": "owner",
  2667. "in": "path",
  2668. "required": true
  2669. },
  2670. {
  2671. "type": "string",
  2672. "description": "name of the repo",
  2673. "name": "repo",
  2674. "in": "path",
  2675. "required": true
  2676. },
  2677. {
  2678. "type": "integer",
  2679. "description": "id of the label to get",
  2680. "name": "id",
  2681. "in": "path",
  2682. "required": true
  2683. }
  2684. ],
  2685. "responses": {
  2686. "200": {
  2687. "$ref": "#/responses/Label"
  2688. }
  2689. }
  2690. },
  2691. "delete": {
  2692. "tags": [
  2693. "issue"
  2694. ],
  2695. "summary": "Delete a label",
  2696. "operationId": "issueDeleteLabel",
  2697. "parameters": [
  2698. {
  2699. "type": "string",
  2700. "description": "owner of the repo",
  2701. "name": "owner",
  2702. "in": "path",
  2703. "required": true
  2704. },
  2705. {
  2706. "type": "string",
  2707. "description": "name of the repo",
  2708. "name": "repo",
  2709. "in": "path",
  2710. "required": true
  2711. },
  2712. {
  2713. "type": "integer",
  2714. "description": "id of the label to delete",
  2715. "name": "id",
  2716. "in": "path",
  2717. "required": true
  2718. }
  2719. ],
  2720. "responses": {
  2721. "204": {
  2722. "$ref": "#/responses/empty"
  2723. }
  2724. }
  2725. },
  2726. "patch": {
  2727. "consumes": [
  2728. "application/json"
  2729. ],
  2730. "produces": [
  2731. "application/json"
  2732. ],
  2733. "tags": [
  2734. "issue"
  2735. ],
  2736. "summary": "Update a label",
  2737. "operationId": "issueEditLabel",
  2738. "parameters": [
  2739. {
  2740. "type": "string",
  2741. "description": "owner of the repo",
  2742. "name": "owner",
  2743. "in": "path",
  2744. "required": true
  2745. },
  2746. {
  2747. "type": "string",
  2748. "description": "name of the repo",
  2749. "name": "repo",
  2750. "in": "path",
  2751. "required": true
  2752. },
  2753. {
  2754. "type": "integer",
  2755. "description": "id of the label to edit",
  2756. "name": "id",
  2757. "in": "path",
  2758. "required": true
  2759. },
  2760. {
  2761. "name": "body",
  2762. "in": "body",
  2763. "schema": {
  2764. "$ref": "#/definitions/EditLabelOption"
  2765. }
  2766. }
  2767. ],
  2768. "responses": {
  2769. "200": {
  2770. "$ref": "#/responses/Label"
  2771. }
  2772. }
  2773. }
  2774. },
  2775. "/repos/{owner}/{repo}/milestones": {
  2776. "get": {
  2777. "produces": [
  2778. "application/json"
  2779. ],
  2780. "tags": [
  2781. "issue"
  2782. ],
  2783. "summary": "Get all of a repository's milestones",
  2784. "operationId": "issueGetMilestones",
  2785. "parameters": [
  2786. {
  2787. "type": "string",
  2788. "description": "owner of the repo",
  2789. "name": "owner",
  2790. "in": "path",
  2791. "required": true
  2792. },
  2793. {
  2794. "type": "string",
  2795. "description": "name of the repo",
  2796. "name": "repo",
  2797. "in": "path",
  2798. "required": true
  2799. },
  2800. {
  2801. "type": "integer",
  2802. "description": "id of the milestone to get",
  2803. "name": "id",
  2804. "in": "path",
  2805. "required": true
  2806. }
  2807. ],
  2808. "responses": {
  2809. "200": {
  2810. "$ref": "#/responses/MilestoneList"
  2811. }
  2812. }
  2813. },
  2814. "post": {
  2815. "consumes": [
  2816. "application/json"
  2817. ],
  2818. "produces": [
  2819. "application/json"
  2820. ],
  2821. "tags": [
  2822. "issue"
  2823. ],
  2824. "summary": "Create a milestone",
  2825. "operationId": "issueCreateMilestone",
  2826. "parameters": [
  2827. {
  2828. "type": "string",
  2829. "description": "owner of the repo",
  2830. "name": "owner",
  2831. "in": "path",
  2832. "required": true
  2833. },
  2834. {
  2835. "type": "string",
  2836. "description": "name of the repo",
  2837. "name": "repo",
  2838. "in": "path",
  2839. "required": true
  2840. },
  2841. {
  2842. "name": "body",
  2843. "in": "body",
  2844. "schema": {
  2845. "$ref": "#/definitions/CreateMilestoneOption"
  2846. }
  2847. }
  2848. ],
  2849. "responses": {
  2850. "201": {
  2851. "$ref": "#/responses/Milestone"
  2852. }
  2853. }
  2854. }
  2855. },
  2856. "/repos/{owner}/{repo}/milestones/{id}": {
  2857. "get": {
  2858. "produces": [
  2859. "application/json"
  2860. ],
  2861. "tags": [
  2862. "issue"
  2863. ],
  2864. "summary": "Get a milestone",
  2865. "operationId": "issueGetMilestone",
  2866. "responses": {
  2867. "200": {
  2868. "$ref": "#/responses/Milestone"
  2869. }
  2870. }
  2871. },
  2872. "delete": {
  2873. "tags": [
  2874. "issue"
  2875. ],
  2876. "summary": "Delete a milestone",
  2877. "operationId": "issueDeleteMilestone",
  2878. "parameters": [
  2879. {
  2880. "type": "string",
  2881. "description": "owner of the repo",
  2882. "name": "owner",
  2883. "in": "path",
  2884. "required": true
  2885. },
  2886. {
  2887. "type": "string",
  2888. "description": "name of the repo",
  2889. "name": "repo",
  2890. "in": "path",
  2891. "required": true
  2892. },
  2893. {
  2894. "type": "integer",
  2895. "description": "id of the milestone to delete",
  2896. "name": "body",
  2897. "in": "path",
  2898. "required": true
  2899. }
  2900. ],
  2901. "responses": {
  2902. "204": {
  2903. "$ref": "#/responses/empty"
  2904. }
  2905. }
  2906. },
  2907. "patch": {
  2908. "consumes": [
  2909. "application/json"
  2910. ],
  2911. "produces": [
  2912. "application/json"
  2913. ],
  2914. "tags": [
  2915. "issue"
  2916. ],
  2917. "summary": "Update a milestone",
  2918. "operationId": "issueEditMilestone",
  2919. "parameters": [
  2920. {
  2921. "type": "string",
  2922. "description": "owner of the repo",
  2923. "name": "owner",
  2924. "in": "path",
  2925. "required": true
  2926. },
  2927. {
  2928. "type": "string",
  2929. "description": "name of the repo",
  2930. "name": "repo",
  2931. "in": "path",
  2932. "required": true
  2933. },
  2934. {
  2935. "name": "body",
  2936. "in": "body",
  2937. "schema": {
  2938. "$ref": "#/definitions/EditMilestoneOption"
  2939. }
  2940. }
  2941. ],
  2942. "responses": {
  2943. "200": {
  2944. "$ref": "#/responses/Milestone"
  2945. }
  2946. }
  2947. }
  2948. },
  2949. "/repos/{owner}/{repo}/mirror-sync": {
  2950. "post": {
  2951. "produces": [
  2952. "application/json"
  2953. ],
  2954. "tags": [
  2955. "repository"
  2956. ],
  2957. "summary": "Sync a mirrored repository",
  2958. "operationId": "repoMirrorSync",
  2959. "parameters": [
  2960. {
  2961. "type": "string",
  2962. "description": "owner of the repo to sync",
  2963. "name": "owner",
  2964. "in": "path",
  2965. "required": true
  2966. },
  2967. {
  2968. "type": "string",
  2969. "description": "name of the repo to sync",
  2970. "name": "repo",
  2971. "in": "path",
  2972. "required": true
  2973. }
  2974. ],
  2975. "responses": {
  2976. "200": {
  2977. "$ref": "#/responses/empty"
  2978. }
  2979. }
  2980. }
  2981. },
  2982. "/repos/{owner}/{repo}/pulls": {
  2983. "get": {
  2984. "produces": [
  2985. "application/json"
  2986. ],
  2987. "tags": [
  2988. "repository"
  2989. ],
  2990. "summary": "List a repo's pull requests",
  2991. "operationId": "repoListPullRequests",
  2992. "parameters": [
  2993. {
  2994. "type": "string",
  2995. "description": "owner of the repo",
  2996. "name": "owner",
  2997. "in": "path",
  2998. "required": true
  2999. },
  3000. {
  3001. "type": "string",
  3002. "description": "name of the repo",
  3003. "name": "repo",
  3004. "in": "path",
  3005. "required": true
  3006. }
  3007. ],
  3008. "responses": {
  3009. "200": {
  3010. "$ref": "#/responses/PullRequestList"
  3011. }
  3012. }
  3013. },
  3014. "post": {
  3015. "consumes": [
  3016. "application/json"
  3017. ],
  3018. "produces": [
  3019. "application/json"
  3020. ],
  3021. "tags": [
  3022. "repository"
  3023. ],
  3024. "summary": "Create a pull request",
  3025. "operationId": "repoCreatePullRequest",
  3026. "parameters": [
  3027. {
  3028. "type": "string",
  3029. "description": "owner of the repo",
  3030. "name": "owner",
  3031. "in": "path",
  3032. "required": true
  3033. },
  3034. {
  3035. "type": "string",
  3036. "description": "name of the repo",
  3037. "name": "repo",
  3038. "in": "path",
  3039. "required": true
  3040. },
  3041. {
  3042. "name": "body",
  3043. "in": "body",
  3044. "schema": {
  3045. "$ref": "#/definitions/CreatePullRequestOption"
  3046. }
  3047. }
  3048. ],
  3049. "responses": {
  3050. "201": {
  3051. "$ref": "#/responses/PullRequest"
  3052. }
  3053. }
  3054. }
  3055. },
  3056. "/repos/{owner}/{repo}/pulls/{index}": {
  3057. "get": {
  3058. "produces": [
  3059. "application/json"
  3060. ],
  3061. "tags": [
  3062. "repository"
  3063. ],
  3064. "summary": "Get a pull request",
  3065. "operationId": "repoGetPullRequest",
  3066. "parameters": [
  3067. {
  3068. "type": "string",
  3069. "description": "owner of the repo",
  3070. "name": "owner",
  3071. "in": "path",
  3072. "required": true
  3073. },
  3074. {
  3075. "type": "string",
  3076. "description": "name of the repo",
  3077. "name": "repo",
  3078. "in": "path",
  3079. "required": true
  3080. },
  3081. {
  3082. "type": "integer",
  3083. "description": "index of the pull request to get",
  3084. "name": "index",
  3085. "in": "path",
  3086. "required": true
  3087. }
  3088. ],
  3089. "responses": {
  3090. "200": {
  3091. "$ref": "#/responses/PullRequest"
  3092. }
  3093. }
  3094. },
  3095. "patch": {
  3096. "consumes": [
  3097. "application/json"
  3098. ],
  3099. "produces": [
  3100. "application/json"
  3101. ],
  3102. "tags": [
  3103. "repository"
  3104. ],
  3105. "summary": "Update a pull request",
  3106. "operationId": "repoEditPullRequest",
  3107. "parameters": [
  3108. {
  3109. "type": "string",
  3110. "description": "owner of the repo",
  3111. "name": "owner",
  3112. "in": "path",
  3113. "required": true
  3114. },
  3115. {
  3116. "type": "string",
  3117. "description": "name of the repo",
  3118. "name": "repo",
  3119. "in": "path",
  3120. "required": true
  3121. },
  3122. {
  3123. "type": "integer",
  3124. "description": "index of the pull request to edit",
  3125. "name": "index",
  3126. "in": "path",
  3127. "required": true
  3128. },
  3129. {
  3130. "name": "body",
  3131. "in": "body",
  3132. "schema": {
  3133. "$ref": "#/definitions/EditPullRequestOption"
  3134. }
  3135. }
  3136. ],
  3137. "responses": {
  3138. "201": {
  3139. "$ref": "#/responses/PullRequest"
  3140. }
  3141. }
  3142. }
  3143. },
  3144. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  3145. "get": {
  3146. "produces": [
  3147. "application/json"
  3148. ],
  3149. "tags": [
  3150. "repository"
  3151. ],
  3152. "summary": "Check if a pull request has been merged",
  3153. "operationId": "repoPullRequestIsMerged",
  3154. "parameters": [
  3155. {
  3156. "type": "string",
  3157. "description": "owner of the repo",
  3158. "name": "owner",
  3159. "in": "path",
  3160. "required": true
  3161. },
  3162. {
  3163. "type": "string",
  3164. "description": "name of the repo",
  3165. "name": "repo",
  3166. "in": "path",
  3167. "required": true
  3168. },
  3169. {
  3170. "type": "integer",
  3171. "description": "index of the pull request",
  3172. "name": "index",
  3173. "in": "path",
  3174. "required": true
  3175. }
  3176. ],
  3177. "responses": {
  3178. "204": {
  3179. "description": "pull request has been merged",
  3180. "schema": {
  3181. "$ref": "#/responses/empty"
  3182. }
  3183. },
  3184. "404": {
  3185. "description": "pull request has not been merged",
  3186. "schema": {
  3187. "$ref": "#/responses/empty"
  3188. }
  3189. }
  3190. }
  3191. },
  3192. "post": {
  3193. "produces": [
  3194. "application/json"
  3195. ],
  3196. "tags": [
  3197. "repository"
  3198. ],
  3199. "summary": "Merge a pull request",
  3200. "operationId": "repoMergePullRequest",
  3201. "parameters": [
  3202. {
  3203. "type": "string",
  3204. "description": "owner of the repo",
  3205. "name": "owner",
  3206. "in": "path",
  3207. "required": true
  3208. },
  3209. {
  3210. "type": "string",
  3211. "description": "name of the repo",
  3212. "name": "repo",
  3213. "in": "path",
  3214. "required": true
  3215. },
  3216. {
  3217. "type": "integer",
  3218. "description": "index of the pull request to merge",
  3219. "name": "index",
  3220. "in": "path",
  3221. "required": true
  3222. }
  3223. ],
  3224. "responses": {
  3225. "200": {
  3226. "$ref": "#/responses/empty"
  3227. },
  3228. "405": {
  3229. "$ref": "#/responses/empty"
  3230. }
  3231. }
  3232. }
  3233. },
  3234. "/repos/{owner}/{repo}/raw/{filepath}": {
  3235. "get": {
  3236. "produces": [
  3237. "application/json"
  3238. ],
  3239. "tags": [
  3240. "repository"
  3241. ],
  3242. "summary": "Get a file from a repository",
  3243. "operationId": "repoGetRawFile",
  3244. "parameters": [
  3245. {
  3246. "type": "string",
  3247. "description": "owner of the repo",
  3248. "name": "owner",
  3249. "in": "path",
  3250. "required": true
  3251. },
  3252. {
  3253. "type": "string",
  3254. "description": "name of the repo",
  3255. "name": "repo",
  3256. "in": "path",
  3257. "required": true
  3258. },
  3259. {
  3260. "type": "string",
  3261. "description": "filepath of the file to get",
  3262. "name": "filepath",
  3263. "in": "path",
  3264. "required": true
  3265. }
  3266. ],
  3267. "responses": {
  3268. "200": {}
  3269. }
  3270. }
  3271. },
  3272. "/repos/{owner}/{repo}/releases": {
  3273. "get": {
  3274. "produces": [
  3275. "application/json"
  3276. ],
  3277. "tags": [
  3278. "repository"
  3279. ],
  3280. "summary": "List a repo's releases",
  3281. "operationId": "repoListReleases",
  3282. "parameters": [
  3283. {
  3284. "type": "string",
  3285. "description": "owner of the repo",
  3286. "name": "owner",
  3287. "in": "path",
  3288. "required": true
  3289. },
  3290. {
  3291. "type": "string",
  3292. "description": "name of the repo",
  3293. "name": "repo",
  3294. "in": "path",
  3295. "required": true
  3296. }
  3297. ],
  3298. "responses": {
  3299. "200": {
  3300. "$ref": "#/responses/ReleaseList"
  3301. }
  3302. }
  3303. },
  3304. "post": {
  3305. "consumes": [
  3306. "application/json"
  3307. ],
  3308. "produces": [
  3309. "application/json"
  3310. ],
  3311. "tags": [
  3312. "repository"
  3313. ],
  3314. "summary": "Create a release",
  3315. "operationId": "repoCreateRelease",
  3316. "parameters": [
  3317. {
  3318. "type": "string",
  3319. "description": "owner of the repo",
  3320. "name": "owner",
  3321. "in": "path",
  3322. "required": true
  3323. },
  3324. {
  3325. "type": "string",
  3326. "description": "name of the repo",
  3327. "name": "repo",
  3328. "in": "path",
  3329. "required": true
  3330. },
  3331. {
  3332. "name": "body",
  3333. "in": "body",
  3334. "schema": {
  3335. "$ref": "#/definitions/CreateReleaseOption"
  3336. }
  3337. }
  3338. ],
  3339. "responses": {
  3340. "201": {
  3341. "$ref": "#/responses/Release"
  3342. }
  3343. }
  3344. }
  3345. },
  3346. "/repos/{owner}/{repo}/releases/{id}": {
  3347. "get": {
  3348. "produces": [
  3349. "application/json"
  3350. ],
  3351. "tags": [
  3352. "repository"
  3353. ],
  3354. "summary": "Get a release",
  3355. "operationId": "repoGetRelease",
  3356. "parameters": [
  3357. {
  3358. "type": "string",
  3359. "description": "owner of the repo",
  3360. "name": "owner",
  3361. "in": "path",
  3362. "required": true
  3363. },
  3364. {
  3365. "type": "string",
  3366. "description": "name of the repo",
  3367. "name": "repo",
  3368. "in": "path",
  3369. "required": true
  3370. },
  3371. {
  3372. "type": "integer",
  3373. "description": "id of the release to get",
  3374. "name": "id",
  3375. "in": "path",
  3376. "required": true
  3377. }
  3378. ],
  3379. "responses": {
  3380. "200": {
  3381. "$ref": "#/responses/Release"
  3382. }
  3383. }
  3384. },
  3385. "delete": {
  3386. "tags": [
  3387. "repository"
  3388. ],
  3389. "summary": "Delete a release",
  3390. "operationId": "repoDeleteRelease",
  3391. "parameters": [
  3392. {
  3393. "type": "string",
  3394. "description": "owner of the repo",
  3395. "name": "owner",
  3396. "in": "path",
  3397. "required": true
  3398. },
  3399. {
  3400. "type": "string",
  3401. "description": "name of the repo",
  3402. "name": "repo",
  3403. "in": "path",
  3404. "required": true
  3405. },
  3406. {
  3407. "type": "integer",
  3408. "description": "id of the release to delete",
  3409. "name": "id",
  3410. "in": "path",
  3411. "required": true
  3412. }
  3413. ],
  3414. "responses": {
  3415. "204": {
  3416. "$ref": "#/responses/empty"
  3417. }
  3418. }
  3419. },
  3420. "patch": {
  3421. "consumes": [
  3422. "application/json"
  3423. ],
  3424. "produces": [
  3425. "application/json"
  3426. ],
  3427. "tags": [
  3428. "repository"
  3429. ],
  3430. "summary": "Update a release",
  3431. "operationId": "repoEditRelease",
  3432. "parameters": [
  3433. {
  3434. "type": "string",
  3435. "description": "owner of the repo",
  3436. "name": "owner",
  3437. "in": "path",
  3438. "required": true
  3439. },
  3440. {
  3441. "type": "string",
  3442. "description": "name of the repo",
  3443. "name": "repo",
  3444. "in": "path",
  3445. "required": true
  3446. },
  3447. {
  3448. "type": "integer",
  3449. "description": "id of the release to edit",
  3450. "name": "id",
  3451. "in": "path",
  3452. "required": true
  3453. },
  3454. {
  3455. "name": "body",
  3456. "in": "body",
  3457. "schema": {
  3458. "$ref": "#/definitions/EditReleaseOption"
  3459. }
  3460. }
  3461. ],
  3462. "responses": {
  3463. "200": {
  3464. "$ref": "#/responses/Release"
  3465. }
  3466. }
  3467. }
  3468. },
  3469. "/repos/{owner}/{repo}/releases/{id}/assets": {
  3470. "get": {
  3471. "produces": [
  3472. "application/json"
  3473. ],
  3474. "tags": [
  3475. "repository"
  3476. ],
  3477. "summary": "List release's attachments",
  3478. "operationId": "repoListReleaseAttachments",
  3479. "parameters": [
  3480. {
  3481. "type": "string",
  3482. "description": "owner of the repo",
  3483. "name": "owner",
  3484. "in": "path",
  3485. "required": true
  3486. },
  3487. {
  3488. "type": "string",
  3489. "description": "name of the repo",
  3490. "name": "repo",
  3491. "in": "path",
  3492. "required": true
  3493. },
  3494. {
  3495. "type": "integer",
  3496. "description": "id of the release",
  3497. "name": "id",
  3498. "in": "path",
  3499. "required": true
  3500. }
  3501. ],
  3502. "responses": {
  3503. "200": {
  3504. "$ref": "#/responses/AttachmentList"
  3505. }
  3506. }
  3507. },
  3508. "post": {
  3509. "consumes": [
  3510. "multipart/form-data"
  3511. ],
  3512. "produces": [
  3513. "application/json"
  3514. ],
  3515. "tags": [
  3516. "repository"
  3517. ],
  3518. "summary": "Create a release attachment",
  3519. "operationId": "repoCreateReleaseAttachment",
  3520. "parameters": [
  3521. {
  3522. "type": "string",
  3523. "description": "owner of the repo",
  3524. "name": "owner",
  3525. "in": "path",
  3526. "required": true
  3527. },
  3528. {
  3529. "type": "string",
  3530. "description": "name of the repo",
  3531. "name": "repo",
  3532. "in": "path",
  3533. "required": true
  3534. },
  3535. {
  3536. "type": "integer",
  3537. "description": "id of the release",
  3538. "name": "id",
  3539. "in": "path",
  3540. "required": true
  3541. },
  3542. {
  3543. "type": "string",
  3544. "description": "name of the attachment",
  3545. "name": "name",
  3546. "in": "query"
  3547. },
  3548. {
  3549. "type": "file",
  3550. "description": "attachment to upload",
  3551. "name": "attachment",
  3552. "in": "formData",
  3553. "required": true
  3554. }
  3555. ],
  3556. "responses": {
  3557. "201": {
  3558. "$ref": "#/responses/Attachment"
  3559. }
  3560. }
  3561. }
  3562. },
  3563. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  3564. "get": {
  3565. "produces": [
  3566. "application/json"
  3567. ],
  3568. "tags": [
  3569. "repository"
  3570. ],
  3571. "summary": "Get a release attachment",
  3572. "operationId": "repoGetReleaseAttachment",
  3573. "parameters": [
  3574. {
  3575. "type": "string",
  3576. "description": "owner of the repo",
  3577. "name": "owner",
  3578. "in": "path",
  3579. "required": true
  3580. },
  3581. {
  3582. "type": "string",
  3583. "description": "name of the repo",
  3584. "name": "repo",
  3585. "in": "path",
  3586. "required": true
  3587. },
  3588. {
  3589. "type": "integer",
  3590. "description": "id of the release",
  3591. "name": "id",
  3592. "in": "path",
  3593. "required": true
  3594. },
  3595. {
  3596. "type": "integer",
  3597. "description": "id of the attachment to get",
  3598. "name": "attachment_id",
  3599. "in": "path",
  3600. "required": true
  3601. }
  3602. ],
  3603. "responses": {
  3604. "200": {
  3605. "$ref": "#/responses/Attachment"
  3606. }
  3607. }
  3608. },
  3609. "delete": {
  3610. "produces": [
  3611. "application/json"
  3612. ],
  3613. "tags": [
  3614. "repository"
  3615. ],
  3616. "summary": "Delete a release attachment",
  3617. "operationId": "repoDeleteReleaseAttachment",
  3618. "parameters": [
  3619. {
  3620. "type": "string",
  3621. "description": "owner of the repo",
  3622. "name": "owner",
  3623. "in": "path",
  3624. "required": true
  3625. },
  3626. {
  3627. "type": "string",
  3628. "description": "name of the repo",
  3629. "name": "repo",
  3630. "in": "path",
  3631. "required": true
  3632. },
  3633. {
  3634. "type": "integer",
  3635. "description": "id of the release",
  3636. "name": "id",
  3637. "in": "path",
  3638. "required": true
  3639. },
  3640. {
  3641. "type": "integer",
  3642. "description": "id of the attachment to delete",
  3643. "name": "attachment_id",
  3644. "in": "path",
  3645. "required": true
  3646. }
  3647. ],
  3648. "responses": {
  3649. "204": {
  3650. "$ref": "#/responses/empty"
  3651. }
  3652. }
  3653. },
  3654. "patch": {
  3655. "consumes": [
  3656. "application/json"
  3657. ],
  3658. "produces": [
  3659. "application/json"
  3660. ],
  3661. "tags": [
  3662. "repository"
  3663. ],
  3664. "summary": "Edit a release attachment",
  3665. "operationId": "repoEditReleaseAttachment",
  3666. "parameters": [
  3667. {
  3668. "type": "string",
  3669. "description": "owner of the repo",
  3670. "name": "owner",
  3671. "in": "path",
  3672. "required": true
  3673. },
  3674. {
  3675. "type": "string",
  3676. "description": "name of the repo",
  3677. "name": "repo",
  3678. "in": "path",
  3679. "required": true
  3680. },
  3681. {
  3682. "type": "integer",
  3683. "description": "id of the release",
  3684. "name": "id",
  3685. "in": "path",
  3686. "required": true
  3687. },
  3688. {
  3689. "type": "integer",
  3690. "description": "id of the attachment to edit",
  3691. "name": "attachment_id",
  3692. "in": "path",
  3693. "required": true
  3694. },
  3695. {
  3696. "name": "body",
  3697. "in": "body",
  3698. "schema": {
  3699. "$ref": "#/definitions/EditAttachmentOptions"
  3700. }
  3701. }
  3702. ],
  3703. "responses": {
  3704. "201": {
  3705. "$ref": "#/responses/Attachment"
  3706. }
  3707. }
  3708. }
  3709. },
  3710. "/repos/{owner}/{repo}/stargazers": {
  3711. "get": {
  3712. "produces": [
  3713. "application/json"
  3714. ],
  3715. "tags": [
  3716. "repository"
  3717. ],
  3718. "summary": "List a repo's stargazers",
  3719. "operationId": "repoListStargazers",
  3720. "parameters": [
  3721. {
  3722. "type": "string",
  3723. "description": "owner of the repo",
  3724. "name": "owner",
  3725. "in": "path",
  3726. "required": true
  3727. },
  3728. {
  3729. "type": "string",
  3730. "description": "name of the repo",
  3731. "name": "repo",
  3732. "in": "path",
  3733. "required": true
  3734. }
  3735. ],
  3736. "responses": {
  3737. "200": {
  3738. "$ref": "#/responses/UserList"
  3739. }
  3740. }
  3741. }
  3742. },
  3743. "/repos/{owner}/{repo}/statuses/{sha}": {
  3744. "get": {
  3745. "produces": [
  3746. "application/json"
  3747. ],
  3748. "tags": [
  3749. "repository"
  3750. ],
  3751. "summary": "Get a commit's statuses",
  3752. "operationId": "repoListStatuses",
  3753. "parameters": [
  3754. {
  3755. "type": "string",
  3756. "description": "owner of the repo",
  3757. "name": "owner",
  3758. "in": "path",
  3759. "required": true
  3760. },
  3761. {
  3762. "type": "string",
  3763. "description": "name of the repo",
  3764. "name": "repo",
  3765. "in": "path",
  3766. "required": true
  3767. },
  3768. {
  3769. "type": "string",
  3770. "description": "sha of the commit",
  3771. "name": "sha",
  3772. "in": "path",
  3773. "required": true
  3774. }
  3775. ],
  3776. "responses": {
  3777. "200": {
  3778. "$ref": "#/responses/StatusList"
  3779. }
  3780. }
  3781. },
  3782. "post": {
  3783. "produces": [
  3784. "application/json"
  3785. ],
  3786. "tags": [
  3787. "repository"
  3788. ],
  3789. "summary": "Create a commit status",
  3790. "operationId": "repoCreateStatus",
  3791. "parameters": [
  3792. {
  3793. "type": "string",
  3794. "description": "owner of the repo",
  3795. "name": "owner",
  3796. "in": "path",
  3797. "required": true
  3798. },
  3799. {
  3800. "type": "string",
  3801. "description": "name of the repo",
  3802. "name": "repo",
  3803. "in": "path",
  3804. "required": true
  3805. },
  3806. {
  3807. "type": "string",
  3808. "description": "sha of the commit",
  3809. "name": "sha",
  3810. "in": "path",
  3811. "required": true
  3812. },
  3813. {
  3814. "name": "body",
  3815. "in": "body",
  3816. "schema": {
  3817. "$ref": "#/definitions/CreateStatusOption"
  3818. }
  3819. }
  3820. ],
  3821. "responses": {
  3822. "200": {
  3823. "$ref": "#/responses/StatusList"
  3824. }
  3825. }
  3826. }
  3827. },
  3828. "/repos/{owner}/{repo}/subscribers": {
  3829. "get": {
  3830. "produces": [
  3831. "application/json"
  3832. ],
  3833. "tags": [
  3834. "repository"
  3835. ],
  3836. "summary": "List a repo's watchers",
  3837. "operationId": "repoListSubscribers",
  3838. "parameters": [
  3839. {
  3840. "type": "string",
  3841. "description": "owner of the repo",
  3842. "name": "owner",
  3843. "in": "path",
  3844. "required": true
  3845. },
  3846. {
  3847. "type": "string",
  3848. "description": "name of the repo",
  3849. "name": "repo",
  3850. "in": "path",
  3851. "required": true
  3852. }
  3853. ],
  3854. "responses": {
  3855. "200": {
  3856. "$ref": "#/responses/UserList"
  3857. }
  3858. }
  3859. }
  3860. },
  3861. "/repos/{owner}/{repo}/subscription": {
  3862. "get": {
  3863. "tags": [
  3864. "repository"
  3865. ],
  3866. "summary": "Check if the current user is watching a repo",
  3867. "operationId": "userCurrentCheckSubscription",
  3868. "parameters": [
  3869. {
  3870. "type": "string",
  3871. "description": "owner of the repo",
  3872. "name": "owner",
  3873. "in": "path",
  3874. "required": true
  3875. },
  3876. {
  3877. "type": "string",
  3878. "description": "name of the repo",
  3879. "name": "repo",
  3880. "in": "path",
  3881. "required": true
  3882. }
  3883. ],
  3884. "responses": {
  3885. "200": {
  3886. "$ref": "#/responses/WatchInfo"
  3887. }
  3888. }
  3889. },
  3890. "put": {
  3891. "tags": [
  3892. "repository"
  3893. ],
  3894. "summary": "Watch a repo",
  3895. "operationId": "userCurrentPutSubscription",
  3896. "parameters": [
  3897. {
  3898. "type": "string",
  3899. "description": "owner of the repo",
  3900. "name": "owner",
  3901. "in": "path",
  3902. "required": true
  3903. },
  3904. {
  3905. "type": "string",
  3906. "description": "name of the repo",
  3907. "name": "repo",
  3908. "in": "path",
  3909. "required": true
  3910. }
  3911. ],
  3912. "responses": {
  3913. "200": {
  3914. "$ref": "#/responses/WatchInfo"
  3915. }
  3916. }
  3917. },
  3918. "delete": {
  3919. "tags": [
  3920. "repository"
  3921. ],
  3922. "summary": "Unwatch a repo",
  3923. "operationId": "userCurrentDeleteSubscription",
  3924. "parameters": [
  3925. {
  3926. "type": "string",
  3927. "description": "owner of the repo",
  3928. "name": "owner",
  3929. "in": "path",
  3930. "required": true
  3931. },
  3932. {
  3933. "type": "string",
  3934. "description": "name of the repo",
  3935. "name": "repo",
  3936. "in": "path",
  3937. "required": true
  3938. }
  3939. ],
  3940. "responses": {
  3941. "204": {
  3942. "$ref": "#/responses/empty"
  3943. }
  3944. }
  3945. }
  3946. },
  3947. "/repos/{owner}/{repo}/times": {
  3948. "get": {
  3949. "produces": [
  3950. "application/json"
  3951. ],
  3952. "tags": [
  3953. "repository"
  3954. ],
  3955. "summary": "List a repo's tracked times",
  3956. "operationId": "repoTrackedTimes",
  3957. "parameters": [
  3958. {
  3959. "type": "string",
  3960. "description": "owner of the repo",
  3961. "name": "owner",
  3962. "in": "path",
  3963. "required": true
  3964. },
  3965. {
  3966. "type": "string",
  3967. "description": "name of the repo",
  3968. "name": "repo",
  3969. "in": "path",
  3970. "required": true
  3971. }
  3972. ],
  3973. "responses": {
  3974. "200": {
  3975. "$ref": "#/responses/TrackedTimeList"
  3976. }
  3977. }
  3978. }
  3979. },
  3980. "/repos/{owner}/{repo}/times/{tracker}": {
  3981. "get": {
  3982. "produces": [
  3983. "application/json"
  3984. ],
  3985. "tags": [
  3986. "user"
  3987. ],
  3988. "summary": "List a user's tracked times in a repo",
  3989. "operationId": "userTrackedTimes",
  3990. "parameters": [
  3991. {
  3992. "type": "string",
  3993. "description": "owner of the repo",
  3994. "name": "owner",
  3995. "in": "path",
  3996. "required": true
  3997. },
  3998. {
  3999. "type": "string",
  4000. "description": "name of the repo",
  4001. "name": "repo",
  4002. "in": "path",
  4003. "required": true
  4004. },
  4005. {
  4006. "type": "string",
  4007. "description": "username of user",
  4008. "name": "user",
  4009. "in": "path",
  4010. "required": true
  4011. }
  4012. ],
  4013. "responses": {
  4014. "200": {
  4015. "$ref": "#/responses/TrackedTimeList"
  4016. }
  4017. }
  4018. }
  4019. },
  4020. "/repos/{user}/{repo}/hooks/{id}": {
  4021. "delete": {
  4022. "produces": [
  4023. "application/json"
  4024. ],
  4025. "tags": [
  4026. "repository"
  4027. ],
  4028. "summary": "Delete a hook in a repository",
  4029. "operationId": "repoDeleteHook",
  4030. "parameters": [
  4031. {
  4032. "type": "string",
  4033. "description": "owner of the repo",
  4034. "name": "owner",
  4035. "in": "path",
  4036. "required": true
  4037. },
  4038. {
  4039. "type": "string",
  4040. "description": "name of the repo",
  4041. "name": "repo",
  4042. "in": "path",
  4043. "required": true
  4044. },
  4045. {
  4046. "type": "integer",
  4047. "description": "id of the hook to delete",
  4048. "name": "id",
  4049. "in": "path",
  4050. "required": true
  4051. }
  4052. ],
  4053. "responses": {
  4054. "204": {
  4055. "$ref": "#/responses/empty"
  4056. },
  4057. "404": {
  4058. "$ref": "#/responses/notFound"
  4059. }
  4060. }
  4061. }
  4062. },
  4063. "/repositories/{id}": {
  4064. "get": {
  4065. "produces": [
  4066. "application/json"
  4067. ],
  4068. "tags": [
  4069. "repository"
  4070. ],
  4071. "summary": "Get a repository by id",
  4072. "operationId": "repoGetByID",
  4073. "parameters": [
  4074. {
  4075. "type": "integer",
  4076. "description": "id of the repo to get",
  4077. "name": "id",
  4078. "in": "path",
  4079. "required": true
  4080. }
  4081. ],
  4082. "responses": {
  4083. "200": {
  4084. "$ref": "#/responses/Repository"
  4085. }
  4086. }
  4087. }
  4088. },
  4089. "/teams/{id}": {
  4090. "get": {
  4091. "produces": [
  4092. "application/json"
  4093. ],
  4094. "tags": [
  4095. "organization"
  4096. ],
  4097. "summary": "Get a team",
  4098. "operationId": "orgGetTeam",
  4099. "parameters": [
  4100. {
  4101. "type": "integer",
  4102. "description": "id of the team to get",
  4103. "name": "id",
  4104. "in": "path",
  4105. "required": true
  4106. }
  4107. ],
  4108. "responses": {
  4109. "200": {
  4110. "$ref": "#/responses/Team"
  4111. }
  4112. }
  4113. },
  4114. "delete": {
  4115. "tags": [
  4116. "organization"
  4117. ],
  4118. "summary": "Delete a team",
  4119. "operationId": "orgDeleteTeam",
  4120. "parameters": [
  4121. {
  4122. "type": "integer",
  4123. "description": "id of the team to delete",
  4124. "name": "id",
  4125. "in": "path",
  4126. "required": true
  4127. }
  4128. ],
  4129. "responses": {
  4130. "204": {
  4131. "description": "team deleted",
  4132. "schema": {
  4133. "$ref": "#/responses/empty"
  4134. }
  4135. }
  4136. }
  4137. },
  4138. "patch": {
  4139. "consumes": [
  4140. "application/json"
  4141. ],
  4142. "produces": [
  4143. "application/json"
  4144. ],
  4145. "tags": [
  4146. "organization"
  4147. ],
  4148. "summary": "Edit a team",
  4149. "operationId": "orgEditTeam",
  4150. "parameters": [
  4151. {
  4152. "type": "integer",
  4153. "description": "id of the team to edit",
  4154. "name": "id",
  4155. "in": "path",
  4156. "required": true
  4157. },
  4158. {
  4159. "name": "body",
  4160. "in": "body",
  4161. "schema": {
  4162. "$ref": "#/definitions/EditTeamOption"
  4163. }
  4164. }
  4165. ],
  4166. "responses": {
  4167. "200": {
  4168. "$ref": "#/responses/Team"
  4169. }
  4170. }
  4171. }
  4172. },
  4173. "/teams/{id}/members": {
  4174. "get": {
  4175. "produces": [
  4176. "application/json"
  4177. ],
  4178. "tags": [
  4179. "organization"
  4180. ],
  4181. "summary": "List a team's members",
  4182. "operationId": "orgListTeamMembers",
  4183. "parameters": [
  4184. {
  4185. "type": "integer",
  4186. "description": "id of the team",
  4187. "name": "id",
  4188. "in": "path",
  4189. "required": true
  4190. }
  4191. ],
  4192. "responses": {
  4193. "200": {
  4194. "$ref": "#/responses/UserList"
  4195. }
  4196. }
  4197. }
  4198. },
  4199. "/teams/{id}/members/{username}": {
  4200. "put": {
  4201. "produces": [
  4202. "application/json"
  4203. ],
  4204. "tags": [
  4205. "organization"
  4206. ],
  4207. "summary": "Add a team member",
  4208. "operationId": "orgAddTeamMember",
  4209. "parameters": [
  4210. {
  4211. "type": "integer",
  4212. "description": "id of the team",
  4213. "name": "id",
  4214. "in": "path",
  4215. "required": true
  4216. },
  4217. {
  4218. "type": "string",
  4219. "description": "username of the user to add",
  4220. "name": "username",
  4221. "in": "path",
  4222. "required": true
  4223. }
  4224. ],
  4225. "responses": {
  4226. "204": {
  4227. "$ref": "#/responses/empty"
  4228. }
  4229. }
  4230. },
  4231. "delete": {
  4232. "produces": [
  4233. "application/json"
  4234. ],
  4235. "tags": [
  4236. "organization"
  4237. ],
  4238. "summary": "Remove a team member",
  4239. "operationId": "orgAddTeamMember",
  4240. "parameters": [
  4241. {
  4242. "type": "integer",
  4243. "description": "id of the team",
  4244. "name": "id",
  4245. "in": "path",
  4246. "required": true
  4247. },
  4248. {
  4249. "type": "string",
  4250. "description": "username of the user to remove",
  4251. "name": "username",
  4252. "in": "path",
  4253. "required": true
  4254. }
  4255. ],
  4256. "responses": {
  4257. "204": {
  4258. "$ref": "#/responses/empty"
  4259. }
  4260. }
  4261. }
  4262. },
  4263. "/teams/{id}/repos": {
  4264. "get": {
  4265. "produces": [
  4266. "application/json"
  4267. ],
  4268. "tags": [
  4269. "organization"
  4270. ],
  4271. "summary": "List a team's repos",
  4272. "operationId": "orgListTeamRepos",
  4273. "parameters": [
  4274. {
  4275. "type": "integer",
  4276. "description": "id of the team",
  4277. "name": "id",
  4278. "in": "path",
  4279. "required": true
  4280. }
  4281. ],
  4282. "responses": {
  4283. "200": {
  4284. "$ref": "#/responses/RepositoryList"
  4285. }
  4286. }
  4287. }
  4288. },
  4289. "/teams/{id}/repos/{org}/{repo}": {
  4290. "put": {
  4291. "produces": [
  4292. "application/json"
  4293. ],
  4294. "tags": [
  4295. "organization"
  4296. ],
  4297. "summary": "Add a repository to a team",
  4298. "operationId": "orgAddTeamMember",
  4299. "parameters": [
  4300. {
  4301. "type": "integer",
  4302. "description": "id of the team",
  4303. "name": "id",
  4304. "in": "path",
  4305. "required": true
  4306. },
  4307. {
  4308. "type": "string",
  4309. "description": "organization that owns the repo to add",
  4310. "name": "org",
  4311. "in": "path",
  4312. "required": true
  4313. },
  4314. {
  4315. "type": "string",
  4316. "description": "name of the repo to add",
  4317. "name": "repo",
  4318. "in": "path",
  4319. "required": true
  4320. }
  4321. ],
  4322. "responses": {
  4323. "204": {
  4324. "$ref": "#/responses/empty"
  4325. }
  4326. }
  4327. },
  4328. "delete": {
  4329. "description": "This does not delete the repository, it only removes the repository from the team.",
  4330. "produces": [
  4331. "application/json"
  4332. ],
  4333. "tags": [
  4334. "organization"
  4335. ],
  4336. "summary": "Remove a repository from a team",
  4337. "operationId": "orgAddTeamMember",
  4338. "parameters": [
  4339. {
  4340. "type": "integer",
  4341. "description": "id of the team",
  4342. "name": "id",
  4343. "in": "path",
  4344. "required": true
  4345. },
  4346. {
  4347. "type": "string",
  4348. "description": "organization that owns the repo to remove",
  4349. "name": "org",
  4350. "in": "path",
  4351. "required": true
  4352. },
  4353. {
  4354. "type": "string",
  4355. "description": "name of the repo to remove",
  4356. "name": "repo",
  4357. "in": "path",
  4358. "required": true
  4359. }
  4360. ],
  4361. "responses": {
  4362. "204": {
  4363. "$ref": "#/responses/empty"
  4364. }
  4365. }
  4366. }
  4367. },
  4368. "/topics/search": {
  4369. "get": {
  4370. "produces": [
  4371. "application/json"
  4372. ],
  4373. "tags": [
  4374. "repository"
  4375. ],
  4376. "summary": "search topics via keyword",
  4377. "operationId": "topicSearch",
  4378. "parameters": [
  4379. {
  4380. "type": "integer",
  4381. "description": "id of the repo to get",
  4382. "name": "keyword",
  4383. "in": "path",
  4384. "required": true
  4385. }
  4386. ],
  4387. "responses": {
  4388. "200": {
  4389. "$ref": "#/responses/Repository"
  4390. }
  4391. }
  4392. }
  4393. },
  4394. "/user": {
  4395. "get": {
  4396. "produces": [
  4397. "application/json"
  4398. ],
  4399. "tags": [
  4400. "user"
  4401. ],
  4402. "summary": "Get the authenticated user",
  4403. "operationId": "userGetCurrent",
  4404. "responses": {
  4405. "200": {
  4406. "$ref": "#/responses/User"
  4407. }
  4408. }
  4409. }
  4410. },
  4411. "/user/emails": {
  4412. "get": {
  4413. "produces": [
  4414. "application/json"
  4415. ],
  4416. "tags": [
  4417. "user"
  4418. ],
  4419. "summary": "List the authenticated user's email addresses",
  4420. "operationId": "userListEmails",
  4421. "responses": {
  4422. "200": {
  4423. "$ref": "#/responses/EmailList"
  4424. }
  4425. }
  4426. },
  4427. "post": {
  4428. "produces": [
  4429. "application/json"
  4430. ],
  4431. "tags": [
  4432. "user"
  4433. ],
  4434. "summary": "Add email addresses",
  4435. "operationId": "userAddEmail",
  4436. "parameters": [
  4437. {
  4438. "name": "body",
  4439. "in": "body",
  4440. "schema": {
  4441. "$ref": "#/definitions/CreateEmailOption"
  4442. }
  4443. }
  4444. ],
  4445. "responses": {
  4446. "201": {
  4447. "$ref": "#/responses/EmailList"
  4448. }
  4449. }
  4450. },
  4451. "delete": {
  4452. "produces": [
  4453. "application/json"
  4454. ],
  4455. "tags": [
  4456. "user"
  4457. ],
  4458. "summary": "Delete email addresses",
  4459. "operationId": "userDeleteEmail",
  4460. "parameters": [
  4461. {
  4462. "name": "body",
  4463. "in": "body",
  4464. "schema": {
  4465. "$ref": "#/definitions/DeleteEmailOption"
  4466. }
  4467. }
  4468. ],
  4469. "responses": {
  4470. "204": {
  4471. "$ref": "#/responses/empty"
  4472. }
  4473. }
  4474. }
  4475. },
  4476. "/user/followers": {
  4477. "get": {
  4478. "produces": [
  4479. "application/json"
  4480. ],
  4481. "tags": [
  4482. "user"
  4483. ],
  4484. "summary": "List the authenticated user's followers",
  4485. "operationId": "userCurrentListFollowers",
  4486. "responses": {
  4487. "200": {
  4488. "$ref": "#/responses/UserList"
  4489. }
  4490. }
  4491. }
  4492. },
  4493. "/user/following": {
  4494. "get": {
  4495. "produces": [
  4496. "application/json"
  4497. ],
  4498. "tags": [
  4499. "user"
  4500. ],
  4501. "summary": "List the users that the authenticated user is following",
  4502. "operationId": "userCurrentListFollowing",
  4503. "responses": {
  4504. "200": {
  4505. "$ref": "#/responses/UserList"
  4506. }
  4507. }
  4508. }
  4509. },
  4510. "/user/following/{followee}": {
  4511. "get": {
  4512. "tags": [
  4513. "user"
  4514. ],
  4515. "summary": "Check whether a user is followed by the authenticated user",
  4516. "operationId": "userCurrentCheckFollowing",
  4517. "parameters": [
  4518. {
  4519. "type": "string",
  4520. "description": "username of followed user",
  4521. "name": "followee",
  4522. "in": "path",
  4523. "required": true
  4524. }
  4525. ],
  4526. "responses": {
  4527. "204": {
  4528. "$ref": "#/responses/empty"
  4529. },
  4530. "404": {
  4531. "$ref": "#/responses/notFound"
  4532. }
  4533. }
  4534. }
  4535. },
  4536. "/user/following/{username}": {
  4537. "put": {
  4538. "tags": [
  4539. "user"
  4540. ],
  4541. "summary": "Follow a user",
  4542. "operationId": "userCurrentPutFollow",
  4543. "parameters": [
  4544. {
  4545. "type": "string",
  4546. "description": "username of user to follow",
  4547. "name": "username",
  4548. "in": "path",
  4549. "required": true
  4550. }
  4551. ],
  4552. "responses": {
  4553. "204": {
  4554. "$ref": "#/responses/empty"
  4555. }
  4556. }
  4557. },
  4558. "delete": {
  4559. "tags": [
  4560. "user"
  4561. ],
  4562. "summary": "Unfollow a user",
  4563. "operationId": "userCurrentDeleteFollow",
  4564. "parameters": [
  4565. {
  4566. "type": "string",
  4567. "description": "username of user to unfollow",
  4568. "name": "username",
  4569. "in": "path",
  4570. "required": true
  4571. }
  4572. ],
  4573. "responses": {
  4574. "204": {
  4575. "$ref": "#/responses/empty"
  4576. }
  4577. }
  4578. }
  4579. },
  4580. "/user/gpg_keys": {
  4581. "get": {
  4582. "produces": [
  4583. "application/json"
  4584. ],
  4585. "tags": [
  4586. "user"
  4587. ],
  4588. "summary": "List the authenticated user's GPG keys",
  4589. "operationId": "userCurrentListGPGKeys",
  4590. "responses": {
  4591. "200": {
  4592. "$ref": "#/responses/GPGKeyList"
  4593. }
  4594. }
  4595. },
  4596. "post": {
  4597. "consumes": [
  4598. "application/json"
  4599. ],
  4600. "produces": [
  4601. "application/json"
  4602. ],
  4603. "tags": [
  4604. "user"
  4605. ],
  4606. "summary": "Create a GPG key",
  4607. "operationId": "userCurrentPostGPGKey",
  4608. "parameters": [
  4609. {
  4610. "name": "Form",
  4611. "in": "body",
  4612. "schema": {
  4613. "$ref": "#/definitions/CreateGPGKeyOption"
  4614. }
  4615. }
  4616. ],
  4617. "responses": {
  4618. "201": {
  4619. "$ref": "#/responses/GPGKey"
  4620. },
  4621. "422": {
  4622. "$ref": "#/responses/validationError"
  4623. }
  4624. }
  4625. }
  4626. },
  4627. "/user/gpg_keys/{id}": {
  4628. "get": {
  4629. "produces": [
  4630. "application/json"
  4631. ],
  4632. "tags": [
  4633. "user"
  4634. ],
  4635. "summary": "Get a GPG key",
  4636. "operationId": "userCurrentGetGPGKey",
  4637. "parameters": [
  4638. {
  4639. "type": "integer",
  4640. "description": "id of key to get",
  4641. "name": "id",
  4642. "in": "path",
  4643. "required": true
  4644. }
  4645. ],
  4646. "responses": {
  4647. "200": {
  4648. "$ref": "#/responses/GPGKey"
  4649. },
  4650. "404": {
  4651. "$ref": "#/responses/notFound"
  4652. }
  4653. }
  4654. },
  4655. "delete": {
  4656. "produces": [
  4657. "application/json"
  4658. ],
  4659. "tags": [
  4660. "user"
  4661. ],
  4662. "summary": "Remove a GPG key",
  4663. "operationId": "userCurrentDeleteGPGKey",
  4664. "parameters": [
  4665. {
  4666. "type": "integer",
  4667. "description": "id of key to delete",
  4668. "name": "id",
  4669. "in": "path",
  4670. "required": true
  4671. }
  4672. ],
  4673. "responses": {
  4674. "204": {
  4675. "$ref": "#/responses/empty"
  4676. },
  4677. "403": {
  4678. "$ref": "#/responses/forbidden"
  4679. }
  4680. }
  4681. }
  4682. },
  4683. "/user/keys": {
  4684. "get": {
  4685. "produces": [
  4686. "application/json"
  4687. ],
  4688. "tags": [
  4689. "user"
  4690. ],
  4691. "summary": "List the authenticated user's public keys",
  4692. "operationId": "userCurrentListKeys",
  4693. "responses": {
  4694. "200": {
  4695. "$ref": "#/responses/PublicKeyList"
  4696. }
  4697. }
  4698. },
  4699. "post": {
  4700. "consumes": [
  4701. "application/json"
  4702. ],
  4703. "produces": [
  4704. "application/json"
  4705. ],
  4706. "tags": [
  4707. "user"
  4708. ],
  4709. "summary": "Create a public key",
  4710. "operationId": "userCurrentPostKey",
  4711. "parameters": [
  4712. {
  4713. "name": "body",
  4714. "in": "body",
  4715. "schema": {
  4716. "$ref": "#/definitions/CreateKeyOption"
  4717. }
  4718. }
  4719. ],
  4720. "responses": {
  4721. "201": {
  4722. "$ref": "#/responses/PublicKey"
  4723. },
  4724. "422": {
  4725. "$ref": "#/responses/validationError"
  4726. }
  4727. }
  4728. }
  4729. },
  4730. "/user/keys/{id}": {
  4731. "get": {
  4732. "produces": [
  4733. "application/json"
  4734. ],
  4735. "tags": [
  4736. "user"
  4737. ],
  4738. "summary": "Get a public key",
  4739. "operationId": "userCurrentGetKey",
  4740. "parameters": [
  4741. {
  4742. "type": "integer",
  4743. "description": "id of key to get",
  4744. "name": "id",
  4745. "in": "path",
  4746. "required": true
  4747. }
  4748. ],
  4749. "responses": {
  4750. "200": {
  4751. "$ref": "#/responses/PublicKey"
  4752. },
  4753. "404": {
  4754. "$ref": "#/responses/notFound"
  4755. }
  4756. }
  4757. },
  4758. "delete": {
  4759. "produces": [
  4760. "application/json"
  4761. ],
  4762. "tags": [
  4763. "user"
  4764. ],
  4765. "summary": "Delete a public key",
  4766. "operationId": "userCurrentDeleteKey",
  4767. "parameters": [
  4768. {
  4769. "type": "integer",
  4770. "description": "id of key to delete",
  4771. "name": "id",
  4772. "in": "path",
  4773. "required": true
  4774. }
  4775. ],
  4776. "responses": {
  4777. "204": {
  4778. "$ref": "#/responses/empty"
  4779. },
  4780. "403": {
  4781. "$ref": "#/responses/forbidden"
  4782. },
  4783. "404": {
  4784. "$ref": "#/responses/notFound"
  4785. }
  4786. }
  4787. }
  4788. },
  4789. "/user/orgs": {
  4790. "get": {
  4791. "produces": [
  4792. "application/json"
  4793. ],
  4794. "tags": [
  4795. "organization"
  4796. ],
  4797. "summary": "List the current user's organizations",
  4798. "operationId": "orgListCurrentUserOrgs",
  4799. "responses": {
  4800. "200": {
  4801. "$ref": "#/responses/OrganizationList"
  4802. }
  4803. }
  4804. }
  4805. },
  4806. "/user/repos": {
  4807. "get": {
  4808. "produces": [
  4809. "application/json"
  4810. ],
  4811. "tags": [
  4812. "user"
  4813. ],
  4814. "summary": "List the repos that the authenticated user owns or has access to",
  4815. "operationId": "userCurrentListRepos",
  4816. "responses": {
  4817. "200": {
  4818. "$ref": "#/responses/RepositoryList"
  4819. }
  4820. }
  4821. },
  4822. "post": {
  4823. "consumes": [
  4824. "application/json"
  4825. ],
  4826. "produces": [
  4827. "application/json"
  4828. ],
  4829. "tags": [
  4830. "repository",
  4831. "user"
  4832. ],
  4833. "summary": "Create a repository",
  4834. "operationId": "createCurrentUserRepo",
  4835. "parameters": [
  4836. {
  4837. "name": "body",
  4838. "in": "body",
  4839. "schema": {
  4840. "$ref": "#/definitions/CreateRepoOption"
  4841. }
  4842. }
  4843. ],
  4844. "responses": {
  4845. "201": {
  4846. "$ref": "#/responses/Repository"
  4847. }
  4848. }
  4849. }
  4850. },
  4851. "/user/starred": {
  4852. "get": {
  4853. "produces": [
  4854. "application/json"
  4855. ],
  4856. "tags": [
  4857. "user"
  4858. ],
  4859. "summary": "The repos that the authenticated user has starred",
  4860. "operationId": "userCurrentListStarred",
  4861. "responses": {
  4862. "200": {
  4863. "$ref": "#/responses/RepositoryList"
  4864. }
  4865. }
  4866. }
  4867. },
  4868. "/user/starred/{owner}/{repo}": {
  4869. "get": {
  4870. "tags": [
  4871. "user"
  4872. ],
  4873. "summary": "Whether the authenticated is starring the repo",
  4874. "operationId": "userCurrentCheckStarring",
  4875. "parameters": [
  4876. {
  4877. "type": "string",
  4878. "description": "owner of the repo",
  4879. "name": "owner",
  4880. "in": "path",
  4881. "required": true
  4882. },
  4883. {
  4884. "type": "string",
  4885. "description": "name of the repo",
  4886. "name": "repo",
  4887. "in": "path",
  4888. "required": true
  4889. }
  4890. ],
  4891. "responses": {
  4892. "204": {
  4893. "$ref": "#/responses/empty"
  4894. },
  4895. "404": {
  4896. "$ref": "#/responses/notFound"
  4897. }
  4898. }
  4899. },
  4900. "put": {
  4901. "tags": [
  4902. "user"
  4903. ],
  4904. "summary": "Star the given repo",
  4905. "operationId": "userCurrentPutStar",
  4906. "parameters": [
  4907. {
  4908. "type": "string",
  4909. "description": "owner of the repo to star",
  4910. "name": "owner",
  4911. "in": "path",
  4912. "required": true
  4913. },
  4914. {
  4915. "type": "string",
  4916. "description": "name of the repo to star",
  4917. "name": "repo",
  4918. "in": "path",
  4919. "required": true
  4920. }
  4921. ],
  4922. "responses": {
  4923. "204": {
  4924. "$ref": "#/responses/empty"
  4925. }
  4926. }
  4927. },
  4928. "delete": {
  4929. "tags": [
  4930. "user"
  4931. ],
  4932. "summary": "Unstar the given repo",
  4933. "operationId": "userCurrentDeleteStar",
  4934. "parameters": [
  4935. {
  4936. "type": "string",
  4937. "description": "owner of the repo to unstar",
  4938. "name": "owner",
  4939. "in": "path",
  4940. "required": true
  4941. },
  4942. {
  4943. "type": "string",
  4944. "description": "name of the repo to unstar",
  4945. "name": "repo",
  4946. "in": "path",
  4947. "required": true
  4948. }
  4949. ],
  4950. "responses": {
  4951. "204": {
  4952. "$ref": "#/responses/empty"
  4953. }
  4954. }
  4955. }
  4956. },
  4957. "/user/subscriptions": {
  4958. "get": {
  4959. "produces": [
  4960. "application/json"
  4961. ],
  4962. "tags": [
  4963. "user"
  4964. ],
  4965. "summary": "List repositories watched by the authenticated user",
  4966. "operationId": "userCurrentListSubscriptions",
  4967. "responses": {
  4968. "200": {
  4969. "$ref": "#/responses/RepositoryList"
  4970. }
  4971. }
  4972. }
  4973. },
  4974. "/user/times": {
  4975. "get": {
  4976. "produces": [
  4977. "application/json"
  4978. ],
  4979. "tags": [
  4980. "user"
  4981. ],
  4982. "summary": "List the current user's tracked times",
  4983. "operationId": "userCurrentTrackedTimes",
  4984. "responses": {
  4985. "200": {
  4986. "$ref": "#/responses/TrackedTimeList"
  4987. }
  4988. }
  4989. }
  4990. },
  4991. "/user/{username}/orgs": {
  4992. "get": {
  4993. "produces": [
  4994. "application/json"
  4995. ],
  4996. "tags": [
  4997. "organization"
  4998. ],
  4999. "summary": "List a user's organizations",
  5000. "operationId": "orgListUserOrgs",
  5001. "parameters": [
  5002. {
  5003. "type": "string",
  5004. "description": "username of user",
  5005. "name": "username",
  5006. "in": "path"
  5007. }
  5008. ],
  5009. "responses": {
  5010. "200": {
  5011. "$ref": "#/responses/OrganizationList"
  5012. }
  5013. }
  5014. }
  5015. },
  5016. "/users/search": {
  5017. "get": {
  5018. "produces": [
  5019. "application/json"
  5020. ],
  5021. "tags": [
  5022. "user"
  5023. ],
  5024. "summary": "Search for users",
  5025. "operationId": "userSearch",
  5026. "parameters": [
  5027. {
  5028. "type": "string",
  5029. "description": "keyword",
  5030. "name": "q",
  5031. "in": "query"
  5032. },
  5033. {
  5034. "type": "integer",
  5035. "description": "maximum number of users to return",
  5036. "name": "limit",
  5037. "in": "query"
  5038. }
  5039. ],
  5040. "responses": {
  5041. "200": {
  5042. "$ref": "#/responses/UserList"
  5043. }
  5044. }
  5045. }
  5046. },
  5047. "/users/{follower}/following/{followee}": {
  5048. "get": {
  5049. "tags": [
  5050. "user"
  5051. ],
  5052. "summary": "Check if one user is following another user",
  5053. "operationId": "userCheckFollowing",
  5054. "parameters": [
  5055. {
  5056. "type": "string",
  5057. "description": "username of following user",
  5058. "name": "follower",
  5059. "in": "path",
  5060. "required": true
  5061. },
  5062. {
  5063. "type": "string",
  5064. "description": "username of followed user",
  5065. "name": "followee",
  5066. "in": "path",
  5067. "required": true
  5068. }
  5069. ],
  5070. "responses": {
  5071. "204": {
  5072. "$ref": "#/responses/empty"
  5073. },
  5074. "404": {
  5075. "$ref": "#/responses/notFound"
  5076. }
  5077. }
  5078. }
  5079. },
  5080. "/users/{username}": {
  5081. "get": {
  5082. "produces": [
  5083. "application/json"
  5084. ],
  5085. "tags": [
  5086. "user"
  5087. ],
  5088. "summary": "Get a user",
  5089. "operationId": "userGet",
  5090. "parameters": [
  5091. {
  5092. "type": "string",
  5093. "description": "username of user to get",
  5094. "name": "username",
  5095. "in": "path",
  5096. "required": true
  5097. }
  5098. ],
  5099. "responses": {
  5100. "200": {
  5101. "$ref": "#/responses/User"
  5102. },
  5103. "404": {
  5104. "$ref": "#/responses/notFound"
  5105. }
  5106. }
  5107. }
  5108. },
  5109. "/users/{username}/followers": {
  5110. "get": {
  5111. "produces": [
  5112. "application/json"
  5113. ],
  5114. "tags": [
  5115. "user"
  5116. ],
  5117. "summary": "List the given user's followers",
  5118. "operationId": "userListFollowers",
  5119. "parameters": [
  5120. {
  5121. "type": "string",
  5122. "description": "username of user",
  5123. "name": "username",
  5124. "in": "path",
  5125. "required": true
  5126. }
  5127. ],
  5128. "responses": {
  5129. "200": {
  5130. "$ref": "#/responses/UserList"
  5131. }
  5132. }
  5133. }
  5134. },
  5135. "/users/{username}/following": {
  5136. "get": {
  5137. "produces": [
  5138. "application/json"
  5139. ],
  5140. "tags": [
  5141. "user"
  5142. ],
  5143. "summary": "List the users that the given user is following",
  5144. "operationId": "userListFollowing",
  5145. "parameters": [
  5146. {
  5147. "type": "string",
  5148. "description": "username of user",
  5149. "name": "username",
  5150. "in": "path",
  5151. "required": true
  5152. }
  5153. ],
  5154. "responses": {
  5155. "200": {
  5156. "$ref": "#/responses/UserList"
  5157. }
  5158. }
  5159. }
  5160. },
  5161. "/users/{username}/gpg_keys": {
  5162. "get": {
  5163. "produces": [
  5164. "application/json"
  5165. ],
  5166. "tags": [
  5167. "user"
  5168. ],
  5169. "summary": "List the given user's GPG keys",
  5170. "operationId": "userListGPGKeys",
  5171. "parameters": [
  5172. {
  5173. "type": "string",
  5174. "description": "username of user",
  5175. "name": "username",
  5176. "in": "path",
  5177. "required": true
  5178. }
  5179. ],
  5180. "responses": {
  5181. "200": {
  5182. "$ref": "#/responses/GPGKeyList"
  5183. }
  5184. }
  5185. }
  5186. },
  5187. "/users/{username}/keys": {
  5188. "get": {
  5189. "produces": [
  5190. "application/json"
  5191. ],
  5192. "tags": [
  5193. "user"
  5194. ],
  5195. "summary": "List the given user's public keys",
  5196. "operationId": "userListKeys",
  5197. "parameters": [
  5198. {
  5199. "type": "string",
  5200. "description": "username of user",
  5201. "name": "username",
  5202. "in": "path",
  5203. "required": true
  5204. }
  5205. ],
  5206. "responses": {
  5207. "200": {
  5208. "$ref": "#/responses/PublicKeyList"
  5209. }
  5210. }
  5211. }
  5212. },
  5213. "/users/{username}/repos": {
  5214. "get": {
  5215. "produces": [
  5216. "application/json"
  5217. ],
  5218. "tags": [
  5219. "user"
  5220. ],
  5221. "summary": "List the repos owned by the given user",
  5222. "operationId": "userListRepos",
  5223. "parameters": [
  5224. {
  5225. "type": "string",
  5226. "description": "username of user",
  5227. "name": "username",
  5228. "in": "path",
  5229. "required": true
  5230. }
  5231. ],
  5232. "responses": {
  5233. "200": {
  5234. "$ref": "#/responses/RepositoryList"
  5235. }
  5236. }
  5237. }
  5238. },
  5239. "/users/{username}/starred": {
  5240. "get": {
  5241. "produces": [
  5242. "application/json"
  5243. ],
  5244. "tags": [
  5245. "user"
  5246. ],
  5247. "summary": "The repos that the given user has starred",
  5248. "operationId": "userListStarred",
  5249. "parameters": [
  5250. {
  5251. "type": "string",
  5252. "description": "username of user",
  5253. "name": "username",
  5254. "in": "path",
  5255. "required": true
  5256. }
  5257. ],
  5258. "responses": {
  5259. "200": {
  5260. "$ref": "#/responses/RepositoryList"
  5261. }
  5262. }
  5263. }
  5264. },
  5265. "/users/{username}/subscriptions": {
  5266. "get": {
  5267. "produces": [
  5268. "application/json"
  5269. ],
  5270. "tags": [
  5271. "user"
  5272. ],
  5273. "summary": "List the repositories watched by a user",
  5274. "operationId": "userListSubscriptions",
  5275. "parameters": [
  5276. {
  5277. "type": "string",
  5278. "description": "username of the user",
  5279. "name": "username",
  5280. "in": "path"
  5281. }
  5282. ],
  5283. "responses": {
  5284. "200": {
  5285. "$ref": "#/responses/RepositoryList"
  5286. }
  5287. }
  5288. }
  5289. },
  5290. "/users/{username}/tokens": {
  5291. "get": {
  5292. "produces": [
  5293. "application/json"
  5294. ],
  5295. "tags": [
  5296. "user"
  5297. ],
  5298. "summary": "List the authenticated user's access tokens",
  5299. "operationId": "userGetTokens",
  5300. "responses": {
  5301. "200": {
  5302. "$ref": "#/responses/AccessTokenList"
  5303. }
  5304. }
  5305. },
  5306. "post": {
  5307. "consumes": [
  5308. "application/json"
  5309. ],
  5310. "produces": [
  5311. "application/json"
  5312. ],
  5313. "tags": [
  5314. "user"
  5315. ],
  5316. "summary": "Create an access token",
  5317. "operationId": "userCreateToken",
  5318. "parameters": [
  5319. {
  5320. "type": "string",
  5321. "x-go-name": "Name",
  5322. "name": "name",
  5323. "in": "query"
  5324. }
  5325. ],
  5326. "responses": {
  5327. "200": {
  5328. "$ref": "#/responses/AccessToken"
  5329. }
  5330. }
  5331. }
  5332. },
  5333. "/version": {
  5334. "get": {
  5335. "produces": [
  5336. "application/json"
  5337. ],
  5338. "tags": [
  5339. "miscellaneous"
  5340. ],
  5341. "summary": "Returns the version of the Gitea application",
  5342. "operationId": "getVersion",
  5343. "responses": {
  5344. "200": {
  5345. "$ref": "#/responses/ServerVersion"
  5346. }
  5347. }
  5348. }
  5349. }
  5350. },
  5351. "definitions": {
  5352. "AddCollaboratorOption": {
  5353. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  5354. "type": "object",
  5355. "properties": {
  5356. "permission": {
  5357. "type": "string",
  5358. "x-go-name": "Permission"
  5359. }
  5360. },
  5361. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5362. },
  5363. "AddTimeOption": {
  5364. "description": "AddTimeOption options for adding time to an issue",
  5365. "type": "object",
  5366. "required": [
  5367. "time"
  5368. ],
  5369. "properties": {
  5370. "time": {
  5371. "description": "time in seconds",
  5372. "type": "integer",
  5373. "format": "int64",
  5374. "x-go-name": "Time"
  5375. }
  5376. },
  5377. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5378. },
  5379. "Attachment": {
  5380. "description": "Attachment a generic attachment",
  5381. "type": "object",
  5382. "properties": {
  5383. "browser_download_url": {
  5384. "type": "string",
  5385. "x-go-name": "DownloadURL"
  5386. },
  5387. "created_at": {
  5388. "type": "string",
  5389. "format": "date-time",
  5390. "x-go-name": "Created"
  5391. },
  5392. "download_count": {
  5393. "type": "integer",
  5394. "format": "int64",
  5395. "x-go-name": "DownloadCount"
  5396. },
  5397. "id": {
  5398. "type": "integer",
  5399. "format": "int64",
  5400. "x-go-name": "ID"
  5401. },
  5402. "name": {
  5403. "type": "string",
  5404. "x-go-name": "Name"
  5405. },
  5406. "size": {
  5407. "type": "integer",
  5408. "format": "int64",
  5409. "x-go-name": "Size"
  5410. },
  5411. "uuid": {
  5412. "type": "string",
  5413. "x-go-name": "UUID"
  5414. }
  5415. },
  5416. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5417. },
  5418. "Branch": {
  5419. "description": "Branch represents a repository branch",
  5420. "type": "object",
  5421. "properties": {
  5422. "commit": {
  5423. "$ref": "#/definitions/PayloadCommit"
  5424. },
  5425. "name": {
  5426. "type": "string",
  5427. "x-go-name": "Name"
  5428. }
  5429. },
  5430. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5431. },
  5432. "Comment": {
  5433. "description": "Comment represents a comment on a commit or issue",
  5434. "type": "object",
  5435. "properties": {
  5436. "body": {
  5437. "type": "string",
  5438. "x-go-name": "Body"
  5439. },
  5440. "created_at": {
  5441. "type": "string",
  5442. "format": "date-time",
  5443. "x-go-name": "Created"
  5444. },
  5445. "html_url": {
  5446. "type": "string",
  5447. "x-go-name": "HTMLURL"
  5448. },
  5449. "id": {
  5450. "type": "integer",
  5451. "format": "int64",
  5452. "x-go-name": "ID"
  5453. },
  5454. "issue_url": {
  5455. "type": "string",
  5456. "x-go-name": "IssueURL"
  5457. },
  5458. "pull_request_url": {
  5459. "type": "string",
  5460. "x-go-name": "PRURL"
  5461. },
  5462. "updated_at": {
  5463. "type": "string",
  5464. "format": "date-time",
  5465. "x-go-name": "Updated"
  5466. },
  5467. "user": {
  5468. "$ref": "#/definitions/User"
  5469. }
  5470. },
  5471. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5472. },
  5473. "CreateEmailOption": {
  5474. "description": "CreateEmailOption options when creating email addresses",
  5475. "type": "object",
  5476. "properties": {
  5477. "emails": {
  5478. "description": "email addresses to add",
  5479. "type": "array",
  5480. "items": {
  5481. "type": "string"
  5482. },
  5483. "x-go-name": "Emails"
  5484. }
  5485. },
  5486. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5487. },
  5488. "CreateForkOption": {
  5489. "description": "CreateForkOption options for creating a fork",
  5490. "type": "object",
  5491. "properties": {
  5492. "organization": {
  5493. "description": "organization name, if forking into an organization",
  5494. "type": "string",
  5495. "x-go-name": "Organization"
  5496. }
  5497. },
  5498. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5499. },
  5500. "CreateGPGKeyOption": {
  5501. "description": "CreateGPGKeyOption options create user GPG key",
  5502. "type": "object",
  5503. "required": [
  5504. "armored_public_key"
  5505. ],
  5506. "properties": {
  5507. "armored_public_key": {
  5508. "description": "An armored GPG key to add",
  5509. "type": "string",
  5510. "uniqueItems": true,
  5511. "x-go-name": "ArmoredKey"
  5512. }
  5513. },
  5514. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5515. },
  5516. "CreateHookOption": {
  5517. "description": "CreateHookOption options when create a hook",
  5518. "type": "object",
  5519. "required": [
  5520. "type",
  5521. "config"
  5522. ],
  5523. "properties": {
  5524. "active": {
  5525. "type": "boolean",
  5526. "default": false,
  5527. "x-go-name": "Active"
  5528. },
  5529. "config": {
  5530. "type": "object",
  5531. "additionalProperties": {
  5532. "type": "string"
  5533. },
  5534. "x-go-name": "Config"
  5535. },
  5536. "events": {
  5537. "type": "array",
  5538. "items": {
  5539. "type": "string"
  5540. },
  5541. "x-go-name": "Events"
  5542. },
  5543. "type": {
  5544. "type": "string",
  5545. "enum": [
  5546. "gitea",
  5547. "gogs",
  5548. "slack",
  5549. "discord"
  5550. ],
  5551. "x-go-name": "Type"
  5552. }
  5553. },
  5554. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5555. },
  5556. "CreateIssueCommentOption": {
  5557. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  5558. "type": "object",
  5559. "required": [
  5560. "body"
  5561. ],
  5562. "properties": {
  5563. "body": {
  5564. "type": "string",
  5565. "x-go-name": "Body"
  5566. }
  5567. },
  5568. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5569. },
  5570. "CreateIssueOption": {
  5571. "description": "CreateIssueOption options to create one issue",
  5572. "type": "object",
  5573. "required": [
  5574. "title"
  5575. ],
  5576. "properties": {
  5577. "assignee": {
  5578. "description": "username of assignee",
  5579. "type": "string",
  5580. "x-go-name": "Assignee"
  5581. },
  5582. "assignees": {
  5583. "type": "array",
  5584. "items": {
  5585. "type": "string"
  5586. },
  5587. "x-go-name": "Assignees"
  5588. },
  5589. "body": {
  5590. "type": "string",
  5591. "x-go-name": "Body"
  5592. },
  5593. "closed": {
  5594. "type": "boolean",
  5595. "x-go-name": "Closed"
  5596. },
  5597. "due_date": {
  5598. "type": "string",
  5599. "format": "date-time",
  5600. "x-go-name": "Deadline"
  5601. },
  5602. "labels": {
  5603. "description": "list of label ids",
  5604. "type": "array",
  5605. "items": {
  5606. "type": "integer",
  5607. "format": "int64"
  5608. },
  5609. "x-go-name": "Labels"
  5610. },
  5611. "milestone": {
  5612. "description": "milestone id",
  5613. "type": "integer",
  5614. "format": "int64",
  5615. "x-go-name": "Milestone"
  5616. },
  5617. "title": {
  5618. "type": "string",
  5619. "x-go-name": "Title"
  5620. }
  5621. },
  5622. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5623. },
  5624. "CreateKeyOption": {
  5625. "description": "CreateKeyOption options when creating a key",
  5626. "type": "object",
  5627. "required": [
  5628. "title",
  5629. "key"
  5630. ],
  5631. "properties": {
  5632. "key": {
  5633. "description": "An armored SSH key to add",
  5634. "type": "string",
  5635. "uniqueItems": true,
  5636. "x-go-name": "Key"
  5637. },
  5638. "read_only": {
  5639. "description": "Describe if the key has only read access or read/write",
  5640. "type": "boolean",
  5641. "x-go-name": "ReadOnly"
  5642. },
  5643. "title": {
  5644. "description": "Title of the key to add",
  5645. "type": "string",
  5646. "uniqueItems": true,
  5647. "x-go-name": "Title"
  5648. }
  5649. },
  5650. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5651. },
  5652. "CreateLabelOption": {
  5653. "description": "CreateLabelOption options for creating a label",
  5654. "type": "object",
  5655. "required": [
  5656. "name",
  5657. "color"
  5658. ],
  5659. "properties": {
  5660. "color": {
  5661. "type": "string",
  5662. "x-go-name": "Color",
  5663. "example": "#00aabb"
  5664. },
  5665. "name": {
  5666. "type": "string",
  5667. "x-go-name": "Name"
  5668. }
  5669. },
  5670. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5671. },
  5672. "CreateMilestoneOption": {
  5673. "description": "CreateMilestoneOption options for creating a milestone",
  5674. "type": "object",
  5675. "properties": {
  5676. "description": {
  5677. "type": "string",
  5678. "x-go-name": "Description"
  5679. },
  5680. "due_on": {
  5681. "type": "string",
  5682. "format": "date-time",
  5683. "x-go-name": "Deadline"
  5684. },
  5685. "title": {
  5686. "type": "string",
  5687. "x-go-name": "Title"
  5688. }
  5689. },
  5690. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5691. },
  5692. "CreateOrgOption": {
  5693. "description": "CreateOrgOption options for creating an organization",
  5694. "type": "object",
  5695. "required": [
  5696. "username"
  5697. ],
  5698. "properties": {
  5699. "description": {
  5700. "type": "string",
  5701. "x-go-name": "Description"
  5702. },
  5703. "full_name": {
  5704. "type": "string",
  5705. "x-go-name": "FullName"
  5706. },
  5707. "location": {
  5708. "type": "string",
  5709. "x-go-name": "Location"
  5710. },
  5711. "username": {
  5712. "type": "string",
  5713. "x-go-name": "UserName"
  5714. },
  5715. "website": {
  5716. "type": "string",
  5717. "x-go-name": "Website"
  5718. }
  5719. },
  5720. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5721. },
  5722. "CreatePullRequestOption": {
  5723. "description": "CreatePullRequestOption options when creating a pull request",
  5724. "type": "object",
  5725. "properties": {
  5726. "assignee": {
  5727. "type": "string",
  5728. "x-go-name": "Assignee"
  5729. },
  5730. "assignees": {
  5731. "type": "array",
  5732. "items": {
  5733. "type": "string"
  5734. },
  5735. "x-go-name": "Assignees"
  5736. },
  5737. "base": {
  5738. "type": "string",
  5739. "x-go-name": "Base"
  5740. },
  5741. "body": {
  5742. "type": "string",
  5743. "x-go-name": "Body"
  5744. },
  5745. "due_date": {
  5746. "type": "string",
  5747. "format": "date-time",
  5748. "x-go-name": "Deadline"
  5749. },
  5750. "head": {
  5751. "type": "string",
  5752. "x-go-name": "Head"
  5753. },
  5754. "labels": {
  5755. "type": "array",
  5756. "items": {
  5757. "type": "integer",
  5758. "format": "int64"
  5759. },
  5760. "x-go-name": "Labels"
  5761. },
  5762. "milestone": {
  5763. "type": "integer",
  5764. "format": "int64",
  5765. "x-go-name": "Milestone"
  5766. },
  5767. "title": {
  5768. "type": "string",
  5769. "x-go-name": "Title"
  5770. }
  5771. },
  5772. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5773. },
  5774. "CreateReleaseOption": {
  5775. "description": "CreateReleaseOption options when creating a release",
  5776. "type": "object",
  5777. "required": [
  5778. "tag_name"
  5779. ],
  5780. "properties": {
  5781. "body": {
  5782. "type": "string",
  5783. "x-go-name": "Note"
  5784. },
  5785. "draft": {
  5786. "type": "boolean",
  5787. "x-go-name": "IsDraft"
  5788. },
  5789. "name": {
  5790. "type": "string",
  5791. "x-go-name": "Title"
  5792. },
  5793. "prerelease": {
  5794. "type": "boolean",
  5795. "x-go-name": "IsPrerelease"
  5796. },
  5797. "tag_name": {
  5798. "type": "string",
  5799. "x-go-name": "TagName"
  5800. },
  5801. "target_commitish": {
  5802. "type": "string",
  5803. "x-go-name": "Target"
  5804. }
  5805. },
  5806. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5807. },
  5808. "CreateRepoOption": {
  5809. "description": "CreateRepoOption options when creating repository",
  5810. "type": "object",
  5811. "required": [
  5812. "name"
  5813. ],
  5814. "properties": {
  5815. "auto_init": {
  5816. "description": "Whether the repository should be auto-intialized?",
  5817. "type": "boolean",
  5818. "x-go-name": "AutoInit"
  5819. },
  5820. "description": {
  5821. "description": "Description of the repository to create",
  5822. "type": "string",
  5823. "x-go-name": "Description"
  5824. },
  5825. "gitignores": {
  5826. "description": "Gitignores to use",
  5827. "type": "string",
  5828. "x-go-name": "Gitignores"
  5829. },
  5830. "license": {
  5831. "description": "License to use",
  5832. "type": "string",
  5833. "x-go-name": "License"
  5834. },
  5835. "name": {
  5836. "description": "Name of the repository to create",
  5837. "type": "string",
  5838. "uniqueItems": true,
  5839. "x-go-name": "Name"
  5840. },
  5841. "private": {
  5842. "description": "Whether the repository is private",
  5843. "type": "boolean",
  5844. "x-go-name": "Private"
  5845. },
  5846. "readme": {
  5847. "description": "Readme of the repository to create",
  5848. "type": "string",
  5849. "x-go-name": "Readme"
  5850. }
  5851. },
  5852. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5853. },
  5854. "CreateStatusOption": {
  5855. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  5856. "type": "object",
  5857. "properties": {
  5858. "context": {
  5859. "type": "string",
  5860. "x-go-name": "Context"
  5861. },
  5862. "description": {
  5863. "type": "string",
  5864. "x-go-name": "Description"
  5865. },
  5866. "state": {
  5867. "$ref": "#/definitions/StatusState"
  5868. },
  5869. "target_url": {
  5870. "type": "string",
  5871. "x-go-name": "TargetURL"
  5872. }
  5873. },
  5874. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5875. },
  5876. "CreateTeamOption": {
  5877. "description": "CreateTeamOption options for creating a team",
  5878. "type": "object",
  5879. "required": [
  5880. "name"
  5881. ],
  5882. "properties": {
  5883. "description": {
  5884. "type": "string",
  5885. "x-go-name": "Description"
  5886. },
  5887. "name": {
  5888. "type": "string",
  5889. "x-go-name": "Name"
  5890. },
  5891. "permission": {
  5892. "type": "string",
  5893. "enum": [
  5894. "read",
  5895. "write",
  5896. "admin"
  5897. ],
  5898. "x-go-name": "Permission"
  5899. }
  5900. },
  5901. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5902. },
  5903. "CreateUserOption": {
  5904. "description": "CreateUserOption create user options",
  5905. "type": "object",
  5906. "required": [
  5907. "username",
  5908. "email",
  5909. "password"
  5910. ],
  5911. "properties": {
  5912. "email": {
  5913. "type": "string",
  5914. "format": "email",
  5915. "x-go-name": "Email"
  5916. },
  5917. "full_name": {
  5918. "type": "string",
  5919. "x-go-name": "FullName"
  5920. },
  5921. "login_name": {
  5922. "type": "string",
  5923. "x-go-name": "LoginName"
  5924. },
  5925. "password": {
  5926. "type": "string",
  5927. "x-go-name": "Password"
  5928. },
  5929. "send_notify": {
  5930. "type": "boolean",
  5931. "x-go-name": "SendNotify"
  5932. },
  5933. "source_id": {
  5934. "type": "integer",
  5935. "format": "int64",
  5936. "x-go-name": "SourceID"
  5937. },
  5938. "username": {
  5939. "type": "string",
  5940. "x-go-name": "Username"
  5941. }
  5942. },
  5943. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5944. },
  5945. "DeleteEmailOption": {
  5946. "description": "DeleteEmailOption options when deleting email addresses",
  5947. "type": "object",
  5948. "properties": {
  5949. "emails": {
  5950. "description": "email addresses to delete",
  5951. "type": "array",
  5952. "items": {
  5953. "type": "string"
  5954. },
  5955. "x-go-name": "Emails"
  5956. }
  5957. },
  5958. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5959. },
  5960. "DeployKey": {
  5961. "description": "DeployKey a deploy key",
  5962. "type": "object",
  5963. "properties": {
  5964. "created_at": {
  5965. "type": "string",
  5966. "format": "date-time",
  5967. "x-go-name": "Created"
  5968. },
  5969. "id": {
  5970. "type": "integer",
  5971. "format": "int64",
  5972. "x-go-name": "ID"
  5973. },
  5974. "key": {
  5975. "type": "string",
  5976. "x-go-name": "Key"
  5977. },
  5978. "read_only": {
  5979. "type": "boolean",
  5980. "x-go-name": "ReadOnly"
  5981. },
  5982. "title": {
  5983. "type": "string",
  5984. "x-go-name": "Title"
  5985. },
  5986. "url": {
  5987. "type": "string",
  5988. "x-go-name": "URL"
  5989. }
  5990. },
  5991. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5992. },
  5993. "EditAttachmentOptions": {
  5994. "description": "EditAttachmentOptions options for editing attachments",
  5995. "type": "object",
  5996. "properties": {
  5997. "name": {
  5998. "type": "string",
  5999. "x-go-name": "Name"
  6000. }
  6001. },
  6002. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6003. },
  6004. "EditHookOption": {
  6005. "description": "EditHookOption options when modify one hook",
  6006. "type": "object",
  6007. "properties": {
  6008. "active": {
  6009. "type": "boolean",
  6010. "x-go-name": "Active"
  6011. },
  6012. "config": {
  6013. "type": "object",
  6014. "additionalProperties": {
  6015. "type": "string"
  6016. },
  6017. "x-go-name": "Config"
  6018. },
  6019. "events": {
  6020. "type": "array",
  6021. "items": {
  6022. "type": "string"
  6023. },
  6024. "x-go-name": "Events"
  6025. }
  6026. },
  6027. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6028. },
  6029. "EditIssueCommentOption": {
  6030. "description": "EditIssueCommentOption options for editing a comment",
  6031. "type": "object",
  6032. "required": [
  6033. "body"
  6034. ],
  6035. "properties": {
  6036. "body": {
  6037. "type": "string",
  6038. "x-go-name": "Body"
  6039. }
  6040. },
  6041. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6042. },
  6043. "EditIssueOption": {
  6044. "description": "EditIssueOption options for editing an issue",
  6045. "type": "object",
  6046. "properties": {
  6047. "assignee": {
  6048. "type": "string",
  6049. "x-go-name": "Assignee"
  6050. },
  6051. "assignees": {
  6052. "type": "array",
  6053. "items": {
  6054. "type": "string"
  6055. },
  6056. "x-go-name": "Assignees"
  6057. },
  6058. "body": {
  6059. "type": "string",
  6060. "x-go-name": "Body"
  6061. },
  6062. "due_date": {
  6063. "type": "string",
  6064. "format": "date-time",
  6065. "x-go-name": "Deadline"
  6066. },
  6067. "milestone": {
  6068. "type": "integer",
  6069. "format": "int64",
  6070. "x-go-name": "Milestone"
  6071. },
  6072. "state": {
  6073. "type": "string",
  6074. "x-go-name": "State"
  6075. },
  6076. "title": {
  6077. "type": "string",
  6078. "x-go-name": "Title"
  6079. }
  6080. },
  6081. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6082. },
  6083. "EditLabelOption": {
  6084. "description": "EditLabelOption options for editing a label",
  6085. "type": "object",
  6086. "properties": {
  6087. "color": {
  6088. "type": "string",
  6089. "x-go-name": "Color"
  6090. },
  6091. "name": {
  6092. "type": "string",
  6093. "x-go-name": "Name"
  6094. }
  6095. },
  6096. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6097. },
  6098. "EditMilestoneOption": {
  6099. "description": "EditMilestoneOption options for editing a milestone",
  6100. "type": "object",
  6101. "properties": {
  6102. "description": {
  6103. "type": "string",
  6104. "x-go-name": "Description"
  6105. },
  6106. "due_on": {
  6107. "type": "string",
  6108. "format": "date-time",
  6109. "x-go-name": "Deadline"
  6110. },
  6111. "state": {
  6112. "type": "string",
  6113. "x-go-name": "State"
  6114. },
  6115. "title": {
  6116. "type": "string",
  6117. "x-go-name": "Title"
  6118. }
  6119. },
  6120. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6121. },
  6122. "EditOrgOption": {
  6123. "description": "EditOrgOption options for editing an organization",
  6124. "type": "object",
  6125. "properties": {
  6126. "description": {
  6127. "type": "string",
  6128. "x-go-name": "Description"
  6129. },
  6130. "full_name": {
  6131. "type": "string",
  6132. "x-go-name": "FullName"
  6133. },
  6134. "location": {
  6135. "type": "string",
  6136. "x-go-name": "Location"
  6137. },
  6138. "website": {
  6139. "type": "string",
  6140. "x-go-name": "Website"
  6141. }
  6142. },
  6143. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6144. },
  6145. "EditPullRequestOption": {
  6146. "description": "EditPullRequestOption options when modify pull request",
  6147. "type": "object",
  6148. "properties": {
  6149. "assignee": {
  6150. "type": "string",
  6151. "x-go-name": "Assignee"
  6152. },
  6153. "assignees": {
  6154. "type": "array",
  6155. "items": {
  6156. "type": "string"
  6157. },
  6158. "x-go-name": "Assignees"
  6159. },
  6160. "body": {
  6161. "type": "string",
  6162. "x-go-name": "Body"
  6163. },
  6164. "due_date": {
  6165. "type": "string",
  6166. "format": "date-time",
  6167. "x-go-name": "Deadline"
  6168. },
  6169. "labels": {
  6170. "type": "array",
  6171. "items": {
  6172. "type": "integer",
  6173. "format": "int64"
  6174. },
  6175. "x-go-name": "Labels"
  6176. },
  6177. "milestone": {
  6178. "type": "integer",
  6179. "format": "int64",
  6180. "x-go-name": "Milestone"
  6181. },
  6182. "state": {
  6183. "type": "string",
  6184. "x-go-name": "State"
  6185. },
  6186. "title": {
  6187. "type": "string",
  6188. "x-go-name": "Title"
  6189. }
  6190. },
  6191. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6192. },
  6193. "EditReleaseOption": {
  6194. "description": "EditReleaseOption options when editing a release",
  6195. "type": "object",
  6196. "properties": {
  6197. "body": {
  6198. "type": "string",
  6199. "x-go-name": "Note"
  6200. },
  6201. "draft": {
  6202. "type": "boolean",
  6203. "x-go-name": "IsDraft"
  6204. },
  6205. "name": {
  6206. "type": "string",
  6207. "x-go-name": "Title"
  6208. },
  6209. "prerelease": {
  6210. "type": "boolean",
  6211. "x-go-name": "IsPrerelease"
  6212. },
  6213. "tag_name": {
  6214. "type": "string",
  6215. "x-go-name": "TagName"
  6216. },
  6217. "target_commitish": {
  6218. "type": "string",
  6219. "x-go-name": "Target"
  6220. }
  6221. },
  6222. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6223. },
  6224. "EditTeamOption": {
  6225. "description": "EditTeamOption options for editing a team",
  6226. "type": "object",
  6227. "required": [
  6228. "name"
  6229. ],
  6230. "properties": {
  6231. "description": {
  6232. "type": "string",
  6233. "x-go-name": "Description"
  6234. },
  6235. "name": {
  6236. "type": "string",
  6237. "x-go-name": "Name"
  6238. },
  6239. "permission": {
  6240. "type": "string",
  6241. "enum": [
  6242. "read",
  6243. "write",
  6244. "admin"
  6245. ],
  6246. "x-go-name": "Permission"
  6247. }
  6248. },
  6249. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6250. },
  6251. "EditUserOption": {
  6252. "description": "EditUserOption edit user options",
  6253. "type": "object",
  6254. "required": [
  6255. "email"
  6256. ],
  6257. "properties": {
  6258. "active": {
  6259. "type": "boolean",
  6260. "x-go-name": "Active"
  6261. },
  6262. "admin": {
  6263. "type": "boolean",
  6264. "x-go-name": "Admin"
  6265. },
  6266. "allow_git_hook": {
  6267. "type": "boolean",
  6268. "x-go-name": "AllowGitHook"
  6269. },
  6270. "allow_import_local": {
  6271. "type": "boolean",
  6272. "x-go-name": "AllowImportLocal"
  6273. },
  6274. "email": {
  6275. "type": "string",
  6276. "format": "email",
  6277. "x-go-name": "Email"
  6278. },
  6279. "full_name": {
  6280. "type": "string",
  6281. "x-go-name": "FullName"
  6282. },
  6283. "location": {
  6284. "type": "string",
  6285. "x-go-name": "Location"
  6286. },
  6287. "login_name": {
  6288. "type": "string",
  6289. "x-go-name": "LoginName"
  6290. },
  6291. "max_repo_creation": {
  6292. "type": "integer",
  6293. "format": "int64",
  6294. "x-go-name": "MaxRepoCreation"
  6295. },
  6296. "password": {
  6297. "type": "string",
  6298. "x-go-name": "Password"
  6299. },
  6300. "source_id": {
  6301. "type": "integer",
  6302. "format": "int64",
  6303. "x-go-name": "SourceID"
  6304. },
  6305. "website": {
  6306. "type": "string",
  6307. "x-go-name": "Website"
  6308. }
  6309. },
  6310. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6311. },
  6312. "Email": {
  6313. "description": "Email an email address belonging to a user",
  6314. "type": "object",
  6315. "properties": {
  6316. "email": {
  6317. "type": "string",
  6318. "format": "email",
  6319. "x-go-name": "Email"
  6320. },
  6321. "primary": {
  6322. "type": "boolean",
  6323. "x-go-name": "Primary"
  6324. },
  6325. "verified": {
  6326. "type": "boolean",
  6327. "x-go-name": "Verified"
  6328. }
  6329. },
  6330. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6331. },
  6332. "GPGKey": {
  6333. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  6334. "type": "object",
  6335. "properties": {
  6336. "can_certify": {
  6337. "type": "boolean",
  6338. "x-go-name": "CanCertify"
  6339. },
  6340. "can_encrypt_comms": {
  6341. "type": "boolean",
  6342. "x-go-name": "CanEncryptComms"
  6343. },
  6344. "can_encrypt_storage": {
  6345. "type": "boolean",
  6346. "x-go-name": "CanEncryptStorage"
  6347. },
  6348. "can_sign": {
  6349. "type": "boolean",
  6350. "x-go-name": "CanSign"
  6351. },
  6352. "created_at": {
  6353. "type": "string",
  6354. "format": "date-time",
  6355. "x-go-name": "Created"
  6356. },
  6357. "emails": {
  6358. "type": "array",
  6359. "items": {
  6360. "$ref": "#/definitions/GPGKeyEmail"
  6361. },
  6362. "x-go-name": "Emails"
  6363. },
  6364. "expires_at": {
  6365. "type": "string",
  6366. "format": "date-time",
  6367. "x-go-name": "Expires"
  6368. },
  6369. "id": {
  6370. "type": "integer",
  6371. "format": "int64",
  6372. "x-go-name": "ID"
  6373. },
  6374. "key_id": {
  6375. "type": "string",
  6376. "x-go-name": "KeyID"
  6377. },
  6378. "primary_key_id": {
  6379. "type": "string",
  6380. "x-go-name": "PrimaryKeyID"
  6381. },
  6382. "public_key": {
  6383. "type": "string",
  6384. "x-go-name": "PublicKey"
  6385. },
  6386. "subkeys": {
  6387. "type": "array",
  6388. "items": {
  6389. "$ref": "#/definitions/GPGKey"
  6390. },
  6391. "x-go-name": "SubsKey"
  6392. }
  6393. },
  6394. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6395. },
  6396. "GPGKeyEmail": {
  6397. "description": "GPGKeyEmail an email attached to a GPGKey",
  6398. "type": "object",
  6399. "properties": {
  6400. "email": {
  6401. "type": "string",
  6402. "x-go-name": "Email"
  6403. },
  6404. "verified": {
  6405. "type": "boolean",
  6406. "x-go-name": "Verified"
  6407. }
  6408. },
  6409. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6410. },
  6411. "Issue": {
  6412. "description": "Issue represents an issue in a repository",
  6413. "type": "object",
  6414. "properties": {
  6415. "assignee": {
  6416. "$ref": "#/definitions/User"
  6417. },
  6418. "assignees": {
  6419. "type": "array",
  6420. "items": {
  6421. "$ref": "#/definitions/User"
  6422. },
  6423. "x-go-name": "Assignees"
  6424. },
  6425. "body": {
  6426. "type": "string",
  6427. "x-go-name": "Body"
  6428. },
  6429. "closed_at": {
  6430. "type": "string",
  6431. "format": "date-time",
  6432. "x-go-name": "Closed"
  6433. },
  6434. "comments": {
  6435. "type": "integer",
  6436. "format": "int64",
  6437. "x-go-name": "Comments"
  6438. },
  6439. "created_at": {
  6440. "type": "string",
  6441. "format": "date-time",
  6442. "x-go-name": "Created"
  6443. },
  6444. "due_date": {
  6445. "type": "string",
  6446. "format": "date-time",
  6447. "x-go-name": "Deadline"
  6448. },
  6449. "id": {
  6450. "type": "integer",
  6451. "format": "int64",
  6452. "x-go-name": "ID"
  6453. },
  6454. "labels": {
  6455. "type": "array",
  6456. "items": {
  6457. "$ref": "#/definitions/Label"
  6458. },
  6459. "x-go-name": "Labels"
  6460. },
  6461. "milestone": {
  6462. "$ref": "#/definitions/Milestone"
  6463. },
  6464. "number": {
  6465. "type": "integer",
  6466. "format": "int64",
  6467. "x-go-name": "Index"
  6468. },
  6469. "pull_request": {
  6470. "$ref": "#/definitions/PullRequestMeta"
  6471. },
  6472. "state": {
  6473. "$ref": "#/definitions/StateType"
  6474. },
  6475. "title": {
  6476. "type": "string",
  6477. "x-go-name": "Title"
  6478. },
  6479. "updated_at": {
  6480. "type": "string",
  6481. "format": "date-time",
  6482. "x-go-name": "Updated"
  6483. },
  6484. "url": {
  6485. "type": "string",
  6486. "x-go-name": "URL"
  6487. },
  6488. "user": {
  6489. "$ref": "#/definitions/User"
  6490. }
  6491. },
  6492. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6493. },
  6494. "IssueLabelsOption": {
  6495. "description": "IssueLabelsOption a collection of labels",
  6496. "type": "object",
  6497. "properties": {
  6498. "labels": {
  6499. "description": "list of label IDs",
  6500. "type": "array",
  6501. "items": {
  6502. "type": "integer",
  6503. "format": "int64"
  6504. },
  6505. "x-go-name": "Labels"
  6506. }
  6507. },
  6508. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6509. },
  6510. "Label": {
  6511. "description": "Label a label to an issue or a pr",
  6512. "type": "object",
  6513. "properties": {
  6514. "color": {
  6515. "type": "string",
  6516. "x-go-name": "Color",
  6517. "example": "00aabb"
  6518. },
  6519. "id": {
  6520. "type": "integer",
  6521. "format": "int64",
  6522. "x-go-name": "ID"
  6523. },
  6524. "name": {
  6525. "type": "string",
  6526. "x-go-name": "Name"
  6527. },
  6528. "url": {
  6529. "type": "string",
  6530. "x-go-name": "URL"
  6531. }
  6532. },
  6533. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6534. },
  6535. "MarkdownOption": {
  6536. "description": "MarkdownOption markdown options",
  6537. "type": "object",
  6538. "properties": {
  6539. "Context": {
  6540. "description": "Context to render\n\nin: body",
  6541. "type": "string"
  6542. },
  6543. "Mode": {
  6544. "description": "Mode to render\n\nin: body",
  6545. "type": "string"
  6546. },
  6547. "Text": {
  6548. "description": "Text markdown to render\n\nin: body",
  6549. "type": "string"
  6550. },
  6551. "Wiki": {
  6552. "description": "Is it a wiki page ?\n\nin: body",
  6553. "type": "boolean"
  6554. }
  6555. },
  6556. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6557. },
  6558. "MigrateRepoForm": {
  6559. "description": "MigrateRepoForm form for migrating repository",
  6560. "type": "object",
  6561. "required": [
  6562. "clone_addr",
  6563. "uid",
  6564. "repo_name"
  6565. ],
  6566. "properties": {
  6567. "auth_password": {
  6568. "type": "string",
  6569. "x-go-name": "AuthPassword"
  6570. },
  6571. "auth_username": {
  6572. "type": "string",
  6573. "x-go-name": "AuthUsername"
  6574. },
  6575. "clone_addr": {
  6576. "type": "string",
  6577. "x-go-name": "CloneAddr"
  6578. },
  6579. "description": {
  6580. "type": "string",
  6581. "x-go-name": "Description"
  6582. },
  6583. "mirror": {
  6584. "type": "boolean",
  6585. "x-go-name": "Mirror"
  6586. },
  6587. "private": {
  6588. "type": "boolean",
  6589. "x-go-name": "Private"
  6590. },
  6591. "repo_name": {
  6592. "type": "string",
  6593. "x-go-name": "RepoName"
  6594. },
  6595. "uid": {
  6596. "type": "integer",
  6597. "format": "int64",
  6598. "x-go-name": "UID"
  6599. }
  6600. },
  6601. "x-go-package": "code.gitea.io/gitea/modules/auth"
  6602. },
  6603. "Milestone": {
  6604. "description": "Milestone milestone is a collection of issues on one repository",
  6605. "type": "object",
  6606. "properties": {
  6607. "closed_at": {
  6608. "type": "string",
  6609. "format": "date-time",
  6610. "x-go-name": "Closed"
  6611. },
  6612. "closed_issues": {
  6613. "type": "integer",
  6614. "format": "int64",
  6615. "x-go-name": "ClosedIssues"
  6616. },
  6617. "description": {
  6618. "type": "string",
  6619. "x-go-name": "Description"
  6620. },
  6621. "due_on": {
  6622. "type": "string",
  6623. "format": "date-time",
  6624. "x-go-name": "Deadline"
  6625. },
  6626. "id": {
  6627. "type": "integer",
  6628. "format": "int64",
  6629. "x-go-name": "ID"
  6630. },
  6631. "open_issues": {
  6632. "type": "integer",
  6633. "format": "int64",
  6634. "x-go-name": "OpenIssues"
  6635. },
  6636. "state": {
  6637. "$ref": "#/definitions/StateType"
  6638. },
  6639. "title": {
  6640. "type": "string",
  6641. "x-go-name": "Title"
  6642. }
  6643. },
  6644. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6645. },
  6646. "Organization": {
  6647. "description": "Organization represents an organization",
  6648. "type": "object",
  6649. "properties": {
  6650. "avatar_url": {
  6651. "type": "string",
  6652. "x-go-name": "AvatarURL"
  6653. },
  6654. "description": {
  6655. "type": "string",
  6656. "x-go-name": "Description"
  6657. },
  6658. "full_name": {
  6659. "type": "string",
  6660. "x-go-name": "FullName"
  6661. },
  6662. "id": {
  6663. "type": "integer",
  6664. "format": "int64",
  6665. "x-go-name": "ID"
  6666. },
  6667. "location": {
  6668. "type": "string",
  6669. "x-go-name": "Location"
  6670. },
  6671. "username": {
  6672. "type": "string",
  6673. "x-go-name": "UserName"
  6674. },
  6675. "website": {
  6676. "type": "string",
  6677. "x-go-name": "Website"
  6678. }
  6679. },
  6680. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6681. },
  6682. "PRBranchInfo": {
  6683. "description": "PRBranchInfo information about a branch",
  6684. "type": "object",
  6685. "properties": {
  6686. "label": {
  6687. "type": "string",
  6688. "x-go-name": "Name"
  6689. },
  6690. "ref": {
  6691. "type": "string",
  6692. "x-go-name": "Ref"
  6693. },
  6694. "repo": {
  6695. "$ref": "#/definitions/Repository"
  6696. },
  6697. "repo_id": {
  6698. "type": "integer",
  6699. "format": "int64",
  6700. "x-go-name": "RepoID"
  6701. },
  6702. "sha": {
  6703. "type": "string",
  6704. "x-go-name": "Sha"
  6705. }
  6706. },
  6707. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6708. },
  6709. "PayloadCommit": {
  6710. "description": "PayloadCommit represents a commit",
  6711. "type": "object",
  6712. "properties": {
  6713. "author": {
  6714. "$ref": "#/definitions/PayloadUser"
  6715. },
  6716. "committer": {
  6717. "$ref": "#/definitions/PayloadUser"
  6718. },
  6719. "id": {
  6720. "description": "sha1 hash of the commit",
  6721. "type": "string",
  6722. "x-go-name": "ID"
  6723. },
  6724. "message": {
  6725. "type": "string",
  6726. "x-go-name": "Message"
  6727. },
  6728. "timestamp": {
  6729. "type": "string",
  6730. "format": "date-time",
  6731. "x-go-name": "Timestamp"
  6732. },
  6733. "url": {
  6734. "type": "string",
  6735. "x-go-name": "URL"
  6736. },
  6737. "verification": {
  6738. "$ref": "#/definitions/PayloadCommitVerification"
  6739. }
  6740. },
  6741. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6742. },
  6743. "PayloadCommitVerification": {
  6744. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  6745. "type": "object",
  6746. "properties": {
  6747. "payload": {
  6748. "type": "string",
  6749. "x-go-name": "Payload"
  6750. },
  6751. "reason": {
  6752. "type": "string",
  6753. "x-go-name": "Reason"
  6754. },
  6755. "signature": {
  6756. "type": "string",
  6757. "x-go-name": "Signature"
  6758. },
  6759. "verified": {
  6760. "type": "boolean",
  6761. "x-go-name": "Verified"
  6762. }
  6763. },
  6764. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6765. },
  6766. "PayloadUser": {
  6767. "description": "PayloadUser represents the author or committer of a commit",
  6768. "type": "object",
  6769. "properties": {
  6770. "email": {
  6771. "type": "string",
  6772. "format": "email",
  6773. "x-go-name": "Email"
  6774. },
  6775. "name": {
  6776. "description": "Full name of the commit author",
  6777. "type": "string",
  6778. "x-go-name": "Name"
  6779. },
  6780. "username": {
  6781. "type": "string",
  6782. "x-go-name": "UserName"
  6783. }
  6784. },
  6785. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6786. },
  6787. "Permission": {
  6788. "description": "Permission represents a set of permissions",
  6789. "type": "object",
  6790. "properties": {
  6791. "admin": {
  6792. "type": "boolean",
  6793. "x-go-name": "Admin"
  6794. },
  6795. "pull": {
  6796. "type": "boolean",
  6797. "x-go-name": "Pull"
  6798. },
  6799. "push": {
  6800. "type": "boolean",
  6801. "x-go-name": "Push"
  6802. }
  6803. },
  6804. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6805. },
  6806. "PublicKey": {
  6807. "description": "PublicKey publickey is a user key to push code to repository",
  6808. "type": "object",
  6809. "properties": {
  6810. "created_at": {
  6811. "type": "string",
  6812. "format": "date-time",
  6813. "x-go-name": "Created"
  6814. },
  6815. "fingerprint": {
  6816. "type": "string",
  6817. "x-go-name": "Fingerprint"
  6818. },
  6819. "id": {
  6820. "type": "integer",
  6821. "format": "int64",
  6822. "x-go-name": "ID"
  6823. },
  6824. "key": {
  6825. "type": "string",
  6826. "x-go-name": "Key"
  6827. },
  6828. "title": {
  6829. "type": "string",
  6830. "x-go-name": "Title"
  6831. },
  6832. "url": {
  6833. "type": "string",
  6834. "x-go-name": "URL"
  6835. }
  6836. },
  6837. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6838. },
  6839. "PullRequest": {
  6840. "description": "PullRequest represents a pull request",
  6841. "type": "object",
  6842. "properties": {
  6843. "assignee": {
  6844. "$ref": "#/definitions/User"
  6845. },
  6846. "assignees": {
  6847. "type": "array",
  6848. "items": {
  6849. "$ref": "#/definitions/User"
  6850. },
  6851. "x-go-name": "Assignees"
  6852. },
  6853. "base": {
  6854. "$ref": "#/definitions/PRBranchInfo"
  6855. },
  6856. "body": {
  6857. "type": "string",
  6858. "x-go-name": "Body"
  6859. },
  6860. "closed_at": {
  6861. "type": "string",
  6862. "format": "date-time",
  6863. "x-go-name": "Closed"
  6864. },
  6865. "comments": {
  6866. "type": "integer",
  6867. "format": "int64",
  6868. "x-go-name": "Comments"
  6869. },
  6870. "created_at": {
  6871. "type": "string",
  6872. "format": "date-time",
  6873. "x-go-name": "Created"
  6874. },
  6875. "diff_url": {
  6876. "type": "string",
  6877. "x-go-name": "DiffURL"
  6878. },
  6879. "due_date": {
  6880. "type": "string",
  6881. "format": "date-time",
  6882. "x-go-name": "Deadline"
  6883. },
  6884. "head": {
  6885. "$ref": "#/definitions/PRBranchInfo"
  6886. },
  6887. "html_url": {
  6888. "type": "string",
  6889. "x-go-name": "HTMLURL"
  6890. },
  6891. "id": {
  6892. "type": "integer",
  6893. "format": "int64",
  6894. "x-go-name": "ID"
  6895. },
  6896. "labels": {
  6897. "type": "array",
  6898. "items": {
  6899. "$ref": "#/definitions/Label"
  6900. },
  6901. "x-go-name": "Labels"
  6902. },
  6903. "merge_base": {
  6904. "type": "string",
  6905. "x-go-name": "MergeBase"
  6906. },
  6907. "merge_commit_sha": {
  6908. "type": "string",
  6909. "x-go-name": "MergedCommitID"
  6910. },
  6911. "mergeable": {
  6912. "type": "boolean",
  6913. "x-go-name": "Mergeable"
  6914. },
  6915. "merged": {
  6916. "type": "boolean",
  6917. "x-go-name": "HasMerged"
  6918. },
  6919. "merged_at": {
  6920. "type": "string",
  6921. "format": "date-time",
  6922. "x-go-name": "Merged"
  6923. },
  6924. "merged_by": {
  6925. "$ref": "#/definitions/User"
  6926. },
  6927. "milestone": {
  6928. "$ref": "#/definitions/Milestone"
  6929. },
  6930. "number": {
  6931. "type": "integer",
  6932. "format": "int64",
  6933. "x-go-name": "Index"
  6934. },
  6935. "patch_url": {
  6936. "type": "string",
  6937. "x-go-name": "PatchURL"
  6938. },
  6939. "state": {
  6940. "$ref": "#/definitions/StateType"
  6941. },
  6942. "title": {
  6943. "type": "string",
  6944. "x-go-name": "Title"
  6945. },
  6946. "updated_at": {
  6947. "type": "string",
  6948. "format": "date-time",
  6949. "x-go-name": "Updated"
  6950. },
  6951. "url": {
  6952. "type": "string",
  6953. "x-go-name": "URL"
  6954. },
  6955. "user": {
  6956. "$ref": "#/definitions/User"
  6957. }
  6958. },
  6959. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6960. },
  6961. "PullRequestMeta": {
  6962. "description": "PullRequestMeta PR info if an issue is a PR",
  6963. "type": "object",
  6964. "properties": {
  6965. "merged": {
  6966. "type": "boolean",
  6967. "x-go-name": "HasMerged"
  6968. },
  6969. "merged_at": {
  6970. "type": "string",
  6971. "format": "date-time",
  6972. "x-go-name": "Merged"
  6973. }
  6974. },
  6975. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6976. },
  6977. "Release": {
  6978. "description": "Release represents a repository release",
  6979. "type": "object",
  6980. "properties": {
  6981. "assets": {
  6982. "type": "array",
  6983. "items": {
  6984. "$ref": "#/definitions/Attachment"
  6985. },
  6986. "x-go-name": "Attachments"
  6987. },
  6988. "author": {
  6989. "$ref": "#/definitions/User"
  6990. },
  6991. "body": {
  6992. "type": "string",
  6993. "x-go-name": "Note"
  6994. },
  6995. "created_at": {
  6996. "type": "string",
  6997. "format": "date-time",
  6998. "x-go-name": "CreatedAt"
  6999. },
  7000. "draft": {
  7001. "type": "boolean",
  7002. "x-go-name": "IsDraft"
  7003. },
  7004. "id": {
  7005. "type": "integer",
  7006. "format": "int64",
  7007. "x-go-name": "ID"
  7008. },
  7009. "name": {
  7010. "type": "string",
  7011. "x-go-name": "Title"
  7012. },
  7013. "prerelease": {
  7014. "type": "boolean",
  7015. "x-go-name": "IsPrerelease"
  7016. },
  7017. "published_at": {
  7018. "type": "string",
  7019. "format": "date-time",
  7020. "x-go-name": "PublishedAt"
  7021. },
  7022. "tag_name": {
  7023. "type": "string",
  7024. "x-go-name": "TagName"
  7025. },
  7026. "tarball_url": {
  7027. "type": "string",
  7028. "x-go-name": "TarURL"
  7029. },
  7030. "target_commitish": {
  7031. "type": "string",
  7032. "x-go-name": "Target"
  7033. },
  7034. "url": {
  7035. "type": "string",
  7036. "x-go-name": "URL"
  7037. },
  7038. "zipball_url": {
  7039. "type": "string",
  7040. "x-go-name": "ZipURL"
  7041. }
  7042. },
  7043. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7044. },
  7045. "Repository": {
  7046. "description": "Repository represents a repository",
  7047. "type": "object",
  7048. "properties": {
  7049. "clone_url": {
  7050. "type": "string",
  7051. "x-go-name": "CloneURL"
  7052. },
  7053. "created_at": {
  7054. "type": "string",
  7055. "format": "date-time",
  7056. "x-go-name": "Created"
  7057. },
  7058. "default_branch": {
  7059. "type": "string",
  7060. "x-go-name": "DefaultBranch"
  7061. },
  7062. "description": {
  7063. "type": "string",
  7064. "x-go-name": "Description"
  7065. },
  7066. "empty": {
  7067. "type": "boolean",
  7068. "x-go-name": "Empty"
  7069. },
  7070. "fork": {
  7071. "type": "boolean",
  7072. "x-go-name": "Fork"
  7073. },
  7074. "forks_count": {
  7075. "type": "integer",
  7076. "format": "int64",
  7077. "x-go-name": "Forks"
  7078. },
  7079. "full_name": {
  7080. "type": "string",
  7081. "x-go-name": "FullName"
  7082. },
  7083. "html_url": {
  7084. "type": "string",
  7085. "x-go-name": "HTMLURL"
  7086. },
  7087. "id": {
  7088. "type": "integer",
  7089. "format": "int64",
  7090. "x-go-name": "ID"
  7091. },
  7092. "mirror": {
  7093. "type": "boolean",
  7094. "x-go-name": "Mirror"
  7095. },
  7096. "name": {
  7097. "type": "string",
  7098. "x-go-name": "Name"
  7099. },
  7100. "open_issues_count": {
  7101. "type": "integer",
  7102. "format": "int64",
  7103. "x-go-name": "OpenIssues"
  7104. },
  7105. "owner": {
  7106. "$ref": "#/definitions/User"
  7107. },
  7108. "parent": {
  7109. "$ref": "#/definitions/Repository"
  7110. },
  7111. "permissions": {
  7112. "$ref": "#/definitions/Permission"
  7113. },
  7114. "private": {
  7115. "type": "boolean",
  7116. "x-go-name": "Private"
  7117. },
  7118. "size": {
  7119. "type": "integer",
  7120. "format": "int64",
  7121. "x-go-name": "Size"
  7122. },
  7123. "ssh_url": {
  7124. "type": "string",
  7125. "x-go-name": "SSHURL"
  7126. },
  7127. "stars_count": {
  7128. "type": "integer",
  7129. "format": "int64",
  7130. "x-go-name": "Stars"
  7131. },
  7132. "updated_at": {
  7133. "type": "string",
  7134. "format": "date-time",
  7135. "x-go-name": "Updated"
  7136. },
  7137. "watchers_count": {
  7138. "type": "integer",
  7139. "format": "int64",
  7140. "x-go-name": "Watchers"
  7141. },
  7142. "website": {
  7143. "type": "string",
  7144. "x-go-name": "Website"
  7145. }
  7146. },
  7147. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7148. },
  7149. "SearchResults": {
  7150. "description": "SearchResults results of a successful search",
  7151. "type": "object",
  7152. "properties": {
  7153. "data": {
  7154. "type": "array",
  7155. "items": {
  7156. "$ref": "#/definitions/Repository"
  7157. },
  7158. "x-go-name": "Data"
  7159. },
  7160. "ok": {
  7161. "type": "boolean",
  7162. "x-go-name": "OK"
  7163. }
  7164. },
  7165. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7166. },
  7167. "ServerVersion": {
  7168. "description": "ServerVersion wraps the version of the server",
  7169. "type": "object",
  7170. "properties": {
  7171. "version": {
  7172. "type": "string",
  7173. "x-go-name": "Version"
  7174. }
  7175. },
  7176. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7177. },
  7178. "StateType": {
  7179. "description": "StateType issue state type",
  7180. "type": "string",
  7181. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7182. },
  7183. "Status": {
  7184. "description": "Status holds a single Status of a single Commit",
  7185. "type": "object",
  7186. "properties": {
  7187. "context": {
  7188. "type": "string",
  7189. "x-go-name": "Context"
  7190. },
  7191. "created_at": {
  7192. "type": "string",
  7193. "format": "date-time",
  7194. "x-go-name": "Created"
  7195. },
  7196. "creator": {
  7197. "$ref": "#/definitions/User"
  7198. },
  7199. "description": {
  7200. "type": "string",
  7201. "x-go-name": "Description"
  7202. },
  7203. "id": {
  7204. "type": "integer",
  7205. "format": "int64",
  7206. "x-go-name": "ID"
  7207. },
  7208. "status": {
  7209. "$ref": "#/definitions/StatusState"
  7210. },
  7211. "target_url": {
  7212. "type": "string",
  7213. "x-go-name": "TargetURL"
  7214. },
  7215. "updated_at": {
  7216. "type": "string",
  7217. "format": "date-time",
  7218. "x-go-name": "Updated"
  7219. },
  7220. "url": {
  7221. "type": "string",
  7222. "x-go-name": "URL"
  7223. }
  7224. },
  7225. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7226. },
  7227. "StatusState": {
  7228. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  7229. "type": "string",
  7230. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7231. },
  7232. "Team": {
  7233. "description": "Team represents a team in an organization",
  7234. "type": "object",
  7235. "properties": {
  7236. "description": {
  7237. "type": "string",
  7238. "x-go-name": "Description"
  7239. },
  7240. "id": {
  7241. "type": "integer",
  7242. "format": "int64",
  7243. "x-go-name": "ID"
  7244. },
  7245. "name": {
  7246. "type": "string",
  7247. "x-go-name": "Name"
  7248. },
  7249. "permission": {
  7250. "type": "string",
  7251. "enum": [
  7252. "none",
  7253. "read",
  7254. "write",
  7255. "admin",
  7256. "owner"
  7257. ],
  7258. "x-go-name": "Permission"
  7259. }
  7260. },
  7261. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7262. },
  7263. "TrackedTime": {
  7264. "description": "TrackedTime worked time for an issue / pr",
  7265. "type": "object",
  7266. "properties": {
  7267. "created": {
  7268. "type": "string",
  7269. "format": "date-time",
  7270. "x-go-name": "Created"
  7271. },
  7272. "id": {
  7273. "type": "integer",
  7274. "format": "int64",
  7275. "x-go-name": "ID"
  7276. },
  7277. "issue_id": {
  7278. "type": "integer",
  7279. "format": "int64",
  7280. "x-go-name": "IssueID"
  7281. },
  7282. "time": {
  7283. "description": "Time in seconds",
  7284. "type": "integer",
  7285. "format": "int64",
  7286. "x-go-name": "Time"
  7287. },
  7288. "user_id": {
  7289. "type": "integer",
  7290. "format": "int64",
  7291. "x-go-name": "UserID"
  7292. }
  7293. },
  7294. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7295. },
  7296. "User": {
  7297. "description": "User represents a user",
  7298. "type": "object",
  7299. "properties": {
  7300. "avatar_url": {
  7301. "description": "URL to the user's avatar",
  7302. "type": "string",
  7303. "x-go-name": "AvatarURL"
  7304. },
  7305. "email": {
  7306. "type": "string",
  7307. "format": "email",
  7308. "x-go-name": "Email"
  7309. },
  7310. "full_name": {
  7311. "description": "the user's full name",
  7312. "type": "string",
  7313. "x-go-name": "FullName"
  7314. },
  7315. "id": {
  7316. "description": "the user's id",
  7317. "type": "integer",
  7318. "format": "int64",
  7319. "x-go-name": "ID"
  7320. },
  7321. "language": {
  7322. "description": "User locale",
  7323. "type": "string",
  7324. "x-go-name": "Language"
  7325. },
  7326. "login": {
  7327. "description": "the user's username",
  7328. "type": "string",
  7329. "x-go-name": "UserName"
  7330. }
  7331. },
  7332. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7333. },
  7334. "WatchInfo": {
  7335. "description": "WatchInfo represents an API watch status of one repository",
  7336. "type": "object",
  7337. "properties": {
  7338. "created_at": {
  7339. "type": "string",
  7340. "format": "date-time",
  7341. "x-go-name": "CreatedAt"
  7342. },
  7343. "ignored": {
  7344. "type": "boolean",
  7345. "x-go-name": "Ignored"
  7346. },
  7347. "reason": {
  7348. "type": "object",
  7349. "x-go-name": "Reason"
  7350. },
  7351. "repository_url": {
  7352. "type": "string",
  7353. "x-go-name": "RepositoryURL"
  7354. },
  7355. "subscribed": {
  7356. "type": "boolean",
  7357. "x-go-name": "Subscribed"
  7358. },
  7359. "url": {
  7360. "type": "string",
  7361. "x-go-name": "URL"
  7362. }
  7363. },
  7364. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  7365. }
  7366. },
  7367. "responses": {
  7368. "AccessToken": {
  7369. "description": "AccessToken represents a API access token.",
  7370. "headers": {
  7371. "name": {
  7372. "type": "string"
  7373. },
  7374. "sha1": {
  7375. "type": "string"
  7376. }
  7377. }
  7378. },
  7379. "AccessTokenList": {
  7380. "description": "AccessTokenList represents a list of API access token."
  7381. },
  7382. "Attachment": {
  7383. "schema": {
  7384. "$ref": "#/definitions/Attachment"
  7385. }
  7386. },
  7387. "AttachmentList": {
  7388. "schema": {
  7389. "type": "array",
  7390. "items": {
  7391. "$ref": "#/definitions/Attachment"
  7392. }
  7393. }
  7394. },
  7395. "Branch": {
  7396. "schema": {
  7397. "$ref": "#/definitions/Branch"
  7398. }
  7399. },
  7400. "BranchList": {
  7401. "schema": {
  7402. "type": "array",
  7403. "items": {
  7404. "$ref": "#/definitions/Branch"
  7405. }
  7406. }
  7407. },
  7408. "Comment": {
  7409. "schema": {
  7410. "$ref": "#/definitions/Comment"
  7411. }
  7412. },
  7413. "CommentList": {
  7414. "schema": {
  7415. "type": "array",
  7416. "items": {
  7417. "$ref": "#/definitions/Comment"
  7418. }
  7419. }
  7420. },
  7421. "DeployKey": {
  7422. "schema": {
  7423. "$ref": "#/definitions/DeployKey"
  7424. }
  7425. },
  7426. "DeployKeyList": {
  7427. "schema": {
  7428. "type": "array",
  7429. "items": {
  7430. "$ref": "#/definitions/DeployKey"
  7431. }
  7432. }
  7433. },
  7434. "EmailList": {
  7435. "schema": {
  7436. "type": "array",
  7437. "items": {
  7438. "$ref": "#/definitions/Email"
  7439. }
  7440. }
  7441. },
  7442. "GPGKey": {
  7443. "schema": {
  7444. "$ref": "#/definitions/GPGKey"
  7445. }
  7446. },
  7447. "GPGKeyList": {
  7448. "schema": {
  7449. "type": "array",
  7450. "items": {
  7451. "$ref": "#/definitions/GPGKey"
  7452. }
  7453. }
  7454. },
  7455. "Hook": {
  7456. "schema": {
  7457. "type": "array",
  7458. "items": {
  7459. "$ref": "#/definitions/Branch"
  7460. }
  7461. }
  7462. },
  7463. "HookList": {
  7464. "schema": {
  7465. "type": "array",
  7466. "items": {
  7467. "$ref": "#/definitions/Branch"
  7468. }
  7469. }
  7470. },
  7471. "Issue": {
  7472. "schema": {
  7473. "$ref": "#/definitions/Issue"
  7474. }
  7475. },
  7476. "IssueList": {
  7477. "schema": {
  7478. "type": "array",
  7479. "items": {
  7480. "$ref": "#/definitions/Issue"
  7481. }
  7482. }
  7483. },
  7484. "Label": {
  7485. "schema": {
  7486. "$ref": "#/definitions/Label"
  7487. }
  7488. },
  7489. "LabelList": {
  7490. "schema": {
  7491. "type": "array",
  7492. "items": {
  7493. "$ref": "#/definitions/Label"
  7494. }
  7495. }
  7496. },
  7497. "MarkdownRender": {
  7498. "description": "MarkdownRender is a rendered markdown document"
  7499. },
  7500. "Milestone": {
  7501. "schema": {
  7502. "$ref": "#/definitions/Milestone"
  7503. }
  7504. },
  7505. "MilestoneList": {
  7506. "schema": {
  7507. "type": "array",
  7508. "items": {
  7509. "$ref": "#/definitions/Milestone"
  7510. }
  7511. }
  7512. },
  7513. "Organization": {
  7514. "schema": {
  7515. "$ref": "#/definitions/Organization"
  7516. }
  7517. },
  7518. "OrganizationList": {
  7519. "schema": {
  7520. "type": "array",
  7521. "items": {
  7522. "$ref": "#/definitions/Organization"
  7523. }
  7524. }
  7525. },
  7526. "PublicKey": {
  7527. "schema": {
  7528. "$ref": "#/definitions/PublicKey"
  7529. }
  7530. },
  7531. "PublicKeyList": {
  7532. "schema": {
  7533. "type": "array",
  7534. "items": {
  7535. "$ref": "#/definitions/PublicKey"
  7536. }
  7537. }
  7538. },
  7539. "PullRequest": {
  7540. "schema": {
  7541. "$ref": "#/definitions/PullRequest"
  7542. }
  7543. },
  7544. "PullRequestList": {
  7545. "schema": {
  7546. "type": "array",
  7547. "items": {
  7548. "$ref": "#/definitions/PullRequest"
  7549. }
  7550. }
  7551. },
  7552. "Release": {
  7553. "schema": {
  7554. "$ref": "#/definitions/Release"
  7555. }
  7556. },
  7557. "ReleaseList": {
  7558. "schema": {
  7559. "type": "array",
  7560. "items": {
  7561. "$ref": "#/definitions/Release"
  7562. }
  7563. }
  7564. },
  7565. "Repository": {
  7566. "schema": {
  7567. "$ref": "#/definitions/Repository"
  7568. }
  7569. },
  7570. "RepositoryList": {
  7571. "schema": {
  7572. "type": "array",
  7573. "items": {
  7574. "$ref": "#/definitions/Repository"
  7575. }
  7576. }
  7577. },
  7578. "SearchResults": {
  7579. "schema": {
  7580. "$ref": "#/definitions/SearchResults"
  7581. },
  7582. "headers": {
  7583. "body": {}
  7584. }
  7585. },
  7586. "ServerVersion": {
  7587. "schema": {
  7588. "$ref": "#/definitions/ServerVersion"
  7589. }
  7590. },
  7591. "Status": {
  7592. "schema": {
  7593. "$ref": "#/definitions/Status"
  7594. }
  7595. },
  7596. "StatusList": {
  7597. "schema": {
  7598. "type": "array",
  7599. "items": {
  7600. "$ref": "#/definitions/Status"
  7601. }
  7602. }
  7603. },
  7604. "Team": {
  7605. "schema": {
  7606. "$ref": "#/definitions/Team"
  7607. }
  7608. },
  7609. "TeamList": {
  7610. "schema": {
  7611. "type": "array",
  7612. "items": {
  7613. "$ref": "#/definitions/Team"
  7614. }
  7615. }
  7616. },
  7617. "TrackedTime": {
  7618. "schema": {
  7619. "$ref": "#/definitions/TrackedTime"
  7620. }
  7621. },
  7622. "TrackedTimeList": {
  7623. "schema": {
  7624. "type": "array",
  7625. "items": {
  7626. "$ref": "#/definitions/TrackedTime"
  7627. }
  7628. }
  7629. },
  7630. "User": {
  7631. "schema": {
  7632. "$ref": "#/definitions/User"
  7633. }
  7634. },
  7635. "UserList": {
  7636. "schema": {
  7637. "type": "array",
  7638. "items": {
  7639. "$ref": "#/definitions/User"
  7640. }
  7641. }
  7642. },
  7643. "WatchInfo": {
  7644. "schema": {
  7645. "$ref": "#/definitions/WatchInfo"
  7646. }
  7647. },
  7648. "empty": {
  7649. "description": "APIEmpty is an empty response"
  7650. },
  7651. "error": {
  7652. "description": "APIError is error format response",
  7653. "headers": {
  7654. "message": {
  7655. "type": "string"
  7656. },
  7657. "url": {
  7658. "type": "string"
  7659. }
  7660. }
  7661. },
  7662. "forbidden": {
  7663. "description": "APIForbiddenError is a forbidden error response",
  7664. "headers": {
  7665. "message": {
  7666. "type": "string"
  7667. },
  7668. "url": {
  7669. "type": "string"
  7670. }
  7671. }
  7672. },
  7673. "notFound": {
  7674. "description": "APINotFound is a not found empty response"
  7675. },
  7676. "parameterBodies": {
  7677. "schema": {
  7678. "$ref": "#/definitions/EditAttachmentOptions"
  7679. },
  7680. "headers": {
  7681. "AddCollaboratorOption": {},
  7682. "AddTimeOption": {},
  7683. "CreateEmailOption": {},
  7684. "CreateForkOption": {},
  7685. "CreateHookOption": {},
  7686. "CreateIssueCommentOption": {},
  7687. "CreateIssueOption": {},
  7688. "CreateKeyOption": {},
  7689. "CreateLabelOption": {},
  7690. "CreateMilestoneOption": {},
  7691. "CreateOrgOption": {},
  7692. "CreatePullRequestOption": {},
  7693. "CreateReleaseOption": {},
  7694. "CreateRepoOption": {},
  7695. "CreateStatusOption": {},
  7696. "CreateTeamOption": {},
  7697. "CreateUserOption": {},
  7698. "DeleteEmailOption": {},
  7699. "EditAttachmentOptions": {},
  7700. "EditHookOption": {},
  7701. "EditIssueCommentOption": {},
  7702. "EditIssueOption": {},
  7703. "EditLabelOption": {},
  7704. "EditMilestoneOption": {},
  7705. "EditOrgOption": {},
  7706. "EditPullRequestOption": {},
  7707. "EditReleaseOption": {},
  7708. "EditTeamOption": {},
  7709. "EditUserOption": {},
  7710. "IssueLabelsOption": {},
  7711. "MarkdownOption": {},
  7712. "MigrateRepoForm": {}
  7713. }
  7714. },
  7715. "redirect": {
  7716. "description": "APIRedirect is a redirect response"
  7717. },
  7718. "validationError": {
  7719. "description": "APIValidationError is error format response related to input validation",
  7720. "headers": {
  7721. "message": {
  7722. "type": "string"
  7723. },
  7724. "url": {
  7725. "type": "string"
  7726. }
  7727. }
  7728. }
  7729. },
  7730. "securityDefinitions": {
  7731. "AccessToken": {
  7732. "type": "apiKey",
  7733. "name": "access_token",
  7734. "in": "query"
  7735. },
  7736. "AuthorizationHeaderToken": {
  7737. "type": "apiKey",
  7738. "name": "Authorization",
  7739. "in": "header"
  7740. },
  7741. "BasicAuth": {
  7742. "type": "basic"
  7743. },
  7744. "Token": {
  7745. "type": "apiKey",
  7746. "name": "token",
  7747. "in": "query"
  7748. }
  7749. },
  7750. "security": [
  7751. {
  7752. "BasicAuth": [
  7753. "[]"
  7754. ]
  7755. },
  7756. {
  7757. "Token": [
  7758. "[]"
  7759. ]
  7760. },
  7761. {
  7762. "AccessToken": [
  7763. "[]"
  7764. ]
  7765. },
  7766. {
  7767. "AuthorizationHeaderToken": [
  7768. "[]"
  7769. ]
  7770. }
  7771. ]
  7772. }