Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.

v1_json.tmpl 337KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483
  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": "{{AppSubUrl}}/api/v1",
  25. "paths": {
  26. "/admin/orgs": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List all organizations",
  35. "operationId": "adminGetAllOrgs",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results, maximum page size is 50",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/OrganizationList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/users": {
  61. "get": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "List all users",
  69. "operationId": "adminGetAllUsers",
  70. "parameters": [
  71. {
  72. "type": "integer",
  73. "description": "page number of results to return (1-based)",
  74. "name": "page",
  75. "in": "query"
  76. },
  77. {
  78. "type": "integer",
  79. "description": "page size of results, maximum page size is 50",
  80. "name": "limit",
  81. "in": "query"
  82. }
  83. ],
  84. "responses": {
  85. "200": {
  86. "$ref": "#/responses/UserList"
  87. },
  88. "403": {
  89. "$ref": "#/responses/forbidden"
  90. }
  91. }
  92. },
  93. "post": {
  94. "consumes": [
  95. "application/json"
  96. ],
  97. "produces": [
  98. "application/json"
  99. ],
  100. "tags": [
  101. "admin"
  102. ],
  103. "summary": "Create a user",
  104. "operationId": "adminCreateUser",
  105. "parameters": [
  106. {
  107. "name": "body",
  108. "in": "body",
  109. "schema": {
  110. "$ref": "#/definitions/CreateUserOption"
  111. }
  112. }
  113. ],
  114. "responses": {
  115. "201": {
  116. "$ref": "#/responses/User"
  117. },
  118. "400": {
  119. "$ref": "#/responses/error"
  120. },
  121. "403": {
  122. "$ref": "#/responses/forbidden"
  123. },
  124. "422": {
  125. "$ref": "#/responses/validationError"
  126. }
  127. }
  128. }
  129. },
  130. "/admin/users/{username}": {
  131. "delete": {
  132. "produces": [
  133. "application/json"
  134. ],
  135. "tags": [
  136. "admin"
  137. ],
  138. "summary": "Delete a user",
  139. "operationId": "adminDeleteUser",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "username of user to delete",
  144. "name": "username",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "204": {
  151. "$ref": "#/responses/empty"
  152. },
  153. "403": {
  154. "$ref": "#/responses/forbidden"
  155. },
  156. "422": {
  157. "$ref": "#/responses/validationError"
  158. }
  159. }
  160. },
  161. "patch": {
  162. "consumes": [
  163. "application/json"
  164. ],
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Edit an existing user",
  172. "operationId": "adminEditUser",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "username of user to edit",
  177. "name": "username",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "name": "body",
  183. "in": "body",
  184. "schema": {
  185. "$ref": "#/definitions/EditUserOption"
  186. }
  187. }
  188. ],
  189. "responses": {
  190. "200": {
  191. "$ref": "#/responses/User"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "422": {
  197. "$ref": "#/responses/validationError"
  198. }
  199. }
  200. }
  201. },
  202. "/admin/users/{username}/keys": {
  203. "post": {
  204. "consumes": [
  205. "application/json"
  206. ],
  207. "produces": [
  208. "application/json"
  209. ],
  210. "tags": [
  211. "admin"
  212. ],
  213. "summary": "Add a public key on behalf of a user",
  214. "operationId": "adminCreatePublicKey",
  215. "parameters": [
  216. {
  217. "type": "string",
  218. "description": "username of the user",
  219. "name": "username",
  220. "in": "path",
  221. "required": true
  222. },
  223. {
  224. "name": "key",
  225. "in": "body",
  226. "schema": {
  227. "$ref": "#/definitions/CreateKeyOption"
  228. }
  229. }
  230. ],
  231. "responses": {
  232. "201": {
  233. "$ref": "#/responses/PublicKey"
  234. },
  235. "403": {
  236. "$ref": "#/responses/forbidden"
  237. },
  238. "422": {
  239. "$ref": "#/responses/validationError"
  240. }
  241. }
  242. }
  243. },
  244. "/admin/users/{username}/keys/{id}": {
  245. "delete": {
  246. "produces": [
  247. "application/json"
  248. ],
  249. "tags": [
  250. "admin"
  251. ],
  252. "summary": "Delete a user's public key",
  253. "operationId": "adminDeleteUserPublicKey",
  254. "parameters": [
  255. {
  256. "type": "string",
  257. "description": "username of user",
  258. "name": "username",
  259. "in": "path",
  260. "required": true
  261. },
  262. {
  263. "type": "integer",
  264. "format": "int64",
  265. "description": "id of the key to delete",
  266. "name": "id",
  267. "in": "path",
  268. "required": true
  269. }
  270. ],
  271. "responses": {
  272. "204": {
  273. "$ref": "#/responses/empty"
  274. },
  275. "403": {
  276. "$ref": "#/responses/forbidden"
  277. },
  278. "404": {
  279. "$ref": "#/responses/notFound"
  280. }
  281. }
  282. }
  283. },
  284. "/admin/users/{username}/orgs": {
  285. "post": {
  286. "consumes": [
  287. "application/json"
  288. ],
  289. "produces": [
  290. "application/json"
  291. ],
  292. "tags": [
  293. "admin"
  294. ],
  295. "summary": "Create an organization",
  296. "operationId": "adminCreateOrg",
  297. "parameters": [
  298. {
  299. "type": "string",
  300. "description": "username of the user that will own the created organization",
  301. "name": "username",
  302. "in": "path",
  303. "required": true
  304. },
  305. {
  306. "name": "organization",
  307. "in": "body",
  308. "required": true,
  309. "schema": {
  310. "$ref": "#/definitions/CreateOrgOption"
  311. }
  312. }
  313. ],
  314. "responses": {
  315. "201": {
  316. "$ref": "#/responses/Organization"
  317. },
  318. "403": {
  319. "$ref": "#/responses/forbidden"
  320. },
  321. "422": {
  322. "$ref": "#/responses/validationError"
  323. }
  324. }
  325. }
  326. },
  327. "/admin/users/{username}/repos": {
  328. "post": {
  329. "consumes": [
  330. "application/json"
  331. ],
  332. "produces": [
  333. "application/json"
  334. ],
  335. "tags": [
  336. "admin"
  337. ],
  338. "summary": "Create a repository on behalf of a user",
  339. "operationId": "adminCreateRepo",
  340. "parameters": [
  341. {
  342. "type": "string",
  343. "description": "username of the user. This user will own the created repository",
  344. "name": "username",
  345. "in": "path",
  346. "required": true
  347. },
  348. {
  349. "name": "repository",
  350. "in": "body",
  351. "required": true,
  352. "schema": {
  353. "$ref": "#/definitions/CreateRepoOption"
  354. }
  355. }
  356. ],
  357. "responses": {
  358. "201": {
  359. "$ref": "#/responses/Repository"
  360. },
  361. "403": {
  362. "$ref": "#/responses/forbidden"
  363. },
  364. "404": {
  365. "$ref": "#/responses/notFound"
  366. },
  367. "409": {
  368. "$ref": "#/responses/error"
  369. },
  370. "422": {
  371. "$ref": "#/responses/validationError"
  372. }
  373. }
  374. }
  375. },
  376. "/markdown": {
  377. "post": {
  378. "consumes": [
  379. "application/json"
  380. ],
  381. "produces": [
  382. "text/html"
  383. ],
  384. "tags": [
  385. "miscellaneous"
  386. ],
  387. "summary": "Render a markdown document as HTML",
  388. "operationId": "renderMarkdown",
  389. "parameters": [
  390. {
  391. "name": "body",
  392. "in": "body",
  393. "schema": {
  394. "$ref": "#/definitions/MarkdownOption"
  395. }
  396. }
  397. ],
  398. "responses": {
  399. "200": {
  400. "$ref": "#/responses/MarkdownRender"
  401. },
  402. "422": {
  403. "$ref": "#/responses/validationError"
  404. }
  405. }
  406. }
  407. },
  408. "/markdown/raw": {
  409. "post": {
  410. "consumes": [
  411. "text/plain"
  412. ],
  413. "produces": [
  414. "text/html"
  415. ],
  416. "tags": [
  417. "miscellaneous"
  418. ],
  419. "summary": "Render raw markdown as HTML",
  420. "operationId": "renderMarkdownRaw",
  421. "parameters": [
  422. {
  423. "description": "Request body to render",
  424. "name": "body",
  425. "in": "body",
  426. "required": true,
  427. "schema": {
  428. "type": "string"
  429. }
  430. }
  431. ],
  432. "responses": {
  433. "200": {
  434. "$ref": "#/responses/MarkdownRender"
  435. },
  436. "422": {
  437. "$ref": "#/responses/validationError"
  438. }
  439. }
  440. }
  441. },
  442. "/notifications": {
  443. "get": {
  444. "consumes": [
  445. "application/json"
  446. ],
  447. "produces": [
  448. "application/json"
  449. ],
  450. "tags": [
  451. "notification"
  452. ],
  453. "summary": "List users's notification threads",
  454. "operationId": "notifyGetList",
  455. "parameters": [
  456. {
  457. "type": "string",
  458. "description": "If true, show notifications marked as read. Default value is false",
  459. "name": "all",
  460. "in": "query"
  461. },
  462. {
  463. "type": "string",
  464. "format": "date-time",
  465. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  466. "name": "since",
  467. "in": "query"
  468. },
  469. {
  470. "type": "string",
  471. "format": "date-time",
  472. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  473. "name": "before",
  474. "in": "query"
  475. },
  476. {
  477. "type": "integer",
  478. "description": "page number of results to return (1-based)",
  479. "name": "page",
  480. "in": "query"
  481. },
  482. {
  483. "type": "integer",
  484. "description": "page size of results, maximum page size is 50",
  485. "name": "limit",
  486. "in": "query"
  487. }
  488. ],
  489. "responses": {
  490. "200": {
  491. "$ref": "#/responses/NotificationThreadList"
  492. }
  493. }
  494. },
  495. "put": {
  496. "consumes": [
  497. "application/json"
  498. ],
  499. "produces": [
  500. "application/json"
  501. ],
  502. "tags": [
  503. "notification"
  504. ],
  505. "summary": "Mark notification threads as read",
  506. "operationId": "notifyReadList",
  507. "parameters": [
  508. {
  509. "type": "string",
  510. "format": "date-time",
  511. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  512. "name": "last_read_at",
  513. "in": "query"
  514. }
  515. ],
  516. "responses": {
  517. "205": {
  518. "$ref": "#/responses/empty"
  519. }
  520. }
  521. }
  522. },
  523. "/notifications/new": {
  524. "get": {
  525. "tags": [
  526. "notification"
  527. ],
  528. "summary": "Check if unread notifications exist",
  529. "operationId": "notifyNewAvailable",
  530. "responses": {
  531. "200": {
  532. "$ref": "#/responses/NotificationCount"
  533. },
  534. "204": {
  535. "description": "No unread notification"
  536. }
  537. }
  538. }
  539. },
  540. "/notifications/threads/{id}": {
  541. "get": {
  542. "consumes": [
  543. "application/json"
  544. ],
  545. "produces": [
  546. "application/json"
  547. ],
  548. "tags": [
  549. "notification"
  550. ],
  551. "summary": "Get notification thread by ID",
  552. "operationId": "notifyGetThread",
  553. "parameters": [
  554. {
  555. "type": "string",
  556. "description": "id of notification thread",
  557. "name": "id",
  558. "in": "path",
  559. "required": true
  560. }
  561. ],
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/NotificationThread"
  565. },
  566. "403": {
  567. "$ref": "#/responses/forbidden"
  568. },
  569. "404": {
  570. "$ref": "#/responses/notFound"
  571. }
  572. }
  573. },
  574. "patch": {
  575. "consumes": [
  576. "application/json"
  577. ],
  578. "produces": [
  579. "application/json"
  580. ],
  581. "tags": [
  582. "notification"
  583. ],
  584. "summary": "Mark notification thread as read by ID",
  585. "operationId": "notifyReadThread",
  586. "parameters": [
  587. {
  588. "type": "string",
  589. "description": "id of notification thread",
  590. "name": "id",
  591. "in": "path",
  592. "required": true
  593. }
  594. ],
  595. "responses": {
  596. "205": {
  597. "$ref": "#/responses/empty"
  598. },
  599. "403": {
  600. "$ref": "#/responses/forbidden"
  601. },
  602. "404": {
  603. "$ref": "#/responses/notFound"
  604. }
  605. }
  606. }
  607. },
  608. "/org/{org}/repos": {
  609. "post": {
  610. "consumes": [
  611. "application/json"
  612. ],
  613. "produces": [
  614. "application/json"
  615. ],
  616. "tags": [
  617. "organization"
  618. ],
  619. "summary": "Create a repository in an organization",
  620. "operationId": "createOrgRepoDeprecated",
  621. "deprecated": true,
  622. "parameters": [
  623. {
  624. "type": "string",
  625. "description": "name of organization",
  626. "name": "org",
  627. "in": "path",
  628. "required": true
  629. },
  630. {
  631. "name": "body",
  632. "in": "body",
  633. "schema": {
  634. "$ref": "#/definitions/CreateRepoOption"
  635. }
  636. }
  637. ],
  638. "responses": {
  639. "201": {
  640. "$ref": "#/responses/Repository"
  641. },
  642. "403": {
  643. "$ref": "#/responses/forbidden"
  644. },
  645. "422": {
  646. "$ref": "#/responses/validationError"
  647. }
  648. }
  649. }
  650. },
  651. "/orgs": {
  652. "get": {
  653. "produces": [
  654. "application/json"
  655. ],
  656. "tags": [
  657. "organization"
  658. ],
  659. "summary": "Get list of organizations",
  660. "operationId": "orgGetAll",
  661. "parameters": [
  662. {
  663. "type": "integer",
  664. "description": "page number of results to return (1-based)",
  665. "name": "page",
  666. "in": "query"
  667. },
  668. {
  669. "type": "integer",
  670. "description": "page size of results, maximum page size is 50",
  671. "name": "limit",
  672. "in": "query"
  673. }
  674. ],
  675. "responses": {
  676. "200": {
  677. "$ref": "#/responses/OrganizationList"
  678. }
  679. }
  680. },
  681. "post": {
  682. "consumes": [
  683. "application/json"
  684. ],
  685. "produces": [
  686. "application/json"
  687. ],
  688. "tags": [
  689. "organization"
  690. ],
  691. "summary": "Create an organization",
  692. "operationId": "orgCreate",
  693. "parameters": [
  694. {
  695. "name": "organization",
  696. "in": "body",
  697. "required": true,
  698. "schema": {
  699. "$ref": "#/definitions/CreateOrgOption"
  700. }
  701. }
  702. ],
  703. "responses": {
  704. "201": {
  705. "$ref": "#/responses/Organization"
  706. },
  707. "403": {
  708. "$ref": "#/responses/forbidden"
  709. },
  710. "422": {
  711. "$ref": "#/responses/validationError"
  712. }
  713. }
  714. }
  715. },
  716. "/orgs/{org}": {
  717. "get": {
  718. "produces": [
  719. "application/json"
  720. ],
  721. "tags": [
  722. "organization"
  723. ],
  724. "summary": "Get an organization",
  725. "operationId": "orgGet",
  726. "parameters": [
  727. {
  728. "type": "string",
  729. "description": "name of the organization to get",
  730. "name": "org",
  731. "in": "path",
  732. "required": true
  733. }
  734. ],
  735. "responses": {
  736. "200": {
  737. "$ref": "#/responses/Organization"
  738. }
  739. }
  740. },
  741. "delete": {
  742. "produces": [
  743. "application/json"
  744. ],
  745. "tags": [
  746. "organization"
  747. ],
  748. "summary": "Delete an organization",
  749. "operationId": "orgDelete",
  750. "parameters": [
  751. {
  752. "type": "string",
  753. "description": "organization that is to be deleted",
  754. "name": "org",
  755. "in": "path",
  756. "required": true
  757. }
  758. ],
  759. "responses": {
  760. "204": {
  761. "$ref": "#/responses/empty"
  762. }
  763. }
  764. },
  765. "patch": {
  766. "consumes": [
  767. "application/json"
  768. ],
  769. "produces": [
  770. "application/json"
  771. ],
  772. "tags": [
  773. "organization"
  774. ],
  775. "summary": "Edit an organization",
  776. "operationId": "orgEdit",
  777. "parameters": [
  778. {
  779. "type": "string",
  780. "description": "name of the organization to edit",
  781. "name": "org",
  782. "in": "path",
  783. "required": true
  784. },
  785. {
  786. "name": "body",
  787. "in": "body",
  788. "required": true,
  789. "schema": {
  790. "$ref": "#/definitions/EditOrgOption"
  791. }
  792. }
  793. ],
  794. "responses": {
  795. "200": {
  796. "$ref": "#/responses/Organization"
  797. }
  798. }
  799. }
  800. },
  801. "/orgs/{org}/hooks": {
  802. "get": {
  803. "produces": [
  804. "application/json"
  805. ],
  806. "tags": [
  807. "organization"
  808. ],
  809. "summary": "List an organization's webhooks",
  810. "operationId": "orgListHooks",
  811. "parameters": [
  812. {
  813. "type": "string",
  814. "description": "name of the organization",
  815. "name": "org",
  816. "in": "path",
  817. "required": true
  818. },
  819. {
  820. "type": "integer",
  821. "description": "page number of results to return (1-based)",
  822. "name": "page",
  823. "in": "query"
  824. },
  825. {
  826. "type": "integer",
  827. "description": "page size of results, maximum page size is 50",
  828. "name": "limit",
  829. "in": "query"
  830. }
  831. ],
  832. "responses": {
  833. "200": {
  834. "$ref": "#/responses/HookList"
  835. }
  836. }
  837. }
  838. },
  839. "/orgs/{org}/hooks/": {
  840. "post": {
  841. "consumes": [
  842. "application/json"
  843. ],
  844. "produces": [
  845. "application/json"
  846. ],
  847. "tags": [
  848. "organization"
  849. ],
  850. "summary": "Create a hook",
  851. "operationId": "orgCreateHook",
  852. "parameters": [
  853. {
  854. "type": "string",
  855. "description": "name of the organization",
  856. "name": "org",
  857. "in": "path",
  858. "required": true
  859. },
  860. {
  861. "name": "body",
  862. "in": "body",
  863. "required": true,
  864. "schema": {
  865. "$ref": "#/definitions/CreateHookOption"
  866. }
  867. }
  868. ],
  869. "responses": {
  870. "201": {
  871. "$ref": "#/responses/Hook"
  872. }
  873. }
  874. }
  875. },
  876. "/orgs/{org}/hooks/{id}": {
  877. "get": {
  878. "produces": [
  879. "application/json"
  880. ],
  881. "tags": [
  882. "organization"
  883. ],
  884. "summary": "Get a hook",
  885. "operationId": "orgGetHook",
  886. "parameters": [
  887. {
  888. "type": "string",
  889. "description": "name of the organization",
  890. "name": "org",
  891. "in": "path",
  892. "required": true
  893. },
  894. {
  895. "type": "integer",
  896. "format": "int64",
  897. "description": "id of the hook to get",
  898. "name": "id",
  899. "in": "path",
  900. "required": true
  901. }
  902. ],
  903. "responses": {
  904. "200": {
  905. "$ref": "#/responses/Hook"
  906. }
  907. }
  908. },
  909. "delete": {
  910. "produces": [
  911. "application/json"
  912. ],
  913. "tags": [
  914. "organization"
  915. ],
  916. "summary": "Delete a hook",
  917. "operationId": "orgDeleteHook",
  918. "parameters": [
  919. {
  920. "type": "string",
  921. "description": "name of the organization",
  922. "name": "org",
  923. "in": "path",
  924. "required": true
  925. },
  926. {
  927. "type": "integer",
  928. "format": "int64",
  929. "description": "id of the hook to delete",
  930. "name": "id",
  931. "in": "path",
  932. "required": true
  933. }
  934. ],
  935. "responses": {
  936. "204": {
  937. "$ref": "#/responses/empty"
  938. }
  939. }
  940. },
  941. "patch": {
  942. "consumes": [
  943. "application/json"
  944. ],
  945. "produces": [
  946. "application/json"
  947. ],
  948. "tags": [
  949. "organization"
  950. ],
  951. "summary": "Update a hook",
  952. "operationId": "orgEditHook",
  953. "parameters": [
  954. {
  955. "type": "string",
  956. "description": "name of the organization",
  957. "name": "org",
  958. "in": "path",
  959. "required": true
  960. },
  961. {
  962. "type": "integer",
  963. "format": "int64",
  964. "description": "id of the hook to update",
  965. "name": "id",
  966. "in": "path",
  967. "required": true
  968. },
  969. {
  970. "name": "body",
  971. "in": "body",
  972. "schema": {
  973. "$ref": "#/definitions/EditHookOption"
  974. }
  975. }
  976. ],
  977. "responses": {
  978. "200": {
  979. "$ref": "#/responses/Hook"
  980. }
  981. }
  982. }
  983. },
  984. "/orgs/{org}/members": {
  985. "get": {
  986. "produces": [
  987. "application/json"
  988. ],
  989. "tags": [
  990. "organization"
  991. ],
  992. "summary": "List an organization's members",
  993. "operationId": "orgListMembers",
  994. "parameters": [
  995. {
  996. "type": "string",
  997. "description": "name of the organization",
  998. "name": "org",
  999. "in": "path",
  1000. "required": true
  1001. },
  1002. {
  1003. "type": "integer",
  1004. "description": "page number of results to return (1-based)",
  1005. "name": "page",
  1006. "in": "query"
  1007. },
  1008. {
  1009. "type": "integer",
  1010. "description": "page size of results, maximum page size is 50",
  1011. "name": "limit",
  1012. "in": "query"
  1013. }
  1014. ],
  1015. "responses": {
  1016. "200": {
  1017. "$ref": "#/responses/UserList"
  1018. }
  1019. }
  1020. }
  1021. },
  1022. "/orgs/{org}/members/{username}": {
  1023. "get": {
  1024. "tags": [
  1025. "organization"
  1026. ],
  1027. "summary": "Check if a user is a member of an organization",
  1028. "operationId": "orgIsMember",
  1029. "parameters": [
  1030. {
  1031. "type": "string",
  1032. "description": "name of the organization",
  1033. "name": "org",
  1034. "in": "path",
  1035. "required": true
  1036. },
  1037. {
  1038. "type": "string",
  1039. "description": "username of the user",
  1040. "name": "username",
  1041. "in": "path",
  1042. "required": true
  1043. }
  1044. ],
  1045. "responses": {
  1046. "204": {
  1047. "description": "user is a member"
  1048. },
  1049. "302": {
  1050. "description": "redirection to /orgs/{org}/public_members/{username}"
  1051. },
  1052. "404": {
  1053. "description": "user is not a member"
  1054. }
  1055. }
  1056. },
  1057. "delete": {
  1058. "produces": [
  1059. "application/json"
  1060. ],
  1061. "tags": [
  1062. "organization"
  1063. ],
  1064. "summary": "Remove a member from an organization",
  1065. "operationId": "orgDeleteMember",
  1066. "parameters": [
  1067. {
  1068. "type": "string",
  1069. "description": "name of the organization",
  1070. "name": "org",
  1071. "in": "path",
  1072. "required": true
  1073. },
  1074. {
  1075. "type": "string",
  1076. "description": "username of the user",
  1077. "name": "username",
  1078. "in": "path",
  1079. "required": true
  1080. }
  1081. ],
  1082. "responses": {
  1083. "204": {
  1084. "description": "member removed"
  1085. }
  1086. }
  1087. }
  1088. },
  1089. "/orgs/{org}/public_members": {
  1090. "get": {
  1091. "produces": [
  1092. "application/json"
  1093. ],
  1094. "tags": [
  1095. "organization"
  1096. ],
  1097. "summary": "List an organization's public members",
  1098. "operationId": "orgListPublicMembers",
  1099. "parameters": [
  1100. {
  1101. "type": "string",
  1102. "description": "name of the organization",
  1103. "name": "org",
  1104. "in": "path",
  1105. "required": true
  1106. },
  1107. {
  1108. "type": "integer",
  1109. "description": "page number of results to return (1-based)",
  1110. "name": "page",
  1111. "in": "query"
  1112. },
  1113. {
  1114. "type": "integer",
  1115. "description": "page size of results, maximum page size is 50",
  1116. "name": "limit",
  1117. "in": "query"
  1118. }
  1119. ],
  1120. "responses": {
  1121. "200": {
  1122. "$ref": "#/responses/UserList"
  1123. }
  1124. }
  1125. }
  1126. },
  1127. "/orgs/{org}/public_members/{username}": {
  1128. "get": {
  1129. "tags": [
  1130. "organization"
  1131. ],
  1132. "summary": "Check if a user is a public member of an organization",
  1133. "operationId": "orgIsPublicMember",
  1134. "parameters": [
  1135. {
  1136. "type": "string",
  1137. "description": "name of the organization",
  1138. "name": "org",
  1139. "in": "path",
  1140. "required": true
  1141. },
  1142. {
  1143. "type": "string",
  1144. "description": "username of the user",
  1145. "name": "username",
  1146. "in": "path",
  1147. "required": true
  1148. }
  1149. ],
  1150. "responses": {
  1151. "204": {
  1152. "description": "user is a public member"
  1153. },
  1154. "404": {
  1155. "description": "user is not a public member"
  1156. }
  1157. }
  1158. },
  1159. "put": {
  1160. "produces": [
  1161. "application/json"
  1162. ],
  1163. "tags": [
  1164. "organization"
  1165. ],
  1166. "summary": "Publicize a user's membership",
  1167. "operationId": "orgPublicizeMember",
  1168. "parameters": [
  1169. {
  1170. "type": "string",
  1171. "description": "name of the organization",
  1172. "name": "org",
  1173. "in": "path",
  1174. "required": true
  1175. },
  1176. {
  1177. "type": "string",
  1178. "description": "username of the user",
  1179. "name": "username",
  1180. "in": "path",
  1181. "required": true
  1182. }
  1183. ],
  1184. "responses": {
  1185. "204": {
  1186. "description": "membership publicized"
  1187. },
  1188. "403": {
  1189. "$ref": "#/responses/forbidden"
  1190. }
  1191. }
  1192. },
  1193. "delete": {
  1194. "produces": [
  1195. "application/json"
  1196. ],
  1197. "tags": [
  1198. "organization"
  1199. ],
  1200. "summary": "Conceal a user's membership",
  1201. "operationId": "orgConcealMember",
  1202. "parameters": [
  1203. {
  1204. "type": "string",
  1205. "description": "name of the organization",
  1206. "name": "org",
  1207. "in": "path",
  1208. "required": true
  1209. },
  1210. {
  1211. "type": "string",
  1212. "description": "username of the user",
  1213. "name": "username",
  1214. "in": "path",
  1215. "required": true
  1216. }
  1217. ],
  1218. "responses": {
  1219. "204": {
  1220. "$ref": "#/responses/empty"
  1221. },
  1222. "403": {
  1223. "$ref": "#/responses/forbidden"
  1224. }
  1225. }
  1226. }
  1227. },
  1228. "/orgs/{org}/repos": {
  1229. "get": {
  1230. "produces": [
  1231. "application/json"
  1232. ],
  1233. "tags": [
  1234. "organization"
  1235. ],
  1236. "summary": "List an organization's repos",
  1237. "operationId": "orgListRepos",
  1238. "parameters": [
  1239. {
  1240. "type": "string",
  1241. "description": "name of the organization",
  1242. "name": "org",
  1243. "in": "path",
  1244. "required": true
  1245. },
  1246. {
  1247. "type": "integer",
  1248. "description": "page number of results to return (1-based)",
  1249. "name": "page",
  1250. "in": "query"
  1251. },
  1252. {
  1253. "type": "integer",
  1254. "description": "page size of results, maximum page size is 50",
  1255. "name": "limit",
  1256. "in": "query"
  1257. }
  1258. ],
  1259. "responses": {
  1260. "200": {
  1261. "$ref": "#/responses/RepositoryList"
  1262. }
  1263. }
  1264. },
  1265. "post": {
  1266. "consumes": [
  1267. "application/json"
  1268. ],
  1269. "produces": [
  1270. "application/json"
  1271. ],
  1272. "tags": [
  1273. "organization"
  1274. ],
  1275. "summary": "Create a repository in an organization",
  1276. "operationId": "createOrgRepo",
  1277. "parameters": [
  1278. {
  1279. "type": "string",
  1280. "description": "name of organization",
  1281. "name": "org",
  1282. "in": "path",
  1283. "required": true
  1284. },
  1285. {
  1286. "name": "body",
  1287. "in": "body",
  1288. "schema": {
  1289. "$ref": "#/definitions/CreateRepoOption"
  1290. }
  1291. }
  1292. ],
  1293. "responses": {
  1294. "201": {
  1295. "$ref": "#/responses/Repository"
  1296. },
  1297. "403": {
  1298. "$ref": "#/responses/forbidden"
  1299. },
  1300. "404": {
  1301. "$ref": "#/responses/notFound"
  1302. }
  1303. }
  1304. }
  1305. },
  1306. "/orgs/{org}/teams": {
  1307. "get": {
  1308. "produces": [
  1309. "application/json"
  1310. ],
  1311. "tags": [
  1312. "organization"
  1313. ],
  1314. "summary": "List an organization's teams",
  1315. "operationId": "orgListTeams",
  1316. "parameters": [
  1317. {
  1318. "type": "string",
  1319. "description": "name of the organization",
  1320. "name": "org",
  1321. "in": "path",
  1322. "required": true
  1323. },
  1324. {
  1325. "type": "integer",
  1326. "description": "page number of results to return (1-based)",
  1327. "name": "page",
  1328. "in": "query"
  1329. },
  1330. {
  1331. "type": "integer",
  1332. "description": "page size of results, maximum page size is 50",
  1333. "name": "limit",
  1334. "in": "query"
  1335. }
  1336. ],
  1337. "responses": {
  1338. "200": {
  1339. "$ref": "#/responses/TeamList"
  1340. }
  1341. }
  1342. },
  1343. "post": {
  1344. "consumes": [
  1345. "application/json"
  1346. ],
  1347. "produces": [
  1348. "application/json"
  1349. ],
  1350. "tags": [
  1351. "organization"
  1352. ],
  1353. "summary": "Create a team",
  1354. "operationId": "orgCreateTeam",
  1355. "parameters": [
  1356. {
  1357. "type": "string",
  1358. "description": "name of the organization",
  1359. "name": "org",
  1360. "in": "path",
  1361. "required": true
  1362. },
  1363. {
  1364. "name": "body",
  1365. "in": "body",
  1366. "schema": {
  1367. "$ref": "#/definitions/CreateTeamOption"
  1368. }
  1369. }
  1370. ],
  1371. "responses": {
  1372. "201": {
  1373. "$ref": "#/responses/Team"
  1374. },
  1375. "422": {
  1376. "$ref": "#/responses/validationError"
  1377. }
  1378. }
  1379. }
  1380. },
  1381. "/orgs/{org}/teams/search": {
  1382. "get": {
  1383. "produces": [
  1384. "application/json"
  1385. ],
  1386. "tags": [
  1387. "organization"
  1388. ],
  1389. "summary": "Search for teams within an organization",
  1390. "operationId": "teamSearch",
  1391. "parameters": [
  1392. {
  1393. "type": "string",
  1394. "description": "name of the organization",
  1395. "name": "org",
  1396. "in": "path",
  1397. "required": true
  1398. },
  1399. {
  1400. "type": "string",
  1401. "description": "keywords to search",
  1402. "name": "q",
  1403. "in": "query"
  1404. },
  1405. {
  1406. "type": "boolean",
  1407. "description": "include search within team description (defaults to true)",
  1408. "name": "include_desc",
  1409. "in": "query"
  1410. },
  1411. {
  1412. "type": "integer",
  1413. "description": "page number of results to return (1-based)",
  1414. "name": "page",
  1415. "in": "query"
  1416. },
  1417. {
  1418. "type": "integer",
  1419. "description": "page size of results, maximum page size is 50",
  1420. "name": "limit",
  1421. "in": "query"
  1422. }
  1423. ],
  1424. "responses": {
  1425. "200": {
  1426. "description": "SearchResults of a successful search",
  1427. "schema": {
  1428. "type": "object",
  1429. "properties": {
  1430. "data": {
  1431. "type": "array",
  1432. "items": {
  1433. "$ref": "#/definitions/Team"
  1434. }
  1435. },
  1436. "ok": {
  1437. "type": "boolean"
  1438. }
  1439. }
  1440. }
  1441. }
  1442. }
  1443. }
  1444. },
  1445. "/repos/issues/search": {
  1446. "get": {
  1447. "produces": [
  1448. "application/json"
  1449. ],
  1450. "tags": [
  1451. "issue"
  1452. ],
  1453. "summary": "Search for issues across the repositories that the user has access to",
  1454. "operationId": "issueSearchIssues",
  1455. "parameters": [
  1456. {
  1457. "type": "string",
  1458. "description": "whether issue is open or closed",
  1459. "name": "state",
  1460. "in": "query"
  1461. },
  1462. {
  1463. "type": "string",
  1464. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1465. "name": "labels",
  1466. "in": "query"
  1467. },
  1468. {
  1469. "type": "string",
  1470. "description": "search string",
  1471. "name": "q",
  1472. "in": "query"
  1473. },
  1474. {
  1475. "type": "integer",
  1476. "format": "int64",
  1477. "description": "repository to prioritize in the results",
  1478. "name": "priority_repo_id",
  1479. "in": "query"
  1480. },
  1481. {
  1482. "type": "string",
  1483. "description": "filter by type (issues / pulls) if set",
  1484. "name": "type",
  1485. "in": "query"
  1486. },
  1487. {
  1488. "type": "integer",
  1489. "description": "page number of requested issues",
  1490. "name": "page",
  1491. "in": "query"
  1492. }
  1493. ],
  1494. "responses": {
  1495. "200": {
  1496. "$ref": "#/responses/IssueList"
  1497. }
  1498. }
  1499. }
  1500. },
  1501. "/repos/migrate": {
  1502. "post": {
  1503. "consumes": [
  1504. "application/json"
  1505. ],
  1506. "produces": [
  1507. "application/json"
  1508. ],
  1509. "tags": [
  1510. "repository"
  1511. ],
  1512. "summary": "Migrate a remote git repository",
  1513. "operationId": "repoMigrate",
  1514. "parameters": [
  1515. {
  1516. "name": "body",
  1517. "in": "body",
  1518. "schema": {
  1519. "$ref": "#/definitions/MigrateRepoForm"
  1520. }
  1521. }
  1522. ],
  1523. "responses": {
  1524. "201": {
  1525. "$ref": "#/responses/Repository"
  1526. },
  1527. "403": {
  1528. "$ref": "#/responses/forbidden"
  1529. },
  1530. "422": {
  1531. "$ref": "#/responses/validationError"
  1532. }
  1533. }
  1534. }
  1535. },
  1536. "/repos/search": {
  1537. "get": {
  1538. "produces": [
  1539. "application/json"
  1540. ],
  1541. "tags": [
  1542. "repository"
  1543. ],
  1544. "summary": "Search for repositories",
  1545. "operationId": "repoSearch",
  1546. "parameters": [
  1547. {
  1548. "type": "string",
  1549. "description": "keyword",
  1550. "name": "q",
  1551. "in": "query"
  1552. },
  1553. {
  1554. "type": "boolean",
  1555. "description": "Limit search to repositories with keyword as topic",
  1556. "name": "topic",
  1557. "in": "query"
  1558. },
  1559. {
  1560. "type": "boolean",
  1561. "description": "include search of keyword within repository description",
  1562. "name": "includeDesc",
  1563. "in": "query"
  1564. },
  1565. {
  1566. "type": "integer",
  1567. "format": "int64",
  1568. "description": "search only for repos that the user with the given id owns or contributes to",
  1569. "name": "uid",
  1570. "in": "query"
  1571. },
  1572. {
  1573. "type": "integer",
  1574. "format": "int64",
  1575. "description": "repo owner to prioritize in the results",
  1576. "name": "priority_owner_id",
  1577. "in": "query"
  1578. },
  1579. {
  1580. "type": "integer",
  1581. "format": "int64",
  1582. "description": "search only for repos that the user with the given id has starred",
  1583. "name": "starredBy",
  1584. "in": "query"
  1585. },
  1586. {
  1587. "type": "boolean",
  1588. "description": "include private repositories this user has access to (defaults to true)",
  1589. "name": "private",
  1590. "in": "query"
  1591. },
  1592. {
  1593. "type": "boolean",
  1594. "description": "include template repositories this user has access to (defaults to true)",
  1595. "name": "template",
  1596. "in": "query"
  1597. },
  1598. {
  1599. "type": "string",
  1600. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1601. "name": "mode",
  1602. "in": "query"
  1603. },
  1604. {
  1605. "type": "boolean",
  1606. "description": "if `uid` is given, search only for repos that the user owns",
  1607. "name": "exclusive",
  1608. "in": "query"
  1609. },
  1610. {
  1611. "type": "string",
  1612. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1613. "name": "sort",
  1614. "in": "query"
  1615. },
  1616. {
  1617. "type": "string",
  1618. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1619. "name": "order",
  1620. "in": "query"
  1621. },
  1622. {
  1623. "type": "integer",
  1624. "description": "page number of results to return (1-based)",
  1625. "name": "page",
  1626. "in": "query"
  1627. },
  1628. {
  1629. "type": "integer",
  1630. "description": "page size of results, maximum page size is 50",
  1631. "name": "limit",
  1632. "in": "query"
  1633. }
  1634. ],
  1635. "responses": {
  1636. "200": {
  1637. "$ref": "#/responses/SearchResults"
  1638. },
  1639. "422": {
  1640. "$ref": "#/responses/validationError"
  1641. }
  1642. }
  1643. }
  1644. },
  1645. "/repos/{owner}/{repo}": {
  1646. "get": {
  1647. "produces": [
  1648. "application/json"
  1649. ],
  1650. "tags": [
  1651. "repository"
  1652. ],
  1653. "summary": "Get a repository",
  1654. "operationId": "repoGet",
  1655. "parameters": [
  1656. {
  1657. "type": "string",
  1658. "description": "owner of the repo",
  1659. "name": "owner",
  1660. "in": "path",
  1661. "required": true
  1662. },
  1663. {
  1664. "type": "string",
  1665. "description": "name of the repo",
  1666. "name": "repo",
  1667. "in": "path",
  1668. "required": true
  1669. }
  1670. ],
  1671. "responses": {
  1672. "200": {
  1673. "$ref": "#/responses/Repository"
  1674. }
  1675. }
  1676. },
  1677. "delete": {
  1678. "produces": [
  1679. "application/json"
  1680. ],
  1681. "tags": [
  1682. "repository"
  1683. ],
  1684. "summary": "Delete a repository",
  1685. "operationId": "repoDelete",
  1686. "parameters": [
  1687. {
  1688. "type": "string",
  1689. "description": "owner of the repo to delete",
  1690. "name": "owner",
  1691. "in": "path",
  1692. "required": true
  1693. },
  1694. {
  1695. "type": "string",
  1696. "description": "name of the repo to delete",
  1697. "name": "repo",
  1698. "in": "path",
  1699. "required": true
  1700. }
  1701. ],
  1702. "responses": {
  1703. "204": {
  1704. "$ref": "#/responses/empty"
  1705. },
  1706. "403": {
  1707. "$ref": "#/responses/forbidden"
  1708. }
  1709. }
  1710. },
  1711. "patch": {
  1712. "produces": [
  1713. "application/json"
  1714. ],
  1715. "tags": [
  1716. "repository"
  1717. ],
  1718. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1719. "operationId": "repoEdit",
  1720. "parameters": [
  1721. {
  1722. "type": "string",
  1723. "description": "owner of the repo to edit",
  1724. "name": "owner",
  1725. "in": "path",
  1726. "required": true
  1727. },
  1728. {
  1729. "type": "string",
  1730. "description": "name of the repo to edit",
  1731. "name": "repo",
  1732. "in": "path",
  1733. "required": true
  1734. },
  1735. {
  1736. "description": "Properties of a repo that you can edit",
  1737. "name": "body",
  1738. "in": "body",
  1739. "schema": {
  1740. "$ref": "#/definitions/EditRepoOption"
  1741. }
  1742. }
  1743. ],
  1744. "responses": {
  1745. "200": {
  1746. "$ref": "#/responses/Repository"
  1747. },
  1748. "403": {
  1749. "$ref": "#/responses/forbidden"
  1750. },
  1751. "422": {
  1752. "$ref": "#/responses/validationError"
  1753. }
  1754. }
  1755. }
  1756. },
  1757. "/repos/{owner}/{repo}/archive/{archive}": {
  1758. "get": {
  1759. "produces": [
  1760. "application/json"
  1761. ],
  1762. "tags": [
  1763. "repository"
  1764. ],
  1765. "summary": "Get an archive of a repository",
  1766. "operationId": "repoGetArchive",
  1767. "parameters": [
  1768. {
  1769. "type": "string",
  1770. "description": "owner of the repo",
  1771. "name": "owner",
  1772. "in": "path",
  1773. "required": true
  1774. },
  1775. {
  1776. "type": "string",
  1777. "description": "name of the repo",
  1778. "name": "repo",
  1779. "in": "path",
  1780. "required": true
  1781. },
  1782. {
  1783. "type": "string",
  1784. "description": "archive to download, consisting of a git reference and archive",
  1785. "name": "archive",
  1786. "in": "path",
  1787. "required": true
  1788. }
  1789. ],
  1790. "responses": {
  1791. "200": {
  1792. "description": "success"
  1793. },
  1794. "404": {
  1795. "$ref": "#/responses/notFound"
  1796. }
  1797. }
  1798. }
  1799. },
  1800. "/repos/{owner}/{repo}/branches": {
  1801. "get": {
  1802. "produces": [
  1803. "application/json"
  1804. ],
  1805. "tags": [
  1806. "repository"
  1807. ],
  1808. "summary": "List a repository's branches",
  1809. "operationId": "repoListBranches",
  1810. "parameters": [
  1811. {
  1812. "type": "string",
  1813. "description": "owner of the repo",
  1814. "name": "owner",
  1815. "in": "path",
  1816. "required": true
  1817. },
  1818. {
  1819. "type": "string",
  1820. "description": "name of the repo",
  1821. "name": "repo",
  1822. "in": "path",
  1823. "required": true
  1824. }
  1825. ],
  1826. "responses": {
  1827. "200": {
  1828. "$ref": "#/responses/BranchList"
  1829. }
  1830. }
  1831. }
  1832. },
  1833. "/repos/{owner}/{repo}/branches/{branch}": {
  1834. "get": {
  1835. "produces": [
  1836. "application/json"
  1837. ],
  1838. "tags": [
  1839. "repository"
  1840. ],
  1841. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  1842. "operationId": "repoGetBranch",
  1843. "parameters": [
  1844. {
  1845. "type": "string",
  1846. "description": "owner of the repo",
  1847. "name": "owner",
  1848. "in": "path",
  1849. "required": true
  1850. },
  1851. {
  1852. "type": "string",
  1853. "description": "name of the repo",
  1854. "name": "repo",
  1855. "in": "path",
  1856. "required": true
  1857. },
  1858. {
  1859. "type": "string",
  1860. "description": "branch to get",
  1861. "name": "branch",
  1862. "in": "path",
  1863. "required": true
  1864. }
  1865. ],
  1866. "responses": {
  1867. "200": {
  1868. "$ref": "#/responses/Branch"
  1869. }
  1870. }
  1871. }
  1872. },
  1873. "/repos/{owner}/{repo}/collaborators": {
  1874. "get": {
  1875. "produces": [
  1876. "application/json"
  1877. ],
  1878. "tags": [
  1879. "repository"
  1880. ],
  1881. "summary": "List a repository's collaborators",
  1882. "operationId": "repoListCollaborators",
  1883. "parameters": [
  1884. {
  1885. "type": "string",
  1886. "description": "owner of the repo",
  1887. "name": "owner",
  1888. "in": "path",
  1889. "required": true
  1890. },
  1891. {
  1892. "type": "string",
  1893. "description": "name of the repo",
  1894. "name": "repo",
  1895. "in": "path",
  1896. "required": true
  1897. },
  1898. {
  1899. "type": "integer",
  1900. "description": "page number of results to return (1-based)",
  1901. "name": "page",
  1902. "in": "query"
  1903. },
  1904. {
  1905. "type": "integer",
  1906. "description": "page size of results, maximum page size is 50",
  1907. "name": "limit",
  1908. "in": "query"
  1909. }
  1910. ],
  1911. "responses": {
  1912. "200": {
  1913. "$ref": "#/responses/UserList"
  1914. }
  1915. }
  1916. }
  1917. },
  1918. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  1919. "get": {
  1920. "produces": [
  1921. "application/json"
  1922. ],
  1923. "tags": [
  1924. "repository"
  1925. ],
  1926. "summary": "Check if a user is a collaborator of a repository",
  1927. "operationId": "repoCheckCollaborator",
  1928. "parameters": [
  1929. {
  1930. "type": "string",
  1931. "description": "owner of the repo",
  1932. "name": "owner",
  1933. "in": "path",
  1934. "required": true
  1935. },
  1936. {
  1937. "type": "string",
  1938. "description": "name of the repo",
  1939. "name": "repo",
  1940. "in": "path",
  1941. "required": true
  1942. },
  1943. {
  1944. "type": "string",
  1945. "description": "username of the collaborator",
  1946. "name": "collaborator",
  1947. "in": "path",
  1948. "required": true
  1949. }
  1950. ],
  1951. "responses": {
  1952. "204": {
  1953. "$ref": "#/responses/empty"
  1954. },
  1955. "404": {
  1956. "$ref": "#/responses/notFound"
  1957. },
  1958. "422": {
  1959. "$ref": "#/responses/validationError"
  1960. }
  1961. }
  1962. },
  1963. "put": {
  1964. "produces": [
  1965. "application/json"
  1966. ],
  1967. "tags": [
  1968. "repository"
  1969. ],
  1970. "summary": "Add a collaborator to a repository",
  1971. "operationId": "repoAddCollaborator",
  1972. "parameters": [
  1973. {
  1974. "type": "string",
  1975. "description": "owner of the repo",
  1976. "name": "owner",
  1977. "in": "path",
  1978. "required": true
  1979. },
  1980. {
  1981. "type": "string",
  1982. "description": "name of the repo",
  1983. "name": "repo",
  1984. "in": "path",
  1985. "required": true
  1986. },
  1987. {
  1988. "type": "string",
  1989. "description": "username of the collaborator to add",
  1990. "name": "collaborator",
  1991. "in": "path",
  1992. "required": true
  1993. },
  1994. {
  1995. "name": "body",
  1996. "in": "body",
  1997. "schema": {
  1998. "$ref": "#/definitions/AddCollaboratorOption"
  1999. }
  2000. }
  2001. ],
  2002. "responses": {
  2003. "204": {
  2004. "$ref": "#/responses/empty"
  2005. },
  2006. "422": {
  2007. "$ref": "#/responses/validationError"
  2008. }
  2009. }
  2010. },
  2011. "delete": {
  2012. "produces": [
  2013. "application/json"
  2014. ],
  2015. "tags": [
  2016. "repository"
  2017. ],
  2018. "summary": "Delete a collaborator from a repository",
  2019. "operationId": "repoDeleteCollaborator",
  2020. "parameters": [
  2021. {
  2022. "type": "string",
  2023. "description": "owner of the repo",
  2024. "name": "owner",
  2025. "in": "path",
  2026. "required": true
  2027. },
  2028. {
  2029. "type": "string",
  2030. "description": "name of the repo",
  2031. "name": "repo",
  2032. "in": "path",
  2033. "required": true
  2034. },
  2035. {
  2036. "type": "string",
  2037. "description": "username of the collaborator to delete",
  2038. "name": "collaborator",
  2039. "in": "path",
  2040. "required": true
  2041. }
  2042. ],
  2043. "responses": {
  2044. "204": {
  2045. "$ref": "#/responses/empty"
  2046. },
  2047. "422": {
  2048. "$ref": "#/responses/validationError"
  2049. }
  2050. }
  2051. }
  2052. },
  2053. "/repos/{owner}/{repo}/commits": {
  2054. "get": {
  2055. "produces": [
  2056. "application/json"
  2057. ],
  2058. "tags": [
  2059. "repository"
  2060. ],
  2061. "summary": "Get a list of all commits from a repository",
  2062. "operationId": "repoGetAllCommits",
  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": "string",
  2080. "description": "SHA or branch to start listing commits from (usually 'master')",
  2081. "name": "sha",
  2082. "in": "query"
  2083. },
  2084. {
  2085. "type": "integer",
  2086. "description": "page number of results to return (1-based)",
  2087. "name": "page",
  2088. "in": "query"
  2089. },
  2090. {
  2091. "type": "integer",
  2092. "description": "page size of results, maximum page size is 50",
  2093. "name": "limit",
  2094. "in": "query"
  2095. }
  2096. ],
  2097. "responses": {
  2098. "200": {
  2099. "$ref": "#/responses/CommitList"
  2100. },
  2101. "404": {
  2102. "$ref": "#/responses/notFound"
  2103. },
  2104. "409": {
  2105. "$ref": "#/responses/EmptyRepository"
  2106. }
  2107. }
  2108. }
  2109. },
  2110. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2111. "get": {
  2112. "produces": [
  2113. "application/json"
  2114. ],
  2115. "tags": [
  2116. "repository"
  2117. ],
  2118. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2119. "operationId": "repoGetCombinedStatusByRef",
  2120. "parameters": [
  2121. {
  2122. "type": "string",
  2123. "description": "owner of the repo",
  2124. "name": "owner",
  2125. "in": "path",
  2126. "required": true
  2127. },
  2128. {
  2129. "type": "string",
  2130. "description": "name of the repo",
  2131. "name": "repo",
  2132. "in": "path",
  2133. "required": true
  2134. },
  2135. {
  2136. "type": "string",
  2137. "description": "name of branch/tag/commit",
  2138. "name": "ref",
  2139. "in": "path",
  2140. "required": true
  2141. },
  2142. {
  2143. "type": "integer",
  2144. "description": "page number of results",
  2145. "name": "page",
  2146. "in": "query"
  2147. }
  2148. ],
  2149. "responses": {
  2150. "200": {
  2151. "$ref": "#/responses/Status"
  2152. },
  2153. "400": {
  2154. "$ref": "#/responses/error"
  2155. }
  2156. }
  2157. }
  2158. },
  2159. "/repos/{owner}/{repo}/contents": {
  2160. "get": {
  2161. "produces": [
  2162. "application/json"
  2163. ],
  2164. "tags": [
  2165. "repository"
  2166. ],
  2167. "summary": "Gets the metadata of all the entries of the root dir",
  2168. "operationId": "repoGetContentsList",
  2169. "parameters": [
  2170. {
  2171. "type": "string",
  2172. "description": "owner of the repo",
  2173. "name": "owner",
  2174. "in": "path",
  2175. "required": true
  2176. },
  2177. {
  2178. "type": "string",
  2179. "description": "name of the repo",
  2180. "name": "repo",
  2181. "in": "path",
  2182. "required": true
  2183. },
  2184. {
  2185. "type": "string",
  2186. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2187. "name": "ref",
  2188. "in": "query"
  2189. }
  2190. ],
  2191. "responses": {
  2192. "200": {
  2193. "$ref": "#/responses/ContentsListResponse"
  2194. }
  2195. }
  2196. }
  2197. },
  2198. "/repos/{owner}/{repo}/contents/{filepath}": {
  2199. "get": {
  2200. "produces": [
  2201. "application/json"
  2202. ],
  2203. "tags": [
  2204. "repository"
  2205. ],
  2206. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2207. "operationId": "repoGetContents",
  2208. "parameters": [
  2209. {
  2210. "type": "string",
  2211. "description": "owner of the repo",
  2212. "name": "owner",
  2213. "in": "path",
  2214. "required": true
  2215. },
  2216. {
  2217. "type": "string",
  2218. "description": "name of the repo",
  2219. "name": "repo",
  2220. "in": "path",
  2221. "required": true
  2222. },
  2223. {
  2224. "type": "string",
  2225. "description": "path of the dir, file, symlink or submodule in the repo",
  2226. "name": "filepath",
  2227. "in": "path",
  2228. "required": true
  2229. },
  2230. {
  2231. "type": "string",
  2232. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2233. "name": "ref",
  2234. "in": "query"
  2235. }
  2236. ],
  2237. "responses": {
  2238. "200": {
  2239. "$ref": "#/responses/ContentsResponse"
  2240. }
  2241. }
  2242. },
  2243. "put": {
  2244. "consumes": [
  2245. "application/json"
  2246. ],
  2247. "produces": [
  2248. "application/json"
  2249. ],
  2250. "tags": [
  2251. "repository"
  2252. ],
  2253. "summary": "Update a file in a repository",
  2254. "operationId": "repoUpdateFile",
  2255. "parameters": [
  2256. {
  2257. "type": "string",
  2258. "description": "owner of the repo",
  2259. "name": "owner",
  2260. "in": "path",
  2261. "required": true
  2262. },
  2263. {
  2264. "type": "string",
  2265. "description": "name of the repo",
  2266. "name": "repo",
  2267. "in": "path",
  2268. "required": true
  2269. },
  2270. {
  2271. "type": "string",
  2272. "description": "path of the file to update",
  2273. "name": "filepath",
  2274. "in": "path",
  2275. "required": true
  2276. },
  2277. {
  2278. "name": "body",
  2279. "in": "body",
  2280. "required": true,
  2281. "schema": {
  2282. "$ref": "#/definitions/UpdateFileOptions"
  2283. }
  2284. }
  2285. ],
  2286. "responses": {
  2287. "200": {
  2288. "$ref": "#/responses/FileResponse"
  2289. }
  2290. }
  2291. },
  2292. "post": {
  2293. "consumes": [
  2294. "application/json"
  2295. ],
  2296. "produces": [
  2297. "application/json"
  2298. ],
  2299. "tags": [
  2300. "repository"
  2301. ],
  2302. "summary": "Create a file in a repository",
  2303. "operationId": "repoCreateFile",
  2304. "parameters": [
  2305. {
  2306. "type": "string",
  2307. "description": "owner of the repo",
  2308. "name": "owner",
  2309. "in": "path",
  2310. "required": true
  2311. },
  2312. {
  2313. "type": "string",
  2314. "description": "name of the repo",
  2315. "name": "repo",
  2316. "in": "path",
  2317. "required": true
  2318. },
  2319. {
  2320. "type": "string",
  2321. "description": "path of the file to create",
  2322. "name": "filepath",
  2323. "in": "path",
  2324. "required": true
  2325. },
  2326. {
  2327. "name": "body",
  2328. "in": "body",
  2329. "required": true,
  2330. "schema": {
  2331. "$ref": "#/definitions/CreateFileOptions"
  2332. }
  2333. }
  2334. ],
  2335. "responses": {
  2336. "201": {
  2337. "$ref": "#/responses/FileResponse"
  2338. }
  2339. }
  2340. },
  2341. "delete": {
  2342. "consumes": [
  2343. "application/json"
  2344. ],
  2345. "produces": [
  2346. "application/json"
  2347. ],
  2348. "tags": [
  2349. "repository"
  2350. ],
  2351. "summary": "Delete a file in a repository",
  2352. "operationId": "repoDeleteFile",
  2353. "parameters": [
  2354. {
  2355. "type": "string",
  2356. "description": "owner of the repo",
  2357. "name": "owner",
  2358. "in": "path",
  2359. "required": true
  2360. },
  2361. {
  2362. "type": "string",
  2363. "description": "name of the repo",
  2364. "name": "repo",
  2365. "in": "path",
  2366. "required": true
  2367. },
  2368. {
  2369. "type": "string",
  2370. "description": "path of the file to delete",
  2371. "name": "filepath",
  2372. "in": "path",
  2373. "required": true
  2374. },
  2375. {
  2376. "name": "body",
  2377. "in": "body",
  2378. "required": true,
  2379. "schema": {
  2380. "$ref": "#/definitions/DeleteFileOptions"
  2381. }
  2382. }
  2383. ],
  2384. "responses": {
  2385. "200": {
  2386. "$ref": "#/responses/FileDeleteResponse"
  2387. }
  2388. }
  2389. }
  2390. },
  2391. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2392. "get": {
  2393. "produces": [
  2394. "application/json"
  2395. ],
  2396. "tags": [
  2397. "repository"
  2398. ],
  2399. "summary": "Get the EditorConfig definitions of a file in a repository",
  2400. "operationId": "repoGetEditorConfig",
  2401. "parameters": [
  2402. {
  2403. "type": "string",
  2404. "description": "owner of the repo",
  2405. "name": "owner",
  2406. "in": "path",
  2407. "required": true
  2408. },
  2409. {
  2410. "type": "string",
  2411. "description": "name of the repo",
  2412. "name": "repo",
  2413. "in": "path",
  2414. "required": true
  2415. },
  2416. {
  2417. "type": "string",
  2418. "description": "filepath of file to get",
  2419. "name": "filepath",
  2420. "in": "path",
  2421. "required": true
  2422. }
  2423. ],
  2424. "responses": {
  2425. "200": {
  2426. "description": "success"
  2427. },
  2428. "404": {
  2429. "$ref": "#/responses/notFound"
  2430. }
  2431. }
  2432. }
  2433. },
  2434. "/repos/{owner}/{repo}/forks": {
  2435. "get": {
  2436. "produces": [
  2437. "application/json"
  2438. ],
  2439. "tags": [
  2440. "repository"
  2441. ],
  2442. "summary": "List a repository's forks",
  2443. "operationId": "listForks",
  2444. "parameters": [
  2445. {
  2446. "type": "string",
  2447. "description": "owner of the repo",
  2448. "name": "owner",
  2449. "in": "path",
  2450. "required": true
  2451. },
  2452. {
  2453. "type": "string",
  2454. "description": "name of the repo",
  2455. "name": "repo",
  2456. "in": "path",
  2457. "required": true
  2458. },
  2459. {
  2460. "type": "integer",
  2461. "description": "page number of results to return (1-based)",
  2462. "name": "page",
  2463. "in": "query"
  2464. },
  2465. {
  2466. "type": "integer",
  2467. "description": "page size of results, maximum page size is 50",
  2468. "name": "limit",
  2469. "in": "query"
  2470. }
  2471. ],
  2472. "responses": {
  2473. "200": {
  2474. "$ref": "#/responses/RepositoryList"
  2475. }
  2476. }
  2477. },
  2478. "post": {
  2479. "produces": [
  2480. "application/json"
  2481. ],
  2482. "tags": [
  2483. "repository"
  2484. ],
  2485. "summary": "Fork a repository",
  2486. "operationId": "createFork",
  2487. "parameters": [
  2488. {
  2489. "type": "string",
  2490. "description": "owner of the repo to fork",
  2491. "name": "owner",
  2492. "in": "path",
  2493. "required": true
  2494. },
  2495. {
  2496. "type": "string",
  2497. "description": "name of the repo to fork",
  2498. "name": "repo",
  2499. "in": "path",
  2500. "required": true
  2501. },
  2502. {
  2503. "name": "body",
  2504. "in": "body",
  2505. "schema": {
  2506. "$ref": "#/definitions/CreateForkOption"
  2507. }
  2508. }
  2509. ],
  2510. "responses": {
  2511. "202": {
  2512. "$ref": "#/responses/Repository"
  2513. },
  2514. "403": {
  2515. "$ref": "#/responses/forbidden"
  2516. },
  2517. "422": {
  2518. "$ref": "#/responses/validationError"
  2519. }
  2520. }
  2521. }
  2522. },
  2523. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  2524. "get": {
  2525. "produces": [
  2526. "application/json"
  2527. ],
  2528. "tags": [
  2529. "repository"
  2530. ],
  2531. "summary": "Gets the blob of a repository.",
  2532. "operationId": "GetBlob",
  2533. "parameters": [
  2534. {
  2535. "type": "string",
  2536. "description": "owner of the repo",
  2537. "name": "owner",
  2538. "in": "path",
  2539. "required": true
  2540. },
  2541. {
  2542. "type": "string",
  2543. "description": "name of the repo",
  2544. "name": "repo",
  2545. "in": "path",
  2546. "required": true
  2547. },
  2548. {
  2549. "type": "string",
  2550. "description": "sha of the commit",
  2551. "name": "sha",
  2552. "in": "path",
  2553. "required": true
  2554. }
  2555. ],
  2556. "responses": {
  2557. "200": {
  2558. "$ref": "#/responses/GitBlobResponse"
  2559. },
  2560. "400": {
  2561. "$ref": "#/responses/error"
  2562. }
  2563. }
  2564. }
  2565. },
  2566. "/repos/{owner}/{repo}/git/commits/{sha}": {
  2567. "get": {
  2568. "produces": [
  2569. "application/json"
  2570. ],
  2571. "tags": [
  2572. "repository"
  2573. ],
  2574. "summary": "Get a single commit from a repository",
  2575. "operationId": "repoGetSingleCommit",
  2576. "parameters": [
  2577. {
  2578. "type": "string",
  2579. "description": "owner of the repo",
  2580. "name": "owner",
  2581. "in": "path",
  2582. "required": true
  2583. },
  2584. {
  2585. "type": "string",
  2586. "description": "name of the repo",
  2587. "name": "repo",
  2588. "in": "path",
  2589. "required": true
  2590. },
  2591. {
  2592. "type": "string",
  2593. "description": "the commit hash",
  2594. "name": "sha",
  2595. "in": "path",
  2596. "required": true
  2597. }
  2598. ],
  2599. "responses": {
  2600. "200": {
  2601. "$ref": "#/responses/Commit"
  2602. },
  2603. "404": {
  2604. "$ref": "#/responses/notFound"
  2605. }
  2606. }
  2607. }
  2608. },
  2609. "/repos/{owner}/{repo}/git/refs": {
  2610. "get": {
  2611. "produces": [
  2612. "application/json"
  2613. ],
  2614. "tags": [
  2615. "repository"
  2616. ],
  2617. "summary": "Get specified ref or filtered repository's refs",
  2618. "operationId": "repoListAllGitRefs",
  2619. "parameters": [
  2620. {
  2621. "type": "string",
  2622. "description": "owner of the repo",
  2623. "name": "owner",
  2624. "in": "path",
  2625. "required": true
  2626. },
  2627. {
  2628. "type": "string",
  2629. "description": "name of the repo",
  2630. "name": "repo",
  2631. "in": "path",
  2632. "required": true
  2633. }
  2634. ],
  2635. "responses": {
  2636. "200": {
  2637. "$ref": "#/responses/ReferenceList"
  2638. },
  2639. "404": {
  2640. "$ref": "#/responses/notFound"
  2641. }
  2642. }
  2643. }
  2644. },
  2645. "/repos/{owner}/{repo}/git/refs/{ref}": {
  2646. "get": {
  2647. "produces": [
  2648. "application/json"
  2649. ],
  2650. "tags": [
  2651. "repository"
  2652. ],
  2653. "summary": "Get specified ref or filtered repository's refs",
  2654. "operationId": "repoListGitRefs",
  2655. "parameters": [
  2656. {
  2657. "type": "string",
  2658. "description": "owner of the repo",
  2659. "name": "owner",
  2660. "in": "path",
  2661. "required": true
  2662. },
  2663. {
  2664. "type": "string",
  2665. "description": "name of the repo",
  2666. "name": "repo",
  2667. "in": "path",
  2668. "required": true
  2669. },
  2670. {
  2671. "type": "string",
  2672. "description": "part or full name of the ref",
  2673. "name": "ref",
  2674. "in": "path",
  2675. "required": true
  2676. }
  2677. ],
  2678. "responses": {
  2679. "200": {
  2680. "$ref": "#/responses/ReferenceList"
  2681. },
  2682. "404": {
  2683. "$ref": "#/responses/notFound"
  2684. }
  2685. }
  2686. }
  2687. },
  2688. "/repos/{owner}/{repo}/git/tags/{sha}": {
  2689. "get": {
  2690. "produces": [
  2691. "application/json"
  2692. ],
  2693. "tags": [
  2694. "repository"
  2695. ],
  2696. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  2697. "operationId": "GetTag",
  2698. "parameters": [
  2699. {
  2700. "type": "string",
  2701. "description": "owner of the repo",
  2702. "name": "owner",
  2703. "in": "path",
  2704. "required": true
  2705. },
  2706. {
  2707. "type": "string",
  2708. "description": "name of the repo",
  2709. "name": "repo",
  2710. "in": "path",
  2711. "required": true
  2712. },
  2713. {
  2714. "type": "string",
  2715. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  2716. "name": "sha",
  2717. "in": "path",
  2718. "required": true
  2719. }
  2720. ],
  2721. "responses": {
  2722. "200": {
  2723. "$ref": "#/responses/AnnotatedTag"
  2724. },
  2725. "400": {
  2726. "$ref": "#/responses/error"
  2727. }
  2728. }
  2729. }
  2730. },
  2731. "/repos/{owner}/{repo}/git/trees/{sha}": {
  2732. "get": {
  2733. "produces": [
  2734. "application/json"
  2735. ],
  2736. "tags": [
  2737. "repository"
  2738. ],
  2739. "summary": "Gets the tree of a repository.",
  2740. "operationId": "GetTree",
  2741. "parameters": [
  2742. {
  2743. "type": "string",
  2744. "description": "owner of the repo",
  2745. "name": "owner",
  2746. "in": "path",
  2747. "required": true
  2748. },
  2749. {
  2750. "type": "string",
  2751. "description": "name of the repo",
  2752. "name": "repo",
  2753. "in": "path",
  2754. "required": true
  2755. },
  2756. {
  2757. "type": "string",
  2758. "description": "sha of the commit",
  2759. "name": "sha",
  2760. "in": "path",
  2761. "required": true
  2762. },
  2763. {
  2764. "type": "boolean",
  2765. "description": "show all directories and files",
  2766. "name": "recursive",
  2767. "in": "query"
  2768. },
  2769. {
  2770. "type": "integer",
  2771. "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page",
  2772. "name": "page",
  2773. "in": "query"
  2774. },
  2775. {
  2776. "type": "integer",
  2777. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  2778. "name": "per_page",
  2779. "in": "query"
  2780. }
  2781. ],
  2782. "responses": {
  2783. "200": {
  2784. "$ref": "#/responses/GitTreeResponse"
  2785. },
  2786. "400": {
  2787. "$ref": "#/responses/error"
  2788. }
  2789. }
  2790. }
  2791. },
  2792. "/repos/{owner}/{repo}/hooks": {
  2793. "get": {
  2794. "produces": [
  2795. "application/json"
  2796. ],
  2797. "tags": [
  2798. "repository"
  2799. ],
  2800. "summary": "List the hooks in a repository",
  2801. "operationId": "repoListHooks",
  2802. "parameters": [
  2803. {
  2804. "type": "string",
  2805. "description": "owner of the repo",
  2806. "name": "owner",
  2807. "in": "path",
  2808. "required": true
  2809. },
  2810. {
  2811. "type": "string",
  2812. "description": "name of the repo",
  2813. "name": "repo",
  2814. "in": "path",
  2815. "required": true
  2816. },
  2817. {
  2818. "type": "integer",
  2819. "description": "page number of results to return (1-based)",
  2820. "name": "page",
  2821. "in": "query"
  2822. },
  2823. {
  2824. "type": "integer",
  2825. "description": "page size of results, maximum page size is 50",
  2826. "name": "limit",
  2827. "in": "query"
  2828. }
  2829. ],
  2830. "responses": {
  2831. "200": {
  2832. "$ref": "#/responses/HookList"
  2833. }
  2834. }
  2835. },
  2836. "post": {
  2837. "consumes": [
  2838. "application/json"
  2839. ],
  2840. "produces": [
  2841. "application/json"
  2842. ],
  2843. "tags": [
  2844. "repository"
  2845. ],
  2846. "summary": "Create a hook",
  2847. "operationId": "repoCreateHook",
  2848. "parameters": [
  2849. {
  2850. "type": "string",
  2851. "description": "owner of the repo",
  2852. "name": "owner",
  2853. "in": "path",
  2854. "required": true
  2855. },
  2856. {
  2857. "type": "string",
  2858. "description": "name of the repo",
  2859. "name": "repo",
  2860. "in": "path",
  2861. "required": true
  2862. },
  2863. {
  2864. "name": "body",
  2865. "in": "body",
  2866. "schema": {
  2867. "$ref": "#/definitions/CreateHookOption"
  2868. }
  2869. }
  2870. ],
  2871. "responses": {
  2872. "201": {
  2873. "$ref": "#/responses/Hook"
  2874. }
  2875. }
  2876. }
  2877. },
  2878. "/repos/{owner}/{repo}/hooks/git": {
  2879. "get": {
  2880. "produces": [
  2881. "application/json"
  2882. ],
  2883. "tags": [
  2884. "repository"
  2885. ],
  2886. "summary": "List the Git hooks in a repository",
  2887. "operationId": "repoListGitHooks",
  2888. "parameters": [
  2889. {
  2890. "type": "string",
  2891. "description": "owner of the repo",
  2892. "name": "owner",
  2893. "in": "path",
  2894. "required": true
  2895. },
  2896. {
  2897. "type": "string",
  2898. "description": "name of the repo",
  2899. "name": "repo",
  2900. "in": "path",
  2901. "required": true
  2902. }
  2903. ],
  2904. "responses": {
  2905. "200": {
  2906. "$ref": "#/responses/GitHookList"
  2907. }
  2908. }
  2909. }
  2910. },
  2911. "/repos/{owner}/{repo}/hooks/git/{id}": {
  2912. "get": {
  2913. "produces": [
  2914. "application/json"
  2915. ],
  2916. "tags": [
  2917. "repository"
  2918. ],
  2919. "summary": "Get a Git hook",
  2920. "operationId": "repoGetGitHook",
  2921. "parameters": [
  2922. {
  2923. "type": "string",
  2924. "description": "owner of the repo",
  2925. "name": "owner",
  2926. "in": "path",
  2927. "required": true
  2928. },
  2929. {
  2930. "type": "string",
  2931. "description": "name of the repo",
  2932. "name": "repo",
  2933. "in": "path",
  2934. "required": true
  2935. },
  2936. {
  2937. "type": "string",
  2938. "description": "id of the hook to get",
  2939. "name": "id",
  2940. "in": "path",
  2941. "required": true
  2942. }
  2943. ],
  2944. "responses": {
  2945. "200": {
  2946. "$ref": "#/responses/GitHook"
  2947. },
  2948. "404": {
  2949. "$ref": "#/responses/notFound"
  2950. }
  2951. }
  2952. },
  2953. "delete": {
  2954. "produces": [
  2955. "application/json"
  2956. ],
  2957. "tags": [
  2958. "repository"
  2959. ],
  2960. "summary": "Delete a Git hook in a repository",
  2961. "operationId": "repoDeleteGitHook",
  2962. "parameters": [
  2963. {
  2964. "type": "string",
  2965. "description": "owner of the repo",
  2966. "name": "owner",
  2967. "in": "path",
  2968. "required": true
  2969. },
  2970. {
  2971. "type": "string",
  2972. "description": "name of the repo",
  2973. "name": "repo",
  2974. "in": "path",
  2975. "required": true
  2976. },
  2977. {
  2978. "type": "string",
  2979. "description": "id of the hook to get",
  2980. "name": "id",
  2981. "in": "path",
  2982. "required": true
  2983. }
  2984. ],
  2985. "responses": {
  2986. "204": {
  2987. "$ref": "#/responses/empty"
  2988. },
  2989. "404": {
  2990. "$ref": "#/responses/notFound"
  2991. }
  2992. }
  2993. },
  2994. "patch": {
  2995. "produces": [
  2996. "application/json"
  2997. ],
  2998. "tags": [
  2999. "repository"
  3000. ],
  3001. "summary": "Edit a Git hook in a repository",
  3002. "operationId": "repoEditGitHook",
  3003. "parameters": [
  3004. {
  3005. "type": "string",
  3006. "description": "owner of the repo",
  3007. "name": "owner",
  3008. "in": "path",
  3009. "required": true
  3010. },
  3011. {
  3012. "type": "string",
  3013. "description": "name of the repo",
  3014. "name": "repo",
  3015. "in": "path",
  3016. "required": true
  3017. },
  3018. {
  3019. "type": "string",
  3020. "description": "id of the hook to get",
  3021. "name": "id",
  3022. "in": "path",
  3023. "required": true
  3024. },
  3025. {
  3026. "name": "body",
  3027. "in": "body",
  3028. "schema": {
  3029. "$ref": "#/definitions/EditGitHookOption"
  3030. }
  3031. }
  3032. ],
  3033. "responses": {
  3034. "200": {
  3035. "$ref": "#/responses/GitHook"
  3036. },
  3037. "404": {
  3038. "$ref": "#/responses/notFound"
  3039. }
  3040. }
  3041. }
  3042. },
  3043. "/repos/{owner}/{repo}/hooks/{id}": {
  3044. "get": {
  3045. "produces": [
  3046. "application/json"
  3047. ],
  3048. "tags": [
  3049. "repository"
  3050. ],
  3051. "summary": "Get a hook",
  3052. "operationId": "repoGetHook",
  3053. "parameters": [
  3054. {
  3055. "type": "string",
  3056. "description": "owner of the repo",
  3057. "name": "owner",
  3058. "in": "path",
  3059. "required": true
  3060. },
  3061. {
  3062. "type": "string",
  3063. "description": "name of the repo",
  3064. "name": "repo",
  3065. "in": "path",
  3066. "required": true
  3067. },
  3068. {
  3069. "type": "integer",
  3070. "format": "int64",
  3071. "description": "id of the hook to get",
  3072. "name": "id",
  3073. "in": "path",
  3074. "required": true
  3075. }
  3076. ],
  3077. "responses": {
  3078. "200": {
  3079. "$ref": "#/responses/Hook"
  3080. },
  3081. "404": {
  3082. "$ref": "#/responses/notFound"
  3083. }
  3084. }
  3085. },
  3086. "delete": {
  3087. "produces": [
  3088. "application/json"
  3089. ],
  3090. "tags": [
  3091. "repository"
  3092. ],
  3093. "summary": "Delete a hook in a repository",
  3094. "operationId": "repoDeleteHook",
  3095. "parameters": [
  3096. {
  3097. "type": "string",
  3098. "description": "owner of the repo",
  3099. "name": "owner",
  3100. "in": "path",
  3101. "required": true
  3102. },
  3103. {
  3104. "type": "string",
  3105. "description": "name of the repo",
  3106. "name": "repo",
  3107. "in": "path",
  3108. "required": true
  3109. },
  3110. {
  3111. "type": "integer",
  3112. "format": "int64",
  3113. "description": "id of the hook to delete",
  3114. "name": "id",
  3115. "in": "path",
  3116. "required": true
  3117. }
  3118. ],
  3119. "responses": {
  3120. "204": {
  3121. "$ref": "#/responses/empty"
  3122. },
  3123. "404": {
  3124. "$ref": "#/responses/notFound"
  3125. }
  3126. }
  3127. },
  3128. "patch": {
  3129. "produces": [
  3130. "application/json"
  3131. ],
  3132. "tags": [
  3133. "repository"
  3134. ],
  3135. "summary": "Edit a hook in a repository",
  3136. "operationId": "repoEditHook",
  3137. "parameters": [
  3138. {
  3139. "type": "string",
  3140. "description": "owner of the repo",
  3141. "name": "owner",
  3142. "in": "path",
  3143. "required": true
  3144. },
  3145. {
  3146. "type": "string",
  3147. "description": "name of the repo",
  3148. "name": "repo",
  3149. "in": "path",
  3150. "required": true
  3151. },
  3152. {
  3153. "type": "integer",
  3154. "format": "int64",
  3155. "description": "index of the hook",
  3156. "name": "id",
  3157. "in": "path",
  3158. "required": true
  3159. },
  3160. {
  3161. "name": "body",
  3162. "in": "body",
  3163. "schema": {
  3164. "$ref": "#/definitions/EditHookOption"
  3165. }
  3166. }
  3167. ],
  3168. "responses": {
  3169. "200": {
  3170. "$ref": "#/responses/Hook"
  3171. }
  3172. }
  3173. }
  3174. },
  3175. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3176. "post": {
  3177. "produces": [
  3178. "application/json"
  3179. ],
  3180. "tags": [
  3181. "repository"
  3182. ],
  3183. "summary": "Test a push webhook",
  3184. "operationId": "repoTestHook",
  3185. "parameters": [
  3186. {
  3187. "type": "string",
  3188. "description": "owner of the repo",
  3189. "name": "owner",
  3190. "in": "path",
  3191. "required": true
  3192. },
  3193. {
  3194. "type": "string",
  3195. "description": "name of the repo",
  3196. "name": "repo",
  3197. "in": "path",
  3198. "required": true
  3199. },
  3200. {
  3201. "type": "integer",
  3202. "format": "int64",
  3203. "description": "id of the hook to test",
  3204. "name": "id",
  3205. "in": "path",
  3206. "required": true
  3207. }
  3208. ],
  3209. "responses": {
  3210. "204": {
  3211. "$ref": "#/responses/empty"
  3212. }
  3213. }
  3214. }
  3215. },
  3216. "/repos/{owner}/{repo}/issues": {
  3217. "get": {
  3218. "produces": [
  3219. "application/json"
  3220. ],
  3221. "tags": [
  3222. "issue"
  3223. ],
  3224. "summary": "List a repository's issues",
  3225. "operationId": "issueListIssues",
  3226. "parameters": [
  3227. {
  3228. "type": "string",
  3229. "description": "owner of the repo",
  3230. "name": "owner",
  3231. "in": "path",
  3232. "required": true
  3233. },
  3234. {
  3235. "type": "string",
  3236. "description": "name of the repo",
  3237. "name": "repo",
  3238. "in": "path",
  3239. "required": true
  3240. },
  3241. {
  3242. "type": "string",
  3243. "description": "whether issue is open or closed",
  3244. "name": "state",
  3245. "in": "query"
  3246. },
  3247. {
  3248. "type": "string",
  3249. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3250. "name": "labels",
  3251. "in": "query"
  3252. },
  3253. {
  3254. "type": "string",
  3255. "description": "search string",
  3256. "name": "q",
  3257. "in": "query"
  3258. },
  3259. {
  3260. "type": "string",
  3261. "description": "filter by type (issues / pulls) if set",
  3262. "name": "type",
  3263. "in": "query"
  3264. },
  3265. {
  3266. "type": "integer",
  3267. "description": "page number of results to return (1-based)",
  3268. "name": "page",
  3269. "in": "query"
  3270. },
  3271. {
  3272. "type": "integer",
  3273. "description": "page size of results, maximum page size is 50",
  3274. "name": "limit",
  3275. "in": "query"
  3276. }
  3277. ],
  3278. "responses": {
  3279. "200": {
  3280. "$ref": "#/responses/IssueList"
  3281. }
  3282. }
  3283. },
  3284. "post": {
  3285. "consumes": [
  3286. "application/json"
  3287. ],
  3288. "produces": [
  3289. "application/json"
  3290. ],
  3291. "tags": [
  3292. "issue"
  3293. ],
  3294. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3295. "operationId": "issueCreateIssue",
  3296. "parameters": [
  3297. {
  3298. "type": "string",
  3299. "description": "owner of the repo",
  3300. "name": "owner",
  3301. "in": "path",
  3302. "required": true
  3303. },
  3304. {
  3305. "type": "string",
  3306. "description": "name of the repo",
  3307. "name": "repo",
  3308. "in": "path",
  3309. "required": true
  3310. },
  3311. {
  3312. "name": "body",
  3313. "in": "body",
  3314. "schema": {
  3315. "$ref": "#/definitions/CreateIssueOption"
  3316. }
  3317. }
  3318. ],
  3319. "responses": {
  3320. "201": {
  3321. "$ref": "#/responses/Issue"
  3322. },
  3323. "403": {
  3324. "$ref": "#/responses/forbidden"
  3325. },
  3326. "412": {
  3327. "$ref": "#/responses/error"
  3328. },
  3329. "422": {
  3330. "$ref": "#/responses/validationError"
  3331. }
  3332. }
  3333. }
  3334. },
  3335. "/repos/{owner}/{repo}/issues/comments": {
  3336. "get": {
  3337. "produces": [
  3338. "application/json"
  3339. ],
  3340. "tags": [
  3341. "issue"
  3342. ],
  3343. "summary": "List all comments in a repository",
  3344. "operationId": "issueGetRepoComments",
  3345. "parameters": [
  3346. {
  3347. "type": "string",
  3348. "description": "owner of the repo",
  3349. "name": "owner",
  3350. "in": "path",
  3351. "required": true
  3352. },
  3353. {
  3354. "type": "string",
  3355. "description": "name of the repo",
  3356. "name": "repo",
  3357. "in": "path",
  3358. "required": true
  3359. },
  3360. {
  3361. "type": "string",
  3362. "format": "date-time",
  3363. "description": "if provided, only comments updated since the provided time are returned.",
  3364. "name": "since",
  3365. "in": "query"
  3366. },
  3367. {
  3368. "type": "string",
  3369. "format": "date-time",
  3370. "description": "if provided, only comments updated before the provided time are returned.",
  3371. "name": "before",
  3372. "in": "query"
  3373. },
  3374. {
  3375. "type": "integer",
  3376. "description": "page number of results to return (1-based)",
  3377. "name": "page",
  3378. "in": "query"
  3379. },
  3380. {
  3381. "type": "integer",
  3382. "description": "page size of results, maximum page size is 50",
  3383. "name": "limit",
  3384. "in": "query"
  3385. }
  3386. ],
  3387. "responses": {
  3388. "200": {
  3389. "$ref": "#/responses/CommentList"
  3390. }
  3391. }
  3392. }
  3393. },
  3394. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3395. "get": {
  3396. "consumes": [
  3397. "application/json"
  3398. ],
  3399. "produces": [
  3400. "application/json"
  3401. ],
  3402. "tags": [
  3403. "issue"
  3404. ],
  3405. "summary": "Get a comment",
  3406. "operationId": "issueGetComment",
  3407. "parameters": [
  3408. {
  3409. "type": "string",
  3410. "description": "owner of the repo",
  3411. "name": "owner",
  3412. "in": "path",
  3413. "required": true
  3414. },
  3415. {
  3416. "type": "string",
  3417. "description": "name of the repo",
  3418. "name": "repo",
  3419. "in": "path",
  3420. "required": true
  3421. },
  3422. {
  3423. "type": "integer",
  3424. "format": "int64",
  3425. "description": "id of the comment",
  3426. "name": "id",
  3427. "in": "path",
  3428. "required": true
  3429. }
  3430. ],
  3431. "responses": {
  3432. "200": {
  3433. "$ref": "#/responses/Comment"
  3434. },
  3435. "204": {
  3436. "$ref": "#/responses/empty"
  3437. },
  3438. "403": {
  3439. "$ref": "#/responses/forbidden"
  3440. },
  3441. "404": {
  3442. "$ref": "#/responses/notFound"
  3443. }
  3444. }
  3445. },
  3446. "delete": {
  3447. "tags": [
  3448. "issue"
  3449. ],
  3450. "summary": "Delete a comment",
  3451. "operationId": "issueDeleteComment",
  3452. "parameters": [
  3453. {
  3454. "type": "string",
  3455. "description": "owner of the repo",
  3456. "name": "owner",
  3457. "in": "path",
  3458. "required": true
  3459. },
  3460. {
  3461. "type": "string",
  3462. "description": "name of the repo",
  3463. "name": "repo",
  3464. "in": "path",
  3465. "required": true
  3466. },
  3467. {
  3468. "type": "integer",
  3469. "format": "int64",
  3470. "description": "id of comment to delete",
  3471. "name": "id",
  3472. "in": "path",
  3473. "required": true
  3474. }
  3475. ],
  3476. "responses": {
  3477. "204": {
  3478. "$ref": "#/responses/empty"
  3479. },
  3480. "403": {
  3481. "$ref": "#/responses/forbidden"
  3482. },
  3483. "404": {
  3484. "$ref": "#/responses/notFound"
  3485. }
  3486. }
  3487. },
  3488. "patch": {
  3489. "consumes": [
  3490. "application/json"
  3491. ],
  3492. "produces": [
  3493. "application/json"
  3494. ],
  3495. "tags": [
  3496. "issue"
  3497. ],
  3498. "summary": "Edit a comment",
  3499. "operationId": "issueEditComment",
  3500. "parameters": [
  3501. {
  3502. "type": "string",
  3503. "description": "owner of the repo",
  3504. "name": "owner",
  3505. "in": "path",
  3506. "required": true
  3507. },
  3508. {
  3509. "type": "string",
  3510. "description": "name of the repo",
  3511. "name": "repo",
  3512. "in": "path",
  3513. "required": true
  3514. },
  3515. {
  3516. "type": "integer",
  3517. "format": "int64",
  3518. "description": "id of the comment to edit",
  3519. "name": "id",
  3520. "in": "path",
  3521. "required": true
  3522. },
  3523. {
  3524. "name": "body",
  3525. "in": "body",
  3526. "schema": {
  3527. "$ref": "#/definitions/EditIssueCommentOption"
  3528. }
  3529. }
  3530. ],
  3531. "responses": {
  3532. "200": {
  3533. "$ref": "#/responses/Comment"
  3534. },
  3535. "204": {
  3536. "$ref": "#/responses/empty"
  3537. },
  3538. "403": {
  3539. "$ref": "#/responses/forbidden"
  3540. },
  3541. "404": {
  3542. "$ref": "#/responses/notFound"
  3543. }
  3544. }
  3545. }
  3546. },
  3547. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  3548. "get": {
  3549. "consumes": [
  3550. "application/json"
  3551. ],
  3552. "produces": [
  3553. "application/json"
  3554. ],
  3555. "tags": [
  3556. "issue"
  3557. ],
  3558. "summary": "Get a list of reactions from a comment of an issue",
  3559. "operationId": "issueGetCommentReactions",
  3560. "parameters": [
  3561. {
  3562. "type": "string",
  3563. "description": "owner of the repo",
  3564. "name": "owner",
  3565. "in": "path",
  3566. "required": true
  3567. },
  3568. {
  3569. "type": "string",
  3570. "description": "name of the repo",
  3571. "name": "repo",
  3572. "in": "path",
  3573. "required": true
  3574. },
  3575. {
  3576. "type": "integer",
  3577. "format": "int64",
  3578. "description": "id of the comment to edit",
  3579. "name": "id",
  3580. "in": "path",
  3581. "required": true
  3582. }
  3583. ],
  3584. "responses": {
  3585. "200": {
  3586. "$ref": "#/responses/ReactionList"
  3587. },
  3588. "403": {
  3589. "$ref": "#/responses/forbidden"
  3590. }
  3591. }
  3592. },
  3593. "post": {
  3594. "consumes": [
  3595. "application/json"
  3596. ],
  3597. "produces": [
  3598. "application/json"
  3599. ],
  3600. "tags": [
  3601. "issue"
  3602. ],
  3603. "summary": "Add a reaction to a comment of an issue",
  3604. "operationId": "issuePostCommentReaction",
  3605. "parameters": [
  3606. {
  3607. "type": "string",
  3608. "description": "owner of the repo",
  3609. "name": "owner",
  3610. "in": "path",
  3611. "required": true
  3612. },
  3613. {
  3614. "type": "string",
  3615. "description": "name of the repo",
  3616. "name": "repo",
  3617. "in": "path",
  3618. "required": true
  3619. },
  3620. {
  3621. "type": "integer",
  3622. "format": "int64",
  3623. "description": "id of the comment to edit",
  3624. "name": "id",
  3625. "in": "path",
  3626. "required": true
  3627. },
  3628. {
  3629. "name": "content",
  3630. "in": "body",
  3631. "schema": {
  3632. "$ref": "#/definitions/EditReactionOption"
  3633. }
  3634. }
  3635. ],
  3636. "responses": {
  3637. "200": {
  3638. "$ref": "#/responses/Reaction"
  3639. },
  3640. "201": {
  3641. "$ref": "#/responses/Reaction"
  3642. },
  3643. "403": {
  3644. "$ref": "#/responses/forbidden"
  3645. }
  3646. }
  3647. },
  3648. "delete": {
  3649. "consumes": [
  3650. "application/json"
  3651. ],
  3652. "produces": [
  3653. "application/json"
  3654. ],
  3655. "tags": [
  3656. "issue"
  3657. ],
  3658. "summary": "Remove a reaction from a comment of an issue",
  3659. "operationId": "issueDeleteCommentReaction",
  3660. "parameters": [
  3661. {
  3662. "type": "string",
  3663. "description": "owner of the repo",
  3664. "name": "owner",
  3665. "in": "path",
  3666. "required": true
  3667. },
  3668. {
  3669. "type": "string",
  3670. "description": "name of the repo",
  3671. "name": "repo",
  3672. "in": "path",
  3673. "required": true
  3674. },
  3675. {
  3676. "type": "integer",
  3677. "format": "int64",
  3678. "description": "id of the comment to edit",
  3679. "name": "id",
  3680. "in": "path",
  3681. "required": true
  3682. },
  3683. {
  3684. "name": "content",
  3685. "in": "body",
  3686. "schema": {
  3687. "$ref": "#/definitions/EditReactionOption"
  3688. }
  3689. }
  3690. ],
  3691. "responses": {
  3692. "200": {
  3693. "$ref": "#/responses/empty"
  3694. },
  3695. "403": {
  3696. "$ref": "#/responses/forbidden"
  3697. }
  3698. }
  3699. }
  3700. },
  3701. "/repos/{owner}/{repo}/issues/{index}": {
  3702. "get": {
  3703. "produces": [
  3704. "application/json"
  3705. ],
  3706. "tags": [
  3707. "issue"
  3708. ],
  3709. "summary": "Get an issue",
  3710. "operationId": "issueGetIssue",
  3711. "parameters": [
  3712. {
  3713. "type": "string",
  3714. "description": "owner of the repo",
  3715. "name": "owner",
  3716. "in": "path",
  3717. "required": true
  3718. },
  3719. {
  3720. "type": "string",
  3721. "description": "name of the repo",
  3722. "name": "repo",
  3723. "in": "path",
  3724. "required": true
  3725. },
  3726. {
  3727. "type": "integer",
  3728. "format": "int64",
  3729. "description": "index of the issue to get",
  3730. "name": "index",
  3731. "in": "path",
  3732. "required": true
  3733. }
  3734. ],
  3735. "responses": {
  3736. "200": {
  3737. "$ref": "#/responses/Issue"
  3738. },
  3739. "404": {
  3740. "$ref": "#/responses/notFound"
  3741. }
  3742. }
  3743. },
  3744. "patch": {
  3745. "consumes": [
  3746. "application/json"
  3747. ],
  3748. "produces": [
  3749. "application/json"
  3750. ],
  3751. "tags": [
  3752. "issue"
  3753. ],
  3754. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3755. "operationId": "issueEditIssue",
  3756. "parameters": [
  3757. {
  3758. "type": "string",
  3759. "description": "owner of the repo",
  3760. "name": "owner",
  3761. "in": "path",
  3762. "required": true
  3763. },
  3764. {
  3765. "type": "string",
  3766. "description": "name of the repo",
  3767. "name": "repo",
  3768. "in": "path",
  3769. "required": true
  3770. },
  3771. {
  3772. "type": "integer",
  3773. "format": "int64",
  3774. "description": "index of the issue to edit",
  3775. "name": "index",
  3776. "in": "path",
  3777. "required": true
  3778. },
  3779. {
  3780. "name": "body",
  3781. "in": "body",
  3782. "schema": {
  3783. "$ref": "#/definitions/EditIssueOption"
  3784. }
  3785. }
  3786. ],
  3787. "responses": {
  3788. "201": {
  3789. "$ref": "#/responses/Issue"
  3790. },
  3791. "403": {
  3792. "$ref": "#/responses/forbidden"
  3793. },
  3794. "404": {
  3795. "$ref": "#/responses/notFound"
  3796. },
  3797. "412": {
  3798. "$ref": "#/responses/error"
  3799. }
  3800. }
  3801. }
  3802. },
  3803. "/repos/{owner}/{repo}/issues/{index}/comments": {
  3804. "get": {
  3805. "produces": [
  3806. "application/json"
  3807. ],
  3808. "tags": [
  3809. "issue"
  3810. ],
  3811. "summary": "List all comments on an issue",
  3812. "operationId": "issueGetComments",
  3813. "parameters": [
  3814. {
  3815. "type": "string",
  3816. "description": "owner of the repo",
  3817. "name": "owner",
  3818. "in": "path",
  3819. "required": true
  3820. },
  3821. {
  3822. "type": "string",
  3823. "description": "name of the repo",
  3824. "name": "repo",
  3825. "in": "path",
  3826. "required": true
  3827. },
  3828. {
  3829. "type": "integer",
  3830. "format": "int64",
  3831. "description": "index of the issue",
  3832. "name": "index",
  3833. "in": "path",
  3834. "required": true
  3835. },
  3836. {
  3837. "type": "string",
  3838. "format": "date-time",
  3839. "description": "if provided, only comments updated since the specified time are returned.",
  3840. "name": "since",
  3841. "in": "query"
  3842. },
  3843. {
  3844. "type": "string",
  3845. "format": "date-time",
  3846. "description": "if provided, only comments updated before the provided time are returned.",
  3847. "name": "before",
  3848. "in": "query"
  3849. }
  3850. ],
  3851. "responses": {
  3852. "200": {
  3853. "$ref": "#/responses/CommentList"
  3854. }
  3855. }
  3856. },
  3857. "post": {
  3858. "consumes": [
  3859. "application/json"
  3860. ],
  3861. "produces": [
  3862. "application/json"
  3863. ],
  3864. "tags": [
  3865. "issue"
  3866. ],
  3867. "summary": "Add a comment to an issue",
  3868. "operationId": "issueCreateComment",
  3869. "parameters": [
  3870. {
  3871. "type": "string",
  3872. "description": "owner of the repo",
  3873. "name": "owner",
  3874. "in": "path",
  3875. "required": true
  3876. },
  3877. {
  3878. "type": "string",
  3879. "description": "name of the repo",
  3880. "name": "repo",
  3881. "in": "path",
  3882. "required": true
  3883. },
  3884. {
  3885. "type": "integer",
  3886. "format": "int64",
  3887. "description": "index of the issue",
  3888. "name": "index",
  3889. "in": "path",
  3890. "required": true
  3891. },
  3892. {
  3893. "name": "body",
  3894. "in": "body",
  3895. "schema": {
  3896. "$ref": "#/definitions/CreateIssueCommentOption"
  3897. }
  3898. }
  3899. ],
  3900. "responses": {
  3901. "201": {
  3902. "$ref": "#/responses/Comment"
  3903. },
  3904. "403": {
  3905. "$ref": "#/responses/forbidden"
  3906. }
  3907. }
  3908. }
  3909. },
  3910. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  3911. "delete": {
  3912. "tags": [
  3913. "issue"
  3914. ],
  3915. "summary": "Delete a comment",
  3916. "operationId": "issueDeleteCommentDeprecated",
  3917. "deprecated": true,
  3918. "parameters": [
  3919. {
  3920. "type": "string",
  3921. "description": "owner of the repo",
  3922. "name": "owner",
  3923. "in": "path",
  3924. "required": true
  3925. },
  3926. {
  3927. "type": "string",
  3928. "description": "name of the repo",
  3929. "name": "repo",
  3930. "in": "path",
  3931. "required": true
  3932. },
  3933. {
  3934. "type": "integer",
  3935. "description": "this parameter is ignored",
  3936. "name": "index",
  3937. "in": "path",
  3938. "required": true
  3939. },
  3940. {
  3941. "type": "integer",
  3942. "format": "int64",
  3943. "description": "id of comment to delete",
  3944. "name": "id",
  3945. "in": "path",
  3946. "required": true
  3947. }
  3948. ],
  3949. "responses": {
  3950. "204": {
  3951. "$ref": "#/responses/empty"
  3952. },
  3953. "403": {
  3954. "$ref": "#/responses/forbidden"
  3955. },
  3956. "404": {
  3957. "$ref": "#/responses/notFound"
  3958. }
  3959. }
  3960. },
  3961. "patch": {
  3962. "consumes": [
  3963. "application/json"
  3964. ],
  3965. "produces": [
  3966. "application/json"
  3967. ],
  3968. "tags": [
  3969. "issue"
  3970. ],
  3971. "summary": "Edit a comment",
  3972. "operationId": "issueEditCommentDeprecated",
  3973. "deprecated": true,
  3974. "parameters": [
  3975. {
  3976. "type": "string",
  3977. "description": "owner of the repo",
  3978. "name": "owner",
  3979. "in": "path",
  3980. "required": true
  3981. },
  3982. {
  3983. "type": "string",
  3984. "description": "name of the repo",
  3985. "name": "repo",
  3986. "in": "path",
  3987. "required": true
  3988. },
  3989. {
  3990. "type": "integer",
  3991. "description": "this parameter is ignored",
  3992. "name": "index",
  3993. "in": "path",
  3994. "required": true
  3995. },
  3996. {
  3997. "type": "integer",
  3998. "format": "int64",
  3999. "description": "id of the comment to edit",
  4000. "name": "id",
  4001. "in": "path",
  4002. "required": true
  4003. },
  4004. {
  4005. "name": "body",
  4006. "in": "body",
  4007. "schema": {
  4008. "$ref": "#/definitions/EditIssueCommentOption"
  4009. }
  4010. }
  4011. ],
  4012. "responses": {
  4013. "200": {
  4014. "$ref": "#/responses/Comment"
  4015. },
  4016. "204": {
  4017. "$ref": "#/responses/empty"
  4018. },
  4019. "403": {
  4020. "$ref": "#/responses/forbidden"
  4021. },
  4022. "404": {
  4023. "$ref": "#/responses/notFound"
  4024. }
  4025. }
  4026. }
  4027. },
  4028. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4029. "post": {
  4030. "consumes": [
  4031. "application/json"
  4032. ],
  4033. "produces": [
  4034. "application/json"
  4035. ],
  4036. "tags": [
  4037. "issue"
  4038. ],
  4039. "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.",
  4040. "operationId": "issueEditIssueDeadline",
  4041. "parameters": [
  4042. {
  4043. "type": "string",
  4044. "description": "owner of the repo",
  4045. "name": "owner",
  4046. "in": "path",
  4047. "required": true
  4048. },
  4049. {
  4050. "type": "string",
  4051. "description": "name of the repo",
  4052. "name": "repo",
  4053. "in": "path",
  4054. "required": true
  4055. },
  4056. {
  4057. "type": "integer",
  4058. "format": "int64",
  4059. "description": "index of the issue to create or update a deadline on",
  4060. "name": "index",
  4061. "in": "path",
  4062. "required": true
  4063. },
  4064. {
  4065. "name": "body",
  4066. "in": "body",
  4067. "schema": {
  4068. "$ref": "#/definitions/EditDeadlineOption"
  4069. }
  4070. }
  4071. ],
  4072. "responses": {
  4073. "201": {
  4074. "$ref": "#/responses/IssueDeadline"
  4075. },
  4076. "403": {
  4077. "$ref": "#/responses/forbidden"
  4078. },
  4079. "404": {
  4080. "$ref": "#/responses/notFound"
  4081. }
  4082. }
  4083. }
  4084. },
  4085. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4086. "get": {
  4087. "produces": [
  4088. "application/json"
  4089. ],
  4090. "tags": [
  4091. "issue"
  4092. ],
  4093. "summary": "Get an issue's labels",
  4094. "operationId": "issueGetLabels",
  4095. "parameters": [
  4096. {
  4097. "type": "string",
  4098. "description": "owner of the repo",
  4099. "name": "owner",
  4100. "in": "path",
  4101. "required": true
  4102. },
  4103. {
  4104. "type": "string",
  4105. "description": "name of the repo",
  4106. "name": "repo",
  4107. "in": "path",
  4108. "required": true
  4109. },
  4110. {
  4111. "type": "integer",
  4112. "format": "int64",
  4113. "description": "index of the issue",
  4114. "name": "index",
  4115. "in": "path",
  4116. "required": true
  4117. }
  4118. ],
  4119. "responses": {
  4120. "200": {
  4121. "$ref": "#/responses/LabelList"
  4122. },
  4123. "404": {
  4124. "$ref": "#/responses/notFound"
  4125. }
  4126. }
  4127. },
  4128. "put": {
  4129. "consumes": [
  4130. "application/json"
  4131. ],
  4132. "produces": [
  4133. "application/json"
  4134. ],
  4135. "tags": [
  4136. "issue"
  4137. ],
  4138. "summary": "Replace an issue's labels",
  4139. "operationId": "issueReplaceLabels",
  4140. "parameters": [
  4141. {
  4142. "type": "string",
  4143. "description": "owner of the repo",
  4144. "name": "owner",
  4145. "in": "path",
  4146. "required": true
  4147. },
  4148. {
  4149. "type": "string",
  4150. "description": "name of the repo",
  4151. "name": "repo",
  4152. "in": "path",
  4153. "required": true
  4154. },
  4155. {
  4156. "type": "integer",
  4157. "format": "int64",
  4158. "description": "index of the issue",
  4159. "name": "index",
  4160. "in": "path",
  4161. "required": true
  4162. },
  4163. {
  4164. "name": "body",
  4165. "in": "body",
  4166. "schema": {
  4167. "$ref": "#/definitions/IssueLabelsOption"
  4168. }
  4169. }
  4170. ],
  4171. "responses": {
  4172. "200": {
  4173. "$ref": "#/responses/LabelList"
  4174. },
  4175. "403": {
  4176. "$ref": "#/responses/forbidden"
  4177. }
  4178. }
  4179. },
  4180. "post": {
  4181. "consumes": [
  4182. "application/json"
  4183. ],
  4184. "produces": [
  4185. "application/json"
  4186. ],
  4187. "tags": [
  4188. "issue"
  4189. ],
  4190. "summary": "Add a label to an issue",
  4191. "operationId": "issueAddLabel",
  4192. "parameters": [
  4193. {
  4194. "type": "string",
  4195. "description": "owner of the repo",
  4196. "name": "owner",
  4197. "in": "path",
  4198. "required": true
  4199. },
  4200. {
  4201. "type": "string",
  4202. "description": "name of the repo",
  4203. "name": "repo",
  4204. "in": "path",
  4205. "required": true
  4206. },
  4207. {
  4208. "type": "integer",
  4209. "format": "int64",
  4210. "description": "index of the issue",
  4211. "name": "index",
  4212. "in": "path",
  4213. "required": true
  4214. },
  4215. {
  4216. "name": "body",
  4217. "in": "body",
  4218. "schema": {
  4219. "$ref": "#/definitions/IssueLabelsOption"
  4220. }
  4221. }
  4222. ],
  4223. "responses": {
  4224. "200": {
  4225. "$ref": "#/responses/LabelList"
  4226. },
  4227. "403": {
  4228. "$ref": "#/responses/forbidden"
  4229. }
  4230. }
  4231. },
  4232. "delete": {
  4233. "produces": [
  4234. "application/json"
  4235. ],
  4236. "tags": [
  4237. "issue"
  4238. ],
  4239. "summary": "Remove all labels from an issue",
  4240. "operationId": "issueClearLabels",
  4241. "parameters": [
  4242. {
  4243. "type": "string",
  4244. "description": "owner of the repo",
  4245. "name": "owner",
  4246. "in": "path",
  4247. "required": true
  4248. },
  4249. {
  4250. "type": "string",
  4251. "description": "name of the repo",
  4252. "name": "repo",
  4253. "in": "path",
  4254. "required": true
  4255. },
  4256. {
  4257. "type": "integer",
  4258. "format": "int64",
  4259. "description": "index of the issue",
  4260. "name": "index",
  4261. "in": "path",
  4262. "required": true
  4263. }
  4264. ],
  4265. "responses": {
  4266. "204": {
  4267. "$ref": "#/responses/empty"
  4268. },
  4269. "403": {
  4270. "$ref": "#/responses/forbidden"
  4271. }
  4272. }
  4273. }
  4274. },
  4275. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4276. "delete": {
  4277. "produces": [
  4278. "application/json"
  4279. ],
  4280. "tags": [
  4281. "issue"
  4282. ],
  4283. "summary": "Remove a label from an issue",
  4284. "operationId": "issueRemoveLabel",
  4285. "parameters": [
  4286. {
  4287. "type": "string",
  4288. "description": "owner of the repo",
  4289. "name": "owner",
  4290. "in": "path",
  4291. "required": true
  4292. },
  4293. {
  4294. "type": "string",
  4295. "description": "name of the repo",
  4296. "name": "repo",
  4297. "in": "path",
  4298. "required": true
  4299. },
  4300. {
  4301. "type": "integer",
  4302. "format": "int64",
  4303. "description": "index of the issue",
  4304. "name": "index",
  4305. "in": "path",
  4306. "required": true
  4307. },
  4308. {
  4309. "type": "integer",
  4310. "format": "int64",
  4311. "description": "id of the label to remove",
  4312. "name": "id",
  4313. "in": "path",
  4314. "required": true
  4315. }
  4316. ],
  4317. "responses": {
  4318. "204": {
  4319. "$ref": "#/responses/empty"
  4320. },
  4321. "403": {
  4322. "$ref": "#/responses/forbidden"
  4323. },
  4324. "422": {
  4325. "$ref": "#/responses/validationError"
  4326. }
  4327. }
  4328. }
  4329. },
  4330. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4331. "get": {
  4332. "consumes": [
  4333. "application/json"
  4334. ],
  4335. "produces": [
  4336. "application/json"
  4337. ],
  4338. "tags": [
  4339. "issue"
  4340. ],
  4341. "summary": "Get a list reactions of an issue",
  4342. "operationId": "issueGetIssueReactions",
  4343. "parameters": [
  4344. {
  4345. "type": "string",
  4346. "description": "owner of the repo",
  4347. "name": "owner",
  4348. "in": "path",
  4349. "required": true
  4350. },
  4351. {
  4352. "type": "string",
  4353. "description": "name of the repo",
  4354. "name": "repo",
  4355. "in": "path",
  4356. "required": true
  4357. },
  4358. {
  4359. "type": "integer",
  4360. "format": "int64",
  4361. "description": "index of the issue",
  4362. "name": "index",
  4363. "in": "path",
  4364. "required": true
  4365. },
  4366. {
  4367. "type": "integer",
  4368. "description": "page number of results to return (1-based)",
  4369. "name": "page",
  4370. "in": "query"
  4371. },
  4372. {
  4373. "type": "integer",
  4374. "description": "page size of results, maximum page size is 50",
  4375. "name": "limit",
  4376. "in": "query"
  4377. }
  4378. ],
  4379. "responses": {
  4380. "200": {
  4381. "$ref": "#/responses/ReactionList"
  4382. },
  4383. "403": {
  4384. "$ref": "#/responses/forbidden"
  4385. }
  4386. }
  4387. },
  4388. "post": {
  4389. "consumes": [
  4390. "application/json"
  4391. ],
  4392. "produces": [
  4393. "application/json"
  4394. ],
  4395. "tags": [
  4396. "issue"
  4397. ],
  4398. "summary": "Add a reaction to an issue",
  4399. "operationId": "issuePostIssueReaction",
  4400. "parameters": [
  4401. {
  4402. "type": "string",
  4403. "description": "owner of the repo",
  4404. "name": "owner",
  4405. "in": "path",
  4406. "required": true
  4407. },
  4408. {
  4409. "type": "string",
  4410. "description": "name of the repo",
  4411. "name": "repo",
  4412. "in": "path",
  4413. "required": true
  4414. },
  4415. {
  4416. "type": "integer",
  4417. "format": "int64",
  4418. "description": "index of the issue",
  4419. "name": "index",
  4420. "in": "path",
  4421. "required": true
  4422. },
  4423. {
  4424. "name": "content",
  4425. "in": "body",
  4426. "schema": {
  4427. "$ref": "#/definitions/EditReactionOption"
  4428. }
  4429. }
  4430. ],
  4431. "responses": {
  4432. "200": {
  4433. "$ref": "#/responses/Reaction"
  4434. },
  4435. "201": {
  4436. "$ref": "#/responses/Reaction"
  4437. },
  4438. "403": {
  4439. "$ref": "#/responses/forbidden"
  4440. }
  4441. }
  4442. },
  4443. "delete": {
  4444. "consumes": [
  4445. "application/json"
  4446. ],
  4447. "produces": [
  4448. "application/json"
  4449. ],
  4450. "tags": [
  4451. "issue"
  4452. ],
  4453. "summary": "Remove a reaction from an issue",
  4454. "operationId": "issueDeleteIssueReaction",
  4455. "parameters": [
  4456. {
  4457. "type": "string",
  4458. "description": "owner of the repo",
  4459. "name": "owner",
  4460. "in": "path",
  4461. "required": true
  4462. },
  4463. {
  4464. "type": "string",
  4465. "description": "name of the repo",
  4466. "name": "repo",
  4467. "in": "path",
  4468. "required": true
  4469. },
  4470. {
  4471. "type": "integer",
  4472. "format": "int64",
  4473. "description": "index of the issue",
  4474. "name": "index",
  4475. "in": "path",
  4476. "required": true
  4477. },
  4478. {
  4479. "name": "content",
  4480. "in": "body",
  4481. "schema": {
  4482. "$ref": "#/definitions/EditReactionOption"
  4483. }
  4484. }
  4485. ],
  4486. "responses": {
  4487. "200": {
  4488. "$ref": "#/responses/empty"
  4489. },
  4490. "403": {
  4491. "$ref": "#/responses/forbidden"
  4492. }
  4493. }
  4494. }
  4495. },
  4496. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4497. "delete": {
  4498. "consumes": [
  4499. "application/json"
  4500. ],
  4501. "produces": [
  4502. "application/json"
  4503. ],
  4504. "tags": [
  4505. "issue"
  4506. ],
  4507. "summary": "Delete an issue's existing stopwatch.",
  4508. "operationId": "issueDeleteStopWatch",
  4509. "parameters": [
  4510. {
  4511. "type": "string",
  4512. "description": "owner of the repo",
  4513. "name": "owner",
  4514. "in": "path",
  4515. "required": true
  4516. },
  4517. {
  4518. "type": "string",
  4519. "description": "name of the repo",
  4520. "name": "repo",
  4521. "in": "path",
  4522. "required": true
  4523. },
  4524. {
  4525. "type": "integer",
  4526. "format": "int64",
  4527. "description": "index of the issue to stop the stopwatch on",
  4528. "name": "index",
  4529. "in": "path",
  4530. "required": true
  4531. }
  4532. ],
  4533. "responses": {
  4534. "204": {
  4535. "$ref": "#/responses/empty"
  4536. },
  4537. "403": {
  4538. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4539. },
  4540. "404": {
  4541. "$ref": "#/responses/notFound"
  4542. },
  4543. "409": {
  4544. "description": "Cannot cancel a non existent stopwatch"
  4545. }
  4546. }
  4547. }
  4548. },
  4549. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  4550. "post": {
  4551. "consumes": [
  4552. "application/json"
  4553. ],
  4554. "produces": [
  4555. "application/json"
  4556. ],
  4557. "tags": [
  4558. "issue"
  4559. ],
  4560. "summary": "Start stopwatch on an issue.",
  4561. "operationId": "issueStartStopWatch",
  4562. "parameters": [
  4563. {
  4564. "type": "string",
  4565. "description": "owner of the repo",
  4566. "name": "owner",
  4567. "in": "path",
  4568. "required": true
  4569. },
  4570. {
  4571. "type": "string",
  4572. "description": "name of the repo",
  4573. "name": "repo",
  4574. "in": "path",
  4575. "required": true
  4576. },
  4577. {
  4578. "type": "integer",
  4579. "format": "int64",
  4580. "description": "index of the issue to create the stopwatch on",
  4581. "name": "index",
  4582. "in": "path",
  4583. "required": true
  4584. }
  4585. ],
  4586. "responses": {
  4587. "201": {
  4588. "$ref": "#/responses/empty"
  4589. },
  4590. "403": {
  4591. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4592. },
  4593. "404": {
  4594. "$ref": "#/responses/notFound"
  4595. },
  4596. "409": {
  4597. "description": "Cannot start a stopwatch again if it already exists"
  4598. }
  4599. }
  4600. }
  4601. },
  4602. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  4603. "post": {
  4604. "consumes": [
  4605. "application/json"
  4606. ],
  4607. "produces": [
  4608. "application/json"
  4609. ],
  4610. "tags": [
  4611. "issue"
  4612. ],
  4613. "summary": "Stop an issue's existing stopwatch.",
  4614. "operationId": "issueStopStopWatch",
  4615. "parameters": [
  4616. {
  4617. "type": "string",
  4618. "description": "owner of the repo",
  4619. "name": "owner",
  4620. "in": "path",
  4621. "required": true
  4622. },
  4623. {
  4624. "type": "string",
  4625. "description": "name of the repo",
  4626. "name": "repo",
  4627. "in": "path",
  4628. "required": true
  4629. },
  4630. {
  4631. "type": "integer",
  4632. "format": "int64",
  4633. "description": "index of the issue to stop the stopwatch on",
  4634. "name": "index",
  4635. "in": "path",
  4636. "required": true
  4637. }
  4638. ],
  4639. "responses": {
  4640. "201": {
  4641. "$ref": "#/responses/empty"
  4642. },
  4643. "403": {
  4644. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4645. },
  4646. "404": {
  4647. "$ref": "#/responses/notFound"
  4648. },
  4649. "409": {
  4650. "description": "Cannot stop a non existent stopwatch"
  4651. }
  4652. }
  4653. }
  4654. },
  4655. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  4656. "get": {
  4657. "consumes": [
  4658. "application/json"
  4659. ],
  4660. "produces": [
  4661. "application/json"
  4662. ],
  4663. "tags": [
  4664. "issue"
  4665. ],
  4666. "summary": "Get users who subscribed on an issue.",
  4667. "operationId": "issueSubscriptions",
  4668. "parameters": [
  4669. {
  4670. "type": "string",
  4671. "description": "owner of the repo",
  4672. "name": "owner",
  4673. "in": "path",
  4674. "required": true
  4675. },
  4676. {
  4677. "type": "string",
  4678. "description": "name of the repo",
  4679. "name": "repo",
  4680. "in": "path",
  4681. "required": true
  4682. },
  4683. {
  4684. "type": "integer",
  4685. "format": "int64",
  4686. "description": "index of the issue",
  4687. "name": "index",
  4688. "in": "path",
  4689. "required": true
  4690. },
  4691. {
  4692. "type": "integer",
  4693. "description": "page number of results to return (1-based)",
  4694. "name": "page",
  4695. "in": "query"
  4696. },
  4697. {
  4698. "type": "integer",
  4699. "description": "page size of results, maximum page size is 50",
  4700. "name": "limit",
  4701. "in": "query"
  4702. }
  4703. ],
  4704. "responses": {
  4705. "200": {
  4706. "$ref": "#/responses/UserList"
  4707. },
  4708. "404": {
  4709. "$ref": "#/responses/notFound"
  4710. }
  4711. }
  4712. }
  4713. },
  4714. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  4715. "put": {
  4716. "consumes": [
  4717. "application/json"
  4718. ],
  4719. "produces": [
  4720. "application/json"
  4721. ],
  4722. "tags": [
  4723. "issue"
  4724. ],
  4725. "summary": "Subscribe user to issue",
  4726. "operationId": "issueAddSubscription",
  4727. "parameters": [
  4728. {
  4729. "type": "string",
  4730. "description": "owner of the repo",
  4731. "name": "owner",
  4732. "in": "path",
  4733. "required": true
  4734. },
  4735. {
  4736. "type": "string",
  4737. "description": "name of the repo",
  4738. "name": "repo",
  4739. "in": "path",
  4740. "required": true
  4741. },
  4742. {
  4743. "type": "integer",
  4744. "format": "int64",
  4745. "description": "index of the issue",
  4746. "name": "index",
  4747. "in": "path",
  4748. "required": true
  4749. },
  4750. {
  4751. "type": "string",
  4752. "description": "user to subscribe",
  4753. "name": "user",
  4754. "in": "path",
  4755. "required": true
  4756. }
  4757. ],
  4758. "responses": {
  4759. "201": {
  4760. "$ref": "#/responses/empty"
  4761. },
  4762. "304": {
  4763. "description": "User can only subscribe itself if he is no admin"
  4764. },
  4765. "404": {
  4766. "$ref": "#/responses/notFound"
  4767. }
  4768. }
  4769. },
  4770. "delete": {
  4771. "consumes": [
  4772. "application/json"
  4773. ],
  4774. "produces": [
  4775. "application/json"
  4776. ],
  4777. "tags": [
  4778. "issue"
  4779. ],
  4780. "summary": "Unsubscribe user from issue",
  4781. "operationId": "issueDeleteSubscription",
  4782. "parameters": [
  4783. {
  4784. "type": "string",
  4785. "description": "owner of the repo",
  4786. "name": "owner",
  4787. "in": "path",
  4788. "required": true
  4789. },
  4790. {
  4791. "type": "string",
  4792. "description": "name of the repo",
  4793. "name": "repo",
  4794. "in": "path",
  4795. "required": true
  4796. },
  4797. {
  4798. "type": "integer",
  4799. "format": "int64",
  4800. "description": "index of the issue",
  4801. "name": "index",
  4802. "in": "path",
  4803. "required": true
  4804. },
  4805. {
  4806. "type": "string",
  4807. "description": "user witch unsubscribe",
  4808. "name": "user",
  4809. "in": "path",
  4810. "required": true
  4811. }
  4812. ],
  4813. "responses": {
  4814. "201": {
  4815. "$ref": "#/responses/empty"
  4816. },
  4817. "304": {
  4818. "description": "User can only subscribe itself if he is no admin"
  4819. },
  4820. "404": {
  4821. "$ref": "#/responses/notFound"
  4822. }
  4823. }
  4824. }
  4825. },
  4826. "/repos/{owner}/{repo}/issues/{index}/times": {
  4827. "get": {
  4828. "produces": [
  4829. "application/json"
  4830. ],
  4831. "tags": [
  4832. "issue"
  4833. ],
  4834. "summary": "List an issue's tracked times",
  4835. "operationId": "issueTrackedTimes",
  4836. "parameters": [
  4837. {
  4838. "type": "string",
  4839. "description": "owner of the repo",
  4840. "name": "owner",
  4841. "in": "path",
  4842. "required": true
  4843. },
  4844. {
  4845. "type": "string",
  4846. "description": "name of the repo",
  4847. "name": "repo",
  4848. "in": "path",
  4849. "required": true
  4850. },
  4851. {
  4852. "type": "integer",
  4853. "format": "int64",
  4854. "description": "index of the issue",
  4855. "name": "index",
  4856. "in": "path",
  4857. "required": true
  4858. },
  4859. {
  4860. "type": "string",
  4861. "format": "date-time",
  4862. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  4863. "name": "since",
  4864. "in": "query"
  4865. },
  4866. {
  4867. "type": "string",
  4868. "format": "date-time",
  4869. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  4870. "name": "before",
  4871. "in": "query"
  4872. },
  4873. {
  4874. "type": "integer",
  4875. "description": "page number of results to return (1-based)",
  4876. "name": "page",
  4877. "in": "query"
  4878. },
  4879. {
  4880. "type": "integer",
  4881. "description": "page size of results, maximum page size is 50",
  4882. "name": "limit",
  4883. "in": "query"
  4884. }
  4885. ],
  4886. "responses": {
  4887. "200": {
  4888. "$ref": "#/responses/TrackedTimeList"
  4889. },
  4890. "404": {
  4891. "$ref": "#/responses/notFound"
  4892. }
  4893. }
  4894. },
  4895. "post": {
  4896. "consumes": [
  4897. "application/json"
  4898. ],
  4899. "produces": [
  4900. "application/json"
  4901. ],
  4902. "tags": [
  4903. "issue"
  4904. ],
  4905. "summary": "Add tracked time to a issue",
  4906. "operationId": "issueAddTime",
  4907. "parameters": [
  4908. {
  4909. "type": "string",
  4910. "description": "owner of the repo",
  4911. "name": "owner",
  4912. "in": "path",
  4913. "required": true
  4914. },
  4915. {
  4916. "type": "string",
  4917. "description": "name of the repo",
  4918. "name": "repo",
  4919. "in": "path",
  4920. "required": true
  4921. },
  4922. {
  4923. "type": "integer",
  4924. "format": "int64",
  4925. "description": "index of the issue",
  4926. "name": "index",
  4927. "in": "path",
  4928. "required": true
  4929. },
  4930. {
  4931. "name": "body",
  4932. "in": "body",
  4933. "schema": {
  4934. "$ref": "#/definitions/AddTimeOption"
  4935. }
  4936. }
  4937. ],
  4938. "responses": {
  4939. "200": {
  4940. "$ref": "#/responses/TrackedTime"
  4941. },
  4942. "400": {
  4943. "$ref": "#/responses/error"
  4944. },
  4945. "403": {
  4946. "$ref": "#/responses/forbidden"
  4947. }
  4948. }
  4949. },
  4950. "delete": {
  4951. "consumes": [
  4952. "application/json"
  4953. ],
  4954. "produces": [
  4955. "application/json"
  4956. ],
  4957. "tags": [
  4958. "issue"
  4959. ],
  4960. "summary": "Reset a tracked time of an issue",
  4961. "operationId": "issueResetTime",
  4962. "parameters": [
  4963. {
  4964. "type": "string",
  4965. "description": "owner of the repo",
  4966. "name": "owner",
  4967. "in": "path",
  4968. "required": true
  4969. },
  4970. {
  4971. "type": "string",
  4972. "description": "name of the repo",
  4973. "name": "repo",
  4974. "in": "path",
  4975. "required": true
  4976. },
  4977. {
  4978. "type": "integer",
  4979. "format": "int64",
  4980. "description": "index of the issue to add tracked time to",
  4981. "name": "index",
  4982. "in": "path",
  4983. "required": true
  4984. }
  4985. ],
  4986. "responses": {
  4987. "204": {
  4988. "$ref": "#/responses/empty"
  4989. },
  4990. "400": {
  4991. "$ref": "#/responses/error"
  4992. },
  4993. "403": {
  4994. "$ref": "#/responses/forbidden"
  4995. }
  4996. }
  4997. }
  4998. },
  4999. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5000. "delete": {
  5001. "consumes": [
  5002. "application/json"
  5003. ],
  5004. "produces": [
  5005. "application/json"
  5006. ],
  5007. "tags": [
  5008. "issue"
  5009. ],
  5010. "summary": "Delete specific tracked time",
  5011. "operationId": "issueDeleteTime",
  5012. "parameters": [
  5013. {
  5014. "type": "string",
  5015. "description": "owner of the repo",
  5016. "name": "owner",
  5017. "in": "path",
  5018. "required": true
  5019. },
  5020. {
  5021. "type": "string",
  5022. "description": "name of the repo",
  5023. "name": "repo",
  5024. "in": "path",
  5025. "required": true
  5026. },
  5027. {
  5028. "type": "integer",
  5029. "format": "int64",
  5030. "description": "index of the issue",
  5031. "name": "index",
  5032. "in": "path",
  5033. "required": true
  5034. },
  5035. {
  5036. "type": "integer",
  5037. "format": "int64",
  5038. "description": "id of time to delete",
  5039. "name": "id",
  5040. "in": "path",
  5041. "required": true
  5042. }
  5043. ],
  5044. "responses": {
  5045. "204": {
  5046. "$ref": "#/responses/empty"
  5047. },
  5048. "400": {
  5049. "$ref": "#/responses/error"
  5050. },
  5051. "403": {
  5052. "$ref": "#/responses/forbidden"
  5053. }
  5054. }
  5055. }
  5056. },
  5057. "/repos/{owner}/{repo}/keys": {
  5058. "get": {
  5059. "produces": [
  5060. "application/json"
  5061. ],
  5062. "tags": [
  5063. "repository"
  5064. ],
  5065. "summary": "List a repository's keys",
  5066. "operationId": "repoListKeys",
  5067. "parameters": [
  5068. {
  5069. "type": "string",
  5070. "description": "owner of the repo",
  5071. "name": "owner",
  5072. "in": "path",
  5073. "required": true
  5074. },
  5075. {
  5076. "type": "string",
  5077. "description": "name of the repo",
  5078. "name": "repo",
  5079. "in": "path",
  5080. "required": true
  5081. },
  5082. {
  5083. "type": "integer",
  5084. "description": "the key_id to search for",
  5085. "name": "key_id",
  5086. "in": "query"
  5087. },
  5088. {
  5089. "type": "string",
  5090. "description": "fingerprint of the key",
  5091. "name": "fingerprint",
  5092. "in": "query"
  5093. },
  5094. {
  5095. "type": "integer",
  5096. "description": "page number of results to return (1-based)",
  5097. "name": "page",
  5098. "in": "query"
  5099. },
  5100. {
  5101. "type": "integer",
  5102. "description": "page size of results, maximum page size is 50",
  5103. "name": "limit",
  5104. "in": "query"
  5105. }
  5106. ],
  5107. "responses": {
  5108. "200": {
  5109. "$ref": "#/responses/DeployKeyList"
  5110. }
  5111. }
  5112. },
  5113. "post": {
  5114. "consumes": [
  5115. "application/json"
  5116. ],
  5117. "produces": [
  5118. "application/json"
  5119. ],
  5120. "tags": [
  5121. "repository"
  5122. ],
  5123. "summary": "Add a key to a repository",
  5124. "operationId": "repoCreateKey",
  5125. "parameters": [
  5126. {
  5127. "type": "string",
  5128. "description": "owner of the repo",
  5129. "name": "owner",
  5130. "in": "path",
  5131. "required": true
  5132. },
  5133. {
  5134. "type": "string",
  5135. "description": "name of the repo",
  5136. "name": "repo",
  5137. "in": "path",
  5138. "required": true
  5139. },
  5140. {
  5141. "name": "body",
  5142. "in": "body",
  5143. "schema": {
  5144. "$ref": "#/definitions/CreateKeyOption"
  5145. }
  5146. }
  5147. ],
  5148. "responses": {
  5149. "201": {
  5150. "$ref": "#/responses/DeployKey"
  5151. },
  5152. "422": {
  5153. "$ref": "#/responses/validationError"
  5154. }
  5155. }
  5156. }
  5157. },
  5158. "/repos/{owner}/{repo}/keys/{id}": {
  5159. "get": {
  5160. "produces": [
  5161. "application/json"
  5162. ],
  5163. "tags": [
  5164. "repository"
  5165. ],
  5166. "summary": "Get a repository's key by id",
  5167. "operationId": "repoGetKey",
  5168. "parameters": [
  5169. {
  5170. "type": "string",
  5171. "description": "owner of the repo",
  5172. "name": "owner",
  5173. "in": "path",
  5174. "required": true
  5175. },
  5176. {
  5177. "type": "string",
  5178. "description": "name of the repo",
  5179. "name": "repo",
  5180. "in": "path",
  5181. "required": true
  5182. },
  5183. {
  5184. "type": "integer",
  5185. "format": "int64",
  5186. "description": "id of the key to get",
  5187. "name": "id",
  5188. "in": "path",
  5189. "required": true
  5190. }
  5191. ],
  5192. "responses": {
  5193. "200": {
  5194. "$ref": "#/responses/DeployKey"
  5195. }
  5196. }
  5197. },
  5198. "delete": {
  5199. "tags": [
  5200. "repository"
  5201. ],
  5202. "summary": "Delete a key from a repository",
  5203. "operationId": "repoDeleteKey",
  5204. "parameters": [
  5205. {
  5206. "type": "string",
  5207. "description": "owner of the repo",
  5208. "name": "owner",
  5209. "in": "path",
  5210. "required": true
  5211. },
  5212. {
  5213. "type": "string",
  5214. "description": "name of the repo",
  5215. "name": "repo",
  5216. "in": "path",
  5217. "required": true
  5218. },
  5219. {
  5220. "type": "integer",
  5221. "format": "int64",
  5222. "description": "id of the key to delete",
  5223. "name": "id",
  5224. "in": "path",
  5225. "required": true
  5226. }
  5227. ],
  5228. "responses": {
  5229. "204": {
  5230. "$ref": "#/responses/empty"
  5231. },
  5232. "403": {
  5233. "$ref": "#/responses/forbidden"
  5234. }
  5235. }
  5236. }
  5237. },
  5238. "/repos/{owner}/{repo}/labels": {
  5239. "get": {
  5240. "produces": [
  5241. "application/json"
  5242. ],
  5243. "tags": [
  5244. "issue"
  5245. ],
  5246. "summary": "Get all of a repository's labels",
  5247. "operationId": "issueListLabels",
  5248. "parameters": [
  5249. {
  5250. "type": "string",
  5251. "description": "owner of the repo",
  5252. "name": "owner",
  5253. "in": "path",
  5254. "required": true
  5255. },
  5256. {
  5257. "type": "string",
  5258. "description": "name of the repo",
  5259. "name": "repo",
  5260. "in": "path",
  5261. "required": true
  5262. },
  5263. {
  5264. "type": "integer",
  5265. "description": "page number of results to return (1-based)",
  5266. "name": "page",
  5267. "in": "query"
  5268. },
  5269. {
  5270. "type": "integer",
  5271. "description": "page size of results, maximum page size is 50",
  5272. "name": "limit",
  5273. "in": "query"
  5274. }
  5275. ],
  5276. "responses": {
  5277. "200": {
  5278. "$ref": "#/responses/LabelList"
  5279. }
  5280. }
  5281. },
  5282. "post": {
  5283. "consumes": [
  5284. "application/json"
  5285. ],
  5286. "produces": [
  5287. "application/json"
  5288. ],
  5289. "tags": [
  5290. "issue"
  5291. ],
  5292. "summary": "Create a label",
  5293. "operationId": "issueCreateLabel",
  5294. "parameters": [
  5295. {
  5296. "type": "string",
  5297. "description": "owner of the repo",
  5298. "name": "owner",
  5299. "in": "path",
  5300. "required": true
  5301. },
  5302. {
  5303. "type": "string",
  5304. "description": "name of the repo",
  5305. "name": "repo",
  5306. "in": "path",
  5307. "required": true
  5308. },
  5309. {
  5310. "name": "body",
  5311. "in": "body",
  5312. "schema": {
  5313. "$ref": "#/definitions/CreateLabelOption"
  5314. }
  5315. }
  5316. ],
  5317. "responses": {
  5318. "201": {
  5319. "$ref": "#/responses/Label"
  5320. },
  5321. "422": {
  5322. "$ref": "#/responses/validationError"
  5323. }
  5324. }
  5325. }
  5326. },
  5327. "/repos/{owner}/{repo}/labels/{id}": {
  5328. "get": {
  5329. "produces": [
  5330. "application/json"
  5331. ],
  5332. "tags": [
  5333. "issue"
  5334. ],
  5335. "summary": "Get a single label",
  5336. "operationId": "issueGetLabel",
  5337. "parameters": [
  5338. {
  5339. "type": "string",
  5340. "description": "owner of the repo",
  5341. "name": "owner",
  5342. "in": "path",
  5343. "required": true
  5344. },
  5345. {
  5346. "type": "string",
  5347. "description": "name of the repo",
  5348. "name": "repo",
  5349. "in": "path",
  5350. "required": true
  5351. },
  5352. {
  5353. "type": "integer",
  5354. "format": "int64",
  5355. "description": "id of the label to get",
  5356. "name": "id",
  5357. "in": "path",
  5358. "required": true
  5359. }
  5360. ],
  5361. "responses": {
  5362. "200": {
  5363. "$ref": "#/responses/Label"
  5364. }
  5365. }
  5366. },
  5367. "delete": {
  5368. "tags": [
  5369. "issue"
  5370. ],
  5371. "summary": "Delete a label",
  5372. "operationId": "issueDeleteLabel",
  5373. "parameters": [
  5374. {
  5375. "type": "string",
  5376. "description": "owner of the repo",
  5377. "name": "owner",
  5378. "in": "path",
  5379. "required": true
  5380. },
  5381. {
  5382. "type": "string",
  5383. "description": "name of the repo",
  5384. "name": "repo",
  5385. "in": "path",
  5386. "required": true
  5387. },
  5388. {
  5389. "type": "integer",
  5390. "format": "int64",
  5391. "description": "id of the label to delete",
  5392. "name": "id",
  5393. "in": "path",
  5394. "required": true
  5395. }
  5396. ],
  5397. "responses": {
  5398. "204": {
  5399. "$ref": "#/responses/empty"
  5400. }
  5401. }
  5402. },
  5403. "patch": {
  5404. "consumes": [
  5405. "application/json"
  5406. ],
  5407. "produces": [
  5408. "application/json"
  5409. ],
  5410. "tags": [
  5411. "issue"
  5412. ],
  5413. "summary": "Update a label",
  5414. "operationId": "issueEditLabel",
  5415. "parameters": [
  5416. {
  5417. "type": "string",
  5418. "description": "owner of the repo",
  5419. "name": "owner",
  5420. "in": "path",
  5421. "required": true
  5422. },
  5423. {
  5424. "type": "string",
  5425. "description": "name of the repo",
  5426. "name": "repo",
  5427. "in": "path",
  5428. "required": true
  5429. },
  5430. {
  5431. "type": "integer",
  5432. "format": "int64",
  5433. "description": "id of the label to edit",
  5434. "name": "id",
  5435. "in": "path",
  5436. "required": true
  5437. },
  5438. {
  5439. "name": "body",
  5440. "in": "body",
  5441. "schema": {
  5442. "$ref": "#/definitions/EditLabelOption"
  5443. }
  5444. }
  5445. ],
  5446. "responses": {
  5447. "200": {
  5448. "$ref": "#/responses/Label"
  5449. },
  5450. "422": {
  5451. "$ref": "#/responses/validationError"
  5452. }
  5453. }
  5454. }
  5455. },
  5456. "/repos/{owner}/{repo}/milestones": {
  5457. "get": {
  5458. "produces": [
  5459. "application/json"
  5460. ],
  5461. "tags": [
  5462. "issue"
  5463. ],
  5464. "summary": "Get all of a repository's opened milestones",
  5465. "operationId": "issueGetMilestonesList",
  5466. "parameters": [
  5467. {
  5468. "type": "string",
  5469. "description": "owner of the repo",
  5470. "name": "owner",
  5471. "in": "path",
  5472. "required": true
  5473. },
  5474. {
  5475. "type": "string",
  5476. "description": "name of the repo",
  5477. "name": "repo",
  5478. "in": "path",
  5479. "required": true
  5480. },
  5481. {
  5482. "type": "string",
  5483. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  5484. "name": "state",
  5485. "in": "query"
  5486. },
  5487. {
  5488. "type": "integer",
  5489. "description": "page number of results to return (1-based)",
  5490. "name": "page",
  5491. "in": "query"
  5492. },
  5493. {
  5494. "type": "integer",
  5495. "description": "page size of results, maximum page size is 50",
  5496. "name": "limit",
  5497. "in": "query"
  5498. }
  5499. ],
  5500. "responses": {
  5501. "200": {
  5502. "$ref": "#/responses/MilestoneList"
  5503. }
  5504. }
  5505. },
  5506. "post": {
  5507. "consumes": [
  5508. "application/json"
  5509. ],
  5510. "produces": [
  5511. "application/json"
  5512. ],
  5513. "tags": [
  5514. "issue"
  5515. ],
  5516. "summary": "Create a milestone",
  5517. "operationId": "issueCreateMilestone",
  5518. "parameters": [
  5519. {
  5520. "type": "string",
  5521. "description": "owner of the repo",
  5522. "name": "owner",
  5523. "in": "path",
  5524. "required": true
  5525. },
  5526. {
  5527. "type": "string",
  5528. "description": "name of the repo",
  5529. "name": "repo",
  5530. "in": "path",
  5531. "required": true
  5532. },
  5533. {
  5534. "name": "body",
  5535. "in": "body",
  5536. "schema": {
  5537. "$ref": "#/definitions/CreateMilestoneOption"
  5538. }
  5539. }
  5540. ],
  5541. "responses": {
  5542. "201": {
  5543. "$ref": "#/responses/Milestone"
  5544. }
  5545. }
  5546. }
  5547. },
  5548. "/repos/{owner}/{repo}/milestones/{id}": {
  5549. "get": {
  5550. "produces": [
  5551. "application/json"
  5552. ],
  5553. "tags": [
  5554. "issue"
  5555. ],
  5556. "summary": "Get a milestone",
  5557. "operationId": "issueGetMilestone",
  5558. "parameters": [
  5559. {
  5560. "type": "string",
  5561. "description": "owner of the repo",
  5562. "name": "owner",
  5563. "in": "path",
  5564. "required": true
  5565. },
  5566. {
  5567. "type": "string",
  5568. "description": "name of the repo",
  5569. "name": "repo",
  5570. "in": "path",
  5571. "required": true
  5572. },
  5573. {
  5574. "type": "integer",
  5575. "format": "int64",
  5576. "description": "id of the milestone",
  5577. "name": "id",
  5578. "in": "path",
  5579. "required": true
  5580. }
  5581. ],
  5582. "responses": {
  5583. "200": {
  5584. "$ref": "#/responses/Milestone"
  5585. }
  5586. }
  5587. },
  5588. "delete": {
  5589. "tags": [
  5590. "issue"
  5591. ],
  5592. "summary": "Delete a milestone",
  5593. "operationId": "issueDeleteMilestone",
  5594. "parameters": [
  5595. {
  5596. "type": "string",
  5597. "description": "owner of the repo",
  5598. "name": "owner",
  5599. "in": "path",
  5600. "required": true
  5601. },
  5602. {
  5603. "type": "string",
  5604. "description": "name of the repo",
  5605. "name": "repo",
  5606. "in": "path",
  5607. "required": true
  5608. },
  5609. {
  5610. "type": "integer",
  5611. "format": "int64",
  5612. "description": "id of the milestone to delete",
  5613. "name": "id",
  5614. "in": "path",
  5615. "required": true
  5616. }
  5617. ],
  5618. "responses": {
  5619. "204": {
  5620. "$ref": "#/responses/empty"
  5621. }
  5622. }
  5623. },
  5624. "patch": {
  5625. "consumes": [
  5626. "application/json"
  5627. ],
  5628. "produces": [
  5629. "application/json"
  5630. ],
  5631. "tags": [
  5632. "issue"
  5633. ],
  5634. "summary": "Update a milestone",
  5635. "operationId": "issueEditMilestone",
  5636. "parameters": [
  5637. {
  5638. "type": "string",
  5639. "description": "owner of the repo",
  5640. "name": "owner",
  5641. "in": "path",
  5642. "required": true
  5643. },
  5644. {
  5645. "type": "string",
  5646. "description": "name of the repo",
  5647. "name": "repo",
  5648. "in": "path",
  5649. "required": true
  5650. },
  5651. {
  5652. "type": "integer",
  5653. "format": "int64",
  5654. "description": "id of the milestone",
  5655. "name": "id",
  5656. "in": "path",
  5657. "required": true
  5658. },
  5659. {
  5660. "name": "body",
  5661. "in": "body",
  5662. "schema": {
  5663. "$ref": "#/definitions/EditMilestoneOption"
  5664. }
  5665. }
  5666. ],
  5667. "responses": {
  5668. "200": {
  5669. "$ref": "#/responses/Milestone"
  5670. }
  5671. }
  5672. }
  5673. },
  5674. "/repos/{owner}/{repo}/mirror-sync": {
  5675. "post": {
  5676. "produces": [
  5677. "application/json"
  5678. ],
  5679. "tags": [
  5680. "repository"
  5681. ],
  5682. "summary": "Sync a mirrored repository",
  5683. "operationId": "repoMirrorSync",
  5684. "parameters": [
  5685. {
  5686. "type": "string",
  5687. "description": "owner of the repo to sync",
  5688. "name": "owner",
  5689. "in": "path",
  5690. "required": true
  5691. },
  5692. {
  5693. "type": "string",
  5694. "description": "name of the repo to sync",
  5695. "name": "repo",
  5696. "in": "path",
  5697. "required": true
  5698. }
  5699. ],
  5700. "responses": {
  5701. "200": {
  5702. "$ref": "#/responses/empty"
  5703. },
  5704. "403": {
  5705. "$ref": "#/responses/forbidden"
  5706. }
  5707. }
  5708. }
  5709. },
  5710. "/repos/{owner}/{repo}/notifications": {
  5711. "get": {
  5712. "consumes": [
  5713. "application/json"
  5714. ],
  5715. "produces": [
  5716. "application/json"
  5717. ],
  5718. "tags": [
  5719. "notification"
  5720. ],
  5721. "summary": "List users's notification threads on a specific repo",
  5722. "operationId": "notifyGetRepoList",
  5723. "parameters": [
  5724. {
  5725. "type": "string",
  5726. "description": "owner of the repo",
  5727. "name": "owner",
  5728. "in": "path",
  5729. "required": true
  5730. },
  5731. {
  5732. "type": "string",
  5733. "description": "name of the repo",
  5734. "name": "repo",
  5735. "in": "path",
  5736. "required": true
  5737. },
  5738. {
  5739. "type": "string",
  5740. "description": "If true, show notifications marked as read. Default value is false",
  5741. "name": "all",
  5742. "in": "query"
  5743. },
  5744. {
  5745. "type": "string",
  5746. "format": "date-time",
  5747. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  5748. "name": "since",
  5749. "in": "query"
  5750. },
  5751. {
  5752. "type": "string",
  5753. "format": "date-time",
  5754. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  5755. "name": "before",
  5756. "in": "query"
  5757. },
  5758. {
  5759. "type": "integer",
  5760. "description": "page number of results to return (1-based)",
  5761. "name": "page",
  5762. "in": "query"
  5763. },
  5764. {
  5765. "type": "integer",
  5766. "description": "page size of results, maximum page size is 50",
  5767. "name": "limit",
  5768. "in": "query"
  5769. }
  5770. ],
  5771. "responses": {
  5772. "200": {
  5773. "$ref": "#/responses/NotificationThreadList"
  5774. }
  5775. }
  5776. },
  5777. "put": {
  5778. "consumes": [
  5779. "application/json"
  5780. ],
  5781. "produces": [
  5782. "application/json"
  5783. ],
  5784. "tags": [
  5785. "notification"
  5786. ],
  5787. "summary": "Mark notification threads as read on a specific repo",
  5788. "operationId": "notifyReadRepoList",
  5789. "parameters": [
  5790. {
  5791. "type": "string",
  5792. "description": "owner of the repo",
  5793. "name": "owner",
  5794. "in": "path",
  5795. "required": true
  5796. },
  5797. {
  5798. "type": "string",
  5799. "description": "name of the repo",
  5800. "name": "repo",
  5801. "in": "path",
  5802. "required": true
  5803. },
  5804. {
  5805. "type": "string",
  5806. "format": "date-time",
  5807. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  5808. "name": "last_read_at",
  5809. "in": "query"
  5810. }
  5811. ],
  5812. "responses": {
  5813. "205": {
  5814. "$ref": "#/responses/empty"
  5815. }
  5816. }
  5817. }
  5818. },
  5819. "/repos/{owner}/{repo}/pulls": {
  5820. "get": {
  5821. "produces": [
  5822. "application/json"
  5823. ],
  5824. "tags": [
  5825. "repository"
  5826. ],
  5827. "summary": "List a repo's pull requests",
  5828. "operationId": "repoListPullRequests",
  5829. "parameters": [
  5830. {
  5831. "type": "string",
  5832. "description": "owner of the repo",
  5833. "name": "owner",
  5834. "in": "path",
  5835. "required": true
  5836. },
  5837. {
  5838. "type": "string",
  5839. "description": "name of the repo",
  5840. "name": "repo",
  5841. "in": "path",
  5842. "required": true
  5843. },
  5844. {
  5845. "enum": [
  5846. "closed",
  5847. "open",
  5848. "all"
  5849. ],
  5850. "type": "string",
  5851. "description": "State of pull request: open or closed (optional)",
  5852. "name": "state",
  5853. "in": "query"
  5854. },
  5855. {
  5856. "enum": [
  5857. "oldest",
  5858. "recentupdate",
  5859. "leastupdate",
  5860. "mostcomment",
  5861. "leastcomment",
  5862. "priority"
  5863. ],
  5864. "type": "string",
  5865. "description": "Type of sort",
  5866. "name": "sort",
  5867. "in": "query"
  5868. },
  5869. {
  5870. "type": "integer",
  5871. "format": "int64",
  5872. "description": "ID of the milestone",
  5873. "name": "milestone",
  5874. "in": "query"
  5875. },
  5876. {
  5877. "type": "array",
  5878. "items": {
  5879. "type": "integer",
  5880. "format": "int64"
  5881. },
  5882. "collectionFormat": "multi",
  5883. "description": "Label IDs",
  5884. "name": "labels",
  5885. "in": "query"
  5886. },
  5887. {
  5888. "type": "integer",
  5889. "description": "page number of results to return (1-based)",
  5890. "name": "page",
  5891. "in": "query"
  5892. },
  5893. {
  5894. "type": "integer",
  5895. "description": "page size of results, maximum page size is 50",
  5896. "name": "limit",
  5897. "in": "query"
  5898. }
  5899. ],
  5900. "responses": {
  5901. "200": {
  5902. "$ref": "#/responses/PullRequestList"
  5903. }
  5904. }
  5905. },
  5906. "post": {
  5907. "consumes": [
  5908. "application/json"
  5909. ],
  5910. "produces": [
  5911. "application/json"
  5912. ],
  5913. "tags": [
  5914. "repository"
  5915. ],
  5916. "summary": "Create a pull request",
  5917. "operationId": "repoCreatePullRequest",
  5918. "parameters": [
  5919. {
  5920. "type": "string",
  5921. "description": "owner of the repo",
  5922. "name": "owner",
  5923. "in": "path",
  5924. "required": true
  5925. },
  5926. {
  5927. "type": "string",
  5928. "description": "name of the repo",
  5929. "name": "repo",
  5930. "in": "path",
  5931. "required": true
  5932. },
  5933. {
  5934. "name": "body",
  5935. "in": "body",
  5936. "schema": {
  5937. "$ref": "#/definitions/CreatePullRequestOption"
  5938. }
  5939. }
  5940. ],
  5941. "responses": {
  5942. "201": {
  5943. "$ref": "#/responses/PullRequest"
  5944. },
  5945. "409": {
  5946. "$ref": "#/responses/error"
  5947. },
  5948. "422": {
  5949. "$ref": "#/responses/validationError"
  5950. }
  5951. }
  5952. }
  5953. },
  5954. "/repos/{owner}/{repo}/pulls/{index}": {
  5955. "get": {
  5956. "produces": [
  5957. "application/json"
  5958. ],
  5959. "tags": [
  5960. "repository"
  5961. ],
  5962. "summary": "Get a pull request",
  5963. "operationId": "repoGetPullRequest",
  5964. "parameters": [
  5965. {
  5966. "type": "string",
  5967. "description": "owner of the repo",
  5968. "name": "owner",
  5969. "in": "path",
  5970. "required": true
  5971. },
  5972. {
  5973. "type": "string",
  5974. "description": "name of the repo",
  5975. "name": "repo",
  5976. "in": "path",
  5977. "required": true
  5978. },
  5979. {
  5980. "type": "integer",
  5981. "format": "int64",
  5982. "description": "index of the pull request to get",
  5983. "name": "index",
  5984. "in": "path",
  5985. "required": true
  5986. }
  5987. ],
  5988. "responses": {
  5989. "200": {
  5990. "$ref": "#/responses/PullRequest"
  5991. },
  5992. "404": {
  5993. "$ref": "#/responses/notFound"
  5994. }
  5995. }
  5996. },
  5997. "patch": {
  5998. "consumes": [
  5999. "application/json"
  6000. ],
  6001. "produces": [
  6002. "application/json"
  6003. ],
  6004. "tags": [
  6005. "repository"
  6006. ],
  6007. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6008. "operationId": "repoEditPullRequest",
  6009. "parameters": [
  6010. {
  6011. "type": "string",
  6012. "description": "owner of the repo",
  6013. "name": "owner",
  6014. "in": "path",
  6015. "required": true
  6016. },
  6017. {
  6018. "type": "string",
  6019. "description": "name of the repo",
  6020. "name": "repo",
  6021. "in": "path",
  6022. "required": true
  6023. },
  6024. {
  6025. "type": "integer",
  6026. "format": "int64",
  6027. "description": "index of the pull request to edit",
  6028. "name": "index",
  6029. "in": "path",
  6030. "required": true
  6031. },
  6032. {
  6033. "name": "body",
  6034. "in": "body",
  6035. "schema": {
  6036. "$ref": "#/definitions/EditPullRequestOption"
  6037. }
  6038. }
  6039. ],
  6040. "responses": {
  6041. "201": {
  6042. "$ref": "#/responses/PullRequest"
  6043. },
  6044. "403": {
  6045. "$ref": "#/responses/forbidden"
  6046. },
  6047. "412": {
  6048. "$ref": "#/responses/error"
  6049. },
  6050. "422": {
  6051. "$ref": "#/responses/validationError"
  6052. }
  6053. }
  6054. }
  6055. },
  6056. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6057. "get": {
  6058. "produces": [
  6059. "application/json"
  6060. ],
  6061. "tags": [
  6062. "repository"
  6063. ],
  6064. "summary": "Check if a pull request has been merged",
  6065. "operationId": "repoPullRequestIsMerged",
  6066. "parameters": [
  6067. {
  6068. "type": "string",
  6069. "description": "owner of the repo",
  6070. "name": "owner",
  6071. "in": "path",
  6072. "required": true
  6073. },
  6074. {
  6075. "type": "string",
  6076. "description": "name of the repo",
  6077. "name": "repo",
  6078. "in": "path",
  6079. "required": true
  6080. },
  6081. {
  6082. "type": "integer",
  6083. "format": "int64",
  6084. "description": "index of the pull request",
  6085. "name": "index",
  6086. "in": "path",
  6087. "required": true
  6088. }
  6089. ],
  6090. "responses": {
  6091. "204": {
  6092. "description": "pull request has been merged"
  6093. },
  6094. "404": {
  6095. "description": "pull request has not been merged"
  6096. }
  6097. }
  6098. },
  6099. "post": {
  6100. "produces": [
  6101. "application/json"
  6102. ],
  6103. "tags": [
  6104. "repository"
  6105. ],
  6106. "summary": "Merge a pull request",
  6107. "operationId": "repoMergePullRequest",
  6108. "parameters": [
  6109. {
  6110. "type": "string",
  6111. "description": "owner of the repo",
  6112. "name": "owner",
  6113. "in": "path",
  6114. "required": true
  6115. },
  6116. {
  6117. "type": "string",
  6118. "description": "name of the repo",
  6119. "name": "repo",
  6120. "in": "path",
  6121. "required": true
  6122. },
  6123. {
  6124. "type": "integer",
  6125. "format": "int64",
  6126. "description": "index of the pull request to merge",
  6127. "name": "index",
  6128. "in": "path",
  6129. "required": true
  6130. },
  6131. {
  6132. "name": "body",
  6133. "in": "body",
  6134. "schema": {
  6135. "$ref": "#/definitions/MergePullRequestOption"
  6136. }
  6137. }
  6138. ],
  6139. "responses": {
  6140. "200": {
  6141. "$ref": "#/responses/empty"
  6142. },
  6143. "405": {
  6144. "$ref": "#/responses/empty"
  6145. },
  6146. "409": {
  6147. "$ref": "#/responses/error"
  6148. }
  6149. }
  6150. }
  6151. },
  6152. "/repos/{owner}/{repo}/raw/{filepath}": {
  6153. "get": {
  6154. "produces": [
  6155. "application/json"
  6156. ],
  6157. "tags": [
  6158. "repository"
  6159. ],
  6160. "summary": "Get a file from a repository",
  6161. "operationId": "repoGetRawFile",
  6162. "parameters": [
  6163. {
  6164. "type": "string",
  6165. "description": "owner of the repo",
  6166. "name": "owner",
  6167. "in": "path",
  6168. "required": true
  6169. },
  6170. {
  6171. "type": "string",
  6172. "description": "name of the repo",
  6173. "name": "repo",
  6174. "in": "path",
  6175. "required": true
  6176. },
  6177. {
  6178. "type": "string",
  6179. "description": "filepath of the file to get",
  6180. "name": "filepath",
  6181. "in": "path",
  6182. "required": true
  6183. }
  6184. ],
  6185. "responses": {
  6186. "200": {
  6187. "description": "success"
  6188. },
  6189. "404": {
  6190. "$ref": "#/responses/notFound"
  6191. }
  6192. }
  6193. }
  6194. },
  6195. "/repos/{owner}/{repo}/releases": {
  6196. "get": {
  6197. "produces": [
  6198. "application/json"
  6199. ],
  6200. "tags": [
  6201. "repository"
  6202. ],
  6203. "summary": "List a repo's releases",
  6204. "operationId": "repoListReleases",
  6205. "parameters": [
  6206. {
  6207. "type": "string",
  6208. "description": "owner of the repo",
  6209. "name": "owner",
  6210. "in": "path",
  6211. "required": true
  6212. },
  6213. {
  6214. "type": "string",
  6215. "description": "name of the repo",
  6216. "name": "repo",
  6217. "in": "path",
  6218. "required": true
  6219. },
  6220. {
  6221. "type": "integer",
  6222. "description": "items count every page wants to load",
  6223. "name": "per_page",
  6224. "in": "query"
  6225. },
  6226. {
  6227. "type": "integer",
  6228. "description": "page number of results to return (1-based)",
  6229. "name": "page",
  6230. "in": "query"
  6231. },
  6232. {
  6233. "type": "integer",
  6234. "description": "page size of results, maximum page size is 50",
  6235. "name": "limit",
  6236. "in": "query"
  6237. }
  6238. ],
  6239. "responses": {
  6240. "200": {
  6241. "$ref": "#/responses/ReleaseList"
  6242. }
  6243. }
  6244. },
  6245. "post": {
  6246. "consumes": [
  6247. "application/json"
  6248. ],
  6249. "produces": [
  6250. "application/json"
  6251. ],
  6252. "tags": [
  6253. "repository"
  6254. ],
  6255. "summary": "Create a release",
  6256. "operationId": "repoCreateRelease",
  6257. "parameters": [
  6258. {
  6259. "type": "string",
  6260. "description": "owner of the repo",
  6261. "name": "owner",
  6262. "in": "path",
  6263. "required": true
  6264. },
  6265. {
  6266. "type": "string",
  6267. "description": "name of the repo",
  6268. "name": "repo",
  6269. "in": "path",
  6270. "required": true
  6271. },
  6272. {
  6273. "name": "body",
  6274. "in": "body",
  6275. "schema": {
  6276. "$ref": "#/definitions/CreateReleaseOption"
  6277. }
  6278. }
  6279. ],
  6280. "responses": {
  6281. "201": {
  6282. "$ref": "#/responses/Release"
  6283. },
  6284. "409": {
  6285. "$ref": "#/responses/error"
  6286. }
  6287. }
  6288. }
  6289. },
  6290. "/repos/{owner}/{repo}/releases/{id}": {
  6291. "get": {
  6292. "produces": [
  6293. "application/json"
  6294. ],
  6295. "tags": [
  6296. "repository"
  6297. ],
  6298. "summary": "Get a release",
  6299. "operationId": "repoGetRelease",
  6300. "parameters": [
  6301. {
  6302. "type": "string",
  6303. "description": "owner of the repo",
  6304. "name": "owner",
  6305. "in": "path",
  6306. "required": true
  6307. },
  6308. {
  6309. "type": "string",
  6310. "description": "name of the repo",
  6311. "name": "repo",
  6312. "in": "path",
  6313. "required": true
  6314. },
  6315. {
  6316. "type": "integer",
  6317. "format": "int64",
  6318. "description": "id of the release to get",
  6319. "name": "id",
  6320. "in": "path",
  6321. "required": true
  6322. }
  6323. ],
  6324. "responses": {
  6325. "200": {
  6326. "$ref": "#/responses/Release"
  6327. }
  6328. }
  6329. },
  6330. "delete": {
  6331. "tags": [
  6332. "repository"
  6333. ],
  6334. "summary": "Delete a release",
  6335. "operationId": "repoDeleteRelease",
  6336. "parameters": [
  6337. {
  6338. "type": "string",
  6339. "description": "owner of the repo",
  6340. "name": "owner",
  6341. "in": "path",
  6342. "required": true
  6343. },
  6344. {
  6345. "type": "string",
  6346. "description": "name of the repo",
  6347. "name": "repo",
  6348. "in": "path",
  6349. "required": true
  6350. },
  6351. {
  6352. "type": "integer",
  6353. "format": "int64",
  6354. "description": "id of the release to delete",
  6355. "name": "id",
  6356. "in": "path",
  6357. "required": true
  6358. }
  6359. ],
  6360. "responses": {
  6361. "204": {
  6362. "$ref": "#/responses/empty"
  6363. }
  6364. }
  6365. },
  6366. "patch": {
  6367. "consumes": [
  6368. "application/json"
  6369. ],
  6370. "produces": [
  6371. "application/json"
  6372. ],
  6373. "tags": [
  6374. "repository"
  6375. ],
  6376. "summary": "Update a release",
  6377. "operationId": "repoEditRelease",
  6378. "parameters": [
  6379. {
  6380. "type": "string",
  6381. "description": "owner of the repo",
  6382. "name": "owner",
  6383. "in": "path",
  6384. "required": true
  6385. },
  6386. {
  6387. "type": "string",
  6388. "description": "name of the repo",
  6389. "name": "repo",
  6390. "in": "path",
  6391. "required": true
  6392. },
  6393. {
  6394. "type": "integer",
  6395. "format": "int64",
  6396. "description": "id of the release to edit",
  6397. "name": "id",
  6398. "in": "path",
  6399. "required": true
  6400. },
  6401. {
  6402. "name": "body",
  6403. "in": "body",
  6404. "schema": {
  6405. "$ref": "#/definitions/EditReleaseOption"
  6406. }
  6407. }
  6408. ],
  6409. "responses": {
  6410. "200": {
  6411. "$ref": "#/responses/Release"
  6412. }
  6413. }
  6414. }
  6415. },
  6416. "/repos/{owner}/{repo}/releases/{id}/assets": {
  6417. "get": {
  6418. "produces": [
  6419. "application/json"
  6420. ],
  6421. "tags": [
  6422. "repository"
  6423. ],
  6424. "summary": "List release's attachments",
  6425. "operationId": "repoListReleaseAttachments",
  6426. "parameters": [
  6427. {
  6428. "type": "string",
  6429. "description": "owner of the repo",
  6430. "name": "owner",
  6431. "in": "path",
  6432. "required": true
  6433. },
  6434. {
  6435. "type": "string",
  6436. "description": "name of the repo",
  6437. "name": "repo",
  6438. "in": "path",
  6439. "required": true
  6440. },
  6441. {
  6442. "type": "integer",
  6443. "format": "int64",
  6444. "description": "id of the release",
  6445. "name": "id",
  6446. "in": "path",
  6447. "required": true
  6448. }
  6449. ],
  6450. "responses": {
  6451. "200": {
  6452. "$ref": "#/responses/AttachmentList"
  6453. }
  6454. }
  6455. },
  6456. "post": {
  6457. "consumes": [
  6458. "multipart/form-data"
  6459. ],
  6460. "produces": [
  6461. "application/json"
  6462. ],
  6463. "tags": [
  6464. "repository"
  6465. ],
  6466. "summary": "Create a release attachment",
  6467. "operationId": "repoCreateReleaseAttachment",
  6468. "parameters": [
  6469. {
  6470. "type": "string",
  6471. "description": "owner of the repo",
  6472. "name": "owner",
  6473. "in": "path",
  6474. "required": true
  6475. },
  6476. {
  6477. "type": "string",
  6478. "description": "name of the repo",
  6479. "name": "repo",
  6480. "in": "path",
  6481. "required": true
  6482. },
  6483. {
  6484. "type": "integer",
  6485. "format": "int64",
  6486. "description": "id of the release",
  6487. "name": "id",
  6488. "in": "path",
  6489. "required": true
  6490. },
  6491. {
  6492. "type": "string",
  6493. "description": "name of the attachment",
  6494. "name": "name",
  6495. "in": "query"
  6496. },
  6497. {
  6498. "type": "file",
  6499. "description": "attachment to upload",
  6500. "name": "attachment",
  6501. "in": "formData",
  6502. "required": true
  6503. }
  6504. ],
  6505. "responses": {
  6506. "201": {
  6507. "$ref": "#/responses/Attachment"
  6508. },
  6509. "400": {
  6510. "$ref": "#/responses/error"
  6511. }
  6512. }
  6513. }
  6514. },
  6515. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  6516. "get": {
  6517. "produces": [
  6518. "application/json"
  6519. ],
  6520. "tags": [
  6521. "repository"
  6522. ],
  6523. "summary": "Get a release attachment",
  6524. "operationId": "repoGetReleaseAttachment",
  6525. "parameters": [
  6526. {
  6527. "type": "string",
  6528. "description": "owner of the repo",
  6529. "name": "owner",
  6530. "in": "path",
  6531. "required": true
  6532. },
  6533. {
  6534. "type": "string",
  6535. "description": "name of the repo",
  6536. "name": "repo",
  6537. "in": "path",
  6538. "required": true
  6539. },
  6540. {
  6541. "type": "integer",
  6542. "format": "int64",
  6543. "description": "id of the release",
  6544. "name": "id",
  6545. "in": "path",
  6546. "required": true
  6547. },
  6548. {
  6549. "type": "integer",
  6550. "format": "int64",
  6551. "description": "id of the attachment to get",
  6552. "name": "attachment_id",
  6553. "in": "path",
  6554. "required": true
  6555. }
  6556. ],
  6557. "responses": {
  6558. "200": {
  6559. "$ref": "#/responses/Attachment"
  6560. }
  6561. }
  6562. },
  6563. "delete": {
  6564. "produces": [
  6565. "application/json"
  6566. ],
  6567. "tags": [
  6568. "repository"
  6569. ],
  6570. "summary": "Delete a release attachment",
  6571. "operationId": "repoDeleteReleaseAttachment",
  6572. "parameters": [
  6573. {
  6574. "type": "string",
  6575. "description": "owner of the repo",
  6576. "name": "owner",
  6577. "in": "path",
  6578. "required": true
  6579. },
  6580. {
  6581. "type": "string",
  6582. "description": "name of the repo",
  6583. "name": "repo",
  6584. "in": "path",
  6585. "required": true
  6586. },
  6587. {
  6588. "type": "integer",
  6589. "format": "int64",
  6590. "description": "id of the release",
  6591. "name": "id",
  6592. "in": "path",
  6593. "required": true
  6594. },
  6595. {
  6596. "type": "integer",
  6597. "format": "int64",
  6598. "description": "id of the attachment to delete",
  6599. "name": "attachment_id",
  6600. "in": "path",
  6601. "required": true
  6602. }
  6603. ],
  6604. "responses": {
  6605. "204": {
  6606. "$ref": "#/responses/empty"
  6607. }
  6608. }
  6609. },
  6610. "patch": {
  6611. "consumes": [
  6612. "application/json"
  6613. ],
  6614. "produces": [
  6615. "application/json"
  6616. ],
  6617. "tags": [
  6618. "repository"
  6619. ],
  6620. "summary": "Edit a release attachment",
  6621. "operationId": "repoEditReleaseAttachment",
  6622. "parameters": [
  6623. {
  6624. "type": "string",
  6625. "description": "owner of the repo",
  6626. "name": "owner",
  6627. "in": "path",
  6628. "required": true
  6629. },
  6630. {
  6631. "type": "string",
  6632. "description": "name of the repo",
  6633. "name": "repo",
  6634. "in": "path",
  6635. "required": true
  6636. },
  6637. {
  6638. "type": "integer",
  6639. "format": "int64",
  6640. "description": "id of the release",
  6641. "name": "id",
  6642. "in": "path",
  6643. "required": true
  6644. },
  6645. {
  6646. "type": "integer",
  6647. "format": "int64",
  6648. "description": "id of the attachment to edit",
  6649. "name": "attachment_id",
  6650. "in": "path",
  6651. "required": true
  6652. },
  6653. {
  6654. "name": "body",
  6655. "in": "body",
  6656. "schema": {
  6657. "$ref": "#/definitions/EditAttachmentOptions"
  6658. }
  6659. }
  6660. ],
  6661. "responses": {
  6662. "201": {
  6663. "$ref": "#/responses/Attachment"
  6664. }
  6665. }
  6666. }
  6667. },
  6668. "/repos/{owner}/{repo}/signing-key.gpg": {
  6669. "get": {
  6670. "produces": [
  6671. "text/plain"
  6672. ],
  6673. "tags": [
  6674. "repository"
  6675. ],
  6676. "summary": "Get signing-key.gpg for given repository",
  6677. "operationId": "repoSigningKey",
  6678. "parameters": [
  6679. {
  6680. "type": "string",
  6681. "description": "owner of the repo",
  6682. "name": "owner",
  6683. "in": "path",
  6684. "required": true
  6685. },
  6686. {
  6687. "type": "string",
  6688. "description": "name of the repo",
  6689. "name": "repo",
  6690. "in": "path",
  6691. "required": true
  6692. }
  6693. ],
  6694. "responses": {
  6695. "200": {
  6696. "description": "GPG armored public key",
  6697. "schema": {
  6698. "type": "string"
  6699. }
  6700. }
  6701. }
  6702. }
  6703. },
  6704. "/repos/{owner}/{repo}/stargazers": {
  6705. "get": {
  6706. "produces": [
  6707. "application/json"
  6708. ],
  6709. "tags": [
  6710. "repository"
  6711. ],
  6712. "summary": "List a repo's stargazers",
  6713. "operationId": "repoListStargazers",
  6714. "parameters": [
  6715. {
  6716. "type": "string",
  6717. "description": "owner of the repo",
  6718. "name": "owner",
  6719. "in": "path",
  6720. "required": true
  6721. },
  6722. {
  6723. "type": "string",
  6724. "description": "name of the repo",
  6725. "name": "repo",
  6726. "in": "path",
  6727. "required": true
  6728. },
  6729. {
  6730. "type": "integer",
  6731. "description": "page number of results to return (1-based)",
  6732. "name": "page",
  6733. "in": "query"
  6734. },
  6735. {
  6736. "type": "integer",
  6737. "description": "page size of results, maximum page size is 50",
  6738. "name": "limit",
  6739. "in": "query"
  6740. }
  6741. ],
  6742. "responses": {
  6743. "200": {
  6744. "$ref": "#/responses/UserList"
  6745. }
  6746. }
  6747. }
  6748. },
  6749. "/repos/{owner}/{repo}/statuses/{sha}": {
  6750. "get": {
  6751. "produces": [
  6752. "application/json"
  6753. ],
  6754. "tags": [
  6755. "repository"
  6756. ],
  6757. "summary": "Get a commit's statuses",
  6758. "operationId": "repoListStatuses",
  6759. "parameters": [
  6760. {
  6761. "type": "string",
  6762. "description": "owner of the repo",
  6763. "name": "owner",
  6764. "in": "path",
  6765. "required": true
  6766. },
  6767. {
  6768. "type": "string",
  6769. "description": "name of the repo",
  6770. "name": "repo",
  6771. "in": "path",
  6772. "required": true
  6773. },
  6774. {
  6775. "type": "string",
  6776. "description": "sha of the commit",
  6777. "name": "sha",
  6778. "in": "path",
  6779. "required": true
  6780. },
  6781. {
  6782. "enum": [
  6783. "oldest",
  6784. "recentupdate",
  6785. "leastupdate",
  6786. "leastindex",
  6787. "highestindex"
  6788. ],
  6789. "type": "string",
  6790. "description": "type of sort",
  6791. "name": "sort",
  6792. "in": "query"
  6793. },
  6794. {
  6795. "enum": [
  6796. "pending",
  6797. "success",
  6798. "error",
  6799. "failure",
  6800. "warning"
  6801. ],
  6802. "type": "string",
  6803. "description": "type of state",
  6804. "name": "state",
  6805. "in": "query"
  6806. },
  6807. {
  6808. "type": "integer",
  6809. "description": "page number of results to return (1-based)",
  6810. "name": "page",
  6811. "in": "query"
  6812. },
  6813. {
  6814. "type": "integer",
  6815. "description": "page size of results, maximum page size is 50",
  6816. "name": "limit",
  6817. "in": "query"
  6818. }
  6819. ],
  6820. "responses": {
  6821. "200": {
  6822. "$ref": "#/responses/StatusList"
  6823. },
  6824. "400": {
  6825. "$ref": "#/responses/error"
  6826. }
  6827. }
  6828. },
  6829. "post": {
  6830. "produces": [
  6831. "application/json"
  6832. ],
  6833. "tags": [
  6834. "repository"
  6835. ],
  6836. "summary": "Create a commit status",
  6837. "operationId": "repoCreateStatus",
  6838. "parameters": [
  6839. {
  6840. "type": "string",
  6841. "description": "owner of the repo",
  6842. "name": "owner",
  6843. "in": "path",
  6844. "required": true
  6845. },
  6846. {
  6847. "type": "string",
  6848. "description": "name of the repo",
  6849. "name": "repo",
  6850. "in": "path",
  6851. "required": true
  6852. },
  6853. {
  6854. "type": "string",
  6855. "description": "sha of the commit",
  6856. "name": "sha",
  6857. "in": "path",
  6858. "required": true
  6859. },
  6860. {
  6861. "name": "body",
  6862. "in": "body",
  6863. "schema": {
  6864. "$ref": "#/definitions/CreateStatusOption"
  6865. }
  6866. }
  6867. ],
  6868. "responses": {
  6869. "201": {
  6870. "$ref": "#/responses/Status"
  6871. },
  6872. "400": {
  6873. "$ref": "#/responses/error"
  6874. }
  6875. }
  6876. }
  6877. },
  6878. "/repos/{owner}/{repo}/subscribers": {
  6879. "get": {
  6880. "produces": [
  6881. "application/json"
  6882. ],
  6883. "tags": [
  6884. "repository"
  6885. ],
  6886. "summary": "List a repo's watchers",
  6887. "operationId": "repoListSubscribers",
  6888. "parameters": [
  6889. {
  6890. "type": "string",
  6891. "description": "owner of the repo",
  6892. "name": "owner",
  6893. "in": "path",
  6894. "required": true
  6895. },
  6896. {
  6897. "type": "string",
  6898. "description": "name of the repo",
  6899. "name": "repo",
  6900. "in": "path",
  6901. "required": true
  6902. },
  6903. {
  6904. "type": "integer",
  6905. "description": "page number of results to return (1-based)",
  6906. "name": "page",
  6907. "in": "query"
  6908. },
  6909. {
  6910. "type": "integer",
  6911. "description": "page size of results, maximum page size is 50",
  6912. "name": "limit",
  6913. "in": "query"
  6914. }
  6915. ],
  6916. "responses": {
  6917. "200": {
  6918. "$ref": "#/responses/UserList"
  6919. }
  6920. }
  6921. }
  6922. },
  6923. "/repos/{owner}/{repo}/subscription": {
  6924. "get": {
  6925. "tags": [
  6926. "repository"
  6927. ],
  6928. "summary": "Check if the current user is watching a repo",
  6929. "operationId": "userCurrentCheckSubscription",
  6930. "parameters": [
  6931. {
  6932. "type": "string",
  6933. "description": "owner of the repo",
  6934. "name": "owner",
  6935. "in": "path",
  6936. "required": true
  6937. },
  6938. {
  6939. "type": "string",
  6940. "description": "name of the repo",
  6941. "name": "repo",
  6942. "in": "path",
  6943. "required": true
  6944. }
  6945. ],
  6946. "responses": {
  6947. "200": {
  6948. "$ref": "#/responses/WatchInfo"
  6949. }
  6950. }
  6951. },
  6952. "put": {
  6953. "tags": [
  6954. "repository"
  6955. ],
  6956. "summary": "Watch a repo",
  6957. "operationId": "userCurrentPutSubscription",
  6958. "parameters": [
  6959. {
  6960. "type": "string",
  6961. "description": "owner of the repo",
  6962. "name": "owner",
  6963. "in": "path",
  6964. "required": true
  6965. },
  6966. {
  6967. "type": "string",
  6968. "description": "name of the repo",
  6969. "name": "repo",
  6970. "in": "path",
  6971. "required": true
  6972. }
  6973. ],
  6974. "responses": {
  6975. "200": {
  6976. "$ref": "#/responses/WatchInfo"
  6977. }
  6978. }
  6979. },
  6980. "delete": {
  6981. "tags": [
  6982. "repository"
  6983. ],
  6984. "summary": "Unwatch a repo",
  6985. "operationId": "userCurrentDeleteSubscription",
  6986. "parameters": [
  6987. {
  6988. "type": "string",
  6989. "description": "owner of the repo",
  6990. "name": "owner",
  6991. "in": "path",
  6992. "required": true
  6993. },
  6994. {
  6995. "type": "string",
  6996. "description": "name of the repo",
  6997. "name": "repo",
  6998. "in": "path",
  6999. "required": true
  7000. }
  7001. ],
  7002. "responses": {
  7003. "204": {
  7004. "$ref": "#/responses/empty"
  7005. }
  7006. }
  7007. }
  7008. },
  7009. "/repos/{owner}/{repo}/tags": {
  7010. "get": {
  7011. "produces": [
  7012. "application/json"
  7013. ],
  7014. "tags": [
  7015. "repository"
  7016. ],
  7017. "summary": "List a repository's tags",
  7018. "operationId": "repoListTags",
  7019. "parameters": [
  7020. {
  7021. "type": "string",
  7022. "description": "owner of the repo",
  7023. "name": "owner",
  7024. "in": "path",
  7025. "required": true
  7026. },
  7027. {
  7028. "type": "string",
  7029. "description": "name of the repo",
  7030. "name": "repo",
  7031. "in": "path",
  7032. "required": true
  7033. }
  7034. ],
  7035. "responses": {
  7036. "200": {
  7037. "$ref": "#/responses/TagList"
  7038. }
  7039. }
  7040. }
  7041. },
  7042. "/repos/{owner}/{repo}/times": {
  7043. "get": {
  7044. "produces": [
  7045. "application/json"
  7046. ],
  7047. "tags": [
  7048. "repository"
  7049. ],
  7050. "summary": "List a repo's tracked times",
  7051. "operationId": "repoTrackedTimes",
  7052. "parameters": [
  7053. {
  7054. "type": "string",
  7055. "description": "owner of the repo",
  7056. "name": "owner",
  7057. "in": "path",
  7058. "required": true
  7059. },
  7060. {
  7061. "type": "string",
  7062. "description": "name of the repo",
  7063. "name": "repo",
  7064. "in": "path",
  7065. "required": true
  7066. },
  7067. {
  7068. "type": "string",
  7069. "description": "optional filter by user",
  7070. "name": "user",
  7071. "in": "query"
  7072. },
  7073. {
  7074. "type": "string",
  7075. "format": "date-time",
  7076. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7077. "name": "since",
  7078. "in": "query"
  7079. },
  7080. {
  7081. "type": "string",
  7082. "format": "date-time",
  7083. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7084. "name": "before",
  7085. "in": "query"
  7086. },
  7087. {
  7088. "type": "integer",
  7089. "description": "page number of results to return (1-based)",
  7090. "name": "page",
  7091. "in": "query"
  7092. },
  7093. {
  7094. "type": "integer",
  7095. "description": "page size of results, maximum page size is 50",
  7096. "name": "limit",
  7097. "in": "query"
  7098. }
  7099. ],
  7100. "responses": {
  7101. "200": {
  7102. "$ref": "#/responses/TrackedTimeList"
  7103. },
  7104. "400": {
  7105. "$ref": "#/responses/error"
  7106. },
  7107. "403": {
  7108. "$ref": "#/responses/forbidden"
  7109. }
  7110. }
  7111. }
  7112. },
  7113. "/repos/{owner}/{repo}/times/{user}": {
  7114. "get": {
  7115. "produces": [
  7116. "application/json"
  7117. ],
  7118. "tags": [
  7119. "repository"
  7120. ],
  7121. "summary": "List a user's tracked times in a repo",
  7122. "operationId": "userTrackedTimes",
  7123. "deprecated": true,
  7124. "parameters": [
  7125. {
  7126. "type": "string",
  7127. "description": "owner of the repo",
  7128. "name": "owner",
  7129. "in": "path",
  7130. "required": true
  7131. },
  7132. {
  7133. "type": "string",
  7134. "description": "name of the repo",
  7135. "name": "repo",
  7136. "in": "path",
  7137. "required": true
  7138. },
  7139. {
  7140. "type": "string",
  7141. "description": "username of user",
  7142. "name": "user",
  7143. "in": "path",
  7144. "required": true
  7145. }
  7146. ],
  7147. "responses": {
  7148. "200": {
  7149. "$ref": "#/responses/TrackedTimeList"
  7150. },
  7151. "400": {
  7152. "$ref": "#/responses/error"
  7153. },
  7154. "403": {
  7155. "$ref": "#/responses/forbidden"
  7156. }
  7157. }
  7158. }
  7159. },
  7160. "/repos/{owner}/{repo}/topics": {
  7161. "get": {
  7162. "produces": [
  7163. "application/json"
  7164. ],
  7165. "tags": [
  7166. "repository"
  7167. ],
  7168. "summary": "Get list of topics that a repository has",
  7169. "operationId": "repoListTopics",
  7170. "parameters": [
  7171. {
  7172. "type": "string",
  7173. "description": "owner of the repo",
  7174. "name": "owner",
  7175. "in": "path",
  7176. "required": true
  7177. },
  7178. {
  7179. "type": "string",
  7180. "description": "name of the repo",
  7181. "name": "repo",
  7182. "in": "path",
  7183. "required": true
  7184. },
  7185. {
  7186. "type": "integer",
  7187. "description": "page number of results to return (1-based)",
  7188. "name": "page",
  7189. "in": "query"
  7190. },
  7191. {
  7192. "type": "integer",
  7193. "description": "page size of results, maximum page size is 50",
  7194. "name": "limit",
  7195. "in": "query"
  7196. }
  7197. ],
  7198. "responses": {
  7199. "200": {
  7200. "$ref": "#/responses/TopicNames"
  7201. }
  7202. }
  7203. },
  7204. "put": {
  7205. "produces": [
  7206. "application/json"
  7207. ],
  7208. "tags": [
  7209. "repository"
  7210. ],
  7211. "summary": "Replace list of topics for a repository",
  7212. "operationId": "repoUpdateTopics",
  7213. "parameters": [
  7214. {
  7215. "type": "string",
  7216. "description": "owner of the repo",
  7217. "name": "owner",
  7218. "in": "path",
  7219. "required": true
  7220. },
  7221. {
  7222. "type": "string",
  7223. "description": "name of the repo",
  7224. "name": "repo",
  7225. "in": "path",
  7226. "required": true
  7227. },
  7228. {
  7229. "name": "body",
  7230. "in": "body",
  7231. "schema": {
  7232. "$ref": "#/definitions/RepoTopicOptions"
  7233. }
  7234. }
  7235. ],
  7236. "responses": {
  7237. "204": {
  7238. "$ref": "#/responses/empty"
  7239. },
  7240. "422": {
  7241. "$ref": "#/responses/invalidTopicsError"
  7242. }
  7243. }
  7244. }
  7245. },
  7246. "/repos/{owner}/{repo}/topics/{topic}": {
  7247. "put": {
  7248. "produces": [
  7249. "application/json"
  7250. ],
  7251. "tags": [
  7252. "repository"
  7253. ],
  7254. "summary": "Add a topic to a repository",
  7255. "operationId": "repoAddTopíc",
  7256. "parameters": [
  7257. {
  7258. "type": "string",
  7259. "description": "owner of the repo",
  7260. "name": "owner",
  7261. "in": "path",
  7262. "required": true
  7263. },
  7264. {
  7265. "type": "string",
  7266. "description": "name of the repo",
  7267. "name": "repo",
  7268. "in": "path",
  7269. "required": true
  7270. },
  7271. {
  7272. "type": "string",
  7273. "description": "name of the topic to add",
  7274. "name": "topic",
  7275. "in": "path",
  7276. "required": true
  7277. }
  7278. ],
  7279. "responses": {
  7280. "204": {
  7281. "$ref": "#/responses/empty"
  7282. },
  7283. "422": {
  7284. "$ref": "#/responses/invalidTopicsError"
  7285. }
  7286. }
  7287. },
  7288. "delete": {
  7289. "produces": [
  7290. "application/json"
  7291. ],
  7292. "tags": [
  7293. "repository"
  7294. ],
  7295. "summary": "Delete a topic from a repository",
  7296. "operationId": "repoDeleteTopic",
  7297. "parameters": [
  7298. {
  7299. "type": "string",
  7300. "description": "owner of the repo",
  7301. "name": "owner",
  7302. "in": "path",
  7303. "required": true
  7304. },
  7305. {
  7306. "type": "string",
  7307. "description": "name of the repo",
  7308. "name": "repo",
  7309. "in": "path",
  7310. "required": true
  7311. },
  7312. {
  7313. "type": "string",
  7314. "description": "name of the topic to delete",
  7315. "name": "topic",
  7316. "in": "path",
  7317. "required": true
  7318. }
  7319. ],
  7320. "responses": {
  7321. "204": {
  7322. "$ref": "#/responses/empty"
  7323. },
  7324. "422": {
  7325. "$ref": "#/responses/invalidTopicsError"
  7326. }
  7327. }
  7328. }
  7329. },
  7330. "/repos/{owner}/{repo}/transfer": {
  7331. "post": {
  7332. "produces": [
  7333. "application/json"
  7334. ],
  7335. "tags": [
  7336. "repository"
  7337. ],
  7338. "summary": "Transfer a repo ownership",
  7339. "operationId": "repoTransfer",
  7340. "parameters": [
  7341. {
  7342. "type": "string",
  7343. "description": "owner of the repo to transfer",
  7344. "name": "owner",
  7345. "in": "path",
  7346. "required": true
  7347. },
  7348. {
  7349. "type": "string",
  7350. "description": "name of the repo to transfer",
  7351. "name": "repo",
  7352. "in": "path",
  7353. "required": true
  7354. },
  7355. {
  7356. "description": "Transfer Options",
  7357. "name": "body",
  7358. "in": "body",
  7359. "required": true,
  7360. "schema": {
  7361. "$ref": "#/definitions/TransferRepoOption"
  7362. }
  7363. }
  7364. ],
  7365. "responses": {
  7366. "202": {
  7367. "$ref": "#/responses/Repository"
  7368. },
  7369. "403": {
  7370. "$ref": "#/responses/forbidden"
  7371. },
  7372. "404": {
  7373. "$ref": "#/responses/notFound"
  7374. },
  7375. "422": {
  7376. "$ref": "#/responses/validationError"
  7377. }
  7378. }
  7379. }
  7380. },
  7381. "/repositories/{id}": {
  7382. "get": {
  7383. "produces": [
  7384. "application/json"
  7385. ],
  7386. "tags": [
  7387. "repository"
  7388. ],
  7389. "summary": "Get a repository by id",
  7390. "operationId": "repoGetByID",
  7391. "parameters": [
  7392. {
  7393. "type": "integer",
  7394. "format": "int64",
  7395. "description": "id of the repo to get",
  7396. "name": "id",
  7397. "in": "path",
  7398. "required": true
  7399. }
  7400. ],
  7401. "responses": {
  7402. "200": {
  7403. "$ref": "#/responses/Repository"
  7404. }
  7405. }
  7406. }
  7407. },
  7408. "/signing-key.gpg": {
  7409. "get": {
  7410. "produces": [
  7411. "text/plain"
  7412. ],
  7413. "tags": [
  7414. "miscellaneous"
  7415. ],
  7416. "summary": "Get default signing-key.gpg",
  7417. "operationId": "getSigningKey",
  7418. "responses": {
  7419. "200": {
  7420. "description": "GPG armored public key",
  7421. "schema": {
  7422. "type": "string"
  7423. }
  7424. }
  7425. }
  7426. }
  7427. },
  7428. "/teams/{id}": {
  7429. "get": {
  7430. "produces": [
  7431. "application/json"
  7432. ],
  7433. "tags": [
  7434. "organization"
  7435. ],
  7436. "summary": "Get a team",
  7437. "operationId": "orgGetTeam",
  7438. "parameters": [
  7439. {
  7440. "type": "integer",
  7441. "format": "int64",
  7442. "description": "id of the team to get",
  7443. "name": "id",
  7444. "in": "path",
  7445. "required": true
  7446. }
  7447. ],
  7448. "responses": {
  7449. "200": {
  7450. "$ref": "#/responses/Team"
  7451. }
  7452. }
  7453. },
  7454. "delete": {
  7455. "tags": [
  7456. "organization"
  7457. ],
  7458. "summary": "Delete a team",
  7459. "operationId": "orgDeleteTeam",
  7460. "parameters": [
  7461. {
  7462. "type": "integer",
  7463. "format": "int64",
  7464. "description": "id of the team to delete",
  7465. "name": "id",
  7466. "in": "path",
  7467. "required": true
  7468. }
  7469. ],
  7470. "responses": {
  7471. "204": {
  7472. "description": "team deleted"
  7473. }
  7474. }
  7475. },
  7476. "patch": {
  7477. "consumes": [
  7478. "application/json"
  7479. ],
  7480. "produces": [
  7481. "application/json"
  7482. ],
  7483. "tags": [
  7484. "organization"
  7485. ],
  7486. "summary": "Edit a team",
  7487. "operationId": "orgEditTeam",
  7488. "parameters": [
  7489. {
  7490. "type": "integer",
  7491. "description": "id of the team to edit",
  7492. "name": "id",
  7493. "in": "path",
  7494. "required": true
  7495. },
  7496. {
  7497. "name": "body",
  7498. "in": "body",
  7499. "schema": {
  7500. "$ref": "#/definitions/EditTeamOption"
  7501. }
  7502. }
  7503. ],
  7504. "responses": {
  7505. "200": {
  7506. "$ref": "#/responses/Team"
  7507. }
  7508. }
  7509. }
  7510. },
  7511. "/teams/{id}/members": {
  7512. "get": {
  7513. "produces": [
  7514. "application/json"
  7515. ],
  7516. "tags": [
  7517. "organization"
  7518. ],
  7519. "summary": "List a team's members",
  7520. "operationId": "orgListTeamMembers",
  7521. "parameters": [
  7522. {
  7523. "type": "integer",
  7524. "format": "int64",
  7525. "description": "id of the team",
  7526. "name": "id",
  7527. "in": "path",
  7528. "required": true
  7529. },
  7530. {
  7531. "type": "integer",
  7532. "description": "page number of results to return (1-based)",
  7533. "name": "page",
  7534. "in": "query"
  7535. },
  7536. {
  7537. "type": "integer",
  7538. "description": "page size of results, maximum page size is 50",
  7539. "name": "limit",
  7540. "in": "query"
  7541. }
  7542. ],
  7543. "responses": {
  7544. "200": {
  7545. "$ref": "#/responses/UserList"
  7546. }
  7547. }
  7548. }
  7549. },
  7550. "/teams/{id}/members/{username}": {
  7551. "get": {
  7552. "produces": [
  7553. "application/json"
  7554. ],
  7555. "tags": [
  7556. "organization"
  7557. ],
  7558. "summary": "List a particular member of team",
  7559. "operationId": "orgListTeamMember",
  7560. "parameters": [
  7561. {
  7562. "type": "integer",
  7563. "format": "int64",
  7564. "description": "id of the team",
  7565. "name": "id",
  7566. "in": "path",
  7567. "required": true
  7568. },
  7569. {
  7570. "type": "string",
  7571. "description": "username of the member to list",
  7572. "name": "username",
  7573. "in": "path",
  7574. "required": true
  7575. }
  7576. ],
  7577. "responses": {
  7578. "200": {
  7579. "$ref": "#/responses/User"
  7580. },
  7581. "404": {
  7582. "$ref": "#/responses/notFound"
  7583. }
  7584. }
  7585. },
  7586. "put": {
  7587. "produces": [
  7588. "application/json"
  7589. ],
  7590. "tags": [
  7591. "organization"
  7592. ],
  7593. "summary": "Add a team member",
  7594. "operationId": "orgAddTeamMember",
  7595. "parameters": [
  7596. {
  7597. "type": "integer",
  7598. "format": "int64",
  7599. "description": "id of the team",
  7600. "name": "id",
  7601. "in": "path",
  7602. "required": true
  7603. },
  7604. {
  7605. "type": "string",
  7606. "description": "username of the user to add",
  7607. "name": "username",
  7608. "in": "path",
  7609. "required": true
  7610. }
  7611. ],
  7612. "responses": {
  7613. "204": {
  7614. "$ref": "#/responses/empty"
  7615. },
  7616. "404": {
  7617. "$ref": "#/responses/notFound"
  7618. }
  7619. }
  7620. },
  7621. "delete": {
  7622. "produces": [
  7623. "application/json"
  7624. ],
  7625. "tags": [
  7626. "organization"
  7627. ],
  7628. "summary": "Remove a team member",
  7629. "operationId": "orgRemoveTeamMember",
  7630. "parameters": [
  7631. {
  7632. "type": "integer",
  7633. "format": "int64",
  7634. "description": "id of the team",
  7635. "name": "id",
  7636. "in": "path",
  7637. "required": true
  7638. },
  7639. {
  7640. "type": "string",
  7641. "description": "username of the user to remove",
  7642. "name": "username",
  7643. "in": "path",
  7644. "required": true
  7645. }
  7646. ],
  7647. "responses": {
  7648. "204": {
  7649. "$ref": "#/responses/empty"
  7650. },
  7651. "404": {
  7652. "$ref": "#/responses/notFound"
  7653. }
  7654. }
  7655. }
  7656. },
  7657. "/teams/{id}/repos": {
  7658. "get": {
  7659. "produces": [
  7660. "application/json"
  7661. ],
  7662. "tags": [
  7663. "organization"
  7664. ],
  7665. "summary": "List a team's repos",
  7666. "operationId": "orgListTeamRepos",
  7667. "parameters": [
  7668. {
  7669. "type": "integer",
  7670. "format": "int64",
  7671. "description": "id of the team",
  7672. "name": "id",
  7673. "in": "path",
  7674. "required": true
  7675. },
  7676. {
  7677. "type": "integer",
  7678. "description": "page number of results to return (1-based)",
  7679. "name": "page",
  7680. "in": "query"
  7681. },
  7682. {
  7683. "type": "integer",
  7684. "description": "page size of results, maximum page size is 50",
  7685. "name": "limit",
  7686. "in": "query"
  7687. }
  7688. ],
  7689. "responses": {
  7690. "200": {
  7691. "$ref": "#/responses/RepositoryList"
  7692. }
  7693. }
  7694. }
  7695. },
  7696. "/teams/{id}/repos/{org}/{repo}": {
  7697. "put": {
  7698. "produces": [
  7699. "application/json"
  7700. ],
  7701. "tags": [
  7702. "organization"
  7703. ],
  7704. "summary": "Add a repository to a team",
  7705. "operationId": "orgAddTeamRepository",
  7706. "parameters": [
  7707. {
  7708. "type": "integer",
  7709. "format": "int64",
  7710. "description": "id of the team",
  7711. "name": "id",
  7712. "in": "path",
  7713. "required": true
  7714. },
  7715. {
  7716. "type": "string",
  7717. "description": "organization that owns the repo to add",
  7718. "name": "org",
  7719. "in": "path",
  7720. "required": true
  7721. },
  7722. {
  7723. "type": "string",
  7724. "description": "name of the repo to add",
  7725. "name": "repo",
  7726. "in": "path",
  7727. "required": true
  7728. }
  7729. ],
  7730. "responses": {
  7731. "204": {
  7732. "$ref": "#/responses/empty"
  7733. },
  7734. "403": {
  7735. "$ref": "#/responses/forbidden"
  7736. }
  7737. }
  7738. },
  7739. "delete": {
  7740. "description": "This does not delete the repository, it only removes the repository from the team.",
  7741. "produces": [
  7742. "application/json"
  7743. ],
  7744. "tags": [
  7745. "organization"
  7746. ],
  7747. "summary": "Remove a repository from a team",
  7748. "operationId": "orgRemoveTeamRepository",
  7749. "parameters": [
  7750. {
  7751. "type": "integer",
  7752. "format": "int64",
  7753. "description": "id of the team",
  7754. "name": "id",
  7755. "in": "path",
  7756. "required": true
  7757. },
  7758. {
  7759. "type": "string",
  7760. "description": "organization that owns the repo to remove",
  7761. "name": "org",
  7762. "in": "path",
  7763. "required": true
  7764. },
  7765. {
  7766. "type": "string",
  7767. "description": "name of the repo to remove",
  7768. "name": "repo",
  7769. "in": "path",
  7770. "required": true
  7771. }
  7772. ],
  7773. "responses": {
  7774. "204": {
  7775. "$ref": "#/responses/empty"
  7776. },
  7777. "403": {
  7778. "$ref": "#/responses/forbidden"
  7779. }
  7780. }
  7781. }
  7782. },
  7783. "/topics/search": {
  7784. "get": {
  7785. "produces": [
  7786. "application/json"
  7787. ],
  7788. "tags": [
  7789. "repository"
  7790. ],
  7791. "summary": "search topics via keyword",
  7792. "operationId": "topicSearch",
  7793. "parameters": [
  7794. {
  7795. "type": "string",
  7796. "description": "keywords to search",
  7797. "name": "q",
  7798. "in": "query",
  7799. "required": true
  7800. },
  7801. {
  7802. "type": "integer",
  7803. "description": "page number of results to return (1-based)",
  7804. "name": "page",
  7805. "in": "query"
  7806. },
  7807. {
  7808. "type": "integer",
  7809. "description": "page size of results, maximum page size is 50",
  7810. "name": "limit",
  7811. "in": "query"
  7812. }
  7813. ],
  7814. "responses": {
  7815. "200": {
  7816. "$ref": "#/responses/TopicListResponse"
  7817. },
  7818. "403": {
  7819. "$ref": "#/responses/forbidden"
  7820. }
  7821. }
  7822. }
  7823. },
  7824. "/user": {
  7825. "get": {
  7826. "produces": [
  7827. "application/json"
  7828. ],
  7829. "tags": [
  7830. "user"
  7831. ],
  7832. "summary": "Get the authenticated user",
  7833. "operationId": "userGetCurrent",
  7834. "responses": {
  7835. "200": {
  7836. "$ref": "#/responses/User"
  7837. }
  7838. }
  7839. }
  7840. },
  7841. "/user/emails": {
  7842. "get": {
  7843. "produces": [
  7844. "application/json"
  7845. ],
  7846. "tags": [
  7847. "user"
  7848. ],
  7849. "summary": "List the authenticated user's email addresses",
  7850. "operationId": "userListEmails",
  7851. "responses": {
  7852. "200": {
  7853. "$ref": "#/responses/EmailList"
  7854. }
  7855. }
  7856. },
  7857. "post": {
  7858. "produces": [
  7859. "application/json"
  7860. ],
  7861. "tags": [
  7862. "user"
  7863. ],
  7864. "summary": "Add email addresses",
  7865. "operationId": "userAddEmail",
  7866. "parameters": [
  7867. {
  7868. "name": "body",
  7869. "in": "body",
  7870. "schema": {
  7871. "$ref": "#/definitions/CreateEmailOption"
  7872. }
  7873. }
  7874. ],
  7875. "responses": {
  7876. "201": {
  7877. "$ref": "#/responses/EmailList"
  7878. },
  7879. "422": {
  7880. "$ref": "#/responses/validationError"
  7881. }
  7882. }
  7883. },
  7884. "delete": {
  7885. "produces": [
  7886. "application/json"
  7887. ],
  7888. "tags": [
  7889. "user"
  7890. ],
  7891. "summary": "Delete email addresses",
  7892. "operationId": "userDeleteEmail",
  7893. "parameters": [
  7894. {
  7895. "name": "body",
  7896. "in": "body",
  7897. "schema": {
  7898. "$ref": "#/definitions/DeleteEmailOption"
  7899. }
  7900. }
  7901. ],
  7902. "responses": {
  7903. "204": {
  7904. "$ref": "#/responses/empty"
  7905. }
  7906. }
  7907. }
  7908. },
  7909. "/user/followers": {
  7910. "get": {
  7911. "produces": [
  7912. "application/json"
  7913. ],
  7914. "tags": [
  7915. "user"
  7916. ],
  7917. "summary": "List the authenticated user's followers",
  7918. "operationId": "userCurrentListFollowers",
  7919. "parameters": [
  7920. {
  7921. "type": "integer",
  7922. "description": "page number of results to return (1-based)",
  7923. "name": "page",
  7924. "in": "query"
  7925. },
  7926. {
  7927. "type": "integer",
  7928. "description": "page size of results, maximum page size is 50",
  7929. "name": "limit",
  7930. "in": "query"
  7931. }
  7932. ],
  7933. "responses": {
  7934. "200": {
  7935. "$ref": "#/responses/UserList"
  7936. }
  7937. }
  7938. }
  7939. },
  7940. "/user/following": {
  7941. "get": {
  7942. "produces": [
  7943. "application/json"
  7944. ],
  7945. "tags": [
  7946. "user"
  7947. ],
  7948. "summary": "List the users that the authenticated user is following",
  7949. "operationId": "userCurrentListFollowing",
  7950. "parameters": [
  7951. {
  7952. "type": "integer",
  7953. "description": "page number of results to return (1-based)",
  7954. "name": "page",
  7955. "in": "query"
  7956. },
  7957. {
  7958. "type": "integer",
  7959. "description": "page size of results, maximum page size is 50",
  7960. "name": "limit",
  7961. "in": "query"
  7962. }
  7963. ],
  7964. "responses": {
  7965. "200": {
  7966. "$ref": "#/responses/UserList"
  7967. }
  7968. }
  7969. }
  7970. },
  7971. "/user/following/{username}": {
  7972. "get": {
  7973. "tags": [
  7974. "user"
  7975. ],
  7976. "summary": "Check whether a user is followed by the authenticated user",
  7977. "operationId": "userCurrentCheckFollowing",
  7978. "parameters": [
  7979. {
  7980. "type": "string",
  7981. "description": "username of followed user",
  7982. "name": "username",
  7983. "in": "path",
  7984. "required": true
  7985. }
  7986. ],
  7987. "responses": {
  7988. "204": {
  7989. "$ref": "#/responses/empty"
  7990. },
  7991. "404": {
  7992. "$ref": "#/responses/notFound"
  7993. }
  7994. }
  7995. },
  7996. "put": {
  7997. "tags": [
  7998. "user"
  7999. ],
  8000. "summary": "Follow a user",
  8001. "operationId": "userCurrentPutFollow",
  8002. "parameters": [
  8003. {
  8004. "type": "string",
  8005. "description": "username of user to follow",
  8006. "name": "username",
  8007. "in": "path",
  8008. "required": true
  8009. }
  8010. ],
  8011. "responses": {
  8012. "204": {
  8013. "$ref": "#/responses/empty"
  8014. }
  8015. }
  8016. },
  8017. "delete": {
  8018. "tags": [
  8019. "user"
  8020. ],
  8021. "summary": "Unfollow a user",
  8022. "operationId": "userCurrentDeleteFollow",
  8023. "parameters": [
  8024. {
  8025. "type": "string",
  8026. "description": "username of user to unfollow",
  8027. "name": "username",
  8028. "in": "path",
  8029. "required": true
  8030. }
  8031. ],
  8032. "responses": {
  8033. "204": {
  8034. "$ref": "#/responses/empty"
  8035. }
  8036. }
  8037. }
  8038. },
  8039. "/user/gpg_keys": {
  8040. "get": {
  8041. "produces": [
  8042. "application/json"
  8043. ],
  8044. "tags": [
  8045. "user"
  8046. ],
  8047. "summary": "List the authenticated user's GPG keys",
  8048. "operationId": "userCurrentListGPGKeys",
  8049. "parameters": [
  8050. {
  8051. "type": "integer",
  8052. "description": "page number of results to return (1-based)",
  8053. "name": "page",
  8054. "in": "query"
  8055. },
  8056. {
  8057. "type": "integer",
  8058. "description": "page size of results, maximum page size is 50",
  8059. "name": "limit",
  8060. "in": "query"
  8061. }
  8062. ],
  8063. "responses": {
  8064. "200": {
  8065. "$ref": "#/responses/GPGKeyList"
  8066. }
  8067. }
  8068. },
  8069. "post": {
  8070. "consumes": [
  8071. "application/json"
  8072. ],
  8073. "produces": [
  8074. "application/json"
  8075. ],
  8076. "tags": [
  8077. "user"
  8078. ],
  8079. "summary": "Create a GPG key",
  8080. "operationId": "userCurrentPostGPGKey",
  8081. "parameters": [
  8082. {
  8083. "name": "Form",
  8084. "in": "body",
  8085. "schema": {
  8086. "$ref": "#/definitions/CreateGPGKeyOption"
  8087. }
  8088. }
  8089. ],
  8090. "responses": {
  8091. "201": {
  8092. "$ref": "#/responses/GPGKey"
  8093. },
  8094. "422": {
  8095. "$ref": "#/responses/validationError"
  8096. }
  8097. }
  8098. }
  8099. },
  8100. "/user/gpg_keys/{id}": {
  8101. "get": {
  8102. "produces": [
  8103. "application/json"
  8104. ],
  8105. "tags": [
  8106. "user"
  8107. ],
  8108. "summary": "Get a GPG key",
  8109. "operationId": "userCurrentGetGPGKey",
  8110. "parameters": [
  8111. {
  8112. "type": "integer",
  8113. "format": "int64",
  8114. "description": "id of key to get",
  8115. "name": "id",
  8116. "in": "path",
  8117. "required": true
  8118. }
  8119. ],
  8120. "responses": {
  8121. "200": {
  8122. "$ref": "#/responses/GPGKey"
  8123. },
  8124. "404": {
  8125. "$ref": "#/responses/notFound"
  8126. }
  8127. }
  8128. },
  8129. "delete": {
  8130. "produces": [
  8131. "application/json"
  8132. ],
  8133. "tags": [
  8134. "user"
  8135. ],
  8136. "summary": "Remove a GPG key",
  8137. "operationId": "userCurrentDeleteGPGKey",
  8138. "parameters": [
  8139. {
  8140. "type": "integer",
  8141. "format": "int64",
  8142. "description": "id of key to delete",
  8143. "name": "id",
  8144. "in": "path",
  8145. "required": true
  8146. }
  8147. ],
  8148. "responses": {
  8149. "204": {
  8150. "$ref": "#/responses/empty"
  8151. },
  8152. "403": {
  8153. "$ref": "#/responses/forbidden"
  8154. }
  8155. }
  8156. }
  8157. },
  8158. "/user/keys": {
  8159. "get": {
  8160. "produces": [
  8161. "application/json"
  8162. ],
  8163. "tags": [
  8164. "user"
  8165. ],
  8166. "summary": "List the authenticated user's public keys",
  8167. "operationId": "userCurrentListKeys",
  8168. "parameters": [
  8169. {
  8170. "type": "string",
  8171. "description": "fingerprint of the key",
  8172. "name": "fingerprint",
  8173. "in": "query"
  8174. },
  8175. {
  8176. "type": "integer",
  8177. "description": "page number of results to return (1-based)",
  8178. "name": "page",
  8179. "in": "query"
  8180. },
  8181. {
  8182. "type": "integer",
  8183. "description": "page size of results, maximum page size is 50",
  8184. "name": "limit",
  8185. "in": "query"
  8186. }
  8187. ],
  8188. "responses": {
  8189. "200": {
  8190. "$ref": "#/responses/PublicKeyList"
  8191. }
  8192. }
  8193. },
  8194. "post": {
  8195. "consumes": [
  8196. "application/json"
  8197. ],
  8198. "produces": [
  8199. "application/json"
  8200. ],
  8201. "tags": [
  8202. "user"
  8203. ],
  8204. "summary": "Create a public key",
  8205. "operationId": "userCurrentPostKey",
  8206. "parameters": [
  8207. {
  8208. "name": "body",
  8209. "in": "body",
  8210. "schema": {
  8211. "$ref": "#/definitions/CreateKeyOption"
  8212. }
  8213. }
  8214. ],
  8215. "responses": {
  8216. "201": {
  8217. "$ref": "#/responses/PublicKey"
  8218. },
  8219. "422": {
  8220. "$ref": "#/responses/validationError"
  8221. }
  8222. }
  8223. }
  8224. },
  8225. "/user/keys/{id}": {
  8226. "get": {
  8227. "produces": [
  8228. "application/json"
  8229. ],
  8230. "tags": [
  8231. "user"
  8232. ],
  8233. "summary": "Get a public key",
  8234. "operationId": "userCurrentGetKey",
  8235. "parameters": [
  8236. {
  8237. "type": "integer",
  8238. "format": "int64",
  8239. "description": "id of key to get",
  8240. "name": "id",
  8241. "in": "path",
  8242. "required": true
  8243. }
  8244. ],
  8245. "responses": {
  8246. "200": {
  8247. "$ref": "#/responses/PublicKey"
  8248. },
  8249. "404": {
  8250. "$ref": "#/responses/notFound"
  8251. }
  8252. }
  8253. },
  8254. "delete": {
  8255. "produces": [
  8256. "application/json"
  8257. ],
  8258. "tags": [
  8259. "user"
  8260. ],
  8261. "summary": "Delete a public key",
  8262. "operationId": "userCurrentDeleteKey",
  8263. "parameters": [
  8264. {
  8265. "type": "integer",
  8266. "format": "int64",
  8267. "description": "id of key to delete",
  8268. "name": "id",
  8269. "in": "path",
  8270. "required": true
  8271. }
  8272. ],
  8273. "responses": {
  8274. "204": {
  8275. "$ref": "#/responses/empty"
  8276. },
  8277. "403": {
  8278. "$ref": "#/responses/forbidden"
  8279. },
  8280. "404": {
  8281. "$ref": "#/responses/notFound"
  8282. }
  8283. }
  8284. }
  8285. },
  8286. "/user/orgs": {
  8287. "get": {
  8288. "produces": [
  8289. "application/json"
  8290. ],
  8291. "tags": [
  8292. "organization"
  8293. ],
  8294. "summary": "List the current user's organizations",
  8295. "operationId": "orgListCurrentUserOrgs",
  8296. "parameters": [
  8297. {
  8298. "type": "integer",
  8299. "description": "page number of results to return (1-based)",
  8300. "name": "page",
  8301. "in": "query"
  8302. },
  8303. {
  8304. "type": "integer",
  8305. "description": "page size of results, maximum page size is 50",
  8306. "name": "limit",
  8307. "in": "query"
  8308. }
  8309. ],
  8310. "responses": {
  8311. "200": {
  8312. "$ref": "#/responses/OrganizationList"
  8313. }
  8314. }
  8315. }
  8316. },
  8317. "/user/repos": {
  8318. "get": {
  8319. "produces": [
  8320. "application/json"
  8321. ],
  8322. "tags": [
  8323. "user"
  8324. ],
  8325. "summary": "List the repos that the authenticated user owns or has access to",
  8326. "operationId": "userCurrentListRepos",
  8327. "parameters": [
  8328. {
  8329. "type": "integer",
  8330. "description": "page number of results to return (1-based)",
  8331. "name": "page",
  8332. "in": "query"
  8333. },
  8334. {
  8335. "type": "integer",
  8336. "description": "page size of results, maximum page size is 50",
  8337. "name": "limit",
  8338. "in": "query"
  8339. }
  8340. ],
  8341. "responses": {
  8342. "200": {
  8343. "$ref": "#/responses/RepositoryList"
  8344. }
  8345. }
  8346. },
  8347. "post": {
  8348. "consumes": [
  8349. "application/json"
  8350. ],
  8351. "produces": [
  8352. "application/json"
  8353. ],
  8354. "tags": [
  8355. "repository",
  8356. "user"
  8357. ],
  8358. "summary": "Create a repository",
  8359. "operationId": "createCurrentUserRepo",
  8360. "parameters": [
  8361. {
  8362. "name": "body",
  8363. "in": "body",
  8364. "schema": {
  8365. "$ref": "#/definitions/CreateRepoOption"
  8366. }
  8367. }
  8368. ],
  8369. "responses": {
  8370. "201": {
  8371. "$ref": "#/responses/Repository"
  8372. },
  8373. "409": {
  8374. "description": "The repository with the same name already exists."
  8375. },
  8376. "422": {
  8377. "$ref": "#/responses/validationError"
  8378. }
  8379. }
  8380. }
  8381. },
  8382. "/user/starred": {
  8383. "get": {
  8384. "produces": [
  8385. "application/json"
  8386. ],
  8387. "tags": [
  8388. "user"
  8389. ],
  8390. "summary": "The repos that the authenticated user has starred",
  8391. "operationId": "userCurrentListStarred",
  8392. "parameters": [
  8393. {
  8394. "type": "integer",
  8395. "description": "page number of results to return (1-based)",
  8396. "name": "page",
  8397. "in": "query"
  8398. },
  8399. {
  8400. "type": "integer",
  8401. "description": "page size of results, maximum page size is 50",
  8402. "name": "limit",
  8403. "in": "query"
  8404. }
  8405. ],
  8406. "responses": {
  8407. "200": {
  8408. "$ref": "#/responses/RepositoryList"
  8409. }
  8410. }
  8411. }
  8412. },
  8413. "/user/starred/{owner}/{repo}": {
  8414. "get": {
  8415. "tags": [
  8416. "user"
  8417. ],
  8418. "summary": "Whether the authenticated is starring the repo",
  8419. "operationId": "userCurrentCheckStarring",
  8420. "parameters": [
  8421. {
  8422. "type": "string",
  8423. "description": "owner of the repo",
  8424. "name": "owner",
  8425. "in": "path",
  8426. "required": true
  8427. },
  8428. {
  8429. "type": "string",
  8430. "description": "name of the repo",
  8431. "name": "repo",
  8432. "in": "path",
  8433. "required": true
  8434. }
  8435. ],
  8436. "responses": {
  8437. "204": {
  8438. "$ref": "#/responses/empty"
  8439. },
  8440. "404": {
  8441. "$ref": "#/responses/notFound"
  8442. }
  8443. }
  8444. },
  8445. "put": {
  8446. "tags": [
  8447. "user"
  8448. ],
  8449. "summary": "Star the given repo",
  8450. "operationId": "userCurrentPutStar",
  8451. "parameters": [
  8452. {
  8453. "type": "string",
  8454. "description": "owner of the repo to star",
  8455. "name": "owner",
  8456. "in": "path",
  8457. "required": true
  8458. },
  8459. {
  8460. "type": "string",
  8461. "description": "name of the repo to star",
  8462. "name": "repo",
  8463. "in": "path",
  8464. "required": true
  8465. }
  8466. ],
  8467. "responses": {
  8468. "204": {
  8469. "$ref": "#/responses/empty"
  8470. }
  8471. }
  8472. },
  8473. "delete": {
  8474. "tags": [
  8475. "user"
  8476. ],
  8477. "summary": "Unstar the given repo",
  8478. "operationId": "userCurrentDeleteStar",
  8479. "parameters": [
  8480. {
  8481. "type": "string",
  8482. "description": "owner of the repo to unstar",
  8483. "name": "owner",
  8484. "in": "path",
  8485. "required": true
  8486. },
  8487. {
  8488. "type": "string",
  8489. "description": "name of the repo to unstar",
  8490. "name": "repo",
  8491. "in": "path",
  8492. "required": true
  8493. }
  8494. ],
  8495. "responses": {
  8496. "204": {
  8497. "$ref": "#/responses/empty"
  8498. }
  8499. }
  8500. }
  8501. },
  8502. "/user/stopwatches": {
  8503. "get": {
  8504. "consumes": [
  8505. "application/json"
  8506. ],
  8507. "produces": [
  8508. "application/json"
  8509. ],
  8510. "tags": [
  8511. "user"
  8512. ],
  8513. "summary": "Get list of all existing stopwatches",
  8514. "operationId": "userGetStopWatches",
  8515. "parameters": [
  8516. {
  8517. "type": "integer",
  8518. "description": "page number of results to return (1-based)",
  8519. "name": "page",
  8520. "in": "query"
  8521. },
  8522. {
  8523. "type": "integer",
  8524. "description": "page size of results, maximum page size is 50",
  8525. "name": "limit",
  8526. "in": "query"
  8527. }
  8528. ],
  8529. "responses": {
  8530. "200": {
  8531. "$ref": "#/responses/StopWatchList"
  8532. }
  8533. }
  8534. }
  8535. },
  8536. "/user/subscriptions": {
  8537. "get": {
  8538. "produces": [
  8539. "application/json"
  8540. ],
  8541. "tags": [
  8542. "user"
  8543. ],
  8544. "summary": "List repositories watched by the authenticated user",
  8545. "operationId": "userCurrentListSubscriptions",
  8546. "parameters": [
  8547. {
  8548. "type": "integer",
  8549. "description": "page number of results to return (1-based)",
  8550. "name": "page",
  8551. "in": "query"
  8552. },
  8553. {
  8554. "type": "integer",
  8555. "description": "page size of results, maximum page size is 50",
  8556. "name": "limit",
  8557. "in": "query"
  8558. }
  8559. ],
  8560. "responses": {
  8561. "200": {
  8562. "$ref": "#/responses/RepositoryList"
  8563. }
  8564. }
  8565. }
  8566. },
  8567. "/user/teams": {
  8568. "get": {
  8569. "produces": [
  8570. "application/json"
  8571. ],
  8572. "tags": [
  8573. "user"
  8574. ],
  8575. "summary": "List all the teams a user belongs to",
  8576. "operationId": "userListTeams",
  8577. "parameters": [
  8578. {
  8579. "type": "integer",
  8580. "description": "page number of results to return (1-based)",
  8581. "name": "page",
  8582. "in": "query"
  8583. },
  8584. {
  8585. "type": "integer",
  8586. "description": "page size of results, maximum page size is 50",
  8587. "name": "limit",
  8588. "in": "query"
  8589. }
  8590. ],
  8591. "responses": {
  8592. "200": {
  8593. "$ref": "#/responses/TeamList"
  8594. }
  8595. }
  8596. }
  8597. },
  8598. "/user/times": {
  8599. "get": {
  8600. "produces": [
  8601. "application/json"
  8602. ],
  8603. "tags": [
  8604. "user"
  8605. ],
  8606. "summary": "List the current user's tracked times",
  8607. "operationId": "userCurrentTrackedTimes",
  8608. "parameters": [
  8609. {
  8610. "type": "string",
  8611. "format": "date-time",
  8612. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8613. "name": "since",
  8614. "in": "query"
  8615. },
  8616. {
  8617. "type": "string",
  8618. "format": "date-time",
  8619. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8620. "name": "before",
  8621. "in": "query"
  8622. }
  8623. ],
  8624. "responses": {
  8625. "200": {
  8626. "$ref": "#/responses/TrackedTimeList"
  8627. }
  8628. }
  8629. }
  8630. },
  8631. "/users/search": {
  8632. "get": {
  8633. "produces": [
  8634. "application/json"
  8635. ],
  8636. "tags": [
  8637. "user"
  8638. ],
  8639. "summary": "Search for users",
  8640. "operationId": "userSearch",
  8641. "parameters": [
  8642. {
  8643. "type": "string",
  8644. "description": "keyword",
  8645. "name": "q",
  8646. "in": "query"
  8647. },
  8648. {
  8649. "type": "integer",
  8650. "format": "int64",
  8651. "description": "ID of the user to search for",
  8652. "name": "uid",
  8653. "in": "query"
  8654. },
  8655. {
  8656. "type": "integer",
  8657. "description": "page number of results to return (1-based)",
  8658. "name": "page",
  8659. "in": "query"
  8660. },
  8661. {
  8662. "type": "integer",
  8663. "description": "page size of results, maximum page size is 50",
  8664. "name": "limit",
  8665. "in": "query"
  8666. }
  8667. ],
  8668. "responses": {
  8669. "200": {
  8670. "description": "SearchResults of a successful search",
  8671. "schema": {
  8672. "type": "object",
  8673. "properties": {
  8674. "data": {
  8675. "type": "array",
  8676. "items": {
  8677. "$ref": "#/definitions/User"
  8678. }
  8679. },
  8680. "ok": {
  8681. "type": "boolean"
  8682. }
  8683. }
  8684. }
  8685. }
  8686. }
  8687. }
  8688. },
  8689. "/users/{follower}/following/{followee}": {
  8690. "get": {
  8691. "tags": [
  8692. "user"
  8693. ],
  8694. "summary": "Check if one user is following another user",
  8695. "operationId": "userCheckFollowing",
  8696. "parameters": [
  8697. {
  8698. "type": "string",
  8699. "description": "username of following user",
  8700. "name": "follower",
  8701. "in": "path",
  8702. "required": true
  8703. },
  8704. {
  8705. "type": "string",
  8706. "description": "username of followed user",
  8707. "name": "followee",
  8708. "in": "path",
  8709. "required": true
  8710. }
  8711. ],
  8712. "responses": {
  8713. "204": {
  8714. "$ref": "#/responses/empty"
  8715. },
  8716. "404": {
  8717. "$ref": "#/responses/notFound"
  8718. }
  8719. }
  8720. }
  8721. },
  8722. "/users/{username}": {
  8723. "get": {
  8724. "produces": [
  8725. "application/json"
  8726. ],
  8727. "tags": [
  8728. "user"
  8729. ],
  8730. "summary": "Get a user",
  8731. "operationId": "userGet",
  8732. "parameters": [
  8733. {
  8734. "type": "string",
  8735. "description": "username of user to get",
  8736. "name": "username",
  8737. "in": "path",
  8738. "required": true
  8739. }
  8740. ],
  8741. "responses": {
  8742. "200": {
  8743. "$ref": "#/responses/User"
  8744. },
  8745. "404": {
  8746. "$ref": "#/responses/notFound"
  8747. }
  8748. }
  8749. }
  8750. },
  8751. "/users/{username}/followers": {
  8752. "get": {
  8753. "produces": [
  8754. "application/json"
  8755. ],
  8756. "tags": [
  8757. "user"
  8758. ],
  8759. "summary": "List the given user's followers",
  8760. "operationId": "userListFollowers",
  8761. "parameters": [
  8762. {
  8763. "type": "string",
  8764. "description": "username of user",
  8765. "name": "username",
  8766. "in": "path",
  8767. "required": true
  8768. },
  8769. {
  8770. "type": "integer",
  8771. "description": "page number of results to return (1-based)",
  8772. "name": "page",
  8773. "in": "query"
  8774. },
  8775. {
  8776. "type": "integer",
  8777. "description": "page size of results, maximum page size is 50",
  8778. "name": "limit",
  8779. "in": "query"
  8780. }
  8781. ],
  8782. "responses": {
  8783. "200": {
  8784. "$ref": "#/responses/UserList"
  8785. }
  8786. }
  8787. }
  8788. },
  8789. "/users/{username}/following": {
  8790. "get": {
  8791. "produces": [
  8792. "application/json"
  8793. ],
  8794. "tags": [
  8795. "user"
  8796. ],
  8797. "summary": "List the users that the given user is following",
  8798. "operationId": "userListFollowing",
  8799. "parameters": [
  8800. {
  8801. "type": "string",
  8802. "description": "username of user",
  8803. "name": "username",
  8804. "in": "path",
  8805. "required": true
  8806. },
  8807. {
  8808. "type": "integer",
  8809. "description": "page number of results to return (1-based)",
  8810. "name": "page",
  8811. "in": "query"
  8812. },
  8813. {
  8814. "type": "integer",
  8815. "description": "page size of results, maximum page size is 50",
  8816. "name": "limit",
  8817. "in": "query"
  8818. }
  8819. ],
  8820. "responses": {
  8821. "200": {
  8822. "$ref": "#/responses/UserList"
  8823. }
  8824. }
  8825. }
  8826. },
  8827. "/users/{username}/gpg_keys": {
  8828. "get": {
  8829. "produces": [
  8830. "application/json"
  8831. ],
  8832. "tags": [
  8833. "user"
  8834. ],
  8835. "summary": "List the given user's GPG keys",
  8836. "operationId": "userListGPGKeys",
  8837. "parameters": [
  8838. {
  8839. "type": "string",
  8840. "description": "username of user",
  8841. "name": "username",
  8842. "in": "path",
  8843. "required": true
  8844. },
  8845. {
  8846. "type": "integer",
  8847. "description": "page number of results to return (1-based)",
  8848. "name": "page",
  8849. "in": "query"
  8850. },
  8851. {
  8852. "type": "integer",
  8853. "description": "page size of results, maximum page size is 50",
  8854. "name": "limit",
  8855. "in": "query"
  8856. }
  8857. ],
  8858. "responses": {
  8859. "200": {
  8860. "$ref": "#/responses/GPGKeyList"
  8861. }
  8862. }
  8863. }
  8864. },
  8865. "/users/{username}/heatmap": {
  8866. "get": {
  8867. "produces": [
  8868. "application/json"
  8869. ],
  8870. "tags": [
  8871. "user"
  8872. ],
  8873. "summary": "Get a user's heatmap",
  8874. "operationId": "userGetHeatmapData",
  8875. "parameters": [
  8876. {
  8877. "type": "string",
  8878. "description": "username of user to get",
  8879. "name": "username",
  8880. "in": "path",
  8881. "required": true
  8882. }
  8883. ],
  8884. "responses": {
  8885. "200": {
  8886. "$ref": "#/responses/UserHeatmapData"
  8887. },
  8888. "404": {
  8889. "$ref": "#/responses/notFound"
  8890. }
  8891. }
  8892. }
  8893. },
  8894. "/users/{username}/keys": {
  8895. "get": {
  8896. "produces": [
  8897. "application/json"
  8898. ],
  8899. "tags": [
  8900. "user"
  8901. ],
  8902. "summary": "List the given user's public keys",
  8903. "operationId": "userListKeys",
  8904. "parameters": [
  8905. {
  8906. "type": "string",
  8907. "description": "username of user",
  8908. "name": "username",
  8909. "in": "path",
  8910. "required": true
  8911. },
  8912. {
  8913. "type": "string",
  8914. "description": "fingerprint of the key",
  8915. "name": "fingerprint",
  8916. "in": "query"
  8917. },
  8918. {
  8919. "type": "integer",
  8920. "description": "page number of results to return (1-based)",
  8921. "name": "page",
  8922. "in": "query"
  8923. },
  8924. {
  8925. "type": "integer",
  8926. "description": "page size of results, maximum page size is 50",
  8927. "name": "limit",
  8928. "in": "query"
  8929. }
  8930. ],
  8931. "responses": {
  8932. "200": {
  8933. "$ref": "#/responses/PublicKeyList"
  8934. }
  8935. }
  8936. }
  8937. },
  8938. "/users/{username}/orgs": {
  8939. "get": {
  8940. "produces": [
  8941. "application/json"
  8942. ],
  8943. "tags": [
  8944. "organization"
  8945. ],
  8946. "summary": "List a user's organizations",
  8947. "operationId": "orgListUserOrgs",
  8948. "parameters": [
  8949. {
  8950. "type": "string",
  8951. "description": "username of user",
  8952. "name": "username",
  8953. "in": "path",
  8954. "required": true
  8955. },
  8956. {
  8957. "type": "integer",
  8958. "description": "page number of results to return (1-based)",
  8959. "name": "page",
  8960. "in": "query"
  8961. },
  8962. {
  8963. "type": "integer",
  8964. "description": "page size of results, maximum page size is 50",
  8965. "name": "limit",
  8966. "in": "query"
  8967. }
  8968. ],
  8969. "responses": {
  8970. "200": {
  8971. "$ref": "#/responses/OrganizationList"
  8972. }
  8973. }
  8974. }
  8975. },
  8976. "/users/{username}/repos": {
  8977. "get": {
  8978. "produces": [
  8979. "application/json"
  8980. ],
  8981. "tags": [
  8982. "user"
  8983. ],
  8984. "summary": "List the repos owned by the given user",
  8985. "operationId": "userListRepos",
  8986. "parameters": [
  8987. {
  8988. "type": "string",
  8989. "description": "username of user",
  8990. "name": "username",
  8991. "in": "path",
  8992. "required": true
  8993. },
  8994. {
  8995. "type": "integer",
  8996. "description": "page number of results to return (1-based)",
  8997. "name": "page",
  8998. "in": "query"
  8999. },
  9000. {
  9001. "type": "integer",
  9002. "description": "page size of results, maximum page size is 50",
  9003. "name": "limit",
  9004. "in": "query"
  9005. }
  9006. ],
  9007. "responses": {
  9008. "200": {
  9009. "$ref": "#/responses/RepositoryList"
  9010. }
  9011. }
  9012. }
  9013. },
  9014. "/users/{username}/starred": {
  9015. "get": {
  9016. "produces": [
  9017. "application/json"
  9018. ],
  9019. "tags": [
  9020. "user"
  9021. ],
  9022. "summary": "The repos that the given user has starred",
  9023. "operationId": "userListStarred",
  9024. "parameters": [
  9025. {
  9026. "type": "string",
  9027. "description": "username of user",
  9028. "name": "username",
  9029. "in": "path",
  9030. "required": true
  9031. },
  9032. {
  9033. "type": "integer",
  9034. "description": "page number of results to return (1-based)",
  9035. "name": "page",
  9036. "in": "query"
  9037. },
  9038. {
  9039. "type": "integer",
  9040. "description": "page size of results, maximum page size is 50",
  9041. "name": "limit",
  9042. "in": "query"
  9043. }
  9044. ],
  9045. "responses": {
  9046. "200": {
  9047. "$ref": "#/responses/RepositoryList"
  9048. }
  9049. }
  9050. }
  9051. },
  9052. "/users/{username}/subscriptions": {
  9053. "get": {
  9054. "produces": [
  9055. "application/json"
  9056. ],
  9057. "tags": [
  9058. "user"
  9059. ],
  9060. "summary": "List the repositories watched by a user",
  9061. "operationId": "userListSubscriptions",
  9062. "parameters": [
  9063. {
  9064. "type": "string",
  9065. "description": "username of the user",
  9066. "name": "username",
  9067. "in": "path",
  9068. "required": true
  9069. },
  9070. {
  9071. "type": "integer",
  9072. "description": "page number of results to return (1-based)",
  9073. "name": "page",
  9074. "in": "query"
  9075. },
  9076. {
  9077. "type": "integer",
  9078. "description": "page size of results, maximum page size is 50",
  9079. "name": "limit",
  9080. "in": "query"
  9081. }
  9082. ],
  9083. "responses": {
  9084. "200": {
  9085. "$ref": "#/responses/RepositoryList"
  9086. }
  9087. }
  9088. }
  9089. },
  9090. "/users/{username}/tokens": {
  9091. "get": {
  9092. "produces": [
  9093. "application/json"
  9094. ],
  9095. "tags": [
  9096. "user"
  9097. ],
  9098. "summary": "List the authenticated user's access tokens",
  9099. "operationId": "userGetTokens",
  9100. "parameters": [
  9101. {
  9102. "type": "string",
  9103. "description": "username of user",
  9104. "name": "username",
  9105. "in": "path",
  9106. "required": true
  9107. },
  9108. {
  9109. "type": "integer",
  9110. "description": "page number of results to return (1-based)",
  9111. "name": "page",
  9112. "in": "query"
  9113. },
  9114. {
  9115. "type": "integer",
  9116. "description": "page size of results, maximum page size is 50",
  9117. "name": "limit",
  9118. "in": "query"
  9119. }
  9120. ],
  9121. "responses": {
  9122. "200": {
  9123. "$ref": "#/responses/AccessTokenList"
  9124. }
  9125. }
  9126. },
  9127. "post": {
  9128. "consumes": [
  9129. "application/json"
  9130. ],
  9131. "produces": [
  9132. "application/json"
  9133. ],
  9134. "tags": [
  9135. "user"
  9136. ],
  9137. "summary": "Create an access token",
  9138. "operationId": "userCreateToken",
  9139. "parameters": [
  9140. {
  9141. "type": "string",
  9142. "x-go-name": "Name",
  9143. "description": "username of user",
  9144. "name": "username",
  9145. "in": "path",
  9146. "required": true
  9147. },
  9148. {
  9149. "name": "accessToken",
  9150. "in": "body",
  9151. "schema": {
  9152. "type": "object",
  9153. "required": [
  9154. "name"
  9155. ],
  9156. "properties": {
  9157. "name": {
  9158. "type": "string"
  9159. }
  9160. }
  9161. }
  9162. }
  9163. ],
  9164. "responses": {
  9165. "200": {
  9166. "$ref": "#/responses/AccessToken"
  9167. }
  9168. }
  9169. }
  9170. },
  9171. "/users/{username}/tokens/{token}": {
  9172. "delete": {
  9173. "produces": [
  9174. "application/json"
  9175. ],
  9176. "tags": [
  9177. "user"
  9178. ],
  9179. "summary": "delete an access token",
  9180. "operationId": "userDeleteAccessToken",
  9181. "parameters": [
  9182. {
  9183. "type": "string",
  9184. "description": "username of user",
  9185. "name": "username",
  9186. "in": "path",
  9187. "required": true
  9188. },
  9189. {
  9190. "type": "integer",
  9191. "format": "int64",
  9192. "description": "token to be deleted",
  9193. "name": "token",
  9194. "in": "path",
  9195. "required": true
  9196. }
  9197. ],
  9198. "responses": {
  9199. "204": {
  9200. "$ref": "#/responses/empty"
  9201. }
  9202. }
  9203. }
  9204. },
  9205. "/version": {
  9206. "get": {
  9207. "produces": [
  9208. "application/json"
  9209. ],
  9210. "tags": [
  9211. "miscellaneous"
  9212. ],
  9213. "summary": "Returns the version of the Gitea application",
  9214. "operationId": "getVersion",
  9215. "responses": {
  9216. "200": {
  9217. "$ref": "#/responses/ServerVersion"
  9218. }
  9219. }
  9220. }
  9221. }
  9222. },
  9223. "definitions": {
  9224. "APIError": {
  9225. "description": "APIError is an api error with a message",
  9226. "type": "object",
  9227. "properties": {
  9228. "message": {
  9229. "type": "string",
  9230. "x-go-name": "Message"
  9231. },
  9232. "url": {
  9233. "type": "string",
  9234. "x-go-name": "URL"
  9235. }
  9236. },
  9237. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9238. },
  9239. "AccessToken": {
  9240. "type": "object",
  9241. "title": "AccessToken represents an API access token.",
  9242. "properties": {
  9243. "id": {
  9244. "type": "integer",
  9245. "format": "int64",
  9246. "x-go-name": "ID"
  9247. },
  9248. "name": {
  9249. "type": "string",
  9250. "x-go-name": "Name"
  9251. },
  9252. "sha1": {
  9253. "type": "string",
  9254. "x-go-name": "Token"
  9255. },
  9256. "token_last_eight": {
  9257. "type": "string",
  9258. "x-go-name": "TokenLastEight"
  9259. }
  9260. },
  9261. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9262. },
  9263. "AddCollaboratorOption": {
  9264. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  9265. "type": "object",
  9266. "properties": {
  9267. "permission": {
  9268. "type": "string",
  9269. "x-go-name": "Permission"
  9270. }
  9271. },
  9272. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9273. },
  9274. "AddTimeOption": {
  9275. "description": "AddTimeOption options for adding time to an issue",
  9276. "type": "object",
  9277. "required": [
  9278. "time"
  9279. ],
  9280. "properties": {
  9281. "created": {
  9282. "type": "string",
  9283. "format": "date-time",
  9284. "x-go-name": "Created"
  9285. },
  9286. "time": {
  9287. "description": "time in seconds",
  9288. "type": "integer",
  9289. "format": "int64",
  9290. "x-go-name": "Time"
  9291. },
  9292. "user_name": {
  9293. "description": "User who spent the time (optional)",
  9294. "type": "string",
  9295. "x-go-name": "User"
  9296. }
  9297. },
  9298. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9299. },
  9300. "AnnotatedTag": {
  9301. "description": "AnnotatedTag represents an annotated tag",
  9302. "type": "object",
  9303. "properties": {
  9304. "message": {
  9305. "type": "string",
  9306. "x-go-name": "Message"
  9307. },
  9308. "object": {
  9309. "$ref": "#/definitions/AnnotatedTagObject"
  9310. },
  9311. "sha": {
  9312. "type": "string",
  9313. "x-go-name": "SHA"
  9314. },
  9315. "tag": {
  9316. "type": "string",
  9317. "x-go-name": "Tag"
  9318. },
  9319. "tagger": {
  9320. "$ref": "#/definitions/CommitUser"
  9321. },
  9322. "url": {
  9323. "type": "string",
  9324. "x-go-name": "URL"
  9325. },
  9326. "verification": {
  9327. "$ref": "#/definitions/PayloadCommitVerification"
  9328. }
  9329. },
  9330. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9331. },
  9332. "AnnotatedTagObject": {
  9333. "description": "AnnotatedTagObject contains meta information of the tag object",
  9334. "type": "object",
  9335. "properties": {
  9336. "sha": {
  9337. "type": "string",
  9338. "x-go-name": "SHA"
  9339. },
  9340. "type": {
  9341. "type": "string",
  9342. "x-go-name": "Type"
  9343. },
  9344. "url": {
  9345. "type": "string",
  9346. "x-go-name": "URL"
  9347. }
  9348. },
  9349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9350. },
  9351. "Attachment": {
  9352. "description": "Attachment a generic attachment",
  9353. "type": "object",
  9354. "properties": {
  9355. "browser_download_url": {
  9356. "type": "string",
  9357. "x-go-name": "DownloadURL"
  9358. },
  9359. "created_at": {
  9360. "type": "string",
  9361. "format": "date-time",
  9362. "x-go-name": "Created"
  9363. },
  9364. "download_count": {
  9365. "type": "integer",
  9366. "format": "int64",
  9367. "x-go-name": "DownloadCount"
  9368. },
  9369. "id": {
  9370. "type": "integer",
  9371. "format": "int64",
  9372. "x-go-name": "ID"
  9373. },
  9374. "name": {
  9375. "type": "string",
  9376. "x-go-name": "Name"
  9377. },
  9378. "size": {
  9379. "type": "integer",
  9380. "format": "int64",
  9381. "x-go-name": "Size"
  9382. },
  9383. "uuid": {
  9384. "type": "string",
  9385. "x-go-name": "UUID"
  9386. }
  9387. },
  9388. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9389. },
  9390. "Branch": {
  9391. "description": "Branch represents a repository branch",
  9392. "type": "object",
  9393. "properties": {
  9394. "commit": {
  9395. "$ref": "#/definitions/PayloadCommit"
  9396. },
  9397. "enable_status_check": {
  9398. "type": "boolean",
  9399. "x-go-name": "EnableStatusCheck"
  9400. },
  9401. "name": {
  9402. "type": "string",
  9403. "x-go-name": "Name"
  9404. },
  9405. "protected": {
  9406. "type": "boolean",
  9407. "x-go-name": "Protected"
  9408. },
  9409. "required_approvals": {
  9410. "type": "integer",
  9411. "format": "int64",
  9412. "x-go-name": "RequiredApprovals"
  9413. },
  9414. "status_check_contexts": {
  9415. "type": "array",
  9416. "items": {
  9417. "type": "string"
  9418. },
  9419. "x-go-name": "StatusCheckContexts"
  9420. },
  9421. "user_can_merge": {
  9422. "type": "boolean",
  9423. "x-go-name": "UserCanMerge"
  9424. },
  9425. "user_can_push": {
  9426. "type": "boolean",
  9427. "x-go-name": "UserCanPush"
  9428. }
  9429. },
  9430. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9431. },
  9432. "Comment": {
  9433. "description": "Comment represents a comment on a commit or issue",
  9434. "type": "object",
  9435. "properties": {
  9436. "body": {
  9437. "type": "string",
  9438. "x-go-name": "Body"
  9439. },
  9440. "created_at": {
  9441. "type": "string",
  9442. "format": "date-time",
  9443. "x-go-name": "Created"
  9444. },
  9445. "html_url": {
  9446. "type": "string",
  9447. "x-go-name": "HTMLURL"
  9448. },
  9449. "id": {
  9450. "type": "integer",
  9451. "format": "int64",
  9452. "x-go-name": "ID"
  9453. },
  9454. "issue_url": {
  9455. "type": "string",
  9456. "x-go-name": "IssueURL"
  9457. },
  9458. "original_author": {
  9459. "type": "string",
  9460. "x-go-name": "OriginalAuthor"
  9461. },
  9462. "original_author_id": {
  9463. "type": "integer",
  9464. "format": "int64",
  9465. "x-go-name": "OriginalAuthorID"
  9466. },
  9467. "pull_request_url": {
  9468. "type": "string",
  9469. "x-go-name": "PRURL"
  9470. },
  9471. "updated_at": {
  9472. "type": "string",
  9473. "format": "date-time",
  9474. "x-go-name": "Updated"
  9475. },
  9476. "user": {
  9477. "$ref": "#/definitions/User"
  9478. }
  9479. },
  9480. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9481. },
  9482. "Commit": {
  9483. "type": "object",
  9484. "title": "Commit contains information generated from a Git commit.",
  9485. "properties": {
  9486. "author": {
  9487. "$ref": "#/definitions/User"
  9488. },
  9489. "commit": {
  9490. "$ref": "#/definitions/RepoCommit"
  9491. },
  9492. "committer": {
  9493. "$ref": "#/definitions/User"
  9494. },
  9495. "html_url": {
  9496. "type": "string",
  9497. "x-go-name": "HTMLURL"
  9498. },
  9499. "parents": {
  9500. "type": "array",
  9501. "items": {
  9502. "$ref": "#/definitions/CommitMeta"
  9503. },
  9504. "x-go-name": "Parents"
  9505. },
  9506. "sha": {
  9507. "type": "string",
  9508. "x-go-name": "SHA"
  9509. },
  9510. "url": {
  9511. "type": "string",
  9512. "x-go-name": "URL"
  9513. }
  9514. },
  9515. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9516. },
  9517. "CommitDateOptions": {
  9518. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  9519. "type": "object",
  9520. "properties": {
  9521. "author": {
  9522. "type": "string",
  9523. "format": "date-time",
  9524. "x-go-name": "Author"
  9525. },
  9526. "committer": {
  9527. "type": "string",
  9528. "format": "date-time",
  9529. "x-go-name": "Committer"
  9530. }
  9531. },
  9532. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9533. },
  9534. "CommitMeta": {
  9535. "type": "object",
  9536. "title": "CommitMeta contains meta information of a commit in terms of API.",
  9537. "properties": {
  9538. "sha": {
  9539. "type": "string",
  9540. "x-go-name": "SHA"
  9541. },
  9542. "url": {
  9543. "type": "string",
  9544. "x-go-name": "URL"
  9545. }
  9546. },
  9547. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9548. },
  9549. "CommitUser": {
  9550. "type": "object",
  9551. "title": "CommitUser contains information of a user in the context of a commit.",
  9552. "properties": {
  9553. "date": {
  9554. "type": "string",
  9555. "x-go-name": "Date"
  9556. },
  9557. "email": {
  9558. "type": "string",
  9559. "format": "email",
  9560. "x-go-name": "Email"
  9561. },
  9562. "name": {
  9563. "type": "string",
  9564. "x-go-name": "Name"
  9565. }
  9566. },
  9567. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9568. },
  9569. "ContentsResponse": {
  9570. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  9571. "type": "object",
  9572. "properties": {
  9573. "_links": {
  9574. "$ref": "#/definitions/FileLinksResponse"
  9575. },
  9576. "content": {
  9577. "description": "`content` is populated when `type` is `file`, otherwise null",
  9578. "type": "string",
  9579. "x-go-name": "Content"
  9580. },
  9581. "download_url": {
  9582. "type": "string",
  9583. "x-go-name": "DownloadURL"
  9584. },
  9585. "encoding": {
  9586. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  9587. "type": "string",
  9588. "x-go-name": "Encoding"
  9589. },
  9590. "git_url": {
  9591. "type": "string",
  9592. "x-go-name": "GitURL"
  9593. },
  9594. "html_url": {
  9595. "type": "string",
  9596. "x-go-name": "HTMLURL"
  9597. },
  9598. "name": {
  9599. "type": "string",
  9600. "x-go-name": "Name"
  9601. },
  9602. "path": {
  9603. "type": "string",
  9604. "x-go-name": "Path"
  9605. },
  9606. "sha": {
  9607. "type": "string",
  9608. "x-go-name": "SHA"
  9609. },
  9610. "size": {
  9611. "type": "integer",
  9612. "format": "int64",
  9613. "x-go-name": "Size"
  9614. },
  9615. "submodule_git_url": {
  9616. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  9617. "type": "string",
  9618. "x-go-name": "SubmoduleGitURL"
  9619. },
  9620. "target": {
  9621. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  9622. "type": "string",
  9623. "x-go-name": "Target"
  9624. },
  9625. "type": {
  9626. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  9627. "type": "string",
  9628. "x-go-name": "Type"
  9629. },
  9630. "url": {
  9631. "type": "string",
  9632. "x-go-name": "URL"
  9633. }
  9634. },
  9635. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9636. },
  9637. "CreateEmailOption": {
  9638. "description": "CreateEmailOption options when creating email addresses",
  9639. "type": "object",
  9640. "properties": {
  9641. "emails": {
  9642. "description": "email addresses to add",
  9643. "type": "array",
  9644. "items": {
  9645. "type": "string"
  9646. },
  9647. "x-go-name": "Emails"
  9648. }
  9649. },
  9650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9651. },
  9652. "CreateFileOptions": {
  9653. "description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  9654. "type": "object",
  9655. "required": [
  9656. "content"
  9657. ],
  9658. "properties": {
  9659. "author": {
  9660. "$ref": "#/definitions/Identity"
  9661. },
  9662. "branch": {
  9663. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  9664. "type": "string",
  9665. "x-go-name": "BranchName"
  9666. },
  9667. "committer": {
  9668. "$ref": "#/definitions/Identity"
  9669. },
  9670. "content": {
  9671. "description": "content must be base64 encoded",
  9672. "type": "string",
  9673. "x-go-name": "Content"
  9674. },
  9675. "dates": {
  9676. "$ref": "#/definitions/CommitDateOptions"
  9677. },
  9678. "message": {
  9679. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  9680. "type": "string",
  9681. "x-go-name": "Message"
  9682. },
  9683. "new_branch": {
  9684. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  9685. "type": "string",
  9686. "x-go-name": "NewBranchName"
  9687. }
  9688. },
  9689. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9690. },
  9691. "CreateForkOption": {
  9692. "description": "CreateForkOption options for creating a fork",
  9693. "type": "object",
  9694. "properties": {
  9695. "organization": {
  9696. "description": "organization name, if forking into an organization",
  9697. "type": "string",
  9698. "x-go-name": "Organization"
  9699. }
  9700. },
  9701. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9702. },
  9703. "CreateGPGKeyOption": {
  9704. "description": "CreateGPGKeyOption options create user GPG key",
  9705. "type": "object",
  9706. "required": [
  9707. "armored_public_key"
  9708. ],
  9709. "properties": {
  9710. "armored_public_key": {
  9711. "description": "An armored GPG key to add",
  9712. "type": "string",
  9713. "uniqueItems": true,
  9714. "x-go-name": "ArmoredKey"
  9715. }
  9716. },
  9717. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9718. },
  9719. "CreateHookOption": {
  9720. "description": "CreateHookOption options when create a hook",
  9721. "type": "object",
  9722. "required": [
  9723. "type",
  9724. "config"
  9725. ],
  9726. "properties": {
  9727. "active": {
  9728. "type": "boolean",
  9729. "default": false,
  9730. "x-go-name": "Active"
  9731. },
  9732. "branch_filter": {
  9733. "type": "string",
  9734. "x-go-name": "BranchFilter"
  9735. },
  9736. "config": {
  9737. "$ref": "#/definitions/CreateHookOptionConfig"
  9738. },
  9739. "events": {
  9740. "type": "array",
  9741. "items": {
  9742. "type": "string"
  9743. },
  9744. "x-go-name": "Events"
  9745. },
  9746. "type": {
  9747. "type": "string",
  9748. "enum": [
  9749. "dingtalk",
  9750. "discord",
  9751. "gitea",
  9752. "gogs",
  9753. "msteams",
  9754. "slack",
  9755. "telegram"
  9756. ],
  9757. "x-go-name": "Type"
  9758. }
  9759. },
  9760. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9761. },
  9762. "CreateHookOptionConfig": {
  9763. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  9764. "type": "object",
  9765. "additionalProperties": {
  9766. "type": "string"
  9767. },
  9768. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9769. },
  9770. "CreateIssueCommentOption": {
  9771. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  9772. "type": "object",
  9773. "required": [
  9774. "body"
  9775. ],
  9776. "properties": {
  9777. "body": {
  9778. "type": "string",
  9779. "x-go-name": "Body"
  9780. }
  9781. },
  9782. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9783. },
  9784. "CreateIssueOption": {
  9785. "description": "CreateIssueOption options to create one issue",
  9786. "type": "object",
  9787. "required": [
  9788. "title"
  9789. ],
  9790. "properties": {
  9791. "assignee": {
  9792. "description": "username of assignee",
  9793. "type": "string",
  9794. "x-go-name": "Assignee"
  9795. },
  9796. "assignees": {
  9797. "type": "array",
  9798. "items": {
  9799. "type": "string"
  9800. },
  9801. "x-go-name": "Assignees"
  9802. },
  9803. "body": {
  9804. "type": "string",
  9805. "x-go-name": "Body"
  9806. },
  9807. "closed": {
  9808. "type": "boolean",
  9809. "x-go-name": "Closed"
  9810. },
  9811. "due_date": {
  9812. "type": "string",
  9813. "format": "date-time",
  9814. "x-go-name": "Deadline"
  9815. },
  9816. "labels": {
  9817. "description": "list of label ids",
  9818. "type": "array",
  9819. "items": {
  9820. "type": "integer",
  9821. "format": "int64"
  9822. },
  9823. "x-go-name": "Labels"
  9824. },
  9825. "milestone": {
  9826. "description": "milestone id",
  9827. "type": "integer",
  9828. "format": "int64",
  9829. "x-go-name": "Milestone"
  9830. },
  9831. "title": {
  9832. "type": "string",
  9833. "x-go-name": "Title"
  9834. }
  9835. },
  9836. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9837. },
  9838. "CreateKeyOption": {
  9839. "description": "CreateKeyOption options when creating a key",
  9840. "type": "object",
  9841. "required": [
  9842. "title",
  9843. "key"
  9844. ],
  9845. "properties": {
  9846. "key": {
  9847. "description": "An armored SSH key to add",
  9848. "type": "string",
  9849. "uniqueItems": true,
  9850. "x-go-name": "Key"
  9851. },
  9852. "read_only": {
  9853. "description": "Describe if the key has only read access or read/write",
  9854. "type": "boolean",
  9855. "x-go-name": "ReadOnly"
  9856. },
  9857. "title": {
  9858. "description": "Title of the key to add",
  9859. "type": "string",
  9860. "uniqueItems": true,
  9861. "x-go-name": "Title"
  9862. }
  9863. },
  9864. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9865. },
  9866. "CreateLabelOption": {
  9867. "description": "CreateLabelOption options for creating a label",
  9868. "type": "object",
  9869. "required": [
  9870. "name",
  9871. "color"
  9872. ],
  9873. "properties": {
  9874. "color": {
  9875. "type": "string",
  9876. "x-go-name": "Color",
  9877. "example": "#00aabb"
  9878. },
  9879. "description": {
  9880. "type": "string",
  9881. "x-go-name": "Description"
  9882. },
  9883. "name": {
  9884. "type": "string",
  9885. "x-go-name": "Name"
  9886. }
  9887. },
  9888. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9889. },
  9890. "CreateMilestoneOption": {
  9891. "description": "CreateMilestoneOption options for creating a milestone",
  9892. "type": "object",
  9893. "properties": {
  9894. "description": {
  9895. "type": "string",
  9896. "x-go-name": "Description"
  9897. },
  9898. "due_on": {
  9899. "type": "string",
  9900. "format": "date-time",
  9901. "x-go-name": "Deadline"
  9902. },
  9903. "title": {
  9904. "type": "string",
  9905. "x-go-name": "Title"
  9906. }
  9907. },
  9908. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9909. },
  9910. "CreateOrgOption": {
  9911. "description": "CreateOrgOption options for creating an organization",
  9912. "type": "object",
  9913. "required": [
  9914. "username"
  9915. ],
  9916. "properties": {
  9917. "description": {
  9918. "type": "string",
  9919. "x-go-name": "Description"
  9920. },
  9921. "full_name": {
  9922. "type": "string",
  9923. "x-go-name": "FullName"
  9924. },
  9925. "location": {
  9926. "type": "string",
  9927. "x-go-name": "Location"
  9928. },
  9929. "repo_admin_change_team_access": {
  9930. "type": "boolean",
  9931. "x-go-name": "RepoAdminChangeTeamAccess"
  9932. },
  9933. "username": {
  9934. "type": "string",
  9935. "x-go-name": "UserName"
  9936. },
  9937. "visibility": {
  9938. "description": "possible values are `public` (default), `limited` or `private`",
  9939. "type": "string",
  9940. "enum": [
  9941. "public",
  9942. "limited",
  9943. "private"
  9944. ],
  9945. "x-go-name": "Visibility"
  9946. },
  9947. "website": {
  9948. "type": "string",
  9949. "x-go-name": "Website"
  9950. }
  9951. },
  9952. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9953. },
  9954. "CreatePullRequestOption": {
  9955. "description": "CreatePullRequestOption options when creating a pull request",
  9956. "type": "object",
  9957. "properties": {
  9958. "assignee": {
  9959. "type": "string",
  9960. "x-go-name": "Assignee"
  9961. },
  9962. "assignees": {
  9963. "type": "array",
  9964. "items": {
  9965. "type": "string"
  9966. },
  9967. "x-go-name": "Assignees"
  9968. },
  9969. "base": {
  9970. "type": "string",
  9971. "x-go-name": "Base"
  9972. },
  9973. "body": {
  9974. "type": "string",
  9975. "x-go-name": "Body"
  9976. },
  9977. "due_date": {
  9978. "type": "string",
  9979. "format": "date-time",
  9980. "x-go-name": "Deadline"
  9981. },
  9982. "head": {
  9983. "type": "string",
  9984. "x-go-name": "Head"
  9985. },
  9986. "labels": {
  9987. "type": "array",
  9988. "items": {
  9989. "type": "integer",
  9990. "format": "int64"
  9991. },
  9992. "x-go-name": "Labels"
  9993. },
  9994. "milestone": {
  9995. "type": "integer",
  9996. "format": "int64",
  9997. "x-go-name": "Milestone"
  9998. },
  9999. "title": {
  10000. "type": "string",
  10001. "x-go-name": "Title"
  10002. }
  10003. },
  10004. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10005. },
  10006. "CreateReleaseOption": {
  10007. "description": "CreateReleaseOption options when creating a release",
  10008. "type": "object",
  10009. "required": [
  10010. "tag_name"
  10011. ],
  10012. "properties": {
  10013. "body": {
  10014. "type": "string",
  10015. "x-go-name": "Note"
  10016. },
  10017. "draft": {
  10018. "type": "boolean",
  10019. "x-go-name": "IsDraft"
  10020. },
  10021. "name": {
  10022. "type": "string",
  10023. "x-go-name": "Title"
  10024. },
  10025. "prerelease": {
  10026. "type": "boolean",
  10027. "x-go-name": "IsPrerelease"
  10028. },
  10029. "tag_name": {
  10030. "type": "string",
  10031. "x-go-name": "TagName"
  10032. },
  10033. "target_commitish": {
  10034. "type": "string",
  10035. "x-go-name": "Target"
  10036. }
  10037. },
  10038. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10039. },
  10040. "CreateRepoOption": {
  10041. "description": "CreateRepoOption options when creating repository",
  10042. "type": "object",
  10043. "required": [
  10044. "name"
  10045. ],
  10046. "properties": {
  10047. "auto_init": {
  10048. "description": "Whether the repository should be auto-intialized?",
  10049. "type": "boolean",
  10050. "x-go-name": "AutoInit"
  10051. },
  10052. "description": {
  10053. "description": "Description of the repository to create",
  10054. "type": "string",
  10055. "x-go-name": "Description"
  10056. },
  10057. "gitignores": {
  10058. "description": "Gitignores to use",
  10059. "type": "string",
  10060. "x-go-name": "Gitignores"
  10061. },
  10062. "issue_labels": {
  10063. "description": "Issue Label set to use",
  10064. "type": "string",
  10065. "x-go-name": "IssueLabels"
  10066. },
  10067. "license": {
  10068. "description": "License to use",
  10069. "type": "string",
  10070. "x-go-name": "License"
  10071. },
  10072. "name": {
  10073. "description": "Name of the repository to create",
  10074. "type": "string",
  10075. "uniqueItems": true,
  10076. "x-go-name": "Name"
  10077. },
  10078. "private": {
  10079. "description": "Whether the repository is private",
  10080. "type": "boolean",
  10081. "x-go-name": "Private"
  10082. },
  10083. "readme": {
  10084. "description": "Readme of the repository to create",
  10085. "type": "string",
  10086. "x-go-name": "Readme"
  10087. }
  10088. },
  10089. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10090. },
  10091. "CreateStatusOption": {
  10092. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  10093. "type": "object",
  10094. "properties": {
  10095. "context": {
  10096. "type": "string",
  10097. "x-go-name": "Context"
  10098. },
  10099. "description": {
  10100. "type": "string",
  10101. "x-go-name": "Description"
  10102. },
  10103. "state": {
  10104. "$ref": "#/definitions/StatusState"
  10105. },
  10106. "target_url": {
  10107. "type": "string",
  10108. "x-go-name": "TargetURL"
  10109. }
  10110. },
  10111. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10112. },
  10113. "CreateTeamOption": {
  10114. "description": "CreateTeamOption options for creating a team",
  10115. "type": "object",
  10116. "required": [
  10117. "name"
  10118. ],
  10119. "properties": {
  10120. "can_create_org_repo": {
  10121. "type": "boolean",
  10122. "x-go-name": "CanCreateOrgRepo"
  10123. },
  10124. "description": {
  10125. "type": "string",
  10126. "x-go-name": "Description"
  10127. },
  10128. "includes_all_repositories": {
  10129. "type": "boolean",
  10130. "x-go-name": "IncludesAllRepositories"
  10131. },
  10132. "name": {
  10133. "type": "string",
  10134. "x-go-name": "Name"
  10135. },
  10136. "permission": {
  10137. "type": "string",
  10138. "enum": [
  10139. "read",
  10140. "write",
  10141. "admin"
  10142. ],
  10143. "x-go-name": "Permission"
  10144. },
  10145. "units": {
  10146. "type": "array",
  10147. "items": {
  10148. "type": "string"
  10149. },
  10150. "x-go-name": "Units",
  10151. "example": [
  10152. "repo.code",
  10153. "repo.issues",
  10154. "repo.ext_issues",
  10155. "repo.wiki",
  10156. "repo.pulls",
  10157. "repo.releases",
  10158. "repo.ext_wiki"
  10159. ]
  10160. }
  10161. },
  10162. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10163. },
  10164. "CreateUserOption": {
  10165. "description": "CreateUserOption create user options",
  10166. "type": "object",
  10167. "required": [
  10168. "username",
  10169. "email",
  10170. "password"
  10171. ],
  10172. "properties": {
  10173. "email": {
  10174. "type": "string",
  10175. "format": "email",
  10176. "x-go-name": "Email"
  10177. },
  10178. "full_name": {
  10179. "type": "string",
  10180. "x-go-name": "FullName"
  10181. },
  10182. "login_name": {
  10183. "type": "string",
  10184. "x-go-name": "LoginName"
  10185. },
  10186. "must_change_password": {
  10187. "type": "boolean",
  10188. "x-go-name": "MustChangePassword"
  10189. },
  10190. "password": {
  10191. "type": "string",
  10192. "x-go-name": "Password"
  10193. },
  10194. "send_notify": {
  10195. "type": "boolean",
  10196. "x-go-name": "SendNotify"
  10197. },
  10198. "source_id": {
  10199. "type": "integer",
  10200. "format": "int64",
  10201. "x-go-name": "SourceID"
  10202. },
  10203. "username": {
  10204. "type": "string",
  10205. "x-go-name": "Username"
  10206. }
  10207. },
  10208. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10209. },
  10210. "DeleteEmailOption": {
  10211. "description": "DeleteEmailOption options when deleting email addresses",
  10212. "type": "object",
  10213. "properties": {
  10214. "emails": {
  10215. "description": "email addresses to delete",
  10216. "type": "array",
  10217. "items": {
  10218. "type": "string"
  10219. },
  10220. "x-go-name": "Emails"
  10221. }
  10222. },
  10223. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10224. },
  10225. "DeleteFileOptions": {
  10226. "description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  10227. "type": "object",
  10228. "required": [
  10229. "sha"
  10230. ],
  10231. "properties": {
  10232. "author": {
  10233. "$ref": "#/definitions/Identity"
  10234. },
  10235. "branch": {
  10236. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10237. "type": "string",
  10238. "x-go-name": "BranchName"
  10239. },
  10240. "committer": {
  10241. "$ref": "#/definitions/Identity"
  10242. },
  10243. "dates": {
  10244. "$ref": "#/definitions/CommitDateOptions"
  10245. },
  10246. "message": {
  10247. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10248. "type": "string",
  10249. "x-go-name": "Message"
  10250. },
  10251. "new_branch": {
  10252. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10253. "type": "string",
  10254. "x-go-name": "NewBranchName"
  10255. },
  10256. "sha": {
  10257. "description": "sha is the SHA for the file that already exists",
  10258. "type": "string",
  10259. "x-go-name": "SHA"
  10260. }
  10261. },
  10262. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10263. },
  10264. "DeployKey": {
  10265. "description": "DeployKey a deploy key",
  10266. "type": "object",
  10267. "properties": {
  10268. "created_at": {
  10269. "type": "string",
  10270. "format": "date-time",
  10271. "x-go-name": "Created"
  10272. },
  10273. "fingerprint": {
  10274. "type": "string",
  10275. "x-go-name": "Fingerprint"
  10276. },
  10277. "id": {
  10278. "type": "integer",
  10279. "format": "int64",
  10280. "x-go-name": "ID"
  10281. },
  10282. "key": {
  10283. "type": "string",
  10284. "x-go-name": "Key"
  10285. },
  10286. "key_id": {
  10287. "type": "integer",
  10288. "format": "int64",
  10289. "x-go-name": "KeyID"
  10290. },
  10291. "read_only": {
  10292. "type": "boolean",
  10293. "x-go-name": "ReadOnly"
  10294. },
  10295. "repository": {
  10296. "$ref": "#/definitions/Repository"
  10297. },
  10298. "title": {
  10299. "type": "string",
  10300. "x-go-name": "Title"
  10301. },
  10302. "url": {
  10303. "type": "string",
  10304. "x-go-name": "URL"
  10305. }
  10306. },
  10307. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10308. },
  10309. "EditAttachmentOptions": {
  10310. "description": "EditAttachmentOptions options for editing attachments",
  10311. "type": "object",
  10312. "properties": {
  10313. "name": {
  10314. "type": "string",
  10315. "x-go-name": "Name"
  10316. }
  10317. },
  10318. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10319. },
  10320. "EditDeadlineOption": {
  10321. "description": "EditDeadlineOption options for creating a deadline",
  10322. "type": "object",
  10323. "required": [
  10324. "due_date"
  10325. ],
  10326. "properties": {
  10327. "due_date": {
  10328. "type": "string",
  10329. "format": "date-time",
  10330. "x-go-name": "Deadline"
  10331. }
  10332. },
  10333. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10334. },
  10335. "EditGitHookOption": {
  10336. "description": "EditGitHookOption options when modifying one Git hook",
  10337. "type": "object",
  10338. "properties": {
  10339. "content": {
  10340. "type": "string",
  10341. "x-go-name": "Content"
  10342. }
  10343. },
  10344. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10345. },
  10346. "EditHookOption": {
  10347. "description": "EditHookOption options when modify one hook",
  10348. "type": "object",
  10349. "properties": {
  10350. "active": {
  10351. "type": "boolean",
  10352. "x-go-name": "Active"
  10353. },
  10354. "branch_filter": {
  10355. "type": "string",
  10356. "x-go-name": "BranchFilter"
  10357. },
  10358. "config": {
  10359. "type": "object",
  10360. "additionalProperties": {
  10361. "type": "string"
  10362. },
  10363. "x-go-name": "Config"
  10364. },
  10365. "events": {
  10366. "type": "array",
  10367. "items": {
  10368. "type": "string"
  10369. },
  10370. "x-go-name": "Events"
  10371. }
  10372. },
  10373. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10374. },
  10375. "EditIssueCommentOption": {
  10376. "description": "EditIssueCommentOption options for editing a comment",
  10377. "type": "object",
  10378. "required": [
  10379. "body"
  10380. ],
  10381. "properties": {
  10382. "body": {
  10383. "type": "string",
  10384. "x-go-name": "Body"
  10385. }
  10386. },
  10387. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10388. },
  10389. "EditIssueOption": {
  10390. "description": "EditIssueOption options for editing an issue",
  10391. "type": "object",
  10392. "properties": {
  10393. "assignee": {
  10394. "type": "string",
  10395. "x-go-name": "Assignee"
  10396. },
  10397. "assignees": {
  10398. "type": "array",
  10399. "items": {
  10400. "type": "string"
  10401. },
  10402. "x-go-name": "Assignees"
  10403. },
  10404. "body": {
  10405. "type": "string",
  10406. "x-go-name": "Body"
  10407. },
  10408. "due_date": {
  10409. "type": "string",
  10410. "format": "date-time",
  10411. "x-go-name": "Deadline"
  10412. },
  10413. "milestone": {
  10414. "type": "integer",
  10415. "format": "int64",
  10416. "x-go-name": "Milestone"
  10417. },
  10418. "state": {
  10419. "type": "string",
  10420. "x-go-name": "State"
  10421. },
  10422. "title": {
  10423. "type": "string",
  10424. "x-go-name": "Title"
  10425. },
  10426. "unset_due_date": {
  10427. "type": "boolean",
  10428. "x-go-name": "RemoveDeadline"
  10429. }
  10430. },
  10431. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10432. },
  10433. "EditLabelOption": {
  10434. "description": "EditLabelOption options for editing a label",
  10435. "type": "object",
  10436. "properties": {
  10437. "color": {
  10438. "type": "string",
  10439. "x-go-name": "Color"
  10440. },
  10441. "description": {
  10442. "type": "string",
  10443. "x-go-name": "Description"
  10444. },
  10445. "name": {
  10446. "type": "string",
  10447. "x-go-name": "Name"
  10448. }
  10449. },
  10450. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10451. },
  10452. "EditMilestoneOption": {
  10453. "description": "EditMilestoneOption options for editing a milestone",
  10454. "type": "object",
  10455. "properties": {
  10456. "description": {
  10457. "type": "string",
  10458. "x-go-name": "Description"
  10459. },
  10460. "due_on": {
  10461. "type": "string",
  10462. "format": "date-time",
  10463. "x-go-name": "Deadline"
  10464. },
  10465. "state": {
  10466. "type": "string",
  10467. "x-go-name": "State"
  10468. },
  10469. "title": {
  10470. "type": "string",
  10471. "x-go-name": "Title"
  10472. }
  10473. },
  10474. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10475. },
  10476. "EditOrgOption": {
  10477. "description": "EditOrgOption options for editing an organization",
  10478. "type": "object",
  10479. "properties": {
  10480. "description": {
  10481. "type": "string",
  10482. "x-go-name": "Description"
  10483. },
  10484. "full_name": {
  10485. "type": "string",
  10486. "x-go-name": "FullName"
  10487. },
  10488. "location": {
  10489. "type": "string",
  10490. "x-go-name": "Location"
  10491. },
  10492. "repo_admin_change_team_access": {
  10493. "type": "boolean",
  10494. "x-go-name": "RepoAdminChangeTeamAccess"
  10495. },
  10496. "visibility": {
  10497. "description": "possible values are `public`, `limited` or `private`",
  10498. "type": "string",
  10499. "enum": [
  10500. "public",
  10501. "limited",
  10502. "private"
  10503. ],
  10504. "x-go-name": "Visibility"
  10505. },
  10506. "website": {
  10507. "type": "string",
  10508. "x-go-name": "Website"
  10509. }
  10510. },
  10511. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10512. },
  10513. "EditPullRequestOption": {
  10514. "description": "EditPullRequestOption options when modify pull request",
  10515. "type": "object",
  10516. "properties": {
  10517. "assignee": {
  10518. "type": "string",
  10519. "x-go-name": "Assignee"
  10520. },
  10521. "assignees": {
  10522. "type": "array",
  10523. "items": {
  10524. "type": "string"
  10525. },
  10526. "x-go-name": "Assignees"
  10527. },
  10528. "body": {
  10529. "type": "string",
  10530. "x-go-name": "Body"
  10531. },
  10532. "due_date": {
  10533. "type": "string",
  10534. "format": "date-time",
  10535. "x-go-name": "Deadline"
  10536. },
  10537. "labels": {
  10538. "type": "array",
  10539. "items": {
  10540. "type": "integer",
  10541. "format": "int64"
  10542. },
  10543. "x-go-name": "Labels"
  10544. },
  10545. "milestone": {
  10546. "type": "integer",
  10547. "format": "int64",
  10548. "x-go-name": "Milestone"
  10549. },
  10550. "state": {
  10551. "type": "string",
  10552. "x-go-name": "State"
  10553. },
  10554. "title": {
  10555. "type": "string",
  10556. "x-go-name": "Title"
  10557. },
  10558. "unset_due_date": {
  10559. "type": "boolean",
  10560. "x-go-name": "RemoveDeadline"
  10561. }
  10562. },
  10563. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10564. },
  10565. "EditReactionOption": {
  10566. "description": "EditReactionOption contain the reaction type",
  10567. "type": "object",
  10568. "properties": {
  10569. "content": {
  10570. "type": "string",
  10571. "x-go-name": "Reaction"
  10572. }
  10573. },
  10574. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10575. },
  10576. "EditReleaseOption": {
  10577. "description": "EditReleaseOption options when editing a release",
  10578. "type": "object",
  10579. "properties": {
  10580. "body": {
  10581. "type": "string",
  10582. "x-go-name": "Note"
  10583. },
  10584. "draft": {
  10585. "type": "boolean",
  10586. "x-go-name": "IsDraft"
  10587. },
  10588. "name": {
  10589. "type": "string",
  10590. "x-go-name": "Title"
  10591. },
  10592. "prerelease": {
  10593. "type": "boolean",
  10594. "x-go-name": "IsPrerelease"
  10595. },
  10596. "tag_name": {
  10597. "type": "string",
  10598. "x-go-name": "TagName"
  10599. },
  10600. "target_commitish": {
  10601. "type": "string",
  10602. "x-go-name": "Target"
  10603. }
  10604. },
  10605. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10606. },
  10607. "EditRepoOption": {
  10608. "description": "EditRepoOption options when editing a repository's properties",
  10609. "type": "object",
  10610. "properties": {
  10611. "allow_merge_commits": {
  10612. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.",
  10613. "type": "boolean",
  10614. "x-go-name": "AllowMerge"
  10615. },
  10616. "allow_rebase": {
  10617. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  10618. "type": "boolean",
  10619. "x-go-name": "AllowRebase"
  10620. },
  10621. "allow_rebase_explicit": {
  10622. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.",
  10623. "type": "boolean",
  10624. "x-go-name": "AllowRebaseMerge"
  10625. },
  10626. "allow_squash_merge": {
  10627. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  10628. "type": "boolean",
  10629. "x-go-name": "AllowSquash"
  10630. },
  10631. "archived": {
  10632. "description": "set to `true` to archive this repository.",
  10633. "type": "boolean",
  10634. "x-go-name": "Archived"
  10635. },
  10636. "default_branch": {
  10637. "description": "sets the default branch for this repository.",
  10638. "type": "string",
  10639. "x-go-name": "DefaultBranch"
  10640. },
  10641. "description": {
  10642. "description": "a short description of the repository.",
  10643. "type": "string",
  10644. "x-go-name": "Description"
  10645. },
  10646. "external_tracker": {
  10647. "$ref": "#/definitions/ExternalTracker"
  10648. },
  10649. "external_wiki": {
  10650. "$ref": "#/definitions/ExternalWiki"
  10651. },
  10652. "has_issues": {
  10653. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  10654. "type": "boolean",
  10655. "x-go-name": "HasIssues"
  10656. },
  10657. "has_pull_requests": {
  10658. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  10659. "type": "boolean",
  10660. "x-go-name": "HasPullRequests"
  10661. },
  10662. "has_wiki": {
  10663. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  10664. "type": "boolean",
  10665. "x-go-name": "HasWiki"
  10666. },
  10667. "ignore_whitespace_conflicts": {
  10668. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  10669. "type": "boolean",
  10670. "x-go-name": "IgnoreWhitespaceConflicts"
  10671. },
  10672. "internal_tracker": {
  10673. "$ref": "#/definitions/InternalTracker"
  10674. },
  10675. "name": {
  10676. "description": "name of the repository",
  10677. "type": "string",
  10678. "uniqueItems": true,
  10679. "x-go-name": "Name"
  10680. },
  10681. "private": {
  10682. "description": "either `true` to make the repository private or `false` to make it public.\nNote: you will get a 422 error if the organization restricts changing repository visibility to organization\nowners and a non-owner tries to change the value of private.",
  10683. "type": "boolean",
  10684. "x-go-name": "Private"
  10685. },
  10686. "template": {
  10687. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  10688. "type": "boolean",
  10689. "x-go-name": "Template"
  10690. },
  10691. "website": {
  10692. "description": "a URL with more information about the repository.",
  10693. "type": "string",
  10694. "x-go-name": "Website"
  10695. }
  10696. },
  10697. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10698. },
  10699. "EditTeamOption": {
  10700. "description": "EditTeamOption options for editing a team",
  10701. "type": "object",
  10702. "required": [
  10703. "name"
  10704. ],
  10705. "properties": {
  10706. "can_create_org_repo": {
  10707. "type": "boolean",
  10708. "x-go-name": "CanCreateOrgRepo"
  10709. },
  10710. "description": {
  10711. "type": "string",
  10712. "x-go-name": "Description"
  10713. },
  10714. "includes_all_repositories": {
  10715. "type": "boolean",
  10716. "x-go-name": "IncludesAllRepositories"
  10717. },
  10718. "name": {
  10719. "type": "string",
  10720. "x-go-name": "Name"
  10721. },
  10722. "permission": {
  10723. "type": "string",
  10724. "enum": [
  10725. "read",
  10726. "write",
  10727. "admin"
  10728. ],
  10729. "x-go-name": "Permission"
  10730. },
  10731. "units": {
  10732. "type": "array",
  10733. "items": {
  10734. "type": "string"
  10735. },
  10736. "x-go-name": "Units",
  10737. "example": [
  10738. "repo.code",
  10739. "repo.issues",
  10740. "repo.ext_issues",
  10741. "repo.wiki",
  10742. "repo.pulls",
  10743. "repo.releases",
  10744. "repo.ext_wiki"
  10745. ]
  10746. }
  10747. },
  10748. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10749. },
  10750. "EditUserOption": {
  10751. "description": "EditUserOption edit user options",
  10752. "type": "object",
  10753. "required": [
  10754. "email"
  10755. ],
  10756. "properties": {
  10757. "active": {
  10758. "type": "boolean",
  10759. "x-go-name": "Active"
  10760. },
  10761. "admin": {
  10762. "type": "boolean",
  10763. "x-go-name": "Admin"
  10764. },
  10765. "allow_create_organization": {
  10766. "type": "boolean",
  10767. "x-go-name": "AllowCreateOrganization"
  10768. },
  10769. "allow_git_hook": {
  10770. "type": "boolean",
  10771. "x-go-name": "AllowGitHook"
  10772. },
  10773. "allow_import_local": {
  10774. "type": "boolean",
  10775. "x-go-name": "AllowImportLocal"
  10776. },
  10777. "email": {
  10778. "type": "string",
  10779. "format": "email",
  10780. "x-go-name": "Email"
  10781. },
  10782. "full_name": {
  10783. "type": "string",
  10784. "x-go-name": "FullName"
  10785. },
  10786. "location": {
  10787. "type": "string",
  10788. "x-go-name": "Location"
  10789. },
  10790. "login_name": {
  10791. "type": "string",
  10792. "x-go-name": "LoginName"
  10793. },
  10794. "max_repo_creation": {
  10795. "type": "integer",
  10796. "format": "int64",
  10797. "x-go-name": "MaxRepoCreation"
  10798. },
  10799. "must_change_password": {
  10800. "type": "boolean",
  10801. "x-go-name": "MustChangePassword"
  10802. },
  10803. "password": {
  10804. "type": "string",
  10805. "x-go-name": "Password"
  10806. },
  10807. "prohibit_login": {
  10808. "type": "boolean",
  10809. "x-go-name": "ProhibitLogin"
  10810. },
  10811. "source_id": {
  10812. "type": "integer",
  10813. "format": "int64",
  10814. "x-go-name": "SourceID"
  10815. },
  10816. "website": {
  10817. "type": "string",
  10818. "x-go-name": "Website"
  10819. }
  10820. },
  10821. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10822. },
  10823. "Email": {
  10824. "description": "Email an email address belonging to a user",
  10825. "type": "object",
  10826. "properties": {
  10827. "email": {
  10828. "type": "string",
  10829. "format": "email",
  10830. "x-go-name": "Email"
  10831. },
  10832. "primary": {
  10833. "type": "boolean",
  10834. "x-go-name": "Primary"
  10835. },
  10836. "verified": {
  10837. "type": "boolean",
  10838. "x-go-name": "Verified"
  10839. }
  10840. },
  10841. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10842. },
  10843. "ExternalTracker": {
  10844. "description": "ExternalTracker represents settings for external tracker",
  10845. "type": "object",
  10846. "properties": {
  10847. "external_tracker_format": {
  10848. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  10849. "type": "string",
  10850. "x-go-name": "ExternalTrackerFormat"
  10851. },
  10852. "external_tracker_style": {
  10853. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  10854. "type": "string",
  10855. "x-go-name": "ExternalTrackerStyle"
  10856. },
  10857. "external_tracker_url": {
  10858. "description": "URL of external issue tracker.",
  10859. "type": "string",
  10860. "x-go-name": "ExternalTrackerURL"
  10861. }
  10862. },
  10863. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10864. },
  10865. "ExternalWiki": {
  10866. "description": "ExternalWiki represents setting for external wiki",
  10867. "type": "object",
  10868. "properties": {
  10869. "external_wiki_url": {
  10870. "description": "URL of external wiki.",
  10871. "type": "string",
  10872. "x-go-name": "ExternalWikiURL"
  10873. }
  10874. },
  10875. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10876. },
  10877. "FileCommitResponse": {
  10878. "type": "object",
  10879. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  10880. "properties": {
  10881. "author": {
  10882. "$ref": "#/definitions/CommitUser"
  10883. },
  10884. "committer": {
  10885. "$ref": "#/definitions/CommitUser"
  10886. },
  10887. "html_url": {
  10888. "type": "string",
  10889. "x-go-name": "HTMLURL"
  10890. },
  10891. "message": {
  10892. "type": "string",
  10893. "x-go-name": "Message"
  10894. },
  10895. "parents": {
  10896. "type": "array",
  10897. "items": {
  10898. "$ref": "#/definitions/CommitMeta"
  10899. },
  10900. "x-go-name": "Parents"
  10901. },
  10902. "sha": {
  10903. "type": "string",
  10904. "x-go-name": "SHA"
  10905. },
  10906. "tree": {
  10907. "$ref": "#/definitions/CommitMeta"
  10908. },
  10909. "url": {
  10910. "type": "string",
  10911. "x-go-name": "URL"
  10912. }
  10913. },
  10914. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10915. },
  10916. "FileDeleteResponse": {
  10917. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  10918. "type": "object",
  10919. "properties": {
  10920. "commit": {
  10921. "$ref": "#/definitions/FileCommitResponse"
  10922. },
  10923. "content": {
  10924. "type": "object",
  10925. "x-go-name": "Content"
  10926. },
  10927. "verification": {
  10928. "$ref": "#/definitions/PayloadCommitVerification"
  10929. }
  10930. },
  10931. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10932. },
  10933. "FileLinksResponse": {
  10934. "description": "FileLinksResponse contains the links for a repo's file",
  10935. "type": "object",
  10936. "properties": {
  10937. "git": {
  10938. "type": "string",
  10939. "x-go-name": "GitURL"
  10940. },
  10941. "html": {
  10942. "type": "string",
  10943. "x-go-name": "HTMLURL"
  10944. },
  10945. "self": {
  10946. "type": "string",
  10947. "x-go-name": "Self"
  10948. }
  10949. },
  10950. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10951. },
  10952. "FileResponse": {
  10953. "description": "FileResponse contains information about a repo's file",
  10954. "type": "object",
  10955. "properties": {
  10956. "commit": {
  10957. "$ref": "#/definitions/FileCommitResponse"
  10958. },
  10959. "content": {
  10960. "$ref": "#/definitions/ContentsResponse"
  10961. },
  10962. "verification": {
  10963. "$ref": "#/definitions/PayloadCommitVerification"
  10964. }
  10965. },
  10966. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10967. },
  10968. "GPGKey": {
  10969. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  10970. "type": "object",
  10971. "properties": {
  10972. "can_certify": {
  10973. "type": "boolean",
  10974. "x-go-name": "CanCertify"
  10975. },
  10976. "can_encrypt_comms": {
  10977. "type": "boolean",
  10978. "x-go-name": "CanEncryptComms"
  10979. },
  10980. "can_encrypt_storage": {
  10981. "type": "boolean",
  10982. "x-go-name": "CanEncryptStorage"
  10983. },
  10984. "can_sign": {
  10985. "type": "boolean",
  10986. "x-go-name": "CanSign"
  10987. },
  10988. "created_at": {
  10989. "type": "string",
  10990. "format": "date-time",
  10991. "x-go-name": "Created"
  10992. },
  10993. "emails": {
  10994. "type": "array",
  10995. "items": {
  10996. "$ref": "#/definitions/GPGKeyEmail"
  10997. },
  10998. "x-go-name": "Emails"
  10999. },
  11000. "expires_at": {
  11001. "type": "string",
  11002. "format": "date-time",
  11003. "x-go-name": "Expires"
  11004. },
  11005. "id": {
  11006. "type": "integer",
  11007. "format": "int64",
  11008. "x-go-name": "ID"
  11009. },
  11010. "key_id": {
  11011. "type": "string",
  11012. "x-go-name": "KeyID"
  11013. },
  11014. "primary_key_id": {
  11015. "type": "string",
  11016. "x-go-name": "PrimaryKeyID"
  11017. },
  11018. "public_key": {
  11019. "type": "string",
  11020. "x-go-name": "PublicKey"
  11021. },
  11022. "subkeys": {
  11023. "type": "array",
  11024. "items": {
  11025. "$ref": "#/definitions/GPGKey"
  11026. },
  11027. "x-go-name": "SubsKey"
  11028. }
  11029. },
  11030. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11031. },
  11032. "GPGKeyEmail": {
  11033. "description": "GPGKeyEmail an email attached to a GPGKey",
  11034. "type": "object",
  11035. "properties": {
  11036. "email": {
  11037. "type": "string",
  11038. "x-go-name": "Email"
  11039. },
  11040. "verified": {
  11041. "type": "boolean",
  11042. "x-go-name": "Verified"
  11043. }
  11044. },
  11045. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11046. },
  11047. "GitBlobResponse": {
  11048. "description": "GitBlobResponse represents a git blob",
  11049. "type": "object",
  11050. "properties": {
  11051. "content": {
  11052. "type": "string",
  11053. "x-go-name": "Content"
  11054. },
  11055. "encoding": {
  11056. "type": "string",
  11057. "x-go-name": "Encoding"
  11058. },
  11059. "sha": {
  11060. "type": "string",
  11061. "x-go-name": "SHA"
  11062. },
  11063. "size": {
  11064. "type": "integer",
  11065. "format": "int64",
  11066. "x-go-name": "Size"
  11067. },
  11068. "url": {
  11069. "type": "string",
  11070. "x-go-name": "URL"
  11071. }
  11072. },
  11073. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11074. },
  11075. "GitEntry": {
  11076. "description": "GitEntry represents a git tree",
  11077. "type": "object",
  11078. "properties": {
  11079. "mode": {
  11080. "type": "string",
  11081. "x-go-name": "Mode"
  11082. },
  11083. "path": {
  11084. "type": "string",
  11085. "x-go-name": "Path"
  11086. },
  11087. "sha": {
  11088. "type": "string",
  11089. "x-go-name": "SHA"
  11090. },
  11091. "size": {
  11092. "type": "integer",
  11093. "format": "int64",
  11094. "x-go-name": "Size"
  11095. },
  11096. "type": {
  11097. "type": "string",
  11098. "x-go-name": "Type"
  11099. },
  11100. "url": {
  11101. "type": "string",
  11102. "x-go-name": "URL"
  11103. }
  11104. },
  11105. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11106. },
  11107. "GitHook": {
  11108. "description": "GitHook represents a Git repository hook",
  11109. "type": "object",
  11110. "properties": {
  11111. "content": {
  11112. "type": "string",
  11113. "x-go-name": "Content"
  11114. },
  11115. "is_active": {
  11116. "type": "boolean",
  11117. "x-go-name": "IsActive"
  11118. },
  11119. "name": {
  11120. "type": "string",
  11121. "x-go-name": "Name"
  11122. }
  11123. },
  11124. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11125. },
  11126. "GitObject": {
  11127. "type": "object",
  11128. "title": "GitObject represents a Git object.",
  11129. "properties": {
  11130. "sha": {
  11131. "type": "string",
  11132. "x-go-name": "SHA"
  11133. },
  11134. "type": {
  11135. "type": "string",
  11136. "x-go-name": "Type"
  11137. },
  11138. "url": {
  11139. "type": "string",
  11140. "x-go-name": "URL"
  11141. }
  11142. },
  11143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11144. },
  11145. "GitTreeResponse": {
  11146. "description": "GitTreeResponse returns a git tree",
  11147. "type": "object",
  11148. "properties": {
  11149. "page": {
  11150. "type": "integer",
  11151. "format": "int64",
  11152. "x-go-name": "Page"
  11153. },
  11154. "sha": {
  11155. "type": "string",
  11156. "x-go-name": "SHA"
  11157. },
  11158. "total_count": {
  11159. "type": "integer",
  11160. "format": "int64",
  11161. "x-go-name": "TotalCount"
  11162. },
  11163. "tree": {
  11164. "type": "array",
  11165. "items": {
  11166. "$ref": "#/definitions/GitEntry"
  11167. },
  11168. "x-go-name": "Entries"
  11169. },
  11170. "truncated": {
  11171. "type": "boolean",
  11172. "x-go-name": "Truncated"
  11173. },
  11174. "url": {
  11175. "type": "string",
  11176. "x-go-name": "URL"
  11177. }
  11178. },
  11179. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11180. },
  11181. "Hook": {
  11182. "description": "Hook a hook is a web hook when one repository changed",
  11183. "type": "object",
  11184. "properties": {
  11185. "active": {
  11186. "type": "boolean",
  11187. "x-go-name": "Active"
  11188. },
  11189. "config": {
  11190. "type": "object",
  11191. "additionalProperties": {
  11192. "type": "string"
  11193. },
  11194. "x-go-name": "Config"
  11195. },
  11196. "created_at": {
  11197. "type": "string",
  11198. "format": "date-time",
  11199. "x-go-name": "Created"
  11200. },
  11201. "events": {
  11202. "type": "array",
  11203. "items": {
  11204. "type": "string"
  11205. },
  11206. "x-go-name": "Events"
  11207. },
  11208. "id": {
  11209. "type": "integer",
  11210. "format": "int64",
  11211. "x-go-name": "ID"
  11212. },
  11213. "type": {
  11214. "type": "string",
  11215. "x-go-name": "Type"
  11216. },
  11217. "updated_at": {
  11218. "type": "string",
  11219. "format": "date-time",
  11220. "x-go-name": "Updated"
  11221. }
  11222. },
  11223. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11224. },
  11225. "Identity": {
  11226. "description": "Identity for a person's identity like an author or committer",
  11227. "type": "object",
  11228. "properties": {
  11229. "email": {
  11230. "type": "string",
  11231. "format": "email",
  11232. "x-go-name": "Email"
  11233. },
  11234. "name": {
  11235. "type": "string",
  11236. "x-go-name": "Name"
  11237. }
  11238. },
  11239. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11240. },
  11241. "InternalTracker": {
  11242. "description": "InternalTracker represents settings for internal tracker",
  11243. "type": "object",
  11244. "properties": {
  11245. "allow_only_contributors_to_track_time": {
  11246. "description": "Let only contributors track time (Built-in issue tracker)",
  11247. "type": "boolean",
  11248. "x-go-name": "AllowOnlyContributorsToTrackTime"
  11249. },
  11250. "enable_issue_dependencies": {
  11251. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  11252. "type": "boolean",
  11253. "x-go-name": "EnableIssueDependencies"
  11254. },
  11255. "enable_time_tracker": {
  11256. "description": "Enable time tracking (Built-in issue tracker)",
  11257. "type": "boolean",
  11258. "x-go-name": "EnableTimeTracker"
  11259. }
  11260. },
  11261. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11262. },
  11263. "Issue": {
  11264. "description": "Issue represents an issue in a repository",
  11265. "type": "object",
  11266. "properties": {
  11267. "assignee": {
  11268. "$ref": "#/definitions/User"
  11269. },
  11270. "assignees": {
  11271. "type": "array",
  11272. "items": {
  11273. "$ref": "#/definitions/User"
  11274. },
  11275. "x-go-name": "Assignees"
  11276. },
  11277. "body": {
  11278. "type": "string",
  11279. "x-go-name": "Body"
  11280. },
  11281. "closed_at": {
  11282. "type": "string",
  11283. "format": "date-time",
  11284. "x-go-name": "Closed"
  11285. },
  11286. "comments": {
  11287. "type": "integer",
  11288. "format": "int64",
  11289. "x-go-name": "Comments"
  11290. },
  11291. "created_at": {
  11292. "type": "string",
  11293. "format": "date-time",
  11294. "x-go-name": "Created"
  11295. },
  11296. "due_date": {
  11297. "type": "string",
  11298. "format": "date-time",
  11299. "x-go-name": "Deadline"
  11300. },
  11301. "html_url": {
  11302. "type": "string",
  11303. "x-go-name": "HTMLURL"
  11304. },
  11305. "id": {
  11306. "type": "integer",
  11307. "format": "int64",
  11308. "x-go-name": "ID"
  11309. },
  11310. "labels": {
  11311. "type": "array",
  11312. "items": {
  11313. "$ref": "#/definitions/Label"
  11314. },
  11315. "x-go-name": "Labels"
  11316. },
  11317. "milestone": {
  11318. "$ref": "#/definitions/Milestone"
  11319. },
  11320. "number": {
  11321. "type": "integer",
  11322. "format": "int64",
  11323. "x-go-name": "Index"
  11324. },
  11325. "original_author": {
  11326. "type": "string",
  11327. "x-go-name": "OriginalAuthor"
  11328. },
  11329. "original_author_id": {
  11330. "type": "integer",
  11331. "format": "int64",
  11332. "x-go-name": "OriginalAuthorID"
  11333. },
  11334. "pull_request": {
  11335. "$ref": "#/definitions/PullRequestMeta"
  11336. },
  11337. "repository": {
  11338. "$ref": "#/definitions/RepositoryMeta"
  11339. },
  11340. "state": {
  11341. "$ref": "#/definitions/StateType"
  11342. },
  11343. "title": {
  11344. "type": "string",
  11345. "x-go-name": "Title"
  11346. },
  11347. "updated_at": {
  11348. "type": "string",
  11349. "format": "date-time",
  11350. "x-go-name": "Updated"
  11351. },
  11352. "url": {
  11353. "type": "string",
  11354. "x-go-name": "URL"
  11355. },
  11356. "user": {
  11357. "$ref": "#/definitions/User"
  11358. }
  11359. },
  11360. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11361. },
  11362. "IssueDeadline": {
  11363. "description": "IssueDeadline represents an issue deadline",
  11364. "type": "object",
  11365. "properties": {
  11366. "due_date": {
  11367. "type": "string",
  11368. "format": "date-time",
  11369. "x-go-name": "Deadline"
  11370. }
  11371. },
  11372. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11373. },
  11374. "IssueLabelsOption": {
  11375. "description": "IssueLabelsOption a collection of labels",
  11376. "type": "object",
  11377. "properties": {
  11378. "labels": {
  11379. "description": "list of label IDs",
  11380. "type": "array",
  11381. "items": {
  11382. "type": "integer",
  11383. "format": "int64"
  11384. },
  11385. "x-go-name": "Labels"
  11386. }
  11387. },
  11388. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11389. },
  11390. "Label": {
  11391. "description": "Label a label to an issue or a pr",
  11392. "type": "object",
  11393. "properties": {
  11394. "color": {
  11395. "type": "string",
  11396. "x-go-name": "Color",
  11397. "example": "00aabb"
  11398. },
  11399. "description": {
  11400. "type": "string",
  11401. "x-go-name": "Description"
  11402. },
  11403. "id": {
  11404. "type": "integer",
  11405. "format": "int64",
  11406. "x-go-name": "ID"
  11407. },
  11408. "name": {
  11409. "type": "string",
  11410. "x-go-name": "Name"
  11411. },
  11412. "url": {
  11413. "type": "string",
  11414. "x-go-name": "URL"
  11415. }
  11416. },
  11417. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11418. },
  11419. "MarkdownOption": {
  11420. "description": "MarkdownOption markdown options",
  11421. "type": "object",
  11422. "properties": {
  11423. "Context": {
  11424. "description": "Context to render\n\nin: body",
  11425. "type": "string"
  11426. },
  11427. "Mode": {
  11428. "description": "Mode to render\n\nin: body",
  11429. "type": "string"
  11430. },
  11431. "Text": {
  11432. "description": "Text markdown to render\n\nin: body",
  11433. "type": "string"
  11434. },
  11435. "Wiki": {
  11436. "description": "Is it a wiki page ?\n\nin: body",
  11437. "type": "boolean"
  11438. }
  11439. },
  11440. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11441. },
  11442. "MergePullRequestOption": {
  11443. "description": "MergePullRequestForm form for merging Pull Request",
  11444. "type": "object",
  11445. "required": [
  11446. "Do"
  11447. ],
  11448. "properties": {
  11449. "Do": {
  11450. "type": "string",
  11451. "enum": [
  11452. "merge",
  11453. "rebase",
  11454. "rebase-merge",
  11455. "squash"
  11456. ]
  11457. },
  11458. "MergeMessageField": {
  11459. "type": "string"
  11460. },
  11461. "MergeTitleField": {
  11462. "type": "string"
  11463. },
  11464. "force_merge": {
  11465. "type": "boolean",
  11466. "x-go-name": "ForceMerge"
  11467. }
  11468. },
  11469. "x-go-name": "MergePullRequestForm",
  11470. "x-go-package": "code.gitea.io/gitea/modules/auth"
  11471. },
  11472. "MigrateRepoForm": {
  11473. "description": "MigrateRepoForm form for migrating repository",
  11474. "type": "object",
  11475. "required": [
  11476. "clone_addr",
  11477. "uid",
  11478. "repo_name"
  11479. ],
  11480. "properties": {
  11481. "auth_password": {
  11482. "type": "string",
  11483. "x-go-name": "AuthPassword"
  11484. },
  11485. "auth_username": {
  11486. "type": "string",
  11487. "x-go-name": "AuthUsername"
  11488. },
  11489. "clone_addr": {
  11490. "type": "string",
  11491. "x-go-name": "CloneAddr"
  11492. },
  11493. "description": {
  11494. "type": "string",
  11495. "x-go-name": "Description"
  11496. },
  11497. "issues": {
  11498. "type": "boolean",
  11499. "x-go-name": "Issues"
  11500. },
  11501. "labels": {
  11502. "type": "boolean",
  11503. "x-go-name": "Labels"
  11504. },
  11505. "milestones": {
  11506. "type": "boolean",
  11507. "x-go-name": "Milestones"
  11508. },
  11509. "mirror": {
  11510. "type": "boolean",
  11511. "x-go-name": "Mirror"
  11512. },
  11513. "private": {
  11514. "type": "boolean",
  11515. "x-go-name": "Private"
  11516. },
  11517. "pull_requests": {
  11518. "type": "boolean",
  11519. "x-go-name": "PullRequests"
  11520. },
  11521. "releases": {
  11522. "type": "boolean",
  11523. "x-go-name": "Releases"
  11524. },
  11525. "repo_name": {
  11526. "type": "string",
  11527. "x-go-name": "RepoName"
  11528. },
  11529. "uid": {
  11530. "type": "integer",
  11531. "format": "int64",
  11532. "x-go-name": "UID"
  11533. },
  11534. "wiki": {
  11535. "type": "boolean",
  11536. "x-go-name": "Wiki"
  11537. }
  11538. },
  11539. "x-go-package": "code.gitea.io/gitea/modules/auth"
  11540. },
  11541. "Milestone": {
  11542. "description": "Milestone milestone is a collection of issues on one repository",
  11543. "type": "object",
  11544. "properties": {
  11545. "closed_at": {
  11546. "type": "string",
  11547. "format": "date-time",
  11548. "x-go-name": "Closed"
  11549. },
  11550. "closed_issues": {
  11551. "type": "integer",
  11552. "format": "int64",
  11553. "x-go-name": "ClosedIssues"
  11554. },
  11555. "description": {
  11556. "type": "string",
  11557. "x-go-name": "Description"
  11558. },
  11559. "due_on": {
  11560. "type": "string",
  11561. "format": "date-time",
  11562. "x-go-name": "Deadline"
  11563. },
  11564. "id": {
  11565. "type": "integer",
  11566. "format": "int64",
  11567. "x-go-name": "ID"
  11568. },
  11569. "open_issues": {
  11570. "type": "integer",
  11571. "format": "int64",
  11572. "x-go-name": "OpenIssues"
  11573. },
  11574. "state": {
  11575. "$ref": "#/definitions/StateType"
  11576. },
  11577. "title": {
  11578. "type": "string",
  11579. "x-go-name": "Title"
  11580. }
  11581. },
  11582. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11583. },
  11584. "NotificationCount": {
  11585. "description": "NotificationCount number of unread notifications",
  11586. "type": "object",
  11587. "properties": {
  11588. "new": {
  11589. "type": "integer",
  11590. "format": "int64",
  11591. "x-go-name": "New"
  11592. }
  11593. },
  11594. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11595. },
  11596. "NotificationSubject": {
  11597. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  11598. "type": "object",
  11599. "properties": {
  11600. "latest_comment_url": {
  11601. "type": "string",
  11602. "x-go-name": "LatestCommentURL"
  11603. },
  11604. "title": {
  11605. "type": "string",
  11606. "x-go-name": "Title"
  11607. },
  11608. "type": {
  11609. "type": "string",
  11610. "x-go-name": "Type"
  11611. },
  11612. "url": {
  11613. "type": "string",
  11614. "x-go-name": "URL"
  11615. }
  11616. },
  11617. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11618. },
  11619. "NotificationThread": {
  11620. "description": "NotificationThread expose Notification on API",
  11621. "type": "object",
  11622. "properties": {
  11623. "id": {
  11624. "type": "integer",
  11625. "format": "int64",
  11626. "x-go-name": "ID"
  11627. },
  11628. "pinned": {
  11629. "type": "boolean",
  11630. "x-go-name": "Pinned"
  11631. },
  11632. "repository": {
  11633. "$ref": "#/definitions/Repository"
  11634. },
  11635. "subject": {
  11636. "$ref": "#/definitions/NotificationSubject"
  11637. },
  11638. "unread": {
  11639. "type": "boolean",
  11640. "x-go-name": "Unread"
  11641. },
  11642. "updated_at": {
  11643. "type": "string",
  11644. "format": "date-time",
  11645. "x-go-name": "UpdatedAt"
  11646. },
  11647. "url": {
  11648. "type": "string",
  11649. "x-go-name": "URL"
  11650. }
  11651. },
  11652. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11653. },
  11654. "Organization": {
  11655. "description": "Organization represents an organization",
  11656. "type": "object",
  11657. "properties": {
  11658. "avatar_url": {
  11659. "type": "string",
  11660. "x-go-name": "AvatarURL"
  11661. },
  11662. "description": {
  11663. "type": "string",
  11664. "x-go-name": "Description"
  11665. },
  11666. "full_name": {
  11667. "type": "string",
  11668. "x-go-name": "FullName"
  11669. },
  11670. "id": {
  11671. "type": "integer",
  11672. "format": "int64",
  11673. "x-go-name": "ID"
  11674. },
  11675. "location": {
  11676. "type": "string",
  11677. "x-go-name": "Location"
  11678. },
  11679. "repo_admin_change_team_access": {
  11680. "type": "boolean",
  11681. "x-go-name": "RepoAdminChangeTeamAccess"
  11682. },
  11683. "username": {
  11684. "type": "string",
  11685. "x-go-name": "UserName"
  11686. },
  11687. "visibility": {
  11688. "type": "string",
  11689. "x-go-name": "Visibility"
  11690. },
  11691. "website": {
  11692. "type": "string",
  11693. "x-go-name": "Website"
  11694. }
  11695. },
  11696. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11697. },
  11698. "PRBranchInfo": {
  11699. "description": "PRBranchInfo information about a branch",
  11700. "type": "object",
  11701. "properties": {
  11702. "label": {
  11703. "type": "string",
  11704. "x-go-name": "Name"
  11705. },
  11706. "ref": {
  11707. "type": "string",
  11708. "x-go-name": "Ref"
  11709. },
  11710. "repo": {
  11711. "$ref": "#/definitions/Repository"
  11712. },
  11713. "repo_id": {
  11714. "type": "integer",
  11715. "format": "int64",
  11716. "x-go-name": "RepoID"
  11717. },
  11718. "sha": {
  11719. "type": "string",
  11720. "x-go-name": "Sha"
  11721. }
  11722. },
  11723. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11724. },
  11725. "PayloadCommit": {
  11726. "description": "PayloadCommit represents a commit",
  11727. "type": "object",
  11728. "properties": {
  11729. "added": {
  11730. "type": "array",
  11731. "items": {
  11732. "type": "string"
  11733. },
  11734. "x-go-name": "Added"
  11735. },
  11736. "author": {
  11737. "$ref": "#/definitions/PayloadUser"
  11738. },
  11739. "committer": {
  11740. "$ref": "#/definitions/PayloadUser"
  11741. },
  11742. "id": {
  11743. "description": "sha1 hash of the commit",
  11744. "type": "string",
  11745. "x-go-name": "ID"
  11746. },
  11747. "message": {
  11748. "type": "string",
  11749. "x-go-name": "Message"
  11750. },
  11751. "modified": {
  11752. "type": "array",
  11753. "items": {
  11754. "type": "string"
  11755. },
  11756. "x-go-name": "Modified"
  11757. },
  11758. "removed": {
  11759. "type": "array",
  11760. "items": {
  11761. "type": "string"
  11762. },
  11763. "x-go-name": "Removed"
  11764. },
  11765. "timestamp": {
  11766. "type": "string",
  11767. "format": "date-time",
  11768. "x-go-name": "Timestamp"
  11769. },
  11770. "url": {
  11771. "type": "string",
  11772. "x-go-name": "URL"
  11773. },
  11774. "verification": {
  11775. "$ref": "#/definitions/PayloadCommitVerification"
  11776. }
  11777. },
  11778. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11779. },
  11780. "PayloadCommitVerification": {
  11781. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  11782. "type": "object",
  11783. "properties": {
  11784. "payload": {
  11785. "type": "string",
  11786. "x-go-name": "Payload"
  11787. },
  11788. "reason": {
  11789. "type": "string",
  11790. "x-go-name": "Reason"
  11791. },
  11792. "signature": {
  11793. "type": "string",
  11794. "x-go-name": "Signature"
  11795. },
  11796. "signer": {
  11797. "$ref": "#/definitions/PayloadUser"
  11798. },
  11799. "verified": {
  11800. "type": "boolean",
  11801. "x-go-name": "Verified"
  11802. }
  11803. },
  11804. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11805. },
  11806. "PayloadUser": {
  11807. "description": "PayloadUser represents the author or committer of a commit",
  11808. "type": "object",
  11809. "properties": {
  11810. "email": {
  11811. "type": "string",
  11812. "format": "email",
  11813. "x-go-name": "Email"
  11814. },
  11815. "name": {
  11816. "description": "Full name of the commit author",
  11817. "type": "string",
  11818. "x-go-name": "Name"
  11819. },
  11820. "username": {
  11821. "type": "string",
  11822. "x-go-name": "UserName"
  11823. }
  11824. },
  11825. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11826. },
  11827. "Permission": {
  11828. "description": "Permission represents a set of permissions",
  11829. "type": "object",
  11830. "properties": {
  11831. "admin": {
  11832. "type": "boolean",
  11833. "x-go-name": "Admin"
  11834. },
  11835. "pull": {
  11836. "type": "boolean",
  11837. "x-go-name": "Pull"
  11838. },
  11839. "push": {
  11840. "type": "boolean",
  11841. "x-go-name": "Push"
  11842. }
  11843. },
  11844. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11845. },
  11846. "PublicKey": {
  11847. "description": "PublicKey publickey is a user key to push code to repository",
  11848. "type": "object",
  11849. "properties": {
  11850. "created_at": {
  11851. "type": "string",
  11852. "format": "date-time",
  11853. "x-go-name": "Created"
  11854. },
  11855. "fingerprint": {
  11856. "type": "string",
  11857. "x-go-name": "Fingerprint"
  11858. },
  11859. "id": {
  11860. "type": "integer",
  11861. "format": "int64",
  11862. "x-go-name": "ID"
  11863. },
  11864. "key": {
  11865. "type": "string",
  11866. "x-go-name": "Key"
  11867. },
  11868. "key_type": {
  11869. "type": "string",
  11870. "x-go-name": "KeyType"
  11871. },
  11872. "read_only": {
  11873. "type": "boolean",
  11874. "x-go-name": "ReadOnly"
  11875. },
  11876. "title": {
  11877. "type": "string",
  11878. "x-go-name": "Title"
  11879. },
  11880. "url": {
  11881. "type": "string",
  11882. "x-go-name": "URL"
  11883. },
  11884. "user": {
  11885. "$ref": "#/definitions/User"
  11886. }
  11887. },
  11888. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11889. },
  11890. "PullRequest": {
  11891. "description": "PullRequest represents a pull request",
  11892. "type": "object",
  11893. "properties": {
  11894. "assignee": {
  11895. "$ref": "#/definitions/User"
  11896. },
  11897. "assignees": {
  11898. "type": "array",
  11899. "items": {
  11900. "$ref": "#/definitions/User"
  11901. },
  11902. "x-go-name": "Assignees"
  11903. },
  11904. "base": {
  11905. "$ref": "#/definitions/PRBranchInfo"
  11906. },
  11907. "body": {
  11908. "type": "string",
  11909. "x-go-name": "Body"
  11910. },
  11911. "closed_at": {
  11912. "type": "string",
  11913. "format": "date-time",
  11914. "x-go-name": "Closed"
  11915. },
  11916. "comments": {
  11917. "type": "integer",
  11918. "format": "int64",
  11919. "x-go-name": "Comments"
  11920. },
  11921. "created_at": {
  11922. "type": "string",
  11923. "format": "date-time",
  11924. "x-go-name": "Created"
  11925. },
  11926. "diff_url": {
  11927. "type": "string",
  11928. "x-go-name": "DiffURL"
  11929. },
  11930. "due_date": {
  11931. "type": "string",
  11932. "format": "date-time",
  11933. "x-go-name": "Deadline"
  11934. },
  11935. "head": {
  11936. "$ref": "#/definitions/PRBranchInfo"
  11937. },
  11938. "html_url": {
  11939. "type": "string",
  11940. "x-go-name": "HTMLURL"
  11941. },
  11942. "id": {
  11943. "type": "integer",
  11944. "format": "int64",
  11945. "x-go-name": "ID"
  11946. },
  11947. "labels": {
  11948. "type": "array",
  11949. "items": {
  11950. "$ref": "#/definitions/Label"
  11951. },
  11952. "x-go-name": "Labels"
  11953. },
  11954. "merge_base": {
  11955. "type": "string",
  11956. "x-go-name": "MergeBase"
  11957. },
  11958. "merge_commit_sha": {
  11959. "type": "string",
  11960. "x-go-name": "MergedCommitID"
  11961. },
  11962. "mergeable": {
  11963. "type": "boolean",
  11964. "x-go-name": "Mergeable"
  11965. },
  11966. "merged": {
  11967. "type": "boolean",
  11968. "x-go-name": "HasMerged"
  11969. },
  11970. "merged_at": {
  11971. "type": "string",
  11972. "format": "date-time",
  11973. "x-go-name": "Merged"
  11974. },
  11975. "merged_by": {
  11976. "$ref": "#/definitions/User"
  11977. },
  11978. "milestone": {
  11979. "$ref": "#/definitions/Milestone"
  11980. },
  11981. "number": {
  11982. "type": "integer",
  11983. "format": "int64",
  11984. "x-go-name": "Index"
  11985. },
  11986. "patch_url": {
  11987. "type": "string",
  11988. "x-go-name": "PatchURL"
  11989. },
  11990. "state": {
  11991. "$ref": "#/definitions/StateType"
  11992. },
  11993. "title": {
  11994. "type": "string",
  11995. "x-go-name": "Title"
  11996. },
  11997. "updated_at": {
  11998. "type": "string",
  11999. "format": "date-time",
  12000. "x-go-name": "Updated"
  12001. },
  12002. "url": {
  12003. "type": "string",
  12004. "x-go-name": "URL"
  12005. },
  12006. "user": {
  12007. "$ref": "#/definitions/User"
  12008. }
  12009. },
  12010. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12011. },
  12012. "PullRequestMeta": {
  12013. "description": "PullRequestMeta PR info if an issue is a PR",
  12014. "type": "object",
  12015. "properties": {
  12016. "merged": {
  12017. "type": "boolean",
  12018. "x-go-name": "HasMerged"
  12019. },
  12020. "merged_at": {
  12021. "type": "string",
  12022. "format": "date-time",
  12023. "x-go-name": "Merged"
  12024. }
  12025. },
  12026. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12027. },
  12028. "Reaction": {
  12029. "description": "Reaction contain one reaction",
  12030. "type": "object",
  12031. "properties": {
  12032. "content": {
  12033. "type": "string",
  12034. "x-go-name": "Reaction"
  12035. },
  12036. "created_at": {
  12037. "type": "string",
  12038. "format": "date-time",
  12039. "x-go-name": "Created"
  12040. },
  12041. "user": {
  12042. "$ref": "#/definitions/User"
  12043. }
  12044. },
  12045. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12046. },
  12047. "Reference": {
  12048. "type": "object",
  12049. "title": "Reference represents a Git reference.",
  12050. "properties": {
  12051. "object": {
  12052. "$ref": "#/definitions/GitObject"
  12053. },
  12054. "ref": {
  12055. "type": "string",
  12056. "x-go-name": "Ref"
  12057. },
  12058. "url": {
  12059. "type": "string",
  12060. "x-go-name": "URL"
  12061. }
  12062. },
  12063. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12064. },
  12065. "Release": {
  12066. "description": "Release represents a repository release",
  12067. "type": "object",
  12068. "properties": {
  12069. "assets": {
  12070. "type": "array",
  12071. "items": {
  12072. "$ref": "#/definitions/Attachment"
  12073. },
  12074. "x-go-name": "Attachments"
  12075. },
  12076. "author": {
  12077. "$ref": "#/definitions/User"
  12078. },
  12079. "body": {
  12080. "type": "string",
  12081. "x-go-name": "Note"
  12082. },
  12083. "created_at": {
  12084. "type": "string",
  12085. "format": "date-time",
  12086. "x-go-name": "CreatedAt"
  12087. },
  12088. "draft": {
  12089. "type": "boolean",
  12090. "x-go-name": "IsDraft"
  12091. },
  12092. "id": {
  12093. "type": "integer",
  12094. "format": "int64",
  12095. "x-go-name": "ID"
  12096. },
  12097. "name": {
  12098. "type": "string",
  12099. "x-go-name": "Title"
  12100. },
  12101. "prerelease": {
  12102. "type": "boolean",
  12103. "x-go-name": "IsPrerelease"
  12104. },
  12105. "published_at": {
  12106. "type": "string",
  12107. "format": "date-time",
  12108. "x-go-name": "PublishedAt"
  12109. },
  12110. "tag_name": {
  12111. "type": "string",
  12112. "x-go-name": "TagName"
  12113. },
  12114. "tarball_url": {
  12115. "type": "string",
  12116. "x-go-name": "TarURL"
  12117. },
  12118. "target_commitish": {
  12119. "type": "string",
  12120. "x-go-name": "Target"
  12121. },
  12122. "url": {
  12123. "type": "string",
  12124. "x-go-name": "URL"
  12125. },
  12126. "zipball_url": {
  12127. "type": "string",
  12128. "x-go-name": "ZipURL"
  12129. }
  12130. },
  12131. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12132. },
  12133. "RepoCommit": {
  12134. "type": "object",
  12135. "title": "RepoCommit contains information of a commit in the context of a repository.",
  12136. "properties": {
  12137. "author": {
  12138. "$ref": "#/definitions/CommitUser"
  12139. },
  12140. "committer": {
  12141. "$ref": "#/definitions/CommitUser"
  12142. },
  12143. "message": {
  12144. "type": "string",
  12145. "x-go-name": "Message"
  12146. },
  12147. "tree": {
  12148. "$ref": "#/definitions/CommitMeta"
  12149. },
  12150. "url": {
  12151. "type": "string",
  12152. "x-go-name": "URL"
  12153. }
  12154. },
  12155. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12156. },
  12157. "RepoTopicOptions": {
  12158. "description": "RepoTopicOptions a collection of repo topic names",
  12159. "type": "object",
  12160. "properties": {
  12161. "topics": {
  12162. "description": "list of topic names",
  12163. "type": "array",
  12164. "items": {
  12165. "type": "string"
  12166. },
  12167. "x-go-name": "Topics"
  12168. }
  12169. },
  12170. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12171. },
  12172. "Repository": {
  12173. "description": "Repository represents a repository",
  12174. "type": "object",
  12175. "properties": {
  12176. "allow_merge_commits": {
  12177. "type": "boolean",
  12178. "x-go-name": "AllowMerge"
  12179. },
  12180. "allow_rebase": {
  12181. "type": "boolean",
  12182. "x-go-name": "AllowRebase"
  12183. },
  12184. "allow_rebase_explicit": {
  12185. "type": "boolean",
  12186. "x-go-name": "AllowRebaseMerge"
  12187. },
  12188. "allow_squash_merge": {
  12189. "type": "boolean",
  12190. "x-go-name": "AllowSquash"
  12191. },
  12192. "archived": {
  12193. "type": "boolean",
  12194. "x-go-name": "Archived"
  12195. },
  12196. "avatar_url": {
  12197. "type": "string",
  12198. "x-go-name": "AvatarURL"
  12199. },
  12200. "clone_url": {
  12201. "type": "string",
  12202. "x-go-name": "CloneURL"
  12203. },
  12204. "created_at": {
  12205. "type": "string",
  12206. "format": "date-time",
  12207. "x-go-name": "Created"
  12208. },
  12209. "default_branch": {
  12210. "type": "string",
  12211. "x-go-name": "DefaultBranch"
  12212. },
  12213. "description": {
  12214. "type": "string",
  12215. "x-go-name": "Description"
  12216. },
  12217. "empty": {
  12218. "type": "boolean",
  12219. "x-go-name": "Empty"
  12220. },
  12221. "external_tracker": {
  12222. "$ref": "#/definitions/ExternalTracker"
  12223. },
  12224. "external_wiki": {
  12225. "$ref": "#/definitions/ExternalWiki"
  12226. },
  12227. "fork": {
  12228. "type": "boolean",
  12229. "x-go-name": "Fork"
  12230. },
  12231. "forks_count": {
  12232. "type": "integer",
  12233. "format": "int64",
  12234. "x-go-name": "Forks"
  12235. },
  12236. "full_name": {
  12237. "type": "string",
  12238. "x-go-name": "FullName"
  12239. },
  12240. "has_issues": {
  12241. "type": "boolean",
  12242. "x-go-name": "HasIssues"
  12243. },
  12244. "has_pull_requests": {
  12245. "type": "boolean",
  12246. "x-go-name": "HasPullRequests"
  12247. },
  12248. "has_wiki": {
  12249. "type": "boolean",
  12250. "x-go-name": "HasWiki"
  12251. },
  12252. "html_url": {
  12253. "type": "string",
  12254. "x-go-name": "HTMLURL"
  12255. },
  12256. "id": {
  12257. "type": "integer",
  12258. "format": "int64",
  12259. "x-go-name": "ID"
  12260. },
  12261. "ignore_whitespace_conflicts": {
  12262. "type": "boolean",
  12263. "x-go-name": "IgnoreWhitespaceConflicts"
  12264. },
  12265. "internal_tracker": {
  12266. "$ref": "#/definitions/InternalTracker"
  12267. },
  12268. "mirror": {
  12269. "type": "boolean",
  12270. "x-go-name": "Mirror"
  12271. },
  12272. "name": {
  12273. "type": "string",
  12274. "x-go-name": "Name"
  12275. },
  12276. "open_issues_count": {
  12277. "type": "integer",
  12278. "format": "int64",
  12279. "x-go-name": "OpenIssues"
  12280. },
  12281. "open_pr_counter": {
  12282. "type": "integer",
  12283. "format": "int64",
  12284. "x-go-name": "OpenPulls"
  12285. },
  12286. "original_url": {
  12287. "type": "string",
  12288. "x-go-name": "OriginalURL"
  12289. },
  12290. "owner": {
  12291. "$ref": "#/definitions/User"
  12292. },
  12293. "parent": {
  12294. "$ref": "#/definitions/Repository"
  12295. },
  12296. "permissions": {
  12297. "$ref": "#/definitions/Permission"
  12298. },
  12299. "private": {
  12300. "type": "boolean",
  12301. "x-go-name": "Private"
  12302. },
  12303. "release_counter": {
  12304. "type": "integer",
  12305. "format": "int64",
  12306. "x-go-name": "Releases"
  12307. },
  12308. "size": {
  12309. "type": "integer",
  12310. "format": "int64",
  12311. "x-go-name": "Size"
  12312. },
  12313. "ssh_url": {
  12314. "type": "string",
  12315. "x-go-name": "SSHURL"
  12316. },
  12317. "stars_count": {
  12318. "type": "integer",
  12319. "format": "int64",
  12320. "x-go-name": "Stars"
  12321. },
  12322. "template": {
  12323. "type": "boolean",
  12324. "x-go-name": "Template"
  12325. },
  12326. "updated_at": {
  12327. "type": "string",
  12328. "format": "date-time",
  12329. "x-go-name": "Updated"
  12330. },
  12331. "watchers_count": {
  12332. "type": "integer",
  12333. "format": "int64",
  12334. "x-go-name": "Watchers"
  12335. },
  12336. "website": {
  12337. "type": "string",
  12338. "x-go-name": "Website"
  12339. }
  12340. },
  12341. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12342. },
  12343. "RepositoryMeta": {
  12344. "description": "RepositoryMeta basic repository information",
  12345. "type": "object",
  12346. "properties": {
  12347. "full_name": {
  12348. "type": "string",
  12349. "x-go-name": "FullName"
  12350. },
  12351. "id": {
  12352. "type": "integer",
  12353. "format": "int64",
  12354. "x-go-name": "ID"
  12355. },
  12356. "name": {
  12357. "type": "string",
  12358. "x-go-name": "Name"
  12359. },
  12360. "owner": {
  12361. "type": "string",
  12362. "x-go-name": "Owner"
  12363. }
  12364. },
  12365. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12366. },
  12367. "SearchResults": {
  12368. "description": "SearchResults results of a successful search",
  12369. "type": "object",
  12370. "properties": {
  12371. "data": {
  12372. "type": "array",
  12373. "items": {
  12374. "$ref": "#/definitions/Repository"
  12375. },
  12376. "x-go-name": "Data"
  12377. },
  12378. "ok": {
  12379. "type": "boolean",
  12380. "x-go-name": "OK"
  12381. }
  12382. },
  12383. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12384. },
  12385. "ServerVersion": {
  12386. "description": "ServerVersion wraps the version of the server",
  12387. "type": "object",
  12388. "properties": {
  12389. "version": {
  12390. "type": "string",
  12391. "x-go-name": "Version"
  12392. }
  12393. },
  12394. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12395. },
  12396. "StateType": {
  12397. "description": "StateType issue state type",
  12398. "type": "string",
  12399. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12400. },
  12401. "Status": {
  12402. "description": "Status holds a single Status of a single Commit",
  12403. "type": "object",
  12404. "properties": {
  12405. "context": {
  12406. "type": "string",
  12407. "x-go-name": "Context"
  12408. },
  12409. "created_at": {
  12410. "type": "string",
  12411. "format": "date-time",
  12412. "x-go-name": "Created"
  12413. },
  12414. "creator": {
  12415. "$ref": "#/definitions/User"
  12416. },
  12417. "description": {
  12418. "type": "string",
  12419. "x-go-name": "Description"
  12420. },
  12421. "id": {
  12422. "type": "integer",
  12423. "format": "int64",
  12424. "x-go-name": "ID"
  12425. },
  12426. "status": {
  12427. "$ref": "#/definitions/StatusState"
  12428. },
  12429. "target_url": {
  12430. "type": "string",
  12431. "x-go-name": "TargetURL"
  12432. },
  12433. "updated_at": {
  12434. "type": "string",
  12435. "format": "date-time",
  12436. "x-go-name": "Updated"
  12437. },
  12438. "url": {
  12439. "type": "string",
  12440. "x-go-name": "URL"
  12441. }
  12442. },
  12443. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12444. },
  12445. "StatusState": {
  12446. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  12447. "type": "string",
  12448. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12449. },
  12450. "StopWatch": {
  12451. "description": "StopWatch represent a running stopwatch",
  12452. "type": "object",
  12453. "properties": {
  12454. "created": {
  12455. "type": "string",
  12456. "format": "date-time",
  12457. "x-go-name": "Created"
  12458. },
  12459. "issue_index": {
  12460. "type": "integer",
  12461. "format": "int64",
  12462. "x-go-name": "IssueIndex"
  12463. }
  12464. },
  12465. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12466. },
  12467. "Tag": {
  12468. "description": "Tag represents a repository tag",
  12469. "type": "object",
  12470. "properties": {
  12471. "commit": {
  12472. "$ref": "#/definitions/CommitMeta"
  12473. },
  12474. "id": {
  12475. "type": "string",
  12476. "x-go-name": "ID"
  12477. },
  12478. "name": {
  12479. "type": "string",
  12480. "x-go-name": "Name"
  12481. },
  12482. "tarball_url": {
  12483. "type": "string",
  12484. "x-go-name": "TarballURL"
  12485. },
  12486. "zipball_url": {
  12487. "type": "string",
  12488. "x-go-name": "ZipballURL"
  12489. }
  12490. },
  12491. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12492. },
  12493. "Team": {
  12494. "description": "Team represents a team in an organization",
  12495. "type": "object",
  12496. "properties": {
  12497. "can_create_org_repo": {
  12498. "type": "boolean",
  12499. "x-go-name": "CanCreateOrgRepo"
  12500. },
  12501. "description": {
  12502. "type": "string",
  12503. "x-go-name": "Description"
  12504. },
  12505. "id": {
  12506. "type": "integer",
  12507. "format": "int64",
  12508. "x-go-name": "ID"
  12509. },
  12510. "includes_all_repositories": {
  12511. "type": "boolean",
  12512. "x-go-name": "IncludesAllRepositories"
  12513. },
  12514. "name": {
  12515. "type": "string",
  12516. "x-go-name": "Name"
  12517. },
  12518. "organization": {
  12519. "$ref": "#/definitions/Organization"
  12520. },
  12521. "permission": {
  12522. "type": "string",
  12523. "enum": [
  12524. "none",
  12525. "read",
  12526. "write",
  12527. "admin",
  12528. "owner"
  12529. ],
  12530. "x-go-name": "Permission"
  12531. },
  12532. "units": {
  12533. "type": "array",
  12534. "items": {
  12535. "type": "string"
  12536. },
  12537. "x-go-name": "Units",
  12538. "example": [
  12539. "repo.code",
  12540. "repo.issues",
  12541. "repo.ext_issues",
  12542. "repo.wiki",
  12543. "repo.pulls",
  12544. "repo.releases",
  12545. "repo.ext_wiki"
  12546. ]
  12547. }
  12548. },
  12549. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12550. },
  12551. "TimeStamp": {
  12552. "description": "TimeStamp defines a timestamp",
  12553. "type": "integer",
  12554. "format": "int64",
  12555. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  12556. },
  12557. "TopicName": {
  12558. "description": "TopicName a list of repo topic names",
  12559. "type": "object",
  12560. "properties": {
  12561. "topics": {
  12562. "type": "array",
  12563. "items": {
  12564. "type": "string"
  12565. },
  12566. "x-go-name": "TopicNames"
  12567. }
  12568. },
  12569. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12570. },
  12571. "TopicResponse": {
  12572. "description": "TopicResponse for returning topics",
  12573. "type": "object",
  12574. "properties": {
  12575. "created": {
  12576. "type": "string",
  12577. "format": "date-time",
  12578. "x-go-name": "Created"
  12579. },
  12580. "id": {
  12581. "type": "integer",
  12582. "format": "int64",
  12583. "x-go-name": "ID"
  12584. },
  12585. "repo_count": {
  12586. "type": "integer",
  12587. "format": "int64",
  12588. "x-go-name": "RepoCount"
  12589. },
  12590. "topic_name": {
  12591. "type": "string",
  12592. "x-go-name": "Name"
  12593. },
  12594. "updated": {
  12595. "type": "string",
  12596. "format": "date-time",
  12597. "x-go-name": "Updated"
  12598. }
  12599. },
  12600. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12601. },
  12602. "TrackedTime": {
  12603. "description": "TrackedTime worked time for an issue / pr",
  12604. "type": "object",
  12605. "properties": {
  12606. "created": {
  12607. "type": "string",
  12608. "format": "date-time",
  12609. "x-go-name": "Created"
  12610. },
  12611. "id": {
  12612. "type": "integer",
  12613. "format": "int64",
  12614. "x-go-name": "ID"
  12615. },
  12616. "issue": {
  12617. "$ref": "#/definitions/Issue"
  12618. },
  12619. "issue_id": {
  12620. "description": "deprecated (only for backwards compatibility)",
  12621. "type": "integer",
  12622. "format": "int64",
  12623. "x-go-name": "IssueID"
  12624. },
  12625. "time": {
  12626. "description": "Time in seconds",
  12627. "type": "integer",
  12628. "format": "int64",
  12629. "x-go-name": "Time"
  12630. },
  12631. "user_id": {
  12632. "description": "deprecated (only for backwards compatibility)",
  12633. "type": "integer",
  12634. "format": "int64",
  12635. "x-go-name": "UserID"
  12636. },
  12637. "user_name": {
  12638. "type": "string",
  12639. "x-go-name": "UserName"
  12640. }
  12641. },
  12642. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12643. },
  12644. "TransferRepoOption": {
  12645. "description": "TransferRepoOption options when transfer a repository's ownership",
  12646. "type": "object",
  12647. "required": [
  12648. "new_owner"
  12649. ],
  12650. "properties": {
  12651. "new_owner": {
  12652. "type": "string",
  12653. "x-go-name": "NewOwner"
  12654. },
  12655. "team_ids": {
  12656. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  12657. "type": "array",
  12658. "items": {
  12659. "type": "integer",
  12660. "format": "int64"
  12661. },
  12662. "x-go-name": "TeamIDs"
  12663. }
  12664. },
  12665. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12666. },
  12667. "UpdateFileOptions": {
  12668. "description": "UpdateFileOptions options for updating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  12669. "type": "object",
  12670. "required": [
  12671. "sha",
  12672. "content"
  12673. ],
  12674. "properties": {
  12675. "author": {
  12676. "$ref": "#/definitions/Identity"
  12677. },
  12678. "branch": {
  12679. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  12680. "type": "string",
  12681. "x-go-name": "BranchName"
  12682. },
  12683. "committer": {
  12684. "$ref": "#/definitions/Identity"
  12685. },
  12686. "content": {
  12687. "description": "content must be base64 encoded",
  12688. "type": "string",
  12689. "x-go-name": "Content"
  12690. },
  12691. "dates": {
  12692. "$ref": "#/definitions/CommitDateOptions"
  12693. },
  12694. "from_path": {
  12695. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  12696. "type": "string",
  12697. "x-go-name": "FromPath"
  12698. },
  12699. "message": {
  12700. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  12701. "type": "string",
  12702. "x-go-name": "Message"
  12703. },
  12704. "new_branch": {
  12705. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  12706. "type": "string",
  12707. "x-go-name": "NewBranchName"
  12708. },
  12709. "sha": {
  12710. "description": "sha is the SHA for the file that already exists",
  12711. "type": "string",
  12712. "x-go-name": "SHA"
  12713. }
  12714. },
  12715. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12716. },
  12717. "User": {
  12718. "description": "User represents a user",
  12719. "type": "object",
  12720. "properties": {
  12721. "avatar_url": {
  12722. "description": "URL to the user's avatar",
  12723. "type": "string",
  12724. "x-go-name": "AvatarURL"
  12725. },
  12726. "created": {
  12727. "type": "string",
  12728. "format": "date-time",
  12729. "x-go-name": "Created"
  12730. },
  12731. "email": {
  12732. "type": "string",
  12733. "format": "email",
  12734. "x-go-name": "Email"
  12735. },
  12736. "full_name": {
  12737. "description": "the user's full name",
  12738. "type": "string",
  12739. "x-go-name": "FullName"
  12740. },
  12741. "id": {
  12742. "description": "the user's id",
  12743. "type": "integer",
  12744. "format": "int64",
  12745. "x-go-name": "ID"
  12746. },
  12747. "is_admin": {
  12748. "description": "Is the user an administrator",
  12749. "type": "boolean",
  12750. "x-go-name": "IsAdmin"
  12751. },
  12752. "language": {
  12753. "description": "User locale",
  12754. "type": "string",
  12755. "x-go-name": "Language"
  12756. },
  12757. "last_login": {
  12758. "type": "string",
  12759. "format": "date-time",
  12760. "x-go-name": "LastLogin"
  12761. },
  12762. "login": {
  12763. "description": "the user's username",
  12764. "type": "string",
  12765. "x-go-name": "UserName"
  12766. }
  12767. },
  12768. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12769. },
  12770. "UserHeatmapData": {
  12771. "description": "UserHeatmapData represents the data needed to create a heatmap",
  12772. "type": "object",
  12773. "properties": {
  12774. "contributions": {
  12775. "type": "integer",
  12776. "format": "int64",
  12777. "x-go-name": "Contributions"
  12778. },
  12779. "timestamp": {
  12780. "$ref": "#/definitions/TimeStamp"
  12781. }
  12782. },
  12783. "x-go-package": "code.gitea.io/gitea/models"
  12784. },
  12785. "WatchInfo": {
  12786. "description": "WatchInfo represents an API watch status of one repository",
  12787. "type": "object",
  12788. "properties": {
  12789. "created_at": {
  12790. "type": "string",
  12791. "format": "date-time",
  12792. "x-go-name": "CreatedAt"
  12793. },
  12794. "ignored": {
  12795. "type": "boolean",
  12796. "x-go-name": "Ignored"
  12797. },
  12798. "reason": {
  12799. "type": "object",
  12800. "x-go-name": "Reason"
  12801. },
  12802. "repository_url": {
  12803. "type": "string",
  12804. "x-go-name": "RepositoryURL"
  12805. },
  12806. "subscribed": {
  12807. "type": "boolean",
  12808. "x-go-name": "Subscribed"
  12809. },
  12810. "url": {
  12811. "type": "string",
  12812. "x-go-name": "URL"
  12813. }
  12814. },
  12815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12816. }
  12817. },
  12818. "responses": {
  12819. "AccessToken": {
  12820. "description": "AccessToken represents an API access token.",
  12821. "headers": {
  12822. "id": {
  12823. "type": "integer",
  12824. "format": "int64"
  12825. },
  12826. "name": {
  12827. "type": "string"
  12828. },
  12829. "sha1": {
  12830. "type": "string"
  12831. },
  12832. "token_last_eight": {
  12833. "type": "string"
  12834. }
  12835. }
  12836. },
  12837. "AccessTokenList": {
  12838. "description": "AccessTokenList represents a list of API access token.",
  12839. "schema": {
  12840. "type": "array",
  12841. "items": {
  12842. "$ref": "#/definitions/AccessToken"
  12843. }
  12844. }
  12845. },
  12846. "AnnotatedTag": {
  12847. "description": "AnnotatedTag",
  12848. "schema": {
  12849. "$ref": "#/definitions/AnnotatedTag"
  12850. }
  12851. },
  12852. "Attachment": {
  12853. "description": "Attachment",
  12854. "schema": {
  12855. "$ref": "#/definitions/Attachment"
  12856. }
  12857. },
  12858. "AttachmentList": {
  12859. "description": "AttachmentList",
  12860. "schema": {
  12861. "type": "array",
  12862. "items": {
  12863. "$ref": "#/definitions/Attachment"
  12864. }
  12865. }
  12866. },
  12867. "Branch": {
  12868. "description": "Branch",
  12869. "schema": {
  12870. "$ref": "#/definitions/Branch"
  12871. }
  12872. },
  12873. "BranchList": {
  12874. "description": "BranchList",
  12875. "schema": {
  12876. "type": "array",
  12877. "items": {
  12878. "$ref": "#/definitions/Branch"
  12879. }
  12880. }
  12881. },
  12882. "Comment": {
  12883. "description": "Comment",
  12884. "schema": {
  12885. "$ref": "#/definitions/Comment"
  12886. }
  12887. },
  12888. "CommentList": {
  12889. "description": "CommentList",
  12890. "schema": {
  12891. "type": "array",
  12892. "items": {
  12893. "$ref": "#/definitions/Comment"
  12894. }
  12895. }
  12896. },
  12897. "Commit": {
  12898. "description": "Commit",
  12899. "schema": {
  12900. "$ref": "#/definitions/Commit"
  12901. }
  12902. },
  12903. "CommitList": {
  12904. "description": "CommitList",
  12905. "schema": {
  12906. "type": "array",
  12907. "items": {
  12908. "$ref": "#/definitions/Commit"
  12909. }
  12910. },
  12911. "headers": {
  12912. "X-HasMore": {
  12913. "type": "boolean",
  12914. "description": "True if there is another page"
  12915. },
  12916. "X-Page": {
  12917. "type": "integer",
  12918. "format": "int64",
  12919. "description": "The current page"
  12920. },
  12921. "X-PageCount": {
  12922. "type": "integer",
  12923. "format": "int64",
  12924. "description": "Total number of pages"
  12925. },
  12926. "X-PerPage": {
  12927. "type": "integer",
  12928. "format": "int64",
  12929. "description": "Commits per page"
  12930. },
  12931. "X-Total": {
  12932. "type": "integer",
  12933. "format": "int64",
  12934. "description": "Total commit count"
  12935. }
  12936. }
  12937. },
  12938. "ContentsListResponse": {
  12939. "description": "ContentsListResponse",
  12940. "schema": {
  12941. "type": "array",
  12942. "items": {
  12943. "$ref": "#/definitions/ContentsResponse"
  12944. }
  12945. }
  12946. },
  12947. "ContentsResponse": {
  12948. "description": "ContentsResponse",
  12949. "schema": {
  12950. "$ref": "#/definitions/ContentsResponse"
  12951. }
  12952. },
  12953. "DeployKey": {
  12954. "description": "DeployKey",
  12955. "schema": {
  12956. "$ref": "#/definitions/DeployKey"
  12957. }
  12958. },
  12959. "DeployKeyList": {
  12960. "description": "DeployKeyList",
  12961. "schema": {
  12962. "type": "array",
  12963. "items": {
  12964. "$ref": "#/definitions/DeployKey"
  12965. }
  12966. }
  12967. },
  12968. "EmailList": {
  12969. "description": "EmailList",
  12970. "schema": {
  12971. "type": "array",
  12972. "items": {
  12973. "$ref": "#/definitions/Email"
  12974. }
  12975. }
  12976. },
  12977. "EmptyRepository": {
  12978. "description": "EmptyRepository",
  12979. "schema": {
  12980. "$ref": "#/definitions/APIError"
  12981. }
  12982. },
  12983. "FileDeleteResponse": {
  12984. "description": "FileDeleteResponse",
  12985. "schema": {
  12986. "$ref": "#/definitions/FileDeleteResponse"
  12987. }
  12988. },
  12989. "FileResponse": {
  12990. "description": "FileResponse",
  12991. "schema": {
  12992. "$ref": "#/definitions/FileResponse"
  12993. }
  12994. },
  12995. "GPGKey": {
  12996. "description": "GPGKey",
  12997. "schema": {
  12998. "$ref": "#/definitions/GPGKey"
  12999. }
  13000. },
  13001. "GPGKeyList": {
  13002. "description": "GPGKeyList",
  13003. "schema": {
  13004. "type": "array",
  13005. "items": {
  13006. "$ref": "#/definitions/GPGKey"
  13007. }
  13008. }
  13009. },
  13010. "GitBlobResponse": {
  13011. "description": "GitBlobResponse",
  13012. "schema": {
  13013. "$ref": "#/definitions/GitBlobResponse"
  13014. }
  13015. },
  13016. "GitHook": {
  13017. "description": "GitHook",
  13018. "schema": {
  13019. "$ref": "#/definitions/GitHook"
  13020. }
  13021. },
  13022. "GitHookList": {
  13023. "description": "GitHookList",
  13024. "schema": {
  13025. "type": "array",
  13026. "items": {
  13027. "$ref": "#/definitions/GitHook"
  13028. }
  13029. }
  13030. },
  13031. "GitTreeResponse": {
  13032. "description": "GitTreeResponse",
  13033. "schema": {
  13034. "$ref": "#/definitions/GitTreeResponse"
  13035. }
  13036. },
  13037. "Hook": {
  13038. "description": "Hook",
  13039. "schema": {
  13040. "$ref": "#/definitions/Hook"
  13041. }
  13042. },
  13043. "HookList": {
  13044. "description": "HookList",
  13045. "schema": {
  13046. "type": "array",
  13047. "items": {
  13048. "$ref": "#/definitions/Hook"
  13049. }
  13050. }
  13051. },
  13052. "Issue": {
  13053. "description": "Issue",
  13054. "schema": {
  13055. "$ref": "#/definitions/Issue"
  13056. }
  13057. },
  13058. "IssueDeadline": {
  13059. "description": "IssueDeadline",
  13060. "schema": {
  13061. "$ref": "#/definitions/IssueDeadline"
  13062. }
  13063. },
  13064. "IssueList": {
  13065. "description": "IssueList",
  13066. "schema": {
  13067. "type": "array",
  13068. "items": {
  13069. "$ref": "#/definitions/Issue"
  13070. }
  13071. }
  13072. },
  13073. "Label": {
  13074. "description": "Label",
  13075. "schema": {
  13076. "$ref": "#/definitions/Label"
  13077. }
  13078. },
  13079. "LabelList": {
  13080. "description": "LabelList",
  13081. "schema": {
  13082. "type": "array",
  13083. "items": {
  13084. "$ref": "#/definitions/Label"
  13085. }
  13086. }
  13087. },
  13088. "MarkdownRender": {
  13089. "description": "MarkdownRender is a rendered markdown document",
  13090. "schema": {
  13091. "type": "string"
  13092. }
  13093. },
  13094. "Milestone": {
  13095. "description": "Milestone",
  13096. "schema": {
  13097. "$ref": "#/definitions/Milestone"
  13098. }
  13099. },
  13100. "MilestoneList": {
  13101. "description": "MilestoneList",
  13102. "schema": {
  13103. "type": "array",
  13104. "items": {
  13105. "$ref": "#/definitions/Milestone"
  13106. }
  13107. }
  13108. },
  13109. "NotificationCount": {
  13110. "description": "Number of unread notifications",
  13111. "schema": {
  13112. "$ref": "#/definitions/NotificationCount"
  13113. }
  13114. },
  13115. "NotificationThread": {
  13116. "description": "NotificationThread",
  13117. "schema": {
  13118. "$ref": "#/definitions/NotificationThread"
  13119. }
  13120. },
  13121. "NotificationThreadList": {
  13122. "description": "NotificationThreadList",
  13123. "schema": {
  13124. "type": "array",
  13125. "items": {
  13126. "$ref": "#/definitions/NotificationThread"
  13127. }
  13128. }
  13129. },
  13130. "Organization": {
  13131. "description": "Organization",
  13132. "schema": {
  13133. "$ref": "#/definitions/Organization"
  13134. }
  13135. },
  13136. "OrganizationList": {
  13137. "description": "OrganizationList",
  13138. "schema": {
  13139. "type": "array",
  13140. "items": {
  13141. "$ref": "#/definitions/Organization"
  13142. }
  13143. }
  13144. },
  13145. "PublicKey": {
  13146. "description": "PublicKey",
  13147. "schema": {
  13148. "$ref": "#/definitions/PublicKey"
  13149. }
  13150. },
  13151. "PublicKeyList": {
  13152. "description": "PublicKeyList",
  13153. "schema": {
  13154. "type": "array",
  13155. "items": {
  13156. "$ref": "#/definitions/PublicKey"
  13157. }
  13158. }
  13159. },
  13160. "PullRequest": {
  13161. "description": "PullRequest",
  13162. "schema": {
  13163. "$ref": "#/definitions/PullRequest"
  13164. }
  13165. },
  13166. "PullRequestList": {
  13167. "description": "PullRequestList",
  13168. "schema": {
  13169. "type": "array",
  13170. "items": {
  13171. "$ref": "#/definitions/PullRequest"
  13172. }
  13173. }
  13174. },
  13175. "Reaction": {
  13176. "description": "Reaction",
  13177. "schema": {
  13178. "$ref": "#/definitions/Reaction"
  13179. }
  13180. },
  13181. "ReactionList": {
  13182. "description": "ReactionList",
  13183. "schema": {
  13184. "type": "array",
  13185. "items": {
  13186. "$ref": "#/definitions/Reaction"
  13187. }
  13188. }
  13189. },
  13190. "Reference": {
  13191. "description": "Reference",
  13192. "schema": {
  13193. "$ref": "#/definitions/Reference"
  13194. }
  13195. },
  13196. "ReferenceList": {
  13197. "description": "ReferenceList",
  13198. "schema": {
  13199. "type": "array",
  13200. "items": {
  13201. "$ref": "#/definitions/Reference"
  13202. }
  13203. }
  13204. },
  13205. "Release": {
  13206. "description": "Release",
  13207. "schema": {
  13208. "$ref": "#/definitions/Release"
  13209. }
  13210. },
  13211. "ReleaseList": {
  13212. "description": "ReleaseList",
  13213. "schema": {
  13214. "type": "array",
  13215. "items": {
  13216. "$ref": "#/definitions/Release"
  13217. }
  13218. }
  13219. },
  13220. "Repository": {
  13221. "description": "Repository",
  13222. "schema": {
  13223. "$ref": "#/definitions/Repository"
  13224. }
  13225. },
  13226. "RepositoryList": {
  13227. "description": "RepositoryList",
  13228. "schema": {
  13229. "type": "array",
  13230. "items": {
  13231. "$ref": "#/definitions/Repository"
  13232. }
  13233. }
  13234. },
  13235. "SearchResults": {
  13236. "description": "SearchResults",
  13237. "schema": {
  13238. "$ref": "#/definitions/SearchResults"
  13239. }
  13240. },
  13241. "ServerVersion": {
  13242. "description": "ServerVersion",
  13243. "schema": {
  13244. "$ref": "#/definitions/ServerVersion"
  13245. }
  13246. },
  13247. "Status": {
  13248. "description": "Status",
  13249. "schema": {
  13250. "$ref": "#/definitions/Status"
  13251. }
  13252. },
  13253. "StatusList": {
  13254. "description": "StatusList",
  13255. "schema": {
  13256. "type": "array",
  13257. "items": {
  13258. "$ref": "#/definitions/Status"
  13259. }
  13260. }
  13261. },
  13262. "StopWatch": {
  13263. "description": "StopWatch",
  13264. "schema": {
  13265. "$ref": "#/definitions/StopWatch"
  13266. }
  13267. },
  13268. "StopWatchList": {
  13269. "description": "StopWatchList",
  13270. "schema": {
  13271. "type": "array",
  13272. "items": {
  13273. "$ref": "#/definitions/StopWatch"
  13274. }
  13275. }
  13276. },
  13277. "Tag": {
  13278. "description": "Tag",
  13279. "schema": {
  13280. "$ref": "#/definitions/Tag"
  13281. }
  13282. },
  13283. "TagList": {
  13284. "description": "TagList",
  13285. "schema": {
  13286. "type": "array",
  13287. "items": {
  13288. "$ref": "#/definitions/Tag"
  13289. }
  13290. }
  13291. },
  13292. "Team": {
  13293. "description": "Team",
  13294. "schema": {
  13295. "$ref": "#/definitions/Team"
  13296. }
  13297. },
  13298. "TeamList": {
  13299. "description": "TeamList",
  13300. "schema": {
  13301. "type": "array",
  13302. "items": {
  13303. "$ref": "#/definitions/Team"
  13304. }
  13305. }
  13306. },
  13307. "TopicListResponse": {
  13308. "description": "TopicListResponse",
  13309. "schema": {
  13310. "type": "array",
  13311. "items": {
  13312. "$ref": "#/definitions/TopicResponse"
  13313. }
  13314. }
  13315. },
  13316. "TopicNames": {
  13317. "description": "TopicNames",
  13318. "schema": {
  13319. "$ref": "#/definitions/TopicName"
  13320. }
  13321. },
  13322. "TrackedTime": {
  13323. "description": "TrackedTime",
  13324. "schema": {
  13325. "$ref": "#/definitions/TrackedTime"
  13326. }
  13327. },
  13328. "TrackedTimeList": {
  13329. "description": "TrackedTimeList",
  13330. "schema": {
  13331. "type": "array",
  13332. "items": {
  13333. "$ref": "#/definitions/TrackedTime"
  13334. }
  13335. }
  13336. },
  13337. "User": {
  13338. "description": "User",
  13339. "schema": {
  13340. "$ref": "#/definitions/User"
  13341. }
  13342. },
  13343. "UserHeatmapData": {
  13344. "description": "UserHeatmapData",
  13345. "schema": {
  13346. "type": "array",
  13347. "items": {
  13348. "$ref": "#/definitions/UserHeatmapData"
  13349. }
  13350. }
  13351. },
  13352. "UserList": {
  13353. "description": "UserList",
  13354. "schema": {
  13355. "type": "array",
  13356. "items": {
  13357. "$ref": "#/definitions/User"
  13358. }
  13359. }
  13360. },
  13361. "WatchInfo": {
  13362. "description": "WatchInfo",
  13363. "schema": {
  13364. "$ref": "#/definitions/WatchInfo"
  13365. }
  13366. },
  13367. "empty": {
  13368. "description": "APIEmpty is an empty response"
  13369. },
  13370. "error": {
  13371. "description": "APIError is error format response",
  13372. "headers": {
  13373. "message": {
  13374. "type": "string"
  13375. },
  13376. "url": {
  13377. "type": "string"
  13378. }
  13379. }
  13380. },
  13381. "forbidden": {
  13382. "description": "APIForbiddenError is a forbidden error response",
  13383. "headers": {
  13384. "message": {
  13385. "type": "string"
  13386. },
  13387. "url": {
  13388. "type": "string"
  13389. }
  13390. }
  13391. },
  13392. "invalidTopicsError": {
  13393. "description": "APIInvalidTopicsError is error format response to invalid topics",
  13394. "headers": {
  13395. "invalidTopics": {
  13396. "type": "array",
  13397. "items": {
  13398. "type": "string"
  13399. }
  13400. },
  13401. "message": {
  13402. "type": "string"
  13403. }
  13404. }
  13405. },
  13406. "notFound": {
  13407. "description": "APINotFound is a not found empty response"
  13408. },
  13409. "parameterBodies": {
  13410. "description": "parameterBodies",
  13411. "schema": {
  13412. "$ref": "#/definitions/EditReactionOption"
  13413. }
  13414. },
  13415. "redirect": {
  13416. "description": "APIRedirect is a redirect response"
  13417. },
  13418. "validationError": {
  13419. "description": "APIValidationError is error format response related to input validation",
  13420. "headers": {
  13421. "message": {
  13422. "type": "string"
  13423. },
  13424. "url": {
  13425. "type": "string"
  13426. }
  13427. }
  13428. }
  13429. },
  13430. "securityDefinitions": {
  13431. "AccessToken": {
  13432. "type": "apiKey",
  13433. "name": "access_token",
  13434. "in": "query"
  13435. },
  13436. "AuthorizationHeaderToken": {
  13437. "description": "API tokens must be prepended with \"token\" followed by a space.",
  13438. "type": "apiKey",
  13439. "name": "Authorization",
  13440. "in": "header"
  13441. },
  13442. "BasicAuth": {
  13443. "type": "basic"
  13444. },
  13445. "SudoHeader": {
  13446. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  13447. "type": "apiKey",
  13448. "name": "Sudo",
  13449. "in": "header"
  13450. },
  13451. "SudoParam": {
  13452. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  13453. "type": "apiKey",
  13454. "name": "sudo",
  13455. "in": "query"
  13456. },
  13457. "Token": {
  13458. "type": "apiKey",
  13459. "name": "token",
  13460. "in": "query"
  13461. }
  13462. },
  13463. "security": [
  13464. {
  13465. "BasicAuth": []
  13466. },
  13467. {
  13468. "Token": []
  13469. },
  13470. {
  13471. "AccessToken": []
  13472. },
  13473. {
  13474. "AuthorizationHeaderToken": []
  13475. },
  13476. {
  13477. "SudoParam": []
  13478. },
  13479. {
  13480. "SudoHeader": []
  13481. }
  13482. ]
  13483. }