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

v1_json.tmpl 362KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API.",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "1.1.1"
  23. },
  24. "basePath": "{{AppSubUrl}}/api/v1",
  25. "paths": {
  26. "/admin/orgs": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List all organizations",
  35. "operationId": "adminGetAllOrgs",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results, maximum page size is 50",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/OrganizationList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/users": {
  61. "get": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "List all users",
  69. "operationId": "adminGetAllUsers",
  70. "parameters": [
  71. {
  72. "type": "integer",
  73. "description": "page number of results to return (1-based)",
  74. "name": "page",
  75. "in": "query"
  76. },
  77. {
  78. "type": "integer",
  79. "description": "page size of results, maximum page size is 50",
  80. "name": "limit",
  81. "in": "query"
  82. }
  83. ],
  84. "responses": {
  85. "200": {
  86. "$ref": "#/responses/UserList"
  87. },
  88. "403": {
  89. "$ref": "#/responses/forbidden"
  90. }
  91. }
  92. },
  93. "post": {
  94. "consumes": [
  95. "application/json"
  96. ],
  97. "produces": [
  98. "application/json"
  99. ],
  100. "tags": [
  101. "admin"
  102. ],
  103. "summary": "Create a user",
  104. "operationId": "adminCreateUser",
  105. "parameters": [
  106. {
  107. "name": "body",
  108. "in": "body",
  109. "schema": {
  110. "$ref": "#/definitions/CreateUserOption"
  111. }
  112. }
  113. ],
  114. "responses": {
  115. "201": {
  116. "$ref": "#/responses/User"
  117. },
  118. "400": {
  119. "$ref": "#/responses/error"
  120. },
  121. "403": {
  122. "$ref": "#/responses/forbidden"
  123. },
  124. "422": {
  125. "$ref": "#/responses/validationError"
  126. }
  127. }
  128. }
  129. },
  130. "/admin/users/{username}": {
  131. "delete": {
  132. "produces": [
  133. "application/json"
  134. ],
  135. "tags": [
  136. "admin"
  137. ],
  138. "summary": "Delete a user",
  139. "operationId": "adminDeleteUser",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "username of user to delete",
  144. "name": "username",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "204": {
  151. "$ref": "#/responses/empty"
  152. },
  153. "403": {
  154. "$ref": "#/responses/forbidden"
  155. },
  156. "422": {
  157. "$ref": "#/responses/validationError"
  158. }
  159. }
  160. },
  161. "patch": {
  162. "consumes": [
  163. "application/json"
  164. ],
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Edit an existing user",
  172. "operationId": "adminEditUser",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "username of user to edit",
  177. "name": "username",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "name": "body",
  183. "in": "body",
  184. "schema": {
  185. "$ref": "#/definitions/EditUserOption"
  186. }
  187. }
  188. ],
  189. "responses": {
  190. "200": {
  191. "$ref": "#/responses/User"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "422": {
  197. "$ref": "#/responses/validationError"
  198. }
  199. }
  200. }
  201. },
  202. "/admin/users/{username}/keys": {
  203. "post": {
  204. "consumes": [
  205. "application/json"
  206. ],
  207. "produces": [
  208. "application/json"
  209. ],
  210. "tags": [
  211. "admin"
  212. ],
  213. "summary": "Add a public key on behalf of a user",
  214. "operationId": "adminCreatePublicKey",
  215. "parameters": [
  216. {
  217. "type": "string",
  218. "description": "username of the user",
  219. "name": "username",
  220. "in": "path",
  221. "required": true
  222. },
  223. {
  224. "name": "key",
  225. "in": "body",
  226. "schema": {
  227. "$ref": "#/definitions/CreateKeyOption"
  228. }
  229. }
  230. ],
  231. "responses": {
  232. "201": {
  233. "$ref": "#/responses/PublicKey"
  234. },
  235. "403": {
  236. "$ref": "#/responses/forbidden"
  237. },
  238. "422": {
  239. "$ref": "#/responses/validationError"
  240. }
  241. }
  242. }
  243. },
  244. "/admin/users/{username}/keys/{id}": {
  245. "delete": {
  246. "produces": [
  247. "application/json"
  248. ],
  249. "tags": [
  250. "admin"
  251. ],
  252. "summary": "Delete a user's public key",
  253. "operationId": "adminDeleteUserPublicKey",
  254. "parameters": [
  255. {
  256. "type": "string",
  257. "description": "username of user",
  258. "name": "username",
  259. "in": "path",
  260. "required": true
  261. },
  262. {
  263. "type": "integer",
  264. "format": "int64",
  265. "description": "id of the key to delete",
  266. "name": "id",
  267. "in": "path",
  268. "required": true
  269. }
  270. ],
  271. "responses": {
  272. "204": {
  273. "$ref": "#/responses/empty"
  274. },
  275. "403": {
  276. "$ref": "#/responses/forbidden"
  277. },
  278. "404": {
  279. "$ref": "#/responses/notFound"
  280. }
  281. }
  282. }
  283. },
  284. "/admin/users/{username}/orgs": {
  285. "post": {
  286. "consumes": [
  287. "application/json"
  288. ],
  289. "produces": [
  290. "application/json"
  291. ],
  292. "tags": [
  293. "admin"
  294. ],
  295. "summary": "Create an organization",
  296. "operationId": "adminCreateOrg",
  297. "parameters": [
  298. {
  299. "type": "string",
  300. "description": "username of the user that will own the created organization",
  301. "name": "username",
  302. "in": "path",
  303. "required": true
  304. },
  305. {
  306. "name": "organization",
  307. "in": "body",
  308. "required": true,
  309. "schema": {
  310. "$ref": "#/definitions/CreateOrgOption"
  311. }
  312. }
  313. ],
  314. "responses": {
  315. "201": {
  316. "$ref": "#/responses/Organization"
  317. },
  318. "403": {
  319. "$ref": "#/responses/forbidden"
  320. },
  321. "422": {
  322. "$ref": "#/responses/validationError"
  323. }
  324. }
  325. }
  326. },
  327. "/admin/users/{username}/repos": {
  328. "post": {
  329. "consumes": [
  330. "application/json"
  331. ],
  332. "produces": [
  333. "application/json"
  334. ],
  335. "tags": [
  336. "admin"
  337. ],
  338. "summary": "Create a repository on behalf of a user",
  339. "operationId": "adminCreateRepo",
  340. "parameters": [
  341. {
  342. "type": "string",
  343. "description": "username of the user. This user will own the created repository",
  344. "name": "username",
  345. "in": "path",
  346. "required": true
  347. },
  348. {
  349. "name": "repository",
  350. "in": "body",
  351. "required": true,
  352. "schema": {
  353. "$ref": "#/definitions/CreateRepoOption"
  354. }
  355. }
  356. ],
  357. "responses": {
  358. "201": {
  359. "$ref": "#/responses/Repository"
  360. },
  361. "403": {
  362. "$ref": "#/responses/forbidden"
  363. },
  364. "404": {
  365. "$ref": "#/responses/notFound"
  366. },
  367. "409": {
  368. "$ref": "#/responses/error"
  369. },
  370. "422": {
  371. "$ref": "#/responses/validationError"
  372. }
  373. }
  374. }
  375. },
  376. "/markdown": {
  377. "post": {
  378. "consumes": [
  379. "application/json"
  380. ],
  381. "produces": [
  382. "text/html"
  383. ],
  384. "tags": [
  385. "miscellaneous"
  386. ],
  387. "summary": "Render a markdown document as HTML",
  388. "operationId": "renderMarkdown",
  389. "parameters": [
  390. {
  391. "name": "body",
  392. "in": "body",
  393. "schema": {
  394. "$ref": "#/definitions/MarkdownOption"
  395. }
  396. }
  397. ],
  398. "responses": {
  399. "200": {
  400. "$ref": "#/responses/MarkdownRender"
  401. },
  402. "422": {
  403. "$ref": "#/responses/validationError"
  404. }
  405. }
  406. }
  407. },
  408. "/markdown/raw": {
  409. "post": {
  410. "consumes": [
  411. "text/plain"
  412. ],
  413. "produces": [
  414. "text/html"
  415. ],
  416. "tags": [
  417. "miscellaneous"
  418. ],
  419. "summary": "Render raw markdown as HTML",
  420. "operationId": "renderMarkdownRaw",
  421. "parameters": [
  422. {
  423. "description": "Request body to render",
  424. "name": "body",
  425. "in": "body",
  426. "required": true,
  427. "schema": {
  428. "type": "string"
  429. }
  430. }
  431. ],
  432. "responses": {
  433. "200": {
  434. "$ref": "#/responses/MarkdownRender"
  435. },
  436. "422": {
  437. "$ref": "#/responses/validationError"
  438. }
  439. }
  440. }
  441. },
  442. "/notifications": {
  443. "get": {
  444. "consumes": [
  445. "application/json"
  446. ],
  447. "produces": [
  448. "application/json"
  449. ],
  450. "tags": [
  451. "notification"
  452. ],
  453. "summary": "List users's notification threads",
  454. "operationId": "notifyGetList",
  455. "parameters": [
  456. {
  457. "type": "string",
  458. "description": "If true, show notifications marked as read. Default value is false",
  459. "name": "all",
  460. "in": "query"
  461. },
  462. {
  463. "type": "string",
  464. "format": "date-time",
  465. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  466. "name": "since",
  467. "in": "query"
  468. },
  469. {
  470. "type": "string",
  471. "format": "date-time",
  472. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  473. "name": "before",
  474. "in": "query"
  475. },
  476. {
  477. "type": "integer",
  478. "description": "page number of results to return (1-based)",
  479. "name": "page",
  480. "in": "query"
  481. },
  482. {
  483. "type": "integer",
  484. "description": "page size of results, maximum page size is 50",
  485. "name": "limit",
  486. "in": "query"
  487. }
  488. ],
  489. "responses": {
  490. "200": {
  491. "$ref": "#/responses/NotificationThreadList"
  492. }
  493. }
  494. },
  495. "put": {
  496. "consumes": [
  497. "application/json"
  498. ],
  499. "produces": [
  500. "application/json"
  501. ],
  502. "tags": [
  503. "notification"
  504. ],
  505. "summary": "Mark notification threads as read",
  506. "operationId": "notifyReadList",
  507. "parameters": [
  508. {
  509. "type": "string",
  510. "format": "date-time",
  511. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  512. "name": "last_read_at",
  513. "in": "query"
  514. }
  515. ],
  516. "responses": {
  517. "205": {
  518. "$ref": "#/responses/empty"
  519. }
  520. }
  521. }
  522. },
  523. "/notifications/new": {
  524. "get": {
  525. "tags": [
  526. "notification"
  527. ],
  528. "summary": "Check if unread notifications exist",
  529. "operationId": "notifyNewAvailable",
  530. "responses": {
  531. "200": {
  532. "$ref": "#/responses/NotificationCount"
  533. },
  534. "204": {
  535. "description": "No unread notification"
  536. }
  537. }
  538. }
  539. },
  540. "/notifications/threads/{id}": {
  541. "get": {
  542. "consumes": [
  543. "application/json"
  544. ],
  545. "produces": [
  546. "application/json"
  547. ],
  548. "tags": [
  549. "notification"
  550. ],
  551. "summary": "Get notification thread by ID",
  552. "operationId": "notifyGetThread",
  553. "parameters": [
  554. {
  555. "type": "string",
  556. "description": "id of notification thread",
  557. "name": "id",
  558. "in": "path",
  559. "required": true
  560. }
  561. ],
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/NotificationThread"
  565. },
  566. "403": {
  567. "$ref": "#/responses/forbidden"
  568. },
  569. "404": {
  570. "$ref": "#/responses/notFound"
  571. }
  572. }
  573. },
  574. "patch": {
  575. "consumes": [
  576. "application/json"
  577. ],
  578. "produces": [
  579. "application/json"
  580. ],
  581. "tags": [
  582. "notification"
  583. ],
  584. "summary": "Mark notification thread as read by ID",
  585. "operationId": "notifyReadThread",
  586. "parameters": [
  587. {
  588. "type": "string",
  589. "description": "id of notification thread",
  590. "name": "id",
  591. "in": "path",
  592. "required": true
  593. }
  594. ],
  595. "responses": {
  596. "205": {
  597. "$ref": "#/responses/empty"
  598. },
  599. "403": {
  600. "$ref": "#/responses/forbidden"
  601. },
  602. "404": {
  603. "$ref": "#/responses/notFound"
  604. }
  605. }
  606. }
  607. },
  608. "/org/{org}/repos": {
  609. "post": {
  610. "consumes": [
  611. "application/json"
  612. ],
  613. "produces": [
  614. "application/json"
  615. ],
  616. "tags": [
  617. "organization"
  618. ],
  619. "summary": "Create a repository in an organization",
  620. "operationId": "createOrgRepoDeprecated",
  621. "deprecated": true,
  622. "parameters": [
  623. {
  624. "type": "string",
  625. "description": "name of organization",
  626. "name": "org",
  627. "in": "path",
  628. "required": true
  629. },
  630. {
  631. "name": "body",
  632. "in": "body",
  633. "schema": {
  634. "$ref": "#/definitions/CreateRepoOption"
  635. }
  636. }
  637. ],
  638. "responses": {
  639. "201": {
  640. "$ref": "#/responses/Repository"
  641. },
  642. "403": {
  643. "$ref": "#/responses/forbidden"
  644. },
  645. "422": {
  646. "$ref": "#/responses/validationError"
  647. }
  648. }
  649. }
  650. },
  651. "/orgs": {
  652. "get": {
  653. "produces": [
  654. "application/json"
  655. ],
  656. "tags": [
  657. "organization"
  658. ],
  659. "summary": "Get list of organizations",
  660. "operationId": "orgGetAll",
  661. "parameters": [
  662. {
  663. "type": "integer",
  664. "description": "page number of results to return (1-based)",
  665. "name": "page",
  666. "in": "query"
  667. },
  668. {
  669. "type": "integer",
  670. "description": "page size of results, maximum page size is 50",
  671. "name": "limit",
  672. "in": "query"
  673. }
  674. ],
  675. "responses": {
  676. "200": {
  677. "$ref": "#/responses/OrganizationList"
  678. }
  679. }
  680. },
  681. "post": {
  682. "consumes": [
  683. "application/json"
  684. ],
  685. "produces": [
  686. "application/json"
  687. ],
  688. "tags": [
  689. "organization"
  690. ],
  691. "summary": "Create an organization",
  692. "operationId": "orgCreate",
  693. "parameters": [
  694. {
  695. "name": "organization",
  696. "in": "body",
  697. "required": true,
  698. "schema": {
  699. "$ref": "#/definitions/CreateOrgOption"
  700. }
  701. }
  702. ],
  703. "responses": {
  704. "201": {
  705. "$ref": "#/responses/Organization"
  706. },
  707. "403": {
  708. "$ref": "#/responses/forbidden"
  709. },
  710. "422": {
  711. "$ref": "#/responses/validationError"
  712. }
  713. }
  714. }
  715. },
  716. "/orgs/{org}": {
  717. "get": {
  718. "produces": [
  719. "application/json"
  720. ],
  721. "tags": [
  722. "organization"
  723. ],
  724. "summary": "Get an organization",
  725. "operationId": "orgGet",
  726. "parameters": [
  727. {
  728. "type": "string",
  729. "description": "name of the organization to get",
  730. "name": "org",
  731. "in": "path",
  732. "required": true
  733. }
  734. ],
  735. "responses": {
  736. "200": {
  737. "$ref": "#/responses/Organization"
  738. }
  739. }
  740. },
  741. "delete": {
  742. "produces": [
  743. "application/json"
  744. ],
  745. "tags": [
  746. "organization"
  747. ],
  748. "summary": "Delete an organization",
  749. "operationId": "orgDelete",
  750. "parameters": [
  751. {
  752. "type": "string",
  753. "description": "organization that is to be deleted",
  754. "name": "org",
  755. "in": "path",
  756. "required": true
  757. }
  758. ],
  759. "responses": {
  760. "204": {
  761. "$ref": "#/responses/empty"
  762. }
  763. }
  764. },
  765. "patch": {
  766. "consumes": [
  767. "application/json"
  768. ],
  769. "produces": [
  770. "application/json"
  771. ],
  772. "tags": [
  773. "organization"
  774. ],
  775. "summary": "Edit an organization",
  776. "operationId": "orgEdit",
  777. "parameters": [
  778. {
  779. "type": "string",
  780. "description": "name of the organization to edit",
  781. "name": "org",
  782. "in": "path",
  783. "required": true
  784. },
  785. {
  786. "name": "body",
  787. "in": "body",
  788. "required": true,
  789. "schema": {
  790. "$ref": "#/definitions/EditOrgOption"
  791. }
  792. }
  793. ],
  794. "responses": {
  795. "200": {
  796. "$ref": "#/responses/Organization"
  797. }
  798. }
  799. }
  800. },
  801. "/orgs/{org}/hooks": {
  802. "get": {
  803. "produces": [
  804. "application/json"
  805. ],
  806. "tags": [
  807. "organization"
  808. ],
  809. "summary": "List an organization's webhooks",
  810. "operationId": "orgListHooks",
  811. "parameters": [
  812. {
  813. "type": "string",
  814. "description": "name of the organization",
  815. "name": "org",
  816. "in": "path",
  817. "required": true
  818. },
  819. {
  820. "type": "integer",
  821. "description": "page number of results to return (1-based)",
  822. "name": "page",
  823. "in": "query"
  824. },
  825. {
  826. "type": "integer",
  827. "description": "page size of results, maximum page size is 50",
  828. "name": "limit",
  829. "in": "query"
  830. }
  831. ],
  832. "responses": {
  833. "200": {
  834. "$ref": "#/responses/HookList"
  835. }
  836. }
  837. }
  838. },
  839. "/orgs/{org}/hooks/": {
  840. "post": {
  841. "consumes": [
  842. "application/json"
  843. ],
  844. "produces": [
  845. "application/json"
  846. ],
  847. "tags": [
  848. "organization"
  849. ],
  850. "summary": "Create a hook",
  851. "operationId": "orgCreateHook",
  852. "parameters": [
  853. {
  854. "type": "string",
  855. "description": "name of the organization",
  856. "name": "org",
  857. "in": "path",
  858. "required": true
  859. },
  860. {
  861. "name": "body",
  862. "in": "body",
  863. "required": true,
  864. "schema": {
  865. "$ref": "#/definitions/CreateHookOption"
  866. }
  867. }
  868. ],
  869. "responses": {
  870. "201": {
  871. "$ref": "#/responses/Hook"
  872. }
  873. }
  874. }
  875. },
  876. "/orgs/{org}/hooks/{id}": {
  877. "get": {
  878. "produces": [
  879. "application/json"
  880. ],
  881. "tags": [
  882. "organization"
  883. ],
  884. "summary": "Get a hook",
  885. "operationId": "orgGetHook",
  886. "parameters": [
  887. {
  888. "type": "string",
  889. "description": "name of the organization",
  890. "name": "org",
  891. "in": "path",
  892. "required": true
  893. },
  894. {
  895. "type": "integer",
  896. "format": "int64",
  897. "description": "id of the hook to get",
  898. "name": "id",
  899. "in": "path",
  900. "required": true
  901. }
  902. ],
  903. "responses": {
  904. "200": {
  905. "$ref": "#/responses/Hook"
  906. }
  907. }
  908. },
  909. "delete": {
  910. "produces": [
  911. "application/json"
  912. ],
  913. "tags": [
  914. "organization"
  915. ],
  916. "summary": "Delete a hook",
  917. "operationId": "orgDeleteHook",
  918. "parameters": [
  919. {
  920. "type": "string",
  921. "description": "name of the organization",
  922. "name": "org",
  923. "in": "path",
  924. "required": true
  925. },
  926. {
  927. "type": "integer",
  928. "format": "int64",
  929. "description": "id of the hook to delete",
  930. "name": "id",
  931. "in": "path",
  932. "required": true
  933. }
  934. ],
  935. "responses": {
  936. "204": {
  937. "$ref": "#/responses/empty"
  938. }
  939. }
  940. },
  941. "patch": {
  942. "consumes": [
  943. "application/json"
  944. ],
  945. "produces": [
  946. "application/json"
  947. ],
  948. "tags": [
  949. "organization"
  950. ],
  951. "summary": "Update a hook",
  952. "operationId": "orgEditHook",
  953. "parameters": [
  954. {
  955. "type": "string",
  956. "description": "name of the organization",
  957. "name": "org",
  958. "in": "path",
  959. "required": true
  960. },
  961. {
  962. "type": "integer",
  963. "format": "int64",
  964. "description": "id of the hook to update",
  965. "name": "id",
  966. "in": "path",
  967. "required": true
  968. },
  969. {
  970. "name": "body",
  971. "in": "body",
  972. "schema": {
  973. "$ref": "#/definitions/EditHookOption"
  974. }
  975. }
  976. ],
  977. "responses": {
  978. "200": {
  979. "$ref": "#/responses/Hook"
  980. }
  981. }
  982. }
  983. },
  984. "/orgs/{org}/labels": {
  985. "get": {
  986. "produces": [
  987. "application/json"
  988. ],
  989. "tags": [
  990. "organization"
  991. ],
  992. "summary": "List an organization's labels",
  993. "operationId": "orgListLabels",
  994. "parameters": [
  995. {
  996. "type": "string",
  997. "description": "name of the organization",
  998. "name": "org",
  999. "in": "path",
  1000. "required": true
  1001. },
  1002. {
  1003. "type": "integer",
  1004. "description": "page number of results to return (1-based)",
  1005. "name": "page",
  1006. "in": "query"
  1007. },
  1008. {
  1009. "type": "integer",
  1010. "description": "page size of results, maximum page size is 50",
  1011. "name": "limit",
  1012. "in": "query"
  1013. }
  1014. ],
  1015. "responses": {
  1016. "200": {
  1017. "$ref": "#/responses/LabelList"
  1018. }
  1019. }
  1020. },
  1021. "post": {
  1022. "consumes": [
  1023. "application/json"
  1024. ],
  1025. "produces": [
  1026. "application/json"
  1027. ],
  1028. "tags": [
  1029. "organization"
  1030. ],
  1031. "summary": "Create a label for an organization",
  1032. "operationId": "orgCreateLabel",
  1033. "parameters": [
  1034. {
  1035. "type": "string",
  1036. "description": "name of the organization",
  1037. "name": "org",
  1038. "in": "path",
  1039. "required": true
  1040. },
  1041. {
  1042. "name": "body",
  1043. "in": "body",
  1044. "schema": {
  1045. "$ref": "#/definitions/CreateLabelOption"
  1046. }
  1047. }
  1048. ],
  1049. "responses": {
  1050. "201": {
  1051. "$ref": "#/responses/Label"
  1052. },
  1053. "422": {
  1054. "$ref": "#/responses/validationError"
  1055. }
  1056. }
  1057. }
  1058. },
  1059. "/orgs/{org}/labels/{id}": {
  1060. "get": {
  1061. "produces": [
  1062. "application/json"
  1063. ],
  1064. "tags": [
  1065. "organization"
  1066. ],
  1067. "summary": "Get a single label",
  1068. "operationId": "orgGetLabel",
  1069. "parameters": [
  1070. {
  1071. "type": "string",
  1072. "description": "name of the organization",
  1073. "name": "org",
  1074. "in": "path",
  1075. "required": true
  1076. },
  1077. {
  1078. "type": "integer",
  1079. "format": "int64",
  1080. "description": "id of the label to get",
  1081. "name": "id",
  1082. "in": "path",
  1083. "required": true
  1084. }
  1085. ],
  1086. "responses": {
  1087. "200": {
  1088. "$ref": "#/responses/Label"
  1089. }
  1090. }
  1091. },
  1092. "delete": {
  1093. "tags": [
  1094. "organization"
  1095. ],
  1096. "summary": "Delete a label",
  1097. "operationId": "orgDeleteLabel",
  1098. "parameters": [
  1099. {
  1100. "type": "string",
  1101. "description": "name of the organization",
  1102. "name": "org",
  1103. "in": "path",
  1104. "required": true
  1105. },
  1106. {
  1107. "type": "integer",
  1108. "format": "int64",
  1109. "description": "id of the label to delete",
  1110. "name": "id",
  1111. "in": "path",
  1112. "required": true
  1113. }
  1114. ],
  1115. "responses": {
  1116. "204": {
  1117. "$ref": "#/responses/empty"
  1118. }
  1119. }
  1120. },
  1121. "patch": {
  1122. "consumes": [
  1123. "application/json"
  1124. ],
  1125. "produces": [
  1126. "application/json"
  1127. ],
  1128. "tags": [
  1129. "organization"
  1130. ],
  1131. "summary": "Update a label",
  1132. "operationId": "orgEditLabel",
  1133. "parameters": [
  1134. {
  1135. "type": "string",
  1136. "description": "name of the organization",
  1137. "name": "org",
  1138. "in": "path",
  1139. "required": true
  1140. },
  1141. {
  1142. "type": "integer",
  1143. "format": "int64",
  1144. "description": "id of the label to edit",
  1145. "name": "id",
  1146. "in": "path",
  1147. "required": true
  1148. },
  1149. {
  1150. "name": "body",
  1151. "in": "body",
  1152. "schema": {
  1153. "$ref": "#/definitions/EditLabelOption"
  1154. }
  1155. }
  1156. ],
  1157. "responses": {
  1158. "200": {
  1159. "$ref": "#/responses/Label"
  1160. },
  1161. "422": {
  1162. "$ref": "#/responses/validationError"
  1163. }
  1164. }
  1165. }
  1166. },
  1167. "/orgs/{org}/members": {
  1168. "get": {
  1169. "produces": [
  1170. "application/json"
  1171. ],
  1172. "tags": [
  1173. "organization"
  1174. ],
  1175. "summary": "List an organization's members",
  1176. "operationId": "orgListMembers",
  1177. "parameters": [
  1178. {
  1179. "type": "string",
  1180. "description": "name of the organization",
  1181. "name": "org",
  1182. "in": "path",
  1183. "required": true
  1184. },
  1185. {
  1186. "type": "integer",
  1187. "description": "page number of results to return (1-based)",
  1188. "name": "page",
  1189. "in": "query"
  1190. },
  1191. {
  1192. "type": "integer",
  1193. "description": "page size of results, maximum page size is 50",
  1194. "name": "limit",
  1195. "in": "query"
  1196. }
  1197. ],
  1198. "responses": {
  1199. "200": {
  1200. "$ref": "#/responses/UserList"
  1201. }
  1202. }
  1203. }
  1204. },
  1205. "/orgs/{org}/members/{username}": {
  1206. "get": {
  1207. "tags": [
  1208. "organization"
  1209. ],
  1210. "summary": "Check if a user is a member of an organization",
  1211. "operationId": "orgIsMember",
  1212. "parameters": [
  1213. {
  1214. "type": "string",
  1215. "description": "name of the organization",
  1216. "name": "org",
  1217. "in": "path",
  1218. "required": true
  1219. },
  1220. {
  1221. "type": "string",
  1222. "description": "username of the user",
  1223. "name": "username",
  1224. "in": "path",
  1225. "required": true
  1226. }
  1227. ],
  1228. "responses": {
  1229. "204": {
  1230. "description": "user is a member"
  1231. },
  1232. "302": {
  1233. "description": "redirection to /orgs/{org}/public_members/{username}"
  1234. },
  1235. "404": {
  1236. "description": "user is not a member"
  1237. }
  1238. }
  1239. },
  1240. "delete": {
  1241. "produces": [
  1242. "application/json"
  1243. ],
  1244. "tags": [
  1245. "organization"
  1246. ],
  1247. "summary": "Remove a member from an organization",
  1248. "operationId": "orgDeleteMember",
  1249. "parameters": [
  1250. {
  1251. "type": "string",
  1252. "description": "name of the organization",
  1253. "name": "org",
  1254. "in": "path",
  1255. "required": true
  1256. },
  1257. {
  1258. "type": "string",
  1259. "description": "username of the user",
  1260. "name": "username",
  1261. "in": "path",
  1262. "required": true
  1263. }
  1264. ],
  1265. "responses": {
  1266. "204": {
  1267. "description": "member removed"
  1268. }
  1269. }
  1270. }
  1271. },
  1272. "/orgs/{org}/public_members": {
  1273. "get": {
  1274. "produces": [
  1275. "application/json"
  1276. ],
  1277. "tags": [
  1278. "organization"
  1279. ],
  1280. "summary": "List an organization's public members",
  1281. "operationId": "orgListPublicMembers",
  1282. "parameters": [
  1283. {
  1284. "type": "string",
  1285. "description": "name of the organization",
  1286. "name": "org",
  1287. "in": "path",
  1288. "required": true
  1289. },
  1290. {
  1291. "type": "integer",
  1292. "description": "page number of results to return (1-based)",
  1293. "name": "page",
  1294. "in": "query"
  1295. },
  1296. {
  1297. "type": "integer",
  1298. "description": "page size of results, maximum page size is 50",
  1299. "name": "limit",
  1300. "in": "query"
  1301. }
  1302. ],
  1303. "responses": {
  1304. "200": {
  1305. "$ref": "#/responses/UserList"
  1306. }
  1307. }
  1308. }
  1309. },
  1310. "/orgs/{org}/public_members/{username}": {
  1311. "get": {
  1312. "tags": [
  1313. "organization"
  1314. ],
  1315. "summary": "Check if a user is a public member of an organization",
  1316. "operationId": "orgIsPublicMember",
  1317. "parameters": [
  1318. {
  1319. "type": "string",
  1320. "description": "name of the organization",
  1321. "name": "org",
  1322. "in": "path",
  1323. "required": true
  1324. },
  1325. {
  1326. "type": "string",
  1327. "description": "username of the user",
  1328. "name": "username",
  1329. "in": "path",
  1330. "required": true
  1331. }
  1332. ],
  1333. "responses": {
  1334. "204": {
  1335. "description": "user is a public member"
  1336. },
  1337. "404": {
  1338. "description": "user is not a public member"
  1339. }
  1340. }
  1341. },
  1342. "put": {
  1343. "produces": [
  1344. "application/json"
  1345. ],
  1346. "tags": [
  1347. "organization"
  1348. ],
  1349. "summary": "Publicize a user's membership",
  1350. "operationId": "orgPublicizeMember",
  1351. "parameters": [
  1352. {
  1353. "type": "string",
  1354. "description": "name of the organization",
  1355. "name": "org",
  1356. "in": "path",
  1357. "required": true
  1358. },
  1359. {
  1360. "type": "string",
  1361. "description": "username of the user",
  1362. "name": "username",
  1363. "in": "path",
  1364. "required": true
  1365. }
  1366. ],
  1367. "responses": {
  1368. "204": {
  1369. "description": "membership publicized"
  1370. },
  1371. "403": {
  1372. "$ref": "#/responses/forbidden"
  1373. }
  1374. }
  1375. },
  1376. "delete": {
  1377. "produces": [
  1378. "application/json"
  1379. ],
  1380. "tags": [
  1381. "organization"
  1382. ],
  1383. "summary": "Conceal a user's membership",
  1384. "operationId": "orgConcealMember",
  1385. "parameters": [
  1386. {
  1387. "type": "string",
  1388. "description": "name of the organization",
  1389. "name": "org",
  1390. "in": "path",
  1391. "required": true
  1392. },
  1393. {
  1394. "type": "string",
  1395. "description": "username of the user",
  1396. "name": "username",
  1397. "in": "path",
  1398. "required": true
  1399. }
  1400. ],
  1401. "responses": {
  1402. "204": {
  1403. "$ref": "#/responses/empty"
  1404. },
  1405. "403": {
  1406. "$ref": "#/responses/forbidden"
  1407. }
  1408. }
  1409. }
  1410. },
  1411. "/orgs/{org}/repos": {
  1412. "get": {
  1413. "produces": [
  1414. "application/json"
  1415. ],
  1416. "tags": [
  1417. "organization"
  1418. ],
  1419. "summary": "List an organization's repos",
  1420. "operationId": "orgListRepos",
  1421. "parameters": [
  1422. {
  1423. "type": "string",
  1424. "description": "name of the organization",
  1425. "name": "org",
  1426. "in": "path",
  1427. "required": true
  1428. },
  1429. {
  1430. "type": "integer",
  1431. "description": "page number of results to return (1-based)",
  1432. "name": "page",
  1433. "in": "query"
  1434. },
  1435. {
  1436. "type": "integer",
  1437. "description": "page size of results, maximum page size is 50",
  1438. "name": "limit",
  1439. "in": "query"
  1440. }
  1441. ],
  1442. "responses": {
  1443. "200": {
  1444. "$ref": "#/responses/RepositoryList"
  1445. }
  1446. }
  1447. },
  1448. "post": {
  1449. "consumes": [
  1450. "application/json"
  1451. ],
  1452. "produces": [
  1453. "application/json"
  1454. ],
  1455. "tags": [
  1456. "organization"
  1457. ],
  1458. "summary": "Create a repository in an organization",
  1459. "operationId": "createOrgRepo",
  1460. "parameters": [
  1461. {
  1462. "type": "string",
  1463. "description": "name of organization",
  1464. "name": "org",
  1465. "in": "path",
  1466. "required": true
  1467. },
  1468. {
  1469. "name": "body",
  1470. "in": "body",
  1471. "schema": {
  1472. "$ref": "#/definitions/CreateRepoOption"
  1473. }
  1474. }
  1475. ],
  1476. "responses": {
  1477. "201": {
  1478. "$ref": "#/responses/Repository"
  1479. },
  1480. "403": {
  1481. "$ref": "#/responses/forbidden"
  1482. },
  1483. "404": {
  1484. "$ref": "#/responses/notFound"
  1485. }
  1486. }
  1487. }
  1488. },
  1489. "/orgs/{org}/teams": {
  1490. "get": {
  1491. "produces": [
  1492. "application/json"
  1493. ],
  1494. "tags": [
  1495. "organization"
  1496. ],
  1497. "summary": "List an organization's teams",
  1498. "operationId": "orgListTeams",
  1499. "parameters": [
  1500. {
  1501. "type": "string",
  1502. "description": "name of the organization",
  1503. "name": "org",
  1504. "in": "path",
  1505. "required": true
  1506. },
  1507. {
  1508. "type": "integer",
  1509. "description": "page number of results to return (1-based)",
  1510. "name": "page",
  1511. "in": "query"
  1512. },
  1513. {
  1514. "type": "integer",
  1515. "description": "page size of results, maximum page size is 50",
  1516. "name": "limit",
  1517. "in": "query"
  1518. }
  1519. ],
  1520. "responses": {
  1521. "200": {
  1522. "$ref": "#/responses/TeamList"
  1523. }
  1524. }
  1525. },
  1526. "post": {
  1527. "consumes": [
  1528. "application/json"
  1529. ],
  1530. "produces": [
  1531. "application/json"
  1532. ],
  1533. "tags": [
  1534. "organization"
  1535. ],
  1536. "summary": "Create a team",
  1537. "operationId": "orgCreateTeam",
  1538. "parameters": [
  1539. {
  1540. "type": "string",
  1541. "description": "name of the organization",
  1542. "name": "org",
  1543. "in": "path",
  1544. "required": true
  1545. },
  1546. {
  1547. "name": "body",
  1548. "in": "body",
  1549. "schema": {
  1550. "$ref": "#/definitions/CreateTeamOption"
  1551. }
  1552. }
  1553. ],
  1554. "responses": {
  1555. "201": {
  1556. "$ref": "#/responses/Team"
  1557. },
  1558. "422": {
  1559. "$ref": "#/responses/validationError"
  1560. }
  1561. }
  1562. }
  1563. },
  1564. "/orgs/{org}/teams/search": {
  1565. "get": {
  1566. "produces": [
  1567. "application/json"
  1568. ],
  1569. "tags": [
  1570. "organization"
  1571. ],
  1572. "summary": "Search for teams within an organization",
  1573. "operationId": "teamSearch",
  1574. "parameters": [
  1575. {
  1576. "type": "string",
  1577. "description": "name of the organization",
  1578. "name": "org",
  1579. "in": "path",
  1580. "required": true
  1581. },
  1582. {
  1583. "type": "string",
  1584. "description": "keywords to search",
  1585. "name": "q",
  1586. "in": "query"
  1587. },
  1588. {
  1589. "type": "boolean",
  1590. "description": "include search within team description (defaults to true)",
  1591. "name": "include_desc",
  1592. "in": "query"
  1593. },
  1594. {
  1595. "type": "integer",
  1596. "description": "page number of results to return (1-based)",
  1597. "name": "page",
  1598. "in": "query"
  1599. },
  1600. {
  1601. "type": "integer",
  1602. "description": "page size of results, maximum page size is 50",
  1603. "name": "limit",
  1604. "in": "query"
  1605. }
  1606. ],
  1607. "responses": {
  1608. "200": {
  1609. "description": "SearchResults of a successful search",
  1610. "schema": {
  1611. "type": "object",
  1612. "properties": {
  1613. "data": {
  1614. "type": "array",
  1615. "items": {
  1616. "$ref": "#/definitions/Team"
  1617. }
  1618. },
  1619. "ok": {
  1620. "type": "boolean"
  1621. }
  1622. }
  1623. }
  1624. }
  1625. }
  1626. }
  1627. },
  1628. "/repos/issues/search": {
  1629. "get": {
  1630. "produces": [
  1631. "application/json"
  1632. ],
  1633. "tags": [
  1634. "issue"
  1635. ],
  1636. "summary": "Search for issues across the repositories that the user has access to",
  1637. "operationId": "issueSearchIssues",
  1638. "parameters": [
  1639. {
  1640. "type": "string",
  1641. "description": "whether issue is open or closed",
  1642. "name": "state",
  1643. "in": "query"
  1644. },
  1645. {
  1646. "type": "string",
  1647. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1648. "name": "labels",
  1649. "in": "query"
  1650. },
  1651. {
  1652. "type": "string",
  1653. "description": "search string",
  1654. "name": "q",
  1655. "in": "query"
  1656. },
  1657. {
  1658. "type": "integer",
  1659. "format": "int64",
  1660. "description": "repository to prioritize in the results",
  1661. "name": "priority_repo_id",
  1662. "in": "query"
  1663. },
  1664. {
  1665. "type": "string",
  1666. "description": "filter by type (issues / pulls) if set",
  1667. "name": "type",
  1668. "in": "query"
  1669. },
  1670. {
  1671. "type": "integer",
  1672. "description": "page number of requested issues",
  1673. "name": "page",
  1674. "in": "query"
  1675. }
  1676. ],
  1677. "responses": {
  1678. "200": {
  1679. "$ref": "#/responses/IssueList"
  1680. }
  1681. }
  1682. }
  1683. },
  1684. "/repos/migrate": {
  1685. "post": {
  1686. "consumes": [
  1687. "application/json"
  1688. ],
  1689. "produces": [
  1690. "application/json"
  1691. ],
  1692. "tags": [
  1693. "repository"
  1694. ],
  1695. "summary": "Migrate a remote git repository",
  1696. "operationId": "repoMigrate",
  1697. "parameters": [
  1698. {
  1699. "name": "body",
  1700. "in": "body",
  1701. "schema": {
  1702. "$ref": "#/definitions/MigrateRepoForm"
  1703. }
  1704. }
  1705. ],
  1706. "responses": {
  1707. "201": {
  1708. "$ref": "#/responses/Repository"
  1709. },
  1710. "403": {
  1711. "$ref": "#/responses/forbidden"
  1712. },
  1713. "422": {
  1714. "$ref": "#/responses/validationError"
  1715. }
  1716. }
  1717. }
  1718. },
  1719. "/repos/search": {
  1720. "get": {
  1721. "produces": [
  1722. "application/json"
  1723. ],
  1724. "tags": [
  1725. "repository"
  1726. ],
  1727. "summary": "Search for repositories",
  1728. "operationId": "repoSearch",
  1729. "parameters": [
  1730. {
  1731. "type": "string",
  1732. "description": "keyword",
  1733. "name": "q",
  1734. "in": "query"
  1735. },
  1736. {
  1737. "type": "boolean",
  1738. "description": "Limit search to repositories with keyword as topic",
  1739. "name": "topic",
  1740. "in": "query"
  1741. },
  1742. {
  1743. "type": "boolean",
  1744. "description": "include search of keyword within repository description",
  1745. "name": "includeDesc",
  1746. "in": "query"
  1747. },
  1748. {
  1749. "type": "integer",
  1750. "format": "int64",
  1751. "description": "search only for repos that the user with the given id owns or contributes to",
  1752. "name": "uid",
  1753. "in": "query"
  1754. },
  1755. {
  1756. "type": "integer",
  1757. "format": "int64",
  1758. "description": "repo owner to prioritize in the results",
  1759. "name": "priority_owner_id",
  1760. "in": "query"
  1761. },
  1762. {
  1763. "type": "integer",
  1764. "format": "int64",
  1765. "description": "search only for repos that the user with the given id has starred",
  1766. "name": "starredBy",
  1767. "in": "query"
  1768. },
  1769. {
  1770. "type": "boolean",
  1771. "description": "include private repositories this user has access to (defaults to true)",
  1772. "name": "private",
  1773. "in": "query"
  1774. },
  1775. {
  1776. "type": "boolean",
  1777. "description": "include template repositories this user has access to (defaults to true)",
  1778. "name": "template",
  1779. "in": "query"
  1780. },
  1781. {
  1782. "type": "string",
  1783. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1784. "name": "mode",
  1785. "in": "query"
  1786. },
  1787. {
  1788. "type": "boolean",
  1789. "description": "if `uid` is given, search only for repos that the user owns",
  1790. "name": "exclusive",
  1791. "in": "query"
  1792. },
  1793. {
  1794. "type": "string",
  1795. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1796. "name": "sort",
  1797. "in": "query"
  1798. },
  1799. {
  1800. "type": "string",
  1801. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1802. "name": "order",
  1803. "in": "query"
  1804. },
  1805. {
  1806. "type": "integer",
  1807. "description": "page number of results to return (1-based)",
  1808. "name": "page",
  1809. "in": "query"
  1810. },
  1811. {
  1812. "type": "integer",
  1813. "description": "page size of results, maximum page size is 50",
  1814. "name": "limit",
  1815. "in": "query"
  1816. }
  1817. ],
  1818. "responses": {
  1819. "200": {
  1820. "$ref": "#/responses/SearchResults"
  1821. },
  1822. "422": {
  1823. "$ref": "#/responses/validationError"
  1824. }
  1825. }
  1826. }
  1827. },
  1828. "/repos/{owner}/{repo}": {
  1829. "get": {
  1830. "produces": [
  1831. "application/json"
  1832. ],
  1833. "tags": [
  1834. "repository"
  1835. ],
  1836. "summary": "Get a repository",
  1837. "operationId": "repoGet",
  1838. "parameters": [
  1839. {
  1840. "type": "string",
  1841. "description": "owner of the repo",
  1842. "name": "owner",
  1843. "in": "path",
  1844. "required": true
  1845. },
  1846. {
  1847. "type": "string",
  1848. "description": "name of the repo",
  1849. "name": "repo",
  1850. "in": "path",
  1851. "required": true
  1852. }
  1853. ],
  1854. "responses": {
  1855. "200": {
  1856. "$ref": "#/responses/Repository"
  1857. }
  1858. }
  1859. },
  1860. "delete": {
  1861. "produces": [
  1862. "application/json"
  1863. ],
  1864. "tags": [
  1865. "repository"
  1866. ],
  1867. "summary": "Delete a repository",
  1868. "operationId": "repoDelete",
  1869. "parameters": [
  1870. {
  1871. "type": "string",
  1872. "description": "owner of the repo to delete",
  1873. "name": "owner",
  1874. "in": "path",
  1875. "required": true
  1876. },
  1877. {
  1878. "type": "string",
  1879. "description": "name of the repo to delete",
  1880. "name": "repo",
  1881. "in": "path",
  1882. "required": true
  1883. }
  1884. ],
  1885. "responses": {
  1886. "204": {
  1887. "$ref": "#/responses/empty"
  1888. },
  1889. "403": {
  1890. "$ref": "#/responses/forbidden"
  1891. }
  1892. }
  1893. },
  1894. "patch": {
  1895. "produces": [
  1896. "application/json"
  1897. ],
  1898. "tags": [
  1899. "repository"
  1900. ],
  1901. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1902. "operationId": "repoEdit",
  1903. "parameters": [
  1904. {
  1905. "type": "string",
  1906. "description": "owner of the repo to edit",
  1907. "name": "owner",
  1908. "in": "path",
  1909. "required": true
  1910. },
  1911. {
  1912. "type": "string",
  1913. "description": "name of the repo to edit",
  1914. "name": "repo",
  1915. "in": "path",
  1916. "required": true
  1917. },
  1918. {
  1919. "description": "Properties of a repo that you can edit",
  1920. "name": "body",
  1921. "in": "body",
  1922. "schema": {
  1923. "$ref": "#/definitions/EditRepoOption"
  1924. }
  1925. }
  1926. ],
  1927. "responses": {
  1928. "200": {
  1929. "$ref": "#/responses/Repository"
  1930. },
  1931. "403": {
  1932. "$ref": "#/responses/forbidden"
  1933. },
  1934. "422": {
  1935. "$ref": "#/responses/validationError"
  1936. }
  1937. }
  1938. }
  1939. },
  1940. "/repos/{owner}/{repo}/archive/{archive}": {
  1941. "get": {
  1942. "produces": [
  1943. "application/json"
  1944. ],
  1945. "tags": [
  1946. "repository"
  1947. ],
  1948. "summary": "Get an archive of a repository",
  1949. "operationId": "repoGetArchive",
  1950. "parameters": [
  1951. {
  1952. "type": "string",
  1953. "description": "owner of the repo",
  1954. "name": "owner",
  1955. "in": "path",
  1956. "required": true
  1957. },
  1958. {
  1959. "type": "string",
  1960. "description": "name of the repo",
  1961. "name": "repo",
  1962. "in": "path",
  1963. "required": true
  1964. },
  1965. {
  1966. "type": "string",
  1967. "description": "archive to download, consisting of a git reference and archive",
  1968. "name": "archive",
  1969. "in": "path",
  1970. "required": true
  1971. }
  1972. ],
  1973. "responses": {
  1974. "200": {
  1975. "description": "success"
  1976. },
  1977. "404": {
  1978. "$ref": "#/responses/notFound"
  1979. }
  1980. }
  1981. }
  1982. },
  1983. "/repos/{owner}/{repo}/branch_protections": {
  1984. "get": {
  1985. "produces": [
  1986. "application/json"
  1987. ],
  1988. "tags": [
  1989. "repository"
  1990. ],
  1991. "summary": "List branch protections for a repository",
  1992. "operationId": "repoListBranchProtection",
  1993. "parameters": [
  1994. {
  1995. "type": "string",
  1996. "description": "owner of the repo",
  1997. "name": "owner",
  1998. "in": "path",
  1999. "required": true
  2000. },
  2001. {
  2002. "type": "string",
  2003. "description": "name of the repo",
  2004. "name": "repo",
  2005. "in": "path",
  2006. "required": true
  2007. }
  2008. ],
  2009. "responses": {
  2010. "200": {
  2011. "$ref": "#/responses/BranchProtectionList"
  2012. }
  2013. }
  2014. },
  2015. "post": {
  2016. "consumes": [
  2017. "application/json"
  2018. ],
  2019. "produces": [
  2020. "application/json"
  2021. ],
  2022. "tags": [
  2023. "repository"
  2024. ],
  2025. "summary": "Create a branch protections for a repository",
  2026. "operationId": "repoCreateBranchProtection",
  2027. "parameters": [
  2028. {
  2029. "type": "string",
  2030. "description": "owner of the repo",
  2031. "name": "owner",
  2032. "in": "path",
  2033. "required": true
  2034. },
  2035. {
  2036. "type": "string",
  2037. "description": "name of the repo",
  2038. "name": "repo",
  2039. "in": "path",
  2040. "required": true
  2041. },
  2042. {
  2043. "name": "body",
  2044. "in": "body",
  2045. "schema": {
  2046. "$ref": "#/definitions/CreateBranchProtectionOption"
  2047. }
  2048. }
  2049. ],
  2050. "responses": {
  2051. "201": {
  2052. "$ref": "#/responses/BranchProtection"
  2053. },
  2054. "403": {
  2055. "$ref": "#/responses/forbidden"
  2056. },
  2057. "404": {
  2058. "$ref": "#/responses/notFound"
  2059. },
  2060. "422": {
  2061. "$ref": "#/responses/validationError"
  2062. }
  2063. }
  2064. }
  2065. },
  2066. "/repos/{owner}/{repo}/branch_protections/{name}": {
  2067. "get": {
  2068. "produces": [
  2069. "application/json"
  2070. ],
  2071. "tags": [
  2072. "repository"
  2073. ],
  2074. "summary": "Get a specific branch protection for the repository",
  2075. "operationId": "repoGetBranchProtection",
  2076. "parameters": [
  2077. {
  2078. "type": "string",
  2079. "description": "owner of the repo",
  2080. "name": "owner",
  2081. "in": "path",
  2082. "required": true
  2083. },
  2084. {
  2085. "type": "string",
  2086. "description": "name of the repo",
  2087. "name": "repo",
  2088. "in": "path",
  2089. "required": true
  2090. },
  2091. {
  2092. "type": "string",
  2093. "description": "name of protected branch",
  2094. "name": "name",
  2095. "in": "path",
  2096. "required": true
  2097. }
  2098. ],
  2099. "responses": {
  2100. "200": {
  2101. "$ref": "#/responses/BranchProtection"
  2102. },
  2103. "404": {
  2104. "$ref": "#/responses/notFound"
  2105. }
  2106. }
  2107. },
  2108. "delete": {
  2109. "produces": [
  2110. "application/json"
  2111. ],
  2112. "tags": [
  2113. "repository"
  2114. ],
  2115. "summary": "Delete a specific branch protection for the repository",
  2116. "operationId": "repoDeleteBranchProtection",
  2117. "parameters": [
  2118. {
  2119. "type": "string",
  2120. "description": "owner of the repo",
  2121. "name": "owner",
  2122. "in": "path",
  2123. "required": true
  2124. },
  2125. {
  2126. "type": "string",
  2127. "description": "name of the repo",
  2128. "name": "repo",
  2129. "in": "path",
  2130. "required": true
  2131. },
  2132. {
  2133. "type": "string",
  2134. "description": "name of protected branch",
  2135. "name": "name",
  2136. "in": "path",
  2137. "required": true
  2138. }
  2139. ],
  2140. "responses": {
  2141. "204": {
  2142. "$ref": "#/responses/empty"
  2143. },
  2144. "404": {
  2145. "$ref": "#/responses/notFound"
  2146. }
  2147. }
  2148. },
  2149. "patch": {
  2150. "consumes": [
  2151. "application/json"
  2152. ],
  2153. "produces": [
  2154. "application/json"
  2155. ],
  2156. "tags": [
  2157. "repository"
  2158. ],
  2159. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  2160. "operationId": "repoEditBranchProtection",
  2161. "parameters": [
  2162. {
  2163. "type": "string",
  2164. "description": "owner of the repo",
  2165. "name": "owner",
  2166. "in": "path",
  2167. "required": true
  2168. },
  2169. {
  2170. "type": "string",
  2171. "description": "name of the repo",
  2172. "name": "repo",
  2173. "in": "path",
  2174. "required": true
  2175. },
  2176. {
  2177. "type": "string",
  2178. "description": "name of protected branch",
  2179. "name": "name",
  2180. "in": "path",
  2181. "required": true
  2182. },
  2183. {
  2184. "name": "body",
  2185. "in": "body",
  2186. "schema": {
  2187. "$ref": "#/definitions/EditBranchProtectionOption"
  2188. }
  2189. }
  2190. ],
  2191. "responses": {
  2192. "200": {
  2193. "$ref": "#/responses/BranchProtection"
  2194. },
  2195. "404": {
  2196. "$ref": "#/responses/notFound"
  2197. },
  2198. "422": {
  2199. "$ref": "#/responses/validationError"
  2200. }
  2201. }
  2202. }
  2203. },
  2204. "/repos/{owner}/{repo}/branches": {
  2205. "get": {
  2206. "produces": [
  2207. "application/json"
  2208. ],
  2209. "tags": [
  2210. "repository"
  2211. ],
  2212. "summary": "List a repository's branches",
  2213. "operationId": "repoListBranches",
  2214. "parameters": [
  2215. {
  2216. "type": "string",
  2217. "description": "owner of the repo",
  2218. "name": "owner",
  2219. "in": "path",
  2220. "required": true
  2221. },
  2222. {
  2223. "type": "string",
  2224. "description": "name of the repo",
  2225. "name": "repo",
  2226. "in": "path",
  2227. "required": true
  2228. }
  2229. ],
  2230. "responses": {
  2231. "200": {
  2232. "$ref": "#/responses/BranchList"
  2233. }
  2234. }
  2235. }
  2236. },
  2237. "/repos/{owner}/{repo}/branches/{branch}": {
  2238. "get": {
  2239. "produces": [
  2240. "application/json"
  2241. ],
  2242. "tags": [
  2243. "repository"
  2244. ],
  2245. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  2246. "operationId": "repoGetBranch",
  2247. "parameters": [
  2248. {
  2249. "type": "string",
  2250. "description": "owner of the repo",
  2251. "name": "owner",
  2252. "in": "path",
  2253. "required": true
  2254. },
  2255. {
  2256. "type": "string",
  2257. "description": "name of the repo",
  2258. "name": "repo",
  2259. "in": "path",
  2260. "required": true
  2261. },
  2262. {
  2263. "type": "string",
  2264. "description": "branch to get",
  2265. "name": "branch",
  2266. "in": "path",
  2267. "required": true
  2268. }
  2269. ],
  2270. "responses": {
  2271. "200": {
  2272. "$ref": "#/responses/Branch"
  2273. }
  2274. }
  2275. }
  2276. },
  2277. "/repos/{owner}/{repo}/collaborators": {
  2278. "get": {
  2279. "produces": [
  2280. "application/json"
  2281. ],
  2282. "tags": [
  2283. "repository"
  2284. ],
  2285. "summary": "List a repository's collaborators",
  2286. "operationId": "repoListCollaborators",
  2287. "parameters": [
  2288. {
  2289. "type": "string",
  2290. "description": "owner of the repo",
  2291. "name": "owner",
  2292. "in": "path",
  2293. "required": true
  2294. },
  2295. {
  2296. "type": "string",
  2297. "description": "name of the repo",
  2298. "name": "repo",
  2299. "in": "path",
  2300. "required": true
  2301. },
  2302. {
  2303. "type": "integer",
  2304. "description": "page number of results to return (1-based)",
  2305. "name": "page",
  2306. "in": "query"
  2307. },
  2308. {
  2309. "type": "integer",
  2310. "description": "page size of results, maximum page size is 50",
  2311. "name": "limit",
  2312. "in": "query"
  2313. }
  2314. ],
  2315. "responses": {
  2316. "200": {
  2317. "$ref": "#/responses/UserList"
  2318. }
  2319. }
  2320. }
  2321. },
  2322. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  2323. "get": {
  2324. "produces": [
  2325. "application/json"
  2326. ],
  2327. "tags": [
  2328. "repository"
  2329. ],
  2330. "summary": "Check if a user is a collaborator of a repository",
  2331. "operationId": "repoCheckCollaborator",
  2332. "parameters": [
  2333. {
  2334. "type": "string",
  2335. "description": "owner of the repo",
  2336. "name": "owner",
  2337. "in": "path",
  2338. "required": true
  2339. },
  2340. {
  2341. "type": "string",
  2342. "description": "name of the repo",
  2343. "name": "repo",
  2344. "in": "path",
  2345. "required": true
  2346. },
  2347. {
  2348. "type": "string",
  2349. "description": "username of the collaborator",
  2350. "name": "collaborator",
  2351. "in": "path",
  2352. "required": true
  2353. }
  2354. ],
  2355. "responses": {
  2356. "204": {
  2357. "$ref": "#/responses/empty"
  2358. },
  2359. "404": {
  2360. "$ref": "#/responses/notFound"
  2361. },
  2362. "422": {
  2363. "$ref": "#/responses/validationError"
  2364. }
  2365. }
  2366. },
  2367. "put": {
  2368. "produces": [
  2369. "application/json"
  2370. ],
  2371. "tags": [
  2372. "repository"
  2373. ],
  2374. "summary": "Add a collaborator to a repository",
  2375. "operationId": "repoAddCollaborator",
  2376. "parameters": [
  2377. {
  2378. "type": "string",
  2379. "description": "owner of the repo",
  2380. "name": "owner",
  2381. "in": "path",
  2382. "required": true
  2383. },
  2384. {
  2385. "type": "string",
  2386. "description": "name of the repo",
  2387. "name": "repo",
  2388. "in": "path",
  2389. "required": true
  2390. },
  2391. {
  2392. "type": "string",
  2393. "description": "username of the collaborator to add",
  2394. "name": "collaborator",
  2395. "in": "path",
  2396. "required": true
  2397. },
  2398. {
  2399. "name": "body",
  2400. "in": "body",
  2401. "schema": {
  2402. "$ref": "#/definitions/AddCollaboratorOption"
  2403. }
  2404. }
  2405. ],
  2406. "responses": {
  2407. "204": {
  2408. "$ref": "#/responses/empty"
  2409. },
  2410. "422": {
  2411. "$ref": "#/responses/validationError"
  2412. }
  2413. }
  2414. },
  2415. "delete": {
  2416. "produces": [
  2417. "application/json"
  2418. ],
  2419. "tags": [
  2420. "repository"
  2421. ],
  2422. "summary": "Delete a collaborator from a repository",
  2423. "operationId": "repoDeleteCollaborator",
  2424. "parameters": [
  2425. {
  2426. "type": "string",
  2427. "description": "owner of the repo",
  2428. "name": "owner",
  2429. "in": "path",
  2430. "required": true
  2431. },
  2432. {
  2433. "type": "string",
  2434. "description": "name of the repo",
  2435. "name": "repo",
  2436. "in": "path",
  2437. "required": true
  2438. },
  2439. {
  2440. "type": "string",
  2441. "description": "username of the collaborator to delete",
  2442. "name": "collaborator",
  2443. "in": "path",
  2444. "required": true
  2445. }
  2446. ],
  2447. "responses": {
  2448. "204": {
  2449. "$ref": "#/responses/empty"
  2450. },
  2451. "422": {
  2452. "$ref": "#/responses/validationError"
  2453. }
  2454. }
  2455. }
  2456. },
  2457. "/repos/{owner}/{repo}/commits": {
  2458. "get": {
  2459. "produces": [
  2460. "application/json"
  2461. ],
  2462. "tags": [
  2463. "repository"
  2464. ],
  2465. "summary": "Get a list of all commits from a repository",
  2466. "operationId": "repoGetAllCommits",
  2467. "parameters": [
  2468. {
  2469. "type": "string",
  2470. "description": "owner of the repo",
  2471. "name": "owner",
  2472. "in": "path",
  2473. "required": true
  2474. },
  2475. {
  2476. "type": "string",
  2477. "description": "name of the repo",
  2478. "name": "repo",
  2479. "in": "path",
  2480. "required": true
  2481. },
  2482. {
  2483. "type": "string",
  2484. "description": "SHA or branch to start listing commits from (usually 'master')",
  2485. "name": "sha",
  2486. "in": "query"
  2487. },
  2488. {
  2489. "type": "integer",
  2490. "description": "page number of results to return (1-based)",
  2491. "name": "page",
  2492. "in": "query"
  2493. },
  2494. {
  2495. "type": "integer",
  2496. "description": "page size of results, maximum page size is 50",
  2497. "name": "limit",
  2498. "in": "query"
  2499. }
  2500. ],
  2501. "responses": {
  2502. "200": {
  2503. "$ref": "#/responses/CommitList"
  2504. },
  2505. "404": {
  2506. "$ref": "#/responses/notFound"
  2507. },
  2508. "409": {
  2509. "$ref": "#/responses/EmptyRepository"
  2510. }
  2511. }
  2512. }
  2513. },
  2514. "/repos/{owner}/{repo}/commits/{ref}": {
  2515. "get": {
  2516. "produces": [
  2517. "application/json"
  2518. ],
  2519. "tags": [
  2520. "repository"
  2521. ],
  2522. "summary": "Get a single commit from a repository",
  2523. "operationId": "repoGetSingleCommitByRef",
  2524. "parameters": [
  2525. {
  2526. "type": "string",
  2527. "description": "owner of the repo",
  2528. "name": "owner",
  2529. "in": "path",
  2530. "required": true
  2531. },
  2532. {
  2533. "type": "string",
  2534. "description": "name of the repo",
  2535. "name": "repo",
  2536. "in": "path",
  2537. "required": true
  2538. },
  2539. {
  2540. "type": "string",
  2541. "description": "a git ref",
  2542. "name": "ref",
  2543. "in": "path",
  2544. "required": true
  2545. }
  2546. ],
  2547. "responses": {
  2548. "200": {
  2549. "$ref": "#/responses/Commit"
  2550. },
  2551. "404": {
  2552. "$ref": "#/responses/notFound"
  2553. },
  2554. "422": {
  2555. "$ref": "#/responses/validationError"
  2556. }
  2557. }
  2558. }
  2559. },
  2560. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2561. "get": {
  2562. "produces": [
  2563. "application/json"
  2564. ],
  2565. "tags": [
  2566. "repository"
  2567. ],
  2568. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2569. "operationId": "repoGetCombinedStatusByRef",
  2570. "parameters": [
  2571. {
  2572. "type": "string",
  2573. "description": "owner of the repo",
  2574. "name": "owner",
  2575. "in": "path",
  2576. "required": true
  2577. },
  2578. {
  2579. "type": "string",
  2580. "description": "name of the repo",
  2581. "name": "repo",
  2582. "in": "path",
  2583. "required": true
  2584. },
  2585. {
  2586. "type": "string",
  2587. "description": "name of branch/tag/commit",
  2588. "name": "ref",
  2589. "in": "path",
  2590. "required": true
  2591. },
  2592. {
  2593. "type": "integer",
  2594. "description": "page number of results",
  2595. "name": "page",
  2596. "in": "query"
  2597. }
  2598. ],
  2599. "responses": {
  2600. "200": {
  2601. "$ref": "#/responses/Status"
  2602. },
  2603. "400": {
  2604. "$ref": "#/responses/error"
  2605. }
  2606. }
  2607. }
  2608. },
  2609. "/repos/{owner}/{repo}/contents": {
  2610. "get": {
  2611. "produces": [
  2612. "application/json"
  2613. ],
  2614. "tags": [
  2615. "repository"
  2616. ],
  2617. "summary": "Gets the metadata of all the entries of the root dir",
  2618. "operationId": "repoGetContentsList",
  2619. "parameters": [
  2620. {
  2621. "type": "string",
  2622. "description": "owner of the repo",
  2623. "name": "owner",
  2624. "in": "path",
  2625. "required": true
  2626. },
  2627. {
  2628. "type": "string",
  2629. "description": "name of the repo",
  2630. "name": "repo",
  2631. "in": "path",
  2632. "required": true
  2633. },
  2634. {
  2635. "type": "string",
  2636. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2637. "name": "ref",
  2638. "in": "query"
  2639. }
  2640. ],
  2641. "responses": {
  2642. "200": {
  2643. "$ref": "#/responses/ContentsListResponse"
  2644. }
  2645. }
  2646. }
  2647. },
  2648. "/repos/{owner}/{repo}/contents/{filepath}": {
  2649. "get": {
  2650. "produces": [
  2651. "application/json"
  2652. ],
  2653. "tags": [
  2654. "repository"
  2655. ],
  2656. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2657. "operationId": "repoGetContents",
  2658. "parameters": [
  2659. {
  2660. "type": "string",
  2661. "description": "owner of the repo",
  2662. "name": "owner",
  2663. "in": "path",
  2664. "required": true
  2665. },
  2666. {
  2667. "type": "string",
  2668. "description": "name of the repo",
  2669. "name": "repo",
  2670. "in": "path",
  2671. "required": true
  2672. },
  2673. {
  2674. "type": "string",
  2675. "description": "path of the dir, file, symlink or submodule in the repo",
  2676. "name": "filepath",
  2677. "in": "path",
  2678. "required": true
  2679. },
  2680. {
  2681. "type": "string",
  2682. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2683. "name": "ref",
  2684. "in": "query"
  2685. }
  2686. ],
  2687. "responses": {
  2688. "200": {
  2689. "$ref": "#/responses/ContentsResponse"
  2690. }
  2691. }
  2692. },
  2693. "put": {
  2694. "consumes": [
  2695. "application/json"
  2696. ],
  2697. "produces": [
  2698. "application/json"
  2699. ],
  2700. "tags": [
  2701. "repository"
  2702. ],
  2703. "summary": "Update a file in a repository",
  2704. "operationId": "repoUpdateFile",
  2705. "parameters": [
  2706. {
  2707. "type": "string",
  2708. "description": "owner of the repo",
  2709. "name": "owner",
  2710. "in": "path",
  2711. "required": true
  2712. },
  2713. {
  2714. "type": "string",
  2715. "description": "name of the repo",
  2716. "name": "repo",
  2717. "in": "path",
  2718. "required": true
  2719. },
  2720. {
  2721. "type": "string",
  2722. "description": "path of the file to update",
  2723. "name": "filepath",
  2724. "in": "path",
  2725. "required": true
  2726. },
  2727. {
  2728. "name": "body",
  2729. "in": "body",
  2730. "required": true,
  2731. "schema": {
  2732. "$ref": "#/definitions/UpdateFileOptions"
  2733. }
  2734. }
  2735. ],
  2736. "responses": {
  2737. "200": {
  2738. "$ref": "#/responses/FileResponse"
  2739. }
  2740. }
  2741. },
  2742. "post": {
  2743. "consumes": [
  2744. "application/json"
  2745. ],
  2746. "produces": [
  2747. "application/json"
  2748. ],
  2749. "tags": [
  2750. "repository"
  2751. ],
  2752. "summary": "Create a file in a repository",
  2753. "operationId": "repoCreateFile",
  2754. "parameters": [
  2755. {
  2756. "type": "string",
  2757. "description": "owner of the repo",
  2758. "name": "owner",
  2759. "in": "path",
  2760. "required": true
  2761. },
  2762. {
  2763. "type": "string",
  2764. "description": "name of the repo",
  2765. "name": "repo",
  2766. "in": "path",
  2767. "required": true
  2768. },
  2769. {
  2770. "type": "string",
  2771. "description": "path of the file to create",
  2772. "name": "filepath",
  2773. "in": "path",
  2774. "required": true
  2775. },
  2776. {
  2777. "name": "body",
  2778. "in": "body",
  2779. "required": true,
  2780. "schema": {
  2781. "$ref": "#/definitions/CreateFileOptions"
  2782. }
  2783. }
  2784. ],
  2785. "responses": {
  2786. "201": {
  2787. "$ref": "#/responses/FileResponse"
  2788. }
  2789. }
  2790. },
  2791. "delete": {
  2792. "consumes": [
  2793. "application/json"
  2794. ],
  2795. "produces": [
  2796. "application/json"
  2797. ],
  2798. "tags": [
  2799. "repository"
  2800. ],
  2801. "summary": "Delete a file in a repository",
  2802. "operationId": "repoDeleteFile",
  2803. "parameters": [
  2804. {
  2805. "type": "string",
  2806. "description": "owner of the repo",
  2807. "name": "owner",
  2808. "in": "path",
  2809. "required": true
  2810. },
  2811. {
  2812. "type": "string",
  2813. "description": "name of the repo",
  2814. "name": "repo",
  2815. "in": "path",
  2816. "required": true
  2817. },
  2818. {
  2819. "type": "string",
  2820. "description": "path of the file to delete",
  2821. "name": "filepath",
  2822. "in": "path",
  2823. "required": true
  2824. },
  2825. {
  2826. "name": "body",
  2827. "in": "body",
  2828. "required": true,
  2829. "schema": {
  2830. "$ref": "#/definitions/DeleteFileOptions"
  2831. }
  2832. }
  2833. ],
  2834. "responses": {
  2835. "200": {
  2836. "$ref": "#/responses/FileDeleteResponse"
  2837. }
  2838. }
  2839. }
  2840. },
  2841. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2842. "get": {
  2843. "produces": [
  2844. "application/json"
  2845. ],
  2846. "tags": [
  2847. "repository"
  2848. ],
  2849. "summary": "Get the EditorConfig definitions of a file in a repository",
  2850. "operationId": "repoGetEditorConfig",
  2851. "parameters": [
  2852. {
  2853. "type": "string",
  2854. "description": "owner of the repo",
  2855. "name": "owner",
  2856. "in": "path",
  2857. "required": true
  2858. },
  2859. {
  2860. "type": "string",
  2861. "description": "name of the repo",
  2862. "name": "repo",
  2863. "in": "path",
  2864. "required": true
  2865. },
  2866. {
  2867. "type": "string",
  2868. "description": "filepath of file to get",
  2869. "name": "filepath",
  2870. "in": "path",
  2871. "required": true
  2872. }
  2873. ],
  2874. "responses": {
  2875. "200": {
  2876. "description": "success"
  2877. },
  2878. "404": {
  2879. "$ref": "#/responses/notFound"
  2880. }
  2881. }
  2882. }
  2883. },
  2884. "/repos/{owner}/{repo}/forks": {
  2885. "get": {
  2886. "produces": [
  2887. "application/json"
  2888. ],
  2889. "tags": [
  2890. "repository"
  2891. ],
  2892. "summary": "List a repository's forks",
  2893. "operationId": "listForks",
  2894. "parameters": [
  2895. {
  2896. "type": "string",
  2897. "description": "owner of the repo",
  2898. "name": "owner",
  2899. "in": "path",
  2900. "required": true
  2901. },
  2902. {
  2903. "type": "string",
  2904. "description": "name of the repo",
  2905. "name": "repo",
  2906. "in": "path",
  2907. "required": true
  2908. },
  2909. {
  2910. "type": "integer",
  2911. "description": "page number of results to return (1-based)",
  2912. "name": "page",
  2913. "in": "query"
  2914. },
  2915. {
  2916. "type": "integer",
  2917. "description": "page size of results, maximum page size is 50",
  2918. "name": "limit",
  2919. "in": "query"
  2920. }
  2921. ],
  2922. "responses": {
  2923. "200": {
  2924. "$ref": "#/responses/RepositoryList"
  2925. }
  2926. }
  2927. },
  2928. "post": {
  2929. "produces": [
  2930. "application/json"
  2931. ],
  2932. "tags": [
  2933. "repository"
  2934. ],
  2935. "summary": "Fork a repository",
  2936. "operationId": "createFork",
  2937. "parameters": [
  2938. {
  2939. "type": "string",
  2940. "description": "owner of the repo to fork",
  2941. "name": "owner",
  2942. "in": "path",
  2943. "required": true
  2944. },
  2945. {
  2946. "type": "string",
  2947. "description": "name of the repo to fork",
  2948. "name": "repo",
  2949. "in": "path",
  2950. "required": true
  2951. },
  2952. {
  2953. "name": "body",
  2954. "in": "body",
  2955. "schema": {
  2956. "$ref": "#/definitions/CreateForkOption"
  2957. }
  2958. }
  2959. ],
  2960. "responses": {
  2961. "202": {
  2962. "$ref": "#/responses/Repository"
  2963. },
  2964. "403": {
  2965. "$ref": "#/responses/forbidden"
  2966. },
  2967. "422": {
  2968. "$ref": "#/responses/validationError"
  2969. }
  2970. }
  2971. }
  2972. },
  2973. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  2974. "get": {
  2975. "produces": [
  2976. "application/json"
  2977. ],
  2978. "tags": [
  2979. "repository"
  2980. ],
  2981. "summary": "Gets the blob of a repository.",
  2982. "operationId": "GetBlob",
  2983. "parameters": [
  2984. {
  2985. "type": "string",
  2986. "description": "owner of the repo",
  2987. "name": "owner",
  2988. "in": "path",
  2989. "required": true
  2990. },
  2991. {
  2992. "type": "string",
  2993. "description": "name of the repo",
  2994. "name": "repo",
  2995. "in": "path",
  2996. "required": true
  2997. },
  2998. {
  2999. "type": "string",
  3000. "description": "sha of the commit",
  3001. "name": "sha",
  3002. "in": "path",
  3003. "required": true
  3004. }
  3005. ],
  3006. "responses": {
  3007. "200": {
  3008. "$ref": "#/responses/GitBlobResponse"
  3009. },
  3010. "400": {
  3011. "$ref": "#/responses/error"
  3012. }
  3013. }
  3014. }
  3015. },
  3016. "/repos/{owner}/{repo}/git/commits/{sha}": {
  3017. "get": {
  3018. "produces": [
  3019. "application/json"
  3020. ],
  3021. "tags": [
  3022. "repository"
  3023. ],
  3024. "summary": "Get a single commit from a repository",
  3025. "operationId": "repoGetSingleCommitBySHA",
  3026. "parameters": [
  3027. {
  3028. "type": "string",
  3029. "description": "owner of the repo",
  3030. "name": "owner",
  3031. "in": "path",
  3032. "required": true
  3033. },
  3034. {
  3035. "type": "string",
  3036. "description": "name of the repo",
  3037. "name": "repo",
  3038. "in": "path",
  3039. "required": true
  3040. },
  3041. {
  3042. "type": "string",
  3043. "description": "the commit hash",
  3044. "name": "sha",
  3045. "in": "path",
  3046. "required": true
  3047. }
  3048. ],
  3049. "responses": {
  3050. "200": {
  3051. "$ref": "#/responses/Commit"
  3052. },
  3053. "404": {
  3054. "$ref": "#/responses/notFound"
  3055. },
  3056. "422": {
  3057. "$ref": "#/responses/validationError"
  3058. }
  3059. }
  3060. }
  3061. },
  3062. "/repos/{owner}/{repo}/git/refs": {
  3063. "get": {
  3064. "produces": [
  3065. "application/json"
  3066. ],
  3067. "tags": [
  3068. "repository"
  3069. ],
  3070. "summary": "Get specified ref or filtered repository's refs",
  3071. "operationId": "repoListAllGitRefs",
  3072. "parameters": [
  3073. {
  3074. "type": "string",
  3075. "description": "owner of the repo",
  3076. "name": "owner",
  3077. "in": "path",
  3078. "required": true
  3079. },
  3080. {
  3081. "type": "string",
  3082. "description": "name of the repo",
  3083. "name": "repo",
  3084. "in": "path",
  3085. "required": true
  3086. }
  3087. ],
  3088. "responses": {
  3089. "200": {
  3090. "$ref": "#/responses/ReferenceList"
  3091. },
  3092. "404": {
  3093. "$ref": "#/responses/notFound"
  3094. }
  3095. }
  3096. }
  3097. },
  3098. "/repos/{owner}/{repo}/git/refs/{ref}": {
  3099. "get": {
  3100. "produces": [
  3101. "application/json"
  3102. ],
  3103. "tags": [
  3104. "repository"
  3105. ],
  3106. "summary": "Get specified ref or filtered repository's refs",
  3107. "operationId": "repoListGitRefs",
  3108. "parameters": [
  3109. {
  3110. "type": "string",
  3111. "description": "owner of the repo",
  3112. "name": "owner",
  3113. "in": "path",
  3114. "required": true
  3115. },
  3116. {
  3117. "type": "string",
  3118. "description": "name of the repo",
  3119. "name": "repo",
  3120. "in": "path",
  3121. "required": true
  3122. },
  3123. {
  3124. "type": "string",
  3125. "description": "part or full name of the ref",
  3126. "name": "ref",
  3127. "in": "path",
  3128. "required": true
  3129. }
  3130. ],
  3131. "responses": {
  3132. "200": {
  3133. "$ref": "#/responses/ReferenceList"
  3134. },
  3135. "404": {
  3136. "$ref": "#/responses/notFound"
  3137. }
  3138. }
  3139. }
  3140. },
  3141. "/repos/{owner}/{repo}/git/tags/{sha}": {
  3142. "get": {
  3143. "produces": [
  3144. "application/json"
  3145. ],
  3146. "tags": [
  3147. "repository"
  3148. ],
  3149. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  3150. "operationId": "GetTag",
  3151. "parameters": [
  3152. {
  3153. "type": "string",
  3154. "description": "owner of the repo",
  3155. "name": "owner",
  3156. "in": "path",
  3157. "required": true
  3158. },
  3159. {
  3160. "type": "string",
  3161. "description": "name of the repo",
  3162. "name": "repo",
  3163. "in": "path",
  3164. "required": true
  3165. },
  3166. {
  3167. "type": "string",
  3168. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  3169. "name": "sha",
  3170. "in": "path",
  3171. "required": true
  3172. }
  3173. ],
  3174. "responses": {
  3175. "200": {
  3176. "$ref": "#/responses/AnnotatedTag"
  3177. },
  3178. "400": {
  3179. "$ref": "#/responses/error"
  3180. }
  3181. }
  3182. }
  3183. },
  3184. "/repos/{owner}/{repo}/git/trees/{sha}": {
  3185. "get": {
  3186. "produces": [
  3187. "application/json"
  3188. ],
  3189. "tags": [
  3190. "repository"
  3191. ],
  3192. "summary": "Gets the tree of a repository.",
  3193. "operationId": "GetTree",
  3194. "parameters": [
  3195. {
  3196. "type": "string",
  3197. "description": "owner of the repo",
  3198. "name": "owner",
  3199. "in": "path",
  3200. "required": true
  3201. },
  3202. {
  3203. "type": "string",
  3204. "description": "name of the repo",
  3205. "name": "repo",
  3206. "in": "path",
  3207. "required": true
  3208. },
  3209. {
  3210. "type": "string",
  3211. "description": "sha of the commit",
  3212. "name": "sha",
  3213. "in": "path",
  3214. "required": true
  3215. },
  3216. {
  3217. "type": "boolean",
  3218. "description": "show all directories and files",
  3219. "name": "recursive",
  3220. "in": "query"
  3221. },
  3222. {
  3223. "type": "integer",
  3224. "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page",
  3225. "name": "page",
  3226. "in": "query"
  3227. },
  3228. {
  3229. "type": "integer",
  3230. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  3231. "name": "per_page",
  3232. "in": "query"
  3233. }
  3234. ],
  3235. "responses": {
  3236. "200": {
  3237. "$ref": "#/responses/GitTreeResponse"
  3238. },
  3239. "400": {
  3240. "$ref": "#/responses/error"
  3241. }
  3242. }
  3243. }
  3244. },
  3245. "/repos/{owner}/{repo}/hooks": {
  3246. "get": {
  3247. "produces": [
  3248. "application/json"
  3249. ],
  3250. "tags": [
  3251. "repository"
  3252. ],
  3253. "summary": "List the hooks in a repository",
  3254. "operationId": "repoListHooks",
  3255. "parameters": [
  3256. {
  3257. "type": "string",
  3258. "description": "owner of the repo",
  3259. "name": "owner",
  3260. "in": "path",
  3261. "required": true
  3262. },
  3263. {
  3264. "type": "string",
  3265. "description": "name of the repo",
  3266. "name": "repo",
  3267. "in": "path",
  3268. "required": true
  3269. },
  3270. {
  3271. "type": "integer",
  3272. "description": "page number of results to return (1-based)",
  3273. "name": "page",
  3274. "in": "query"
  3275. },
  3276. {
  3277. "type": "integer",
  3278. "description": "page size of results, maximum page size is 50",
  3279. "name": "limit",
  3280. "in": "query"
  3281. }
  3282. ],
  3283. "responses": {
  3284. "200": {
  3285. "$ref": "#/responses/HookList"
  3286. }
  3287. }
  3288. },
  3289. "post": {
  3290. "consumes": [
  3291. "application/json"
  3292. ],
  3293. "produces": [
  3294. "application/json"
  3295. ],
  3296. "tags": [
  3297. "repository"
  3298. ],
  3299. "summary": "Create a hook",
  3300. "operationId": "repoCreateHook",
  3301. "parameters": [
  3302. {
  3303. "type": "string",
  3304. "description": "owner of the repo",
  3305. "name": "owner",
  3306. "in": "path",
  3307. "required": true
  3308. },
  3309. {
  3310. "type": "string",
  3311. "description": "name of the repo",
  3312. "name": "repo",
  3313. "in": "path",
  3314. "required": true
  3315. },
  3316. {
  3317. "name": "body",
  3318. "in": "body",
  3319. "schema": {
  3320. "$ref": "#/definitions/CreateHookOption"
  3321. }
  3322. }
  3323. ],
  3324. "responses": {
  3325. "201": {
  3326. "$ref": "#/responses/Hook"
  3327. }
  3328. }
  3329. }
  3330. },
  3331. "/repos/{owner}/{repo}/hooks/git": {
  3332. "get": {
  3333. "produces": [
  3334. "application/json"
  3335. ],
  3336. "tags": [
  3337. "repository"
  3338. ],
  3339. "summary": "List the Git hooks in a repository",
  3340. "operationId": "repoListGitHooks",
  3341. "parameters": [
  3342. {
  3343. "type": "string",
  3344. "description": "owner of the repo",
  3345. "name": "owner",
  3346. "in": "path",
  3347. "required": true
  3348. },
  3349. {
  3350. "type": "string",
  3351. "description": "name of the repo",
  3352. "name": "repo",
  3353. "in": "path",
  3354. "required": true
  3355. }
  3356. ],
  3357. "responses": {
  3358. "200": {
  3359. "$ref": "#/responses/GitHookList"
  3360. }
  3361. }
  3362. }
  3363. },
  3364. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3365. "get": {
  3366. "produces": [
  3367. "application/json"
  3368. ],
  3369. "tags": [
  3370. "repository"
  3371. ],
  3372. "summary": "Get a Git hook",
  3373. "operationId": "repoGetGitHook",
  3374. "parameters": [
  3375. {
  3376. "type": "string",
  3377. "description": "owner of the repo",
  3378. "name": "owner",
  3379. "in": "path",
  3380. "required": true
  3381. },
  3382. {
  3383. "type": "string",
  3384. "description": "name of the repo",
  3385. "name": "repo",
  3386. "in": "path",
  3387. "required": true
  3388. },
  3389. {
  3390. "type": "string",
  3391. "description": "id of the hook to get",
  3392. "name": "id",
  3393. "in": "path",
  3394. "required": true
  3395. }
  3396. ],
  3397. "responses": {
  3398. "200": {
  3399. "$ref": "#/responses/GitHook"
  3400. },
  3401. "404": {
  3402. "$ref": "#/responses/notFound"
  3403. }
  3404. }
  3405. },
  3406. "delete": {
  3407. "produces": [
  3408. "application/json"
  3409. ],
  3410. "tags": [
  3411. "repository"
  3412. ],
  3413. "summary": "Delete a Git hook in a repository",
  3414. "operationId": "repoDeleteGitHook",
  3415. "parameters": [
  3416. {
  3417. "type": "string",
  3418. "description": "owner of the repo",
  3419. "name": "owner",
  3420. "in": "path",
  3421. "required": true
  3422. },
  3423. {
  3424. "type": "string",
  3425. "description": "name of the repo",
  3426. "name": "repo",
  3427. "in": "path",
  3428. "required": true
  3429. },
  3430. {
  3431. "type": "string",
  3432. "description": "id of the hook to get",
  3433. "name": "id",
  3434. "in": "path",
  3435. "required": true
  3436. }
  3437. ],
  3438. "responses": {
  3439. "204": {
  3440. "$ref": "#/responses/empty"
  3441. },
  3442. "404": {
  3443. "$ref": "#/responses/notFound"
  3444. }
  3445. }
  3446. },
  3447. "patch": {
  3448. "produces": [
  3449. "application/json"
  3450. ],
  3451. "tags": [
  3452. "repository"
  3453. ],
  3454. "summary": "Edit a Git hook in a repository",
  3455. "operationId": "repoEditGitHook",
  3456. "parameters": [
  3457. {
  3458. "type": "string",
  3459. "description": "owner of the repo",
  3460. "name": "owner",
  3461. "in": "path",
  3462. "required": true
  3463. },
  3464. {
  3465. "type": "string",
  3466. "description": "name of the repo",
  3467. "name": "repo",
  3468. "in": "path",
  3469. "required": true
  3470. },
  3471. {
  3472. "type": "string",
  3473. "description": "id of the hook to get",
  3474. "name": "id",
  3475. "in": "path",
  3476. "required": true
  3477. },
  3478. {
  3479. "name": "body",
  3480. "in": "body",
  3481. "schema": {
  3482. "$ref": "#/definitions/EditGitHookOption"
  3483. }
  3484. }
  3485. ],
  3486. "responses": {
  3487. "200": {
  3488. "$ref": "#/responses/GitHook"
  3489. },
  3490. "404": {
  3491. "$ref": "#/responses/notFound"
  3492. }
  3493. }
  3494. }
  3495. },
  3496. "/repos/{owner}/{repo}/hooks/{id}": {
  3497. "get": {
  3498. "produces": [
  3499. "application/json"
  3500. ],
  3501. "tags": [
  3502. "repository"
  3503. ],
  3504. "summary": "Get a hook",
  3505. "operationId": "repoGetHook",
  3506. "parameters": [
  3507. {
  3508. "type": "string",
  3509. "description": "owner of the repo",
  3510. "name": "owner",
  3511. "in": "path",
  3512. "required": true
  3513. },
  3514. {
  3515. "type": "string",
  3516. "description": "name of the repo",
  3517. "name": "repo",
  3518. "in": "path",
  3519. "required": true
  3520. },
  3521. {
  3522. "type": "integer",
  3523. "format": "int64",
  3524. "description": "id of the hook to get",
  3525. "name": "id",
  3526. "in": "path",
  3527. "required": true
  3528. }
  3529. ],
  3530. "responses": {
  3531. "200": {
  3532. "$ref": "#/responses/Hook"
  3533. },
  3534. "404": {
  3535. "$ref": "#/responses/notFound"
  3536. }
  3537. }
  3538. },
  3539. "delete": {
  3540. "produces": [
  3541. "application/json"
  3542. ],
  3543. "tags": [
  3544. "repository"
  3545. ],
  3546. "summary": "Delete a hook in a repository",
  3547. "operationId": "repoDeleteHook",
  3548. "parameters": [
  3549. {
  3550. "type": "string",
  3551. "description": "owner of the repo",
  3552. "name": "owner",
  3553. "in": "path",
  3554. "required": true
  3555. },
  3556. {
  3557. "type": "string",
  3558. "description": "name of the repo",
  3559. "name": "repo",
  3560. "in": "path",
  3561. "required": true
  3562. },
  3563. {
  3564. "type": "integer",
  3565. "format": "int64",
  3566. "description": "id of the hook to delete",
  3567. "name": "id",
  3568. "in": "path",
  3569. "required": true
  3570. }
  3571. ],
  3572. "responses": {
  3573. "204": {
  3574. "$ref": "#/responses/empty"
  3575. },
  3576. "404": {
  3577. "$ref": "#/responses/notFound"
  3578. }
  3579. }
  3580. },
  3581. "patch": {
  3582. "produces": [
  3583. "application/json"
  3584. ],
  3585. "tags": [
  3586. "repository"
  3587. ],
  3588. "summary": "Edit a hook in a repository",
  3589. "operationId": "repoEditHook",
  3590. "parameters": [
  3591. {
  3592. "type": "string",
  3593. "description": "owner of the repo",
  3594. "name": "owner",
  3595. "in": "path",
  3596. "required": true
  3597. },
  3598. {
  3599. "type": "string",
  3600. "description": "name of the repo",
  3601. "name": "repo",
  3602. "in": "path",
  3603. "required": true
  3604. },
  3605. {
  3606. "type": "integer",
  3607. "format": "int64",
  3608. "description": "index of the hook",
  3609. "name": "id",
  3610. "in": "path",
  3611. "required": true
  3612. },
  3613. {
  3614. "name": "body",
  3615. "in": "body",
  3616. "schema": {
  3617. "$ref": "#/definitions/EditHookOption"
  3618. }
  3619. }
  3620. ],
  3621. "responses": {
  3622. "200": {
  3623. "$ref": "#/responses/Hook"
  3624. }
  3625. }
  3626. }
  3627. },
  3628. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3629. "post": {
  3630. "produces": [
  3631. "application/json"
  3632. ],
  3633. "tags": [
  3634. "repository"
  3635. ],
  3636. "summary": "Test a push webhook",
  3637. "operationId": "repoTestHook",
  3638. "parameters": [
  3639. {
  3640. "type": "string",
  3641. "description": "owner of the repo",
  3642. "name": "owner",
  3643. "in": "path",
  3644. "required": true
  3645. },
  3646. {
  3647. "type": "string",
  3648. "description": "name of the repo",
  3649. "name": "repo",
  3650. "in": "path",
  3651. "required": true
  3652. },
  3653. {
  3654. "type": "integer",
  3655. "format": "int64",
  3656. "description": "id of the hook to test",
  3657. "name": "id",
  3658. "in": "path",
  3659. "required": true
  3660. }
  3661. ],
  3662. "responses": {
  3663. "204": {
  3664. "$ref": "#/responses/empty"
  3665. }
  3666. }
  3667. }
  3668. },
  3669. "/repos/{owner}/{repo}/issues": {
  3670. "get": {
  3671. "produces": [
  3672. "application/json"
  3673. ],
  3674. "tags": [
  3675. "issue"
  3676. ],
  3677. "summary": "List a repository's issues",
  3678. "operationId": "issueListIssues",
  3679. "parameters": [
  3680. {
  3681. "type": "string",
  3682. "description": "owner of the repo",
  3683. "name": "owner",
  3684. "in": "path",
  3685. "required": true
  3686. },
  3687. {
  3688. "type": "string",
  3689. "description": "name of the repo",
  3690. "name": "repo",
  3691. "in": "path",
  3692. "required": true
  3693. },
  3694. {
  3695. "type": "string",
  3696. "description": "whether issue is open or closed",
  3697. "name": "state",
  3698. "in": "query"
  3699. },
  3700. {
  3701. "type": "string",
  3702. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3703. "name": "labels",
  3704. "in": "query"
  3705. },
  3706. {
  3707. "type": "string",
  3708. "description": "search string",
  3709. "name": "q",
  3710. "in": "query"
  3711. },
  3712. {
  3713. "type": "string",
  3714. "description": "filter by type (issues / pulls) if set",
  3715. "name": "type",
  3716. "in": "query"
  3717. },
  3718. {
  3719. "type": "integer",
  3720. "description": "page number of results to return (1-based)",
  3721. "name": "page",
  3722. "in": "query"
  3723. },
  3724. {
  3725. "type": "integer",
  3726. "description": "page size of results, maximum page size is 50",
  3727. "name": "limit",
  3728. "in": "query"
  3729. }
  3730. ],
  3731. "responses": {
  3732. "200": {
  3733. "$ref": "#/responses/IssueList"
  3734. }
  3735. }
  3736. },
  3737. "post": {
  3738. "consumes": [
  3739. "application/json"
  3740. ],
  3741. "produces": [
  3742. "application/json"
  3743. ],
  3744. "tags": [
  3745. "issue"
  3746. ],
  3747. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3748. "operationId": "issueCreateIssue",
  3749. "parameters": [
  3750. {
  3751. "type": "string",
  3752. "description": "owner of the repo",
  3753. "name": "owner",
  3754. "in": "path",
  3755. "required": true
  3756. },
  3757. {
  3758. "type": "string",
  3759. "description": "name of the repo",
  3760. "name": "repo",
  3761. "in": "path",
  3762. "required": true
  3763. },
  3764. {
  3765. "name": "body",
  3766. "in": "body",
  3767. "schema": {
  3768. "$ref": "#/definitions/CreateIssueOption"
  3769. }
  3770. }
  3771. ],
  3772. "responses": {
  3773. "201": {
  3774. "$ref": "#/responses/Issue"
  3775. },
  3776. "403": {
  3777. "$ref": "#/responses/forbidden"
  3778. },
  3779. "412": {
  3780. "$ref": "#/responses/error"
  3781. },
  3782. "422": {
  3783. "$ref": "#/responses/validationError"
  3784. }
  3785. }
  3786. }
  3787. },
  3788. "/repos/{owner}/{repo}/issues/comments": {
  3789. "get": {
  3790. "produces": [
  3791. "application/json"
  3792. ],
  3793. "tags": [
  3794. "issue"
  3795. ],
  3796. "summary": "List all comments in a repository",
  3797. "operationId": "issueGetRepoComments",
  3798. "parameters": [
  3799. {
  3800. "type": "string",
  3801. "description": "owner of the repo",
  3802. "name": "owner",
  3803. "in": "path",
  3804. "required": true
  3805. },
  3806. {
  3807. "type": "string",
  3808. "description": "name of the repo",
  3809. "name": "repo",
  3810. "in": "path",
  3811. "required": true
  3812. },
  3813. {
  3814. "type": "string",
  3815. "format": "date-time",
  3816. "description": "if provided, only comments updated since the provided time are returned.",
  3817. "name": "since",
  3818. "in": "query"
  3819. },
  3820. {
  3821. "type": "string",
  3822. "format": "date-time",
  3823. "description": "if provided, only comments updated before the provided time are returned.",
  3824. "name": "before",
  3825. "in": "query"
  3826. },
  3827. {
  3828. "type": "integer",
  3829. "description": "page number of results to return (1-based)",
  3830. "name": "page",
  3831. "in": "query"
  3832. },
  3833. {
  3834. "type": "integer",
  3835. "description": "page size of results, maximum page size is 50",
  3836. "name": "limit",
  3837. "in": "query"
  3838. }
  3839. ],
  3840. "responses": {
  3841. "200": {
  3842. "$ref": "#/responses/CommentList"
  3843. }
  3844. }
  3845. }
  3846. },
  3847. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3848. "get": {
  3849. "consumes": [
  3850. "application/json"
  3851. ],
  3852. "produces": [
  3853. "application/json"
  3854. ],
  3855. "tags": [
  3856. "issue"
  3857. ],
  3858. "summary": "Get a comment",
  3859. "operationId": "issueGetComment",
  3860. "parameters": [
  3861. {
  3862. "type": "string",
  3863. "description": "owner of the repo",
  3864. "name": "owner",
  3865. "in": "path",
  3866. "required": true
  3867. },
  3868. {
  3869. "type": "string",
  3870. "description": "name of the repo",
  3871. "name": "repo",
  3872. "in": "path",
  3873. "required": true
  3874. },
  3875. {
  3876. "type": "integer",
  3877. "format": "int64",
  3878. "description": "id of the comment",
  3879. "name": "id",
  3880. "in": "path",
  3881. "required": true
  3882. }
  3883. ],
  3884. "responses": {
  3885. "200": {
  3886. "$ref": "#/responses/Comment"
  3887. },
  3888. "204": {
  3889. "$ref": "#/responses/empty"
  3890. },
  3891. "403": {
  3892. "$ref": "#/responses/forbidden"
  3893. },
  3894. "404": {
  3895. "$ref": "#/responses/notFound"
  3896. }
  3897. }
  3898. },
  3899. "delete": {
  3900. "tags": [
  3901. "issue"
  3902. ],
  3903. "summary": "Delete a comment",
  3904. "operationId": "issueDeleteComment",
  3905. "parameters": [
  3906. {
  3907. "type": "string",
  3908. "description": "owner of the repo",
  3909. "name": "owner",
  3910. "in": "path",
  3911. "required": true
  3912. },
  3913. {
  3914. "type": "string",
  3915. "description": "name of the repo",
  3916. "name": "repo",
  3917. "in": "path",
  3918. "required": true
  3919. },
  3920. {
  3921. "type": "integer",
  3922. "format": "int64",
  3923. "description": "id of comment to delete",
  3924. "name": "id",
  3925. "in": "path",
  3926. "required": true
  3927. }
  3928. ],
  3929. "responses": {
  3930. "204": {
  3931. "$ref": "#/responses/empty"
  3932. },
  3933. "403": {
  3934. "$ref": "#/responses/forbidden"
  3935. },
  3936. "404": {
  3937. "$ref": "#/responses/notFound"
  3938. }
  3939. }
  3940. },
  3941. "patch": {
  3942. "consumes": [
  3943. "application/json"
  3944. ],
  3945. "produces": [
  3946. "application/json"
  3947. ],
  3948. "tags": [
  3949. "issue"
  3950. ],
  3951. "summary": "Edit a comment",
  3952. "operationId": "issueEditComment",
  3953. "parameters": [
  3954. {
  3955. "type": "string",
  3956. "description": "owner of the repo",
  3957. "name": "owner",
  3958. "in": "path",
  3959. "required": true
  3960. },
  3961. {
  3962. "type": "string",
  3963. "description": "name of the repo",
  3964. "name": "repo",
  3965. "in": "path",
  3966. "required": true
  3967. },
  3968. {
  3969. "type": "integer",
  3970. "format": "int64",
  3971. "description": "id of the comment to edit",
  3972. "name": "id",
  3973. "in": "path",
  3974. "required": true
  3975. },
  3976. {
  3977. "name": "body",
  3978. "in": "body",
  3979. "schema": {
  3980. "$ref": "#/definitions/EditIssueCommentOption"
  3981. }
  3982. }
  3983. ],
  3984. "responses": {
  3985. "200": {
  3986. "$ref": "#/responses/Comment"
  3987. },
  3988. "204": {
  3989. "$ref": "#/responses/empty"
  3990. },
  3991. "403": {
  3992. "$ref": "#/responses/forbidden"
  3993. },
  3994. "404": {
  3995. "$ref": "#/responses/notFound"
  3996. }
  3997. }
  3998. }
  3999. },
  4000. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  4001. "get": {
  4002. "consumes": [
  4003. "application/json"
  4004. ],
  4005. "produces": [
  4006. "application/json"
  4007. ],
  4008. "tags": [
  4009. "issue"
  4010. ],
  4011. "summary": "Get a list of reactions from a comment of an issue",
  4012. "operationId": "issueGetCommentReactions",
  4013. "parameters": [
  4014. {
  4015. "type": "string",
  4016. "description": "owner of the repo",
  4017. "name": "owner",
  4018. "in": "path",
  4019. "required": true
  4020. },
  4021. {
  4022. "type": "string",
  4023. "description": "name of the repo",
  4024. "name": "repo",
  4025. "in": "path",
  4026. "required": true
  4027. },
  4028. {
  4029. "type": "integer",
  4030. "format": "int64",
  4031. "description": "id of the comment to edit",
  4032. "name": "id",
  4033. "in": "path",
  4034. "required": true
  4035. }
  4036. ],
  4037. "responses": {
  4038. "200": {
  4039. "$ref": "#/responses/ReactionList"
  4040. },
  4041. "403": {
  4042. "$ref": "#/responses/forbidden"
  4043. }
  4044. }
  4045. },
  4046. "post": {
  4047. "consumes": [
  4048. "application/json"
  4049. ],
  4050. "produces": [
  4051. "application/json"
  4052. ],
  4053. "tags": [
  4054. "issue"
  4055. ],
  4056. "summary": "Add a reaction to a comment of an issue",
  4057. "operationId": "issuePostCommentReaction",
  4058. "parameters": [
  4059. {
  4060. "type": "string",
  4061. "description": "owner of the repo",
  4062. "name": "owner",
  4063. "in": "path",
  4064. "required": true
  4065. },
  4066. {
  4067. "type": "string",
  4068. "description": "name of the repo",
  4069. "name": "repo",
  4070. "in": "path",
  4071. "required": true
  4072. },
  4073. {
  4074. "type": "integer",
  4075. "format": "int64",
  4076. "description": "id of the comment to edit",
  4077. "name": "id",
  4078. "in": "path",
  4079. "required": true
  4080. },
  4081. {
  4082. "name": "content",
  4083. "in": "body",
  4084. "schema": {
  4085. "$ref": "#/definitions/EditReactionOption"
  4086. }
  4087. }
  4088. ],
  4089. "responses": {
  4090. "200": {
  4091. "$ref": "#/responses/Reaction"
  4092. },
  4093. "201": {
  4094. "$ref": "#/responses/Reaction"
  4095. },
  4096. "403": {
  4097. "$ref": "#/responses/forbidden"
  4098. }
  4099. }
  4100. },
  4101. "delete": {
  4102. "consumes": [
  4103. "application/json"
  4104. ],
  4105. "produces": [
  4106. "application/json"
  4107. ],
  4108. "tags": [
  4109. "issue"
  4110. ],
  4111. "summary": "Remove a reaction from a comment of an issue",
  4112. "operationId": "issueDeleteCommentReaction",
  4113. "parameters": [
  4114. {
  4115. "type": "string",
  4116. "description": "owner of the repo",
  4117. "name": "owner",
  4118. "in": "path",
  4119. "required": true
  4120. },
  4121. {
  4122. "type": "string",
  4123. "description": "name of the repo",
  4124. "name": "repo",
  4125. "in": "path",
  4126. "required": true
  4127. },
  4128. {
  4129. "type": "integer",
  4130. "format": "int64",
  4131. "description": "id of the comment to edit",
  4132. "name": "id",
  4133. "in": "path",
  4134. "required": true
  4135. },
  4136. {
  4137. "name": "content",
  4138. "in": "body",
  4139. "schema": {
  4140. "$ref": "#/definitions/EditReactionOption"
  4141. }
  4142. }
  4143. ],
  4144. "responses": {
  4145. "200": {
  4146. "$ref": "#/responses/empty"
  4147. },
  4148. "403": {
  4149. "$ref": "#/responses/forbidden"
  4150. }
  4151. }
  4152. }
  4153. },
  4154. "/repos/{owner}/{repo}/issues/{index}": {
  4155. "get": {
  4156. "produces": [
  4157. "application/json"
  4158. ],
  4159. "tags": [
  4160. "issue"
  4161. ],
  4162. "summary": "Get an issue",
  4163. "operationId": "issueGetIssue",
  4164. "parameters": [
  4165. {
  4166. "type": "string",
  4167. "description": "owner of the repo",
  4168. "name": "owner",
  4169. "in": "path",
  4170. "required": true
  4171. },
  4172. {
  4173. "type": "string",
  4174. "description": "name of the repo",
  4175. "name": "repo",
  4176. "in": "path",
  4177. "required": true
  4178. },
  4179. {
  4180. "type": "integer",
  4181. "format": "int64",
  4182. "description": "index of the issue to get",
  4183. "name": "index",
  4184. "in": "path",
  4185. "required": true
  4186. }
  4187. ],
  4188. "responses": {
  4189. "200": {
  4190. "$ref": "#/responses/Issue"
  4191. },
  4192. "404": {
  4193. "$ref": "#/responses/notFound"
  4194. }
  4195. }
  4196. },
  4197. "patch": {
  4198. "consumes": [
  4199. "application/json"
  4200. ],
  4201. "produces": [
  4202. "application/json"
  4203. ],
  4204. "tags": [
  4205. "issue"
  4206. ],
  4207. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4208. "operationId": "issueEditIssue",
  4209. "parameters": [
  4210. {
  4211. "type": "string",
  4212. "description": "owner of the repo",
  4213. "name": "owner",
  4214. "in": "path",
  4215. "required": true
  4216. },
  4217. {
  4218. "type": "string",
  4219. "description": "name of the repo",
  4220. "name": "repo",
  4221. "in": "path",
  4222. "required": true
  4223. },
  4224. {
  4225. "type": "integer",
  4226. "format": "int64",
  4227. "description": "index of the issue to edit",
  4228. "name": "index",
  4229. "in": "path",
  4230. "required": true
  4231. },
  4232. {
  4233. "name": "body",
  4234. "in": "body",
  4235. "schema": {
  4236. "$ref": "#/definitions/EditIssueOption"
  4237. }
  4238. }
  4239. ],
  4240. "responses": {
  4241. "201": {
  4242. "$ref": "#/responses/Issue"
  4243. },
  4244. "403": {
  4245. "$ref": "#/responses/forbidden"
  4246. },
  4247. "404": {
  4248. "$ref": "#/responses/notFound"
  4249. },
  4250. "412": {
  4251. "$ref": "#/responses/error"
  4252. }
  4253. }
  4254. }
  4255. },
  4256. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4257. "get": {
  4258. "produces": [
  4259. "application/json"
  4260. ],
  4261. "tags": [
  4262. "issue"
  4263. ],
  4264. "summary": "List all comments on an issue",
  4265. "operationId": "issueGetComments",
  4266. "parameters": [
  4267. {
  4268. "type": "string",
  4269. "description": "owner of the repo",
  4270. "name": "owner",
  4271. "in": "path",
  4272. "required": true
  4273. },
  4274. {
  4275. "type": "string",
  4276. "description": "name of the repo",
  4277. "name": "repo",
  4278. "in": "path",
  4279. "required": true
  4280. },
  4281. {
  4282. "type": "integer",
  4283. "format": "int64",
  4284. "description": "index of the issue",
  4285. "name": "index",
  4286. "in": "path",
  4287. "required": true
  4288. },
  4289. {
  4290. "type": "string",
  4291. "format": "date-time",
  4292. "description": "if provided, only comments updated since the specified time are returned.",
  4293. "name": "since",
  4294. "in": "query"
  4295. },
  4296. {
  4297. "type": "string",
  4298. "format": "date-time",
  4299. "description": "if provided, only comments updated before the provided time are returned.",
  4300. "name": "before",
  4301. "in": "query"
  4302. }
  4303. ],
  4304. "responses": {
  4305. "200": {
  4306. "$ref": "#/responses/CommentList"
  4307. }
  4308. }
  4309. },
  4310. "post": {
  4311. "consumes": [
  4312. "application/json"
  4313. ],
  4314. "produces": [
  4315. "application/json"
  4316. ],
  4317. "tags": [
  4318. "issue"
  4319. ],
  4320. "summary": "Add a comment to an issue",
  4321. "operationId": "issueCreateComment",
  4322. "parameters": [
  4323. {
  4324. "type": "string",
  4325. "description": "owner of the repo",
  4326. "name": "owner",
  4327. "in": "path",
  4328. "required": true
  4329. },
  4330. {
  4331. "type": "string",
  4332. "description": "name of the repo",
  4333. "name": "repo",
  4334. "in": "path",
  4335. "required": true
  4336. },
  4337. {
  4338. "type": "integer",
  4339. "format": "int64",
  4340. "description": "index of the issue",
  4341. "name": "index",
  4342. "in": "path",
  4343. "required": true
  4344. },
  4345. {
  4346. "name": "body",
  4347. "in": "body",
  4348. "schema": {
  4349. "$ref": "#/definitions/CreateIssueCommentOption"
  4350. }
  4351. }
  4352. ],
  4353. "responses": {
  4354. "201": {
  4355. "$ref": "#/responses/Comment"
  4356. },
  4357. "403": {
  4358. "$ref": "#/responses/forbidden"
  4359. }
  4360. }
  4361. }
  4362. },
  4363. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  4364. "delete": {
  4365. "tags": [
  4366. "issue"
  4367. ],
  4368. "summary": "Delete a comment",
  4369. "operationId": "issueDeleteCommentDeprecated",
  4370. "deprecated": true,
  4371. "parameters": [
  4372. {
  4373. "type": "string",
  4374. "description": "owner of the repo",
  4375. "name": "owner",
  4376. "in": "path",
  4377. "required": true
  4378. },
  4379. {
  4380. "type": "string",
  4381. "description": "name of the repo",
  4382. "name": "repo",
  4383. "in": "path",
  4384. "required": true
  4385. },
  4386. {
  4387. "type": "integer",
  4388. "description": "this parameter is ignored",
  4389. "name": "index",
  4390. "in": "path",
  4391. "required": true
  4392. },
  4393. {
  4394. "type": "integer",
  4395. "format": "int64",
  4396. "description": "id of comment to delete",
  4397. "name": "id",
  4398. "in": "path",
  4399. "required": true
  4400. }
  4401. ],
  4402. "responses": {
  4403. "204": {
  4404. "$ref": "#/responses/empty"
  4405. },
  4406. "403": {
  4407. "$ref": "#/responses/forbidden"
  4408. },
  4409. "404": {
  4410. "$ref": "#/responses/notFound"
  4411. }
  4412. }
  4413. },
  4414. "patch": {
  4415. "consumes": [
  4416. "application/json"
  4417. ],
  4418. "produces": [
  4419. "application/json"
  4420. ],
  4421. "tags": [
  4422. "issue"
  4423. ],
  4424. "summary": "Edit a comment",
  4425. "operationId": "issueEditCommentDeprecated",
  4426. "deprecated": true,
  4427. "parameters": [
  4428. {
  4429. "type": "string",
  4430. "description": "owner of the repo",
  4431. "name": "owner",
  4432. "in": "path",
  4433. "required": true
  4434. },
  4435. {
  4436. "type": "string",
  4437. "description": "name of the repo",
  4438. "name": "repo",
  4439. "in": "path",
  4440. "required": true
  4441. },
  4442. {
  4443. "type": "integer",
  4444. "description": "this parameter is ignored",
  4445. "name": "index",
  4446. "in": "path",
  4447. "required": true
  4448. },
  4449. {
  4450. "type": "integer",
  4451. "format": "int64",
  4452. "description": "id of the comment to edit",
  4453. "name": "id",
  4454. "in": "path",
  4455. "required": true
  4456. },
  4457. {
  4458. "name": "body",
  4459. "in": "body",
  4460. "schema": {
  4461. "$ref": "#/definitions/EditIssueCommentOption"
  4462. }
  4463. }
  4464. ],
  4465. "responses": {
  4466. "200": {
  4467. "$ref": "#/responses/Comment"
  4468. },
  4469. "204": {
  4470. "$ref": "#/responses/empty"
  4471. },
  4472. "403": {
  4473. "$ref": "#/responses/forbidden"
  4474. },
  4475. "404": {
  4476. "$ref": "#/responses/notFound"
  4477. }
  4478. }
  4479. }
  4480. },
  4481. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4482. "post": {
  4483. "consumes": [
  4484. "application/json"
  4485. ],
  4486. "produces": [
  4487. "application/json"
  4488. ],
  4489. "tags": [
  4490. "issue"
  4491. ],
  4492. "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.",
  4493. "operationId": "issueEditIssueDeadline",
  4494. "parameters": [
  4495. {
  4496. "type": "string",
  4497. "description": "owner of the repo",
  4498. "name": "owner",
  4499. "in": "path",
  4500. "required": true
  4501. },
  4502. {
  4503. "type": "string",
  4504. "description": "name of the repo",
  4505. "name": "repo",
  4506. "in": "path",
  4507. "required": true
  4508. },
  4509. {
  4510. "type": "integer",
  4511. "format": "int64",
  4512. "description": "index of the issue to create or update a deadline on",
  4513. "name": "index",
  4514. "in": "path",
  4515. "required": true
  4516. },
  4517. {
  4518. "name": "body",
  4519. "in": "body",
  4520. "schema": {
  4521. "$ref": "#/definitions/EditDeadlineOption"
  4522. }
  4523. }
  4524. ],
  4525. "responses": {
  4526. "201": {
  4527. "$ref": "#/responses/IssueDeadline"
  4528. },
  4529. "403": {
  4530. "$ref": "#/responses/forbidden"
  4531. },
  4532. "404": {
  4533. "$ref": "#/responses/notFound"
  4534. }
  4535. }
  4536. }
  4537. },
  4538. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4539. "get": {
  4540. "produces": [
  4541. "application/json"
  4542. ],
  4543. "tags": [
  4544. "issue"
  4545. ],
  4546. "summary": "Get an issue's labels",
  4547. "operationId": "issueGetLabels",
  4548. "parameters": [
  4549. {
  4550. "type": "string",
  4551. "description": "owner of the repo",
  4552. "name": "owner",
  4553. "in": "path",
  4554. "required": true
  4555. },
  4556. {
  4557. "type": "string",
  4558. "description": "name of the repo",
  4559. "name": "repo",
  4560. "in": "path",
  4561. "required": true
  4562. },
  4563. {
  4564. "type": "integer",
  4565. "format": "int64",
  4566. "description": "index of the issue",
  4567. "name": "index",
  4568. "in": "path",
  4569. "required": true
  4570. }
  4571. ],
  4572. "responses": {
  4573. "200": {
  4574. "$ref": "#/responses/LabelList"
  4575. },
  4576. "404": {
  4577. "$ref": "#/responses/notFound"
  4578. }
  4579. }
  4580. },
  4581. "put": {
  4582. "consumes": [
  4583. "application/json"
  4584. ],
  4585. "produces": [
  4586. "application/json"
  4587. ],
  4588. "tags": [
  4589. "issue"
  4590. ],
  4591. "summary": "Replace an issue's labels",
  4592. "operationId": "issueReplaceLabels",
  4593. "parameters": [
  4594. {
  4595. "type": "string",
  4596. "description": "owner of the repo",
  4597. "name": "owner",
  4598. "in": "path",
  4599. "required": true
  4600. },
  4601. {
  4602. "type": "string",
  4603. "description": "name of the repo",
  4604. "name": "repo",
  4605. "in": "path",
  4606. "required": true
  4607. },
  4608. {
  4609. "type": "integer",
  4610. "format": "int64",
  4611. "description": "index of the issue",
  4612. "name": "index",
  4613. "in": "path",
  4614. "required": true
  4615. },
  4616. {
  4617. "name": "body",
  4618. "in": "body",
  4619. "schema": {
  4620. "$ref": "#/definitions/IssueLabelsOption"
  4621. }
  4622. }
  4623. ],
  4624. "responses": {
  4625. "200": {
  4626. "$ref": "#/responses/LabelList"
  4627. },
  4628. "403": {
  4629. "$ref": "#/responses/forbidden"
  4630. }
  4631. }
  4632. },
  4633. "post": {
  4634. "consumes": [
  4635. "application/json"
  4636. ],
  4637. "produces": [
  4638. "application/json"
  4639. ],
  4640. "tags": [
  4641. "issue"
  4642. ],
  4643. "summary": "Add a label to an issue",
  4644. "operationId": "issueAddLabel",
  4645. "parameters": [
  4646. {
  4647. "type": "string",
  4648. "description": "owner of the repo",
  4649. "name": "owner",
  4650. "in": "path",
  4651. "required": true
  4652. },
  4653. {
  4654. "type": "string",
  4655. "description": "name of the repo",
  4656. "name": "repo",
  4657. "in": "path",
  4658. "required": true
  4659. },
  4660. {
  4661. "type": "integer",
  4662. "format": "int64",
  4663. "description": "index of the issue",
  4664. "name": "index",
  4665. "in": "path",
  4666. "required": true
  4667. },
  4668. {
  4669. "name": "body",
  4670. "in": "body",
  4671. "schema": {
  4672. "$ref": "#/definitions/IssueLabelsOption"
  4673. }
  4674. }
  4675. ],
  4676. "responses": {
  4677. "200": {
  4678. "$ref": "#/responses/LabelList"
  4679. },
  4680. "403": {
  4681. "$ref": "#/responses/forbidden"
  4682. }
  4683. }
  4684. },
  4685. "delete": {
  4686. "produces": [
  4687. "application/json"
  4688. ],
  4689. "tags": [
  4690. "issue"
  4691. ],
  4692. "summary": "Remove all labels from an issue",
  4693. "operationId": "issueClearLabels",
  4694. "parameters": [
  4695. {
  4696. "type": "string",
  4697. "description": "owner of the repo",
  4698. "name": "owner",
  4699. "in": "path",
  4700. "required": true
  4701. },
  4702. {
  4703. "type": "string",
  4704. "description": "name of the repo",
  4705. "name": "repo",
  4706. "in": "path",
  4707. "required": true
  4708. },
  4709. {
  4710. "type": "integer",
  4711. "format": "int64",
  4712. "description": "index of the issue",
  4713. "name": "index",
  4714. "in": "path",
  4715. "required": true
  4716. }
  4717. ],
  4718. "responses": {
  4719. "204": {
  4720. "$ref": "#/responses/empty"
  4721. },
  4722. "403": {
  4723. "$ref": "#/responses/forbidden"
  4724. }
  4725. }
  4726. }
  4727. },
  4728. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4729. "delete": {
  4730. "produces": [
  4731. "application/json"
  4732. ],
  4733. "tags": [
  4734. "issue"
  4735. ],
  4736. "summary": "Remove a label from an issue",
  4737. "operationId": "issueRemoveLabel",
  4738. "parameters": [
  4739. {
  4740. "type": "string",
  4741. "description": "owner of the repo",
  4742. "name": "owner",
  4743. "in": "path",
  4744. "required": true
  4745. },
  4746. {
  4747. "type": "string",
  4748. "description": "name of the repo",
  4749. "name": "repo",
  4750. "in": "path",
  4751. "required": true
  4752. },
  4753. {
  4754. "type": "integer",
  4755. "format": "int64",
  4756. "description": "index of the issue",
  4757. "name": "index",
  4758. "in": "path",
  4759. "required": true
  4760. },
  4761. {
  4762. "type": "integer",
  4763. "format": "int64",
  4764. "description": "id of the label to remove",
  4765. "name": "id",
  4766. "in": "path",
  4767. "required": true
  4768. }
  4769. ],
  4770. "responses": {
  4771. "204": {
  4772. "$ref": "#/responses/empty"
  4773. },
  4774. "403": {
  4775. "$ref": "#/responses/forbidden"
  4776. },
  4777. "422": {
  4778. "$ref": "#/responses/validationError"
  4779. }
  4780. }
  4781. }
  4782. },
  4783. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4784. "get": {
  4785. "consumes": [
  4786. "application/json"
  4787. ],
  4788. "produces": [
  4789. "application/json"
  4790. ],
  4791. "tags": [
  4792. "issue"
  4793. ],
  4794. "summary": "Get a list reactions of an issue",
  4795. "operationId": "issueGetIssueReactions",
  4796. "parameters": [
  4797. {
  4798. "type": "string",
  4799. "description": "owner of the repo",
  4800. "name": "owner",
  4801. "in": "path",
  4802. "required": true
  4803. },
  4804. {
  4805. "type": "string",
  4806. "description": "name of the repo",
  4807. "name": "repo",
  4808. "in": "path",
  4809. "required": true
  4810. },
  4811. {
  4812. "type": "integer",
  4813. "format": "int64",
  4814. "description": "index of the issue",
  4815. "name": "index",
  4816. "in": "path",
  4817. "required": true
  4818. },
  4819. {
  4820. "type": "integer",
  4821. "description": "page number of results to return (1-based)",
  4822. "name": "page",
  4823. "in": "query"
  4824. },
  4825. {
  4826. "type": "integer",
  4827. "description": "page size of results, maximum page size is 50",
  4828. "name": "limit",
  4829. "in": "query"
  4830. }
  4831. ],
  4832. "responses": {
  4833. "200": {
  4834. "$ref": "#/responses/ReactionList"
  4835. },
  4836. "403": {
  4837. "$ref": "#/responses/forbidden"
  4838. }
  4839. }
  4840. },
  4841. "post": {
  4842. "consumes": [
  4843. "application/json"
  4844. ],
  4845. "produces": [
  4846. "application/json"
  4847. ],
  4848. "tags": [
  4849. "issue"
  4850. ],
  4851. "summary": "Add a reaction to an issue",
  4852. "operationId": "issuePostIssueReaction",
  4853. "parameters": [
  4854. {
  4855. "type": "string",
  4856. "description": "owner of the repo",
  4857. "name": "owner",
  4858. "in": "path",
  4859. "required": true
  4860. },
  4861. {
  4862. "type": "string",
  4863. "description": "name of the repo",
  4864. "name": "repo",
  4865. "in": "path",
  4866. "required": true
  4867. },
  4868. {
  4869. "type": "integer",
  4870. "format": "int64",
  4871. "description": "index of the issue",
  4872. "name": "index",
  4873. "in": "path",
  4874. "required": true
  4875. },
  4876. {
  4877. "name": "content",
  4878. "in": "body",
  4879. "schema": {
  4880. "$ref": "#/definitions/EditReactionOption"
  4881. }
  4882. }
  4883. ],
  4884. "responses": {
  4885. "200": {
  4886. "$ref": "#/responses/Reaction"
  4887. },
  4888. "201": {
  4889. "$ref": "#/responses/Reaction"
  4890. },
  4891. "403": {
  4892. "$ref": "#/responses/forbidden"
  4893. }
  4894. }
  4895. },
  4896. "delete": {
  4897. "consumes": [
  4898. "application/json"
  4899. ],
  4900. "produces": [
  4901. "application/json"
  4902. ],
  4903. "tags": [
  4904. "issue"
  4905. ],
  4906. "summary": "Remove a reaction from an issue",
  4907. "operationId": "issueDeleteIssueReaction",
  4908. "parameters": [
  4909. {
  4910. "type": "string",
  4911. "description": "owner of the repo",
  4912. "name": "owner",
  4913. "in": "path",
  4914. "required": true
  4915. },
  4916. {
  4917. "type": "string",
  4918. "description": "name of the repo",
  4919. "name": "repo",
  4920. "in": "path",
  4921. "required": true
  4922. },
  4923. {
  4924. "type": "integer",
  4925. "format": "int64",
  4926. "description": "index of the issue",
  4927. "name": "index",
  4928. "in": "path",
  4929. "required": true
  4930. },
  4931. {
  4932. "name": "content",
  4933. "in": "body",
  4934. "schema": {
  4935. "$ref": "#/definitions/EditReactionOption"
  4936. }
  4937. }
  4938. ],
  4939. "responses": {
  4940. "200": {
  4941. "$ref": "#/responses/empty"
  4942. },
  4943. "403": {
  4944. "$ref": "#/responses/forbidden"
  4945. }
  4946. }
  4947. }
  4948. },
  4949. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4950. "delete": {
  4951. "consumes": [
  4952. "application/json"
  4953. ],
  4954. "produces": [
  4955. "application/json"
  4956. ],
  4957. "tags": [
  4958. "issue"
  4959. ],
  4960. "summary": "Delete an issue's existing stopwatch.",
  4961. "operationId": "issueDeleteStopWatch",
  4962. "parameters": [
  4963. {
  4964. "type": "string",
  4965. "description": "owner of the repo",
  4966. "name": "owner",
  4967. "in": "path",
  4968. "required": true
  4969. },
  4970. {
  4971. "type": "string",
  4972. "description": "name of the repo",
  4973. "name": "repo",
  4974. "in": "path",
  4975. "required": true
  4976. },
  4977. {
  4978. "type": "integer",
  4979. "format": "int64",
  4980. "description": "index of the issue to stop the stopwatch on",
  4981. "name": "index",
  4982. "in": "path",
  4983. "required": true
  4984. }
  4985. ],
  4986. "responses": {
  4987. "204": {
  4988. "$ref": "#/responses/empty"
  4989. },
  4990. "403": {
  4991. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4992. },
  4993. "404": {
  4994. "$ref": "#/responses/notFound"
  4995. },
  4996. "409": {
  4997. "description": "Cannot cancel a non existent stopwatch"
  4998. }
  4999. }
  5000. }
  5001. },
  5002. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  5003. "post": {
  5004. "consumes": [
  5005. "application/json"
  5006. ],
  5007. "produces": [
  5008. "application/json"
  5009. ],
  5010. "tags": [
  5011. "issue"
  5012. ],
  5013. "summary": "Start stopwatch on an issue.",
  5014. "operationId": "issueStartStopWatch",
  5015. "parameters": [
  5016. {
  5017. "type": "string",
  5018. "description": "owner of the repo",
  5019. "name": "owner",
  5020. "in": "path",
  5021. "required": true
  5022. },
  5023. {
  5024. "type": "string",
  5025. "description": "name of the repo",
  5026. "name": "repo",
  5027. "in": "path",
  5028. "required": true
  5029. },
  5030. {
  5031. "type": "integer",
  5032. "format": "int64",
  5033. "description": "index of the issue to create the stopwatch on",
  5034. "name": "index",
  5035. "in": "path",
  5036. "required": true
  5037. }
  5038. ],
  5039. "responses": {
  5040. "201": {
  5041. "$ref": "#/responses/empty"
  5042. },
  5043. "403": {
  5044. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5045. },
  5046. "404": {
  5047. "$ref": "#/responses/notFound"
  5048. },
  5049. "409": {
  5050. "description": "Cannot start a stopwatch again if it already exists"
  5051. }
  5052. }
  5053. }
  5054. },
  5055. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  5056. "post": {
  5057. "consumes": [
  5058. "application/json"
  5059. ],
  5060. "produces": [
  5061. "application/json"
  5062. ],
  5063. "tags": [
  5064. "issue"
  5065. ],
  5066. "summary": "Stop an issue's existing stopwatch.",
  5067. "operationId": "issueStopStopWatch",
  5068. "parameters": [
  5069. {
  5070. "type": "string",
  5071. "description": "owner of the repo",
  5072. "name": "owner",
  5073. "in": "path",
  5074. "required": true
  5075. },
  5076. {
  5077. "type": "string",
  5078. "description": "name of the repo",
  5079. "name": "repo",
  5080. "in": "path",
  5081. "required": true
  5082. },
  5083. {
  5084. "type": "integer",
  5085. "format": "int64",
  5086. "description": "index of the issue to stop the stopwatch on",
  5087. "name": "index",
  5088. "in": "path",
  5089. "required": true
  5090. }
  5091. ],
  5092. "responses": {
  5093. "201": {
  5094. "$ref": "#/responses/empty"
  5095. },
  5096. "403": {
  5097. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5098. },
  5099. "404": {
  5100. "$ref": "#/responses/notFound"
  5101. },
  5102. "409": {
  5103. "description": "Cannot stop a non existent stopwatch"
  5104. }
  5105. }
  5106. }
  5107. },
  5108. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  5109. "get": {
  5110. "consumes": [
  5111. "application/json"
  5112. ],
  5113. "produces": [
  5114. "application/json"
  5115. ],
  5116. "tags": [
  5117. "issue"
  5118. ],
  5119. "summary": "Get users who subscribed on an issue.",
  5120. "operationId": "issueSubscriptions",
  5121. "parameters": [
  5122. {
  5123. "type": "string",
  5124. "description": "owner of the repo",
  5125. "name": "owner",
  5126. "in": "path",
  5127. "required": true
  5128. },
  5129. {
  5130. "type": "string",
  5131. "description": "name of the repo",
  5132. "name": "repo",
  5133. "in": "path",
  5134. "required": true
  5135. },
  5136. {
  5137. "type": "integer",
  5138. "format": "int64",
  5139. "description": "index of the issue",
  5140. "name": "index",
  5141. "in": "path",
  5142. "required": true
  5143. },
  5144. {
  5145. "type": "integer",
  5146. "description": "page number of results to return (1-based)",
  5147. "name": "page",
  5148. "in": "query"
  5149. },
  5150. {
  5151. "type": "integer",
  5152. "description": "page size of results, maximum page size is 50",
  5153. "name": "limit",
  5154. "in": "query"
  5155. }
  5156. ],
  5157. "responses": {
  5158. "200": {
  5159. "$ref": "#/responses/UserList"
  5160. },
  5161. "404": {
  5162. "$ref": "#/responses/notFound"
  5163. }
  5164. }
  5165. }
  5166. },
  5167. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  5168. "put": {
  5169. "consumes": [
  5170. "application/json"
  5171. ],
  5172. "produces": [
  5173. "application/json"
  5174. ],
  5175. "tags": [
  5176. "issue"
  5177. ],
  5178. "summary": "Subscribe user to issue",
  5179. "operationId": "issueAddSubscription",
  5180. "parameters": [
  5181. {
  5182. "type": "string",
  5183. "description": "owner of the repo",
  5184. "name": "owner",
  5185. "in": "path",
  5186. "required": true
  5187. },
  5188. {
  5189. "type": "string",
  5190. "description": "name of the repo",
  5191. "name": "repo",
  5192. "in": "path",
  5193. "required": true
  5194. },
  5195. {
  5196. "type": "integer",
  5197. "format": "int64",
  5198. "description": "index of the issue",
  5199. "name": "index",
  5200. "in": "path",
  5201. "required": true
  5202. },
  5203. {
  5204. "type": "string",
  5205. "description": "user to subscribe",
  5206. "name": "user",
  5207. "in": "path",
  5208. "required": true
  5209. }
  5210. ],
  5211. "responses": {
  5212. "201": {
  5213. "$ref": "#/responses/empty"
  5214. },
  5215. "304": {
  5216. "description": "User can only subscribe itself if he is no admin"
  5217. },
  5218. "404": {
  5219. "$ref": "#/responses/notFound"
  5220. }
  5221. }
  5222. },
  5223. "delete": {
  5224. "consumes": [
  5225. "application/json"
  5226. ],
  5227. "produces": [
  5228. "application/json"
  5229. ],
  5230. "tags": [
  5231. "issue"
  5232. ],
  5233. "summary": "Unsubscribe user from issue",
  5234. "operationId": "issueDeleteSubscription",
  5235. "parameters": [
  5236. {
  5237. "type": "string",
  5238. "description": "owner of the repo",
  5239. "name": "owner",
  5240. "in": "path",
  5241. "required": true
  5242. },
  5243. {
  5244. "type": "string",
  5245. "description": "name of the repo",
  5246. "name": "repo",
  5247. "in": "path",
  5248. "required": true
  5249. },
  5250. {
  5251. "type": "integer",
  5252. "format": "int64",
  5253. "description": "index of the issue",
  5254. "name": "index",
  5255. "in": "path",
  5256. "required": true
  5257. },
  5258. {
  5259. "type": "string",
  5260. "description": "user witch unsubscribe",
  5261. "name": "user",
  5262. "in": "path",
  5263. "required": true
  5264. }
  5265. ],
  5266. "responses": {
  5267. "201": {
  5268. "$ref": "#/responses/empty"
  5269. },
  5270. "304": {
  5271. "description": "User can only subscribe itself if he is no admin"
  5272. },
  5273. "404": {
  5274. "$ref": "#/responses/notFound"
  5275. }
  5276. }
  5277. }
  5278. },
  5279. "/repos/{owner}/{repo}/issues/{index}/times": {
  5280. "get": {
  5281. "produces": [
  5282. "application/json"
  5283. ],
  5284. "tags": [
  5285. "issue"
  5286. ],
  5287. "summary": "List an issue's tracked times",
  5288. "operationId": "issueTrackedTimes",
  5289. "parameters": [
  5290. {
  5291. "type": "string",
  5292. "description": "owner of the repo",
  5293. "name": "owner",
  5294. "in": "path",
  5295. "required": true
  5296. },
  5297. {
  5298. "type": "string",
  5299. "description": "name of the repo",
  5300. "name": "repo",
  5301. "in": "path",
  5302. "required": true
  5303. },
  5304. {
  5305. "type": "integer",
  5306. "format": "int64",
  5307. "description": "index of the issue",
  5308. "name": "index",
  5309. "in": "path",
  5310. "required": true
  5311. },
  5312. {
  5313. "type": "string",
  5314. "format": "date-time",
  5315. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  5316. "name": "since",
  5317. "in": "query"
  5318. },
  5319. {
  5320. "type": "string",
  5321. "format": "date-time",
  5322. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  5323. "name": "before",
  5324. "in": "query"
  5325. },
  5326. {
  5327. "type": "integer",
  5328. "description": "page number of results to return (1-based)",
  5329. "name": "page",
  5330. "in": "query"
  5331. },
  5332. {
  5333. "type": "integer",
  5334. "description": "page size of results, maximum page size is 50",
  5335. "name": "limit",
  5336. "in": "query"
  5337. }
  5338. ],
  5339. "responses": {
  5340. "200": {
  5341. "$ref": "#/responses/TrackedTimeList"
  5342. },
  5343. "404": {
  5344. "$ref": "#/responses/notFound"
  5345. }
  5346. }
  5347. },
  5348. "post": {
  5349. "consumes": [
  5350. "application/json"
  5351. ],
  5352. "produces": [
  5353. "application/json"
  5354. ],
  5355. "tags": [
  5356. "issue"
  5357. ],
  5358. "summary": "Add tracked time to a issue",
  5359. "operationId": "issueAddTime",
  5360. "parameters": [
  5361. {
  5362. "type": "string",
  5363. "description": "owner of the repo",
  5364. "name": "owner",
  5365. "in": "path",
  5366. "required": true
  5367. },
  5368. {
  5369. "type": "string",
  5370. "description": "name of the repo",
  5371. "name": "repo",
  5372. "in": "path",
  5373. "required": true
  5374. },
  5375. {
  5376. "type": "integer",
  5377. "format": "int64",
  5378. "description": "index of the issue",
  5379. "name": "index",
  5380. "in": "path",
  5381. "required": true
  5382. },
  5383. {
  5384. "name": "body",
  5385. "in": "body",
  5386. "schema": {
  5387. "$ref": "#/definitions/AddTimeOption"
  5388. }
  5389. }
  5390. ],
  5391. "responses": {
  5392. "200": {
  5393. "$ref": "#/responses/TrackedTime"
  5394. },
  5395. "400": {
  5396. "$ref": "#/responses/error"
  5397. },
  5398. "403": {
  5399. "$ref": "#/responses/forbidden"
  5400. }
  5401. }
  5402. },
  5403. "delete": {
  5404. "consumes": [
  5405. "application/json"
  5406. ],
  5407. "produces": [
  5408. "application/json"
  5409. ],
  5410. "tags": [
  5411. "issue"
  5412. ],
  5413. "summary": "Reset a tracked time of an issue",
  5414. "operationId": "issueResetTime",
  5415. "parameters": [
  5416. {
  5417. "type": "string",
  5418. "description": "owner of the repo",
  5419. "name": "owner",
  5420. "in": "path",
  5421. "required": true
  5422. },
  5423. {
  5424. "type": "string",
  5425. "description": "name of the repo",
  5426. "name": "repo",
  5427. "in": "path",
  5428. "required": true
  5429. },
  5430. {
  5431. "type": "integer",
  5432. "format": "int64",
  5433. "description": "index of the issue to add tracked time to",
  5434. "name": "index",
  5435. "in": "path",
  5436. "required": true
  5437. }
  5438. ],
  5439. "responses": {
  5440. "204": {
  5441. "$ref": "#/responses/empty"
  5442. },
  5443. "400": {
  5444. "$ref": "#/responses/error"
  5445. },
  5446. "403": {
  5447. "$ref": "#/responses/forbidden"
  5448. }
  5449. }
  5450. }
  5451. },
  5452. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5453. "delete": {
  5454. "consumes": [
  5455. "application/json"
  5456. ],
  5457. "produces": [
  5458. "application/json"
  5459. ],
  5460. "tags": [
  5461. "issue"
  5462. ],
  5463. "summary": "Delete specific tracked time",
  5464. "operationId": "issueDeleteTime",
  5465. "parameters": [
  5466. {
  5467. "type": "string",
  5468. "description": "owner of the repo",
  5469. "name": "owner",
  5470. "in": "path",
  5471. "required": true
  5472. },
  5473. {
  5474. "type": "string",
  5475. "description": "name of the repo",
  5476. "name": "repo",
  5477. "in": "path",
  5478. "required": true
  5479. },
  5480. {
  5481. "type": "integer",
  5482. "format": "int64",
  5483. "description": "index of the issue",
  5484. "name": "index",
  5485. "in": "path",
  5486. "required": true
  5487. },
  5488. {
  5489. "type": "integer",
  5490. "format": "int64",
  5491. "description": "id of time to delete",
  5492. "name": "id",
  5493. "in": "path",
  5494. "required": true
  5495. }
  5496. ],
  5497. "responses": {
  5498. "204": {
  5499. "$ref": "#/responses/empty"
  5500. },
  5501. "400": {
  5502. "$ref": "#/responses/error"
  5503. },
  5504. "403": {
  5505. "$ref": "#/responses/forbidden"
  5506. }
  5507. }
  5508. }
  5509. },
  5510. "/repos/{owner}/{repo}/keys": {
  5511. "get": {
  5512. "produces": [
  5513. "application/json"
  5514. ],
  5515. "tags": [
  5516. "repository"
  5517. ],
  5518. "summary": "List a repository's keys",
  5519. "operationId": "repoListKeys",
  5520. "parameters": [
  5521. {
  5522. "type": "string",
  5523. "description": "owner of the repo",
  5524. "name": "owner",
  5525. "in": "path",
  5526. "required": true
  5527. },
  5528. {
  5529. "type": "string",
  5530. "description": "name of the repo",
  5531. "name": "repo",
  5532. "in": "path",
  5533. "required": true
  5534. },
  5535. {
  5536. "type": "integer",
  5537. "description": "the key_id to search for",
  5538. "name": "key_id",
  5539. "in": "query"
  5540. },
  5541. {
  5542. "type": "string",
  5543. "description": "fingerprint of the key",
  5544. "name": "fingerprint",
  5545. "in": "query"
  5546. },
  5547. {
  5548. "type": "integer",
  5549. "description": "page number of results to return (1-based)",
  5550. "name": "page",
  5551. "in": "query"
  5552. },
  5553. {
  5554. "type": "integer",
  5555. "description": "page size of results, maximum page size is 50",
  5556. "name": "limit",
  5557. "in": "query"
  5558. }
  5559. ],
  5560. "responses": {
  5561. "200": {
  5562. "$ref": "#/responses/DeployKeyList"
  5563. }
  5564. }
  5565. },
  5566. "post": {
  5567. "consumes": [
  5568. "application/json"
  5569. ],
  5570. "produces": [
  5571. "application/json"
  5572. ],
  5573. "tags": [
  5574. "repository"
  5575. ],
  5576. "summary": "Add a key to a repository",
  5577. "operationId": "repoCreateKey",
  5578. "parameters": [
  5579. {
  5580. "type": "string",
  5581. "description": "owner of the repo",
  5582. "name": "owner",
  5583. "in": "path",
  5584. "required": true
  5585. },
  5586. {
  5587. "type": "string",
  5588. "description": "name of the repo",
  5589. "name": "repo",
  5590. "in": "path",
  5591. "required": true
  5592. },
  5593. {
  5594. "name": "body",
  5595. "in": "body",
  5596. "schema": {
  5597. "$ref": "#/definitions/CreateKeyOption"
  5598. }
  5599. }
  5600. ],
  5601. "responses": {
  5602. "201": {
  5603. "$ref": "#/responses/DeployKey"
  5604. },
  5605. "422": {
  5606. "$ref": "#/responses/validationError"
  5607. }
  5608. }
  5609. }
  5610. },
  5611. "/repos/{owner}/{repo}/keys/{id}": {
  5612. "get": {
  5613. "produces": [
  5614. "application/json"
  5615. ],
  5616. "tags": [
  5617. "repository"
  5618. ],
  5619. "summary": "Get a repository's key by id",
  5620. "operationId": "repoGetKey",
  5621. "parameters": [
  5622. {
  5623. "type": "string",
  5624. "description": "owner of the repo",
  5625. "name": "owner",
  5626. "in": "path",
  5627. "required": true
  5628. },
  5629. {
  5630. "type": "string",
  5631. "description": "name of the repo",
  5632. "name": "repo",
  5633. "in": "path",
  5634. "required": true
  5635. },
  5636. {
  5637. "type": "integer",
  5638. "format": "int64",
  5639. "description": "id of the key to get",
  5640. "name": "id",
  5641. "in": "path",
  5642. "required": true
  5643. }
  5644. ],
  5645. "responses": {
  5646. "200": {
  5647. "$ref": "#/responses/DeployKey"
  5648. }
  5649. }
  5650. },
  5651. "delete": {
  5652. "tags": [
  5653. "repository"
  5654. ],
  5655. "summary": "Delete a key from a repository",
  5656. "operationId": "repoDeleteKey",
  5657. "parameters": [
  5658. {
  5659. "type": "string",
  5660. "description": "owner of the repo",
  5661. "name": "owner",
  5662. "in": "path",
  5663. "required": true
  5664. },
  5665. {
  5666. "type": "string",
  5667. "description": "name of the repo",
  5668. "name": "repo",
  5669. "in": "path",
  5670. "required": true
  5671. },
  5672. {
  5673. "type": "integer",
  5674. "format": "int64",
  5675. "description": "id of the key to delete",
  5676. "name": "id",
  5677. "in": "path",
  5678. "required": true
  5679. }
  5680. ],
  5681. "responses": {
  5682. "204": {
  5683. "$ref": "#/responses/empty"
  5684. },
  5685. "403": {
  5686. "$ref": "#/responses/forbidden"
  5687. }
  5688. }
  5689. }
  5690. },
  5691. "/repos/{owner}/{repo}/labels": {
  5692. "get": {
  5693. "produces": [
  5694. "application/json"
  5695. ],
  5696. "tags": [
  5697. "issue"
  5698. ],
  5699. "summary": "Get all of a repository's labels",
  5700. "operationId": "issueListLabels",
  5701. "parameters": [
  5702. {
  5703. "type": "string",
  5704. "description": "owner of the repo",
  5705. "name": "owner",
  5706. "in": "path",
  5707. "required": true
  5708. },
  5709. {
  5710. "type": "string",
  5711. "description": "name of the repo",
  5712. "name": "repo",
  5713. "in": "path",
  5714. "required": true
  5715. },
  5716. {
  5717. "type": "integer",
  5718. "description": "page number of results to return (1-based)",
  5719. "name": "page",
  5720. "in": "query"
  5721. },
  5722. {
  5723. "type": "integer",
  5724. "description": "page size of results, maximum page size is 50",
  5725. "name": "limit",
  5726. "in": "query"
  5727. }
  5728. ],
  5729. "responses": {
  5730. "200": {
  5731. "$ref": "#/responses/LabelList"
  5732. }
  5733. }
  5734. },
  5735. "post": {
  5736. "consumes": [
  5737. "application/json"
  5738. ],
  5739. "produces": [
  5740. "application/json"
  5741. ],
  5742. "tags": [
  5743. "issue"
  5744. ],
  5745. "summary": "Create a label",
  5746. "operationId": "issueCreateLabel",
  5747. "parameters": [
  5748. {
  5749. "type": "string",
  5750. "description": "owner of the repo",
  5751. "name": "owner",
  5752. "in": "path",
  5753. "required": true
  5754. },
  5755. {
  5756. "type": "string",
  5757. "description": "name of the repo",
  5758. "name": "repo",
  5759. "in": "path",
  5760. "required": true
  5761. },
  5762. {
  5763. "name": "body",
  5764. "in": "body",
  5765. "schema": {
  5766. "$ref": "#/definitions/CreateLabelOption"
  5767. }
  5768. }
  5769. ],
  5770. "responses": {
  5771. "201": {
  5772. "$ref": "#/responses/Label"
  5773. },
  5774. "422": {
  5775. "$ref": "#/responses/validationError"
  5776. }
  5777. }
  5778. }
  5779. },
  5780. "/repos/{owner}/{repo}/labels/{id}": {
  5781. "get": {
  5782. "produces": [
  5783. "application/json"
  5784. ],
  5785. "tags": [
  5786. "issue"
  5787. ],
  5788. "summary": "Get a single label",
  5789. "operationId": "issueGetLabel",
  5790. "parameters": [
  5791. {
  5792. "type": "string",
  5793. "description": "owner of the repo",
  5794. "name": "owner",
  5795. "in": "path",
  5796. "required": true
  5797. },
  5798. {
  5799. "type": "string",
  5800. "description": "name of the repo",
  5801. "name": "repo",
  5802. "in": "path",
  5803. "required": true
  5804. },
  5805. {
  5806. "type": "integer",
  5807. "format": "int64",
  5808. "description": "id of the label to get",
  5809. "name": "id",
  5810. "in": "path",
  5811. "required": true
  5812. }
  5813. ],
  5814. "responses": {
  5815. "200": {
  5816. "$ref": "#/responses/Label"
  5817. }
  5818. }
  5819. },
  5820. "delete": {
  5821. "tags": [
  5822. "issue"
  5823. ],
  5824. "summary": "Delete a label",
  5825. "operationId": "issueDeleteLabel",
  5826. "parameters": [
  5827. {
  5828. "type": "string",
  5829. "description": "owner of the repo",
  5830. "name": "owner",
  5831. "in": "path",
  5832. "required": true
  5833. },
  5834. {
  5835. "type": "string",
  5836. "description": "name of the repo",
  5837. "name": "repo",
  5838. "in": "path",
  5839. "required": true
  5840. },
  5841. {
  5842. "type": "integer",
  5843. "format": "int64",
  5844. "description": "id of the label to delete",
  5845. "name": "id",
  5846. "in": "path",
  5847. "required": true
  5848. }
  5849. ],
  5850. "responses": {
  5851. "204": {
  5852. "$ref": "#/responses/empty"
  5853. }
  5854. }
  5855. },
  5856. "patch": {
  5857. "consumes": [
  5858. "application/json"
  5859. ],
  5860. "produces": [
  5861. "application/json"
  5862. ],
  5863. "tags": [
  5864. "issue"
  5865. ],
  5866. "summary": "Update a label",
  5867. "operationId": "issueEditLabel",
  5868. "parameters": [
  5869. {
  5870. "type": "string",
  5871. "description": "owner of the repo",
  5872. "name": "owner",
  5873. "in": "path",
  5874. "required": true
  5875. },
  5876. {
  5877. "type": "string",
  5878. "description": "name of the repo",
  5879. "name": "repo",
  5880. "in": "path",
  5881. "required": true
  5882. },
  5883. {
  5884. "type": "integer",
  5885. "format": "int64",
  5886. "description": "id of the label to edit",
  5887. "name": "id",
  5888. "in": "path",
  5889. "required": true
  5890. },
  5891. {
  5892. "name": "body",
  5893. "in": "body",
  5894. "schema": {
  5895. "$ref": "#/definitions/EditLabelOption"
  5896. }
  5897. }
  5898. ],
  5899. "responses": {
  5900. "200": {
  5901. "$ref": "#/responses/Label"
  5902. },
  5903. "422": {
  5904. "$ref": "#/responses/validationError"
  5905. }
  5906. }
  5907. }
  5908. },
  5909. "/repos/{owner}/{repo}/milestones": {
  5910. "get": {
  5911. "produces": [
  5912. "application/json"
  5913. ],
  5914. "tags": [
  5915. "issue"
  5916. ],
  5917. "summary": "Get all of a repository's opened milestones",
  5918. "operationId": "issueGetMilestonesList",
  5919. "parameters": [
  5920. {
  5921. "type": "string",
  5922. "description": "owner of the repo",
  5923. "name": "owner",
  5924. "in": "path",
  5925. "required": true
  5926. },
  5927. {
  5928. "type": "string",
  5929. "description": "name of the repo",
  5930. "name": "repo",
  5931. "in": "path",
  5932. "required": true
  5933. },
  5934. {
  5935. "type": "string",
  5936. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  5937. "name": "state",
  5938. "in": "query"
  5939. },
  5940. {
  5941. "type": "integer",
  5942. "description": "page number of results to return (1-based)",
  5943. "name": "page",
  5944. "in": "query"
  5945. },
  5946. {
  5947. "type": "integer",
  5948. "description": "page size of results, maximum page size is 50",
  5949. "name": "limit",
  5950. "in": "query"
  5951. }
  5952. ],
  5953. "responses": {
  5954. "200": {
  5955. "$ref": "#/responses/MilestoneList"
  5956. }
  5957. }
  5958. },
  5959. "post": {
  5960. "consumes": [
  5961. "application/json"
  5962. ],
  5963. "produces": [
  5964. "application/json"
  5965. ],
  5966. "tags": [
  5967. "issue"
  5968. ],
  5969. "summary": "Create a milestone",
  5970. "operationId": "issueCreateMilestone",
  5971. "parameters": [
  5972. {
  5973. "type": "string",
  5974. "description": "owner of the repo",
  5975. "name": "owner",
  5976. "in": "path",
  5977. "required": true
  5978. },
  5979. {
  5980. "type": "string",
  5981. "description": "name of the repo",
  5982. "name": "repo",
  5983. "in": "path",
  5984. "required": true
  5985. },
  5986. {
  5987. "name": "body",
  5988. "in": "body",
  5989. "schema": {
  5990. "$ref": "#/definitions/CreateMilestoneOption"
  5991. }
  5992. }
  5993. ],
  5994. "responses": {
  5995. "201": {
  5996. "$ref": "#/responses/Milestone"
  5997. }
  5998. }
  5999. }
  6000. },
  6001. "/repos/{owner}/{repo}/milestones/{id}": {
  6002. "get": {
  6003. "produces": [
  6004. "application/json"
  6005. ],
  6006. "tags": [
  6007. "issue"
  6008. ],
  6009. "summary": "Get a milestone",
  6010. "operationId": "issueGetMilestone",
  6011. "parameters": [
  6012. {
  6013. "type": "string",
  6014. "description": "owner of the repo",
  6015. "name": "owner",
  6016. "in": "path",
  6017. "required": true
  6018. },
  6019. {
  6020. "type": "string",
  6021. "description": "name of the repo",
  6022. "name": "repo",
  6023. "in": "path",
  6024. "required": true
  6025. },
  6026. {
  6027. "type": "integer",
  6028. "format": "int64",
  6029. "description": "id of the milestone",
  6030. "name": "id",
  6031. "in": "path",
  6032. "required": true
  6033. }
  6034. ],
  6035. "responses": {
  6036. "200": {
  6037. "$ref": "#/responses/Milestone"
  6038. }
  6039. }
  6040. },
  6041. "delete": {
  6042. "tags": [
  6043. "issue"
  6044. ],
  6045. "summary": "Delete a milestone",
  6046. "operationId": "issueDeleteMilestone",
  6047. "parameters": [
  6048. {
  6049. "type": "string",
  6050. "description": "owner of the repo",
  6051. "name": "owner",
  6052. "in": "path",
  6053. "required": true
  6054. },
  6055. {
  6056. "type": "string",
  6057. "description": "name of the repo",
  6058. "name": "repo",
  6059. "in": "path",
  6060. "required": true
  6061. },
  6062. {
  6063. "type": "integer",
  6064. "format": "int64",
  6065. "description": "id of the milestone to delete",
  6066. "name": "id",
  6067. "in": "path",
  6068. "required": true
  6069. }
  6070. ],
  6071. "responses": {
  6072. "204": {
  6073. "$ref": "#/responses/empty"
  6074. }
  6075. }
  6076. },
  6077. "patch": {
  6078. "consumes": [
  6079. "application/json"
  6080. ],
  6081. "produces": [
  6082. "application/json"
  6083. ],
  6084. "tags": [
  6085. "issue"
  6086. ],
  6087. "summary": "Update a milestone",
  6088. "operationId": "issueEditMilestone",
  6089. "parameters": [
  6090. {
  6091. "type": "string",
  6092. "description": "owner of the repo",
  6093. "name": "owner",
  6094. "in": "path",
  6095. "required": true
  6096. },
  6097. {
  6098. "type": "string",
  6099. "description": "name of the repo",
  6100. "name": "repo",
  6101. "in": "path",
  6102. "required": true
  6103. },
  6104. {
  6105. "type": "integer",
  6106. "format": "int64",
  6107. "description": "id of the milestone",
  6108. "name": "id",
  6109. "in": "path",
  6110. "required": true
  6111. },
  6112. {
  6113. "name": "body",
  6114. "in": "body",
  6115. "schema": {
  6116. "$ref": "#/definitions/EditMilestoneOption"
  6117. }
  6118. }
  6119. ],
  6120. "responses": {
  6121. "200": {
  6122. "$ref": "#/responses/Milestone"
  6123. }
  6124. }
  6125. }
  6126. },
  6127. "/repos/{owner}/{repo}/mirror-sync": {
  6128. "post": {
  6129. "produces": [
  6130. "application/json"
  6131. ],
  6132. "tags": [
  6133. "repository"
  6134. ],
  6135. "summary": "Sync a mirrored repository",
  6136. "operationId": "repoMirrorSync",
  6137. "parameters": [
  6138. {
  6139. "type": "string",
  6140. "description": "owner of the repo to sync",
  6141. "name": "owner",
  6142. "in": "path",
  6143. "required": true
  6144. },
  6145. {
  6146. "type": "string",
  6147. "description": "name of the repo to sync",
  6148. "name": "repo",
  6149. "in": "path",
  6150. "required": true
  6151. }
  6152. ],
  6153. "responses": {
  6154. "200": {
  6155. "$ref": "#/responses/empty"
  6156. },
  6157. "403": {
  6158. "$ref": "#/responses/forbidden"
  6159. }
  6160. }
  6161. }
  6162. },
  6163. "/repos/{owner}/{repo}/notifications": {
  6164. "get": {
  6165. "consumes": [
  6166. "application/json"
  6167. ],
  6168. "produces": [
  6169. "application/json"
  6170. ],
  6171. "tags": [
  6172. "notification"
  6173. ],
  6174. "summary": "List users's notification threads on a specific repo",
  6175. "operationId": "notifyGetRepoList",
  6176. "parameters": [
  6177. {
  6178. "type": "string",
  6179. "description": "owner of the repo",
  6180. "name": "owner",
  6181. "in": "path",
  6182. "required": true
  6183. },
  6184. {
  6185. "type": "string",
  6186. "description": "name of the repo",
  6187. "name": "repo",
  6188. "in": "path",
  6189. "required": true
  6190. },
  6191. {
  6192. "type": "string",
  6193. "description": "If true, show notifications marked as read. Default value is false",
  6194. "name": "all",
  6195. "in": "query"
  6196. },
  6197. {
  6198. "type": "string",
  6199. "format": "date-time",
  6200. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  6201. "name": "since",
  6202. "in": "query"
  6203. },
  6204. {
  6205. "type": "string",
  6206. "format": "date-time",
  6207. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  6208. "name": "before",
  6209. "in": "query"
  6210. },
  6211. {
  6212. "type": "integer",
  6213. "description": "page number of results to return (1-based)",
  6214. "name": "page",
  6215. "in": "query"
  6216. },
  6217. {
  6218. "type": "integer",
  6219. "description": "page size of results, maximum page size is 50",
  6220. "name": "limit",
  6221. "in": "query"
  6222. }
  6223. ],
  6224. "responses": {
  6225. "200": {
  6226. "$ref": "#/responses/NotificationThreadList"
  6227. }
  6228. }
  6229. },
  6230. "put": {
  6231. "consumes": [
  6232. "application/json"
  6233. ],
  6234. "produces": [
  6235. "application/json"
  6236. ],
  6237. "tags": [
  6238. "notification"
  6239. ],
  6240. "summary": "Mark notification threads as read on a specific repo",
  6241. "operationId": "notifyReadRepoList",
  6242. "parameters": [
  6243. {
  6244. "type": "string",
  6245. "description": "owner of the repo",
  6246. "name": "owner",
  6247. "in": "path",
  6248. "required": true
  6249. },
  6250. {
  6251. "type": "string",
  6252. "description": "name of the repo",
  6253. "name": "repo",
  6254. "in": "path",
  6255. "required": true
  6256. },
  6257. {
  6258. "type": "string",
  6259. "format": "date-time",
  6260. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  6261. "name": "last_read_at",
  6262. "in": "query"
  6263. }
  6264. ],
  6265. "responses": {
  6266. "205": {
  6267. "$ref": "#/responses/empty"
  6268. }
  6269. }
  6270. }
  6271. },
  6272. "/repos/{owner}/{repo}/pulls": {
  6273. "get": {
  6274. "produces": [
  6275. "application/json"
  6276. ],
  6277. "tags": [
  6278. "repository"
  6279. ],
  6280. "summary": "List a repo's pull requests",
  6281. "operationId": "repoListPullRequests",
  6282. "parameters": [
  6283. {
  6284. "type": "string",
  6285. "description": "owner of the repo",
  6286. "name": "owner",
  6287. "in": "path",
  6288. "required": true
  6289. },
  6290. {
  6291. "type": "string",
  6292. "description": "name of the repo",
  6293. "name": "repo",
  6294. "in": "path",
  6295. "required": true
  6296. },
  6297. {
  6298. "enum": [
  6299. "closed",
  6300. "open",
  6301. "all"
  6302. ],
  6303. "type": "string",
  6304. "description": "State of pull request: open or closed (optional)",
  6305. "name": "state",
  6306. "in": "query"
  6307. },
  6308. {
  6309. "enum": [
  6310. "oldest",
  6311. "recentupdate",
  6312. "leastupdate",
  6313. "mostcomment",
  6314. "leastcomment",
  6315. "priority"
  6316. ],
  6317. "type": "string",
  6318. "description": "Type of sort",
  6319. "name": "sort",
  6320. "in": "query"
  6321. },
  6322. {
  6323. "type": "integer",
  6324. "format": "int64",
  6325. "description": "ID of the milestone",
  6326. "name": "milestone",
  6327. "in": "query"
  6328. },
  6329. {
  6330. "type": "array",
  6331. "items": {
  6332. "type": "integer",
  6333. "format": "int64"
  6334. },
  6335. "collectionFormat": "multi",
  6336. "description": "Label IDs",
  6337. "name": "labels",
  6338. "in": "query"
  6339. },
  6340. {
  6341. "type": "integer",
  6342. "description": "page number of results to return (1-based)",
  6343. "name": "page",
  6344. "in": "query"
  6345. },
  6346. {
  6347. "type": "integer",
  6348. "description": "page size of results, maximum page size is 50",
  6349. "name": "limit",
  6350. "in": "query"
  6351. }
  6352. ],
  6353. "responses": {
  6354. "200": {
  6355. "$ref": "#/responses/PullRequestList"
  6356. }
  6357. }
  6358. },
  6359. "post": {
  6360. "consumes": [
  6361. "application/json"
  6362. ],
  6363. "produces": [
  6364. "application/json"
  6365. ],
  6366. "tags": [
  6367. "repository"
  6368. ],
  6369. "summary": "Create a pull request",
  6370. "operationId": "repoCreatePullRequest",
  6371. "parameters": [
  6372. {
  6373. "type": "string",
  6374. "description": "owner of the repo",
  6375. "name": "owner",
  6376. "in": "path",
  6377. "required": true
  6378. },
  6379. {
  6380. "type": "string",
  6381. "description": "name of the repo",
  6382. "name": "repo",
  6383. "in": "path",
  6384. "required": true
  6385. },
  6386. {
  6387. "name": "body",
  6388. "in": "body",
  6389. "schema": {
  6390. "$ref": "#/definitions/CreatePullRequestOption"
  6391. }
  6392. }
  6393. ],
  6394. "responses": {
  6395. "201": {
  6396. "$ref": "#/responses/PullRequest"
  6397. },
  6398. "409": {
  6399. "$ref": "#/responses/error"
  6400. },
  6401. "422": {
  6402. "$ref": "#/responses/validationError"
  6403. }
  6404. }
  6405. }
  6406. },
  6407. "/repos/{owner}/{repo}/pulls/{index}": {
  6408. "get": {
  6409. "produces": [
  6410. "application/json"
  6411. ],
  6412. "tags": [
  6413. "repository"
  6414. ],
  6415. "summary": "Get a pull request",
  6416. "operationId": "repoGetPullRequest",
  6417. "parameters": [
  6418. {
  6419. "type": "string",
  6420. "description": "owner of the repo",
  6421. "name": "owner",
  6422. "in": "path",
  6423. "required": true
  6424. },
  6425. {
  6426. "type": "string",
  6427. "description": "name of the repo",
  6428. "name": "repo",
  6429. "in": "path",
  6430. "required": true
  6431. },
  6432. {
  6433. "type": "integer",
  6434. "format": "int64",
  6435. "description": "index of the pull request to get",
  6436. "name": "index",
  6437. "in": "path",
  6438. "required": true
  6439. }
  6440. ],
  6441. "responses": {
  6442. "200": {
  6443. "$ref": "#/responses/PullRequest"
  6444. },
  6445. "404": {
  6446. "$ref": "#/responses/notFound"
  6447. }
  6448. }
  6449. },
  6450. "patch": {
  6451. "consumes": [
  6452. "application/json"
  6453. ],
  6454. "produces": [
  6455. "application/json"
  6456. ],
  6457. "tags": [
  6458. "repository"
  6459. ],
  6460. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6461. "operationId": "repoEditPullRequest",
  6462. "parameters": [
  6463. {
  6464. "type": "string",
  6465. "description": "owner of the repo",
  6466. "name": "owner",
  6467. "in": "path",
  6468. "required": true
  6469. },
  6470. {
  6471. "type": "string",
  6472. "description": "name of the repo",
  6473. "name": "repo",
  6474. "in": "path",
  6475. "required": true
  6476. },
  6477. {
  6478. "type": "integer",
  6479. "format": "int64",
  6480. "description": "index of the pull request to edit",
  6481. "name": "index",
  6482. "in": "path",
  6483. "required": true
  6484. },
  6485. {
  6486. "name": "body",
  6487. "in": "body",
  6488. "schema": {
  6489. "$ref": "#/definitions/EditPullRequestOption"
  6490. }
  6491. }
  6492. ],
  6493. "responses": {
  6494. "201": {
  6495. "$ref": "#/responses/PullRequest"
  6496. },
  6497. "403": {
  6498. "$ref": "#/responses/forbidden"
  6499. },
  6500. "412": {
  6501. "$ref": "#/responses/error"
  6502. },
  6503. "422": {
  6504. "$ref": "#/responses/validationError"
  6505. }
  6506. }
  6507. }
  6508. },
  6509. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6510. "get": {
  6511. "produces": [
  6512. "application/json"
  6513. ],
  6514. "tags": [
  6515. "repository"
  6516. ],
  6517. "summary": "Check if a pull request has been merged",
  6518. "operationId": "repoPullRequestIsMerged",
  6519. "parameters": [
  6520. {
  6521. "type": "string",
  6522. "description": "owner of the repo",
  6523. "name": "owner",
  6524. "in": "path",
  6525. "required": true
  6526. },
  6527. {
  6528. "type": "string",
  6529. "description": "name of the repo",
  6530. "name": "repo",
  6531. "in": "path",
  6532. "required": true
  6533. },
  6534. {
  6535. "type": "integer",
  6536. "format": "int64",
  6537. "description": "index of the pull request",
  6538. "name": "index",
  6539. "in": "path",
  6540. "required": true
  6541. }
  6542. ],
  6543. "responses": {
  6544. "204": {
  6545. "description": "pull request has been merged"
  6546. },
  6547. "404": {
  6548. "description": "pull request has not been merged"
  6549. }
  6550. }
  6551. },
  6552. "post": {
  6553. "produces": [
  6554. "application/json"
  6555. ],
  6556. "tags": [
  6557. "repository"
  6558. ],
  6559. "summary": "Merge a pull request",
  6560. "operationId": "repoMergePullRequest",
  6561. "parameters": [
  6562. {
  6563. "type": "string",
  6564. "description": "owner of the repo",
  6565. "name": "owner",
  6566. "in": "path",
  6567. "required": true
  6568. },
  6569. {
  6570. "type": "string",
  6571. "description": "name of the repo",
  6572. "name": "repo",
  6573. "in": "path",
  6574. "required": true
  6575. },
  6576. {
  6577. "type": "integer",
  6578. "format": "int64",
  6579. "description": "index of the pull request to merge",
  6580. "name": "index",
  6581. "in": "path",
  6582. "required": true
  6583. },
  6584. {
  6585. "name": "body",
  6586. "in": "body",
  6587. "schema": {
  6588. "$ref": "#/definitions/MergePullRequestOption"
  6589. }
  6590. }
  6591. ],
  6592. "responses": {
  6593. "200": {
  6594. "$ref": "#/responses/empty"
  6595. },
  6596. "405": {
  6597. "$ref": "#/responses/empty"
  6598. },
  6599. "409": {
  6600. "$ref": "#/responses/error"
  6601. }
  6602. }
  6603. }
  6604. },
  6605. "/repos/{owner}/{repo}/raw/{filepath}": {
  6606. "get": {
  6607. "produces": [
  6608. "application/json"
  6609. ],
  6610. "tags": [
  6611. "repository"
  6612. ],
  6613. "summary": "Get a file from a repository",
  6614. "operationId": "repoGetRawFile",
  6615. "parameters": [
  6616. {
  6617. "type": "string",
  6618. "description": "owner of the repo",
  6619. "name": "owner",
  6620. "in": "path",
  6621. "required": true
  6622. },
  6623. {
  6624. "type": "string",
  6625. "description": "name of the repo",
  6626. "name": "repo",
  6627. "in": "path",
  6628. "required": true
  6629. },
  6630. {
  6631. "type": "string",
  6632. "description": "filepath of the file to get",
  6633. "name": "filepath",
  6634. "in": "path",
  6635. "required": true
  6636. }
  6637. ],
  6638. "responses": {
  6639. "200": {
  6640. "description": "success"
  6641. },
  6642. "404": {
  6643. "$ref": "#/responses/notFound"
  6644. }
  6645. }
  6646. }
  6647. },
  6648. "/repos/{owner}/{repo}/releases": {
  6649. "get": {
  6650. "produces": [
  6651. "application/json"
  6652. ],
  6653. "tags": [
  6654. "repository"
  6655. ],
  6656. "summary": "List a repo's releases",
  6657. "operationId": "repoListReleases",
  6658. "parameters": [
  6659. {
  6660. "type": "string",
  6661. "description": "owner of the repo",
  6662. "name": "owner",
  6663. "in": "path",
  6664. "required": true
  6665. },
  6666. {
  6667. "type": "string",
  6668. "description": "name of the repo",
  6669. "name": "repo",
  6670. "in": "path",
  6671. "required": true
  6672. },
  6673. {
  6674. "type": "integer",
  6675. "description": "items count every page wants to load",
  6676. "name": "per_page",
  6677. "in": "query"
  6678. },
  6679. {
  6680. "type": "integer",
  6681. "description": "page number of results to return (1-based)",
  6682. "name": "page",
  6683. "in": "query"
  6684. },
  6685. {
  6686. "type": "integer",
  6687. "description": "page size of results, maximum page size is 50",
  6688. "name": "limit",
  6689. "in": "query"
  6690. }
  6691. ],
  6692. "responses": {
  6693. "200": {
  6694. "$ref": "#/responses/ReleaseList"
  6695. }
  6696. }
  6697. },
  6698. "post": {
  6699. "consumes": [
  6700. "application/json"
  6701. ],
  6702. "produces": [
  6703. "application/json"
  6704. ],
  6705. "tags": [
  6706. "repository"
  6707. ],
  6708. "summary": "Create a release",
  6709. "operationId": "repoCreateRelease",
  6710. "parameters": [
  6711. {
  6712. "type": "string",
  6713. "description": "owner of the repo",
  6714. "name": "owner",
  6715. "in": "path",
  6716. "required": true
  6717. },
  6718. {
  6719. "type": "string",
  6720. "description": "name of the repo",
  6721. "name": "repo",
  6722. "in": "path",
  6723. "required": true
  6724. },
  6725. {
  6726. "name": "body",
  6727. "in": "body",
  6728. "schema": {
  6729. "$ref": "#/definitions/CreateReleaseOption"
  6730. }
  6731. }
  6732. ],
  6733. "responses": {
  6734. "201": {
  6735. "$ref": "#/responses/Release"
  6736. },
  6737. "409": {
  6738. "$ref": "#/responses/error"
  6739. }
  6740. }
  6741. }
  6742. },
  6743. "/repos/{owner}/{repo}/releases/{id}": {
  6744. "get": {
  6745. "produces": [
  6746. "application/json"
  6747. ],
  6748. "tags": [
  6749. "repository"
  6750. ],
  6751. "summary": "Get a release",
  6752. "operationId": "repoGetRelease",
  6753. "parameters": [
  6754. {
  6755. "type": "string",
  6756. "description": "owner of the repo",
  6757. "name": "owner",
  6758. "in": "path",
  6759. "required": true
  6760. },
  6761. {
  6762. "type": "string",
  6763. "description": "name of the repo",
  6764. "name": "repo",
  6765. "in": "path",
  6766. "required": true
  6767. },
  6768. {
  6769. "type": "integer",
  6770. "format": "int64",
  6771. "description": "id of the release to get",
  6772. "name": "id",
  6773. "in": "path",
  6774. "required": true
  6775. }
  6776. ],
  6777. "responses": {
  6778. "200": {
  6779. "$ref": "#/responses/Release"
  6780. }
  6781. }
  6782. },
  6783. "delete": {
  6784. "tags": [
  6785. "repository"
  6786. ],
  6787. "summary": "Delete a release",
  6788. "operationId": "repoDeleteRelease",
  6789. "parameters": [
  6790. {
  6791. "type": "string",
  6792. "description": "owner of the repo",
  6793. "name": "owner",
  6794. "in": "path",
  6795. "required": true
  6796. },
  6797. {
  6798. "type": "string",
  6799. "description": "name of the repo",
  6800. "name": "repo",
  6801. "in": "path",
  6802. "required": true
  6803. },
  6804. {
  6805. "type": "integer",
  6806. "format": "int64",
  6807. "description": "id of the release to delete",
  6808. "name": "id",
  6809. "in": "path",
  6810. "required": true
  6811. }
  6812. ],
  6813. "responses": {
  6814. "204": {
  6815. "$ref": "#/responses/empty"
  6816. }
  6817. }
  6818. },
  6819. "patch": {
  6820. "consumes": [
  6821. "application/json"
  6822. ],
  6823. "produces": [
  6824. "application/json"
  6825. ],
  6826. "tags": [
  6827. "repository"
  6828. ],
  6829. "summary": "Update a release",
  6830. "operationId": "repoEditRelease",
  6831. "parameters": [
  6832. {
  6833. "type": "string",
  6834. "description": "owner of the repo",
  6835. "name": "owner",
  6836. "in": "path",
  6837. "required": true
  6838. },
  6839. {
  6840. "type": "string",
  6841. "description": "name of the repo",
  6842. "name": "repo",
  6843. "in": "path",
  6844. "required": true
  6845. },
  6846. {
  6847. "type": "integer",
  6848. "format": "int64",
  6849. "description": "id of the release to edit",
  6850. "name": "id",
  6851. "in": "path",
  6852. "required": true
  6853. },
  6854. {
  6855. "name": "body",
  6856. "in": "body",
  6857. "schema": {
  6858. "$ref": "#/definitions/EditReleaseOption"
  6859. }
  6860. }
  6861. ],
  6862. "responses": {
  6863. "200": {
  6864. "$ref": "#/responses/Release"
  6865. }
  6866. }
  6867. }
  6868. },
  6869. "/repos/{owner}/{repo}/releases/{id}/assets": {
  6870. "get": {
  6871. "produces": [
  6872. "application/json"
  6873. ],
  6874. "tags": [
  6875. "repository"
  6876. ],
  6877. "summary": "List release's attachments",
  6878. "operationId": "repoListReleaseAttachments",
  6879. "parameters": [
  6880. {
  6881. "type": "string",
  6882. "description": "owner of the repo",
  6883. "name": "owner",
  6884. "in": "path",
  6885. "required": true
  6886. },
  6887. {
  6888. "type": "string",
  6889. "description": "name of the repo",
  6890. "name": "repo",
  6891. "in": "path",
  6892. "required": true
  6893. },
  6894. {
  6895. "type": "integer",
  6896. "format": "int64",
  6897. "description": "id of the release",
  6898. "name": "id",
  6899. "in": "path",
  6900. "required": true
  6901. }
  6902. ],
  6903. "responses": {
  6904. "200": {
  6905. "$ref": "#/responses/AttachmentList"
  6906. }
  6907. }
  6908. },
  6909. "post": {
  6910. "consumes": [
  6911. "multipart/form-data"
  6912. ],
  6913. "produces": [
  6914. "application/json"
  6915. ],
  6916. "tags": [
  6917. "repository"
  6918. ],
  6919. "summary": "Create a release attachment",
  6920. "operationId": "repoCreateReleaseAttachment",
  6921. "parameters": [
  6922. {
  6923. "type": "string",
  6924. "description": "owner of the repo",
  6925. "name": "owner",
  6926. "in": "path",
  6927. "required": true
  6928. },
  6929. {
  6930. "type": "string",
  6931. "description": "name of the repo",
  6932. "name": "repo",
  6933. "in": "path",
  6934. "required": true
  6935. },
  6936. {
  6937. "type": "integer",
  6938. "format": "int64",
  6939. "description": "id of the release",
  6940. "name": "id",
  6941. "in": "path",
  6942. "required": true
  6943. },
  6944. {
  6945. "type": "string",
  6946. "description": "name of the attachment",
  6947. "name": "name",
  6948. "in": "query"
  6949. },
  6950. {
  6951. "type": "file",
  6952. "description": "attachment to upload",
  6953. "name": "attachment",
  6954. "in": "formData",
  6955. "required": true
  6956. }
  6957. ],
  6958. "responses": {
  6959. "201": {
  6960. "$ref": "#/responses/Attachment"
  6961. },
  6962. "400": {
  6963. "$ref": "#/responses/error"
  6964. }
  6965. }
  6966. }
  6967. },
  6968. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  6969. "get": {
  6970. "produces": [
  6971. "application/json"
  6972. ],
  6973. "tags": [
  6974. "repository"
  6975. ],
  6976. "summary": "Get a release attachment",
  6977. "operationId": "repoGetReleaseAttachment",
  6978. "parameters": [
  6979. {
  6980. "type": "string",
  6981. "description": "owner of the repo",
  6982. "name": "owner",
  6983. "in": "path",
  6984. "required": true
  6985. },
  6986. {
  6987. "type": "string",
  6988. "description": "name of the repo",
  6989. "name": "repo",
  6990. "in": "path",
  6991. "required": true
  6992. },
  6993. {
  6994. "type": "integer",
  6995. "format": "int64",
  6996. "description": "id of the release",
  6997. "name": "id",
  6998. "in": "path",
  6999. "required": true
  7000. },
  7001. {
  7002. "type": "integer",
  7003. "format": "int64",
  7004. "description": "id of the attachment to get",
  7005. "name": "attachment_id",
  7006. "in": "path",
  7007. "required": true
  7008. }
  7009. ],
  7010. "responses": {
  7011. "200": {
  7012. "$ref": "#/responses/Attachment"
  7013. }
  7014. }
  7015. },
  7016. "delete": {
  7017. "produces": [
  7018. "application/json"
  7019. ],
  7020. "tags": [
  7021. "repository"
  7022. ],
  7023. "summary": "Delete a release attachment",
  7024. "operationId": "repoDeleteReleaseAttachment",
  7025. "parameters": [
  7026. {
  7027. "type": "string",
  7028. "description": "owner of the repo",
  7029. "name": "owner",
  7030. "in": "path",
  7031. "required": true
  7032. },
  7033. {
  7034. "type": "string",
  7035. "description": "name of the repo",
  7036. "name": "repo",
  7037. "in": "path",
  7038. "required": true
  7039. },
  7040. {
  7041. "type": "integer",
  7042. "format": "int64",
  7043. "description": "id of the release",
  7044. "name": "id",
  7045. "in": "path",
  7046. "required": true
  7047. },
  7048. {
  7049. "type": "integer",
  7050. "format": "int64",
  7051. "description": "id of the attachment to delete",
  7052. "name": "attachment_id",
  7053. "in": "path",
  7054. "required": true
  7055. }
  7056. ],
  7057. "responses": {
  7058. "204": {
  7059. "$ref": "#/responses/empty"
  7060. }
  7061. }
  7062. },
  7063. "patch": {
  7064. "consumes": [
  7065. "application/json"
  7066. ],
  7067. "produces": [
  7068. "application/json"
  7069. ],
  7070. "tags": [
  7071. "repository"
  7072. ],
  7073. "summary": "Edit a release attachment",
  7074. "operationId": "repoEditReleaseAttachment",
  7075. "parameters": [
  7076. {
  7077. "type": "string",
  7078. "description": "owner of the repo",
  7079. "name": "owner",
  7080. "in": "path",
  7081. "required": true
  7082. },
  7083. {
  7084. "type": "string",
  7085. "description": "name of the repo",
  7086. "name": "repo",
  7087. "in": "path",
  7088. "required": true
  7089. },
  7090. {
  7091. "type": "integer",
  7092. "format": "int64",
  7093. "description": "id of the release",
  7094. "name": "id",
  7095. "in": "path",
  7096. "required": true
  7097. },
  7098. {
  7099. "type": "integer",
  7100. "format": "int64",
  7101. "description": "id of the attachment to edit",
  7102. "name": "attachment_id",
  7103. "in": "path",
  7104. "required": true
  7105. },
  7106. {
  7107. "name": "body",
  7108. "in": "body",
  7109. "schema": {
  7110. "$ref": "#/definitions/EditAttachmentOptions"
  7111. }
  7112. }
  7113. ],
  7114. "responses": {
  7115. "201": {
  7116. "$ref": "#/responses/Attachment"
  7117. }
  7118. }
  7119. }
  7120. },
  7121. "/repos/{owner}/{repo}/signing-key.gpg": {
  7122. "get": {
  7123. "produces": [
  7124. "text/plain"
  7125. ],
  7126. "tags": [
  7127. "repository"
  7128. ],
  7129. "summary": "Get signing-key.gpg for given repository",
  7130. "operationId": "repoSigningKey",
  7131. "parameters": [
  7132. {
  7133. "type": "string",
  7134. "description": "owner of the repo",
  7135. "name": "owner",
  7136. "in": "path",
  7137. "required": true
  7138. },
  7139. {
  7140. "type": "string",
  7141. "description": "name of the repo",
  7142. "name": "repo",
  7143. "in": "path",
  7144. "required": true
  7145. }
  7146. ],
  7147. "responses": {
  7148. "200": {
  7149. "description": "GPG armored public key",
  7150. "schema": {
  7151. "type": "string"
  7152. }
  7153. }
  7154. }
  7155. }
  7156. },
  7157. "/repos/{owner}/{repo}/stargazers": {
  7158. "get": {
  7159. "produces": [
  7160. "application/json"
  7161. ],
  7162. "tags": [
  7163. "repository"
  7164. ],
  7165. "summary": "List a repo's stargazers",
  7166. "operationId": "repoListStargazers",
  7167. "parameters": [
  7168. {
  7169. "type": "string",
  7170. "description": "owner of the repo",
  7171. "name": "owner",
  7172. "in": "path",
  7173. "required": true
  7174. },
  7175. {
  7176. "type": "string",
  7177. "description": "name of the repo",
  7178. "name": "repo",
  7179. "in": "path",
  7180. "required": true
  7181. },
  7182. {
  7183. "type": "integer",
  7184. "description": "page number of results to return (1-based)",
  7185. "name": "page",
  7186. "in": "query"
  7187. },
  7188. {
  7189. "type": "integer",
  7190. "description": "page size of results, maximum page size is 50",
  7191. "name": "limit",
  7192. "in": "query"
  7193. }
  7194. ],
  7195. "responses": {
  7196. "200": {
  7197. "$ref": "#/responses/UserList"
  7198. }
  7199. }
  7200. }
  7201. },
  7202. "/repos/{owner}/{repo}/statuses/{sha}": {
  7203. "get": {
  7204. "produces": [
  7205. "application/json"
  7206. ],
  7207. "tags": [
  7208. "repository"
  7209. ],
  7210. "summary": "Get a commit's statuses",
  7211. "operationId": "repoListStatuses",
  7212. "parameters": [
  7213. {
  7214. "type": "string",
  7215. "description": "owner of the repo",
  7216. "name": "owner",
  7217. "in": "path",
  7218. "required": true
  7219. },
  7220. {
  7221. "type": "string",
  7222. "description": "name of the repo",
  7223. "name": "repo",
  7224. "in": "path",
  7225. "required": true
  7226. },
  7227. {
  7228. "type": "string",
  7229. "description": "sha of the commit",
  7230. "name": "sha",
  7231. "in": "path",
  7232. "required": true
  7233. },
  7234. {
  7235. "enum": [
  7236. "oldest",
  7237. "recentupdate",
  7238. "leastupdate",
  7239. "leastindex",
  7240. "highestindex"
  7241. ],
  7242. "type": "string",
  7243. "description": "type of sort",
  7244. "name": "sort",
  7245. "in": "query"
  7246. },
  7247. {
  7248. "enum": [
  7249. "pending",
  7250. "success",
  7251. "error",
  7252. "failure",
  7253. "warning"
  7254. ],
  7255. "type": "string",
  7256. "description": "type of state",
  7257. "name": "state",
  7258. "in": "query"
  7259. },
  7260. {
  7261. "type": "integer",
  7262. "description": "page number of results to return (1-based)",
  7263. "name": "page",
  7264. "in": "query"
  7265. },
  7266. {
  7267. "type": "integer",
  7268. "description": "page size of results, maximum page size is 50",
  7269. "name": "limit",
  7270. "in": "query"
  7271. }
  7272. ],
  7273. "responses": {
  7274. "200": {
  7275. "$ref": "#/responses/StatusList"
  7276. },
  7277. "400": {
  7278. "$ref": "#/responses/error"
  7279. }
  7280. }
  7281. },
  7282. "post": {
  7283. "produces": [
  7284. "application/json"
  7285. ],
  7286. "tags": [
  7287. "repository"
  7288. ],
  7289. "summary": "Create a commit status",
  7290. "operationId": "repoCreateStatus",
  7291. "parameters": [
  7292. {
  7293. "type": "string",
  7294. "description": "owner of the repo",
  7295. "name": "owner",
  7296. "in": "path",
  7297. "required": true
  7298. },
  7299. {
  7300. "type": "string",
  7301. "description": "name of the repo",
  7302. "name": "repo",
  7303. "in": "path",
  7304. "required": true
  7305. },
  7306. {
  7307. "type": "string",
  7308. "description": "sha of the commit",
  7309. "name": "sha",
  7310. "in": "path",
  7311. "required": true
  7312. },
  7313. {
  7314. "name": "body",
  7315. "in": "body",
  7316. "schema": {
  7317. "$ref": "#/definitions/CreateStatusOption"
  7318. }
  7319. }
  7320. ],
  7321. "responses": {
  7322. "201": {
  7323. "$ref": "#/responses/Status"
  7324. },
  7325. "400": {
  7326. "$ref": "#/responses/error"
  7327. }
  7328. }
  7329. }
  7330. },
  7331. "/repos/{owner}/{repo}/subscribers": {
  7332. "get": {
  7333. "produces": [
  7334. "application/json"
  7335. ],
  7336. "tags": [
  7337. "repository"
  7338. ],
  7339. "summary": "List a repo's watchers",
  7340. "operationId": "repoListSubscribers",
  7341. "parameters": [
  7342. {
  7343. "type": "string",
  7344. "description": "owner of the repo",
  7345. "name": "owner",
  7346. "in": "path",
  7347. "required": true
  7348. },
  7349. {
  7350. "type": "string",
  7351. "description": "name of the repo",
  7352. "name": "repo",
  7353. "in": "path",
  7354. "required": true
  7355. },
  7356. {
  7357. "type": "integer",
  7358. "description": "page number of results to return (1-based)",
  7359. "name": "page",
  7360. "in": "query"
  7361. },
  7362. {
  7363. "type": "integer",
  7364. "description": "page size of results, maximum page size is 50",
  7365. "name": "limit",
  7366. "in": "query"
  7367. }
  7368. ],
  7369. "responses": {
  7370. "200": {
  7371. "$ref": "#/responses/UserList"
  7372. }
  7373. }
  7374. }
  7375. },
  7376. "/repos/{owner}/{repo}/subscription": {
  7377. "get": {
  7378. "tags": [
  7379. "repository"
  7380. ],
  7381. "summary": "Check if the current user is watching a repo",
  7382. "operationId": "userCurrentCheckSubscription",
  7383. "parameters": [
  7384. {
  7385. "type": "string",
  7386. "description": "owner of the repo",
  7387. "name": "owner",
  7388. "in": "path",
  7389. "required": true
  7390. },
  7391. {
  7392. "type": "string",
  7393. "description": "name of the repo",
  7394. "name": "repo",
  7395. "in": "path",
  7396. "required": true
  7397. }
  7398. ],
  7399. "responses": {
  7400. "200": {
  7401. "$ref": "#/responses/WatchInfo"
  7402. }
  7403. }
  7404. },
  7405. "put": {
  7406. "tags": [
  7407. "repository"
  7408. ],
  7409. "summary": "Watch a repo",
  7410. "operationId": "userCurrentPutSubscription",
  7411. "parameters": [
  7412. {
  7413. "type": "string",
  7414. "description": "owner of the repo",
  7415. "name": "owner",
  7416. "in": "path",
  7417. "required": true
  7418. },
  7419. {
  7420. "type": "string",
  7421. "description": "name of the repo",
  7422. "name": "repo",
  7423. "in": "path",
  7424. "required": true
  7425. }
  7426. ],
  7427. "responses": {
  7428. "200": {
  7429. "$ref": "#/responses/WatchInfo"
  7430. }
  7431. }
  7432. },
  7433. "delete": {
  7434. "tags": [
  7435. "repository"
  7436. ],
  7437. "summary": "Unwatch a repo",
  7438. "operationId": "userCurrentDeleteSubscription",
  7439. "parameters": [
  7440. {
  7441. "type": "string",
  7442. "description": "owner of the repo",
  7443. "name": "owner",
  7444. "in": "path",
  7445. "required": true
  7446. },
  7447. {
  7448. "type": "string",
  7449. "description": "name of the repo",
  7450. "name": "repo",
  7451. "in": "path",
  7452. "required": true
  7453. }
  7454. ],
  7455. "responses": {
  7456. "204": {
  7457. "$ref": "#/responses/empty"
  7458. }
  7459. }
  7460. }
  7461. },
  7462. "/repos/{owner}/{repo}/tags": {
  7463. "get": {
  7464. "produces": [
  7465. "application/json"
  7466. ],
  7467. "tags": [
  7468. "repository"
  7469. ],
  7470. "summary": "List a repository's tags",
  7471. "operationId": "repoListTags",
  7472. "parameters": [
  7473. {
  7474. "type": "string",
  7475. "description": "owner of the repo",
  7476. "name": "owner",
  7477. "in": "path",
  7478. "required": true
  7479. },
  7480. {
  7481. "type": "string",
  7482. "description": "name of the repo",
  7483. "name": "repo",
  7484. "in": "path",
  7485. "required": true
  7486. },
  7487. {
  7488. "type": "integer",
  7489. "description": "page number of results to return (1-based)",
  7490. "name": "page",
  7491. "in": "query"
  7492. },
  7493. {
  7494. "type": "integer",
  7495. "description": "page size of results, default maximum page size is 50",
  7496. "name": "limit",
  7497. "in": "query"
  7498. }
  7499. ],
  7500. "responses": {
  7501. "200": {
  7502. "$ref": "#/responses/TagList"
  7503. }
  7504. }
  7505. }
  7506. },
  7507. "/repos/{owner}/{repo}/times": {
  7508. "get": {
  7509. "produces": [
  7510. "application/json"
  7511. ],
  7512. "tags": [
  7513. "repository"
  7514. ],
  7515. "summary": "List a repo's tracked times",
  7516. "operationId": "repoTrackedTimes",
  7517. "parameters": [
  7518. {
  7519. "type": "string",
  7520. "description": "owner of the repo",
  7521. "name": "owner",
  7522. "in": "path",
  7523. "required": true
  7524. },
  7525. {
  7526. "type": "string",
  7527. "description": "name of the repo",
  7528. "name": "repo",
  7529. "in": "path",
  7530. "required": true
  7531. },
  7532. {
  7533. "type": "string",
  7534. "description": "optional filter by user",
  7535. "name": "user",
  7536. "in": "query"
  7537. },
  7538. {
  7539. "type": "string",
  7540. "format": "date-time",
  7541. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7542. "name": "since",
  7543. "in": "query"
  7544. },
  7545. {
  7546. "type": "string",
  7547. "format": "date-time",
  7548. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7549. "name": "before",
  7550. "in": "query"
  7551. },
  7552. {
  7553. "type": "integer",
  7554. "description": "page number of results to return (1-based)",
  7555. "name": "page",
  7556. "in": "query"
  7557. },
  7558. {
  7559. "type": "integer",
  7560. "description": "page size of results, maximum page size is 50",
  7561. "name": "limit",
  7562. "in": "query"
  7563. }
  7564. ],
  7565. "responses": {
  7566. "200": {
  7567. "$ref": "#/responses/TrackedTimeList"
  7568. },
  7569. "400": {
  7570. "$ref": "#/responses/error"
  7571. },
  7572. "403": {
  7573. "$ref": "#/responses/forbidden"
  7574. }
  7575. }
  7576. }
  7577. },
  7578. "/repos/{owner}/{repo}/times/{user}": {
  7579. "get": {
  7580. "produces": [
  7581. "application/json"
  7582. ],
  7583. "tags": [
  7584. "repository"
  7585. ],
  7586. "summary": "List a user's tracked times in a repo",
  7587. "operationId": "userTrackedTimes",
  7588. "deprecated": true,
  7589. "parameters": [
  7590. {
  7591. "type": "string",
  7592. "description": "owner of the repo",
  7593. "name": "owner",
  7594. "in": "path",
  7595. "required": true
  7596. },
  7597. {
  7598. "type": "string",
  7599. "description": "name of the repo",
  7600. "name": "repo",
  7601. "in": "path",
  7602. "required": true
  7603. },
  7604. {
  7605. "type": "string",
  7606. "description": "username of user",
  7607. "name": "user",
  7608. "in": "path",
  7609. "required": true
  7610. }
  7611. ],
  7612. "responses": {
  7613. "200": {
  7614. "$ref": "#/responses/TrackedTimeList"
  7615. },
  7616. "400": {
  7617. "$ref": "#/responses/error"
  7618. },
  7619. "403": {
  7620. "$ref": "#/responses/forbidden"
  7621. }
  7622. }
  7623. }
  7624. },
  7625. "/repos/{owner}/{repo}/topics": {
  7626. "get": {
  7627. "produces": [
  7628. "application/json"
  7629. ],
  7630. "tags": [
  7631. "repository"
  7632. ],
  7633. "summary": "Get list of topics that a repository has",
  7634. "operationId": "repoListTopics",
  7635. "parameters": [
  7636. {
  7637. "type": "string",
  7638. "description": "owner of the repo",
  7639. "name": "owner",
  7640. "in": "path",
  7641. "required": true
  7642. },
  7643. {
  7644. "type": "string",
  7645. "description": "name of the repo",
  7646. "name": "repo",
  7647. "in": "path",
  7648. "required": true
  7649. },
  7650. {
  7651. "type": "integer",
  7652. "description": "page number of results to return (1-based)",
  7653. "name": "page",
  7654. "in": "query"
  7655. },
  7656. {
  7657. "type": "integer",
  7658. "description": "page size of results, maximum page size is 50",
  7659. "name": "limit",
  7660. "in": "query"
  7661. }
  7662. ],
  7663. "responses": {
  7664. "200": {
  7665. "$ref": "#/responses/TopicNames"
  7666. }
  7667. }
  7668. },
  7669. "put": {
  7670. "produces": [
  7671. "application/json"
  7672. ],
  7673. "tags": [
  7674. "repository"
  7675. ],
  7676. "summary": "Replace list of topics for a repository",
  7677. "operationId": "repoUpdateTopics",
  7678. "parameters": [
  7679. {
  7680. "type": "string",
  7681. "description": "owner of the repo",
  7682. "name": "owner",
  7683. "in": "path",
  7684. "required": true
  7685. },
  7686. {
  7687. "type": "string",
  7688. "description": "name of the repo",
  7689. "name": "repo",
  7690. "in": "path",
  7691. "required": true
  7692. },
  7693. {
  7694. "name": "body",
  7695. "in": "body",
  7696. "schema": {
  7697. "$ref": "#/definitions/RepoTopicOptions"
  7698. }
  7699. }
  7700. ],
  7701. "responses": {
  7702. "204": {
  7703. "$ref": "#/responses/empty"
  7704. },
  7705. "422": {
  7706. "$ref": "#/responses/invalidTopicsError"
  7707. }
  7708. }
  7709. }
  7710. },
  7711. "/repos/{owner}/{repo}/topics/{topic}": {
  7712. "put": {
  7713. "produces": [
  7714. "application/json"
  7715. ],
  7716. "tags": [
  7717. "repository"
  7718. ],
  7719. "summary": "Add a topic to a repository",
  7720. "operationId": "repoAddTopíc",
  7721. "parameters": [
  7722. {
  7723. "type": "string",
  7724. "description": "owner of the repo",
  7725. "name": "owner",
  7726. "in": "path",
  7727. "required": true
  7728. },
  7729. {
  7730. "type": "string",
  7731. "description": "name of the repo",
  7732. "name": "repo",
  7733. "in": "path",
  7734. "required": true
  7735. },
  7736. {
  7737. "type": "string",
  7738. "description": "name of the topic to add",
  7739. "name": "topic",
  7740. "in": "path",
  7741. "required": true
  7742. }
  7743. ],
  7744. "responses": {
  7745. "204": {
  7746. "$ref": "#/responses/empty"
  7747. },
  7748. "422": {
  7749. "$ref": "#/responses/invalidTopicsError"
  7750. }
  7751. }
  7752. },
  7753. "delete": {
  7754. "produces": [
  7755. "application/json"
  7756. ],
  7757. "tags": [
  7758. "repository"
  7759. ],
  7760. "summary": "Delete a topic from a repository",
  7761. "operationId": "repoDeleteTopic",
  7762. "parameters": [
  7763. {
  7764. "type": "string",
  7765. "description": "owner of the repo",
  7766. "name": "owner",
  7767. "in": "path",
  7768. "required": true
  7769. },
  7770. {
  7771. "type": "string",
  7772. "description": "name of the repo",
  7773. "name": "repo",
  7774. "in": "path",
  7775. "required": true
  7776. },
  7777. {
  7778. "type": "string",
  7779. "description": "name of the topic to delete",
  7780. "name": "topic",
  7781. "in": "path",
  7782. "required": true
  7783. }
  7784. ],
  7785. "responses": {
  7786. "204": {
  7787. "$ref": "#/responses/empty"
  7788. },
  7789. "422": {
  7790. "$ref": "#/responses/invalidTopicsError"
  7791. }
  7792. }
  7793. }
  7794. },
  7795. "/repos/{owner}/{repo}/transfer": {
  7796. "post": {
  7797. "produces": [
  7798. "application/json"
  7799. ],
  7800. "tags": [
  7801. "repository"
  7802. ],
  7803. "summary": "Transfer a repo ownership",
  7804. "operationId": "repoTransfer",
  7805. "parameters": [
  7806. {
  7807. "type": "string",
  7808. "description": "owner of the repo to transfer",
  7809. "name": "owner",
  7810. "in": "path",
  7811. "required": true
  7812. },
  7813. {
  7814. "type": "string",
  7815. "description": "name of the repo to transfer",
  7816. "name": "repo",
  7817. "in": "path",
  7818. "required": true
  7819. },
  7820. {
  7821. "description": "Transfer Options",
  7822. "name": "body",
  7823. "in": "body",
  7824. "required": true,
  7825. "schema": {
  7826. "$ref": "#/definitions/TransferRepoOption"
  7827. }
  7828. }
  7829. ],
  7830. "responses": {
  7831. "202": {
  7832. "$ref": "#/responses/Repository"
  7833. },
  7834. "403": {
  7835. "$ref": "#/responses/forbidden"
  7836. },
  7837. "404": {
  7838. "$ref": "#/responses/notFound"
  7839. },
  7840. "422": {
  7841. "$ref": "#/responses/validationError"
  7842. }
  7843. }
  7844. }
  7845. },
  7846. "/repositories/{id}": {
  7847. "get": {
  7848. "produces": [
  7849. "application/json"
  7850. ],
  7851. "tags": [
  7852. "repository"
  7853. ],
  7854. "summary": "Get a repository by id",
  7855. "operationId": "repoGetByID",
  7856. "parameters": [
  7857. {
  7858. "type": "integer",
  7859. "format": "int64",
  7860. "description": "id of the repo to get",
  7861. "name": "id",
  7862. "in": "path",
  7863. "required": true
  7864. }
  7865. ],
  7866. "responses": {
  7867. "200": {
  7868. "$ref": "#/responses/Repository"
  7869. }
  7870. }
  7871. }
  7872. },
  7873. "/signing-key.gpg": {
  7874. "get": {
  7875. "produces": [
  7876. "text/plain"
  7877. ],
  7878. "tags": [
  7879. "miscellaneous"
  7880. ],
  7881. "summary": "Get default signing-key.gpg",
  7882. "operationId": "getSigningKey",
  7883. "responses": {
  7884. "200": {
  7885. "description": "GPG armored public key",
  7886. "schema": {
  7887. "type": "string"
  7888. }
  7889. }
  7890. }
  7891. }
  7892. },
  7893. "/teams/{id}": {
  7894. "get": {
  7895. "produces": [
  7896. "application/json"
  7897. ],
  7898. "tags": [
  7899. "organization"
  7900. ],
  7901. "summary": "Get a team",
  7902. "operationId": "orgGetTeam",
  7903. "parameters": [
  7904. {
  7905. "type": "integer",
  7906. "format": "int64",
  7907. "description": "id of the team to get",
  7908. "name": "id",
  7909. "in": "path",
  7910. "required": true
  7911. }
  7912. ],
  7913. "responses": {
  7914. "200": {
  7915. "$ref": "#/responses/Team"
  7916. }
  7917. }
  7918. },
  7919. "delete": {
  7920. "tags": [
  7921. "organization"
  7922. ],
  7923. "summary": "Delete a team",
  7924. "operationId": "orgDeleteTeam",
  7925. "parameters": [
  7926. {
  7927. "type": "integer",
  7928. "format": "int64",
  7929. "description": "id of the team to delete",
  7930. "name": "id",
  7931. "in": "path",
  7932. "required": true
  7933. }
  7934. ],
  7935. "responses": {
  7936. "204": {
  7937. "description": "team deleted"
  7938. }
  7939. }
  7940. },
  7941. "patch": {
  7942. "consumes": [
  7943. "application/json"
  7944. ],
  7945. "produces": [
  7946. "application/json"
  7947. ],
  7948. "tags": [
  7949. "organization"
  7950. ],
  7951. "summary": "Edit a team",
  7952. "operationId": "orgEditTeam",
  7953. "parameters": [
  7954. {
  7955. "type": "integer",
  7956. "description": "id of the team to edit",
  7957. "name": "id",
  7958. "in": "path",
  7959. "required": true
  7960. },
  7961. {
  7962. "name": "body",
  7963. "in": "body",
  7964. "schema": {
  7965. "$ref": "#/definitions/EditTeamOption"
  7966. }
  7967. }
  7968. ],
  7969. "responses": {
  7970. "200": {
  7971. "$ref": "#/responses/Team"
  7972. }
  7973. }
  7974. }
  7975. },
  7976. "/teams/{id}/members": {
  7977. "get": {
  7978. "produces": [
  7979. "application/json"
  7980. ],
  7981. "tags": [
  7982. "organization"
  7983. ],
  7984. "summary": "List a team's members",
  7985. "operationId": "orgListTeamMembers",
  7986. "parameters": [
  7987. {
  7988. "type": "integer",
  7989. "format": "int64",
  7990. "description": "id of the team",
  7991. "name": "id",
  7992. "in": "path",
  7993. "required": true
  7994. },
  7995. {
  7996. "type": "integer",
  7997. "description": "page number of results to return (1-based)",
  7998. "name": "page",
  7999. "in": "query"
  8000. },
  8001. {
  8002. "type": "integer",
  8003. "description": "page size of results, maximum page size is 50",
  8004. "name": "limit",
  8005. "in": "query"
  8006. }
  8007. ],
  8008. "responses": {
  8009. "200": {
  8010. "$ref": "#/responses/UserList"
  8011. }
  8012. }
  8013. }
  8014. },
  8015. "/teams/{id}/members/{username}": {
  8016. "get": {
  8017. "produces": [
  8018. "application/json"
  8019. ],
  8020. "tags": [
  8021. "organization"
  8022. ],
  8023. "summary": "List a particular member of team",
  8024. "operationId": "orgListTeamMember",
  8025. "parameters": [
  8026. {
  8027. "type": "integer",
  8028. "format": "int64",
  8029. "description": "id of the team",
  8030. "name": "id",
  8031. "in": "path",
  8032. "required": true
  8033. },
  8034. {
  8035. "type": "string",
  8036. "description": "username of the member to list",
  8037. "name": "username",
  8038. "in": "path",
  8039. "required": true
  8040. }
  8041. ],
  8042. "responses": {
  8043. "200": {
  8044. "$ref": "#/responses/User"
  8045. },
  8046. "404": {
  8047. "$ref": "#/responses/notFound"
  8048. }
  8049. }
  8050. },
  8051. "put": {
  8052. "produces": [
  8053. "application/json"
  8054. ],
  8055. "tags": [
  8056. "organization"
  8057. ],
  8058. "summary": "Add a team member",
  8059. "operationId": "orgAddTeamMember",
  8060. "parameters": [
  8061. {
  8062. "type": "integer",
  8063. "format": "int64",
  8064. "description": "id of the team",
  8065. "name": "id",
  8066. "in": "path",
  8067. "required": true
  8068. },
  8069. {
  8070. "type": "string",
  8071. "description": "username of the user to add",
  8072. "name": "username",
  8073. "in": "path",
  8074. "required": true
  8075. }
  8076. ],
  8077. "responses": {
  8078. "204": {
  8079. "$ref": "#/responses/empty"
  8080. },
  8081. "404": {
  8082. "$ref": "#/responses/notFound"
  8083. }
  8084. }
  8085. },
  8086. "delete": {
  8087. "produces": [
  8088. "application/json"
  8089. ],
  8090. "tags": [
  8091. "organization"
  8092. ],
  8093. "summary": "Remove a team member",
  8094. "operationId": "orgRemoveTeamMember",
  8095. "parameters": [
  8096. {
  8097. "type": "integer",
  8098. "format": "int64",
  8099. "description": "id of the team",
  8100. "name": "id",
  8101. "in": "path",
  8102. "required": true
  8103. },
  8104. {
  8105. "type": "string",
  8106. "description": "username of the user to remove",
  8107. "name": "username",
  8108. "in": "path",
  8109. "required": true
  8110. }
  8111. ],
  8112. "responses": {
  8113. "204": {
  8114. "$ref": "#/responses/empty"
  8115. },
  8116. "404": {
  8117. "$ref": "#/responses/notFound"
  8118. }
  8119. }
  8120. }
  8121. },
  8122. "/teams/{id}/repos": {
  8123. "get": {
  8124. "produces": [
  8125. "application/json"
  8126. ],
  8127. "tags": [
  8128. "organization"
  8129. ],
  8130. "summary": "List a team's repos",
  8131. "operationId": "orgListTeamRepos",
  8132. "parameters": [
  8133. {
  8134. "type": "integer",
  8135. "format": "int64",
  8136. "description": "id of the team",
  8137. "name": "id",
  8138. "in": "path",
  8139. "required": true
  8140. },
  8141. {
  8142. "type": "integer",
  8143. "description": "page number of results to return (1-based)",
  8144. "name": "page",
  8145. "in": "query"
  8146. },
  8147. {
  8148. "type": "integer",
  8149. "description": "page size of results, maximum page size is 50",
  8150. "name": "limit",
  8151. "in": "query"
  8152. }
  8153. ],
  8154. "responses": {
  8155. "200": {
  8156. "$ref": "#/responses/RepositoryList"
  8157. }
  8158. }
  8159. }
  8160. },
  8161. "/teams/{id}/repos/{org}/{repo}": {
  8162. "put": {
  8163. "produces": [
  8164. "application/json"
  8165. ],
  8166. "tags": [
  8167. "organization"
  8168. ],
  8169. "summary": "Add a repository to a team",
  8170. "operationId": "orgAddTeamRepository",
  8171. "parameters": [
  8172. {
  8173. "type": "integer",
  8174. "format": "int64",
  8175. "description": "id of the team",
  8176. "name": "id",
  8177. "in": "path",
  8178. "required": true
  8179. },
  8180. {
  8181. "type": "string",
  8182. "description": "organization that owns the repo to add",
  8183. "name": "org",
  8184. "in": "path",
  8185. "required": true
  8186. },
  8187. {
  8188. "type": "string",
  8189. "description": "name of the repo to add",
  8190. "name": "repo",
  8191. "in": "path",
  8192. "required": true
  8193. }
  8194. ],
  8195. "responses": {
  8196. "204": {
  8197. "$ref": "#/responses/empty"
  8198. },
  8199. "403": {
  8200. "$ref": "#/responses/forbidden"
  8201. }
  8202. }
  8203. },
  8204. "delete": {
  8205. "description": "This does not delete the repository, it only removes the repository from the team.",
  8206. "produces": [
  8207. "application/json"
  8208. ],
  8209. "tags": [
  8210. "organization"
  8211. ],
  8212. "summary": "Remove a repository from a team",
  8213. "operationId": "orgRemoveTeamRepository",
  8214. "parameters": [
  8215. {
  8216. "type": "integer",
  8217. "format": "int64",
  8218. "description": "id of the team",
  8219. "name": "id",
  8220. "in": "path",
  8221. "required": true
  8222. },
  8223. {
  8224. "type": "string",
  8225. "description": "organization that owns the repo to remove",
  8226. "name": "org",
  8227. "in": "path",
  8228. "required": true
  8229. },
  8230. {
  8231. "type": "string",
  8232. "description": "name of the repo to remove",
  8233. "name": "repo",
  8234. "in": "path",
  8235. "required": true
  8236. }
  8237. ],
  8238. "responses": {
  8239. "204": {
  8240. "$ref": "#/responses/empty"
  8241. },
  8242. "403": {
  8243. "$ref": "#/responses/forbidden"
  8244. }
  8245. }
  8246. }
  8247. },
  8248. "/topics/search": {
  8249. "get": {
  8250. "produces": [
  8251. "application/json"
  8252. ],
  8253. "tags": [
  8254. "repository"
  8255. ],
  8256. "summary": "search topics via keyword",
  8257. "operationId": "topicSearch",
  8258. "parameters": [
  8259. {
  8260. "type": "string",
  8261. "description": "keywords to search",
  8262. "name": "q",
  8263. "in": "query",
  8264. "required": true
  8265. },
  8266. {
  8267. "type": "integer",
  8268. "description": "page number of results to return (1-based)",
  8269. "name": "page",
  8270. "in": "query"
  8271. },
  8272. {
  8273. "type": "integer",
  8274. "description": "page size of results, maximum page size is 50",
  8275. "name": "limit",
  8276. "in": "query"
  8277. }
  8278. ],
  8279. "responses": {
  8280. "200": {
  8281. "$ref": "#/responses/TopicListResponse"
  8282. },
  8283. "403": {
  8284. "$ref": "#/responses/forbidden"
  8285. }
  8286. }
  8287. }
  8288. },
  8289. "/user": {
  8290. "get": {
  8291. "produces": [
  8292. "application/json"
  8293. ],
  8294. "tags": [
  8295. "user"
  8296. ],
  8297. "summary": "Get the authenticated user",
  8298. "operationId": "userGetCurrent",
  8299. "responses": {
  8300. "200": {
  8301. "$ref": "#/responses/User"
  8302. }
  8303. }
  8304. }
  8305. },
  8306. "/user/applications/oauth2": {
  8307. "get": {
  8308. "produces": [
  8309. "application/json"
  8310. ],
  8311. "tags": [
  8312. "user"
  8313. ],
  8314. "summary": "List the authenticated user's oauth2 applications",
  8315. "operationId": "userGetOauth2Application",
  8316. "parameters": [
  8317. {
  8318. "type": "integer",
  8319. "description": "page number of results to return (1-based)",
  8320. "name": "page",
  8321. "in": "query"
  8322. },
  8323. {
  8324. "type": "integer",
  8325. "description": "page size of results, maximum page size is 50",
  8326. "name": "limit",
  8327. "in": "query"
  8328. }
  8329. ],
  8330. "responses": {
  8331. "200": {
  8332. "$ref": "#/responses/OAuth2ApplicationList"
  8333. }
  8334. }
  8335. },
  8336. "post": {
  8337. "produces": [
  8338. "application/json"
  8339. ],
  8340. "tags": [
  8341. "user"
  8342. ],
  8343. "summary": "creates a new OAuth2 application",
  8344. "operationId": "userCreateOAuth2Application",
  8345. "parameters": [
  8346. {
  8347. "name": "body",
  8348. "in": "body",
  8349. "required": true,
  8350. "schema": {
  8351. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  8352. }
  8353. }
  8354. ],
  8355. "responses": {
  8356. "201": {
  8357. "$ref": "#/responses/OAuth2Application"
  8358. }
  8359. }
  8360. }
  8361. },
  8362. "/user/applications/oauth2/{id}": {
  8363. "delete": {
  8364. "produces": [
  8365. "application/json"
  8366. ],
  8367. "tags": [
  8368. "user"
  8369. ],
  8370. "summary": "delete an OAuth2 Application",
  8371. "operationId": "userDeleteOAuth2Application",
  8372. "parameters": [
  8373. {
  8374. "type": "integer",
  8375. "format": "int64",
  8376. "description": "token to be deleted",
  8377. "name": "id",
  8378. "in": "path",
  8379. "required": true
  8380. }
  8381. ],
  8382. "responses": {
  8383. "204": {
  8384. "$ref": "#/responses/empty"
  8385. }
  8386. }
  8387. }
  8388. },
  8389. "/user/emails": {
  8390. "get": {
  8391. "produces": [
  8392. "application/json"
  8393. ],
  8394. "tags": [
  8395. "user"
  8396. ],
  8397. "summary": "List the authenticated user's email addresses",
  8398. "operationId": "userListEmails",
  8399. "responses": {
  8400. "200": {
  8401. "$ref": "#/responses/EmailList"
  8402. }
  8403. }
  8404. },
  8405. "post": {
  8406. "produces": [
  8407. "application/json"
  8408. ],
  8409. "tags": [
  8410. "user"
  8411. ],
  8412. "summary": "Add email addresses",
  8413. "operationId": "userAddEmail",
  8414. "parameters": [
  8415. {
  8416. "name": "body",
  8417. "in": "body",
  8418. "schema": {
  8419. "$ref": "#/definitions/CreateEmailOption"
  8420. }
  8421. }
  8422. ],
  8423. "responses": {
  8424. "201": {
  8425. "$ref": "#/responses/EmailList"
  8426. },
  8427. "422": {
  8428. "$ref": "#/responses/validationError"
  8429. }
  8430. }
  8431. },
  8432. "delete": {
  8433. "produces": [
  8434. "application/json"
  8435. ],
  8436. "tags": [
  8437. "user"
  8438. ],
  8439. "summary": "Delete email addresses",
  8440. "operationId": "userDeleteEmail",
  8441. "parameters": [
  8442. {
  8443. "name": "body",
  8444. "in": "body",
  8445. "schema": {
  8446. "$ref": "#/definitions/DeleteEmailOption"
  8447. }
  8448. }
  8449. ],
  8450. "responses": {
  8451. "204": {
  8452. "$ref": "#/responses/empty"
  8453. }
  8454. }
  8455. }
  8456. },
  8457. "/user/followers": {
  8458. "get": {
  8459. "produces": [
  8460. "application/json"
  8461. ],
  8462. "tags": [
  8463. "user"
  8464. ],
  8465. "summary": "List the authenticated user's followers",
  8466. "operationId": "userCurrentListFollowers",
  8467. "parameters": [
  8468. {
  8469. "type": "integer",
  8470. "description": "page number of results to return (1-based)",
  8471. "name": "page",
  8472. "in": "query"
  8473. },
  8474. {
  8475. "type": "integer",
  8476. "description": "page size of results, maximum page size is 50",
  8477. "name": "limit",
  8478. "in": "query"
  8479. }
  8480. ],
  8481. "responses": {
  8482. "200": {
  8483. "$ref": "#/responses/UserList"
  8484. }
  8485. }
  8486. }
  8487. },
  8488. "/user/following": {
  8489. "get": {
  8490. "produces": [
  8491. "application/json"
  8492. ],
  8493. "tags": [
  8494. "user"
  8495. ],
  8496. "summary": "List the users that the authenticated user is following",
  8497. "operationId": "userCurrentListFollowing",
  8498. "parameters": [
  8499. {
  8500. "type": "integer",
  8501. "description": "page number of results to return (1-based)",
  8502. "name": "page",
  8503. "in": "query"
  8504. },
  8505. {
  8506. "type": "integer",
  8507. "description": "page size of results, maximum page size is 50",
  8508. "name": "limit",
  8509. "in": "query"
  8510. }
  8511. ],
  8512. "responses": {
  8513. "200": {
  8514. "$ref": "#/responses/UserList"
  8515. }
  8516. }
  8517. }
  8518. },
  8519. "/user/following/{username}": {
  8520. "get": {
  8521. "tags": [
  8522. "user"
  8523. ],
  8524. "summary": "Check whether a user is followed by the authenticated user",
  8525. "operationId": "userCurrentCheckFollowing",
  8526. "parameters": [
  8527. {
  8528. "type": "string",
  8529. "description": "username of followed user",
  8530. "name": "username",
  8531. "in": "path",
  8532. "required": true
  8533. }
  8534. ],
  8535. "responses": {
  8536. "204": {
  8537. "$ref": "#/responses/empty"
  8538. },
  8539. "404": {
  8540. "$ref": "#/responses/notFound"
  8541. }
  8542. }
  8543. },
  8544. "put": {
  8545. "tags": [
  8546. "user"
  8547. ],
  8548. "summary": "Follow a user",
  8549. "operationId": "userCurrentPutFollow",
  8550. "parameters": [
  8551. {
  8552. "type": "string",
  8553. "description": "username of user to follow",
  8554. "name": "username",
  8555. "in": "path",
  8556. "required": true
  8557. }
  8558. ],
  8559. "responses": {
  8560. "204": {
  8561. "$ref": "#/responses/empty"
  8562. }
  8563. }
  8564. },
  8565. "delete": {
  8566. "tags": [
  8567. "user"
  8568. ],
  8569. "summary": "Unfollow a user",
  8570. "operationId": "userCurrentDeleteFollow",
  8571. "parameters": [
  8572. {
  8573. "type": "string",
  8574. "description": "username of user to unfollow",
  8575. "name": "username",
  8576. "in": "path",
  8577. "required": true
  8578. }
  8579. ],
  8580. "responses": {
  8581. "204": {
  8582. "$ref": "#/responses/empty"
  8583. }
  8584. }
  8585. }
  8586. },
  8587. "/user/gpg_keys": {
  8588. "get": {
  8589. "produces": [
  8590. "application/json"
  8591. ],
  8592. "tags": [
  8593. "user"
  8594. ],
  8595. "summary": "List the authenticated user's GPG keys",
  8596. "operationId": "userCurrentListGPGKeys",
  8597. "parameters": [
  8598. {
  8599. "type": "integer",
  8600. "description": "page number of results to return (1-based)",
  8601. "name": "page",
  8602. "in": "query"
  8603. },
  8604. {
  8605. "type": "integer",
  8606. "description": "page size of results, maximum page size is 50",
  8607. "name": "limit",
  8608. "in": "query"
  8609. }
  8610. ],
  8611. "responses": {
  8612. "200": {
  8613. "$ref": "#/responses/GPGKeyList"
  8614. }
  8615. }
  8616. },
  8617. "post": {
  8618. "consumes": [
  8619. "application/json"
  8620. ],
  8621. "produces": [
  8622. "application/json"
  8623. ],
  8624. "tags": [
  8625. "user"
  8626. ],
  8627. "summary": "Create a GPG key",
  8628. "operationId": "userCurrentPostGPGKey",
  8629. "parameters": [
  8630. {
  8631. "name": "Form",
  8632. "in": "body",
  8633. "schema": {
  8634. "$ref": "#/definitions/CreateGPGKeyOption"
  8635. }
  8636. }
  8637. ],
  8638. "responses": {
  8639. "201": {
  8640. "$ref": "#/responses/GPGKey"
  8641. },
  8642. "422": {
  8643. "$ref": "#/responses/validationError"
  8644. }
  8645. }
  8646. }
  8647. },
  8648. "/user/gpg_keys/{id}": {
  8649. "get": {
  8650. "produces": [
  8651. "application/json"
  8652. ],
  8653. "tags": [
  8654. "user"
  8655. ],
  8656. "summary": "Get a GPG key",
  8657. "operationId": "userCurrentGetGPGKey",
  8658. "parameters": [
  8659. {
  8660. "type": "integer",
  8661. "format": "int64",
  8662. "description": "id of key to get",
  8663. "name": "id",
  8664. "in": "path",
  8665. "required": true
  8666. }
  8667. ],
  8668. "responses": {
  8669. "200": {
  8670. "$ref": "#/responses/GPGKey"
  8671. },
  8672. "404": {
  8673. "$ref": "#/responses/notFound"
  8674. }
  8675. }
  8676. },
  8677. "delete": {
  8678. "produces": [
  8679. "application/json"
  8680. ],
  8681. "tags": [
  8682. "user"
  8683. ],
  8684. "summary": "Remove a GPG key",
  8685. "operationId": "userCurrentDeleteGPGKey",
  8686. "parameters": [
  8687. {
  8688. "type": "integer",
  8689. "format": "int64",
  8690. "description": "id of key to delete",
  8691. "name": "id",
  8692. "in": "path",
  8693. "required": true
  8694. }
  8695. ],
  8696. "responses": {
  8697. "204": {
  8698. "$ref": "#/responses/empty"
  8699. },
  8700. "403": {
  8701. "$ref": "#/responses/forbidden"
  8702. }
  8703. }
  8704. }
  8705. },
  8706. "/user/keys": {
  8707. "get": {
  8708. "produces": [
  8709. "application/json"
  8710. ],
  8711. "tags": [
  8712. "user"
  8713. ],
  8714. "summary": "List the authenticated user's public keys",
  8715. "operationId": "userCurrentListKeys",
  8716. "parameters": [
  8717. {
  8718. "type": "string",
  8719. "description": "fingerprint of the key",
  8720. "name": "fingerprint",
  8721. "in": "query"
  8722. },
  8723. {
  8724. "type": "integer",
  8725. "description": "page number of results to return (1-based)",
  8726. "name": "page",
  8727. "in": "query"
  8728. },
  8729. {
  8730. "type": "integer",
  8731. "description": "page size of results, maximum page size is 50",
  8732. "name": "limit",
  8733. "in": "query"
  8734. }
  8735. ],
  8736. "responses": {
  8737. "200": {
  8738. "$ref": "#/responses/PublicKeyList"
  8739. }
  8740. }
  8741. },
  8742. "post": {
  8743. "consumes": [
  8744. "application/json"
  8745. ],
  8746. "produces": [
  8747. "application/json"
  8748. ],
  8749. "tags": [
  8750. "user"
  8751. ],
  8752. "summary": "Create a public key",
  8753. "operationId": "userCurrentPostKey",
  8754. "parameters": [
  8755. {
  8756. "name": "body",
  8757. "in": "body",
  8758. "schema": {
  8759. "$ref": "#/definitions/CreateKeyOption"
  8760. }
  8761. }
  8762. ],
  8763. "responses": {
  8764. "201": {
  8765. "$ref": "#/responses/PublicKey"
  8766. },
  8767. "422": {
  8768. "$ref": "#/responses/validationError"
  8769. }
  8770. }
  8771. }
  8772. },
  8773. "/user/keys/{id}": {
  8774. "get": {
  8775. "produces": [
  8776. "application/json"
  8777. ],
  8778. "tags": [
  8779. "user"
  8780. ],
  8781. "summary": "Get a public key",
  8782. "operationId": "userCurrentGetKey",
  8783. "parameters": [
  8784. {
  8785. "type": "integer",
  8786. "format": "int64",
  8787. "description": "id of key to get",
  8788. "name": "id",
  8789. "in": "path",
  8790. "required": true
  8791. }
  8792. ],
  8793. "responses": {
  8794. "200": {
  8795. "$ref": "#/responses/PublicKey"
  8796. },
  8797. "404": {
  8798. "$ref": "#/responses/notFound"
  8799. }
  8800. }
  8801. },
  8802. "delete": {
  8803. "produces": [
  8804. "application/json"
  8805. ],
  8806. "tags": [
  8807. "user"
  8808. ],
  8809. "summary": "Delete a public key",
  8810. "operationId": "userCurrentDeleteKey",
  8811. "parameters": [
  8812. {
  8813. "type": "integer",
  8814. "format": "int64",
  8815. "description": "id of key to delete",
  8816. "name": "id",
  8817. "in": "path",
  8818. "required": true
  8819. }
  8820. ],
  8821. "responses": {
  8822. "204": {
  8823. "$ref": "#/responses/empty"
  8824. },
  8825. "403": {
  8826. "$ref": "#/responses/forbidden"
  8827. },
  8828. "404": {
  8829. "$ref": "#/responses/notFound"
  8830. }
  8831. }
  8832. }
  8833. },
  8834. "/user/orgs": {
  8835. "get": {
  8836. "produces": [
  8837. "application/json"
  8838. ],
  8839. "tags": [
  8840. "organization"
  8841. ],
  8842. "summary": "List the current user's organizations",
  8843. "operationId": "orgListCurrentUserOrgs",
  8844. "parameters": [
  8845. {
  8846. "type": "integer",
  8847. "description": "page number of results to return (1-based)",
  8848. "name": "page",
  8849. "in": "query"
  8850. },
  8851. {
  8852. "type": "integer",
  8853. "description": "page size of results, maximum page size is 50",
  8854. "name": "limit",
  8855. "in": "query"
  8856. }
  8857. ],
  8858. "responses": {
  8859. "200": {
  8860. "$ref": "#/responses/OrganizationList"
  8861. }
  8862. }
  8863. }
  8864. },
  8865. "/user/repos": {
  8866. "get": {
  8867. "produces": [
  8868. "application/json"
  8869. ],
  8870. "tags": [
  8871. "user"
  8872. ],
  8873. "summary": "List the repos that the authenticated user owns or has access to",
  8874. "operationId": "userCurrentListRepos",
  8875. "parameters": [
  8876. {
  8877. "type": "integer",
  8878. "description": "page number of results to return (1-based)",
  8879. "name": "page",
  8880. "in": "query"
  8881. },
  8882. {
  8883. "type": "integer",
  8884. "description": "page size of results, maximum page size is 50",
  8885. "name": "limit",
  8886. "in": "query"
  8887. }
  8888. ],
  8889. "responses": {
  8890. "200": {
  8891. "$ref": "#/responses/RepositoryList"
  8892. }
  8893. }
  8894. },
  8895. "post": {
  8896. "consumes": [
  8897. "application/json"
  8898. ],
  8899. "produces": [
  8900. "application/json"
  8901. ],
  8902. "tags": [
  8903. "repository",
  8904. "user"
  8905. ],
  8906. "summary": "Create a repository",
  8907. "operationId": "createCurrentUserRepo",
  8908. "parameters": [
  8909. {
  8910. "name": "body",
  8911. "in": "body",
  8912. "schema": {
  8913. "$ref": "#/definitions/CreateRepoOption"
  8914. }
  8915. }
  8916. ],
  8917. "responses": {
  8918. "201": {
  8919. "$ref": "#/responses/Repository"
  8920. },
  8921. "409": {
  8922. "description": "The repository with the same name already exists."
  8923. },
  8924. "422": {
  8925. "$ref": "#/responses/validationError"
  8926. }
  8927. }
  8928. }
  8929. },
  8930. "/user/starred": {
  8931. "get": {
  8932. "produces": [
  8933. "application/json"
  8934. ],
  8935. "tags": [
  8936. "user"
  8937. ],
  8938. "summary": "The repos that the authenticated user has starred",
  8939. "operationId": "userCurrentListStarred",
  8940. "parameters": [
  8941. {
  8942. "type": "integer",
  8943. "description": "page number of results to return (1-based)",
  8944. "name": "page",
  8945. "in": "query"
  8946. },
  8947. {
  8948. "type": "integer",
  8949. "description": "page size of results, maximum page size is 50",
  8950. "name": "limit",
  8951. "in": "query"
  8952. }
  8953. ],
  8954. "responses": {
  8955. "200": {
  8956. "$ref": "#/responses/RepositoryList"
  8957. }
  8958. }
  8959. }
  8960. },
  8961. "/user/starred/{owner}/{repo}": {
  8962. "get": {
  8963. "tags": [
  8964. "user"
  8965. ],
  8966. "summary": "Whether the authenticated is starring the repo",
  8967. "operationId": "userCurrentCheckStarring",
  8968. "parameters": [
  8969. {
  8970. "type": "string",
  8971. "description": "owner of the repo",
  8972. "name": "owner",
  8973. "in": "path",
  8974. "required": true
  8975. },
  8976. {
  8977. "type": "string",
  8978. "description": "name of the repo",
  8979. "name": "repo",
  8980. "in": "path",
  8981. "required": true
  8982. }
  8983. ],
  8984. "responses": {
  8985. "204": {
  8986. "$ref": "#/responses/empty"
  8987. },
  8988. "404": {
  8989. "$ref": "#/responses/notFound"
  8990. }
  8991. }
  8992. },
  8993. "put": {
  8994. "tags": [
  8995. "user"
  8996. ],
  8997. "summary": "Star the given repo",
  8998. "operationId": "userCurrentPutStar",
  8999. "parameters": [
  9000. {
  9001. "type": "string",
  9002. "description": "owner of the repo to star",
  9003. "name": "owner",
  9004. "in": "path",
  9005. "required": true
  9006. },
  9007. {
  9008. "type": "string",
  9009. "description": "name of the repo to star",
  9010. "name": "repo",
  9011. "in": "path",
  9012. "required": true
  9013. }
  9014. ],
  9015. "responses": {
  9016. "204": {
  9017. "$ref": "#/responses/empty"
  9018. }
  9019. }
  9020. },
  9021. "delete": {
  9022. "tags": [
  9023. "user"
  9024. ],
  9025. "summary": "Unstar the given repo",
  9026. "operationId": "userCurrentDeleteStar",
  9027. "parameters": [
  9028. {
  9029. "type": "string",
  9030. "description": "owner of the repo to unstar",
  9031. "name": "owner",
  9032. "in": "path",
  9033. "required": true
  9034. },
  9035. {
  9036. "type": "string",
  9037. "description": "name of the repo to unstar",
  9038. "name": "repo",
  9039. "in": "path",
  9040. "required": true
  9041. }
  9042. ],
  9043. "responses": {
  9044. "204": {
  9045. "$ref": "#/responses/empty"
  9046. }
  9047. }
  9048. }
  9049. },
  9050. "/user/stopwatches": {
  9051. "get": {
  9052. "consumes": [
  9053. "application/json"
  9054. ],
  9055. "produces": [
  9056. "application/json"
  9057. ],
  9058. "tags": [
  9059. "user"
  9060. ],
  9061. "summary": "Get list of all existing stopwatches",
  9062. "operationId": "userGetStopWatches",
  9063. "parameters": [
  9064. {
  9065. "type": "integer",
  9066. "description": "page number of results to return (1-based)",
  9067. "name": "page",
  9068. "in": "query"
  9069. },
  9070. {
  9071. "type": "integer",
  9072. "description": "page size of results, maximum page size is 50",
  9073. "name": "limit",
  9074. "in": "query"
  9075. }
  9076. ],
  9077. "responses": {
  9078. "200": {
  9079. "$ref": "#/responses/StopWatchList"
  9080. }
  9081. }
  9082. }
  9083. },
  9084. "/user/subscriptions": {
  9085. "get": {
  9086. "produces": [
  9087. "application/json"
  9088. ],
  9089. "tags": [
  9090. "user"
  9091. ],
  9092. "summary": "List repositories watched by the authenticated user",
  9093. "operationId": "userCurrentListSubscriptions",
  9094. "parameters": [
  9095. {
  9096. "type": "integer",
  9097. "description": "page number of results to return (1-based)",
  9098. "name": "page",
  9099. "in": "query"
  9100. },
  9101. {
  9102. "type": "integer",
  9103. "description": "page size of results, maximum page size is 50",
  9104. "name": "limit",
  9105. "in": "query"
  9106. }
  9107. ],
  9108. "responses": {
  9109. "200": {
  9110. "$ref": "#/responses/RepositoryList"
  9111. }
  9112. }
  9113. }
  9114. },
  9115. "/user/teams": {
  9116. "get": {
  9117. "produces": [
  9118. "application/json"
  9119. ],
  9120. "tags": [
  9121. "user"
  9122. ],
  9123. "summary": "List all the teams a user belongs to",
  9124. "operationId": "userListTeams",
  9125. "parameters": [
  9126. {
  9127. "type": "integer",
  9128. "description": "page number of results to return (1-based)",
  9129. "name": "page",
  9130. "in": "query"
  9131. },
  9132. {
  9133. "type": "integer",
  9134. "description": "page size of results, maximum page size is 50",
  9135. "name": "limit",
  9136. "in": "query"
  9137. }
  9138. ],
  9139. "responses": {
  9140. "200": {
  9141. "$ref": "#/responses/TeamList"
  9142. }
  9143. }
  9144. }
  9145. },
  9146. "/user/times": {
  9147. "get": {
  9148. "produces": [
  9149. "application/json"
  9150. ],
  9151. "tags": [
  9152. "user"
  9153. ],
  9154. "summary": "List the current user's tracked times",
  9155. "operationId": "userCurrentTrackedTimes",
  9156. "parameters": [
  9157. {
  9158. "type": "string",
  9159. "format": "date-time",
  9160. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9161. "name": "since",
  9162. "in": "query"
  9163. },
  9164. {
  9165. "type": "string",
  9166. "format": "date-time",
  9167. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9168. "name": "before",
  9169. "in": "query"
  9170. }
  9171. ],
  9172. "responses": {
  9173. "200": {
  9174. "$ref": "#/responses/TrackedTimeList"
  9175. }
  9176. }
  9177. }
  9178. },
  9179. "/users/search": {
  9180. "get": {
  9181. "produces": [
  9182. "application/json"
  9183. ],
  9184. "tags": [
  9185. "user"
  9186. ],
  9187. "summary": "Search for users",
  9188. "operationId": "userSearch",
  9189. "parameters": [
  9190. {
  9191. "type": "string",
  9192. "description": "keyword",
  9193. "name": "q",
  9194. "in": "query"
  9195. },
  9196. {
  9197. "type": "integer",
  9198. "format": "int64",
  9199. "description": "ID of the user to search for",
  9200. "name": "uid",
  9201. "in": "query"
  9202. },
  9203. {
  9204. "type": "integer",
  9205. "description": "page number of results to return (1-based)",
  9206. "name": "page",
  9207. "in": "query"
  9208. },
  9209. {
  9210. "type": "integer",
  9211. "description": "page size of results, maximum page size is 50",
  9212. "name": "limit",
  9213. "in": "query"
  9214. }
  9215. ],
  9216. "responses": {
  9217. "200": {
  9218. "description": "SearchResults of a successful search",
  9219. "schema": {
  9220. "type": "object",
  9221. "properties": {
  9222. "data": {
  9223. "type": "array",
  9224. "items": {
  9225. "$ref": "#/definitions/User"
  9226. }
  9227. },
  9228. "ok": {
  9229. "type": "boolean"
  9230. }
  9231. }
  9232. }
  9233. }
  9234. }
  9235. }
  9236. },
  9237. "/users/{follower}/following/{followee}": {
  9238. "get": {
  9239. "tags": [
  9240. "user"
  9241. ],
  9242. "summary": "Check if one user is following another user",
  9243. "operationId": "userCheckFollowing",
  9244. "parameters": [
  9245. {
  9246. "type": "string",
  9247. "description": "username of following user",
  9248. "name": "follower",
  9249. "in": "path",
  9250. "required": true
  9251. },
  9252. {
  9253. "type": "string",
  9254. "description": "username of followed user",
  9255. "name": "followee",
  9256. "in": "path",
  9257. "required": true
  9258. }
  9259. ],
  9260. "responses": {
  9261. "204": {
  9262. "$ref": "#/responses/empty"
  9263. },
  9264. "404": {
  9265. "$ref": "#/responses/notFound"
  9266. }
  9267. }
  9268. }
  9269. },
  9270. "/users/{username}": {
  9271. "get": {
  9272. "produces": [
  9273. "application/json"
  9274. ],
  9275. "tags": [
  9276. "user"
  9277. ],
  9278. "summary": "Get a user",
  9279. "operationId": "userGet",
  9280. "parameters": [
  9281. {
  9282. "type": "string",
  9283. "description": "username of user to get",
  9284. "name": "username",
  9285. "in": "path",
  9286. "required": true
  9287. }
  9288. ],
  9289. "responses": {
  9290. "200": {
  9291. "$ref": "#/responses/User"
  9292. },
  9293. "404": {
  9294. "$ref": "#/responses/notFound"
  9295. }
  9296. }
  9297. }
  9298. },
  9299. "/users/{username}/followers": {
  9300. "get": {
  9301. "produces": [
  9302. "application/json"
  9303. ],
  9304. "tags": [
  9305. "user"
  9306. ],
  9307. "summary": "List the given user's followers",
  9308. "operationId": "userListFollowers",
  9309. "parameters": [
  9310. {
  9311. "type": "string",
  9312. "description": "username of user",
  9313. "name": "username",
  9314. "in": "path",
  9315. "required": true
  9316. },
  9317. {
  9318. "type": "integer",
  9319. "description": "page number of results to return (1-based)",
  9320. "name": "page",
  9321. "in": "query"
  9322. },
  9323. {
  9324. "type": "integer",
  9325. "description": "page size of results, maximum page size is 50",
  9326. "name": "limit",
  9327. "in": "query"
  9328. }
  9329. ],
  9330. "responses": {
  9331. "200": {
  9332. "$ref": "#/responses/UserList"
  9333. }
  9334. }
  9335. }
  9336. },
  9337. "/users/{username}/following": {
  9338. "get": {
  9339. "produces": [
  9340. "application/json"
  9341. ],
  9342. "tags": [
  9343. "user"
  9344. ],
  9345. "summary": "List the users that the given user is following",
  9346. "operationId": "userListFollowing",
  9347. "parameters": [
  9348. {
  9349. "type": "string",
  9350. "description": "username of user",
  9351. "name": "username",
  9352. "in": "path",
  9353. "required": true
  9354. },
  9355. {
  9356. "type": "integer",
  9357. "description": "page number of results to return (1-based)",
  9358. "name": "page",
  9359. "in": "query"
  9360. },
  9361. {
  9362. "type": "integer",
  9363. "description": "page size of results, maximum page size is 50",
  9364. "name": "limit",
  9365. "in": "query"
  9366. }
  9367. ],
  9368. "responses": {
  9369. "200": {
  9370. "$ref": "#/responses/UserList"
  9371. }
  9372. }
  9373. }
  9374. },
  9375. "/users/{username}/gpg_keys": {
  9376. "get": {
  9377. "produces": [
  9378. "application/json"
  9379. ],
  9380. "tags": [
  9381. "user"
  9382. ],
  9383. "summary": "List the given user's GPG keys",
  9384. "operationId": "userListGPGKeys",
  9385. "parameters": [
  9386. {
  9387. "type": "string",
  9388. "description": "username of user",
  9389. "name": "username",
  9390. "in": "path",
  9391. "required": true
  9392. },
  9393. {
  9394. "type": "integer",
  9395. "description": "page number of results to return (1-based)",
  9396. "name": "page",
  9397. "in": "query"
  9398. },
  9399. {
  9400. "type": "integer",
  9401. "description": "page size of results, maximum page size is 50",
  9402. "name": "limit",
  9403. "in": "query"
  9404. }
  9405. ],
  9406. "responses": {
  9407. "200": {
  9408. "$ref": "#/responses/GPGKeyList"
  9409. }
  9410. }
  9411. }
  9412. },
  9413. "/users/{username}/heatmap": {
  9414. "get": {
  9415. "produces": [
  9416. "application/json"
  9417. ],
  9418. "tags": [
  9419. "user"
  9420. ],
  9421. "summary": "Get a user's heatmap",
  9422. "operationId": "userGetHeatmapData",
  9423. "parameters": [
  9424. {
  9425. "type": "string",
  9426. "description": "username of user to get",
  9427. "name": "username",
  9428. "in": "path",
  9429. "required": true
  9430. }
  9431. ],
  9432. "responses": {
  9433. "200": {
  9434. "$ref": "#/responses/UserHeatmapData"
  9435. },
  9436. "404": {
  9437. "$ref": "#/responses/notFound"
  9438. }
  9439. }
  9440. }
  9441. },
  9442. "/users/{username}/keys": {
  9443. "get": {
  9444. "produces": [
  9445. "application/json"
  9446. ],
  9447. "tags": [
  9448. "user"
  9449. ],
  9450. "summary": "List the given user's public keys",
  9451. "operationId": "userListKeys",
  9452. "parameters": [
  9453. {
  9454. "type": "string",
  9455. "description": "username of user",
  9456. "name": "username",
  9457. "in": "path",
  9458. "required": true
  9459. },
  9460. {
  9461. "type": "string",
  9462. "description": "fingerprint of the key",
  9463. "name": "fingerprint",
  9464. "in": "query"
  9465. },
  9466. {
  9467. "type": "integer",
  9468. "description": "page number of results to return (1-based)",
  9469. "name": "page",
  9470. "in": "query"
  9471. },
  9472. {
  9473. "type": "integer",
  9474. "description": "page size of results, maximum page size is 50",
  9475. "name": "limit",
  9476. "in": "query"
  9477. }
  9478. ],
  9479. "responses": {
  9480. "200": {
  9481. "$ref": "#/responses/PublicKeyList"
  9482. }
  9483. }
  9484. }
  9485. },
  9486. "/users/{username}/orgs": {
  9487. "get": {
  9488. "produces": [
  9489. "application/json"
  9490. ],
  9491. "tags": [
  9492. "organization"
  9493. ],
  9494. "summary": "List a user's organizations",
  9495. "operationId": "orgListUserOrgs",
  9496. "parameters": [
  9497. {
  9498. "type": "string",
  9499. "description": "username of user",
  9500. "name": "username",
  9501. "in": "path",
  9502. "required": true
  9503. },
  9504. {
  9505. "type": "integer",
  9506. "description": "page number of results to return (1-based)",
  9507. "name": "page",
  9508. "in": "query"
  9509. },
  9510. {
  9511. "type": "integer",
  9512. "description": "page size of results, maximum page size is 50",
  9513. "name": "limit",
  9514. "in": "query"
  9515. }
  9516. ],
  9517. "responses": {
  9518. "200": {
  9519. "$ref": "#/responses/OrganizationList"
  9520. }
  9521. }
  9522. }
  9523. },
  9524. "/users/{username}/repos": {
  9525. "get": {
  9526. "produces": [
  9527. "application/json"
  9528. ],
  9529. "tags": [
  9530. "user"
  9531. ],
  9532. "summary": "List the repos owned by the given user",
  9533. "operationId": "userListRepos",
  9534. "parameters": [
  9535. {
  9536. "type": "string",
  9537. "description": "username of user",
  9538. "name": "username",
  9539. "in": "path",
  9540. "required": true
  9541. },
  9542. {
  9543. "type": "integer",
  9544. "description": "page number of results to return (1-based)",
  9545. "name": "page",
  9546. "in": "query"
  9547. },
  9548. {
  9549. "type": "integer",
  9550. "description": "page size of results, maximum page size is 50",
  9551. "name": "limit",
  9552. "in": "query"
  9553. }
  9554. ],
  9555. "responses": {
  9556. "200": {
  9557. "$ref": "#/responses/RepositoryList"
  9558. }
  9559. }
  9560. }
  9561. },
  9562. "/users/{username}/starred": {
  9563. "get": {
  9564. "produces": [
  9565. "application/json"
  9566. ],
  9567. "tags": [
  9568. "user"
  9569. ],
  9570. "summary": "The repos that the given user has starred",
  9571. "operationId": "userListStarred",
  9572. "parameters": [
  9573. {
  9574. "type": "string",
  9575. "description": "username of user",
  9576. "name": "username",
  9577. "in": "path",
  9578. "required": true
  9579. },
  9580. {
  9581. "type": "integer",
  9582. "description": "page number of results to return (1-based)",
  9583. "name": "page",
  9584. "in": "query"
  9585. },
  9586. {
  9587. "type": "integer",
  9588. "description": "page size of results, maximum page size is 50",
  9589. "name": "limit",
  9590. "in": "query"
  9591. }
  9592. ],
  9593. "responses": {
  9594. "200": {
  9595. "$ref": "#/responses/RepositoryList"
  9596. }
  9597. }
  9598. }
  9599. },
  9600. "/users/{username}/subscriptions": {
  9601. "get": {
  9602. "produces": [
  9603. "application/json"
  9604. ],
  9605. "tags": [
  9606. "user"
  9607. ],
  9608. "summary": "List the repositories watched by a user",
  9609. "operationId": "userListSubscriptions",
  9610. "parameters": [
  9611. {
  9612. "type": "string",
  9613. "description": "username of the user",
  9614. "name": "username",
  9615. "in": "path",
  9616. "required": true
  9617. },
  9618. {
  9619. "type": "integer",
  9620. "description": "page number of results to return (1-based)",
  9621. "name": "page",
  9622. "in": "query"
  9623. },
  9624. {
  9625. "type": "integer",
  9626. "description": "page size of results, maximum page size is 50",
  9627. "name": "limit",
  9628. "in": "query"
  9629. }
  9630. ],
  9631. "responses": {
  9632. "200": {
  9633. "$ref": "#/responses/RepositoryList"
  9634. }
  9635. }
  9636. }
  9637. },
  9638. "/users/{username}/tokens": {
  9639. "get": {
  9640. "produces": [
  9641. "application/json"
  9642. ],
  9643. "tags": [
  9644. "user"
  9645. ],
  9646. "summary": "List the authenticated user's access tokens",
  9647. "operationId": "userGetTokens",
  9648. "parameters": [
  9649. {
  9650. "type": "string",
  9651. "description": "username of user",
  9652. "name": "username",
  9653. "in": "path",
  9654. "required": true
  9655. },
  9656. {
  9657. "type": "integer",
  9658. "description": "page number of results to return (1-based)",
  9659. "name": "page",
  9660. "in": "query"
  9661. },
  9662. {
  9663. "type": "integer",
  9664. "description": "page size of results, maximum page size is 50",
  9665. "name": "limit",
  9666. "in": "query"
  9667. }
  9668. ],
  9669. "responses": {
  9670. "200": {
  9671. "$ref": "#/responses/AccessTokenList"
  9672. }
  9673. }
  9674. },
  9675. "post": {
  9676. "consumes": [
  9677. "application/json"
  9678. ],
  9679. "produces": [
  9680. "application/json"
  9681. ],
  9682. "tags": [
  9683. "user"
  9684. ],
  9685. "summary": "Create an access token",
  9686. "operationId": "userCreateToken",
  9687. "parameters": [
  9688. {
  9689. "type": "string",
  9690. "x-go-name": "Name",
  9691. "description": "username of user",
  9692. "name": "username",
  9693. "in": "path",
  9694. "required": true
  9695. },
  9696. {
  9697. "name": "accessToken",
  9698. "in": "body",
  9699. "schema": {
  9700. "type": "object",
  9701. "required": [
  9702. "name"
  9703. ],
  9704. "properties": {
  9705. "name": {
  9706. "type": "string"
  9707. }
  9708. }
  9709. }
  9710. }
  9711. ],
  9712. "responses": {
  9713. "200": {
  9714. "$ref": "#/responses/AccessToken"
  9715. }
  9716. }
  9717. }
  9718. },
  9719. "/users/{username}/tokens/{token}": {
  9720. "delete": {
  9721. "produces": [
  9722. "application/json"
  9723. ],
  9724. "tags": [
  9725. "user"
  9726. ],
  9727. "summary": "delete an access token",
  9728. "operationId": "userDeleteAccessToken",
  9729. "parameters": [
  9730. {
  9731. "type": "string",
  9732. "description": "username of user",
  9733. "name": "username",
  9734. "in": "path",
  9735. "required": true
  9736. },
  9737. {
  9738. "type": "integer",
  9739. "format": "int64",
  9740. "description": "token to be deleted",
  9741. "name": "token",
  9742. "in": "path",
  9743. "required": true
  9744. }
  9745. ],
  9746. "responses": {
  9747. "204": {
  9748. "$ref": "#/responses/empty"
  9749. }
  9750. }
  9751. }
  9752. },
  9753. "/version": {
  9754. "get": {
  9755. "produces": [
  9756. "application/json"
  9757. ],
  9758. "tags": [
  9759. "miscellaneous"
  9760. ],
  9761. "summary": "Returns the version of the Gitea application",
  9762. "operationId": "getVersion",
  9763. "responses": {
  9764. "200": {
  9765. "$ref": "#/responses/ServerVersion"
  9766. }
  9767. }
  9768. }
  9769. }
  9770. },
  9771. "definitions": {
  9772. "APIError": {
  9773. "description": "APIError is an api error with a message",
  9774. "type": "object",
  9775. "properties": {
  9776. "message": {
  9777. "type": "string",
  9778. "x-go-name": "Message"
  9779. },
  9780. "url": {
  9781. "type": "string",
  9782. "x-go-name": "URL"
  9783. }
  9784. },
  9785. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9786. },
  9787. "AccessToken": {
  9788. "type": "object",
  9789. "title": "AccessToken represents an API access token.",
  9790. "properties": {
  9791. "id": {
  9792. "type": "integer",
  9793. "format": "int64",
  9794. "x-go-name": "ID"
  9795. },
  9796. "name": {
  9797. "type": "string",
  9798. "x-go-name": "Name"
  9799. },
  9800. "sha1": {
  9801. "type": "string",
  9802. "x-go-name": "Token"
  9803. },
  9804. "token_last_eight": {
  9805. "type": "string",
  9806. "x-go-name": "TokenLastEight"
  9807. }
  9808. },
  9809. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9810. },
  9811. "AddCollaboratorOption": {
  9812. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  9813. "type": "object",
  9814. "properties": {
  9815. "permission": {
  9816. "type": "string",
  9817. "x-go-name": "Permission"
  9818. }
  9819. },
  9820. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9821. },
  9822. "AddTimeOption": {
  9823. "description": "AddTimeOption options for adding time to an issue",
  9824. "type": "object",
  9825. "required": [
  9826. "time"
  9827. ],
  9828. "properties": {
  9829. "created": {
  9830. "type": "string",
  9831. "format": "date-time",
  9832. "x-go-name": "Created"
  9833. },
  9834. "time": {
  9835. "description": "time in seconds",
  9836. "type": "integer",
  9837. "format": "int64",
  9838. "x-go-name": "Time"
  9839. },
  9840. "user_name": {
  9841. "description": "User who spent the time (optional)",
  9842. "type": "string",
  9843. "x-go-name": "User"
  9844. }
  9845. },
  9846. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9847. },
  9848. "AnnotatedTag": {
  9849. "description": "AnnotatedTag represents an annotated tag",
  9850. "type": "object",
  9851. "properties": {
  9852. "message": {
  9853. "type": "string",
  9854. "x-go-name": "Message"
  9855. },
  9856. "object": {
  9857. "$ref": "#/definitions/AnnotatedTagObject"
  9858. },
  9859. "sha": {
  9860. "type": "string",
  9861. "x-go-name": "SHA"
  9862. },
  9863. "tag": {
  9864. "type": "string",
  9865. "x-go-name": "Tag"
  9866. },
  9867. "tagger": {
  9868. "$ref": "#/definitions/CommitUser"
  9869. },
  9870. "url": {
  9871. "type": "string",
  9872. "x-go-name": "URL"
  9873. },
  9874. "verification": {
  9875. "$ref": "#/definitions/PayloadCommitVerification"
  9876. }
  9877. },
  9878. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9879. },
  9880. "AnnotatedTagObject": {
  9881. "description": "AnnotatedTagObject contains meta information of the tag object",
  9882. "type": "object",
  9883. "properties": {
  9884. "sha": {
  9885. "type": "string",
  9886. "x-go-name": "SHA"
  9887. },
  9888. "type": {
  9889. "type": "string",
  9890. "x-go-name": "Type"
  9891. },
  9892. "url": {
  9893. "type": "string",
  9894. "x-go-name": "URL"
  9895. }
  9896. },
  9897. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9898. },
  9899. "Attachment": {
  9900. "description": "Attachment a generic attachment",
  9901. "type": "object",
  9902. "properties": {
  9903. "browser_download_url": {
  9904. "type": "string",
  9905. "x-go-name": "DownloadURL"
  9906. },
  9907. "created_at": {
  9908. "type": "string",
  9909. "format": "date-time",
  9910. "x-go-name": "Created"
  9911. },
  9912. "download_count": {
  9913. "type": "integer",
  9914. "format": "int64",
  9915. "x-go-name": "DownloadCount"
  9916. },
  9917. "id": {
  9918. "type": "integer",
  9919. "format": "int64",
  9920. "x-go-name": "ID"
  9921. },
  9922. "name": {
  9923. "type": "string",
  9924. "x-go-name": "Name"
  9925. },
  9926. "size": {
  9927. "type": "integer",
  9928. "format": "int64",
  9929. "x-go-name": "Size"
  9930. },
  9931. "uuid": {
  9932. "type": "string",
  9933. "x-go-name": "UUID"
  9934. }
  9935. },
  9936. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9937. },
  9938. "Branch": {
  9939. "description": "Branch represents a repository branch",
  9940. "type": "object",
  9941. "properties": {
  9942. "commit": {
  9943. "$ref": "#/definitions/PayloadCommit"
  9944. },
  9945. "effective_branch_protection_name": {
  9946. "type": "string",
  9947. "x-go-name": "EffectiveBranchProtectionName"
  9948. },
  9949. "enable_status_check": {
  9950. "type": "boolean",
  9951. "x-go-name": "EnableStatusCheck"
  9952. },
  9953. "name": {
  9954. "type": "string",
  9955. "x-go-name": "Name"
  9956. },
  9957. "protected": {
  9958. "type": "boolean",
  9959. "x-go-name": "Protected"
  9960. },
  9961. "required_approvals": {
  9962. "type": "integer",
  9963. "format": "int64",
  9964. "x-go-name": "RequiredApprovals"
  9965. },
  9966. "status_check_contexts": {
  9967. "type": "array",
  9968. "items": {
  9969. "type": "string"
  9970. },
  9971. "x-go-name": "StatusCheckContexts"
  9972. },
  9973. "user_can_merge": {
  9974. "type": "boolean",
  9975. "x-go-name": "UserCanMerge"
  9976. },
  9977. "user_can_push": {
  9978. "type": "boolean",
  9979. "x-go-name": "UserCanPush"
  9980. }
  9981. },
  9982. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9983. },
  9984. "BranchProtection": {
  9985. "description": "BranchProtection represents a branch protection for a repository",
  9986. "type": "object",
  9987. "properties": {
  9988. "approvals_whitelist_teams": {
  9989. "type": "array",
  9990. "items": {
  9991. "type": "string"
  9992. },
  9993. "x-go-name": "ApprovalsWhitelistTeams"
  9994. },
  9995. "approvals_whitelist_username": {
  9996. "type": "array",
  9997. "items": {
  9998. "type": "string"
  9999. },
  10000. "x-go-name": "ApprovalsWhitelistUsernames"
  10001. },
  10002. "block_on_rejected_reviews": {
  10003. "type": "boolean",
  10004. "x-go-name": "BlockOnRejectedReviews"
  10005. },
  10006. "branch_name": {
  10007. "type": "string",
  10008. "x-go-name": "BranchName"
  10009. },
  10010. "created_at": {
  10011. "type": "string",
  10012. "format": "date-time",
  10013. "x-go-name": "Created"
  10014. },
  10015. "dismiss_stale_approvals": {
  10016. "type": "boolean",
  10017. "x-go-name": "DismissStaleApprovals"
  10018. },
  10019. "enable_approvals_whitelist": {
  10020. "type": "boolean",
  10021. "x-go-name": "EnableApprovalsWhitelist"
  10022. },
  10023. "enable_merge_whitelist": {
  10024. "type": "boolean",
  10025. "x-go-name": "EnableMergeWhitelist"
  10026. },
  10027. "enable_push": {
  10028. "type": "boolean",
  10029. "x-go-name": "EnablePush"
  10030. },
  10031. "enable_push_whitelist": {
  10032. "type": "boolean",
  10033. "x-go-name": "EnablePushWhitelist"
  10034. },
  10035. "enable_status_check": {
  10036. "type": "boolean",
  10037. "x-go-name": "EnableStatusCheck"
  10038. },
  10039. "merge_whitelist_teams": {
  10040. "type": "array",
  10041. "items": {
  10042. "type": "string"
  10043. },
  10044. "x-go-name": "MergeWhitelistTeams"
  10045. },
  10046. "merge_whitelist_usernames": {
  10047. "type": "array",
  10048. "items": {
  10049. "type": "string"
  10050. },
  10051. "x-go-name": "MergeWhitelistUsernames"
  10052. },
  10053. "protected_file_patterns": {
  10054. "type": "string",
  10055. "x-go-name": "ProtectedFilePatterns"
  10056. },
  10057. "push_whitelist_deploy_keys": {
  10058. "type": "boolean",
  10059. "x-go-name": "PushWhitelistDeployKeys"
  10060. },
  10061. "push_whitelist_teams": {
  10062. "type": "array",
  10063. "items": {
  10064. "type": "string"
  10065. },
  10066. "x-go-name": "PushWhitelistTeams"
  10067. },
  10068. "push_whitelist_usernames": {
  10069. "type": "array",
  10070. "items": {
  10071. "type": "string"
  10072. },
  10073. "x-go-name": "PushWhitelistUsernames"
  10074. },
  10075. "require_signed_commits": {
  10076. "type": "boolean",
  10077. "x-go-name": "RequireSignedCommits"
  10078. },
  10079. "required_approvals": {
  10080. "type": "integer",
  10081. "format": "int64",
  10082. "x-go-name": "RequiredApprovals"
  10083. },
  10084. "status_check_contexts": {
  10085. "type": "array",
  10086. "items": {
  10087. "type": "string"
  10088. },
  10089. "x-go-name": "StatusCheckContexts"
  10090. },
  10091. "updated_at": {
  10092. "type": "string",
  10093. "format": "date-time",
  10094. "x-go-name": "Updated"
  10095. }
  10096. },
  10097. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10098. },
  10099. "Comment": {
  10100. "description": "Comment represents a comment on a commit or issue",
  10101. "type": "object",
  10102. "properties": {
  10103. "body": {
  10104. "type": "string",
  10105. "x-go-name": "Body"
  10106. },
  10107. "created_at": {
  10108. "type": "string",
  10109. "format": "date-time",
  10110. "x-go-name": "Created"
  10111. },
  10112. "html_url": {
  10113. "type": "string",
  10114. "x-go-name": "HTMLURL"
  10115. },
  10116. "id": {
  10117. "type": "integer",
  10118. "format": "int64",
  10119. "x-go-name": "ID"
  10120. },
  10121. "issue_url": {
  10122. "type": "string",
  10123. "x-go-name": "IssueURL"
  10124. },
  10125. "original_author": {
  10126. "type": "string",
  10127. "x-go-name": "OriginalAuthor"
  10128. },
  10129. "original_author_id": {
  10130. "type": "integer",
  10131. "format": "int64",
  10132. "x-go-name": "OriginalAuthorID"
  10133. },
  10134. "pull_request_url": {
  10135. "type": "string",
  10136. "x-go-name": "PRURL"
  10137. },
  10138. "updated_at": {
  10139. "type": "string",
  10140. "format": "date-time",
  10141. "x-go-name": "Updated"
  10142. },
  10143. "user": {
  10144. "$ref": "#/definitions/User"
  10145. }
  10146. },
  10147. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10148. },
  10149. "Commit": {
  10150. "type": "object",
  10151. "title": "Commit contains information generated from a Git commit.",
  10152. "properties": {
  10153. "author": {
  10154. "$ref": "#/definitions/User"
  10155. },
  10156. "commit": {
  10157. "$ref": "#/definitions/RepoCommit"
  10158. },
  10159. "committer": {
  10160. "$ref": "#/definitions/User"
  10161. },
  10162. "html_url": {
  10163. "type": "string",
  10164. "x-go-name": "HTMLURL"
  10165. },
  10166. "parents": {
  10167. "type": "array",
  10168. "items": {
  10169. "$ref": "#/definitions/CommitMeta"
  10170. },
  10171. "x-go-name": "Parents"
  10172. },
  10173. "sha": {
  10174. "type": "string",
  10175. "x-go-name": "SHA"
  10176. },
  10177. "url": {
  10178. "type": "string",
  10179. "x-go-name": "URL"
  10180. }
  10181. },
  10182. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10183. },
  10184. "CommitDateOptions": {
  10185. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  10186. "type": "object",
  10187. "properties": {
  10188. "author": {
  10189. "type": "string",
  10190. "format": "date-time",
  10191. "x-go-name": "Author"
  10192. },
  10193. "committer": {
  10194. "type": "string",
  10195. "format": "date-time",
  10196. "x-go-name": "Committer"
  10197. }
  10198. },
  10199. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10200. },
  10201. "CommitMeta": {
  10202. "type": "object",
  10203. "title": "CommitMeta contains meta information of a commit in terms of API.",
  10204. "properties": {
  10205. "sha": {
  10206. "type": "string",
  10207. "x-go-name": "SHA"
  10208. },
  10209. "url": {
  10210. "type": "string",
  10211. "x-go-name": "URL"
  10212. }
  10213. },
  10214. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10215. },
  10216. "CommitUser": {
  10217. "type": "object",
  10218. "title": "CommitUser contains information of a user in the context of a commit.",
  10219. "properties": {
  10220. "date": {
  10221. "type": "string",
  10222. "x-go-name": "Date"
  10223. },
  10224. "email": {
  10225. "type": "string",
  10226. "format": "email",
  10227. "x-go-name": "Email"
  10228. },
  10229. "name": {
  10230. "type": "string",
  10231. "x-go-name": "Name"
  10232. }
  10233. },
  10234. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10235. },
  10236. "ContentsResponse": {
  10237. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  10238. "type": "object",
  10239. "properties": {
  10240. "_links": {
  10241. "$ref": "#/definitions/FileLinksResponse"
  10242. },
  10243. "content": {
  10244. "description": "`content` is populated when `type` is `file`, otherwise null",
  10245. "type": "string",
  10246. "x-go-name": "Content"
  10247. },
  10248. "download_url": {
  10249. "type": "string",
  10250. "x-go-name": "DownloadURL"
  10251. },
  10252. "encoding": {
  10253. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  10254. "type": "string",
  10255. "x-go-name": "Encoding"
  10256. },
  10257. "git_url": {
  10258. "type": "string",
  10259. "x-go-name": "GitURL"
  10260. },
  10261. "html_url": {
  10262. "type": "string",
  10263. "x-go-name": "HTMLURL"
  10264. },
  10265. "name": {
  10266. "type": "string",
  10267. "x-go-name": "Name"
  10268. },
  10269. "path": {
  10270. "type": "string",
  10271. "x-go-name": "Path"
  10272. },
  10273. "sha": {
  10274. "type": "string",
  10275. "x-go-name": "SHA"
  10276. },
  10277. "size": {
  10278. "type": "integer",
  10279. "format": "int64",
  10280. "x-go-name": "Size"
  10281. },
  10282. "submodule_git_url": {
  10283. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  10284. "type": "string",
  10285. "x-go-name": "SubmoduleGitURL"
  10286. },
  10287. "target": {
  10288. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  10289. "type": "string",
  10290. "x-go-name": "Target"
  10291. },
  10292. "type": {
  10293. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  10294. "type": "string",
  10295. "x-go-name": "Type"
  10296. },
  10297. "url": {
  10298. "type": "string",
  10299. "x-go-name": "URL"
  10300. }
  10301. },
  10302. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10303. },
  10304. "CreateBranchProtectionOption": {
  10305. "description": "CreateBranchProtectionOption options for creating a branch protection",
  10306. "type": "object",
  10307. "properties": {
  10308. "approvals_whitelist_teams": {
  10309. "type": "array",
  10310. "items": {
  10311. "type": "string"
  10312. },
  10313. "x-go-name": "ApprovalsWhitelistTeams"
  10314. },
  10315. "approvals_whitelist_username": {
  10316. "type": "array",
  10317. "items": {
  10318. "type": "string"
  10319. },
  10320. "x-go-name": "ApprovalsWhitelistUsernames"
  10321. },
  10322. "block_on_rejected_reviews": {
  10323. "type": "boolean",
  10324. "x-go-name": "BlockOnRejectedReviews"
  10325. },
  10326. "branch_name": {
  10327. "type": "string",
  10328. "x-go-name": "BranchName"
  10329. },
  10330. "dismiss_stale_approvals": {
  10331. "type": "boolean",
  10332. "x-go-name": "DismissStaleApprovals"
  10333. },
  10334. "enable_approvals_whitelist": {
  10335. "type": "boolean",
  10336. "x-go-name": "EnableApprovalsWhitelist"
  10337. },
  10338. "enable_merge_whitelist": {
  10339. "type": "boolean",
  10340. "x-go-name": "EnableMergeWhitelist"
  10341. },
  10342. "enable_push": {
  10343. "type": "boolean",
  10344. "x-go-name": "EnablePush"
  10345. },
  10346. "enable_push_whitelist": {
  10347. "type": "boolean",
  10348. "x-go-name": "EnablePushWhitelist"
  10349. },
  10350. "enable_status_check": {
  10351. "type": "boolean",
  10352. "x-go-name": "EnableStatusCheck"
  10353. },
  10354. "merge_whitelist_teams": {
  10355. "type": "array",
  10356. "items": {
  10357. "type": "string"
  10358. },
  10359. "x-go-name": "MergeWhitelistTeams"
  10360. },
  10361. "merge_whitelist_usernames": {
  10362. "type": "array",
  10363. "items": {
  10364. "type": "string"
  10365. },
  10366. "x-go-name": "MergeWhitelistUsernames"
  10367. },
  10368. "protected_file_patterns": {
  10369. "type": "string",
  10370. "x-go-name": "ProtectedFilePatterns"
  10371. },
  10372. "push_whitelist_deploy_keys": {
  10373. "type": "boolean",
  10374. "x-go-name": "PushWhitelistDeployKeys"
  10375. },
  10376. "push_whitelist_teams": {
  10377. "type": "array",
  10378. "items": {
  10379. "type": "string"
  10380. },
  10381. "x-go-name": "PushWhitelistTeams"
  10382. },
  10383. "push_whitelist_usernames": {
  10384. "type": "array",
  10385. "items": {
  10386. "type": "string"
  10387. },
  10388. "x-go-name": "PushWhitelistUsernames"
  10389. },
  10390. "require_signed_commits": {
  10391. "type": "boolean",
  10392. "x-go-name": "RequireSignedCommits"
  10393. },
  10394. "required_approvals": {
  10395. "type": "integer",
  10396. "format": "int64",
  10397. "x-go-name": "RequiredApprovals"
  10398. },
  10399. "status_check_contexts": {
  10400. "type": "array",
  10401. "items": {
  10402. "type": "string"
  10403. },
  10404. "x-go-name": "StatusCheckContexts"
  10405. }
  10406. },
  10407. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10408. },
  10409. "CreateEmailOption": {
  10410. "description": "CreateEmailOption options when creating email addresses",
  10411. "type": "object",
  10412. "properties": {
  10413. "emails": {
  10414. "description": "email addresses to add",
  10415. "type": "array",
  10416. "items": {
  10417. "type": "string"
  10418. },
  10419. "x-go-name": "Emails"
  10420. }
  10421. },
  10422. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10423. },
  10424. "CreateFileOptions": {
  10425. "description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  10426. "type": "object",
  10427. "required": [
  10428. "content"
  10429. ],
  10430. "properties": {
  10431. "author": {
  10432. "$ref": "#/definitions/Identity"
  10433. },
  10434. "branch": {
  10435. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10436. "type": "string",
  10437. "x-go-name": "BranchName"
  10438. },
  10439. "committer": {
  10440. "$ref": "#/definitions/Identity"
  10441. },
  10442. "content": {
  10443. "description": "content must be base64 encoded",
  10444. "type": "string",
  10445. "x-go-name": "Content"
  10446. },
  10447. "dates": {
  10448. "$ref": "#/definitions/CommitDateOptions"
  10449. },
  10450. "message": {
  10451. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10452. "type": "string",
  10453. "x-go-name": "Message"
  10454. },
  10455. "new_branch": {
  10456. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10457. "type": "string",
  10458. "x-go-name": "NewBranchName"
  10459. }
  10460. },
  10461. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10462. },
  10463. "CreateForkOption": {
  10464. "description": "CreateForkOption options for creating a fork",
  10465. "type": "object",
  10466. "properties": {
  10467. "organization": {
  10468. "description": "organization name, if forking into an organization",
  10469. "type": "string",
  10470. "x-go-name": "Organization"
  10471. }
  10472. },
  10473. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10474. },
  10475. "CreateGPGKeyOption": {
  10476. "description": "CreateGPGKeyOption options create user GPG key",
  10477. "type": "object",
  10478. "required": [
  10479. "armored_public_key"
  10480. ],
  10481. "properties": {
  10482. "armored_public_key": {
  10483. "description": "An armored GPG key to add",
  10484. "type": "string",
  10485. "uniqueItems": true,
  10486. "x-go-name": "ArmoredKey"
  10487. }
  10488. },
  10489. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10490. },
  10491. "CreateHookOption": {
  10492. "description": "CreateHookOption options when create a hook",
  10493. "type": "object",
  10494. "required": [
  10495. "type",
  10496. "config"
  10497. ],
  10498. "properties": {
  10499. "active": {
  10500. "type": "boolean",
  10501. "default": false,
  10502. "x-go-name": "Active"
  10503. },
  10504. "branch_filter": {
  10505. "type": "string",
  10506. "x-go-name": "BranchFilter"
  10507. },
  10508. "config": {
  10509. "$ref": "#/definitions/CreateHookOptionConfig"
  10510. },
  10511. "events": {
  10512. "type": "array",
  10513. "items": {
  10514. "type": "string"
  10515. },
  10516. "x-go-name": "Events"
  10517. },
  10518. "type": {
  10519. "type": "string",
  10520. "enum": [
  10521. "dingtalk",
  10522. "discord",
  10523. "gitea",
  10524. "gogs",
  10525. "msteams",
  10526. "slack",
  10527. "telegram",
  10528. "feishu"
  10529. ],
  10530. "x-go-name": "Type"
  10531. }
  10532. },
  10533. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10534. },
  10535. "CreateHookOptionConfig": {
  10536. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  10537. "type": "object",
  10538. "additionalProperties": {
  10539. "type": "string"
  10540. },
  10541. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10542. },
  10543. "CreateIssueCommentOption": {
  10544. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  10545. "type": "object",
  10546. "required": [
  10547. "body"
  10548. ],
  10549. "properties": {
  10550. "body": {
  10551. "type": "string",
  10552. "x-go-name": "Body"
  10553. }
  10554. },
  10555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10556. },
  10557. "CreateIssueOption": {
  10558. "description": "CreateIssueOption options to create one issue",
  10559. "type": "object",
  10560. "required": [
  10561. "title"
  10562. ],
  10563. "properties": {
  10564. "assignee": {
  10565. "description": "username of assignee",
  10566. "type": "string",
  10567. "x-go-name": "Assignee"
  10568. },
  10569. "assignees": {
  10570. "type": "array",
  10571. "items": {
  10572. "type": "string"
  10573. },
  10574. "x-go-name": "Assignees"
  10575. },
  10576. "body": {
  10577. "type": "string",
  10578. "x-go-name": "Body"
  10579. },
  10580. "closed": {
  10581. "type": "boolean",
  10582. "x-go-name": "Closed"
  10583. },
  10584. "due_date": {
  10585. "type": "string",
  10586. "format": "date-time",
  10587. "x-go-name": "Deadline"
  10588. },
  10589. "labels": {
  10590. "description": "list of label ids",
  10591. "type": "array",
  10592. "items": {
  10593. "type": "integer",
  10594. "format": "int64"
  10595. },
  10596. "x-go-name": "Labels"
  10597. },
  10598. "milestone": {
  10599. "description": "milestone id",
  10600. "type": "integer",
  10601. "format": "int64",
  10602. "x-go-name": "Milestone"
  10603. },
  10604. "title": {
  10605. "type": "string",
  10606. "x-go-name": "Title"
  10607. }
  10608. },
  10609. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10610. },
  10611. "CreateKeyOption": {
  10612. "description": "CreateKeyOption options when creating a key",
  10613. "type": "object",
  10614. "required": [
  10615. "title",
  10616. "key"
  10617. ],
  10618. "properties": {
  10619. "key": {
  10620. "description": "An armored SSH key to add",
  10621. "type": "string",
  10622. "uniqueItems": true,
  10623. "x-go-name": "Key"
  10624. },
  10625. "read_only": {
  10626. "description": "Describe if the key has only read access or read/write",
  10627. "type": "boolean",
  10628. "x-go-name": "ReadOnly"
  10629. },
  10630. "title": {
  10631. "description": "Title of the key to add",
  10632. "type": "string",
  10633. "uniqueItems": true,
  10634. "x-go-name": "Title"
  10635. }
  10636. },
  10637. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10638. },
  10639. "CreateLabelOption": {
  10640. "description": "CreateLabelOption options for creating a label",
  10641. "type": "object",
  10642. "required": [
  10643. "name",
  10644. "color"
  10645. ],
  10646. "properties": {
  10647. "color": {
  10648. "type": "string",
  10649. "x-go-name": "Color",
  10650. "example": "#00aabb"
  10651. },
  10652. "description": {
  10653. "type": "string",
  10654. "x-go-name": "Description"
  10655. },
  10656. "name": {
  10657. "type": "string",
  10658. "x-go-name": "Name"
  10659. }
  10660. },
  10661. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10662. },
  10663. "CreateMilestoneOption": {
  10664. "description": "CreateMilestoneOption options for creating a milestone",
  10665. "type": "object",
  10666. "properties": {
  10667. "description": {
  10668. "type": "string",
  10669. "x-go-name": "Description"
  10670. },
  10671. "due_on": {
  10672. "type": "string",
  10673. "format": "date-time",
  10674. "x-go-name": "Deadline"
  10675. },
  10676. "title": {
  10677. "type": "string",
  10678. "x-go-name": "Title"
  10679. }
  10680. },
  10681. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10682. },
  10683. "CreateOAuth2ApplicationOptions": {
  10684. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  10685. "type": "object",
  10686. "properties": {
  10687. "name": {
  10688. "type": "string",
  10689. "x-go-name": "Name"
  10690. },
  10691. "redirect_uris": {
  10692. "type": "array",
  10693. "items": {
  10694. "type": "string"
  10695. },
  10696. "x-go-name": "RedirectURIs"
  10697. }
  10698. },
  10699. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10700. },
  10701. "CreateOrgOption": {
  10702. "description": "CreateOrgOption options for creating an organization",
  10703. "type": "object",
  10704. "required": [
  10705. "username"
  10706. ],
  10707. "properties": {
  10708. "description": {
  10709. "type": "string",
  10710. "x-go-name": "Description"
  10711. },
  10712. "full_name": {
  10713. "type": "string",
  10714. "x-go-name": "FullName"
  10715. },
  10716. "location": {
  10717. "type": "string",
  10718. "x-go-name": "Location"
  10719. },
  10720. "repo_admin_change_team_access": {
  10721. "type": "boolean",
  10722. "x-go-name": "RepoAdminChangeTeamAccess"
  10723. },
  10724. "username": {
  10725. "type": "string",
  10726. "x-go-name": "UserName"
  10727. },
  10728. "visibility": {
  10729. "description": "possible values are `public` (default), `limited` or `private`",
  10730. "type": "string",
  10731. "enum": [
  10732. "public",
  10733. "limited",
  10734. "private"
  10735. ],
  10736. "x-go-name": "Visibility"
  10737. },
  10738. "website": {
  10739. "type": "string",
  10740. "x-go-name": "Website"
  10741. }
  10742. },
  10743. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10744. },
  10745. "CreatePullRequestOption": {
  10746. "description": "CreatePullRequestOption options when creating a pull request",
  10747. "type": "object",
  10748. "properties": {
  10749. "assignee": {
  10750. "type": "string",
  10751. "x-go-name": "Assignee"
  10752. },
  10753. "assignees": {
  10754. "type": "array",
  10755. "items": {
  10756. "type": "string"
  10757. },
  10758. "x-go-name": "Assignees"
  10759. },
  10760. "base": {
  10761. "type": "string",
  10762. "x-go-name": "Base"
  10763. },
  10764. "body": {
  10765. "type": "string",
  10766. "x-go-name": "Body"
  10767. },
  10768. "due_date": {
  10769. "type": "string",
  10770. "format": "date-time",
  10771. "x-go-name": "Deadline"
  10772. },
  10773. "head": {
  10774. "type": "string",
  10775. "x-go-name": "Head"
  10776. },
  10777. "labels": {
  10778. "type": "array",
  10779. "items": {
  10780. "type": "integer",
  10781. "format": "int64"
  10782. },
  10783. "x-go-name": "Labels"
  10784. },
  10785. "milestone": {
  10786. "type": "integer",
  10787. "format": "int64",
  10788. "x-go-name": "Milestone"
  10789. },
  10790. "title": {
  10791. "type": "string",
  10792. "x-go-name": "Title"
  10793. }
  10794. },
  10795. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10796. },
  10797. "CreateReleaseOption": {
  10798. "description": "CreateReleaseOption options when creating a release",
  10799. "type": "object",
  10800. "required": [
  10801. "tag_name"
  10802. ],
  10803. "properties": {
  10804. "body": {
  10805. "type": "string",
  10806. "x-go-name": "Note"
  10807. },
  10808. "draft": {
  10809. "type": "boolean",
  10810. "x-go-name": "IsDraft"
  10811. },
  10812. "name": {
  10813. "type": "string",
  10814. "x-go-name": "Title"
  10815. },
  10816. "prerelease": {
  10817. "type": "boolean",
  10818. "x-go-name": "IsPrerelease"
  10819. },
  10820. "tag_name": {
  10821. "type": "string",
  10822. "x-go-name": "TagName"
  10823. },
  10824. "target_commitish": {
  10825. "type": "string",
  10826. "x-go-name": "Target"
  10827. }
  10828. },
  10829. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10830. },
  10831. "CreateRepoOption": {
  10832. "description": "CreateRepoOption options when creating repository",
  10833. "type": "object",
  10834. "required": [
  10835. "name"
  10836. ],
  10837. "properties": {
  10838. "auto_init": {
  10839. "description": "Whether the repository should be auto-intialized?",
  10840. "type": "boolean",
  10841. "x-go-name": "AutoInit"
  10842. },
  10843. "default_branch": {
  10844. "description": "DefaultBranch of the repository (used when initializes and in template)",
  10845. "type": "string",
  10846. "x-go-name": "DefaultBranch"
  10847. },
  10848. "description": {
  10849. "description": "Description of the repository to create",
  10850. "type": "string",
  10851. "x-go-name": "Description"
  10852. },
  10853. "gitignores": {
  10854. "description": "Gitignores to use",
  10855. "type": "string",
  10856. "x-go-name": "Gitignores"
  10857. },
  10858. "issue_labels": {
  10859. "description": "Issue Label set to use",
  10860. "type": "string",
  10861. "x-go-name": "IssueLabels"
  10862. },
  10863. "license": {
  10864. "description": "License to use",
  10865. "type": "string",
  10866. "x-go-name": "License"
  10867. },
  10868. "name": {
  10869. "description": "Name of the repository to create",
  10870. "type": "string",
  10871. "uniqueItems": true,
  10872. "x-go-name": "Name"
  10873. },
  10874. "private": {
  10875. "description": "Whether the repository is private",
  10876. "type": "boolean",
  10877. "x-go-name": "Private"
  10878. },
  10879. "readme": {
  10880. "description": "Readme of the repository to create",
  10881. "type": "string",
  10882. "x-go-name": "Readme"
  10883. }
  10884. },
  10885. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10886. },
  10887. "CreateStatusOption": {
  10888. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  10889. "type": "object",
  10890. "properties": {
  10891. "context": {
  10892. "type": "string",
  10893. "x-go-name": "Context"
  10894. },
  10895. "description": {
  10896. "type": "string",
  10897. "x-go-name": "Description"
  10898. },
  10899. "state": {
  10900. "$ref": "#/definitions/StatusState"
  10901. },
  10902. "target_url": {
  10903. "type": "string",
  10904. "x-go-name": "TargetURL"
  10905. }
  10906. },
  10907. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10908. },
  10909. "CreateTeamOption": {
  10910. "description": "CreateTeamOption options for creating a team",
  10911. "type": "object",
  10912. "required": [
  10913. "name"
  10914. ],
  10915. "properties": {
  10916. "can_create_org_repo": {
  10917. "type": "boolean",
  10918. "x-go-name": "CanCreateOrgRepo"
  10919. },
  10920. "description": {
  10921. "type": "string",
  10922. "x-go-name": "Description"
  10923. },
  10924. "includes_all_repositories": {
  10925. "type": "boolean",
  10926. "x-go-name": "IncludesAllRepositories"
  10927. },
  10928. "name": {
  10929. "type": "string",
  10930. "x-go-name": "Name"
  10931. },
  10932. "permission": {
  10933. "type": "string",
  10934. "enum": [
  10935. "read",
  10936. "write",
  10937. "admin"
  10938. ],
  10939. "x-go-name": "Permission"
  10940. },
  10941. "units": {
  10942. "type": "array",
  10943. "items": {
  10944. "type": "string"
  10945. },
  10946. "x-go-name": "Units",
  10947. "example": [
  10948. "repo.code",
  10949. "repo.issues",
  10950. "repo.ext_issues",
  10951. "repo.wiki",
  10952. "repo.pulls",
  10953. "repo.releases",
  10954. "repo.ext_wiki"
  10955. ]
  10956. }
  10957. },
  10958. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10959. },
  10960. "CreateUserOption": {
  10961. "description": "CreateUserOption create user options",
  10962. "type": "object",
  10963. "required": [
  10964. "username",
  10965. "email",
  10966. "password"
  10967. ],
  10968. "properties": {
  10969. "email": {
  10970. "type": "string",
  10971. "format": "email",
  10972. "x-go-name": "Email"
  10973. },
  10974. "full_name": {
  10975. "type": "string",
  10976. "x-go-name": "FullName"
  10977. },
  10978. "login_name": {
  10979. "type": "string",
  10980. "x-go-name": "LoginName"
  10981. },
  10982. "must_change_password": {
  10983. "type": "boolean",
  10984. "x-go-name": "MustChangePassword"
  10985. },
  10986. "password": {
  10987. "type": "string",
  10988. "x-go-name": "Password"
  10989. },
  10990. "send_notify": {
  10991. "type": "boolean",
  10992. "x-go-name": "SendNotify"
  10993. },
  10994. "source_id": {
  10995. "type": "integer",
  10996. "format": "int64",
  10997. "x-go-name": "SourceID"
  10998. },
  10999. "username": {
  11000. "type": "string",
  11001. "x-go-name": "Username"
  11002. }
  11003. },
  11004. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11005. },
  11006. "DeleteEmailOption": {
  11007. "description": "DeleteEmailOption options when deleting email addresses",
  11008. "type": "object",
  11009. "properties": {
  11010. "emails": {
  11011. "description": "email addresses to delete",
  11012. "type": "array",
  11013. "items": {
  11014. "type": "string"
  11015. },
  11016. "x-go-name": "Emails"
  11017. }
  11018. },
  11019. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11020. },
  11021. "DeleteFileOptions": {
  11022. "description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  11023. "type": "object",
  11024. "required": [
  11025. "sha"
  11026. ],
  11027. "properties": {
  11028. "author": {
  11029. "$ref": "#/definitions/Identity"
  11030. },
  11031. "branch": {
  11032. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  11033. "type": "string",
  11034. "x-go-name": "BranchName"
  11035. },
  11036. "committer": {
  11037. "$ref": "#/definitions/Identity"
  11038. },
  11039. "dates": {
  11040. "$ref": "#/definitions/CommitDateOptions"
  11041. },
  11042. "message": {
  11043. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  11044. "type": "string",
  11045. "x-go-name": "Message"
  11046. },
  11047. "new_branch": {
  11048. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  11049. "type": "string",
  11050. "x-go-name": "NewBranchName"
  11051. },
  11052. "sha": {
  11053. "description": "sha is the SHA for the file that already exists",
  11054. "type": "string",
  11055. "x-go-name": "SHA"
  11056. }
  11057. },
  11058. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11059. },
  11060. "DeployKey": {
  11061. "description": "DeployKey a deploy key",
  11062. "type": "object",
  11063. "properties": {
  11064. "created_at": {
  11065. "type": "string",
  11066. "format": "date-time",
  11067. "x-go-name": "Created"
  11068. },
  11069. "fingerprint": {
  11070. "type": "string",
  11071. "x-go-name": "Fingerprint"
  11072. },
  11073. "id": {
  11074. "type": "integer",
  11075. "format": "int64",
  11076. "x-go-name": "ID"
  11077. },
  11078. "key": {
  11079. "type": "string",
  11080. "x-go-name": "Key"
  11081. },
  11082. "key_id": {
  11083. "type": "integer",
  11084. "format": "int64",
  11085. "x-go-name": "KeyID"
  11086. },
  11087. "read_only": {
  11088. "type": "boolean",
  11089. "x-go-name": "ReadOnly"
  11090. },
  11091. "repository": {
  11092. "$ref": "#/definitions/Repository"
  11093. },
  11094. "title": {
  11095. "type": "string",
  11096. "x-go-name": "Title"
  11097. },
  11098. "url": {
  11099. "type": "string",
  11100. "x-go-name": "URL"
  11101. }
  11102. },
  11103. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11104. },
  11105. "EditAttachmentOptions": {
  11106. "description": "EditAttachmentOptions options for editing attachments",
  11107. "type": "object",
  11108. "properties": {
  11109. "name": {
  11110. "type": "string",
  11111. "x-go-name": "Name"
  11112. }
  11113. },
  11114. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11115. },
  11116. "EditBranchProtectionOption": {
  11117. "description": "EditBranchProtectionOption options for editing a branch protection",
  11118. "type": "object",
  11119. "properties": {
  11120. "approvals_whitelist_teams": {
  11121. "type": "array",
  11122. "items": {
  11123. "type": "string"
  11124. },
  11125. "x-go-name": "ApprovalsWhitelistTeams"
  11126. },
  11127. "approvals_whitelist_username": {
  11128. "type": "array",
  11129. "items": {
  11130. "type": "string"
  11131. },
  11132. "x-go-name": "ApprovalsWhitelistUsernames"
  11133. },
  11134. "block_on_rejected_reviews": {
  11135. "type": "boolean",
  11136. "x-go-name": "BlockOnRejectedReviews"
  11137. },
  11138. "dismiss_stale_approvals": {
  11139. "type": "boolean",
  11140. "x-go-name": "DismissStaleApprovals"
  11141. },
  11142. "enable_approvals_whitelist": {
  11143. "type": "boolean",
  11144. "x-go-name": "EnableApprovalsWhitelist"
  11145. },
  11146. "enable_merge_whitelist": {
  11147. "type": "boolean",
  11148. "x-go-name": "EnableMergeWhitelist"
  11149. },
  11150. "enable_push": {
  11151. "type": "boolean",
  11152. "x-go-name": "EnablePush"
  11153. },
  11154. "enable_push_whitelist": {
  11155. "type": "boolean",
  11156. "x-go-name": "EnablePushWhitelist"
  11157. },
  11158. "enable_status_check": {
  11159. "type": "boolean",
  11160. "x-go-name": "EnableStatusCheck"
  11161. },
  11162. "merge_whitelist_teams": {
  11163. "type": "array",
  11164. "items": {
  11165. "type": "string"
  11166. },
  11167. "x-go-name": "MergeWhitelistTeams"
  11168. },
  11169. "merge_whitelist_usernames": {
  11170. "type": "array",
  11171. "items": {
  11172. "type": "string"
  11173. },
  11174. "x-go-name": "MergeWhitelistUsernames"
  11175. },
  11176. "protected_file_patterns": {
  11177. "type": "string",
  11178. "x-go-name": "ProtectedFilePatterns"
  11179. },
  11180. "push_whitelist_deploy_keys": {
  11181. "type": "boolean",
  11182. "x-go-name": "PushWhitelistDeployKeys"
  11183. },
  11184. "push_whitelist_teams": {
  11185. "type": "array",
  11186. "items": {
  11187. "type": "string"
  11188. },
  11189. "x-go-name": "PushWhitelistTeams"
  11190. },
  11191. "push_whitelist_usernames": {
  11192. "type": "array",
  11193. "items": {
  11194. "type": "string"
  11195. },
  11196. "x-go-name": "PushWhitelistUsernames"
  11197. },
  11198. "require_signed_commits": {
  11199. "type": "boolean",
  11200. "x-go-name": "RequireSignedCommits"
  11201. },
  11202. "required_approvals": {
  11203. "type": "integer",
  11204. "format": "int64",
  11205. "x-go-name": "RequiredApprovals"
  11206. },
  11207. "status_check_contexts": {
  11208. "type": "array",
  11209. "items": {
  11210. "type": "string"
  11211. },
  11212. "x-go-name": "StatusCheckContexts"
  11213. }
  11214. },
  11215. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11216. },
  11217. "EditDeadlineOption": {
  11218. "description": "EditDeadlineOption options for creating a deadline",
  11219. "type": "object",
  11220. "required": [
  11221. "due_date"
  11222. ],
  11223. "properties": {
  11224. "due_date": {
  11225. "type": "string",
  11226. "format": "date-time",
  11227. "x-go-name": "Deadline"
  11228. }
  11229. },
  11230. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11231. },
  11232. "EditGitHookOption": {
  11233. "description": "EditGitHookOption options when modifying one Git hook",
  11234. "type": "object",
  11235. "properties": {
  11236. "content": {
  11237. "type": "string",
  11238. "x-go-name": "Content"
  11239. }
  11240. },
  11241. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11242. },
  11243. "EditHookOption": {
  11244. "description": "EditHookOption options when modify one hook",
  11245. "type": "object",
  11246. "properties": {
  11247. "active": {
  11248. "type": "boolean",
  11249. "x-go-name": "Active"
  11250. },
  11251. "branch_filter": {
  11252. "type": "string",
  11253. "x-go-name": "BranchFilter"
  11254. },
  11255. "config": {
  11256. "type": "object",
  11257. "additionalProperties": {
  11258. "type": "string"
  11259. },
  11260. "x-go-name": "Config"
  11261. },
  11262. "events": {
  11263. "type": "array",
  11264. "items": {
  11265. "type": "string"
  11266. },
  11267. "x-go-name": "Events"
  11268. }
  11269. },
  11270. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11271. },
  11272. "EditIssueCommentOption": {
  11273. "description": "EditIssueCommentOption options for editing a comment",
  11274. "type": "object",
  11275. "required": [
  11276. "body"
  11277. ],
  11278. "properties": {
  11279. "body": {
  11280. "type": "string",
  11281. "x-go-name": "Body"
  11282. }
  11283. },
  11284. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11285. },
  11286. "EditIssueOption": {
  11287. "description": "EditIssueOption options for editing an issue",
  11288. "type": "object",
  11289. "properties": {
  11290. "assignee": {
  11291. "type": "string",
  11292. "x-go-name": "Assignee"
  11293. },
  11294. "assignees": {
  11295. "type": "array",
  11296. "items": {
  11297. "type": "string"
  11298. },
  11299. "x-go-name": "Assignees"
  11300. },
  11301. "body": {
  11302. "type": "string",
  11303. "x-go-name": "Body"
  11304. },
  11305. "due_date": {
  11306. "type": "string",
  11307. "format": "date-time",
  11308. "x-go-name": "Deadline"
  11309. },
  11310. "milestone": {
  11311. "type": "integer",
  11312. "format": "int64",
  11313. "x-go-name": "Milestone"
  11314. },
  11315. "state": {
  11316. "type": "string",
  11317. "x-go-name": "State"
  11318. },
  11319. "title": {
  11320. "type": "string",
  11321. "x-go-name": "Title"
  11322. },
  11323. "unset_due_date": {
  11324. "type": "boolean",
  11325. "x-go-name": "RemoveDeadline"
  11326. }
  11327. },
  11328. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11329. },
  11330. "EditLabelOption": {
  11331. "description": "EditLabelOption options for editing a label",
  11332. "type": "object",
  11333. "properties": {
  11334. "color": {
  11335. "type": "string",
  11336. "x-go-name": "Color"
  11337. },
  11338. "description": {
  11339. "type": "string",
  11340. "x-go-name": "Description"
  11341. },
  11342. "name": {
  11343. "type": "string",
  11344. "x-go-name": "Name"
  11345. }
  11346. },
  11347. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11348. },
  11349. "EditMilestoneOption": {
  11350. "description": "EditMilestoneOption options for editing a milestone",
  11351. "type": "object",
  11352. "properties": {
  11353. "description": {
  11354. "type": "string",
  11355. "x-go-name": "Description"
  11356. },
  11357. "due_on": {
  11358. "type": "string",
  11359. "format": "date-time",
  11360. "x-go-name": "Deadline"
  11361. },
  11362. "state": {
  11363. "type": "string",
  11364. "x-go-name": "State"
  11365. },
  11366. "title": {
  11367. "type": "string",
  11368. "x-go-name": "Title"
  11369. }
  11370. },
  11371. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11372. },
  11373. "EditOrgOption": {
  11374. "description": "EditOrgOption options for editing an organization",
  11375. "type": "object",
  11376. "properties": {
  11377. "description": {
  11378. "type": "string",
  11379. "x-go-name": "Description"
  11380. },
  11381. "full_name": {
  11382. "type": "string",
  11383. "x-go-name": "FullName"
  11384. },
  11385. "location": {
  11386. "type": "string",
  11387. "x-go-name": "Location"
  11388. },
  11389. "repo_admin_change_team_access": {
  11390. "type": "boolean",
  11391. "x-go-name": "RepoAdminChangeTeamAccess"
  11392. },
  11393. "visibility": {
  11394. "description": "possible values are `public`, `limited` or `private`",
  11395. "type": "string",
  11396. "enum": [
  11397. "public",
  11398. "limited",
  11399. "private"
  11400. ],
  11401. "x-go-name": "Visibility"
  11402. },
  11403. "website": {
  11404. "type": "string",
  11405. "x-go-name": "Website"
  11406. }
  11407. },
  11408. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11409. },
  11410. "EditPullRequestOption": {
  11411. "description": "EditPullRequestOption options when modify pull request",
  11412. "type": "object",
  11413. "properties": {
  11414. "assignee": {
  11415. "type": "string",
  11416. "x-go-name": "Assignee"
  11417. },
  11418. "assignees": {
  11419. "type": "array",
  11420. "items": {
  11421. "type": "string"
  11422. },
  11423. "x-go-name": "Assignees"
  11424. },
  11425. "body": {
  11426. "type": "string",
  11427. "x-go-name": "Body"
  11428. },
  11429. "due_date": {
  11430. "type": "string",
  11431. "format": "date-time",
  11432. "x-go-name": "Deadline"
  11433. },
  11434. "labels": {
  11435. "type": "array",
  11436. "items": {
  11437. "type": "integer",
  11438. "format": "int64"
  11439. },
  11440. "x-go-name": "Labels"
  11441. },
  11442. "milestone": {
  11443. "type": "integer",
  11444. "format": "int64",
  11445. "x-go-name": "Milestone"
  11446. },
  11447. "state": {
  11448. "type": "string",
  11449. "x-go-name": "State"
  11450. },
  11451. "title": {
  11452. "type": "string",
  11453. "x-go-name": "Title"
  11454. },
  11455. "unset_due_date": {
  11456. "type": "boolean",
  11457. "x-go-name": "RemoveDeadline"
  11458. }
  11459. },
  11460. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11461. },
  11462. "EditReactionOption": {
  11463. "description": "EditReactionOption contain the reaction type",
  11464. "type": "object",
  11465. "properties": {
  11466. "content": {
  11467. "type": "string",
  11468. "x-go-name": "Reaction"
  11469. }
  11470. },
  11471. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11472. },
  11473. "EditReleaseOption": {
  11474. "description": "EditReleaseOption options when editing a release",
  11475. "type": "object",
  11476. "properties": {
  11477. "body": {
  11478. "type": "string",
  11479. "x-go-name": "Note"
  11480. },
  11481. "draft": {
  11482. "type": "boolean",
  11483. "x-go-name": "IsDraft"
  11484. },
  11485. "name": {
  11486. "type": "string",
  11487. "x-go-name": "Title"
  11488. },
  11489. "prerelease": {
  11490. "type": "boolean",
  11491. "x-go-name": "IsPrerelease"
  11492. },
  11493. "tag_name": {
  11494. "type": "string",
  11495. "x-go-name": "TagName"
  11496. },
  11497. "target_commitish": {
  11498. "type": "string",
  11499. "x-go-name": "Target"
  11500. }
  11501. },
  11502. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11503. },
  11504. "EditRepoOption": {
  11505. "description": "EditRepoOption options when editing a repository's properties",
  11506. "type": "object",
  11507. "properties": {
  11508. "allow_merge_commits": {
  11509. "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.",
  11510. "type": "boolean",
  11511. "x-go-name": "AllowMerge"
  11512. },
  11513. "allow_rebase": {
  11514. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  11515. "type": "boolean",
  11516. "x-go-name": "AllowRebase"
  11517. },
  11518. "allow_rebase_explicit": {
  11519. "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.",
  11520. "type": "boolean",
  11521. "x-go-name": "AllowRebaseMerge"
  11522. },
  11523. "allow_squash_merge": {
  11524. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  11525. "type": "boolean",
  11526. "x-go-name": "AllowSquash"
  11527. },
  11528. "archived": {
  11529. "description": "set to `true` to archive this repository.",
  11530. "type": "boolean",
  11531. "x-go-name": "Archived"
  11532. },
  11533. "default_branch": {
  11534. "description": "sets the default branch for this repository.",
  11535. "type": "string",
  11536. "x-go-name": "DefaultBranch"
  11537. },
  11538. "description": {
  11539. "description": "a short description of the repository.",
  11540. "type": "string",
  11541. "x-go-name": "Description"
  11542. },
  11543. "external_tracker": {
  11544. "$ref": "#/definitions/ExternalTracker"
  11545. },
  11546. "external_wiki": {
  11547. "$ref": "#/definitions/ExternalWiki"
  11548. },
  11549. "has_issues": {
  11550. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  11551. "type": "boolean",
  11552. "x-go-name": "HasIssues"
  11553. },
  11554. "has_pull_requests": {
  11555. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  11556. "type": "boolean",
  11557. "x-go-name": "HasPullRequests"
  11558. },
  11559. "has_wiki": {
  11560. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  11561. "type": "boolean",
  11562. "x-go-name": "HasWiki"
  11563. },
  11564. "ignore_whitespace_conflicts": {
  11565. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  11566. "type": "boolean",
  11567. "x-go-name": "IgnoreWhitespaceConflicts"
  11568. },
  11569. "internal_tracker": {
  11570. "$ref": "#/definitions/InternalTracker"
  11571. },
  11572. "name": {
  11573. "description": "name of the repository",
  11574. "type": "string",
  11575. "uniqueItems": true,
  11576. "x-go-name": "Name"
  11577. },
  11578. "private": {
  11579. "description": "either `true` to make the repository private or `false` to make it public.\nNote: you will get a 422 error if the organization restricts changing repository visibility to organization\nowners and a non-owner tries to change the value of private.",
  11580. "type": "boolean",
  11581. "x-go-name": "Private"
  11582. },
  11583. "template": {
  11584. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  11585. "type": "boolean",
  11586. "x-go-name": "Template"
  11587. },
  11588. "website": {
  11589. "description": "a URL with more information about the repository.",
  11590. "type": "string",
  11591. "x-go-name": "Website"
  11592. }
  11593. },
  11594. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11595. },
  11596. "EditTeamOption": {
  11597. "description": "EditTeamOption options for editing a team",
  11598. "type": "object",
  11599. "required": [
  11600. "name"
  11601. ],
  11602. "properties": {
  11603. "can_create_org_repo": {
  11604. "type": "boolean",
  11605. "x-go-name": "CanCreateOrgRepo"
  11606. },
  11607. "description": {
  11608. "type": "string",
  11609. "x-go-name": "Description"
  11610. },
  11611. "includes_all_repositories": {
  11612. "type": "boolean",
  11613. "x-go-name": "IncludesAllRepositories"
  11614. },
  11615. "name": {
  11616. "type": "string",
  11617. "x-go-name": "Name"
  11618. },
  11619. "permission": {
  11620. "type": "string",
  11621. "enum": [
  11622. "read",
  11623. "write",
  11624. "admin"
  11625. ],
  11626. "x-go-name": "Permission"
  11627. },
  11628. "units": {
  11629. "type": "array",
  11630. "items": {
  11631. "type": "string"
  11632. },
  11633. "x-go-name": "Units",
  11634. "example": [
  11635. "repo.code",
  11636. "repo.issues",
  11637. "repo.ext_issues",
  11638. "repo.wiki",
  11639. "repo.pulls",
  11640. "repo.releases",
  11641. "repo.ext_wiki"
  11642. ]
  11643. }
  11644. },
  11645. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11646. },
  11647. "EditUserOption": {
  11648. "description": "EditUserOption edit user options",
  11649. "type": "object",
  11650. "required": [
  11651. "email"
  11652. ],
  11653. "properties": {
  11654. "active": {
  11655. "type": "boolean",
  11656. "x-go-name": "Active"
  11657. },
  11658. "admin": {
  11659. "type": "boolean",
  11660. "x-go-name": "Admin"
  11661. },
  11662. "allow_create_organization": {
  11663. "type": "boolean",
  11664. "x-go-name": "AllowCreateOrganization"
  11665. },
  11666. "allow_git_hook": {
  11667. "type": "boolean",
  11668. "x-go-name": "AllowGitHook"
  11669. },
  11670. "allow_import_local": {
  11671. "type": "boolean",
  11672. "x-go-name": "AllowImportLocal"
  11673. },
  11674. "email": {
  11675. "type": "string",
  11676. "format": "email",
  11677. "x-go-name": "Email"
  11678. },
  11679. "full_name": {
  11680. "type": "string",
  11681. "x-go-name": "FullName"
  11682. },
  11683. "location": {
  11684. "type": "string",
  11685. "x-go-name": "Location"
  11686. },
  11687. "login_name": {
  11688. "type": "string",
  11689. "x-go-name": "LoginName"
  11690. },
  11691. "max_repo_creation": {
  11692. "type": "integer",
  11693. "format": "int64",
  11694. "x-go-name": "MaxRepoCreation"
  11695. },
  11696. "must_change_password": {
  11697. "type": "boolean",
  11698. "x-go-name": "MustChangePassword"
  11699. },
  11700. "password": {
  11701. "type": "string",
  11702. "x-go-name": "Password"
  11703. },
  11704. "prohibit_login": {
  11705. "type": "boolean",
  11706. "x-go-name": "ProhibitLogin"
  11707. },
  11708. "source_id": {
  11709. "type": "integer",
  11710. "format": "int64",
  11711. "x-go-name": "SourceID"
  11712. },
  11713. "website": {
  11714. "type": "string",
  11715. "x-go-name": "Website"
  11716. }
  11717. },
  11718. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11719. },
  11720. "Email": {
  11721. "description": "Email an email address belonging to a user",
  11722. "type": "object",
  11723. "properties": {
  11724. "email": {
  11725. "type": "string",
  11726. "format": "email",
  11727. "x-go-name": "Email"
  11728. },
  11729. "primary": {
  11730. "type": "boolean",
  11731. "x-go-name": "Primary"
  11732. },
  11733. "verified": {
  11734. "type": "boolean",
  11735. "x-go-name": "Verified"
  11736. }
  11737. },
  11738. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11739. },
  11740. "ExternalTracker": {
  11741. "description": "ExternalTracker represents settings for external tracker",
  11742. "type": "object",
  11743. "properties": {
  11744. "external_tracker_format": {
  11745. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  11746. "type": "string",
  11747. "x-go-name": "ExternalTrackerFormat"
  11748. },
  11749. "external_tracker_style": {
  11750. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  11751. "type": "string",
  11752. "x-go-name": "ExternalTrackerStyle"
  11753. },
  11754. "external_tracker_url": {
  11755. "description": "URL of external issue tracker.",
  11756. "type": "string",
  11757. "x-go-name": "ExternalTrackerURL"
  11758. }
  11759. },
  11760. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11761. },
  11762. "ExternalWiki": {
  11763. "description": "ExternalWiki represents setting for external wiki",
  11764. "type": "object",
  11765. "properties": {
  11766. "external_wiki_url": {
  11767. "description": "URL of external wiki.",
  11768. "type": "string",
  11769. "x-go-name": "ExternalWikiURL"
  11770. }
  11771. },
  11772. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11773. },
  11774. "FileCommitResponse": {
  11775. "type": "object",
  11776. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  11777. "properties": {
  11778. "author": {
  11779. "$ref": "#/definitions/CommitUser"
  11780. },
  11781. "committer": {
  11782. "$ref": "#/definitions/CommitUser"
  11783. },
  11784. "html_url": {
  11785. "type": "string",
  11786. "x-go-name": "HTMLURL"
  11787. },
  11788. "message": {
  11789. "type": "string",
  11790. "x-go-name": "Message"
  11791. },
  11792. "parents": {
  11793. "type": "array",
  11794. "items": {
  11795. "$ref": "#/definitions/CommitMeta"
  11796. },
  11797. "x-go-name": "Parents"
  11798. },
  11799. "sha": {
  11800. "type": "string",
  11801. "x-go-name": "SHA"
  11802. },
  11803. "tree": {
  11804. "$ref": "#/definitions/CommitMeta"
  11805. },
  11806. "url": {
  11807. "type": "string",
  11808. "x-go-name": "URL"
  11809. }
  11810. },
  11811. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11812. },
  11813. "FileDeleteResponse": {
  11814. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  11815. "type": "object",
  11816. "properties": {
  11817. "commit": {
  11818. "$ref": "#/definitions/FileCommitResponse"
  11819. },
  11820. "content": {
  11821. "type": "object",
  11822. "x-go-name": "Content"
  11823. },
  11824. "verification": {
  11825. "$ref": "#/definitions/PayloadCommitVerification"
  11826. }
  11827. },
  11828. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11829. },
  11830. "FileLinksResponse": {
  11831. "description": "FileLinksResponse contains the links for a repo's file",
  11832. "type": "object",
  11833. "properties": {
  11834. "git": {
  11835. "type": "string",
  11836. "x-go-name": "GitURL"
  11837. },
  11838. "html": {
  11839. "type": "string",
  11840. "x-go-name": "HTMLURL"
  11841. },
  11842. "self": {
  11843. "type": "string",
  11844. "x-go-name": "Self"
  11845. }
  11846. },
  11847. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11848. },
  11849. "FileResponse": {
  11850. "description": "FileResponse contains information about a repo's file",
  11851. "type": "object",
  11852. "properties": {
  11853. "commit": {
  11854. "$ref": "#/definitions/FileCommitResponse"
  11855. },
  11856. "content": {
  11857. "$ref": "#/definitions/ContentsResponse"
  11858. },
  11859. "verification": {
  11860. "$ref": "#/definitions/PayloadCommitVerification"
  11861. }
  11862. },
  11863. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11864. },
  11865. "GPGKey": {
  11866. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  11867. "type": "object",
  11868. "properties": {
  11869. "can_certify": {
  11870. "type": "boolean",
  11871. "x-go-name": "CanCertify"
  11872. },
  11873. "can_encrypt_comms": {
  11874. "type": "boolean",
  11875. "x-go-name": "CanEncryptComms"
  11876. },
  11877. "can_encrypt_storage": {
  11878. "type": "boolean",
  11879. "x-go-name": "CanEncryptStorage"
  11880. },
  11881. "can_sign": {
  11882. "type": "boolean",
  11883. "x-go-name": "CanSign"
  11884. },
  11885. "created_at": {
  11886. "type": "string",
  11887. "format": "date-time",
  11888. "x-go-name": "Created"
  11889. },
  11890. "emails": {
  11891. "type": "array",
  11892. "items": {
  11893. "$ref": "#/definitions/GPGKeyEmail"
  11894. },
  11895. "x-go-name": "Emails"
  11896. },
  11897. "expires_at": {
  11898. "type": "string",
  11899. "format": "date-time",
  11900. "x-go-name": "Expires"
  11901. },
  11902. "id": {
  11903. "type": "integer",
  11904. "format": "int64",
  11905. "x-go-name": "ID"
  11906. },
  11907. "key_id": {
  11908. "type": "string",
  11909. "x-go-name": "KeyID"
  11910. },
  11911. "primary_key_id": {
  11912. "type": "string",
  11913. "x-go-name": "PrimaryKeyID"
  11914. },
  11915. "public_key": {
  11916. "type": "string",
  11917. "x-go-name": "PublicKey"
  11918. },
  11919. "subkeys": {
  11920. "type": "array",
  11921. "items": {
  11922. "$ref": "#/definitions/GPGKey"
  11923. },
  11924. "x-go-name": "SubsKey"
  11925. }
  11926. },
  11927. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11928. },
  11929. "GPGKeyEmail": {
  11930. "description": "GPGKeyEmail an email attached to a GPGKey",
  11931. "type": "object",
  11932. "properties": {
  11933. "email": {
  11934. "type": "string",
  11935. "x-go-name": "Email"
  11936. },
  11937. "verified": {
  11938. "type": "boolean",
  11939. "x-go-name": "Verified"
  11940. }
  11941. },
  11942. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11943. },
  11944. "GitBlobResponse": {
  11945. "description": "GitBlobResponse represents a git blob",
  11946. "type": "object",
  11947. "properties": {
  11948. "content": {
  11949. "type": "string",
  11950. "x-go-name": "Content"
  11951. },
  11952. "encoding": {
  11953. "type": "string",
  11954. "x-go-name": "Encoding"
  11955. },
  11956. "sha": {
  11957. "type": "string",
  11958. "x-go-name": "SHA"
  11959. },
  11960. "size": {
  11961. "type": "integer",
  11962. "format": "int64",
  11963. "x-go-name": "Size"
  11964. },
  11965. "url": {
  11966. "type": "string",
  11967. "x-go-name": "URL"
  11968. }
  11969. },
  11970. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11971. },
  11972. "GitEntry": {
  11973. "description": "GitEntry represents a git tree",
  11974. "type": "object",
  11975. "properties": {
  11976. "mode": {
  11977. "type": "string",
  11978. "x-go-name": "Mode"
  11979. },
  11980. "path": {
  11981. "type": "string",
  11982. "x-go-name": "Path"
  11983. },
  11984. "sha": {
  11985. "type": "string",
  11986. "x-go-name": "SHA"
  11987. },
  11988. "size": {
  11989. "type": "integer",
  11990. "format": "int64",
  11991. "x-go-name": "Size"
  11992. },
  11993. "type": {
  11994. "type": "string",
  11995. "x-go-name": "Type"
  11996. },
  11997. "url": {
  11998. "type": "string",
  11999. "x-go-name": "URL"
  12000. }
  12001. },
  12002. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12003. },
  12004. "GitHook": {
  12005. "description": "GitHook represents a Git repository hook",
  12006. "type": "object",
  12007. "properties": {
  12008. "content": {
  12009. "type": "string",
  12010. "x-go-name": "Content"
  12011. },
  12012. "is_active": {
  12013. "type": "boolean",
  12014. "x-go-name": "IsActive"
  12015. },
  12016. "name": {
  12017. "type": "string",
  12018. "x-go-name": "Name"
  12019. }
  12020. },
  12021. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12022. },
  12023. "GitObject": {
  12024. "type": "object",
  12025. "title": "GitObject represents a Git object.",
  12026. "properties": {
  12027. "sha": {
  12028. "type": "string",
  12029. "x-go-name": "SHA"
  12030. },
  12031. "type": {
  12032. "type": "string",
  12033. "x-go-name": "Type"
  12034. },
  12035. "url": {
  12036. "type": "string",
  12037. "x-go-name": "URL"
  12038. }
  12039. },
  12040. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12041. },
  12042. "GitTreeResponse": {
  12043. "description": "GitTreeResponse returns a git tree",
  12044. "type": "object",
  12045. "properties": {
  12046. "page": {
  12047. "type": "integer",
  12048. "format": "int64",
  12049. "x-go-name": "Page"
  12050. },
  12051. "sha": {
  12052. "type": "string",
  12053. "x-go-name": "SHA"
  12054. },
  12055. "total_count": {
  12056. "type": "integer",
  12057. "format": "int64",
  12058. "x-go-name": "TotalCount"
  12059. },
  12060. "tree": {
  12061. "type": "array",
  12062. "items": {
  12063. "$ref": "#/definitions/GitEntry"
  12064. },
  12065. "x-go-name": "Entries"
  12066. },
  12067. "truncated": {
  12068. "type": "boolean",
  12069. "x-go-name": "Truncated"
  12070. },
  12071. "url": {
  12072. "type": "string",
  12073. "x-go-name": "URL"
  12074. }
  12075. },
  12076. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12077. },
  12078. "Hook": {
  12079. "description": "Hook a hook is a web hook when one repository changed",
  12080. "type": "object",
  12081. "properties": {
  12082. "active": {
  12083. "type": "boolean",
  12084. "x-go-name": "Active"
  12085. },
  12086. "config": {
  12087. "type": "object",
  12088. "additionalProperties": {
  12089. "type": "string"
  12090. },
  12091. "x-go-name": "Config"
  12092. },
  12093. "created_at": {
  12094. "type": "string",
  12095. "format": "date-time",
  12096. "x-go-name": "Created"
  12097. },
  12098. "events": {
  12099. "type": "array",
  12100. "items": {
  12101. "type": "string"
  12102. },
  12103. "x-go-name": "Events"
  12104. },
  12105. "id": {
  12106. "type": "integer",
  12107. "format": "int64",
  12108. "x-go-name": "ID"
  12109. },
  12110. "type": {
  12111. "type": "string",
  12112. "x-go-name": "Type"
  12113. },
  12114. "updated_at": {
  12115. "type": "string",
  12116. "format": "date-time",
  12117. "x-go-name": "Updated"
  12118. }
  12119. },
  12120. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12121. },
  12122. "Identity": {
  12123. "description": "Identity for a person's identity like an author or committer",
  12124. "type": "object",
  12125. "properties": {
  12126. "email": {
  12127. "type": "string",
  12128. "format": "email",
  12129. "x-go-name": "Email"
  12130. },
  12131. "name": {
  12132. "type": "string",
  12133. "x-go-name": "Name"
  12134. }
  12135. },
  12136. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12137. },
  12138. "InternalTracker": {
  12139. "description": "InternalTracker represents settings for internal tracker",
  12140. "type": "object",
  12141. "properties": {
  12142. "allow_only_contributors_to_track_time": {
  12143. "description": "Let only contributors track time (Built-in issue tracker)",
  12144. "type": "boolean",
  12145. "x-go-name": "AllowOnlyContributorsToTrackTime"
  12146. },
  12147. "enable_issue_dependencies": {
  12148. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  12149. "type": "boolean",
  12150. "x-go-name": "EnableIssueDependencies"
  12151. },
  12152. "enable_time_tracker": {
  12153. "description": "Enable time tracking (Built-in issue tracker)",
  12154. "type": "boolean",
  12155. "x-go-name": "EnableTimeTracker"
  12156. }
  12157. },
  12158. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12159. },
  12160. "Issue": {
  12161. "description": "Issue represents an issue in a repository",
  12162. "type": "object",
  12163. "properties": {
  12164. "assignee": {
  12165. "$ref": "#/definitions/User"
  12166. },
  12167. "assignees": {
  12168. "type": "array",
  12169. "items": {
  12170. "$ref": "#/definitions/User"
  12171. },
  12172. "x-go-name": "Assignees"
  12173. },
  12174. "body": {
  12175. "type": "string",
  12176. "x-go-name": "Body"
  12177. },
  12178. "closed_at": {
  12179. "type": "string",
  12180. "format": "date-time",
  12181. "x-go-name": "Closed"
  12182. },
  12183. "comments": {
  12184. "type": "integer",
  12185. "format": "int64",
  12186. "x-go-name": "Comments"
  12187. },
  12188. "created_at": {
  12189. "type": "string",
  12190. "format": "date-time",
  12191. "x-go-name": "Created"
  12192. },
  12193. "due_date": {
  12194. "type": "string",
  12195. "format": "date-time",
  12196. "x-go-name": "Deadline"
  12197. },
  12198. "html_url": {
  12199. "type": "string",
  12200. "x-go-name": "HTMLURL"
  12201. },
  12202. "id": {
  12203. "type": "integer",
  12204. "format": "int64",
  12205. "x-go-name": "ID"
  12206. },
  12207. "labels": {
  12208. "type": "array",
  12209. "items": {
  12210. "$ref": "#/definitions/Label"
  12211. },
  12212. "x-go-name": "Labels"
  12213. },
  12214. "milestone": {
  12215. "$ref": "#/definitions/Milestone"
  12216. },
  12217. "number": {
  12218. "type": "integer",
  12219. "format": "int64",
  12220. "x-go-name": "Index"
  12221. },
  12222. "original_author": {
  12223. "type": "string",
  12224. "x-go-name": "OriginalAuthor"
  12225. },
  12226. "original_author_id": {
  12227. "type": "integer",
  12228. "format": "int64",
  12229. "x-go-name": "OriginalAuthorID"
  12230. },
  12231. "pull_request": {
  12232. "$ref": "#/definitions/PullRequestMeta"
  12233. },
  12234. "repository": {
  12235. "$ref": "#/definitions/RepositoryMeta"
  12236. },
  12237. "state": {
  12238. "$ref": "#/definitions/StateType"
  12239. },
  12240. "title": {
  12241. "type": "string",
  12242. "x-go-name": "Title"
  12243. },
  12244. "updated_at": {
  12245. "type": "string",
  12246. "format": "date-time",
  12247. "x-go-name": "Updated"
  12248. },
  12249. "url": {
  12250. "type": "string",
  12251. "x-go-name": "URL"
  12252. },
  12253. "user": {
  12254. "$ref": "#/definitions/User"
  12255. }
  12256. },
  12257. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12258. },
  12259. "IssueDeadline": {
  12260. "description": "IssueDeadline represents an issue deadline",
  12261. "type": "object",
  12262. "properties": {
  12263. "due_date": {
  12264. "type": "string",
  12265. "format": "date-time",
  12266. "x-go-name": "Deadline"
  12267. }
  12268. },
  12269. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12270. },
  12271. "IssueLabelsOption": {
  12272. "description": "IssueLabelsOption a collection of labels",
  12273. "type": "object",
  12274. "properties": {
  12275. "labels": {
  12276. "description": "list of label IDs",
  12277. "type": "array",
  12278. "items": {
  12279. "type": "integer",
  12280. "format": "int64"
  12281. },
  12282. "x-go-name": "Labels"
  12283. }
  12284. },
  12285. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12286. },
  12287. "Label": {
  12288. "description": "Label a label to an issue or a pr",
  12289. "type": "object",
  12290. "properties": {
  12291. "color": {
  12292. "type": "string",
  12293. "x-go-name": "Color",
  12294. "example": "00aabb"
  12295. },
  12296. "description": {
  12297. "type": "string",
  12298. "x-go-name": "Description"
  12299. },
  12300. "id": {
  12301. "type": "integer",
  12302. "format": "int64",
  12303. "x-go-name": "ID"
  12304. },
  12305. "name": {
  12306. "type": "string",
  12307. "x-go-name": "Name"
  12308. },
  12309. "url": {
  12310. "type": "string",
  12311. "x-go-name": "URL"
  12312. }
  12313. },
  12314. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12315. },
  12316. "MarkdownOption": {
  12317. "description": "MarkdownOption markdown options",
  12318. "type": "object",
  12319. "properties": {
  12320. "Context": {
  12321. "description": "Context to render\n\nin: body",
  12322. "type": "string"
  12323. },
  12324. "Mode": {
  12325. "description": "Mode to render\n\nin: body",
  12326. "type": "string"
  12327. },
  12328. "Text": {
  12329. "description": "Text markdown to render\n\nin: body",
  12330. "type": "string"
  12331. },
  12332. "Wiki": {
  12333. "description": "Is it a wiki page ?\n\nin: body",
  12334. "type": "boolean"
  12335. }
  12336. },
  12337. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12338. },
  12339. "MergePullRequestOption": {
  12340. "description": "MergePullRequestForm form for merging Pull Request",
  12341. "type": "object",
  12342. "required": [
  12343. "Do"
  12344. ],
  12345. "properties": {
  12346. "Do": {
  12347. "type": "string",
  12348. "enum": [
  12349. "merge",
  12350. "rebase",
  12351. "rebase-merge",
  12352. "squash"
  12353. ]
  12354. },
  12355. "MergeMessageField": {
  12356. "type": "string"
  12357. },
  12358. "MergeTitleField": {
  12359. "type": "string"
  12360. },
  12361. "force_merge": {
  12362. "type": "boolean",
  12363. "x-go-name": "ForceMerge"
  12364. }
  12365. },
  12366. "x-go-name": "MergePullRequestForm",
  12367. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12368. },
  12369. "MigrateRepoForm": {
  12370. "description": "MigrateRepoForm form for migrating repository",
  12371. "type": "object",
  12372. "required": [
  12373. "clone_addr",
  12374. "uid",
  12375. "repo_name"
  12376. ],
  12377. "properties": {
  12378. "auth_password": {
  12379. "type": "string",
  12380. "x-go-name": "AuthPassword"
  12381. },
  12382. "auth_username": {
  12383. "type": "string",
  12384. "x-go-name": "AuthUsername"
  12385. },
  12386. "clone_addr": {
  12387. "type": "string",
  12388. "x-go-name": "CloneAddr"
  12389. },
  12390. "description": {
  12391. "type": "string",
  12392. "x-go-name": "Description"
  12393. },
  12394. "issues": {
  12395. "type": "boolean",
  12396. "x-go-name": "Issues"
  12397. },
  12398. "labels": {
  12399. "type": "boolean",
  12400. "x-go-name": "Labels"
  12401. },
  12402. "milestones": {
  12403. "type": "boolean",
  12404. "x-go-name": "Milestones"
  12405. },
  12406. "mirror": {
  12407. "type": "boolean",
  12408. "x-go-name": "Mirror"
  12409. },
  12410. "private": {
  12411. "type": "boolean",
  12412. "x-go-name": "Private"
  12413. },
  12414. "pull_requests": {
  12415. "type": "boolean",
  12416. "x-go-name": "PullRequests"
  12417. },
  12418. "releases": {
  12419. "type": "boolean",
  12420. "x-go-name": "Releases"
  12421. },
  12422. "repo_name": {
  12423. "type": "string",
  12424. "x-go-name": "RepoName"
  12425. },
  12426. "uid": {
  12427. "type": "integer",
  12428. "format": "int64",
  12429. "x-go-name": "UID"
  12430. },
  12431. "wiki": {
  12432. "type": "boolean",
  12433. "x-go-name": "Wiki"
  12434. }
  12435. },
  12436. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12437. },
  12438. "Milestone": {
  12439. "description": "Milestone milestone is a collection of issues on one repository",
  12440. "type": "object",
  12441. "properties": {
  12442. "closed_at": {
  12443. "type": "string",
  12444. "format": "date-time",
  12445. "x-go-name": "Closed"
  12446. },
  12447. "closed_issues": {
  12448. "type": "integer",
  12449. "format": "int64",
  12450. "x-go-name": "ClosedIssues"
  12451. },
  12452. "description": {
  12453. "type": "string",
  12454. "x-go-name": "Description"
  12455. },
  12456. "due_on": {
  12457. "type": "string",
  12458. "format": "date-time",
  12459. "x-go-name": "Deadline"
  12460. },
  12461. "id": {
  12462. "type": "integer",
  12463. "format": "int64",
  12464. "x-go-name": "ID"
  12465. },
  12466. "open_issues": {
  12467. "type": "integer",
  12468. "format": "int64",
  12469. "x-go-name": "OpenIssues"
  12470. },
  12471. "state": {
  12472. "$ref": "#/definitions/StateType"
  12473. },
  12474. "title": {
  12475. "type": "string",
  12476. "x-go-name": "Title"
  12477. }
  12478. },
  12479. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12480. },
  12481. "NotificationCount": {
  12482. "description": "NotificationCount number of unread notifications",
  12483. "type": "object",
  12484. "properties": {
  12485. "new": {
  12486. "type": "integer",
  12487. "format": "int64",
  12488. "x-go-name": "New"
  12489. }
  12490. },
  12491. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12492. },
  12493. "NotificationSubject": {
  12494. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  12495. "type": "object",
  12496. "properties": {
  12497. "latest_comment_url": {
  12498. "type": "string",
  12499. "x-go-name": "LatestCommentURL"
  12500. },
  12501. "title": {
  12502. "type": "string",
  12503. "x-go-name": "Title"
  12504. },
  12505. "type": {
  12506. "type": "string",
  12507. "x-go-name": "Type"
  12508. },
  12509. "url": {
  12510. "type": "string",
  12511. "x-go-name": "URL"
  12512. }
  12513. },
  12514. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12515. },
  12516. "NotificationThread": {
  12517. "description": "NotificationThread expose Notification on API",
  12518. "type": "object",
  12519. "properties": {
  12520. "id": {
  12521. "type": "integer",
  12522. "format": "int64",
  12523. "x-go-name": "ID"
  12524. },
  12525. "pinned": {
  12526. "type": "boolean",
  12527. "x-go-name": "Pinned"
  12528. },
  12529. "repository": {
  12530. "$ref": "#/definitions/Repository"
  12531. },
  12532. "subject": {
  12533. "$ref": "#/definitions/NotificationSubject"
  12534. },
  12535. "unread": {
  12536. "type": "boolean",
  12537. "x-go-name": "Unread"
  12538. },
  12539. "updated_at": {
  12540. "type": "string",
  12541. "format": "date-time",
  12542. "x-go-name": "UpdatedAt"
  12543. },
  12544. "url": {
  12545. "type": "string",
  12546. "x-go-name": "URL"
  12547. }
  12548. },
  12549. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12550. },
  12551. "OAuth2Application": {
  12552. "type": "object",
  12553. "title": "OAuth2Application represents an OAuth2 application.",
  12554. "properties": {
  12555. "client_id": {
  12556. "type": "string",
  12557. "x-go-name": "ClientID"
  12558. },
  12559. "client_secret": {
  12560. "type": "string",
  12561. "x-go-name": "ClientSecret"
  12562. },
  12563. "created": {
  12564. "type": "string",
  12565. "format": "date-time",
  12566. "x-go-name": "Created"
  12567. },
  12568. "id": {
  12569. "type": "integer",
  12570. "format": "int64",
  12571. "x-go-name": "ID"
  12572. },
  12573. "name": {
  12574. "type": "string",
  12575. "x-go-name": "Name"
  12576. },
  12577. "redirect_uris": {
  12578. "type": "array",
  12579. "items": {
  12580. "type": "string"
  12581. },
  12582. "x-go-name": "RedirectURIs"
  12583. }
  12584. },
  12585. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12586. },
  12587. "Organization": {
  12588. "description": "Organization represents an organization",
  12589. "type": "object",
  12590. "properties": {
  12591. "avatar_url": {
  12592. "type": "string",
  12593. "x-go-name": "AvatarURL"
  12594. },
  12595. "description": {
  12596. "type": "string",
  12597. "x-go-name": "Description"
  12598. },
  12599. "full_name": {
  12600. "type": "string",
  12601. "x-go-name": "FullName"
  12602. },
  12603. "id": {
  12604. "type": "integer",
  12605. "format": "int64",
  12606. "x-go-name": "ID"
  12607. },
  12608. "location": {
  12609. "type": "string",
  12610. "x-go-name": "Location"
  12611. },
  12612. "repo_admin_change_team_access": {
  12613. "type": "boolean",
  12614. "x-go-name": "RepoAdminChangeTeamAccess"
  12615. },
  12616. "username": {
  12617. "type": "string",
  12618. "x-go-name": "UserName"
  12619. },
  12620. "visibility": {
  12621. "type": "string",
  12622. "x-go-name": "Visibility"
  12623. },
  12624. "website": {
  12625. "type": "string",
  12626. "x-go-name": "Website"
  12627. }
  12628. },
  12629. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12630. },
  12631. "PRBranchInfo": {
  12632. "description": "PRBranchInfo information about a branch",
  12633. "type": "object",
  12634. "properties": {
  12635. "label": {
  12636. "type": "string",
  12637. "x-go-name": "Name"
  12638. },
  12639. "ref": {
  12640. "type": "string",
  12641. "x-go-name": "Ref"
  12642. },
  12643. "repo": {
  12644. "$ref": "#/definitions/Repository"
  12645. },
  12646. "repo_id": {
  12647. "type": "integer",
  12648. "format": "int64",
  12649. "x-go-name": "RepoID"
  12650. },
  12651. "sha": {
  12652. "type": "string",
  12653. "x-go-name": "Sha"
  12654. }
  12655. },
  12656. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12657. },
  12658. "PayloadCommit": {
  12659. "description": "PayloadCommit represents a commit",
  12660. "type": "object",
  12661. "properties": {
  12662. "added": {
  12663. "type": "array",
  12664. "items": {
  12665. "type": "string"
  12666. },
  12667. "x-go-name": "Added"
  12668. },
  12669. "author": {
  12670. "$ref": "#/definitions/PayloadUser"
  12671. },
  12672. "committer": {
  12673. "$ref": "#/definitions/PayloadUser"
  12674. },
  12675. "id": {
  12676. "description": "sha1 hash of the commit",
  12677. "type": "string",
  12678. "x-go-name": "ID"
  12679. },
  12680. "message": {
  12681. "type": "string",
  12682. "x-go-name": "Message"
  12683. },
  12684. "modified": {
  12685. "type": "array",
  12686. "items": {
  12687. "type": "string"
  12688. },
  12689. "x-go-name": "Modified"
  12690. },
  12691. "removed": {
  12692. "type": "array",
  12693. "items": {
  12694. "type": "string"
  12695. },
  12696. "x-go-name": "Removed"
  12697. },
  12698. "timestamp": {
  12699. "type": "string",
  12700. "format": "date-time",
  12701. "x-go-name": "Timestamp"
  12702. },
  12703. "url": {
  12704. "type": "string",
  12705. "x-go-name": "URL"
  12706. },
  12707. "verification": {
  12708. "$ref": "#/definitions/PayloadCommitVerification"
  12709. }
  12710. },
  12711. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12712. },
  12713. "PayloadCommitVerification": {
  12714. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  12715. "type": "object",
  12716. "properties": {
  12717. "payload": {
  12718. "type": "string",
  12719. "x-go-name": "Payload"
  12720. },
  12721. "reason": {
  12722. "type": "string",
  12723. "x-go-name": "Reason"
  12724. },
  12725. "signature": {
  12726. "type": "string",
  12727. "x-go-name": "Signature"
  12728. },
  12729. "signer": {
  12730. "$ref": "#/definitions/PayloadUser"
  12731. },
  12732. "verified": {
  12733. "type": "boolean",
  12734. "x-go-name": "Verified"
  12735. }
  12736. },
  12737. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12738. },
  12739. "PayloadUser": {
  12740. "description": "PayloadUser represents the author or committer of a commit",
  12741. "type": "object",
  12742. "properties": {
  12743. "email": {
  12744. "type": "string",
  12745. "format": "email",
  12746. "x-go-name": "Email"
  12747. },
  12748. "name": {
  12749. "description": "Full name of the commit author",
  12750. "type": "string",
  12751. "x-go-name": "Name"
  12752. },
  12753. "username": {
  12754. "type": "string",
  12755. "x-go-name": "UserName"
  12756. }
  12757. },
  12758. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12759. },
  12760. "Permission": {
  12761. "description": "Permission represents a set of permissions",
  12762. "type": "object",
  12763. "properties": {
  12764. "admin": {
  12765. "type": "boolean",
  12766. "x-go-name": "Admin"
  12767. },
  12768. "pull": {
  12769. "type": "boolean",
  12770. "x-go-name": "Pull"
  12771. },
  12772. "push": {
  12773. "type": "boolean",
  12774. "x-go-name": "Push"
  12775. }
  12776. },
  12777. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12778. },
  12779. "PublicKey": {
  12780. "description": "PublicKey publickey is a user key to push code to repository",
  12781. "type": "object",
  12782. "properties": {
  12783. "created_at": {
  12784. "type": "string",
  12785. "format": "date-time",
  12786. "x-go-name": "Created"
  12787. },
  12788. "fingerprint": {
  12789. "type": "string",
  12790. "x-go-name": "Fingerprint"
  12791. },
  12792. "id": {
  12793. "type": "integer",
  12794. "format": "int64",
  12795. "x-go-name": "ID"
  12796. },
  12797. "key": {
  12798. "type": "string",
  12799. "x-go-name": "Key"
  12800. },
  12801. "key_type": {
  12802. "type": "string",
  12803. "x-go-name": "KeyType"
  12804. },
  12805. "read_only": {
  12806. "type": "boolean",
  12807. "x-go-name": "ReadOnly"
  12808. },
  12809. "title": {
  12810. "type": "string",
  12811. "x-go-name": "Title"
  12812. },
  12813. "url": {
  12814. "type": "string",
  12815. "x-go-name": "URL"
  12816. },
  12817. "user": {
  12818. "$ref": "#/definitions/User"
  12819. }
  12820. },
  12821. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12822. },
  12823. "PullRequest": {
  12824. "description": "PullRequest represents a pull request",
  12825. "type": "object",
  12826. "properties": {
  12827. "assignee": {
  12828. "$ref": "#/definitions/User"
  12829. },
  12830. "assignees": {
  12831. "type": "array",
  12832. "items": {
  12833. "$ref": "#/definitions/User"
  12834. },
  12835. "x-go-name": "Assignees"
  12836. },
  12837. "base": {
  12838. "$ref": "#/definitions/PRBranchInfo"
  12839. },
  12840. "body": {
  12841. "type": "string",
  12842. "x-go-name": "Body"
  12843. },
  12844. "closed_at": {
  12845. "type": "string",
  12846. "format": "date-time",
  12847. "x-go-name": "Closed"
  12848. },
  12849. "comments": {
  12850. "type": "integer",
  12851. "format": "int64",
  12852. "x-go-name": "Comments"
  12853. },
  12854. "created_at": {
  12855. "type": "string",
  12856. "format": "date-time",
  12857. "x-go-name": "Created"
  12858. },
  12859. "diff_url": {
  12860. "type": "string",
  12861. "x-go-name": "DiffURL"
  12862. },
  12863. "due_date": {
  12864. "type": "string",
  12865. "format": "date-time",
  12866. "x-go-name": "Deadline"
  12867. },
  12868. "head": {
  12869. "$ref": "#/definitions/PRBranchInfo"
  12870. },
  12871. "html_url": {
  12872. "type": "string",
  12873. "x-go-name": "HTMLURL"
  12874. },
  12875. "id": {
  12876. "type": "integer",
  12877. "format": "int64",
  12878. "x-go-name": "ID"
  12879. },
  12880. "labels": {
  12881. "type": "array",
  12882. "items": {
  12883. "$ref": "#/definitions/Label"
  12884. },
  12885. "x-go-name": "Labels"
  12886. },
  12887. "merge_base": {
  12888. "type": "string",
  12889. "x-go-name": "MergeBase"
  12890. },
  12891. "merge_commit_sha": {
  12892. "type": "string",
  12893. "x-go-name": "MergedCommitID"
  12894. },
  12895. "mergeable": {
  12896. "type": "boolean",
  12897. "x-go-name": "Mergeable"
  12898. },
  12899. "merged": {
  12900. "type": "boolean",
  12901. "x-go-name": "HasMerged"
  12902. },
  12903. "merged_at": {
  12904. "type": "string",
  12905. "format": "date-time",
  12906. "x-go-name": "Merged"
  12907. },
  12908. "merged_by": {
  12909. "$ref": "#/definitions/User"
  12910. },
  12911. "milestone": {
  12912. "$ref": "#/definitions/Milestone"
  12913. },
  12914. "number": {
  12915. "type": "integer",
  12916. "format": "int64",
  12917. "x-go-name": "Index"
  12918. },
  12919. "patch_url": {
  12920. "type": "string",
  12921. "x-go-name": "PatchURL"
  12922. },
  12923. "state": {
  12924. "$ref": "#/definitions/StateType"
  12925. },
  12926. "title": {
  12927. "type": "string",
  12928. "x-go-name": "Title"
  12929. },
  12930. "updated_at": {
  12931. "type": "string",
  12932. "format": "date-time",
  12933. "x-go-name": "Updated"
  12934. },
  12935. "url": {
  12936. "type": "string",
  12937. "x-go-name": "URL"
  12938. },
  12939. "user": {
  12940. "$ref": "#/definitions/User"
  12941. }
  12942. },
  12943. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12944. },
  12945. "PullRequestMeta": {
  12946. "description": "PullRequestMeta PR info if an issue is a PR",
  12947. "type": "object",
  12948. "properties": {
  12949. "merged": {
  12950. "type": "boolean",
  12951. "x-go-name": "HasMerged"
  12952. },
  12953. "merged_at": {
  12954. "type": "string",
  12955. "format": "date-time",
  12956. "x-go-name": "Merged"
  12957. }
  12958. },
  12959. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12960. },
  12961. "Reaction": {
  12962. "description": "Reaction contain one reaction",
  12963. "type": "object",
  12964. "properties": {
  12965. "content": {
  12966. "type": "string",
  12967. "x-go-name": "Reaction"
  12968. },
  12969. "created_at": {
  12970. "type": "string",
  12971. "format": "date-time",
  12972. "x-go-name": "Created"
  12973. },
  12974. "user": {
  12975. "$ref": "#/definitions/User"
  12976. }
  12977. },
  12978. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12979. },
  12980. "Reference": {
  12981. "type": "object",
  12982. "title": "Reference represents a Git reference.",
  12983. "properties": {
  12984. "object": {
  12985. "$ref": "#/definitions/GitObject"
  12986. },
  12987. "ref": {
  12988. "type": "string",
  12989. "x-go-name": "Ref"
  12990. },
  12991. "url": {
  12992. "type": "string",
  12993. "x-go-name": "URL"
  12994. }
  12995. },
  12996. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12997. },
  12998. "Release": {
  12999. "description": "Release represents a repository release",
  13000. "type": "object",
  13001. "properties": {
  13002. "assets": {
  13003. "type": "array",
  13004. "items": {
  13005. "$ref": "#/definitions/Attachment"
  13006. },
  13007. "x-go-name": "Attachments"
  13008. },
  13009. "author": {
  13010. "$ref": "#/definitions/User"
  13011. },
  13012. "body": {
  13013. "type": "string",
  13014. "x-go-name": "Note"
  13015. },
  13016. "created_at": {
  13017. "type": "string",
  13018. "format": "date-time",
  13019. "x-go-name": "CreatedAt"
  13020. },
  13021. "draft": {
  13022. "type": "boolean",
  13023. "x-go-name": "IsDraft"
  13024. },
  13025. "id": {
  13026. "type": "integer",
  13027. "format": "int64",
  13028. "x-go-name": "ID"
  13029. },
  13030. "name": {
  13031. "type": "string",
  13032. "x-go-name": "Title"
  13033. },
  13034. "prerelease": {
  13035. "type": "boolean",
  13036. "x-go-name": "IsPrerelease"
  13037. },
  13038. "published_at": {
  13039. "type": "string",
  13040. "format": "date-time",
  13041. "x-go-name": "PublishedAt"
  13042. },
  13043. "tag_name": {
  13044. "type": "string",
  13045. "x-go-name": "TagName"
  13046. },
  13047. "tarball_url": {
  13048. "type": "string",
  13049. "x-go-name": "TarURL"
  13050. },
  13051. "target_commitish": {
  13052. "type": "string",
  13053. "x-go-name": "Target"
  13054. },
  13055. "url": {
  13056. "type": "string",
  13057. "x-go-name": "URL"
  13058. },
  13059. "zipball_url": {
  13060. "type": "string",
  13061. "x-go-name": "ZipURL"
  13062. }
  13063. },
  13064. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13065. },
  13066. "RepoCommit": {
  13067. "type": "object",
  13068. "title": "RepoCommit contains information of a commit in the context of a repository.",
  13069. "properties": {
  13070. "author": {
  13071. "$ref": "#/definitions/CommitUser"
  13072. },
  13073. "committer": {
  13074. "$ref": "#/definitions/CommitUser"
  13075. },
  13076. "message": {
  13077. "type": "string",
  13078. "x-go-name": "Message"
  13079. },
  13080. "tree": {
  13081. "$ref": "#/definitions/CommitMeta"
  13082. },
  13083. "url": {
  13084. "type": "string",
  13085. "x-go-name": "URL"
  13086. }
  13087. },
  13088. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13089. },
  13090. "RepoTopicOptions": {
  13091. "description": "RepoTopicOptions a collection of repo topic names",
  13092. "type": "object",
  13093. "properties": {
  13094. "topics": {
  13095. "description": "list of topic names",
  13096. "type": "array",
  13097. "items": {
  13098. "type": "string"
  13099. },
  13100. "x-go-name": "Topics"
  13101. }
  13102. },
  13103. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13104. },
  13105. "Repository": {
  13106. "description": "Repository represents a repository",
  13107. "type": "object",
  13108. "properties": {
  13109. "allow_merge_commits": {
  13110. "type": "boolean",
  13111. "x-go-name": "AllowMerge"
  13112. },
  13113. "allow_rebase": {
  13114. "type": "boolean",
  13115. "x-go-name": "AllowRebase"
  13116. },
  13117. "allow_rebase_explicit": {
  13118. "type": "boolean",
  13119. "x-go-name": "AllowRebaseMerge"
  13120. },
  13121. "allow_squash_merge": {
  13122. "type": "boolean",
  13123. "x-go-name": "AllowSquash"
  13124. },
  13125. "archived": {
  13126. "type": "boolean",
  13127. "x-go-name": "Archived"
  13128. },
  13129. "avatar_url": {
  13130. "type": "string",
  13131. "x-go-name": "AvatarURL"
  13132. },
  13133. "clone_url": {
  13134. "type": "string",
  13135. "x-go-name": "CloneURL"
  13136. },
  13137. "created_at": {
  13138. "type": "string",
  13139. "format": "date-time",
  13140. "x-go-name": "Created"
  13141. },
  13142. "default_branch": {
  13143. "type": "string",
  13144. "x-go-name": "DefaultBranch"
  13145. },
  13146. "description": {
  13147. "type": "string",
  13148. "x-go-name": "Description"
  13149. },
  13150. "empty": {
  13151. "type": "boolean",
  13152. "x-go-name": "Empty"
  13153. },
  13154. "external_tracker": {
  13155. "$ref": "#/definitions/ExternalTracker"
  13156. },
  13157. "external_wiki": {
  13158. "$ref": "#/definitions/ExternalWiki"
  13159. },
  13160. "fork": {
  13161. "type": "boolean",
  13162. "x-go-name": "Fork"
  13163. },
  13164. "forks_count": {
  13165. "type": "integer",
  13166. "format": "int64",
  13167. "x-go-name": "Forks"
  13168. },
  13169. "full_name": {
  13170. "type": "string",
  13171. "x-go-name": "FullName"
  13172. },
  13173. "has_issues": {
  13174. "type": "boolean",
  13175. "x-go-name": "HasIssues"
  13176. },
  13177. "has_pull_requests": {
  13178. "type": "boolean",
  13179. "x-go-name": "HasPullRequests"
  13180. },
  13181. "has_wiki": {
  13182. "type": "boolean",
  13183. "x-go-name": "HasWiki"
  13184. },
  13185. "html_url": {
  13186. "type": "string",
  13187. "x-go-name": "HTMLURL"
  13188. },
  13189. "id": {
  13190. "type": "integer",
  13191. "format": "int64",
  13192. "x-go-name": "ID"
  13193. },
  13194. "ignore_whitespace_conflicts": {
  13195. "type": "boolean",
  13196. "x-go-name": "IgnoreWhitespaceConflicts"
  13197. },
  13198. "internal_tracker": {
  13199. "$ref": "#/definitions/InternalTracker"
  13200. },
  13201. "mirror": {
  13202. "type": "boolean",
  13203. "x-go-name": "Mirror"
  13204. },
  13205. "name": {
  13206. "type": "string",
  13207. "x-go-name": "Name"
  13208. },
  13209. "open_issues_count": {
  13210. "type": "integer",
  13211. "format": "int64",
  13212. "x-go-name": "OpenIssues"
  13213. },
  13214. "open_pr_counter": {
  13215. "type": "integer",
  13216. "format": "int64",
  13217. "x-go-name": "OpenPulls"
  13218. },
  13219. "original_url": {
  13220. "type": "string",
  13221. "x-go-name": "OriginalURL"
  13222. },
  13223. "owner": {
  13224. "$ref": "#/definitions/User"
  13225. },
  13226. "parent": {
  13227. "$ref": "#/definitions/Repository"
  13228. },
  13229. "permissions": {
  13230. "$ref": "#/definitions/Permission"
  13231. },
  13232. "private": {
  13233. "type": "boolean",
  13234. "x-go-name": "Private"
  13235. },
  13236. "release_counter": {
  13237. "type": "integer",
  13238. "format": "int64",
  13239. "x-go-name": "Releases"
  13240. },
  13241. "size": {
  13242. "type": "integer",
  13243. "format": "int64",
  13244. "x-go-name": "Size"
  13245. },
  13246. "ssh_url": {
  13247. "type": "string",
  13248. "x-go-name": "SSHURL"
  13249. },
  13250. "stars_count": {
  13251. "type": "integer",
  13252. "format": "int64",
  13253. "x-go-name": "Stars"
  13254. },
  13255. "template": {
  13256. "type": "boolean",
  13257. "x-go-name": "Template"
  13258. },
  13259. "updated_at": {
  13260. "type": "string",
  13261. "format": "date-time",
  13262. "x-go-name": "Updated"
  13263. },
  13264. "watchers_count": {
  13265. "type": "integer",
  13266. "format": "int64",
  13267. "x-go-name": "Watchers"
  13268. },
  13269. "website": {
  13270. "type": "string",
  13271. "x-go-name": "Website"
  13272. }
  13273. },
  13274. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13275. },
  13276. "RepositoryMeta": {
  13277. "description": "RepositoryMeta basic repository information",
  13278. "type": "object",
  13279. "properties": {
  13280. "full_name": {
  13281. "type": "string",
  13282. "x-go-name": "FullName"
  13283. },
  13284. "id": {
  13285. "type": "integer",
  13286. "format": "int64",
  13287. "x-go-name": "ID"
  13288. },
  13289. "name": {
  13290. "type": "string",
  13291. "x-go-name": "Name"
  13292. },
  13293. "owner": {
  13294. "type": "string",
  13295. "x-go-name": "Owner"
  13296. }
  13297. },
  13298. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13299. },
  13300. "SearchResults": {
  13301. "description": "SearchResults results of a successful search",
  13302. "type": "object",
  13303. "properties": {
  13304. "data": {
  13305. "type": "array",
  13306. "items": {
  13307. "$ref": "#/definitions/Repository"
  13308. },
  13309. "x-go-name": "Data"
  13310. },
  13311. "ok": {
  13312. "type": "boolean",
  13313. "x-go-name": "OK"
  13314. }
  13315. },
  13316. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13317. },
  13318. "ServerVersion": {
  13319. "description": "ServerVersion wraps the version of the server",
  13320. "type": "object",
  13321. "properties": {
  13322. "version": {
  13323. "type": "string",
  13324. "x-go-name": "Version"
  13325. }
  13326. },
  13327. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13328. },
  13329. "StateType": {
  13330. "description": "StateType issue state type",
  13331. "type": "string",
  13332. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13333. },
  13334. "Status": {
  13335. "description": "Status holds a single Status of a single Commit",
  13336. "type": "object",
  13337. "properties": {
  13338. "context": {
  13339. "type": "string",
  13340. "x-go-name": "Context"
  13341. },
  13342. "created_at": {
  13343. "type": "string",
  13344. "format": "date-time",
  13345. "x-go-name": "Created"
  13346. },
  13347. "creator": {
  13348. "$ref": "#/definitions/User"
  13349. },
  13350. "description": {
  13351. "type": "string",
  13352. "x-go-name": "Description"
  13353. },
  13354. "id": {
  13355. "type": "integer",
  13356. "format": "int64",
  13357. "x-go-name": "ID"
  13358. },
  13359. "status": {
  13360. "$ref": "#/definitions/StatusState"
  13361. },
  13362. "target_url": {
  13363. "type": "string",
  13364. "x-go-name": "TargetURL"
  13365. },
  13366. "updated_at": {
  13367. "type": "string",
  13368. "format": "date-time",
  13369. "x-go-name": "Updated"
  13370. },
  13371. "url": {
  13372. "type": "string",
  13373. "x-go-name": "URL"
  13374. }
  13375. },
  13376. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13377. },
  13378. "StatusState": {
  13379. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  13380. "type": "string",
  13381. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13382. },
  13383. "StopWatch": {
  13384. "description": "StopWatch represent a running stopwatch",
  13385. "type": "object",
  13386. "properties": {
  13387. "created": {
  13388. "type": "string",
  13389. "format": "date-time",
  13390. "x-go-name": "Created"
  13391. },
  13392. "issue_index": {
  13393. "type": "integer",
  13394. "format": "int64",
  13395. "x-go-name": "IssueIndex"
  13396. }
  13397. },
  13398. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13399. },
  13400. "Tag": {
  13401. "description": "Tag represents a repository tag",
  13402. "type": "object",
  13403. "properties": {
  13404. "commit": {
  13405. "$ref": "#/definitions/CommitMeta"
  13406. },
  13407. "id": {
  13408. "type": "string",
  13409. "x-go-name": "ID"
  13410. },
  13411. "name": {
  13412. "type": "string",
  13413. "x-go-name": "Name"
  13414. },
  13415. "tarball_url": {
  13416. "type": "string",
  13417. "x-go-name": "TarballURL"
  13418. },
  13419. "zipball_url": {
  13420. "type": "string",
  13421. "x-go-name": "ZipballURL"
  13422. }
  13423. },
  13424. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13425. },
  13426. "Team": {
  13427. "description": "Team represents a team in an organization",
  13428. "type": "object",
  13429. "properties": {
  13430. "can_create_org_repo": {
  13431. "type": "boolean",
  13432. "x-go-name": "CanCreateOrgRepo"
  13433. },
  13434. "description": {
  13435. "type": "string",
  13436. "x-go-name": "Description"
  13437. },
  13438. "id": {
  13439. "type": "integer",
  13440. "format": "int64",
  13441. "x-go-name": "ID"
  13442. },
  13443. "includes_all_repositories": {
  13444. "type": "boolean",
  13445. "x-go-name": "IncludesAllRepositories"
  13446. },
  13447. "name": {
  13448. "type": "string",
  13449. "x-go-name": "Name"
  13450. },
  13451. "organization": {
  13452. "$ref": "#/definitions/Organization"
  13453. },
  13454. "permission": {
  13455. "type": "string",
  13456. "enum": [
  13457. "none",
  13458. "read",
  13459. "write",
  13460. "admin",
  13461. "owner"
  13462. ],
  13463. "x-go-name": "Permission"
  13464. },
  13465. "units": {
  13466. "type": "array",
  13467. "items": {
  13468. "type": "string"
  13469. },
  13470. "x-go-name": "Units",
  13471. "example": [
  13472. "repo.code",
  13473. "repo.issues",
  13474. "repo.ext_issues",
  13475. "repo.wiki",
  13476. "repo.pulls",
  13477. "repo.releases",
  13478. "repo.ext_wiki"
  13479. ]
  13480. }
  13481. },
  13482. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13483. },
  13484. "TimeStamp": {
  13485. "description": "TimeStamp defines a timestamp",
  13486. "type": "integer",
  13487. "format": "int64",
  13488. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  13489. },
  13490. "TopicName": {
  13491. "description": "TopicName a list of repo topic names",
  13492. "type": "object",
  13493. "properties": {
  13494. "topics": {
  13495. "type": "array",
  13496. "items": {
  13497. "type": "string"
  13498. },
  13499. "x-go-name": "TopicNames"
  13500. }
  13501. },
  13502. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13503. },
  13504. "TopicResponse": {
  13505. "description": "TopicResponse for returning topics",
  13506. "type": "object",
  13507. "properties": {
  13508. "created": {
  13509. "type": "string",
  13510. "format": "date-time",
  13511. "x-go-name": "Created"
  13512. },
  13513. "id": {
  13514. "type": "integer",
  13515. "format": "int64",
  13516. "x-go-name": "ID"
  13517. },
  13518. "repo_count": {
  13519. "type": "integer",
  13520. "format": "int64",
  13521. "x-go-name": "RepoCount"
  13522. },
  13523. "topic_name": {
  13524. "type": "string",
  13525. "x-go-name": "Name"
  13526. },
  13527. "updated": {
  13528. "type": "string",
  13529. "format": "date-time",
  13530. "x-go-name": "Updated"
  13531. }
  13532. },
  13533. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13534. },
  13535. "TrackedTime": {
  13536. "description": "TrackedTime worked time for an issue / pr",
  13537. "type": "object",
  13538. "properties": {
  13539. "created": {
  13540. "type": "string",
  13541. "format": "date-time",
  13542. "x-go-name": "Created"
  13543. },
  13544. "id": {
  13545. "type": "integer",
  13546. "format": "int64",
  13547. "x-go-name": "ID"
  13548. },
  13549. "issue": {
  13550. "$ref": "#/definitions/Issue"
  13551. },
  13552. "issue_id": {
  13553. "description": "deprecated (only for backwards compatibility)",
  13554. "type": "integer",
  13555. "format": "int64",
  13556. "x-go-name": "IssueID"
  13557. },
  13558. "time": {
  13559. "description": "Time in seconds",
  13560. "type": "integer",
  13561. "format": "int64",
  13562. "x-go-name": "Time"
  13563. },
  13564. "user_id": {
  13565. "description": "deprecated (only for backwards compatibility)",
  13566. "type": "integer",
  13567. "format": "int64",
  13568. "x-go-name": "UserID"
  13569. },
  13570. "user_name": {
  13571. "type": "string",
  13572. "x-go-name": "UserName"
  13573. }
  13574. },
  13575. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13576. },
  13577. "TransferRepoOption": {
  13578. "description": "TransferRepoOption options when transfer a repository's ownership",
  13579. "type": "object",
  13580. "required": [
  13581. "new_owner"
  13582. ],
  13583. "properties": {
  13584. "new_owner": {
  13585. "type": "string",
  13586. "x-go-name": "NewOwner"
  13587. },
  13588. "team_ids": {
  13589. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  13590. "type": "array",
  13591. "items": {
  13592. "type": "integer",
  13593. "format": "int64"
  13594. },
  13595. "x-go-name": "TeamIDs"
  13596. }
  13597. },
  13598. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13599. },
  13600. "UpdateFileOptions": {
  13601. "description": "UpdateFileOptions options for updating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
  13602. "type": "object",
  13603. "required": [
  13604. "sha",
  13605. "content"
  13606. ],
  13607. "properties": {
  13608. "author": {
  13609. "$ref": "#/definitions/Identity"
  13610. },
  13611. "branch": {
  13612. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  13613. "type": "string",
  13614. "x-go-name": "BranchName"
  13615. },
  13616. "committer": {
  13617. "$ref": "#/definitions/Identity"
  13618. },
  13619. "content": {
  13620. "description": "content must be base64 encoded",
  13621. "type": "string",
  13622. "x-go-name": "Content"
  13623. },
  13624. "dates": {
  13625. "$ref": "#/definitions/CommitDateOptions"
  13626. },
  13627. "from_path": {
  13628. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  13629. "type": "string",
  13630. "x-go-name": "FromPath"
  13631. },
  13632. "message": {
  13633. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  13634. "type": "string",
  13635. "x-go-name": "Message"
  13636. },
  13637. "new_branch": {
  13638. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  13639. "type": "string",
  13640. "x-go-name": "NewBranchName"
  13641. },
  13642. "sha": {
  13643. "description": "sha is the SHA for the file that already exists",
  13644. "type": "string",
  13645. "x-go-name": "SHA"
  13646. }
  13647. },
  13648. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13649. },
  13650. "User": {
  13651. "description": "User represents a user",
  13652. "type": "object",
  13653. "properties": {
  13654. "avatar_url": {
  13655. "description": "URL to the user's avatar",
  13656. "type": "string",
  13657. "x-go-name": "AvatarURL"
  13658. },
  13659. "created": {
  13660. "type": "string",
  13661. "format": "date-time",
  13662. "x-go-name": "Created"
  13663. },
  13664. "email": {
  13665. "type": "string",
  13666. "format": "email",
  13667. "x-go-name": "Email"
  13668. },
  13669. "full_name": {
  13670. "description": "the user's full name",
  13671. "type": "string",
  13672. "x-go-name": "FullName"
  13673. },
  13674. "id": {
  13675. "description": "the user's id",
  13676. "type": "integer",
  13677. "format": "int64",
  13678. "x-go-name": "ID"
  13679. },
  13680. "is_admin": {
  13681. "description": "Is the user an administrator",
  13682. "type": "boolean",
  13683. "x-go-name": "IsAdmin"
  13684. },
  13685. "language": {
  13686. "description": "User locale",
  13687. "type": "string",
  13688. "x-go-name": "Language"
  13689. },
  13690. "last_login": {
  13691. "type": "string",
  13692. "format": "date-time",
  13693. "x-go-name": "LastLogin"
  13694. },
  13695. "login": {
  13696. "description": "the user's username",
  13697. "type": "string",
  13698. "x-go-name": "UserName"
  13699. }
  13700. },
  13701. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13702. },
  13703. "UserHeatmapData": {
  13704. "description": "UserHeatmapData represents the data needed to create a heatmap",
  13705. "type": "object",
  13706. "properties": {
  13707. "contributions": {
  13708. "type": "integer",
  13709. "format": "int64",
  13710. "x-go-name": "Contributions"
  13711. },
  13712. "timestamp": {
  13713. "$ref": "#/definitions/TimeStamp"
  13714. }
  13715. },
  13716. "x-go-package": "code.gitea.io/gitea/models"
  13717. },
  13718. "WatchInfo": {
  13719. "description": "WatchInfo represents an API watch status of one repository",
  13720. "type": "object",
  13721. "properties": {
  13722. "created_at": {
  13723. "type": "string",
  13724. "format": "date-time",
  13725. "x-go-name": "CreatedAt"
  13726. },
  13727. "ignored": {
  13728. "type": "boolean",
  13729. "x-go-name": "Ignored"
  13730. },
  13731. "reason": {
  13732. "type": "object",
  13733. "x-go-name": "Reason"
  13734. },
  13735. "repository_url": {
  13736. "type": "string",
  13737. "x-go-name": "RepositoryURL"
  13738. },
  13739. "subscribed": {
  13740. "type": "boolean",
  13741. "x-go-name": "Subscribed"
  13742. },
  13743. "url": {
  13744. "type": "string",
  13745. "x-go-name": "URL"
  13746. }
  13747. },
  13748. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13749. }
  13750. },
  13751. "responses": {
  13752. "AccessToken": {
  13753. "description": "AccessToken represents an API access token.",
  13754. "headers": {
  13755. "id": {
  13756. "type": "integer",
  13757. "format": "int64"
  13758. },
  13759. "name": {
  13760. "type": "string"
  13761. },
  13762. "sha1": {
  13763. "type": "string"
  13764. },
  13765. "token_last_eight": {
  13766. "type": "string"
  13767. }
  13768. }
  13769. },
  13770. "AccessTokenList": {
  13771. "description": "AccessTokenList represents a list of API access token.",
  13772. "schema": {
  13773. "type": "array",
  13774. "items": {
  13775. "$ref": "#/definitions/AccessToken"
  13776. }
  13777. }
  13778. },
  13779. "AnnotatedTag": {
  13780. "description": "AnnotatedTag",
  13781. "schema": {
  13782. "$ref": "#/definitions/AnnotatedTag"
  13783. }
  13784. },
  13785. "Attachment": {
  13786. "description": "Attachment",
  13787. "schema": {
  13788. "$ref": "#/definitions/Attachment"
  13789. }
  13790. },
  13791. "AttachmentList": {
  13792. "description": "AttachmentList",
  13793. "schema": {
  13794. "type": "array",
  13795. "items": {
  13796. "$ref": "#/definitions/Attachment"
  13797. }
  13798. }
  13799. },
  13800. "Branch": {
  13801. "description": "Branch",
  13802. "schema": {
  13803. "$ref": "#/definitions/Branch"
  13804. }
  13805. },
  13806. "BranchList": {
  13807. "description": "BranchList",
  13808. "schema": {
  13809. "type": "array",
  13810. "items": {
  13811. "$ref": "#/definitions/Branch"
  13812. }
  13813. }
  13814. },
  13815. "BranchProtection": {
  13816. "description": "BranchProtection",
  13817. "schema": {
  13818. "$ref": "#/definitions/BranchProtection"
  13819. }
  13820. },
  13821. "BranchProtectionList": {
  13822. "description": "BranchProtectionList",
  13823. "schema": {
  13824. "type": "array",
  13825. "items": {
  13826. "$ref": "#/definitions/BranchProtection"
  13827. }
  13828. }
  13829. },
  13830. "Comment": {
  13831. "description": "Comment",
  13832. "schema": {
  13833. "$ref": "#/definitions/Comment"
  13834. }
  13835. },
  13836. "CommentList": {
  13837. "description": "CommentList",
  13838. "schema": {
  13839. "type": "array",
  13840. "items": {
  13841. "$ref": "#/definitions/Comment"
  13842. }
  13843. }
  13844. },
  13845. "Commit": {
  13846. "description": "Commit",
  13847. "schema": {
  13848. "$ref": "#/definitions/Commit"
  13849. }
  13850. },
  13851. "CommitList": {
  13852. "description": "CommitList",
  13853. "schema": {
  13854. "type": "array",
  13855. "items": {
  13856. "$ref": "#/definitions/Commit"
  13857. }
  13858. },
  13859. "headers": {
  13860. "X-HasMore": {
  13861. "type": "boolean",
  13862. "description": "True if there is another page"
  13863. },
  13864. "X-Page": {
  13865. "type": "integer",
  13866. "format": "int64",
  13867. "description": "The current page"
  13868. },
  13869. "X-PageCount": {
  13870. "type": "integer",
  13871. "format": "int64",
  13872. "description": "Total number of pages"
  13873. },
  13874. "X-PerPage": {
  13875. "type": "integer",
  13876. "format": "int64",
  13877. "description": "Commits per page"
  13878. },
  13879. "X-Total": {
  13880. "type": "integer",
  13881. "format": "int64",
  13882. "description": "Total commit count"
  13883. }
  13884. }
  13885. },
  13886. "ContentsListResponse": {
  13887. "description": "ContentsListResponse",
  13888. "schema": {
  13889. "type": "array",
  13890. "items": {
  13891. "$ref": "#/definitions/ContentsResponse"
  13892. }
  13893. }
  13894. },
  13895. "ContentsResponse": {
  13896. "description": "ContentsResponse",
  13897. "schema": {
  13898. "$ref": "#/definitions/ContentsResponse"
  13899. }
  13900. },
  13901. "DeployKey": {
  13902. "description": "DeployKey",
  13903. "schema": {
  13904. "$ref": "#/definitions/DeployKey"
  13905. }
  13906. },
  13907. "DeployKeyList": {
  13908. "description": "DeployKeyList",
  13909. "schema": {
  13910. "type": "array",
  13911. "items": {
  13912. "$ref": "#/definitions/DeployKey"
  13913. }
  13914. }
  13915. },
  13916. "EmailList": {
  13917. "description": "EmailList",
  13918. "schema": {
  13919. "type": "array",
  13920. "items": {
  13921. "$ref": "#/definitions/Email"
  13922. }
  13923. }
  13924. },
  13925. "EmptyRepository": {
  13926. "description": "EmptyRepository",
  13927. "schema": {
  13928. "$ref": "#/definitions/APIError"
  13929. }
  13930. },
  13931. "FileDeleteResponse": {
  13932. "description": "FileDeleteResponse",
  13933. "schema": {
  13934. "$ref": "#/definitions/FileDeleteResponse"
  13935. }
  13936. },
  13937. "FileResponse": {
  13938. "description": "FileResponse",
  13939. "schema": {
  13940. "$ref": "#/definitions/FileResponse"
  13941. }
  13942. },
  13943. "GPGKey": {
  13944. "description": "GPGKey",
  13945. "schema": {
  13946. "$ref": "#/definitions/GPGKey"
  13947. }
  13948. },
  13949. "GPGKeyList": {
  13950. "description": "GPGKeyList",
  13951. "schema": {
  13952. "type": "array",
  13953. "items": {
  13954. "$ref": "#/definitions/GPGKey"
  13955. }
  13956. }
  13957. },
  13958. "GitBlobResponse": {
  13959. "description": "GitBlobResponse",
  13960. "schema": {
  13961. "$ref": "#/definitions/GitBlobResponse"
  13962. }
  13963. },
  13964. "GitHook": {
  13965. "description": "GitHook",
  13966. "schema": {
  13967. "$ref": "#/definitions/GitHook"
  13968. }
  13969. },
  13970. "GitHookList": {
  13971. "description": "GitHookList",
  13972. "schema": {
  13973. "type": "array",
  13974. "items": {
  13975. "$ref": "#/definitions/GitHook"
  13976. }
  13977. }
  13978. },
  13979. "GitTreeResponse": {
  13980. "description": "GitTreeResponse",
  13981. "schema": {
  13982. "$ref": "#/definitions/GitTreeResponse"
  13983. }
  13984. },
  13985. "Hook": {
  13986. "description": "Hook",
  13987. "schema": {
  13988. "$ref": "#/definitions/Hook"
  13989. }
  13990. },
  13991. "HookList": {
  13992. "description": "HookList",
  13993. "schema": {
  13994. "type": "array",
  13995. "items": {
  13996. "$ref": "#/definitions/Hook"
  13997. }
  13998. }
  13999. },
  14000. "Issue": {
  14001. "description": "Issue",
  14002. "schema": {
  14003. "$ref": "#/definitions/Issue"
  14004. }
  14005. },
  14006. "IssueDeadline": {
  14007. "description": "IssueDeadline",
  14008. "schema": {
  14009. "$ref": "#/definitions/IssueDeadline"
  14010. }
  14011. },
  14012. "IssueList": {
  14013. "description": "IssueList",
  14014. "schema": {
  14015. "type": "array",
  14016. "items": {
  14017. "$ref": "#/definitions/Issue"
  14018. }
  14019. }
  14020. },
  14021. "Label": {
  14022. "description": "Label",
  14023. "schema": {
  14024. "$ref": "#/definitions/Label"
  14025. }
  14026. },
  14027. "LabelList": {
  14028. "description": "LabelList",
  14029. "schema": {
  14030. "type": "array",
  14031. "items": {
  14032. "$ref": "#/definitions/Label"
  14033. }
  14034. }
  14035. },
  14036. "MarkdownRender": {
  14037. "description": "MarkdownRender is a rendered markdown document",
  14038. "schema": {
  14039. "type": "string"
  14040. }
  14041. },
  14042. "Milestone": {
  14043. "description": "Milestone",
  14044. "schema": {
  14045. "$ref": "#/definitions/Milestone"
  14046. }
  14047. },
  14048. "MilestoneList": {
  14049. "description": "MilestoneList",
  14050. "schema": {
  14051. "type": "array",
  14052. "items": {
  14053. "$ref": "#/definitions/Milestone"
  14054. }
  14055. }
  14056. },
  14057. "NotificationCount": {
  14058. "description": "Number of unread notifications",
  14059. "schema": {
  14060. "$ref": "#/definitions/NotificationCount"
  14061. }
  14062. },
  14063. "NotificationThread": {
  14064. "description": "NotificationThread",
  14065. "schema": {
  14066. "$ref": "#/definitions/NotificationThread"
  14067. }
  14068. },
  14069. "NotificationThreadList": {
  14070. "description": "NotificationThreadList",
  14071. "schema": {
  14072. "type": "array",
  14073. "items": {
  14074. "$ref": "#/definitions/NotificationThread"
  14075. }
  14076. }
  14077. },
  14078. "OAuth2Application": {
  14079. "description": "OAuth2Application",
  14080. "schema": {
  14081. "$ref": "#/definitions/OAuth2Application"
  14082. }
  14083. },
  14084. "OAuth2ApplicationList": {
  14085. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  14086. "schema": {
  14087. "type": "array",
  14088. "items": {
  14089. "$ref": "#/definitions/OAuth2Application"
  14090. }
  14091. }
  14092. },
  14093. "Organization": {
  14094. "description": "Organization",
  14095. "schema": {
  14096. "$ref": "#/definitions/Organization"
  14097. }
  14098. },
  14099. "OrganizationList": {
  14100. "description": "OrganizationList",
  14101. "schema": {
  14102. "type": "array",
  14103. "items": {
  14104. "$ref": "#/definitions/Organization"
  14105. }
  14106. }
  14107. },
  14108. "PublicKey": {
  14109. "description": "PublicKey",
  14110. "schema": {
  14111. "$ref": "#/definitions/PublicKey"
  14112. }
  14113. },
  14114. "PublicKeyList": {
  14115. "description": "PublicKeyList",
  14116. "schema": {
  14117. "type": "array",
  14118. "items": {
  14119. "$ref": "#/definitions/PublicKey"
  14120. }
  14121. }
  14122. },
  14123. "PullRequest": {
  14124. "description": "PullRequest",
  14125. "schema": {
  14126. "$ref": "#/definitions/PullRequest"
  14127. }
  14128. },
  14129. "PullRequestList": {
  14130. "description": "PullRequestList",
  14131. "schema": {
  14132. "type": "array",
  14133. "items": {
  14134. "$ref": "#/definitions/PullRequest"
  14135. }
  14136. }
  14137. },
  14138. "Reaction": {
  14139. "description": "Reaction",
  14140. "schema": {
  14141. "$ref": "#/definitions/Reaction"
  14142. }
  14143. },
  14144. "ReactionList": {
  14145. "description": "ReactionList",
  14146. "schema": {
  14147. "type": "array",
  14148. "items": {
  14149. "$ref": "#/definitions/Reaction"
  14150. }
  14151. }
  14152. },
  14153. "Reference": {
  14154. "description": "Reference",
  14155. "schema": {
  14156. "$ref": "#/definitions/Reference"
  14157. }
  14158. },
  14159. "ReferenceList": {
  14160. "description": "ReferenceList",
  14161. "schema": {
  14162. "type": "array",
  14163. "items": {
  14164. "$ref": "#/definitions/Reference"
  14165. }
  14166. }
  14167. },
  14168. "Release": {
  14169. "description": "Release",
  14170. "schema": {
  14171. "$ref": "#/definitions/Release"
  14172. }
  14173. },
  14174. "ReleaseList": {
  14175. "description": "ReleaseList",
  14176. "schema": {
  14177. "type": "array",
  14178. "items": {
  14179. "$ref": "#/definitions/Release"
  14180. }
  14181. }
  14182. },
  14183. "Repository": {
  14184. "description": "Repository",
  14185. "schema": {
  14186. "$ref": "#/definitions/Repository"
  14187. }
  14188. },
  14189. "RepositoryList": {
  14190. "description": "RepositoryList",
  14191. "schema": {
  14192. "type": "array",
  14193. "items": {
  14194. "$ref": "#/definitions/Repository"
  14195. }
  14196. }
  14197. },
  14198. "SearchResults": {
  14199. "description": "SearchResults",
  14200. "schema": {
  14201. "$ref": "#/definitions/SearchResults"
  14202. }
  14203. },
  14204. "ServerVersion": {
  14205. "description": "ServerVersion",
  14206. "schema": {
  14207. "$ref": "#/definitions/ServerVersion"
  14208. }
  14209. },
  14210. "Status": {
  14211. "description": "Status",
  14212. "schema": {
  14213. "$ref": "#/definitions/Status"
  14214. }
  14215. },
  14216. "StatusList": {
  14217. "description": "StatusList",
  14218. "schema": {
  14219. "type": "array",
  14220. "items": {
  14221. "$ref": "#/definitions/Status"
  14222. }
  14223. }
  14224. },
  14225. "StopWatch": {
  14226. "description": "StopWatch",
  14227. "schema": {
  14228. "$ref": "#/definitions/StopWatch"
  14229. }
  14230. },
  14231. "StopWatchList": {
  14232. "description": "StopWatchList",
  14233. "schema": {
  14234. "type": "array",
  14235. "items": {
  14236. "$ref": "#/definitions/StopWatch"
  14237. }
  14238. }
  14239. },
  14240. "Tag": {
  14241. "description": "Tag",
  14242. "schema": {
  14243. "$ref": "#/definitions/Tag"
  14244. }
  14245. },
  14246. "TagList": {
  14247. "description": "TagList",
  14248. "schema": {
  14249. "type": "array",
  14250. "items": {
  14251. "$ref": "#/definitions/Tag"
  14252. }
  14253. }
  14254. },
  14255. "Team": {
  14256. "description": "Team",
  14257. "schema": {
  14258. "$ref": "#/definitions/Team"
  14259. }
  14260. },
  14261. "TeamList": {
  14262. "description": "TeamList",
  14263. "schema": {
  14264. "type": "array",
  14265. "items": {
  14266. "$ref": "#/definitions/Team"
  14267. }
  14268. }
  14269. },
  14270. "TopicListResponse": {
  14271. "description": "TopicListResponse",
  14272. "schema": {
  14273. "type": "array",
  14274. "items": {
  14275. "$ref": "#/definitions/TopicResponse"
  14276. }
  14277. }
  14278. },
  14279. "TopicNames": {
  14280. "description": "TopicNames",
  14281. "schema": {
  14282. "$ref": "#/definitions/TopicName"
  14283. }
  14284. },
  14285. "TrackedTime": {
  14286. "description": "TrackedTime",
  14287. "schema": {
  14288. "$ref": "#/definitions/TrackedTime"
  14289. }
  14290. },
  14291. "TrackedTimeList": {
  14292. "description": "TrackedTimeList",
  14293. "schema": {
  14294. "type": "array",
  14295. "items": {
  14296. "$ref": "#/definitions/TrackedTime"
  14297. }
  14298. }
  14299. },
  14300. "User": {
  14301. "description": "User",
  14302. "schema": {
  14303. "$ref": "#/definitions/User"
  14304. }
  14305. },
  14306. "UserHeatmapData": {
  14307. "description": "UserHeatmapData",
  14308. "schema": {
  14309. "type": "array",
  14310. "items": {
  14311. "$ref": "#/definitions/UserHeatmapData"
  14312. }
  14313. }
  14314. },
  14315. "UserList": {
  14316. "description": "UserList",
  14317. "schema": {
  14318. "type": "array",
  14319. "items": {
  14320. "$ref": "#/definitions/User"
  14321. }
  14322. }
  14323. },
  14324. "WatchInfo": {
  14325. "description": "WatchInfo",
  14326. "schema": {
  14327. "$ref": "#/definitions/WatchInfo"
  14328. }
  14329. },
  14330. "empty": {
  14331. "description": "APIEmpty is an empty response"
  14332. },
  14333. "error": {
  14334. "description": "APIError is error format response",
  14335. "headers": {
  14336. "message": {
  14337. "type": "string"
  14338. },
  14339. "url": {
  14340. "type": "string"
  14341. }
  14342. }
  14343. },
  14344. "forbidden": {
  14345. "description": "APIForbiddenError is a forbidden error response",
  14346. "headers": {
  14347. "message": {
  14348. "type": "string"
  14349. },
  14350. "url": {
  14351. "type": "string"
  14352. }
  14353. }
  14354. },
  14355. "invalidTopicsError": {
  14356. "description": "APIInvalidTopicsError is error format response to invalid topics",
  14357. "headers": {
  14358. "invalidTopics": {
  14359. "type": "array",
  14360. "items": {
  14361. "type": "string"
  14362. }
  14363. },
  14364. "message": {
  14365. "type": "string"
  14366. }
  14367. }
  14368. },
  14369. "notFound": {
  14370. "description": "APINotFound is a not found empty response"
  14371. },
  14372. "parameterBodies": {
  14373. "description": "parameterBodies",
  14374. "schema": {
  14375. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14376. }
  14377. },
  14378. "redirect": {
  14379. "description": "APIRedirect is a redirect response"
  14380. },
  14381. "validationError": {
  14382. "description": "APIValidationError is error format response related to input validation",
  14383. "headers": {
  14384. "message": {
  14385. "type": "string"
  14386. },
  14387. "url": {
  14388. "type": "string"
  14389. }
  14390. }
  14391. }
  14392. },
  14393. "securityDefinitions": {
  14394. "AccessToken": {
  14395. "type": "apiKey",
  14396. "name": "access_token",
  14397. "in": "query"
  14398. },
  14399. "AuthorizationHeaderToken": {
  14400. "description": "API tokens must be prepended with \"token\" followed by a space.",
  14401. "type": "apiKey",
  14402. "name": "Authorization",
  14403. "in": "header"
  14404. },
  14405. "BasicAuth": {
  14406. "type": "basic"
  14407. },
  14408. "SudoHeader": {
  14409. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  14410. "type": "apiKey",
  14411. "name": "Sudo",
  14412. "in": "header"
  14413. },
  14414. "SudoParam": {
  14415. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  14416. "type": "apiKey",
  14417. "name": "sudo",
  14418. "in": "query"
  14419. },
  14420. "Token": {
  14421. "type": "apiKey",
  14422. "name": "token",
  14423. "in": "query"
  14424. }
  14425. },
  14426. "security": [
  14427. {
  14428. "BasicAuth": []
  14429. },
  14430. {
  14431. "Token": []
  14432. },
  14433. {
  14434. "AccessToken": []
  14435. },
  14436. {
  14437. "AuthorizationHeaderToken": []
  14438. },
  14439. {
  14440. "SudoParam": []
  14441. },
  14442. {
  14443. "SudoHeader": []
  14444. }
  14445. ]
  14446. }