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.

swagger.v1.json 171KB

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