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 356KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API.",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "1.1.1"
  23. },
  24. "basePath": "{{AppSubUrl}}/api/v1",
  25. "paths": {
  26. "/admin/orgs": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List all organizations",
  35. "operationId": "adminGetAllOrgs",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results, maximum page size is 50",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/OrganizationList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/users": {
  61. "get": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "List all users",
  69. "operationId": "adminGetAllUsers",
  70. "parameters": [
  71. {
  72. "type": "integer",
  73. "description": "page number of results to return (1-based)",
  74. "name": "page",
  75. "in": "query"
  76. },
  77. {
  78. "type": "integer",
  79. "description": "page size of results, maximum page size is 50",
  80. "name": "limit",
  81. "in": "query"
  82. }
  83. ],
  84. "responses": {
  85. "200": {
  86. "$ref": "#/responses/UserList"
  87. },
  88. "403": {
  89. "$ref": "#/responses/forbidden"
  90. }
  91. }
  92. },
  93. "post": {
  94. "consumes": [
  95. "application/json"
  96. ],
  97. "produces": [
  98. "application/json"
  99. ],
  100. "tags": [
  101. "admin"
  102. ],
  103. "summary": "Create a user",
  104. "operationId": "adminCreateUser",
  105. "parameters": [
  106. {
  107. "name": "body",
  108. "in": "body",
  109. "schema": {
  110. "$ref": "#/definitions/CreateUserOption"
  111. }
  112. }
  113. ],
  114. "responses": {
  115. "201": {
  116. "$ref": "#/responses/User"
  117. },
  118. "400": {
  119. "$ref": "#/responses/error"
  120. },
  121. "403": {
  122. "$ref": "#/responses/forbidden"
  123. },
  124. "422": {
  125. "$ref": "#/responses/validationError"
  126. }
  127. }
  128. }
  129. },
  130. "/admin/users/{username}": {
  131. "delete": {
  132. "produces": [
  133. "application/json"
  134. ],
  135. "tags": [
  136. "admin"
  137. ],
  138. "summary": "Delete a user",
  139. "operationId": "adminDeleteUser",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "username of user to delete",
  144. "name": "username",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "204": {
  151. "$ref": "#/responses/empty"
  152. },
  153. "403": {
  154. "$ref": "#/responses/forbidden"
  155. },
  156. "422": {
  157. "$ref": "#/responses/validationError"
  158. }
  159. }
  160. },
  161. "patch": {
  162. "consumes": [
  163. "application/json"
  164. ],
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Edit an existing user",
  172. "operationId": "adminEditUser",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "username of user to edit",
  177. "name": "username",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "name": "body",
  183. "in": "body",
  184. "schema": {
  185. "$ref": "#/definitions/EditUserOption"
  186. }
  187. }
  188. ],
  189. "responses": {
  190. "200": {
  191. "$ref": "#/responses/User"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "422": {
  197. "$ref": "#/responses/validationError"
  198. }
  199. }
  200. }
  201. },
  202. "/admin/users/{username}/keys": {
  203. "post": {
  204. "consumes": [
  205. "application/json"
  206. ],
  207. "produces": [
  208. "application/json"
  209. ],
  210. "tags": [
  211. "admin"
  212. ],
  213. "summary": "Add a public key on behalf of a user",
  214. "operationId": "adminCreatePublicKey",
  215. "parameters": [
  216. {
  217. "type": "string",
  218. "description": "username of the user",
  219. "name": "username",
  220. "in": "path",
  221. "required": true
  222. },
  223. {
  224. "name": "key",
  225. "in": "body",
  226. "schema": {
  227. "$ref": "#/definitions/CreateKeyOption"
  228. }
  229. }
  230. ],
  231. "responses": {
  232. "201": {
  233. "$ref": "#/responses/PublicKey"
  234. },
  235. "403": {
  236. "$ref": "#/responses/forbidden"
  237. },
  238. "422": {
  239. "$ref": "#/responses/validationError"
  240. }
  241. }
  242. }
  243. },
  244. "/admin/users/{username}/keys/{id}": {
  245. "delete": {
  246. "produces": [
  247. "application/json"
  248. ],
  249. "tags": [
  250. "admin"
  251. ],
  252. "summary": "Delete a user's public key",
  253. "operationId": "adminDeleteUserPublicKey",
  254. "parameters": [
  255. {
  256. "type": "string",
  257. "description": "username of user",
  258. "name": "username",
  259. "in": "path",
  260. "required": true
  261. },
  262. {
  263. "type": "integer",
  264. "format": "int64",
  265. "description": "id of the key to delete",
  266. "name": "id",
  267. "in": "path",
  268. "required": true
  269. }
  270. ],
  271. "responses": {
  272. "204": {
  273. "$ref": "#/responses/empty"
  274. },
  275. "403": {
  276. "$ref": "#/responses/forbidden"
  277. },
  278. "404": {
  279. "$ref": "#/responses/notFound"
  280. }
  281. }
  282. }
  283. },
  284. "/admin/users/{username}/orgs": {
  285. "post": {
  286. "consumes": [
  287. "application/json"
  288. ],
  289. "produces": [
  290. "application/json"
  291. ],
  292. "tags": [
  293. "admin"
  294. ],
  295. "summary": "Create an organization",
  296. "operationId": "adminCreateOrg",
  297. "parameters": [
  298. {
  299. "type": "string",
  300. "description": "username of the user that will own the created organization",
  301. "name": "username",
  302. "in": "path",
  303. "required": true
  304. },
  305. {
  306. "name": "organization",
  307. "in": "body",
  308. "required": true,
  309. "schema": {
  310. "$ref": "#/definitions/CreateOrgOption"
  311. }
  312. }
  313. ],
  314. "responses": {
  315. "201": {
  316. "$ref": "#/responses/Organization"
  317. },
  318. "403": {
  319. "$ref": "#/responses/forbidden"
  320. },
  321. "422": {
  322. "$ref": "#/responses/validationError"
  323. }
  324. }
  325. }
  326. },
  327. "/admin/users/{username}/repos": {
  328. "post": {
  329. "consumes": [
  330. "application/json"
  331. ],
  332. "produces": [
  333. "application/json"
  334. ],
  335. "tags": [
  336. "admin"
  337. ],
  338. "summary": "Create a repository on behalf of a user",
  339. "operationId": "adminCreateRepo",
  340. "parameters": [
  341. {
  342. "type": "string",
  343. "description": "username of the user. This user will own the created repository",
  344. "name": "username",
  345. "in": "path",
  346. "required": true
  347. },
  348. {
  349. "name": "repository",
  350. "in": "body",
  351. "required": true,
  352. "schema": {
  353. "$ref": "#/definitions/CreateRepoOption"
  354. }
  355. }
  356. ],
  357. "responses": {
  358. "201": {
  359. "$ref": "#/responses/Repository"
  360. },
  361. "403": {
  362. "$ref": "#/responses/forbidden"
  363. },
  364. "404": {
  365. "$ref": "#/responses/notFound"
  366. },
  367. "409": {
  368. "$ref": "#/responses/error"
  369. },
  370. "422": {
  371. "$ref": "#/responses/validationError"
  372. }
  373. }
  374. }
  375. },
  376. "/markdown": {
  377. "post": {
  378. "consumes": [
  379. "application/json"
  380. ],
  381. "produces": [
  382. "text/html"
  383. ],
  384. "tags": [
  385. "miscellaneous"
  386. ],
  387. "summary": "Render a markdown document as HTML",
  388. "operationId": "renderMarkdown",
  389. "parameters": [
  390. {
  391. "name": "body",
  392. "in": "body",
  393. "schema": {
  394. "$ref": "#/definitions/MarkdownOption"
  395. }
  396. }
  397. ],
  398. "responses": {
  399. "200": {
  400. "$ref": "#/responses/MarkdownRender"
  401. },
  402. "422": {
  403. "$ref": "#/responses/validationError"
  404. }
  405. }
  406. }
  407. },
  408. "/markdown/raw": {
  409. "post": {
  410. "consumes": [
  411. "text/plain"
  412. ],
  413. "produces": [
  414. "text/html"
  415. ],
  416. "tags": [
  417. "miscellaneous"
  418. ],
  419. "summary": "Render raw markdown as HTML",
  420. "operationId": "renderMarkdownRaw",
  421. "parameters": [
  422. {
  423. "description": "Request body to render",
  424. "name": "body",
  425. "in": "body",
  426. "required": true,
  427. "schema": {
  428. "type": "string"
  429. }
  430. }
  431. ],
  432. "responses": {
  433. "200": {
  434. "$ref": "#/responses/MarkdownRender"
  435. },
  436. "422": {
  437. "$ref": "#/responses/validationError"
  438. }
  439. }
  440. }
  441. },
  442. "/notifications": {
  443. "get": {
  444. "consumes": [
  445. "application/json"
  446. ],
  447. "produces": [
  448. "application/json"
  449. ],
  450. "tags": [
  451. "notification"
  452. ],
  453. "summary": "List users's notification threads",
  454. "operationId": "notifyGetList",
  455. "parameters": [
  456. {
  457. "type": "string",
  458. "description": "If true, show notifications marked as read. Default value is false",
  459. "name": "all",
  460. "in": "query"
  461. },
  462. {
  463. "type": "string",
  464. "format": "date-time",
  465. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  466. "name": "since",
  467. "in": "query"
  468. },
  469. {
  470. "type": "string",
  471. "format": "date-time",
  472. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  473. "name": "before",
  474. "in": "query"
  475. },
  476. {
  477. "type": "integer",
  478. "description": "page number of results to return (1-based)",
  479. "name": "page",
  480. "in": "query"
  481. },
  482. {
  483. "type": "integer",
  484. "description": "page size of results, maximum page size is 50",
  485. "name": "limit",
  486. "in": "query"
  487. }
  488. ],
  489. "responses": {
  490. "200": {
  491. "$ref": "#/responses/NotificationThreadList"
  492. }
  493. }
  494. },
  495. "put": {
  496. "consumes": [
  497. "application/json"
  498. ],
  499. "produces": [
  500. "application/json"
  501. ],
  502. "tags": [
  503. "notification"
  504. ],
  505. "summary": "Mark notification threads as read",
  506. "operationId": "notifyReadList",
  507. "parameters": [
  508. {
  509. "type": "string",
  510. "format": "date-time",
  511. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  512. "name": "last_read_at",
  513. "in": "query"
  514. }
  515. ],
  516. "responses": {
  517. "205": {
  518. "$ref": "#/responses/empty"
  519. }
  520. }
  521. }
  522. },
  523. "/notifications/new": {
  524. "get": {
  525. "tags": [
  526. "notification"
  527. ],
  528. "summary": "Check if unread notifications exist",
  529. "operationId": "notifyNewAvailable",
  530. "responses": {
  531. "200": {
  532. "$ref": "#/responses/NotificationCount"
  533. },
  534. "204": {
  535. "description": "No unread notification"
  536. }
  537. }
  538. }
  539. },
  540. "/notifications/threads/{id}": {
  541. "get": {
  542. "consumes": [
  543. "application/json"
  544. ],
  545. "produces": [
  546. "application/json"
  547. ],
  548. "tags": [
  549. "notification"
  550. ],
  551. "summary": "Get notification thread by ID",
  552. "operationId": "notifyGetThread",
  553. "parameters": [
  554. {
  555. "type": "string",
  556. "description": "id of notification thread",
  557. "name": "id",
  558. "in": "path",
  559. "required": true
  560. }
  561. ],
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/NotificationThread"
  565. },
  566. "403": {
  567. "$ref": "#/responses/forbidden"
  568. },
  569. "404": {
  570. "$ref": "#/responses/notFound"
  571. }
  572. }
  573. },
  574. "patch": {
  575. "consumes": [
  576. "application/json"
  577. ],
  578. "produces": [
  579. "application/json"
  580. ],
  581. "tags": [
  582. "notification"
  583. ],
  584. "summary": "Mark notification thread as read by ID",
  585. "operationId": "notifyReadThread",
  586. "parameters": [
  587. {
  588. "type": "string",
  589. "description": "id of notification thread",
  590. "name": "id",
  591. "in": "path",
  592. "required": true
  593. }
  594. ],
  595. "responses": {
  596. "205": {
  597. "$ref": "#/responses/empty"
  598. },
  599. "403": {
  600. "$ref": "#/responses/forbidden"
  601. },
  602. "404": {
  603. "$ref": "#/responses/notFound"
  604. }
  605. }
  606. }
  607. },
  608. "/org/{org}/repos": {
  609. "post": {
  610. "consumes": [
  611. "application/json"
  612. ],
  613. "produces": [
  614. "application/json"
  615. ],
  616. "tags": [
  617. "organization"
  618. ],
  619. "summary": "Create a repository in an organization",
  620. "operationId": "createOrgRepoDeprecated",
  621. "deprecated": true,
  622. "parameters": [
  623. {
  624. "type": "string",
  625. "description": "name of organization",
  626. "name": "org",
  627. "in": "path",
  628. "required": true
  629. },
  630. {
  631. "name": "body",
  632. "in": "body",
  633. "schema": {
  634. "$ref": "#/definitions/CreateRepoOption"
  635. }
  636. }
  637. ],
  638. "responses": {
  639. "201": {
  640. "$ref": "#/responses/Repository"
  641. },
  642. "403": {
  643. "$ref": "#/responses/forbidden"
  644. },
  645. "422": {
  646. "$ref": "#/responses/validationError"
  647. }
  648. }
  649. }
  650. },
  651. "/orgs": {
  652. "get": {
  653. "produces": [
  654. "application/json"
  655. ],
  656. "tags": [
  657. "organization"
  658. ],
  659. "summary": "Get list of organizations",
  660. "operationId": "orgGetAll",
  661. "parameters": [
  662. {
  663. "type": "integer",
  664. "description": "page number of results to return (1-based)",
  665. "name": "page",
  666. "in": "query"
  667. },
  668. {
  669. "type": "integer",
  670. "description": "page size of results, maximum page size is 50",
  671. "name": "limit",
  672. "in": "query"
  673. }
  674. ],
  675. "responses": {
  676. "200": {
  677. "$ref": "#/responses/OrganizationList"
  678. }
  679. }
  680. },
  681. "post": {
  682. "consumes": [
  683. "application/json"
  684. ],
  685. "produces": [
  686. "application/json"
  687. ],
  688. "tags": [
  689. "organization"
  690. ],
  691. "summary": "Create an organization",
  692. "operationId": "orgCreate",
  693. "parameters": [
  694. {
  695. "name": "organization",
  696. "in": "body",
  697. "required": true,
  698. "schema": {
  699. "$ref": "#/definitions/CreateOrgOption"
  700. }
  701. }
  702. ],
  703. "responses": {
  704. "201": {
  705. "$ref": "#/responses/Organization"
  706. },
  707. "403": {
  708. "$ref": "#/responses/forbidden"
  709. },
  710. "422": {
  711. "$ref": "#/responses/validationError"
  712. }
  713. }
  714. }
  715. },
  716. "/orgs/{org}": {
  717. "get": {
  718. "produces": [
  719. "application/json"
  720. ],
  721. "tags": [
  722. "organization"
  723. ],
  724. "summary": "Get an organization",
  725. "operationId": "orgGet",
  726. "parameters": [
  727. {
  728. "type": "string",
  729. "description": "name of the organization to get",
  730. "name": "org",
  731. "in": "path",
  732. "required": true
  733. }
  734. ],
  735. "responses": {
  736. "200": {
  737. "$ref": "#/responses/Organization"
  738. }
  739. }
  740. },
  741. "delete": {
  742. "produces": [
  743. "application/json"
  744. ],
  745. "tags": [
  746. "organization"
  747. ],
  748. "summary": "Delete an organization",
  749. "operationId": "orgDelete",
  750. "parameters": [
  751. {
  752. "type": "string",
  753. "description": "organization that is to be deleted",
  754. "name": "org",
  755. "in": "path",
  756. "required": true
  757. }
  758. ],
  759. "responses": {
  760. "204": {
  761. "$ref": "#/responses/empty"
  762. }
  763. }
  764. },
  765. "patch": {
  766. "consumes": [
  767. "application/json"
  768. ],
  769. "produces": [
  770. "application/json"
  771. ],
  772. "tags": [
  773. "organization"
  774. ],
  775. "summary": "Edit an organization",
  776. "operationId": "orgEdit",
  777. "parameters": [
  778. {
  779. "type": "string",
  780. "description": "name of the organization to edit",
  781. "name": "org",
  782. "in": "path",
  783. "required": true
  784. },
  785. {
  786. "name": "body",
  787. "in": "body",
  788. "required": true,
  789. "schema": {
  790. "$ref": "#/definitions/EditOrgOption"
  791. }
  792. }
  793. ],
  794. "responses": {
  795. "200": {
  796. "$ref": "#/responses/Organization"
  797. }
  798. }
  799. }
  800. },
  801. "/orgs/{org}/hooks": {
  802. "get": {
  803. "produces": [
  804. "application/json"
  805. ],
  806. "tags": [
  807. "organization"
  808. ],
  809. "summary": "List an organization's webhooks",
  810. "operationId": "orgListHooks",
  811. "parameters": [
  812. {
  813. "type": "string",
  814. "description": "name of the organization",
  815. "name": "org",
  816. "in": "path",
  817. "required": true
  818. },
  819. {
  820. "type": "integer",
  821. "description": "page number of results to return (1-based)",
  822. "name": "page",
  823. "in": "query"
  824. },
  825. {
  826. "type": "integer",
  827. "description": "page size of results, maximum page size is 50",
  828. "name": "limit",
  829. "in": "query"
  830. }
  831. ],
  832. "responses": {
  833. "200": {
  834. "$ref": "#/responses/HookList"
  835. }
  836. }
  837. }
  838. },
  839. "/orgs/{org}/hooks/": {
  840. "post": {
  841. "consumes": [
  842. "application/json"
  843. ],
  844. "produces": [
  845. "application/json"
  846. ],
  847. "tags": [
  848. "organization"
  849. ],
  850. "summary": "Create a hook",
  851. "operationId": "orgCreateHook",
  852. "parameters": [
  853. {
  854. "type": "string",
  855. "description": "name of the organization",
  856. "name": "org",
  857. "in": "path",
  858. "required": true
  859. },
  860. {
  861. "name": "body",
  862. "in": "body",
  863. "required": true,
  864. "schema": {
  865. "$ref": "#/definitions/CreateHookOption"
  866. }
  867. }
  868. ],
  869. "responses": {
  870. "201": {
  871. "$ref": "#/responses/Hook"
  872. }
  873. }
  874. }
  875. },
  876. "/orgs/{org}/hooks/{id}": {
  877. "get": {
  878. "produces": [
  879. "application/json"
  880. ],
  881. "tags": [
  882. "organization"
  883. ],
  884. "summary": "Get a hook",
  885. "operationId": "orgGetHook",
  886. "parameters": [
  887. {
  888. "type": "string",
  889. "description": "name of the organization",
  890. "name": "org",
  891. "in": "path",
  892. "required": true
  893. },
  894. {
  895. "type": "integer",
  896. "format": "int64",
  897. "description": "id of the hook to get",
  898. "name": "id",
  899. "in": "path",
  900. "required": true
  901. }
  902. ],
  903. "responses": {
  904. "200": {
  905. "$ref": "#/responses/Hook"
  906. }
  907. }
  908. },
  909. "delete": {
  910. "produces": [
  911. "application/json"
  912. ],
  913. "tags": [
  914. "organization"
  915. ],
  916. "summary": "Delete a hook",
  917. "operationId": "orgDeleteHook",
  918. "parameters": [
  919. {
  920. "type": "string",
  921. "description": "name of the organization",
  922. "name": "org",
  923. "in": "path",
  924. "required": true
  925. },
  926. {
  927. "type": "integer",
  928. "format": "int64",
  929. "description": "id of the hook to delete",
  930. "name": "id",
  931. "in": "path",
  932. "required": true
  933. }
  934. ],
  935. "responses": {
  936. "204": {
  937. "$ref": "#/responses/empty"
  938. }
  939. }
  940. },
  941. "patch": {
  942. "consumes": [
  943. "application/json"
  944. ],
  945. "produces": [
  946. "application/json"
  947. ],
  948. "tags": [
  949. "organization"
  950. ],
  951. "summary": "Update a hook",
  952. "operationId": "orgEditHook",
  953. "parameters": [
  954. {
  955. "type": "string",
  956. "description": "name of the organization",
  957. "name": "org",
  958. "in": "path",
  959. "required": true
  960. },
  961. {
  962. "type": "integer",
  963. "format": "int64",
  964. "description": "id of the hook to update",
  965. "name": "id",
  966. "in": "path",
  967. "required": true
  968. },
  969. {
  970. "name": "body",
  971. "in": "body",
  972. "schema": {
  973. "$ref": "#/definitions/EditHookOption"
  974. }
  975. }
  976. ],
  977. "responses": {
  978. "200": {
  979. "$ref": "#/responses/Hook"
  980. }
  981. }
  982. }
  983. },
  984. "/orgs/{org}/members": {
  985. "get": {
  986. "produces": [
  987. "application/json"
  988. ],
  989. "tags": [
  990. "organization"
  991. ],
  992. "summary": "List an organization's members",
  993. "operationId": "orgListMembers",
  994. "parameters": [
  995. {
  996. "type": "string",
  997. "description": "name of the organization",
  998. "name": "org",
  999. "in": "path",
  1000. "required": true
  1001. },
  1002. {
  1003. "type": "integer",
  1004. "description": "page number of results to return (1-based)",
  1005. "name": "page",
  1006. "in": "query"
  1007. },
  1008. {
  1009. "type": "integer",
  1010. "description": "page size of results, maximum page size is 50",
  1011. "name": "limit",
  1012. "in": "query"
  1013. }
  1014. ],
  1015. "responses": {
  1016. "200": {
  1017. "$ref": "#/responses/UserList"
  1018. }
  1019. }
  1020. }
  1021. },
  1022. "/orgs/{org}/members/{username}": {
  1023. "get": {
  1024. "tags": [
  1025. "organization"
  1026. ],
  1027. "summary": "Check if a user is a member of an organization",
  1028. "operationId": "orgIsMember",
  1029. "parameters": [
  1030. {
  1031. "type": "string",
  1032. "description": "name of the organization",
  1033. "name": "org",
  1034. "in": "path",
  1035. "required": true
  1036. },
  1037. {
  1038. "type": "string",
  1039. "description": "username of the user",
  1040. "name": "username",
  1041. "in": "path",
  1042. "required": true
  1043. }
  1044. ],
  1045. "responses": {
  1046. "204": {
  1047. "description": "user is a member"
  1048. },
  1049. "302": {
  1050. "description": "redirection to /orgs/{org}/public_members/{username}"
  1051. },
  1052. "404": {
  1053. "description": "user is not a member"
  1054. }
  1055. }
  1056. },
  1057. "delete": {
  1058. "produces": [
  1059. "application/json"
  1060. ],
  1061. "tags": [
  1062. "organization"
  1063. ],
  1064. "summary": "Remove a member from an organization",
  1065. "operationId": "orgDeleteMember",
  1066. "parameters": [
  1067. {
  1068. "type": "string",
  1069. "description": "name of the organization",
  1070. "name": "org",
  1071. "in": "path",
  1072. "required": true
  1073. },
  1074. {
  1075. "type": "string",
  1076. "description": "username of the user",
  1077. "name": "username",
  1078. "in": "path",
  1079. "required": true
  1080. }
  1081. ],
  1082. "responses": {
  1083. "204": {
  1084. "description": "member removed"
  1085. }
  1086. }
  1087. }
  1088. },
  1089. "/orgs/{org}/public_members": {
  1090. "get": {
  1091. "produces": [
  1092. "application/json"
  1093. ],
  1094. "tags": [
  1095. "organization"
  1096. ],
  1097. "summary": "List an organization's public members",
  1098. "operationId": "orgListPublicMembers",
  1099. "parameters": [
  1100. {
  1101. "type": "string",
  1102. "description": "name of the organization",
  1103. "name": "org",
  1104. "in": "path",
  1105. "required": true
  1106. },
  1107. {
  1108. "type": "integer",
  1109. "description": "page number of results to return (1-based)",
  1110. "name": "page",
  1111. "in": "query"
  1112. },
  1113. {
  1114. "type": "integer",
  1115. "description": "page size of results, maximum page size is 50",
  1116. "name": "limit",
  1117. "in": "query"
  1118. }
  1119. ],
  1120. "responses": {
  1121. "200": {
  1122. "$ref": "#/responses/UserList"
  1123. }
  1124. }
  1125. }
  1126. },
  1127. "/orgs/{org}/public_members/{username}": {
  1128. "get": {
  1129. "tags": [
  1130. "organization"
  1131. ],
  1132. "summary": "Check if a user is a public member of an organization",
  1133. "operationId": "orgIsPublicMember",
  1134. "parameters": [
  1135. {
  1136. "type": "string",
  1137. "description": "name of the organization",
  1138. "name": "org",
  1139. "in": "path",
  1140. "required": true
  1141. },
  1142. {
  1143. "type": "string",
  1144. "description": "username of the user",
  1145. "name": "username",
  1146. "in": "path",
  1147. "required": true
  1148. }
  1149. ],
  1150. "responses": {
  1151. "204": {
  1152. "description": "user is a public member"
  1153. },
  1154. "404": {
  1155. "description": "user is not a public member"
  1156. }
  1157. }
  1158. },
  1159. "put": {
  1160. "produces": [
  1161. "application/json"
  1162. ],
  1163. "tags": [
  1164. "organization"
  1165. ],
  1166. "summary": "Publicize a user's membership",
  1167. "operationId": "orgPublicizeMember",
  1168. "parameters": [
  1169. {
  1170. "type": "string",
  1171. "description": "name of the organization",
  1172. "name": "org",
  1173. "in": "path",
  1174. "required": true
  1175. },
  1176. {
  1177. "type": "string",
  1178. "description": "username of the user",
  1179. "name": "username",
  1180. "in": "path",
  1181. "required": true
  1182. }
  1183. ],
  1184. "responses": {
  1185. "204": {
  1186. "description": "membership publicized"
  1187. },
  1188. "403": {
  1189. "$ref": "#/responses/forbidden"
  1190. }
  1191. }
  1192. },
  1193. "delete": {
  1194. "produces": [
  1195. "application/json"
  1196. ],
  1197. "tags": [
  1198. "organization"
  1199. ],
  1200. "summary": "Conceal a user's membership",
  1201. "operationId": "orgConcealMember",
  1202. "parameters": [
  1203. {
  1204. "type": "string",
  1205. "description": "name of the organization",
  1206. "name": "org",
  1207. "in": "path",
  1208. "required": true
  1209. },
  1210. {
  1211. "type": "string",
  1212. "description": "username of the user",
  1213. "name": "username",
  1214. "in": "path",
  1215. "required": true
  1216. }
  1217. ],
  1218. "responses": {
  1219. "204": {
  1220. "$ref": "#/responses/empty"
  1221. },
  1222. "403": {
  1223. "$ref": "#/responses/forbidden"
  1224. }
  1225. }
  1226. }
  1227. },
  1228. "/orgs/{org}/repos": {
  1229. "get": {
  1230. "produces": [
  1231. "application/json"
  1232. ],
  1233. "tags": [
  1234. "organization"
  1235. ],
  1236. "summary": "List an organization's repos",
  1237. "operationId": "orgListRepos",
  1238. "parameters": [
  1239. {
  1240. "type": "string",
  1241. "description": "name of the organization",
  1242. "name": "org",
  1243. "in": "path",
  1244. "required": true
  1245. },
  1246. {
  1247. "type": "integer",
  1248. "description": "page number of results to return (1-based)",
  1249. "name": "page",
  1250. "in": "query"
  1251. },
  1252. {
  1253. "type": "integer",
  1254. "description": "page size of results, maximum page size is 50",
  1255. "name": "limit",
  1256. "in": "query"
  1257. }
  1258. ],
  1259. "responses": {
  1260. "200": {
  1261. "$ref": "#/responses/RepositoryList"
  1262. }
  1263. }
  1264. },
  1265. "post": {
  1266. "consumes": [
  1267. "application/json"
  1268. ],
  1269. "produces": [
  1270. "application/json"
  1271. ],
  1272. "tags": [
  1273. "organization"
  1274. ],
  1275. "summary": "Create a repository in an organization",
  1276. "operationId": "createOrgRepo",
  1277. "parameters": [
  1278. {
  1279. "type": "string",
  1280. "description": "name of organization",
  1281. "name": "org",
  1282. "in": "path",
  1283. "required": true
  1284. },
  1285. {
  1286. "name": "body",
  1287. "in": "body",
  1288. "schema": {
  1289. "$ref": "#/definitions/CreateRepoOption"
  1290. }
  1291. }
  1292. ],
  1293. "responses": {
  1294. "201": {
  1295. "$ref": "#/responses/Repository"
  1296. },
  1297. "403": {
  1298. "$ref": "#/responses/forbidden"
  1299. },
  1300. "404": {
  1301. "$ref": "#/responses/notFound"
  1302. }
  1303. }
  1304. }
  1305. },
  1306. "/orgs/{org}/teams": {
  1307. "get": {
  1308. "produces": [
  1309. "application/json"
  1310. ],
  1311. "tags": [
  1312. "organization"
  1313. ],
  1314. "summary": "List an organization's teams",
  1315. "operationId": "orgListTeams",
  1316. "parameters": [
  1317. {
  1318. "type": "string",
  1319. "description": "name of the organization",
  1320. "name": "org",
  1321. "in": "path",
  1322. "required": true
  1323. },
  1324. {
  1325. "type": "integer",
  1326. "description": "page number of results to return (1-based)",
  1327. "name": "page",
  1328. "in": "query"
  1329. },
  1330. {
  1331. "type": "integer",
  1332. "description": "page size of results, maximum page size is 50",
  1333. "name": "limit",
  1334. "in": "query"
  1335. }
  1336. ],
  1337. "responses": {
  1338. "200": {
  1339. "$ref": "#/responses/TeamList"
  1340. }
  1341. }
  1342. },
  1343. "post": {
  1344. "consumes": [
  1345. "application/json"
  1346. ],
  1347. "produces": [
  1348. "application/json"
  1349. ],
  1350. "tags": [
  1351. "organization"
  1352. ],
  1353. "summary": "Create a team",
  1354. "operationId": "orgCreateTeam",
  1355. "parameters": [
  1356. {
  1357. "type": "string",
  1358. "description": "name of the organization",
  1359. "name": "org",
  1360. "in": "path",
  1361. "required": true
  1362. },
  1363. {
  1364. "name": "body",
  1365. "in": "body",
  1366. "schema": {
  1367. "$ref": "#/definitions/CreateTeamOption"
  1368. }
  1369. }
  1370. ],
  1371. "responses": {
  1372. "201": {
  1373. "$ref": "#/responses/Team"
  1374. },
  1375. "422": {
  1376. "$ref": "#/responses/validationError"
  1377. }
  1378. }
  1379. }
  1380. },
  1381. "/orgs/{org}/teams/search": {
  1382. "get": {
  1383. "produces": [
  1384. "application/json"
  1385. ],
  1386. "tags": [
  1387. "organization"
  1388. ],
  1389. "summary": "Search for teams within an organization",
  1390. "operationId": "teamSearch",
  1391. "parameters": [
  1392. {
  1393. "type": "string",
  1394. "description": "name of the organization",
  1395. "name": "org",
  1396. "in": "path",
  1397. "required": true
  1398. },
  1399. {
  1400. "type": "string",
  1401. "description": "keywords to search",
  1402. "name": "q",
  1403. "in": "query"
  1404. },
  1405. {
  1406. "type": "boolean",
  1407. "description": "include search within team description (defaults to true)",
  1408. "name": "include_desc",
  1409. "in": "query"
  1410. },
  1411. {
  1412. "type": "integer",
  1413. "description": "page number of results to return (1-based)",
  1414. "name": "page",
  1415. "in": "query"
  1416. },
  1417. {
  1418. "type": "integer",
  1419. "description": "page size of results, maximum page size is 50",
  1420. "name": "limit",
  1421. "in": "query"
  1422. }
  1423. ],
  1424. "responses": {
  1425. "200": {
  1426. "description": "SearchResults of a successful search",
  1427. "schema": {
  1428. "type": "object",
  1429. "properties": {
  1430. "data": {
  1431. "type": "array",
  1432. "items": {
  1433. "$ref": "#/definitions/Team"
  1434. }
  1435. },
  1436. "ok": {
  1437. "type": "boolean"
  1438. }
  1439. }
  1440. }
  1441. }
  1442. }
  1443. }
  1444. },
  1445. "/repos/issues/search": {
  1446. "get": {
  1447. "produces": [
  1448. "application/json"
  1449. ],
  1450. "tags": [
  1451. "issue"
  1452. ],
  1453. "summary": "Search for issues across the repositories that the user has access to",
  1454. "operationId": "issueSearchIssues",
  1455. "parameters": [
  1456. {
  1457. "type": "string",
  1458. "description": "whether issue is open or closed",
  1459. "name": "state",
  1460. "in": "query"
  1461. },
  1462. {
  1463. "type": "string",
  1464. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1465. "name": "labels",
  1466. "in": "query"
  1467. },
  1468. {
  1469. "type": "string",
  1470. "description": "search string",
  1471. "name": "q",
  1472. "in": "query"
  1473. },
  1474. {
  1475. "type": "integer",
  1476. "format": "int64",
  1477. "description": "repository to prioritize in the results",
  1478. "name": "priority_repo_id",
  1479. "in": "query"
  1480. },
  1481. {
  1482. "type": "string",
  1483. "description": "filter by type (issues / pulls) if set",
  1484. "name": "type",
  1485. "in": "query"
  1486. },
  1487. {
  1488. "type": "integer",
  1489. "description": "page number of requested issues",
  1490. "name": "page",
  1491. "in": "query"
  1492. }
  1493. ],
  1494. "responses": {
  1495. "200": {
  1496. "$ref": "#/responses/IssueList"
  1497. }
  1498. }
  1499. }
  1500. },
  1501. "/repos/migrate": {
  1502. "post": {
  1503. "consumes": [
  1504. "application/json"
  1505. ],
  1506. "produces": [
  1507. "application/json"
  1508. ],
  1509. "tags": [
  1510. "repository"
  1511. ],
  1512. "summary": "Migrate a remote git repository",
  1513. "operationId": "repoMigrate",
  1514. "parameters": [
  1515. {
  1516. "name": "body",
  1517. "in": "body",
  1518. "schema": {
  1519. "$ref": "#/definitions/MigrateRepoForm"
  1520. }
  1521. }
  1522. ],
  1523. "responses": {
  1524. "201": {
  1525. "$ref": "#/responses/Repository"
  1526. },
  1527. "403": {
  1528. "$ref": "#/responses/forbidden"
  1529. },
  1530. "422": {
  1531. "$ref": "#/responses/validationError"
  1532. }
  1533. }
  1534. }
  1535. },
  1536. "/repos/search": {
  1537. "get": {
  1538. "produces": [
  1539. "application/json"
  1540. ],
  1541. "tags": [
  1542. "repository"
  1543. ],
  1544. "summary": "Search for repositories",
  1545. "operationId": "repoSearch",
  1546. "parameters": [
  1547. {
  1548. "type": "string",
  1549. "description": "keyword",
  1550. "name": "q",
  1551. "in": "query"
  1552. },
  1553. {
  1554. "type": "boolean",
  1555. "description": "Limit search to repositories with keyword as topic",
  1556. "name": "topic",
  1557. "in": "query"
  1558. },
  1559. {
  1560. "type": "boolean",
  1561. "description": "include search of keyword within repository description",
  1562. "name": "includeDesc",
  1563. "in": "query"
  1564. },
  1565. {
  1566. "type": "integer",
  1567. "format": "int64",
  1568. "description": "search only for repos that the user with the given id owns or contributes to",
  1569. "name": "uid",
  1570. "in": "query"
  1571. },
  1572. {
  1573. "type": "integer",
  1574. "format": "int64",
  1575. "description": "repo owner to prioritize in the results",
  1576. "name": "priority_owner_id",
  1577. "in": "query"
  1578. },
  1579. {
  1580. "type": "integer",
  1581. "format": "int64",
  1582. "description": "search only for repos that the user with the given id has starred",
  1583. "name": "starredBy",
  1584. "in": "query"
  1585. },
  1586. {
  1587. "type": "boolean",
  1588. "description": "include private repositories this user has access to (defaults to true)",
  1589. "name": "private",
  1590. "in": "query"
  1591. },
  1592. {
  1593. "type": "boolean",
  1594. "description": "include template repositories this user has access to (defaults to true)",
  1595. "name": "template",
  1596. "in": "query"
  1597. },
  1598. {
  1599. "type": "string",
  1600. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1601. "name": "mode",
  1602. "in": "query"
  1603. },
  1604. {
  1605. "type": "boolean",
  1606. "description": "if `uid` is given, search only for repos that the user owns",
  1607. "name": "exclusive",
  1608. "in": "query"
  1609. },
  1610. {
  1611. "type": "string",
  1612. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1613. "name": "sort",
  1614. "in": "query"
  1615. },
  1616. {
  1617. "type": "string",
  1618. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1619. "name": "order",
  1620. "in": "query"
  1621. },
  1622. {
  1623. "type": "integer",
  1624. "description": "page number of results to return (1-based)",
  1625. "name": "page",
  1626. "in": "query"
  1627. },
  1628. {
  1629. "type": "integer",
  1630. "description": "page size of results, maximum page size is 50",
  1631. "name": "limit",
  1632. "in": "query"
  1633. }
  1634. ],
  1635. "responses": {
  1636. "200": {
  1637. "$ref": "#/responses/SearchResults"
  1638. },
  1639. "422": {
  1640. "$ref": "#/responses/validationError"
  1641. }
  1642. }
  1643. }
  1644. },
  1645. "/repos/{owner}/{repo}": {
  1646. "get": {
  1647. "produces": [
  1648. "application/json"
  1649. ],
  1650. "tags": [
  1651. "repository"
  1652. ],
  1653. "summary": "Get a repository",
  1654. "operationId": "repoGet",
  1655. "parameters": [
  1656. {
  1657. "type": "string",
  1658. "description": "owner of the repo",
  1659. "name": "owner",
  1660. "in": "path",
  1661. "required": true
  1662. },
  1663. {
  1664. "type": "string",
  1665. "description": "name of the repo",
  1666. "name": "repo",
  1667. "in": "path",
  1668. "required": true
  1669. }
  1670. ],
  1671. "responses": {
  1672. "200": {
  1673. "$ref": "#/responses/Repository"
  1674. }
  1675. }
  1676. },
  1677. "delete": {
  1678. "produces": [
  1679. "application/json"
  1680. ],
  1681. "tags": [
  1682. "repository"
  1683. ],
  1684. "summary": "Delete a repository",
  1685. "operationId": "repoDelete",
  1686. "parameters": [
  1687. {
  1688. "type": "string",
  1689. "description": "owner of the repo to delete",
  1690. "name": "owner",
  1691. "in": "path",
  1692. "required": true
  1693. },
  1694. {
  1695. "type": "string",
  1696. "description": "name of the repo to delete",
  1697. "name": "repo",
  1698. "in": "path",
  1699. "required": true
  1700. }
  1701. ],
  1702. "responses": {
  1703. "204": {
  1704. "$ref": "#/responses/empty"
  1705. },
  1706. "403": {
  1707. "$ref": "#/responses/forbidden"
  1708. }
  1709. }
  1710. },
  1711. "patch": {
  1712. "produces": [
  1713. "application/json"
  1714. ],
  1715. "tags": [
  1716. "repository"
  1717. ],
  1718. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1719. "operationId": "repoEdit",
  1720. "parameters": [
  1721. {
  1722. "type": "string",
  1723. "description": "owner of the repo to edit",
  1724. "name": "owner",
  1725. "in": "path",
  1726. "required": true
  1727. },
  1728. {
  1729. "type": "string",
  1730. "description": "name of the repo to edit",
  1731. "name": "repo",
  1732. "in": "path",
  1733. "required": true
  1734. },
  1735. {
  1736. "description": "Properties of a repo that you can edit",
  1737. "name": "body",
  1738. "in": "body",
  1739. "schema": {
  1740. "$ref": "#/definitions/EditRepoOption"
  1741. }
  1742. }
  1743. ],
  1744. "responses": {
  1745. "200": {
  1746. "$ref": "#/responses/Repository"
  1747. },
  1748. "403": {
  1749. "$ref": "#/responses/forbidden"
  1750. },
  1751. "422": {
  1752. "$ref": "#/responses/validationError"
  1753. }
  1754. }
  1755. }
  1756. },
  1757. "/repos/{owner}/{repo}/archive/{archive}": {
  1758. "get": {
  1759. "produces": [
  1760. "application/json"
  1761. ],
  1762. "tags": [
  1763. "repository"
  1764. ],
  1765. "summary": "Get an archive of a repository",
  1766. "operationId": "repoGetArchive",
  1767. "parameters": [
  1768. {
  1769. "type": "string",
  1770. "description": "owner of the repo",
  1771. "name": "owner",
  1772. "in": "path",
  1773. "required": true
  1774. },
  1775. {
  1776. "type": "string",
  1777. "description": "name of the repo",
  1778. "name": "repo",
  1779. "in": "path",
  1780. "required": true
  1781. },
  1782. {
  1783. "type": "string",
  1784. "description": "archive to download, consisting of a git reference and archive",
  1785. "name": "archive",
  1786. "in": "path",
  1787. "required": true
  1788. }
  1789. ],
  1790. "responses": {
  1791. "200": {
  1792. "description": "success"
  1793. },
  1794. "404": {
  1795. "$ref": "#/responses/notFound"
  1796. }
  1797. }
  1798. }
  1799. },
  1800. "/repos/{owner}/{repo}/branch_protections": {
  1801. "get": {
  1802. "produces": [
  1803. "application/json"
  1804. ],
  1805. "tags": [
  1806. "repository"
  1807. ],
  1808. "summary": "List branch protections for a repository",
  1809. "operationId": "repoListBranchProtection",
  1810. "parameters": [
  1811. {
  1812. "type": "string",
  1813. "description": "owner of the repo",
  1814. "name": "owner",
  1815. "in": "path",
  1816. "required": true
  1817. },
  1818. {
  1819. "type": "string",
  1820. "description": "name of the repo",
  1821. "name": "repo",
  1822. "in": "path",
  1823. "required": true
  1824. }
  1825. ],
  1826. "responses": {
  1827. "200": {
  1828. "$ref": "#/responses/BranchProtectionList"
  1829. }
  1830. }
  1831. },
  1832. "post": {
  1833. "consumes": [
  1834. "application/json"
  1835. ],
  1836. "produces": [
  1837. "application/json"
  1838. ],
  1839. "tags": [
  1840. "repository"
  1841. ],
  1842. "summary": "Create a branch protections for a repository",
  1843. "operationId": "repoCreateBranchProtection",
  1844. "parameters": [
  1845. {
  1846. "type": "string",
  1847. "description": "owner of the repo",
  1848. "name": "owner",
  1849. "in": "path",
  1850. "required": true
  1851. },
  1852. {
  1853. "type": "string",
  1854. "description": "name of the repo",
  1855. "name": "repo",
  1856. "in": "path",
  1857. "required": true
  1858. },
  1859. {
  1860. "name": "body",
  1861. "in": "body",
  1862. "schema": {
  1863. "$ref": "#/definitions/CreateBranchProtectionOption"
  1864. }
  1865. }
  1866. ],
  1867. "responses": {
  1868. "201": {
  1869. "$ref": "#/responses/BranchProtection"
  1870. },
  1871. "403": {
  1872. "$ref": "#/responses/forbidden"
  1873. },
  1874. "404": {
  1875. "$ref": "#/responses/notFound"
  1876. },
  1877. "422": {
  1878. "$ref": "#/responses/validationError"
  1879. }
  1880. }
  1881. }
  1882. },
  1883. "/repos/{owner}/{repo}/branch_protections/{name}": {
  1884. "get": {
  1885. "produces": [
  1886. "application/json"
  1887. ],
  1888. "tags": [
  1889. "repository"
  1890. ],
  1891. "summary": "Get a specific branch protection for the repository",
  1892. "operationId": "repoGetBranchProtection",
  1893. "parameters": [
  1894. {
  1895. "type": "string",
  1896. "description": "owner of the repo",
  1897. "name": "owner",
  1898. "in": "path",
  1899. "required": true
  1900. },
  1901. {
  1902. "type": "string",
  1903. "description": "name of the repo",
  1904. "name": "repo",
  1905. "in": "path",
  1906. "required": true
  1907. },
  1908. {
  1909. "type": "string",
  1910. "description": "name of protected branch",
  1911. "name": "name",
  1912. "in": "path",
  1913. "required": true
  1914. }
  1915. ],
  1916. "responses": {
  1917. "200": {
  1918. "$ref": "#/responses/BranchProtection"
  1919. },
  1920. "404": {
  1921. "$ref": "#/responses/notFound"
  1922. }
  1923. }
  1924. },
  1925. "delete": {
  1926. "produces": [
  1927. "application/json"
  1928. ],
  1929. "tags": [
  1930. "repository"
  1931. ],
  1932. "summary": "Delete a specific branch protection for the repository",
  1933. "operationId": "repoDeleteBranchProtection",
  1934. "parameters": [
  1935. {
  1936. "type": "string",
  1937. "description": "owner of the repo",
  1938. "name": "owner",
  1939. "in": "path",
  1940. "required": true
  1941. },
  1942. {
  1943. "type": "string",
  1944. "description": "name of the repo",
  1945. "name": "repo",
  1946. "in": "path",
  1947. "required": true
  1948. },
  1949. {
  1950. "type": "string",
  1951. "description": "name of protected branch",
  1952. "name": "name",
  1953. "in": "path",
  1954. "required": true
  1955. }
  1956. ],
  1957. "responses": {
  1958. "204": {
  1959. "$ref": "#/responses/empty"
  1960. },
  1961. "404": {
  1962. "$ref": "#/responses/notFound"
  1963. }
  1964. }
  1965. },
  1966. "patch": {
  1967. "consumes": [
  1968. "application/json"
  1969. ],
  1970. "produces": [
  1971. "application/json"
  1972. ],
  1973. "tags": [
  1974. "repository"
  1975. ],
  1976. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  1977. "operationId": "repoEditBranchProtection",
  1978. "parameters": [
  1979. {
  1980. "type": "string",
  1981. "description": "owner of the repo",
  1982. "name": "owner",
  1983. "in": "path",
  1984. "required": true
  1985. },
  1986. {
  1987. "type": "string",
  1988. "description": "name of the repo",
  1989. "name": "repo",
  1990. "in": "path",
  1991. "required": true
  1992. },
  1993. {
  1994. "type": "string",
  1995. "description": "name of protected branch",
  1996. "name": "name",
  1997. "in": "path",
  1998. "required": true
  1999. },
  2000. {
  2001. "name": "body",
  2002. "in": "body",
  2003. "schema": {
  2004. "$ref": "#/definitions/EditBranchProtectionOption"
  2005. }
  2006. }
  2007. ],
  2008. "responses": {
  2009. "200": {
  2010. "$ref": "#/responses/BranchProtection"
  2011. },
  2012. "404": {
  2013. "$ref": "#/responses/notFound"
  2014. },
  2015. "422": {
  2016. "$ref": "#/responses/validationError"
  2017. }
  2018. }
  2019. }
  2020. },
  2021. "/repos/{owner}/{repo}/branches": {
  2022. "get": {
  2023. "produces": [
  2024. "application/json"
  2025. ],
  2026. "tags": [
  2027. "repository"
  2028. ],
  2029. "summary": "List a repository's branches",
  2030. "operationId": "repoListBranches",
  2031. "parameters": [
  2032. {
  2033. "type": "string",
  2034. "description": "owner of the repo",
  2035. "name": "owner",
  2036. "in": "path",
  2037. "required": true
  2038. },
  2039. {
  2040. "type": "string",
  2041. "description": "name of the repo",
  2042. "name": "repo",
  2043. "in": "path",
  2044. "required": true
  2045. }
  2046. ],
  2047. "responses": {
  2048. "200": {
  2049. "$ref": "#/responses/BranchList"
  2050. }
  2051. }
  2052. }
  2053. },
  2054. "/repos/{owner}/{repo}/branches/{branch}": {
  2055. "get": {
  2056. "produces": [
  2057. "application/json"
  2058. ],
  2059. "tags": [
  2060. "repository"
  2061. ],
  2062. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  2063. "operationId": "repoGetBranch",
  2064. "parameters": [
  2065. {
  2066. "type": "string",
  2067. "description": "owner of the repo",
  2068. "name": "owner",
  2069. "in": "path",
  2070. "required": true
  2071. },
  2072. {
  2073. "type": "string",
  2074. "description": "name of the repo",
  2075. "name": "repo",
  2076. "in": "path",
  2077. "required": true
  2078. },
  2079. {
  2080. "type": "string",
  2081. "description": "branch to get",
  2082. "name": "branch",
  2083. "in": "path",
  2084. "required": true
  2085. }
  2086. ],
  2087. "responses": {
  2088. "200": {
  2089. "$ref": "#/responses/Branch"
  2090. }
  2091. }
  2092. }
  2093. },
  2094. "/repos/{owner}/{repo}/collaborators": {
  2095. "get": {
  2096. "produces": [
  2097. "application/json"
  2098. ],
  2099. "tags": [
  2100. "repository"
  2101. ],
  2102. "summary": "List a repository's collaborators",
  2103. "operationId": "repoListCollaborators",
  2104. "parameters": [
  2105. {
  2106. "type": "string",
  2107. "description": "owner of the repo",
  2108. "name": "owner",
  2109. "in": "path",
  2110. "required": true
  2111. },
  2112. {
  2113. "type": "string",
  2114. "description": "name of the repo",
  2115. "name": "repo",
  2116. "in": "path",
  2117. "required": true
  2118. },
  2119. {
  2120. "type": "integer",
  2121. "description": "page number of results to return (1-based)",
  2122. "name": "page",
  2123. "in": "query"
  2124. },
  2125. {
  2126. "type": "integer",
  2127. "description": "page size of results, maximum page size is 50",
  2128. "name": "limit",
  2129. "in": "query"
  2130. }
  2131. ],
  2132. "responses": {
  2133. "200": {
  2134. "$ref": "#/responses/UserList"
  2135. }
  2136. }
  2137. }
  2138. },
  2139. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  2140. "get": {
  2141. "produces": [
  2142. "application/json"
  2143. ],
  2144. "tags": [
  2145. "repository"
  2146. ],
  2147. "summary": "Check if a user is a collaborator of a repository",
  2148. "operationId": "repoCheckCollaborator",
  2149. "parameters": [
  2150. {
  2151. "type": "string",
  2152. "description": "owner of the repo",
  2153. "name": "owner",
  2154. "in": "path",
  2155. "required": true
  2156. },
  2157. {
  2158. "type": "string",
  2159. "description": "name of the repo",
  2160. "name": "repo",
  2161. "in": "path",
  2162. "required": true
  2163. },
  2164. {
  2165. "type": "string",
  2166. "description": "username of the collaborator",
  2167. "name": "collaborator",
  2168. "in": "path",
  2169. "required": true
  2170. }
  2171. ],
  2172. "responses": {
  2173. "204": {
  2174. "$ref": "#/responses/empty"
  2175. },
  2176. "404": {
  2177. "$ref": "#/responses/notFound"
  2178. },
  2179. "422": {
  2180. "$ref": "#/responses/validationError"
  2181. }
  2182. }
  2183. },
  2184. "put": {
  2185. "produces": [
  2186. "application/json"
  2187. ],
  2188. "tags": [
  2189. "repository"
  2190. ],
  2191. "summary": "Add a collaborator to a repository",
  2192. "operationId": "repoAddCollaborator",
  2193. "parameters": [
  2194. {
  2195. "type": "string",
  2196. "description": "owner of the repo",
  2197. "name": "owner",
  2198. "in": "path",
  2199. "required": true
  2200. },
  2201. {
  2202. "type": "string",
  2203. "description": "name of the repo",
  2204. "name": "repo",
  2205. "in": "path",
  2206. "required": true
  2207. },
  2208. {
  2209. "type": "string",
  2210. "description": "username of the collaborator to add",
  2211. "name": "collaborator",
  2212. "in": "path",
  2213. "required": true
  2214. },
  2215. {
  2216. "name": "body",
  2217. "in": "body",
  2218. "schema": {
  2219. "$ref": "#/definitions/AddCollaboratorOption"
  2220. }
  2221. }
  2222. ],
  2223. "responses": {
  2224. "204": {
  2225. "$ref": "#/responses/empty"
  2226. },
  2227. "422": {
  2228. "$ref": "#/responses/validationError"
  2229. }
  2230. }
  2231. },
  2232. "delete": {
  2233. "produces": [
  2234. "application/json"
  2235. ],
  2236. "tags": [
  2237. "repository"
  2238. ],
  2239. "summary": "Delete a collaborator from a repository",
  2240. "operationId": "repoDeleteCollaborator",
  2241. "parameters": [
  2242. {
  2243. "type": "string",
  2244. "description": "owner of the repo",
  2245. "name": "owner",
  2246. "in": "path",
  2247. "required": true
  2248. },
  2249. {
  2250. "type": "string",
  2251. "description": "name of the repo",
  2252. "name": "repo",
  2253. "in": "path",
  2254. "required": true
  2255. },
  2256. {
  2257. "type": "string",
  2258. "description": "username of the collaborator to delete",
  2259. "name": "collaborator",
  2260. "in": "path",
  2261. "required": true
  2262. }
  2263. ],
  2264. "responses": {
  2265. "204": {
  2266. "$ref": "#/responses/empty"
  2267. },
  2268. "422": {
  2269. "$ref": "#/responses/validationError"
  2270. }
  2271. }
  2272. }
  2273. },
  2274. "/repos/{owner}/{repo}/commits": {
  2275. "get": {
  2276. "produces": [
  2277. "application/json"
  2278. ],
  2279. "tags": [
  2280. "repository"
  2281. ],
  2282. "summary": "Get a list of all commits from a repository",
  2283. "operationId": "repoGetAllCommits",
  2284. "parameters": [
  2285. {
  2286. "type": "string",
  2287. "description": "owner of the repo",
  2288. "name": "owner",
  2289. "in": "path",
  2290. "required": true
  2291. },
  2292. {
  2293. "type": "string",
  2294. "description": "name of the repo",
  2295. "name": "repo",
  2296. "in": "path",
  2297. "required": true
  2298. },
  2299. {
  2300. "type": "string",
  2301. "description": "SHA or branch to start listing commits from (usually 'master')",
  2302. "name": "sha",
  2303. "in": "query"
  2304. },
  2305. {
  2306. "type": "integer",
  2307. "description": "page number of results to return (1-based)",
  2308. "name": "page",
  2309. "in": "query"
  2310. },
  2311. {
  2312. "type": "integer",
  2313. "description": "page size of results, maximum page size is 50",
  2314. "name": "limit",
  2315. "in": "query"
  2316. }
  2317. ],
  2318. "responses": {
  2319. "200": {
  2320. "$ref": "#/responses/CommitList"
  2321. },
  2322. "404": {
  2323. "$ref": "#/responses/notFound"
  2324. },
  2325. "409": {
  2326. "$ref": "#/responses/EmptyRepository"
  2327. }
  2328. }
  2329. }
  2330. },
  2331. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2332. "get": {
  2333. "produces": [
  2334. "application/json"
  2335. ],
  2336. "tags": [
  2337. "repository"
  2338. ],
  2339. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2340. "operationId": "repoGetCombinedStatusByRef",
  2341. "parameters": [
  2342. {
  2343. "type": "string",
  2344. "description": "owner of the repo",
  2345. "name": "owner",
  2346. "in": "path",
  2347. "required": true
  2348. },
  2349. {
  2350. "type": "string",
  2351. "description": "name of the repo",
  2352. "name": "repo",
  2353. "in": "path",
  2354. "required": true
  2355. },
  2356. {
  2357. "type": "string",
  2358. "description": "name of branch/tag/commit",
  2359. "name": "ref",
  2360. "in": "path",
  2361. "required": true
  2362. },
  2363. {
  2364. "type": "integer",
  2365. "description": "page number of results",
  2366. "name": "page",
  2367. "in": "query"
  2368. }
  2369. ],
  2370. "responses": {
  2371. "200": {
  2372. "$ref": "#/responses/Status"
  2373. },
  2374. "400": {
  2375. "$ref": "#/responses/error"
  2376. }
  2377. }
  2378. }
  2379. },
  2380. "/repos/{owner}/{repo}/contents": {
  2381. "get": {
  2382. "produces": [
  2383. "application/json"
  2384. ],
  2385. "tags": [
  2386. "repository"
  2387. ],
  2388. "summary": "Gets the metadata of all the entries of the root dir",
  2389. "operationId": "repoGetContentsList",
  2390. "parameters": [
  2391. {
  2392. "type": "string",
  2393. "description": "owner of the repo",
  2394. "name": "owner",
  2395. "in": "path",
  2396. "required": true
  2397. },
  2398. {
  2399. "type": "string",
  2400. "description": "name of the repo",
  2401. "name": "repo",
  2402. "in": "path",
  2403. "required": true
  2404. },
  2405. {
  2406. "type": "string",
  2407. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2408. "name": "ref",
  2409. "in": "query"
  2410. }
  2411. ],
  2412. "responses": {
  2413. "200": {
  2414. "$ref": "#/responses/ContentsListResponse"
  2415. }
  2416. }
  2417. }
  2418. },
  2419. "/repos/{owner}/{repo}/contents/{filepath}": {
  2420. "get": {
  2421. "produces": [
  2422. "application/json"
  2423. ],
  2424. "tags": [
  2425. "repository"
  2426. ],
  2427. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2428. "operationId": "repoGetContents",
  2429. "parameters": [
  2430. {
  2431. "type": "string",
  2432. "description": "owner of the repo",
  2433. "name": "owner",
  2434. "in": "path",
  2435. "required": true
  2436. },
  2437. {
  2438. "type": "string",
  2439. "description": "name of the repo",
  2440. "name": "repo",
  2441. "in": "path",
  2442. "required": true
  2443. },
  2444. {
  2445. "type": "string",
  2446. "description": "path of the dir, file, symlink or submodule in the repo",
  2447. "name": "filepath",
  2448. "in": "path",
  2449. "required": true
  2450. },
  2451. {
  2452. "type": "string",
  2453. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2454. "name": "ref",
  2455. "in": "query"
  2456. }
  2457. ],
  2458. "responses": {
  2459. "200": {
  2460. "$ref": "#/responses/ContentsResponse"
  2461. }
  2462. }
  2463. },
  2464. "put": {
  2465. "consumes": [
  2466. "application/json"
  2467. ],
  2468. "produces": [
  2469. "application/json"
  2470. ],
  2471. "tags": [
  2472. "repository"
  2473. ],
  2474. "summary": "Update a file in a repository",
  2475. "operationId": "repoUpdateFile",
  2476. "parameters": [
  2477. {
  2478. "type": "string",
  2479. "description": "owner of the repo",
  2480. "name": "owner",
  2481. "in": "path",
  2482. "required": true
  2483. },
  2484. {
  2485. "type": "string",
  2486. "description": "name of the repo",
  2487. "name": "repo",
  2488. "in": "path",
  2489. "required": true
  2490. },
  2491. {
  2492. "type": "string",
  2493. "description": "path of the file to update",
  2494. "name": "filepath",
  2495. "in": "path",
  2496. "required": true
  2497. },
  2498. {
  2499. "name": "body",
  2500. "in": "body",
  2501. "required": true,
  2502. "schema": {
  2503. "$ref": "#/definitions/UpdateFileOptions"
  2504. }
  2505. }
  2506. ],
  2507. "responses": {
  2508. "200": {
  2509. "$ref": "#/responses/FileResponse"
  2510. }
  2511. }
  2512. },
  2513. "post": {
  2514. "consumes": [
  2515. "application/json"
  2516. ],
  2517. "produces": [
  2518. "application/json"
  2519. ],
  2520. "tags": [
  2521. "repository"
  2522. ],
  2523. "summary": "Create a file in a repository",
  2524. "operationId": "repoCreateFile",
  2525. "parameters": [
  2526. {
  2527. "type": "string",
  2528. "description": "owner of the repo",
  2529. "name": "owner",
  2530. "in": "path",
  2531. "required": true
  2532. },
  2533. {
  2534. "type": "string",
  2535. "description": "name of the repo",
  2536. "name": "repo",
  2537. "in": "path",
  2538. "required": true
  2539. },
  2540. {
  2541. "type": "string",
  2542. "description": "path of the file to create",
  2543. "name": "filepath",
  2544. "in": "path",
  2545. "required": true
  2546. },
  2547. {
  2548. "name": "body",
  2549. "in": "body",
  2550. "required": true,
  2551. "schema": {
  2552. "$ref": "#/definitions/CreateFileOptions"
  2553. }
  2554. }
  2555. ],
  2556. "responses": {
  2557. "201": {
  2558. "$ref": "#/responses/FileResponse"
  2559. }
  2560. }
  2561. },
  2562. "delete": {
  2563. "consumes": [
  2564. "application/json"
  2565. ],
  2566. "produces": [
  2567. "application/json"
  2568. ],
  2569. "tags": [
  2570. "repository"
  2571. ],
  2572. "summary": "Delete a file in a repository",
  2573. "operationId": "repoDeleteFile",
  2574. "parameters": [
  2575. {
  2576. "type": "string",
  2577. "description": "owner of the repo",
  2578. "name": "owner",
  2579. "in": "path",
  2580. "required": true
  2581. },
  2582. {
  2583. "type": "string",
  2584. "description": "name of the repo",
  2585. "name": "repo",
  2586. "in": "path",
  2587. "required": true
  2588. },
  2589. {
  2590. "type": "string",
  2591. "description": "path of the file to delete",
  2592. "name": "filepath",
  2593. "in": "path",
  2594. "required": true
  2595. },
  2596. {
  2597. "name": "body",
  2598. "in": "body",
  2599. "required": true,
  2600. "schema": {
  2601. "$ref": "#/definitions/DeleteFileOptions"
  2602. }
  2603. }
  2604. ],
  2605. "responses": {
  2606. "200": {
  2607. "$ref": "#/responses/FileDeleteResponse"
  2608. }
  2609. }
  2610. }
  2611. },
  2612. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2613. "get": {
  2614. "produces": [
  2615. "application/json"
  2616. ],
  2617. "tags": [
  2618. "repository"
  2619. ],
  2620. "summary": "Get the EditorConfig definitions of a file in a repository",
  2621. "operationId": "repoGetEditorConfig",
  2622. "parameters": [
  2623. {
  2624. "type": "string",
  2625. "description": "owner of the repo",
  2626. "name": "owner",
  2627. "in": "path",
  2628. "required": true
  2629. },
  2630. {
  2631. "type": "string",
  2632. "description": "name of the repo",
  2633. "name": "repo",
  2634. "in": "path",
  2635. "required": true
  2636. },
  2637. {
  2638. "type": "string",
  2639. "description": "filepath of file to get",
  2640. "name": "filepath",
  2641. "in": "path",
  2642. "required": true
  2643. }
  2644. ],
  2645. "responses": {
  2646. "200": {
  2647. "description": "success"
  2648. },
  2649. "404": {
  2650. "$ref": "#/responses/notFound"
  2651. }
  2652. }
  2653. }
  2654. },
  2655. "/repos/{owner}/{repo}/forks": {
  2656. "get": {
  2657. "produces": [
  2658. "application/json"
  2659. ],
  2660. "tags": [
  2661. "repository"
  2662. ],
  2663. "summary": "List a repository's forks",
  2664. "operationId": "listForks",
  2665. "parameters": [
  2666. {
  2667. "type": "string",
  2668. "description": "owner of the repo",
  2669. "name": "owner",
  2670. "in": "path",
  2671. "required": true
  2672. },
  2673. {
  2674. "type": "string",
  2675. "description": "name of the repo",
  2676. "name": "repo",
  2677. "in": "path",
  2678. "required": true
  2679. },
  2680. {
  2681. "type": "integer",
  2682. "description": "page number of results to return (1-based)",
  2683. "name": "page",
  2684. "in": "query"
  2685. },
  2686. {
  2687. "type": "integer",
  2688. "description": "page size of results, maximum page size is 50",
  2689. "name": "limit",
  2690. "in": "query"
  2691. }
  2692. ],
  2693. "responses": {
  2694. "200": {
  2695. "$ref": "#/responses/RepositoryList"
  2696. }
  2697. }
  2698. },
  2699. "post": {
  2700. "produces": [
  2701. "application/json"
  2702. ],
  2703. "tags": [
  2704. "repository"
  2705. ],
  2706. "summary": "Fork a repository",
  2707. "operationId": "createFork",
  2708. "parameters": [
  2709. {
  2710. "type": "string",
  2711. "description": "owner of the repo to fork",
  2712. "name": "owner",
  2713. "in": "path",
  2714. "required": true
  2715. },
  2716. {
  2717. "type": "string",
  2718. "description": "name of the repo to fork",
  2719. "name": "repo",
  2720. "in": "path",
  2721. "required": true
  2722. },
  2723. {
  2724. "name": "body",
  2725. "in": "body",
  2726. "schema": {
  2727. "$ref": "#/definitions/CreateForkOption"
  2728. }
  2729. }
  2730. ],
  2731. "responses": {
  2732. "202": {
  2733. "$ref": "#/responses/Repository"
  2734. },
  2735. "403": {
  2736. "$ref": "#/responses/forbidden"
  2737. },
  2738. "422": {
  2739. "$ref": "#/responses/validationError"
  2740. }
  2741. }
  2742. }
  2743. },
  2744. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  2745. "get": {
  2746. "produces": [
  2747. "application/json"
  2748. ],
  2749. "tags": [
  2750. "repository"
  2751. ],
  2752. "summary": "Gets the blob of a repository.",
  2753. "operationId": "GetBlob",
  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": "sha of the commit",
  2772. "name": "sha",
  2773. "in": "path",
  2774. "required": true
  2775. }
  2776. ],
  2777. "responses": {
  2778. "200": {
  2779. "$ref": "#/responses/GitBlobResponse"
  2780. },
  2781. "400": {
  2782. "$ref": "#/responses/error"
  2783. }
  2784. }
  2785. }
  2786. },
  2787. "/repos/{owner}/{repo}/git/commits/{sha}": {
  2788. "get": {
  2789. "produces": [
  2790. "application/json"
  2791. ],
  2792. "tags": [
  2793. "repository"
  2794. ],
  2795. "summary": "Get a single commit from a repository",
  2796. "operationId": "repoGetSingleCommit",
  2797. "parameters": [
  2798. {
  2799. "type": "string",
  2800. "description": "owner of the repo",
  2801. "name": "owner",
  2802. "in": "path",
  2803. "required": true
  2804. },
  2805. {
  2806. "type": "string",
  2807. "description": "name of the repo",
  2808. "name": "repo",
  2809. "in": "path",
  2810. "required": true
  2811. },
  2812. {
  2813. "type": "string",
  2814. "description": "the commit hash",
  2815. "name": "sha",
  2816. "in": "path",
  2817. "required": true
  2818. }
  2819. ],
  2820. "responses": {
  2821. "200": {
  2822. "$ref": "#/responses/Commit"
  2823. },
  2824. "404": {
  2825. "$ref": "#/responses/notFound"
  2826. }
  2827. }
  2828. }
  2829. },
  2830. "/repos/{owner}/{repo}/git/refs": {
  2831. "get": {
  2832. "produces": [
  2833. "application/json"
  2834. ],
  2835. "tags": [
  2836. "repository"
  2837. ],
  2838. "summary": "Get specified ref or filtered repository's refs",
  2839. "operationId": "repoListAllGitRefs",
  2840. "parameters": [
  2841. {
  2842. "type": "string",
  2843. "description": "owner of the repo",
  2844. "name": "owner",
  2845. "in": "path",
  2846. "required": true
  2847. },
  2848. {
  2849. "type": "string",
  2850. "description": "name of the repo",
  2851. "name": "repo",
  2852. "in": "path",
  2853. "required": true
  2854. }
  2855. ],
  2856. "responses": {
  2857. "200": {
  2858. "$ref": "#/responses/ReferenceList"
  2859. },
  2860. "404": {
  2861. "$ref": "#/responses/notFound"
  2862. }
  2863. }
  2864. }
  2865. },
  2866. "/repos/{owner}/{repo}/git/refs/{ref}": {
  2867. "get": {
  2868. "produces": [
  2869. "application/json"
  2870. ],
  2871. "tags": [
  2872. "repository"
  2873. ],
  2874. "summary": "Get specified ref or filtered repository's refs",
  2875. "operationId": "repoListGitRefs",
  2876. "parameters": [
  2877. {
  2878. "type": "string",
  2879. "description": "owner of the repo",
  2880. "name": "owner",
  2881. "in": "path",
  2882. "required": true
  2883. },
  2884. {
  2885. "type": "string",
  2886. "description": "name of the repo",
  2887. "name": "repo",
  2888. "in": "path",
  2889. "required": true
  2890. },
  2891. {
  2892. "type": "string",
  2893. "description": "part or full name of the ref",
  2894. "name": "ref",
  2895. "in": "path",
  2896. "required": true
  2897. }
  2898. ],
  2899. "responses": {
  2900. "200": {
  2901. "$ref": "#/responses/ReferenceList"
  2902. },
  2903. "404": {
  2904. "$ref": "#/responses/notFound"
  2905. }
  2906. }
  2907. }
  2908. },
  2909. "/repos/{owner}/{repo}/git/tags/{sha}": {
  2910. "get": {
  2911. "produces": [
  2912. "application/json"
  2913. ],
  2914. "tags": [
  2915. "repository"
  2916. ],
  2917. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  2918. "operationId": "GetTag",
  2919. "parameters": [
  2920. {
  2921. "type": "string",
  2922. "description": "owner of the repo",
  2923. "name": "owner",
  2924. "in": "path",
  2925. "required": true
  2926. },
  2927. {
  2928. "type": "string",
  2929. "description": "name of the repo",
  2930. "name": "repo",
  2931. "in": "path",
  2932. "required": true
  2933. },
  2934. {
  2935. "type": "string",
  2936. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  2937. "name": "sha",
  2938. "in": "path",
  2939. "required": true
  2940. }
  2941. ],
  2942. "responses": {
  2943. "200": {
  2944. "$ref": "#/responses/AnnotatedTag"
  2945. },
  2946. "400": {
  2947. "$ref": "#/responses/error"
  2948. }
  2949. }
  2950. }
  2951. },
  2952. "/repos/{owner}/{repo}/git/trees/{sha}": {
  2953. "get": {
  2954. "produces": [
  2955. "application/json"
  2956. ],
  2957. "tags": [
  2958. "repository"
  2959. ],
  2960. "summary": "Gets the tree of a repository.",
  2961. "operationId": "GetTree",
  2962. "parameters": [
  2963. {
  2964. "type": "string",
  2965. "description": "owner of the repo",
  2966. "name": "owner",
  2967. "in": "path",
  2968. "required": true
  2969. },
  2970. {
  2971. "type": "string",
  2972. "description": "name of the repo",
  2973. "name": "repo",
  2974. "in": "path",
  2975. "required": true
  2976. },
  2977. {
  2978. "type": "string",
  2979. "description": "sha of the commit",
  2980. "name": "sha",
  2981. "in": "path",
  2982. "required": true
  2983. },
  2984. {
  2985. "type": "boolean",
  2986. "description": "show all directories and files",
  2987. "name": "recursive",
  2988. "in": "query"
  2989. },
  2990. {
  2991. "type": "integer",
  2992. "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",
  2993. "name": "page",
  2994. "in": "query"
  2995. },
  2996. {
  2997. "type": "integer",
  2998. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  2999. "name": "per_page",
  3000. "in": "query"
  3001. }
  3002. ],
  3003. "responses": {
  3004. "200": {
  3005. "$ref": "#/responses/GitTreeResponse"
  3006. },
  3007. "400": {
  3008. "$ref": "#/responses/error"
  3009. }
  3010. }
  3011. }
  3012. },
  3013. "/repos/{owner}/{repo}/hooks": {
  3014. "get": {
  3015. "produces": [
  3016. "application/json"
  3017. ],
  3018. "tags": [
  3019. "repository"
  3020. ],
  3021. "summary": "List the hooks in a repository",
  3022. "operationId": "repoListHooks",
  3023. "parameters": [
  3024. {
  3025. "type": "string",
  3026. "description": "owner of the repo",
  3027. "name": "owner",
  3028. "in": "path",
  3029. "required": true
  3030. },
  3031. {
  3032. "type": "string",
  3033. "description": "name of the repo",
  3034. "name": "repo",
  3035. "in": "path",
  3036. "required": true
  3037. },
  3038. {
  3039. "type": "integer",
  3040. "description": "page number of results to return (1-based)",
  3041. "name": "page",
  3042. "in": "query"
  3043. },
  3044. {
  3045. "type": "integer",
  3046. "description": "page size of results, maximum page size is 50",
  3047. "name": "limit",
  3048. "in": "query"
  3049. }
  3050. ],
  3051. "responses": {
  3052. "200": {
  3053. "$ref": "#/responses/HookList"
  3054. }
  3055. }
  3056. },
  3057. "post": {
  3058. "consumes": [
  3059. "application/json"
  3060. ],
  3061. "produces": [
  3062. "application/json"
  3063. ],
  3064. "tags": [
  3065. "repository"
  3066. ],
  3067. "summary": "Create a hook",
  3068. "operationId": "repoCreateHook",
  3069. "parameters": [
  3070. {
  3071. "type": "string",
  3072. "description": "owner of the repo",
  3073. "name": "owner",
  3074. "in": "path",
  3075. "required": true
  3076. },
  3077. {
  3078. "type": "string",
  3079. "description": "name of the repo",
  3080. "name": "repo",
  3081. "in": "path",
  3082. "required": true
  3083. },
  3084. {
  3085. "name": "body",
  3086. "in": "body",
  3087. "schema": {
  3088. "$ref": "#/definitions/CreateHookOption"
  3089. }
  3090. }
  3091. ],
  3092. "responses": {
  3093. "201": {
  3094. "$ref": "#/responses/Hook"
  3095. }
  3096. }
  3097. }
  3098. },
  3099. "/repos/{owner}/{repo}/hooks/git": {
  3100. "get": {
  3101. "produces": [
  3102. "application/json"
  3103. ],
  3104. "tags": [
  3105. "repository"
  3106. ],
  3107. "summary": "List the Git hooks in a repository",
  3108. "operationId": "repoListGitHooks",
  3109. "parameters": [
  3110. {
  3111. "type": "string",
  3112. "description": "owner of the repo",
  3113. "name": "owner",
  3114. "in": "path",
  3115. "required": true
  3116. },
  3117. {
  3118. "type": "string",
  3119. "description": "name of the repo",
  3120. "name": "repo",
  3121. "in": "path",
  3122. "required": true
  3123. }
  3124. ],
  3125. "responses": {
  3126. "200": {
  3127. "$ref": "#/responses/GitHookList"
  3128. }
  3129. }
  3130. }
  3131. },
  3132. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3133. "get": {
  3134. "produces": [
  3135. "application/json"
  3136. ],
  3137. "tags": [
  3138. "repository"
  3139. ],
  3140. "summary": "Get a Git hook",
  3141. "operationId": "repoGetGitHook",
  3142. "parameters": [
  3143. {
  3144. "type": "string",
  3145. "description": "owner of the repo",
  3146. "name": "owner",
  3147. "in": "path",
  3148. "required": true
  3149. },
  3150. {
  3151. "type": "string",
  3152. "description": "name of the repo",
  3153. "name": "repo",
  3154. "in": "path",
  3155. "required": true
  3156. },
  3157. {
  3158. "type": "string",
  3159. "description": "id of the hook to get",
  3160. "name": "id",
  3161. "in": "path",
  3162. "required": true
  3163. }
  3164. ],
  3165. "responses": {
  3166. "200": {
  3167. "$ref": "#/responses/GitHook"
  3168. },
  3169. "404": {
  3170. "$ref": "#/responses/notFound"
  3171. }
  3172. }
  3173. },
  3174. "delete": {
  3175. "produces": [
  3176. "application/json"
  3177. ],
  3178. "tags": [
  3179. "repository"
  3180. ],
  3181. "summary": "Delete a Git hook in a repository",
  3182. "operationId": "repoDeleteGitHook",
  3183. "parameters": [
  3184. {
  3185. "type": "string",
  3186. "description": "owner of the repo",
  3187. "name": "owner",
  3188. "in": "path",
  3189. "required": true
  3190. },
  3191. {
  3192. "type": "string",
  3193. "description": "name of the repo",
  3194. "name": "repo",
  3195. "in": "path",
  3196. "required": true
  3197. },
  3198. {
  3199. "type": "string",
  3200. "description": "id of the hook to get",
  3201. "name": "id",
  3202. "in": "path",
  3203. "required": true
  3204. }
  3205. ],
  3206. "responses": {
  3207. "204": {
  3208. "$ref": "#/responses/empty"
  3209. },
  3210. "404": {
  3211. "$ref": "#/responses/notFound"
  3212. }
  3213. }
  3214. },
  3215. "patch": {
  3216. "produces": [
  3217. "application/json"
  3218. ],
  3219. "tags": [
  3220. "repository"
  3221. ],
  3222. "summary": "Edit a Git hook in a repository",
  3223. "operationId": "repoEditGitHook",
  3224. "parameters": [
  3225. {
  3226. "type": "string",
  3227. "description": "owner of the repo",
  3228. "name": "owner",
  3229. "in": "path",
  3230. "required": true
  3231. },
  3232. {
  3233. "type": "string",
  3234. "description": "name of the repo",
  3235. "name": "repo",
  3236. "in": "path",
  3237. "required": true
  3238. },
  3239. {
  3240. "type": "string",
  3241. "description": "id of the hook to get",
  3242. "name": "id",
  3243. "in": "path",
  3244. "required": true
  3245. },
  3246. {
  3247. "name": "body",
  3248. "in": "body",
  3249. "schema": {
  3250. "$ref": "#/definitions/EditGitHookOption"
  3251. }
  3252. }
  3253. ],
  3254. "responses": {
  3255. "200": {
  3256. "$ref": "#/responses/GitHook"
  3257. },
  3258. "404": {
  3259. "$ref": "#/responses/notFound"
  3260. }
  3261. }
  3262. }
  3263. },
  3264. "/repos/{owner}/{repo}/hooks/{id}": {
  3265. "get": {
  3266. "produces": [
  3267. "application/json"
  3268. ],
  3269. "tags": [
  3270. "repository"
  3271. ],
  3272. "summary": "Get a hook",
  3273. "operationId": "repoGetHook",
  3274. "parameters": [
  3275. {
  3276. "type": "string",
  3277. "description": "owner of the repo",
  3278. "name": "owner",
  3279. "in": "path",
  3280. "required": true
  3281. },
  3282. {
  3283. "type": "string",
  3284. "description": "name of the repo",
  3285. "name": "repo",
  3286. "in": "path",
  3287. "required": true
  3288. },
  3289. {
  3290. "type": "integer",
  3291. "format": "int64",
  3292. "description": "id of the hook to get",
  3293. "name": "id",
  3294. "in": "path",
  3295. "required": true
  3296. }
  3297. ],
  3298. "responses": {
  3299. "200": {
  3300. "$ref": "#/responses/Hook"
  3301. },
  3302. "404": {
  3303. "$ref": "#/responses/notFound"
  3304. }
  3305. }
  3306. },
  3307. "delete": {
  3308. "produces": [
  3309. "application/json"
  3310. ],
  3311. "tags": [
  3312. "repository"
  3313. ],
  3314. "summary": "Delete a hook in a repository",
  3315. "operationId": "repoDeleteHook",
  3316. "parameters": [
  3317. {
  3318. "type": "string",
  3319. "description": "owner of the repo",
  3320. "name": "owner",
  3321. "in": "path",
  3322. "required": true
  3323. },
  3324. {
  3325. "type": "string",
  3326. "description": "name of the repo",
  3327. "name": "repo",
  3328. "in": "path",
  3329. "required": true
  3330. },
  3331. {
  3332. "type": "integer",
  3333. "format": "int64",
  3334. "description": "id of the hook to delete",
  3335. "name": "id",
  3336. "in": "path",
  3337. "required": true
  3338. }
  3339. ],
  3340. "responses": {
  3341. "204": {
  3342. "$ref": "#/responses/empty"
  3343. },
  3344. "404": {
  3345. "$ref": "#/responses/notFound"
  3346. }
  3347. }
  3348. },
  3349. "patch": {
  3350. "produces": [
  3351. "application/json"
  3352. ],
  3353. "tags": [
  3354. "repository"
  3355. ],
  3356. "summary": "Edit a hook in a repository",
  3357. "operationId": "repoEditHook",
  3358. "parameters": [
  3359. {
  3360. "type": "string",
  3361. "description": "owner of the repo",
  3362. "name": "owner",
  3363. "in": "path",
  3364. "required": true
  3365. },
  3366. {
  3367. "type": "string",
  3368. "description": "name of the repo",
  3369. "name": "repo",
  3370. "in": "path",
  3371. "required": true
  3372. },
  3373. {
  3374. "type": "integer",
  3375. "format": "int64",
  3376. "description": "index of the hook",
  3377. "name": "id",
  3378. "in": "path",
  3379. "required": true
  3380. },
  3381. {
  3382. "name": "body",
  3383. "in": "body",
  3384. "schema": {
  3385. "$ref": "#/definitions/EditHookOption"
  3386. }
  3387. }
  3388. ],
  3389. "responses": {
  3390. "200": {
  3391. "$ref": "#/responses/Hook"
  3392. }
  3393. }
  3394. }
  3395. },
  3396. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3397. "post": {
  3398. "produces": [
  3399. "application/json"
  3400. ],
  3401. "tags": [
  3402. "repository"
  3403. ],
  3404. "summary": "Test a push webhook",
  3405. "operationId": "repoTestHook",
  3406. "parameters": [
  3407. {
  3408. "type": "string",
  3409. "description": "owner of the repo",
  3410. "name": "owner",
  3411. "in": "path",
  3412. "required": true
  3413. },
  3414. {
  3415. "type": "string",
  3416. "description": "name of the repo",
  3417. "name": "repo",
  3418. "in": "path",
  3419. "required": true
  3420. },
  3421. {
  3422. "type": "integer",
  3423. "format": "int64",
  3424. "description": "id of the hook to test",
  3425. "name": "id",
  3426. "in": "path",
  3427. "required": true
  3428. }
  3429. ],
  3430. "responses": {
  3431. "204": {
  3432. "$ref": "#/responses/empty"
  3433. }
  3434. }
  3435. }
  3436. },
  3437. "/repos/{owner}/{repo}/issues": {
  3438. "get": {
  3439. "produces": [
  3440. "application/json"
  3441. ],
  3442. "tags": [
  3443. "issue"
  3444. ],
  3445. "summary": "List a repository's issues",
  3446. "operationId": "issueListIssues",
  3447. "parameters": [
  3448. {
  3449. "type": "string",
  3450. "description": "owner of the repo",
  3451. "name": "owner",
  3452. "in": "path",
  3453. "required": true
  3454. },
  3455. {
  3456. "type": "string",
  3457. "description": "name of the repo",
  3458. "name": "repo",
  3459. "in": "path",
  3460. "required": true
  3461. },
  3462. {
  3463. "type": "string",
  3464. "description": "whether issue is open or closed",
  3465. "name": "state",
  3466. "in": "query"
  3467. },
  3468. {
  3469. "type": "string",
  3470. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3471. "name": "labels",
  3472. "in": "query"
  3473. },
  3474. {
  3475. "type": "string",
  3476. "description": "search string",
  3477. "name": "q",
  3478. "in": "query"
  3479. },
  3480. {
  3481. "type": "string",
  3482. "description": "filter by type (issues / pulls) if set",
  3483. "name": "type",
  3484. "in": "query"
  3485. },
  3486. {
  3487. "type": "integer",
  3488. "description": "page number of results to return (1-based)",
  3489. "name": "page",
  3490. "in": "query"
  3491. },
  3492. {
  3493. "type": "integer",
  3494. "description": "page size of results, maximum page size is 50",
  3495. "name": "limit",
  3496. "in": "query"
  3497. }
  3498. ],
  3499. "responses": {
  3500. "200": {
  3501. "$ref": "#/responses/IssueList"
  3502. }
  3503. }
  3504. },
  3505. "post": {
  3506. "consumes": [
  3507. "application/json"
  3508. ],
  3509. "produces": [
  3510. "application/json"
  3511. ],
  3512. "tags": [
  3513. "issue"
  3514. ],
  3515. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3516. "operationId": "issueCreateIssue",
  3517. "parameters": [
  3518. {
  3519. "type": "string",
  3520. "description": "owner of the repo",
  3521. "name": "owner",
  3522. "in": "path",
  3523. "required": true
  3524. },
  3525. {
  3526. "type": "string",
  3527. "description": "name of the repo",
  3528. "name": "repo",
  3529. "in": "path",
  3530. "required": true
  3531. },
  3532. {
  3533. "name": "body",
  3534. "in": "body",
  3535. "schema": {
  3536. "$ref": "#/definitions/CreateIssueOption"
  3537. }
  3538. }
  3539. ],
  3540. "responses": {
  3541. "201": {
  3542. "$ref": "#/responses/Issue"
  3543. },
  3544. "403": {
  3545. "$ref": "#/responses/forbidden"
  3546. },
  3547. "412": {
  3548. "$ref": "#/responses/error"
  3549. },
  3550. "422": {
  3551. "$ref": "#/responses/validationError"
  3552. }
  3553. }
  3554. }
  3555. },
  3556. "/repos/{owner}/{repo}/issues/comments": {
  3557. "get": {
  3558. "produces": [
  3559. "application/json"
  3560. ],
  3561. "tags": [
  3562. "issue"
  3563. ],
  3564. "summary": "List all comments in a repository",
  3565. "operationId": "issueGetRepoComments",
  3566. "parameters": [
  3567. {
  3568. "type": "string",
  3569. "description": "owner of the repo",
  3570. "name": "owner",
  3571. "in": "path",
  3572. "required": true
  3573. },
  3574. {
  3575. "type": "string",
  3576. "description": "name of the repo",
  3577. "name": "repo",
  3578. "in": "path",
  3579. "required": true
  3580. },
  3581. {
  3582. "type": "string",
  3583. "format": "date-time",
  3584. "description": "if provided, only comments updated since the provided time are returned.",
  3585. "name": "since",
  3586. "in": "query"
  3587. },
  3588. {
  3589. "type": "string",
  3590. "format": "date-time",
  3591. "description": "if provided, only comments updated before the provided time are returned.",
  3592. "name": "before",
  3593. "in": "query"
  3594. },
  3595. {
  3596. "type": "integer",
  3597. "description": "page number of results to return (1-based)",
  3598. "name": "page",
  3599. "in": "query"
  3600. },
  3601. {
  3602. "type": "integer",
  3603. "description": "page size of results, maximum page size is 50",
  3604. "name": "limit",
  3605. "in": "query"
  3606. }
  3607. ],
  3608. "responses": {
  3609. "200": {
  3610. "$ref": "#/responses/CommentList"
  3611. }
  3612. }
  3613. }
  3614. },
  3615. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3616. "get": {
  3617. "consumes": [
  3618. "application/json"
  3619. ],
  3620. "produces": [
  3621. "application/json"
  3622. ],
  3623. "tags": [
  3624. "issue"
  3625. ],
  3626. "summary": "Get a comment",
  3627. "operationId": "issueGetComment",
  3628. "parameters": [
  3629. {
  3630. "type": "string",
  3631. "description": "owner of the repo",
  3632. "name": "owner",
  3633. "in": "path",
  3634. "required": true
  3635. },
  3636. {
  3637. "type": "string",
  3638. "description": "name of the repo",
  3639. "name": "repo",
  3640. "in": "path",
  3641. "required": true
  3642. },
  3643. {
  3644. "type": "integer",
  3645. "format": "int64",
  3646. "description": "id of the comment",
  3647. "name": "id",
  3648. "in": "path",
  3649. "required": true
  3650. }
  3651. ],
  3652. "responses": {
  3653. "200": {
  3654. "$ref": "#/responses/Comment"
  3655. },
  3656. "204": {
  3657. "$ref": "#/responses/empty"
  3658. },
  3659. "403": {
  3660. "$ref": "#/responses/forbidden"
  3661. },
  3662. "404": {
  3663. "$ref": "#/responses/notFound"
  3664. }
  3665. }
  3666. },
  3667. "delete": {
  3668. "tags": [
  3669. "issue"
  3670. ],
  3671. "summary": "Delete a comment",
  3672. "operationId": "issueDeleteComment",
  3673. "parameters": [
  3674. {
  3675. "type": "string",
  3676. "description": "owner of the repo",
  3677. "name": "owner",
  3678. "in": "path",
  3679. "required": true
  3680. },
  3681. {
  3682. "type": "string",
  3683. "description": "name of the repo",
  3684. "name": "repo",
  3685. "in": "path",
  3686. "required": true
  3687. },
  3688. {
  3689. "type": "integer",
  3690. "format": "int64",
  3691. "description": "id of comment to delete",
  3692. "name": "id",
  3693. "in": "path",
  3694. "required": true
  3695. }
  3696. ],
  3697. "responses": {
  3698. "204": {
  3699. "$ref": "#/responses/empty"
  3700. },
  3701. "403": {
  3702. "$ref": "#/responses/forbidden"
  3703. },
  3704. "404": {
  3705. "$ref": "#/responses/notFound"
  3706. }
  3707. }
  3708. },
  3709. "patch": {
  3710. "consumes": [
  3711. "application/json"
  3712. ],
  3713. "produces": [
  3714. "application/json"
  3715. ],
  3716. "tags": [
  3717. "issue"
  3718. ],
  3719. "summary": "Edit a comment",
  3720. "operationId": "issueEditComment",
  3721. "parameters": [
  3722. {
  3723. "type": "string",
  3724. "description": "owner of the repo",
  3725. "name": "owner",
  3726. "in": "path",
  3727. "required": true
  3728. },
  3729. {
  3730. "type": "string",
  3731. "description": "name of the repo",
  3732. "name": "repo",
  3733. "in": "path",
  3734. "required": true
  3735. },
  3736. {
  3737. "type": "integer",
  3738. "format": "int64",
  3739. "description": "id of the comment to edit",
  3740. "name": "id",
  3741. "in": "path",
  3742. "required": true
  3743. },
  3744. {
  3745. "name": "body",
  3746. "in": "body",
  3747. "schema": {
  3748. "$ref": "#/definitions/EditIssueCommentOption"
  3749. }
  3750. }
  3751. ],
  3752. "responses": {
  3753. "200": {
  3754. "$ref": "#/responses/Comment"
  3755. },
  3756. "204": {
  3757. "$ref": "#/responses/empty"
  3758. },
  3759. "403": {
  3760. "$ref": "#/responses/forbidden"
  3761. },
  3762. "404": {
  3763. "$ref": "#/responses/notFound"
  3764. }
  3765. }
  3766. }
  3767. },
  3768. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  3769. "get": {
  3770. "consumes": [
  3771. "application/json"
  3772. ],
  3773. "produces": [
  3774. "application/json"
  3775. ],
  3776. "tags": [
  3777. "issue"
  3778. ],
  3779. "summary": "Get a list of reactions from a comment of an issue",
  3780. "operationId": "issueGetCommentReactions",
  3781. "parameters": [
  3782. {
  3783. "type": "string",
  3784. "description": "owner of the repo",
  3785. "name": "owner",
  3786. "in": "path",
  3787. "required": true
  3788. },
  3789. {
  3790. "type": "string",
  3791. "description": "name of the repo",
  3792. "name": "repo",
  3793. "in": "path",
  3794. "required": true
  3795. },
  3796. {
  3797. "type": "integer",
  3798. "format": "int64",
  3799. "description": "id of the comment to edit",
  3800. "name": "id",
  3801. "in": "path",
  3802. "required": true
  3803. }
  3804. ],
  3805. "responses": {
  3806. "200": {
  3807. "$ref": "#/responses/ReactionList"
  3808. },
  3809. "403": {
  3810. "$ref": "#/responses/forbidden"
  3811. }
  3812. }
  3813. },
  3814. "post": {
  3815. "consumes": [
  3816. "application/json"
  3817. ],
  3818. "produces": [
  3819. "application/json"
  3820. ],
  3821. "tags": [
  3822. "issue"
  3823. ],
  3824. "summary": "Add a reaction to a comment of an issue",
  3825. "operationId": "issuePostCommentReaction",
  3826. "parameters": [
  3827. {
  3828. "type": "string",
  3829. "description": "owner of the repo",
  3830. "name": "owner",
  3831. "in": "path",
  3832. "required": true
  3833. },
  3834. {
  3835. "type": "string",
  3836. "description": "name of the repo",
  3837. "name": "repo",
  3838. "in": "path",
  3839. "required": true
  3840. },
  3841. {
  3842. "type": "integer",
  3843. "format": "int64",
  3844. "description": "id of the comment to edit",
  3845. "name": "id",
  3846. "in": "path",
  3847. "required": true
  3848. },
  3849. {
  3850. "name": "content",
  3851. "in": "body",
  3852. "schema": {
  3853. "$ref": "#/definitions/EditReactionOption"
  3854. }
  3855. }
  3856. ],
  3857. "responses": {
  3858. "200": {
  3859. "$ref": "#/responses/Reaction"
  3860. },
  3861. "201": {
  3862. "$ref": "#/responses/Reaction"
  3863. },
  3864. "403": {
  3865. "$ref": "#/responses/forbidden"
  3866. }
  3867. }
  3868. },
  3869. "delete": {
  3870. "consumes": [
  3871. "application/json"
  3872. ],
  3873. "produces": [
  3874. "application/json"
  3875. ],
  3876. "tags": [
  3877. "issue"
  3878. ],
  3879. "summary": "Remove a reaction from a comment of an issue",
  3880. "operationId": "issueDeleteCommentReaction",
  3881. "parameters": [
  3882. {
  3883. "type": "string",
  3884. "description": "owner of the repo",
  3885. "name": "owner",
  3886. "in": "path",
  3887. "required": true
  3888. },
  3889. {
  3890. "type": "string",
  3891. "description": "name of the repo",
  3892. "name": "repo",
  3893. "in": "path",
  3894. "required": true
  3895. },
  3896. {
  3897. "type": "integer",
  3898. "format": "int64",
  3899. "description": "id of the comment to edit",
  3900. "name": "id",
  3901. "in": "path",
  3902. "required": true
  3903. },
  3904. {
  3905. "name": "content",
  3906. "in": "body",
  3907. "schema": {
  3908. "$ref": "#/definitions/EditReactionOption"
  3909. }
  3910. }
  3911. ],
  3912. "responses": {
  3913. "200": {
  3914. "$ref": "#/responses/empty"
  3915. },
  3916. "403": {
  3917. "$ref": "#/responses/forbidden"
  3918. }
  3919. }
  3920. }
  3921. },
  3922. "/repos/{owner}/{repo}/issues/{index}": {
  3923. "get": {
  3924. "produces": [
  3925. "application/json"
  3926. ],
  3927. "tags": [
  3928. "issue"
  3929. ],
  3930. "summary": "Get an issue",
  3931. "operationId": "issueGetIssue",
  3932. "parameters": [
  3933. {
  3934. "type": "string",
  3935. "description": "owner of the repo",
  3936. "name": "owner",
  3937. "in": "path",
  3938. "required": true
  3939. },
  3940. {
  3941. "type": "string",
  3942. "description": "name of the repo",
  3943. "name": "repo",
  3944. "in": "path",
  3945. "required": true
  3946. },
  3947. {
  3948. "type": "integer",
  3949. "format": "int64",
  3950. "description": "index of the issue to get",
  3951. "name": "index",
  3952. "in": "path",
  3953. "required": true
  3954. }
  3955. ],
  3956. "responses": {
  3957. "200": {
  3958. "$ref": "#/responses/Issue"
  3959. },
  3960. "404": {
  3961. "$ref": "#/responses/notFound"
  3962. }
  3963. }
  3964. },
  3965. "patch": {
  3966. "consumes": [
  3967. "application/json"
  3968. ],
  3969. "produces": [
  3970. "application/json"
  3971. ],
  3972. "tags": [
  3973. "issue"
  3974. ],
  3975. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3976. "operationId": "issueEditIssue",
  3977. "parameters": [
  3978. {
  3979. "type": "string",
  3980. "description": "owner of the repo",
  3981. "name": "owner",
  3982. "in": "path",
  3983. "required": true
  3984. },
  3985. {
  3986. "type": "string",
  3987. "description": "name of the repo",
  3988. "name": "repo",
  3989. "in": "path",
  3990. "required": true
  3991. },
  3992. {
  3993. "type": "integer",
  3994. "format": "int64",
  3995. "description": "index of the issue to edit",
  3996. "name": "index",
  3997. "in": "path",
  3998. "required": true
  3999. },
  4000. {
  4001. "name": "body",
  4002. "in": "body",
  4003. "schema": {
  4004. "$ref": "#/definitions/EditIssueOption"
  4005. }
  4006. }
  4007. ],
  4008. "responses": {
  4009. "201": {
  4010. "$ref": "#/responses/Issue"
  4011. },
  4012. "403": {
  4013. "$ref": "#/responses/forbidden"
  4014. },
  4015. "404": {
  4016. "$ref": "#/responses/notFound"
  4017. },
  4018. "412": {
  4019. "$ref": "#/responses/error"
  4020. }
  4021. }
  4022. }
  4023. },
  4024. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4025. "get": {
  4026. "produces": [
  4027. "application/json"
  4028. ],
  4029. "tags": [
  4030. "issue"
  4031. ],
  4032. "summary": "List all comments on an issue",
  4033. "operationId": "issueGetComments",
  4034. "parameters": [
  4035. {
  4036. "type": "string",
  4037. "description": "owner of the repo",
  4038. "name": "owner",
  4039. "in": "path",
  4040. "required": true
  4041. },
  4042. {
  4043. "type": "string",
  4044. "description": "name of the repo",
  4045. "name": "repo",
  4046. "in": "path",
  4047. "required": true
  4048. },
  4049. {
  4050. "type": "integer",
  4051. "format": "int64",
  4052. "description": "index of the issue",
  4053. "name": "index",
  4054. "in": "path",
  4055. "required": true
  4056. },
  4057. {
  4058. "type": "string",
  4059. "format": "date-time",
  4060. "description": "if provided, only comments updated since the specified time are returned.",
  4061. "name": "since",
  4062. "in": "query"
  4063. },
  4064. {
  4065. "type": "string",
  4066. "format": "date-time",
  4067. "description": "if provided, only comments updated before the provided time are returned.",
  4068. "name": "before",
  4069. "in": "query"
  4070. }
  4071. ],
  4072. "responses": {
  4073. "200": {
  4074. "$ref": "#/responses/CommentList"
  4075. }
  4076. }
  4077. },
  4078. "post": {
  4079. "consumes": [
  4080. "application/json"
  4081. ],
  4082. "produces": [
  4083. "application/json"
  4084. ],
  4085. "tags": [
  4086. "issue"
  4087. ],
  4088. "summary": "Add a comment to an issue",
  4089. "operationId": "issueCreateComment",
  4090. "parameters": [
  4091. {
  4092. "type": "string",
  4093. "description": "owner of the repo",
  4094. "name": "owner",
  4095. "in": "path",
  4096. "required": true
  4097. },
  4098. {
  4099. "type": "string",
  4100. "description": "name of the repo",
  4101. "name": "repo",
  4102. "in": "path",
  4103. "required": true
  4104. },
  4105. {
  4106. "type": "integer",
  4107. "format": "int64",
  4108. "description": "index of the issue",
  4109. "name": "index",
  4110. "in": "path",
  4111. "required": true
  4112. },
  4113. {
  4114. "name": "body",
  4115. "in": "body",
  4116. "schema": {
  4117. "$ref": "#/definitions/CreateIssueCommentOption"
  4118. }
  4119. }
  4120. ],
  4121. "responses": {
  4122. "201": {
  4123. "$ref": "#/responses/Comment"
  4124. },
  4125. "403": {
  4126. "$ref": "#/responses/forbidden"
  4127. }
  4128. }
  4129. }
  4130. },
  4131. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  4132. "delete": {
  4133. "tags": [
  4134. "issue"
  4135. ],
  4136. "summary": "Delete a comment",
  4137. "operationId": "issueDeleteCommentDeprecated",
  4138. "deprecated": true,
  4139. "parameters": [
  4140. {
  4141. "type": "string",
  4142. "description": "owner of the repo",
  4143. "name": "owner",
  4144. "in": "path",
  4145. "required": true
  4146. },
  4147. {
  4148. "type": "string",
  4149. "description": "name of the repo",
  4150. "name": "repo",
  4151. "in": "path",
  4152. "required": true
  4153. },
  4154. {
  4155. "type": "integer",
  4156. "description": "this parameter is ignored",
  4157. "name": "index",
  4158. "in": "path",
  4159. "required": true
  4160. },
  4161. {
  4162. "type": "integer",
  4163. "format": "int64",
  4164. "description": "id of comment to delete",
  4165. "name": "id",
  4166. "in": "path",
  4167. "required": true
  4168. }
  4169. ],
  4170. "responses": {
  4171. "204": {
  4172. "$ref": "#/responses/empty"
  4173. },
  4174. "403": {
  4175. "$ref": "#/responses/forbidden"
  4176. },
  4177. "404": {
  4178. "$ref": "#/responses/notFound"
  4179. }
  4180. }
  4181. },
  4182. "patch": {
  4183. "consumes": [
  4184. "application/json"
  4185. ],
  4186. "produces": [
  4187. "application/json"
  4188. ],
  4189. "tags": [
  4190. "issue"
  4191. ],
  4192. "summary": "Edit a comment",
  4193. "operationId": "issueEditCommentDeprecated",
  4194. "deprecated": true,
  4195. "parameters": [
  4196. {
  4197. "type": "string",
  4198. "description": "owner of the repo",
  4199. "name": "owner",
  4200. "in": "path",
  4201. "required": true
  4202. },
  4203. {
  4204. "type": "string",
  4205. "description": "name of the repo",
  4206. "name": "repo",
  4207. "in": "path",
  4208. "required": true
  4209. },
  4210. {
  4211. "type": "integer",
  4212. "description": "this parameter is ignored",
  4213. "name": "index",
  4214. "in": "path",
  4215. "required": true
  4216. },
  4217. {
  4218. "type": "integer",
  4219. "format": "int64",
  4220. "description": "id of the comment to edit",
  4221. "name": "id",
  4222. "in": "path",
  4223. "required": true
  4224. },
  4225. {
  4226. "name": "body",
  4227. "in": "body",
  4228. "schema": {
  4229. "$ref": "#/definitions/EditIssueCommentOption"
  4230. }
  4231. }
  4232. ],
  4233. "responses": {
  4234. "200": {
  4235. "$ref": "#/responses/Comment"
  4236. },
  4237. "204": {
  4238. "$ref": "#/responses/empty"
  4239. },
  4240. "403": {
  4241. "$ref": "#/responses/forbidden"
  4242. },
  4243. "404": {
  4244. "$ref": "#/responses/notFound"
  4245. }
  4246. }
  4247. }
  4248. },
  4249. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4250. "post": {
  4251. "consumes": [
  4252. "application/json"
  4253. ],
  4254. "produces": [
  4255. "application/json"
  4256. ],
  4257. "tags": [
  4258. "issue"
  4259. ],
  4260. "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.",
  4261. "operationId": "issueEditIssueDeadline",
  4262. "parameters": [
  4263. {
  4264. "type": "string",
  4265. "description": "owner of the repo",
  4266. "name": "owner",
  4267. "in": "path",
  4268. "required": true
  4269. },
  4270. {
  4271. "type": "string",
  4272. "description": "name of the repo",
  4273. "name": "repo",
  4274. "in": "path",
  4275. "required": true
  4276. },
  4277. {
  4278. "type": "integer",
  4279. "format": "int64",
  4280. "description": "index of the issue to create or update a deadline on",
  4281. "name": "index",
  4282. "in": "path",
  4283. "required": true
  4284. },
  4285. {
  4286. "name": "body",
  4287. "in": "body",
  4288. "schema": {
  4289. "$ref": "#/definitions/EditDeadlineOption"
  4290. }
  4291. }
  4292. ],
  4293. "responses": {
  4294. "201": {
  4295. "$ref": "#/responses/IssueDeadline"
  4296. },
  4297. "403": {
  4298. "$ref": "#/responses/forbidden"
  4299. },
  4300. "404": {
  4301. "$ref": "#/responses/notFound"
  4302. }
  4303. }
  4304. }
  4305. },
  4306. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4307. "get": {
  4308. "produces": [
  4309. "application/json"
  4310. ],
  4311. "tags": [
  4312. "issue"
  4313. ],
  4314. "summary": "Get an issue's labels",
  4315. "operationId": "issueGetLabels",
  4316. "parameters": [
  4317. {
  4318. "type": "string",
  4319. "description": "owner of the repo",
  4320. "name": "owner",
  4321. "in": "path",
  4322. "required": true
  4323. },
  4324. {
  4325. "type": "string",
  4326. "description": "name of the repo",
  4327. "name": "repo",
  4328. "in": "path",
  4329. "required": true
  4330. },
  4331. {
  4332. "type": "integer",
  4333. "format": "int64",
  4334. "description": "index of the issue",
  4335. "name": "index",
  4336. "in": "path",
  4337. "required": true
  4338. }
  4339. ],
  4340. "responses": {
  4341. "200": {
  4342. "$ref": "#/responses/LabelList"
  4343. },
  4344. "404": {
  4345. "$ref": "#/responses/notFound"
  4346. }
  4347. }
  4348. },
  4349. "put": {
  4350. "consumes": [
  4351. "application/json"
  4352. ],
  4353. "produces": [
  4354. "application/json"
  4355. ],
  4356. "tags": [
  4357. "issue"
  4358. ],
  4359. "summary": "Replace an issue's labels",
  4360. "operationId": "issueReplaceLabels",
  4361. "parameters": [
  4362. {
  4363. "type": "string",
  4364. "description": "owner of the repo",
  4365. "name": "owner",
  4366. "in": "path",
  4367. "required": true
  4368. },
  4369. {
  4370. "type": "string",
  4371. "description": "name of the repo",
  4372. "name": "repo",
  4373. "in": "path",
  4374. "required": true
  4375. },
  4376. {
  4377. "type": "integer",
  4378. "format": "int64",
  4379. "description": "index of the issue",
  4380. "name": "index",
  4381. "in": "path",
  4382. "required": true
  4383. },
  4384. {
  4385. "name": "body",
  4386. "in": "body",
  4387. "schema": {
  4388. "$ref": "#/definitions/IssueLabelsOption"
  4389. }
  4390. }
  4391. ],
  4392. "responses": {
  4393. "200": {
  4394. "$ref": "#/responses/LabelList"
  4395. },
  4396. "403": {
  4397. "$ref": "#/responses/forbidden"
  4398. }
  4399. }
  4400. },
  4401. "post": {
  4402. "consumes": [
  4403. "application/json"
  4404. ],
  4405. "produces": [
  4406. "application/json"
  4407. ],
  4408. "tags": [
  4409. "issue"
  4410. ],
  4411. "summary": "Add a label to an issue",
  4412. "operationId": "issueAddLabel",
  4413. "parameters": [
  4414. {
  4415. "type": "string",
  4416. "description": "owner of the repo",
  4417. "name": "owner",
  4418. "in": "path",
  4419. "required": true
  4420. },
  4421. {
  4422. "type": "string",
  4423. "description": "name of the repo",
  4424. "name": "repo",
  4425. "in": "path",
  4426. "required": true
  4427. },
  4428. {
  4429. "type": "integer",
  4430. "format": "int64",
  4431. "description": "index of the issue",
  4432. "name": "index",
  4433. "in": "path",
  4434. "required": true
  4435. },
  4436. {
  4437. "name": "body",
  4438. "in": "body",
  4439. "schema": {
  4440. "$ref": "#/definitions/IssueLabelsOption"
  4441. }
  4442. }
  4443. ],
  4444. "responses": {
  4445. "200": {
  4446. "$ref": "#/responses/LabelList"
  4447. },
  4448. "403": {
  4449. "$ref": "#/responses/forbidden"
  4450. }
  4451. }
  4452. },
  4453. "delete": {
  4454. "produces": [
  4455. "application/json"
  4456. ],
  4457. "tags": [
  4458. "issue"
  4459. ],
  4460. "summary": "Remove all labels from an issue",
  4461. "operationId": "issueClearLabels",
  4462. "parameters": [
  4463. {
  4464. "type": "string",
  4465. "description": "owner of the repo",
  4466. "name": "owner",
  4467. "in": "path",
  4468. "required": true
  4469. },
  4470. {
  4471. "type": "string",
  4472. "description": "name of the repo",
  4473. "name": "repo",
  4474. "in": "path",
  4475. "required": true
  4476. },
  4477. {
  4478. "type": "integer",
  4479. "format": "int64",
  4480. "description": "index of the issue",
  4481. "name": "index",
  4482. "in": "path",
  4483. "required": true
  4484. }
  4485. ],
  4486. "responses": {
  4487. "204": {
  4488. "$ref": "#/responses/empty"
  4489. },
  4490. "403": {
  4491. "$ref": "#/responses/forbidden"
  4492. }
  4493. }
  4494. }
  4495. },
  4496. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4497. "delete": {
  4498. "produces": [
  4499. "application/json"
  4500. ],
  4501. "tags": [
  4502. "issue"
  4503. ],
  4504. "summary": "Remove a label from an issue",
  4505. "operationId": "issueRemoveLabel",
  4506. "parameters": [
  4507. {
  4508. "type": "string",
  4509. "description": "owner of the repo",
  4510. "name": "owner",
  4511. "in": "path",
  4512. "required": true
  4513. },
  4514. {
  4515. "type": "string",
  4516. "description": "name of the repo",
  4517. "name": "repo",
  4518. "in": "path",
  4519. "required": true
  4520. },
  4521. {
  4522. "type": "integer",
  4523. "format": "int64",
  4524. "description": "index of the issue",
  4525. "name": "index",
  4526. "in": "path",
  4527. "required": true
  4528. },
  4529. {
  4530. "type": "integer",
  4531. "format": "int64",
  4532. "description": "id of the label to remove",
  4533. "name": "id",
  4534. "in": "path",
  4535. "required": true
  4536. }
  4537. ],
  4538. "responses": {
  4539. "204": {
  4540. "$ref": "#/responses/empty"
  4541. },
  4542. "403": {
  4543. "$ref": "#/responses/forbidden"
  4544. },
  4545. "422": {
  4546. "$ref": "#/responses/validationError"
  4547. }
  4548. }
  4549. }
  4550. },
  4551. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4552. "get": {
  4553. "consumes": [
  4554. "application/json"
  4555. ],
  4556. "produces": [
  4557. "application/json"
  4558. ],
  4559. "tags": [
  4560. "issue"
  4561. ],
  4562. "summary": "Get a list reactions of an issue",
  4563. "operationId": "issueGetIssueReactions",
  4564. "parameters": [
  4565. {
  4566. "type": "string",
  4567. "description": "owner of the repo",
  4568. "name": "owner",
  4569. "in": "path",
  4570. "required": true
  4571. },
  4572. {
  4573. "type": "string",
  4574. "description": "name of the repo",
  4575. "name": "repo",
  4576. "in": "path",
  4577. "required": true
  4578. },
  4579. {
  4580. "type": "integer",
  4581. "format": "int64",
  4582. "description": "index of the issue",
  4583. "name": "index",
  4584. "in": "path",
  4585. "required": true
  4586. },
  4587. {
  4588. "type": "integer",
  4589. "description": "page number of results to return (1-based)",
  4590. "name": "page",
  4591. "in": "query"
  4592. },
  4593. {
  4594. "type": "integer",
  4595. "description": "page size of results, maximum page size is 50",
  4596. "name": "limit",
  4597. "in": "query"
  4598. }
  4599. ],
  4600. "responses": {
  4601. "200": {
  4602. "$ref": "#/responses/ReactionList"
  4603. },
  4604. "403": {
  4605. "$ref": "#/responses/forbidden"
  4606. }
  4607. }
  4608. },
  4609. "post": {
  4610. "consumes": [
  4611. "application/json"
  4612. ],
  4613. "produces": [
  4614. "application/json"
  4615. ],
  4616. "tags": [
  4617. "issue"
  4618. ],
  4619. "summary": "Add a reaction to an issue",
  4620. "operationId": "issuePostIssueReaction",
  4621. "parameters": [
  4622. {
  4623. "type": "string",
  4624. "description": "owner of the repo",
  4625. "name": "owner",
  4626. "in": "path",
  4627. "required": true
  4628. },
  4629. {
  4630. "type": "string",
  4631. "description": "name of the repo",
  4632. "name": "repo",
  4633. "in": "path",
  4634. "required": true
  4635. },
  4636. {
  4637. "type": "integer",
  4638. "format": "int64",
  4639. "description": "index of the issue",
  4640. "name": "index",
  4641. "in": "path",
  4642. "required": true
  4643. },
  4644. {
  4645. "name": "content",
  4646. "in": "body",
  4647. "schema": {
  4648. "$ref": "#/definitions/EditReactionOption"
  4649. }
  4650. }
  4651. ],
  4652. "responses": {
  4653. "200": {
  4654. "$ref": "#/responses/Reaction"
  4655. },
  4656. "201": {
  4657. "$ref": "#/responses/Reaction"
  4658. },
  4659. "403": {
  4660. "$ref": "#/responses/forbidden"
  4661. }
  4662. }
  4663. },
  4664. "delete": {
  4665. "consumes": [
  4666. "application/json"
  4667. ],
  4668. "produces": [
  4669. "application/json"
  4670. ],
  4671. "tags": [
  4672. "issue"
  4673. ],
  4674. "summary": "Remove a reaction from an issue",
  4675. "operationId": "issueDeleteIssueReaction",
  4676. "parameters": [
  4677. {
  4678. "type": "string",
  4679. "description": "owner of the repo",
  4680. "name": "owner",
  4681. "in": "path",
  4682. "required": true
  4683. },
  4684. {
  4685. "type": "string",
  4686. "description": "name of the repo",
  4687. "name": "repo",
  4688. "in": "path",
  4689. "required": true
  4690. },
  4691. {
  4692. "type": "integer",
  4693. "format": "int64",
  4694. "description": "index of the issue",
  4695. "name": "index",
  4696. "in": "path",
  4697. "required": true
  4698. },
  4699. {
  4700. "name": "content",
  4701. "in": "body",
  4702. "schema": {
  4703. "$ref": "#/definitions/EditReactionOption"
  4704. }
  4705. }
  4706. ],
  4707. "responses": {
  4708. "200": {
  4709. "$ref": "#/responses/empty"
  4710. },
  4711. "403": {
  4712. "$ref": "#/responses/forbidden"
  4713. }
  4714. }
  4715. }
  4716. },
  4717. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4718. "delete": {
  4719. "consumes": [
  4720. "application/json"
  4721. ],
  4722. "produces": [
  4723. "application/json"
  4724. ],
  4725. "tags": [
  4726. "issue"
  4727. ],
  4728. "summary": "Delete an issue's existing stopwatch.",
  4729. "operationId": "issueDeleteStopWatch",
  4730. "parameters": [
  4731. {
  4732. "type": "string",
  4733. "description": "owner of the repo",
  4734. "name": "owner",
  4735. "in": "path",
  4736. "required": true
  4737. },
  4738. {
  4739. "type": "string",
  4740. "description": "name of the repo",
  4741. "name": "repo",
  4742. "in": "path",
  4743. "required": true
  4744. },
  4745. {
  4746. "type": "integer",
  4747. "format": "int64",
  4748. "description": "index of the issue to stop the stopwatch on",
  4749. "name": "index",
  4750. "in": "path",
  4751. "required": true
  4752. }
  4753. ],
  4754. "responses": {
  4755. "204": {
  4756. "$ref": "#/responses/empty"
  4757. },
  4758. "403": {
  4759. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4760. },
  4761. "404": {
  4762. "$ref": "#/responses/notFound"
  4763. },
  4764. "409": {
  4765. "description": "Cannot cancel a non existent stopwatch"
  4766. }
  4767. }
  4768. }
  4769. },
  4770. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  4771. "post": {
  4772. "consumes": [
  4773. "application/json"
  4774. ],
  4775. "produces": [
  4776. "application/json"
  4777. ],
  4778. "tags": [
  4779. "issue"
  4780. ],
  4781. "summary": "Start stopwatch on an issue.",
  4782. "operationId": "issueStartStopWatch",
  4783. "parameters": [
  4784. {
  4785. "type": "string",
  4786. "description": "owner of the repo",
  4787. "name": "owner",
  4788. "in": "path",
  4789. "required": true
  4790. },
  4791. {
  4792. "type": "string",
  4793. "description": "name of the repo",
  4794. "name": "repo",
  4795. "in": "path",
  4796. "required": true
  4797. },
  4798. {
  4799. "type": "integer",
  4800. "format": "int64",
  4801. "description": "index of the issue to create the stopwatch on",
  4802. "name": "index",
  4803. "in": "path",
  4804. "required": true
  4805. }
  4806. ],
  4807. "responses": {
  4808. "201": {
  4809. "$ref": "#/responses/empty"
  4810. },
  4811. "403": {
  4812. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4813. },
  4814. "404": {
  4815. "$ref": "#/responses/notFound"
  4816. },
  4817. "409": {
  4818. "description": "Cannot start a stopwatch again if it already exists"
  4819. }
  4820. }
  4821. }
  4822. },
  4823. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  4824. "post": {
  4825. "consumes": [
  4826. "application/json"
  4827. ],
  4828. "produces": [
  4829. "application/json"
  4830. ],
  4831. "tags": [
  4832. "issue"
  4833. ],
  4834. "summary": "Stop an issue's existing stopwatch.",
  4835. "operationId": "issueStopStopWatch",
  4836. "parameters": [
  4837. {
  4838. "type": "string",
  4839. "description": "owner of the repo",
  4840. "name": "owner",
  4841. "in": "path",
  4842. "required": true
  4843. },
  4844. {
  4845. "type": "string",
  4846. "description": "name of the repo",
  4847. "name": "repo",
  4848. "in": "path",
  4849. "required": true
  4850. },
  4851. {
  4852. "type": "integer",
  4853. "format": "int64",
  4854. "description": "index of the issue to stop the stopwatch on",
  4855. "name": "index",
  4856. "in": "path",
  4857. "required": true
  4858. }
  4859. ],
  4860. "responses": {
  4861. "201": {
  4862. "$ref": "#/responses/empty"
  4863. },
  4864. "403": {
  4865. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4866. },
  4867. "404": {
  4868. "$ref": "#/responses/notFound"
  4869. },
  4870. "409": {
  4871. "description": "Cannot stop a non existent stopwatch"
  4872. }
  4873. }
  4874. }
  4875. },
  4876. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  4877. "get": {
  4878. "consumes": [
  4879. "application/json"
  4880. ],
  4881. "produces": [
  4882. "application/json"
  4883. ],
  4884. "tags": [
  4885. "issue"
  4886. ],
  4887. "summary": "Get users who subscribed on an issue.",
  4888. "operationId": "issueSubscriptions",
  4889. "parameters": [
  4890. {
  4891. "type": "string",
  4892. "description": "owner of the repo",
  4893. "name": "owner",
  4894. "in": "path",
  4895. "required": true
  4896. },
  4897. {
  4898. "type": "string",
  4899. "description": "name of the repo",
  4900. "name": "repo",
  4901. "in": "path",
  4902. "required": true
  4903. },
  4904. {
  4905. "type": "integer",
  4906. "format": "int64",
  4907. "description": "index of the issue",
  4908. "name": "index",
  4909. "in": "path",
  4910. "required": true
  4911. },
  4912. {
  4913. "type": "integer",
  4914. "description": "page number of results to return (1-based)",
  4915. "name": "page",
  4916. "in": "query"
  4917. },
  4918. {
  4919. "type": "integer",
  4920. "description": "page size of results, maximum page size is 50",
  4921. "name": "limit",
  4922. "in": "query"
  4923. }
  4924. ],
  4925. "responses": {
  4926. "200": {
  4927. "$ref": "#/responses/UserList"
  4928. },
  4929. "404": {
  4930. "$ref": "#/responses/notFound"
  4931. }
  4932. }
  4933. }
  4934. },
  4935. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  4936. "put": {
  4937. "consumes": [
  4938. "application/json"
  4939. ],
  4940. "produces": [
  4941. "application/json"
  4942. ],
  4943. "tags": [
  4944. "issue"
  4945. ],
  4946. "summary": "Subscribe user to issue",
  4947. "operationId": "issueAddSubscription",
  4948. "parameters": [
  4949. {
  4950. "type": "string",
  4951. "description": "owner of the repo",
  4952. "name": "owner",
  4953. "in": "path",
  4954. "required": true
  4955. },
  4956. {
  4957. "type": "string",
  4958. "description": "name of the repo",
  4959. "name": "repo",
  4960. "in": "path",
  4961. "required": true
  4962. },
  4963. {
  4964. "type": "integer",
  4965. "format": "int64",
  4966. "description": "index of the issue",
  4967. "name": "index",
  4968. "in": "path",
  4969. "required": true
  4970. },
  4971. {
  4972. "type": "string",
  4973. "description": "user to subscribe",
  4974. "name": "user",
  4975. "in": "path",
  4976. "required": true
  4977. }
  4978. ],
  4979. "responses": {
  4980. "201": {
  4981. "$ref": "#/responses/empty"
  4982. },
  4983. "304": {
  4984. "description": "User can only subscribe itself if he is no admin"
  4985. },
  4986. "404": {
  4987. "$ref": "#/responses/notFound"
  4988. }
  4989. }
  4990. },
  4991. "delete": {
  4992. "consumes": [
  4993. "application/json"
  4994. ],
  4995. "produces": [
  4996. "application/json"
  4997. ],
  4998. "tags": [
  4999. "issue"
  5000. ],
  5001. "summary": "Unsubscribe user from issue",
  5002. "operationId": "issueDeleteSubscription",
  5003. "parameters": [
  5004. {
  5005. "type": "string",
  5006. "description": "owner of the repo",
  5007. "name": "owner",
  5008. "in": "path",
  5009. "required": true
  5010. },
  5011. {
  5012. "type": "string",
  5013. "description": "name of the repo",
  5014. "name": "repo",
  5015. "in": "path",
  5016. "required": true
  5017. },
  5018. {
  5019. "type": "integer",
  5020. "format": "int64",
  5021. "description": "index of the issue",
  5022. "name": "index",
  5023. "in": "path",
  5024. "required": true
  5025. },
  5026. {
  5027. "type": "string",
  5028. "description": "user witch unsubscribe",
  5029. "name": "user",
  5030. "in": "path",
  5031. "required": true
  5032. }
  5033. ],
  5034. "responses": {
  5035. "201": {
  5036. "$ref": "#/responses/empty"
  5037. },
  5038. "304": {
  5039. "description": "User can only subscribe itself if he is no admin"
  5040. },
  5041. "404": {
  5042. "$ref": "#/responses/notFound"
  5043. }
  5044. }
  5045. }
  5046. },
  5047. "/repos/{owner}/{repo}/issues/{index}/times": {
  5048. "get": {
  5049. "produces": [
  5050. "application/json"
  5051. ],
  5052. "tags": [
  5053. "issue"
  5054. ],
  5055. "summary": "List an issue's tracked times",
  5056. "operationId": "issueTrackedTimes",
  5057. "parameters": [
  5058. {
  5059. "type": "string",
  5060. "description": "owner of the repo",
  5061. "name": "owner",
  5062. "in": "path",
  5063. "required": true
  5064. },
  5065. {
  5066. "type": "string",
  5067. "description": "name of the repo",
  5068. "name": "repo",
  5069. "in": "path",
  5070. "required": true
  5071. },
  5072. {
  5073. "type": "integer",
  5074. "format": "int64",
  5075. "description": "index of the issue",
  5076. "name": "index",
  5077. "in": "path",
  5078. "required": true
  5079. },
  5080. {
  5081. "type": "string",
  5082. "format": "date-time",
  5083. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  5084. "name": "since",
  5085. "in": "query"
  5086. },
  5087. {
  5088. "type": "string",
  5089. "format": "date-time",
  5090. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  5091. "name": "before",
  5092. "in": "query"
  5093. },
  5094. {
  5095. "type": "integer",
  5096. "description": "page number of results to return (1-based)",
  5097. "name": "page",
  5098. "in": "query"
  5099. },
  5100. {
  5101. "type": "integer",
  5102. "description": "page size of results, maximum page size is 50",
  5103. "name": "limit",
  5104. "in": "query"
  5105. }
  5106. ],
  5107. "responses": {
  5108. "200": {
  5109. "$ref": "#/responses/TrackedTimeList"
  5110. },
  5111. "404": {
  5112. "$ref": "#/responses/notFound"
  5113. }
  5114. }
  5115. },
  5116. "post": {
  5117. "consumes": [
  5118. "application/json"
  5119. ],
  5120. "produces": [
  5121. "application/json"
  5122. ],
  5123. "tags": [
  5124. "issue"
  5125. ],
  5126. "summary": "Add tracked time to a issue",
  5127. "operationId": "issueAddTime",
  5128. "parameters": [
  5129. {
  5130. "type": "string",
  5131. "description": "owner of the repo",
  5132. "name": "owner",
  5133. "in": "path",
  5134. "required": true
  5135. },
  5136. {
  5137. "type": "string",
  5138. "description": "name of the repo",
  5139. "name": "repo",
  5140. "in": "path",
  5141. "required": true
  5142. },
  5143. {
  5144. "type": "integer",
  5145. "format": "int64",
  5146. "description": "index of the issue",
  5147. "name": "index",
  5148. "in": "path",
  5149. "required": true
  5150. },
  5151. {
  5152. "name": "body",
  5153. "in": "body",
  5154. "schema": {
  5155. "$ref": "#/definitions/AddTimeOption"
  5156. }
  5157. }
  5158. ],
  5159. "responses": {
  5160. "200": {
  5161. "$ref": "#/responses/TrackedTime"
  5162. },
  5163. "400": {
  5164. "$ref": "#/responses/error"
  5165. },
  5166. "403": {
  5167. "$ref": "#/responses/forbidden"
  5168. }
  5169. }
  5170. },
  5171. "delete": {
  5172. "consumes": [
  5173. "application/json"
  5174. ],
  5175. "produces": [
  5176. "application/json"
  5177. ],
  5178. "tags": [
  5179. "issue"
  5180. ],
  5181. "summary": "Reset a tracked time of an issue",
  5182. "operationId": "issueResetTime",
  5183. "parameters": [
  5184. {
  5185. "type": "string",
  5186. "description": "owner of the repo",
  5187. "name": "owner",
  5188. "in": "path",
  5189. "required": true
  5190. },
  5191. {
  5192. "type": "string",
  5193. "description": "name of the repo",
  5194. "name": "repo",
  5195. "in": "path",
  5196. "required": true
  5197. },
  5198. {
  5199. "type": "integer",
  5200. "format": "int64",
  5201. "description": "index of the issue to add tracked time to",
  5202. "name": "index",
  5203. "in": "path",
  5204. "required": true
  5205. }
  5206. ],
  5207. "responses": {
  5208. "204": {
  5209. "$ref": "#/responses/empty"
  5210. },
  5211. "400": {
  5212. "$ref": "#/responses/error"
  5213. },
  5214. "403": {
  5215. "$ref": "#/responses/forbidden"
  5216. }
  5217. }
  5218. }
  5219. },
  5220. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5221. "delete": {
  5222. "consumes": [
  5223. "application/json"
  5224. ],
  5225. "produces": [
  5226. "application/json"
  5227. ],
  5228. "tags": [
  5229. "issue"
  5230. ],
  5231. "summary": "Delete specific tracked time",
  5232. "operationId": "issueDeleteTime",
  5233. "parameters": [
  5234. {
  5235. "type": "string",
  5236. "description": "owner of the repo",
  5237. "name": "owner",
  5238. "in": "path",
  5239. "required": true
  5240. },
  5241. {
  5242. "type": "string",
  5243. "description": "name of the repo",
  5244. "name": "repo",
  5245. "in": "path",
  5246. "required": true
  5247. },
  5248. {
  5249. "type": "integer",
  5250. "format": "int64",
  5251. "description": "index of the issue",
  5252. "name": "index",
  5253. "in": "path",
  5254. "required": true
  5255. },
  5256. {
  5257. "type": "integer",
  5258. "format": "int64",
  5259. "description": "id of time to delete",
  5260. "name": "id",
  5261. "in": "path",
  5262. "required": true
  5263. }
  5264. ],
  5265. "responses": {
  5266. "204": {
  5267. "$ref": "#/responses/empty"
  5268. },
  5269. "400": {
  5270. "$ref": "#/responses/error"
  5271. },
  5272. "403": {
  5273. "$ref": "#/responses/forbidden"
  5274. }
  5275. }
  5276. }
  5277. },
  5278. "/repos/{owner}/{repo}/keys": {
  5279. "get": {
  5280. "produces": [
  5281. "application/json"
  5282. ],
  5283. "tags": [
  5284. "repository"
  5285. ],
  5286. "summary": "List a repository's keys",
  5287. "operationId": "repoListKeys",
  5288. "parameters": [
  5289. {
  5290. "type": "string",
  5291. "description": "owner of the repo",
  5292. "name": "owner",
  5293. "in": "path",
  5294. "required": true
  5295. },
  5296. {
  5297. "type": "string",
  5298. "description": "name of the repo",
  5299. "name": "repo",
  5300. "in": "path",
  5301. "required": true
  5302. },
  5303. {
  5304. "type": "integer",
  5305. "description": "the key_id to search for",
  5306. "name": "key_id",
  5307. "in": "query"
  5308. },
  5309. {
  5310. "type": "string",
  5311. "description": "fingerprint of the key",
  5312. "name": "fingerprint",
  5313. "in": "query"
  5314. },
  5315. {
  5316. "type": "integer",
  5317. "description": "page number of results to return (1-based)",
  5318. "name": "page",
  5319. "in": "query"
  5320. },
  5321. {
  5322. "type": "integer",
  5323. "description": "page size of results, maximum page size is 50",
  5324. "name": "limit",
  5325. "in": "query"
  5326. }
  5327. ],
  5328. "responses": {
  5329. "200": {
  5330. "$ref": "#/responses/DeployKeyList"
  5331. }
  5332. }
  5333. },
  5334. "post": {
  5335. "consumes": [
  5336. "application/json"
  5337. ],
  5338. "produces": [
  5339. "application/json"
  5340. ],
  5341. "tags": [
  5342. "repository"
  5343. ],
  5344. "summary": "Add a key to a repository",
  5345. "operationId": "repoCreateKey",
  5346. "parameters": [
  5347. {
  5348. "type": "string",
  5349. "description": "owner of the repo",
  5350. "name": "owner",
  5351. "in": "path",
  5352. "required": true
  5353. },
  5354. {
  5355. "type": "string",
  5356. "description": "name of the repo",
  5357. "name": "repo",
  5358. "in": "path",
  5359. "required": true
  5360. },
  5361. {
  5362. "name": "body",
  5363. "in": "body",
  5364. "schema": {
  5365. "$ref": "#/definitions/CreateKeyOption"
  5366. }
  5367. }
  5368. ],
  5369. "responses": {
  5370. "201": {
  5371. "$ref": "#/responses/DeployKey"
  5372. },
  5373. "422": {
  5374. "$ref": "#/responses/validationError"
  5375. }
  5376. }
  5377. }
  5378. },
  5379. "/repos/{owner}/{repo}/keys/{id}": {
  5380. "get": {
  5381. "produces": [
  5382. "application/json"
  5383. ],
  5384. "tags": [
  5385. "repository"
  5386. ],
  5387. "summary": "Get a repository's key by id",
  5388. "operationId": "repoGetKey",
  5389. "parameters": [
  5390. {
  5391. "type": "string",
  5392. "description": "owner of the repo",
  5393. "name": "owner",
  5394. "in": "path",
  5395. "required": true
  5396. },
  5397. {
  5398. "type": "string",
  5399. "description": "name of the repo",
  5400. "name": "repo",
  5401. "in": "path",
  5402. "required": true
  5403. },
  5404. {
  5405. "type": "integer",
  5406. "format": "int64",
  5407. "description": "id of the key to get",
  5408. "name": "id",
  5409. "in": "path",
  5410. "required": true
  5411. }
  5412. ],
  5413. "responses": {
  5414. "200": {
  5415. "$ref": "#/responses/DeployKey"
  5416. }
  5417. }
  5418. },
  5419. "delete": {
  5420. "tags": [
  5421. "repository"
  5422. ],
  5423. "summary": "Delete a key from a repository",
  5424. "operationId": "repoDeleteKey",
  5425. "parameters": [
  5426. {
  5427. "type": "string",
  5428. "description": "owner of the repo",
  5429. "name": "owner",
  5430. "in": "path",
  5431. "required": true
  5432. },
  5433. {
  5434. "type": "string",
  5435. "description": "name of the repo",
  5436. "name": "repo",
  5437. "in": "path",
  5438. "required": true
  5439. },
  5440. {
  5441. "type": "integer",
  5442. "format": "int64",
  5443. "description": "id of the key to delete",
  5444. "name": "id",
  5445. "in": "path",
  5446. "required": true
  5447. }
  5448. ],
  5449. "responses": {
  5450. "204": {
  5451. "$ref": "#/responses/empty"
  5452. },
  5453. "403": {
  5454. "$ref": "#/responses/forbidden"
  5455. }
  5456. }
  5457. }
  5458. },
  5459. "/repos/{owner}/{repo}/labels": {
  5460. "get": {
  5461. "produces": [
  5462. "application/json"
  5463. ],
  5464. "tags": [
  5465. "issue"
  5466. ],
  5467. "summary": "Get all of a repository's labels",
  5468. "operationId": "issueListLabels",
  5469. "parameters": [
  5470. {
  5471. "type": "string",
  5472. "description": "owner of the repo",
  5473. "name": "owner",
  5474. "in": "path",
  5475. "required": true
  5476. },
  5477. {
  5478. "type": "string",
  5479. "description": "name of the repo",
  5480. "name": "repo",
  5481. "in": "path",
  5482. "required": true
  5483. },
  5484. {
  5485. "type": "integer",
  5486. "description": "page number of results to return (1-based)",
  5487. "name": "page",
  5488. "in": "query"
  5489. },
  5490. {
  5491. "type": "integer",
  5492. "description": "page size of results, maximum page size is 50",
  5493. "name": "limit",
  5494. "in": "query"
  5495. }
  5496. ],
  5497. "responses": {
  5498. "200": {
  5499. "$ref": "#/responses/LabelList"
  5500. }
  5501. }
  5502. },
  5503. "post": {
  5504. "consumes": [
  5505. "application/json"
  5506. ],
  5507. "produces": [
  5508. "application/json"
  5509. ],
  5510. "tags": [
  5511. "issue"
  5512. ],
  5513. "summary": "Create a label",
  5514. "operationId": "issueCreateLabel",
  5515. "parameters": [
  5516. {
  5517. "type": "string",
  5518. "description": "owner of the repo",
  5519. "name": "owner",
  5520. "in": "path",
  5521. "required": true
  5522. },
  5523. {
  5524. "type": "string",
  5525. "description": "name of the repo",
  5526. "name": "repo",
  5527. "in": "path",
  5528. "required": true
  5529. },
  5530. {
  5531. "name": "body",
  5532. "in": "body",
  5533. "schema": {
  5534. "$ref": "#/definitions/CreateLabelOption"
  5535. }
  5536. }
  5537. ],
  5538. "responses": {
  5539. "201": {
  5540. "$ref": "#/responses/Label"
  5541. },
  5542. "422": {
  5543. "$ref": "#/responses/validationError"
  5544. }
  5545. }
  5546. }
  5547. },
  5548. "/repos/{owner}/{repo}/labels/{id}": {
  5549. "get": {
  5550. "produces": [
  5551. "application/json"
  5552. ],
  5553. "tags": [
  5554. "issue"
  5555. ],
  5556. "summary": "Get a single label",
  5557. "operationId": "issueGetLabel",
  5558. "parameters": [
  5559. {
  5560. "type": "string",
  5561. "description": "owner of the repo",
  5562. "name": "owner",
  5563. "in": "path",
  5564. "required": true
  5565. },
  5566. {
  5567. "type": "string",
  5568. "description": "name of the repo",
  5569. "name": "repo",
  5570. "in": "path",
  5571. "required": true
  5572. },
  5573. {
  5574. "type": "integer",
  5575. "format": "int64",
  5576. "description": "id of the label to get",
  5577. "name": "id",
  5578. "in": "path",
  5579. "required": true
  5580. }
  5581. ],
  5582. "responses": {
  5583. "200": {
  5584. "$ref": "#/responses/Label"
  5585. }
  5586. }
  5587. },
  5588. "delete": {
  5589. "tags": [
  5590. "issue"
  5591. ],
  5592. "summary": "Delete a label",
  5593. "operationId": "issueDeleteLabel",
  5594. "parameters": [
  5595. {
  5596. "type": "string",
  5597. "description": "owner of the repo",
  5598. "name": "owner",
  5599. "in": "path",
  5600. "required": true
  5601. },
  5602. {
  5603. "type": "string",
  5604. "description": "name of the repo",
  5605. "name": "repo",
  5606. "in": "path",
  5607. "required": true
  5608. },
  5609. {
  5610. "type": "integer",
  5611. "format": "int64",
  5612. "description": "id of the label to delete",
  5613. "name": "id",
  5614. "in": "path",
  5615. "required": true
  5616. }
  5617. ],
  5618. "responses": {
  5619. "204": {
  5620. "$ref": "#/responses/empty"
  5621. }
  5622. }
  5623. },
  5624. "patch": {
  5625. "consumes": [
  5626. "application/json"
  5627. ],
  5628. "produces": [
  5629. "application/json"
  5630. ],
  5631. "tags": [
  5632. "issue"
  5633. ],
  5634. "summary": "Update a label",
  5635. "operationId": "issueEditLabel",
  5636. "parameters": [
  5637. {
  5638. "type": "string",
  5639. "description": "owner of the repo",
  5640. "name": "owner",
  5641. "in": "path",
  5642. "required": true
  5643. },
  5644. {
  5645. "type": "string",
  5646. "description": "name of the repo",
  5647. "name": "repo",
  5648. "in": "path",
  5649. "required": true
  5650. },
  5651. {
  5652. "type": "integer",
  5653. "format": "int64",
  5654. "description": "id of the label to edit",
  5655. "name": "id",
  5656. "in": "path",
  5657. "required": true
  5658. },
  5659. {
  5660. "name": "body",
  5661. "in": "body",
  5662. "schema": {
  5663. "$ref": "#/definitions/EditLabelOption"
  5664. }
  5665. }
  5666. ],
  5667. "responses": {
  5668. "200": {
  5669. "$ref": "#/responses/Label"
  5670. },
  5671. "422": {
  5672. "$ref": "#/responses/validationError"
  5673. }
  5674. }
  5675. }
  5676. },
  5677. "/repos/{owner}/{repo}/milestones": {
  5678. "get": {
  5679. "produces": [
  5680. "application/json"
  5681. ],
  5682. "tags": [
  5683. "issue"
  5684. ],
  5685. "summary": "Get all of a repository's opened milestones",
  5686. "operationId": "issueGetMilestonesList",
  5687. "parameters": [
  5688. {
  5689. "type": "string",
  5690. "description": "owner of the repo",
  5691. "name": "owner",
  5692. "in": "path",
  5693. "required": true
  5694. },
  5695. {
  5696. "type": "string",
  5697. "description": "name of the repo",
  5698. "name": "repo",
  5699. "in": "path",
  5700. "required": true
  5701. },
  5702. {
  5703. "type": "string",
  5704. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  5705. "name": "state",
  5706. "in": "query"
  5707. },
  5708. {
  5709. "type": "integer",
  5710. "description": "page number of results to return (1-based)",
  5711. "name": "page",
  5712. "in": "query"
  5713. },
  5714. {
  5715. "type": "integer",
  5716. "description": "page size of results, maximum page size is 50",
  5717. "name": "limit",
  5718. "in": "query"
  5719. }
  5720. ],
  5721. "responses": {
  5722. "200": {
  5723. "$ref": "#/responses/MilestoneList"
  5724. }
  5725. }
  5726. },
  5727. "post": {
  5728. "consumes": [
  5729. "application/json"
  5730. ],
  5731. "produces": [
  5732. "application/json"
  5733. ],
  5734. "tags": [
  5735. "issue"
  5736. ],
  5737. "summary": "Create a milestone",
  5738. "operationId": "issueCreateMilestone",
  5739. "parameters": [
  5740. {
  5741. "type": "string",
  5742. "description": "owner of the repo",
  5743. "name": "owner",
  5744. "in": "path",
  5745. "required": true
  5746. },
  5747. {
  5748. "type": "string",
  5749. "description": "name of the repo",
  5750. "name": "repo",
  5751. "in": "path",
  5752. "required": true
  5753. },
  5754. {
  5755. "name": "body",
  5756. "in": "body",
  5757. "schema": {
  5758. "$ref": "#/definitions/CreateMilestoneOption"
  5759. }
  5760. }
  5761. ],
  5762. "responses": {
  5763. "201": {
  5764. "$ref": "#/responses/Milestone"
  5765. }
  5766. }
  5767. }
  5768. },
  5769. "/repos/{owner}/{repo}/milestones/{id}": {
  5770. "get": {
  5771. "produces": [
  5772. "application/json"
  5773. ],
  5774. "tags": [
  5775. "issue"
  5776. ],
  5777. "summary": "Get a milestone",
  5778. "operationId": "issueGetMilestone",
  5779. "parameters": [
  5780. {
  5781. "type": "string",
  5782. "description": "owner of the repo",
  5783. "name": "owner",
  5784. "in": "path",
  5785. "required": true
  5786. },
  5787. {
  5788. "type": "string",
  5789. "description": "name of the repo",
  5790. "name": "repo",
  5791. "in": "path",
  5792. "required": true
  5793. },
  5794. {
  5795. "type": "integer",
  5796. "format": "int64",
  5797. "description": "id of the milestone",
  5798. "name": "id",
  5799. "in": "path",
  5800. "required": true
  5801. }
  5802. ],
  5803. "responses": {
  5804. "200": {
  5805. "$ref": "#/responses/Milestone"
  5806. }
  5807. }
  5808. },
  5809. "delete": {
  5810. "tags": [
  5811. "issue"
  5812. ],
  5813. "summary": "Delete a milestone",
  5814. "operationId": "issueDeleteMilestone",
  5815. "parameters": [
  5816. {
  5817. "type": "string",
  5818. "description": "owner of the repo",
  5819. "name": "owner",
  5820. "in": "path",
  5821. "required": true
  5822. },
  5823. {
  5824. "type": "string",
  5825. "description": "name of the repo",
  5826. "name": "repo",
  5827. "in": "path",
  5828. "required": true
  5829. },
  5830. {
  5831. "type": "integer",
  5832. "format": "int64",
  5833. "description": "id of the milestone to delete",
  5834. "name": "id",
  5835. "in": "path",
  5836. "required": true
  5837. }
  5838. ],
  5839. "responses": {
  5840. "204": {
  5841. "$ref": "#/responses/empty"
  5842. }
  5843. }
  5844. },
  5845. "patch": {
  5846. "consumes": [
  5847. "application/json"
  5848. ],
  5849. "produces": [
  5850. "application/json"
  5851. ],
  5852. "tags": [
  5853. "issue"
  5854. ],
  5855. "summary": "Update a milestone",
  5856. "operationId": "issueEditMilestone",
  5857. "parameters": [
  5858. {
  5859. "type": "string",
  5860. "description": "owner of the repo",
  5861. "name": "owner",
  5862. "in": "path",
  5863. "required": true
  5864. },
  5865. {
  5866. "type": "string",
  5867. "description": "name of the repo",
  5868. "name": "repo",
  5869. "in": "path",
  5870. "required": true
  5871. },
  5872. {
  5873. "type": "integer",
  5874. "format": "int64",
  5875. "description": "id of the milestone",
  5876. "name": "id",
  5877. "in": "path",
  5878. "required": true
  5879. },
  5880. {
  5881. "name": "body",
  5882. "in": "body",
  5883. "schema": {
  5884. "$ref": "#/definitions/EditMilestoneOption"
  5885. }
  5886. }
  5887. ],
  5888. "responses": {
  5889. "200": {
  5890. "$ref": "#/responses/Milestone"
  5891. }
  5892. }
  5893. }
  5894. },
  5895. "/repos/{owner}/{repo}/mirror-sync": {
  5896. "post": {
  5897. "produces": [
  5898. "application/json"
  5899. ],
  5900. "tags": [
  5901. "repository"
  5902. ],
  5903. "summary": "Sync a mirrored repository",
  5904. "operationId": "repoMirrorSync",
  5905. "parameters": [
  5906. {
  5907. "type": "string",
  5908. "description": "owner of the repo to sync",
  5909. "name": "owner",
  5910. "in": "path",
  5911. "required": true
  5912. },
  5913. {
  5914. "type": "string",
  5915. "description": "name of the repo to sync",
  5916. "name": "repo",
  5917. "in": "path",
  5918. "required": true
  5919. }
  5920. ],
  5921. "responses": {
  5922. "200": {
  5923. "$ref": "#/responses/empty"
  5924. },
  5925. "403": {
  5926. "$ref": "#/responses/forbidden"
  5927. }
  5928. }
  5929. }
  5930. },
  5931. "/repos/{owner}/{repo}/notifications": {
  5932. "get": {
  5933. "consumes": [
  5934. "application/json"
  5935. ],
  5936. "produces": [
  5937. "application/json"
  5938. ],
  5939. "tags": [
  5940. "notification"
  5941. ],
  5942. "summary": "List users's notification threads on a specific repo",
  5943. "operationId": "notifyGetRepoList",
  5944. "parameters": [
  5945. {
  5946. "type": "string",
  5947. "description": "owner of the repo",
  5948. "name": "owner",
  5949. "in": "path",
  5950. "required": true
  5951. },
  5952. {
  5953. "type": "string",
  5954. "description": "name of the repo",
  5955. "name": "repo",
  5956. "in": "path",
  5957. "required": true
  5958. },
  5959. {
  5960. "type": "string",
  5961. "description": "If true, show notifications marked as read. Default value is false",
  5962. "name": "all",
  5963. "in": "query"
  5964. },
  5965. {
  5966. "type": "string",
  5967. "format": "date-time",
  5968. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  5969. "name": "since",
  5970. "in": "query"
  5971. },
  5972. {
  5973. "type": "string",
  5974. "format": "date-time",
  5975. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  5976. "name": "before",
  5977. "in": "query"
  5978. },
  5979. {
  5980. "type": "integer",
  5981. "description": "page number of results to return (1-based)",
  5982. "name": "page",
  5983. "in": "query"
  5984. },
  5985. {
  5986. "type": "integer",
  5987. "description": "page size of results, maximum page size is 50",
  5988. "name": "limit",
  5989. "in": "query"
  5990. }
  5991. ],
  5992. "responses": {
  5993. "200": {
  5994. "$ref": "#/responses/NotificationThreadList"
  5995. }
  5996. }
  5997. },
  5998. "put": {
  5999. "consumes": [
  6000. "application/json"
  6001. ],
  6002. "produces": [
  6003. "application/json"
  6004. ],
  6005. "tags": [
  6006. "notification"
  6007. ],
  6008. "summary": "Mark notification threads as read on a specific repo",
  6009. "operationId": "notifyReadRepoList",
  6010. "parameters": [
  6011. {
  6012. "type": "string",
  6013. "description": "owner of the repo",
  6014. "name": "owner",
  6015. "in": "path",
  6016. "required": true
  6017. },
  6018. {
  6019. "type": "string",
  6020. "description": "name of the repo",
  6021. "name": "repo",
  6022. "in": "path",
  6023. "required": true
  6024. },
  6025. {
  6026. "type": "string",
  6027. "format": "date-time",
  6028. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  6029. "name": "last_read_at",
  6030. "in": "query"
  6031. }
  6032. ],
  6033. "responses": {
  6034. "205": {
  6035. "$ref": "#/responses/empty"
  6036. }
  6037. }
  6038. }
  6039. },
  6040. "/repos/{owner}/{repo}/pulls": {
  6041. "get": {
  6042. "produces": [
  6043. "application/json"
  6044. ],
  6045. "tags": [
  6046. "repository"
  6047. ],
  6048. "summary": "List a repo's pull requests",
  6049. "operationId": "repoListPullRequests",
  6050. "parameters": [
  6051. {
  6052. "type": "string",
  6053. "description": "owner of the repo",
  6054. "name": "owner",
  6055. "in": "path",
  6056. "required": true
  6057. },
  6058. {
  6059. "type": "string",
  6060. "description": "name of the repo",
  6061. "name": "repo",
  6062. "in": "path",
  6063. "required": true
  6064. },
  6065. {
  6066. "enum": [
  6067. "closed",
  6068. "open",
  6069. "all"
  6070. ],
  6071. "type": "string",
  6072. "description": "State of pull request: open or closed (optional)",
  6073. "name": "state",
  6074. "in": "query"
  6075. },
  6076. {
  6077. "enum": [
  6078. "oldest",
  6079. "recentupdate",
  6080. "leastupdate",
  6081. "mostcomment",
  6082. "leastcomment",
  6083. "priority"
  6084. ],
  6085. "type": "string",
  6086. "description": "Type of sort",
  6087. "name": "sort",
  6088. "in": "query"
  6089. },
  6090. {
  6091. "type": "integer",
  6092. "format": "int64",
  6093. "description": "ID of the milestone",
  6094. "name": "milestone",
  6095. "in": "query"
  6096. },
  6097. {
  6098. "type": "array",
  6099. "items": {
  6100. "type": "integer",
  6101. "format": "int64"
  6102. },
  6103. "collectionFormat": "multi",
  6104. "description": "Label IDs",
  6105. "name": "labels",
  6106. "in": "query"
  6107. },
  6108. {
  6109. "type": "integer",
  6110. "description": "page number of results to return (1-based)",
  6111. "name": "page",
  6112. "in": "query"
  6113. },
  6114. {
  6115. "type": "integer",
  6116. "description": "page size of results, maximum page size is 50",
  6117. "name": "limit",
  6118. "in": "query"
  6119. }
  6120. ],
  6121. "responses": {
  6122. "200": {
  6123. "$ref": "#/responses/PullRequestList"
  6124. }
  6125. }
  6126. },
  6127. "post": {
  6128. "consumes": [
  6129. "application/json"
  6130. ],
  6131. "produces": [
  6132. "application/json"
  6133. ],
  6134. "tags": [
  6135. "repository"
  6136. ],
  6137. "summary": "Create a pull request",
  6138. "operationId": "repoCreatePullRequest",
  6139. "parameters": [
  6140. {
  6141. "type": "string",
  6142. "description": "owner of the repo",
  6143. "name": "owner",
  6144. "in": "path",
  6145. "required": true
  6146. },
  6147. {
  6148. "type": "string",
  6149. "description": "name of the repo",
  6150. "name": "repo",
  6151. "in": "path",
  6152. "required": true
  6153. },
  6154. {
  6155. "name": "body",
  6156. "in": "body",
  6157. "schema": {
  6158. "$ref": "#/definitions/CreatePullRequestOption"
  6159. }
  6160. }
  6161. ],
  6162. "responses": {
  6163. "201": {
  6164. "$ref": "#/responses/PullRequest"
  6165. },
  6166. "409": {
  6167. "$ref": "#/responses/error"
  6168. },
  6169. "422": {
  6170. "$ref": "#/responses/validationError"
  6171. }
  6172. }
  6173. }
  6174. },
  6175. "/repos/{owner}/{repo}/pulls/{index}": {
  6176. "get": {
  6177. "produces": [
  6178. "application/json"
  6179. ],
  6180. "tags": [
  6181. "repository"
  6182. ],
  6183. "summary": "Get a pull request",
  6184. "operationId": "repoGetPullRequest",
  6185. "parameters": [
  6186. {
  6187. "type": "string",
  6188. "description": "owner of the repo",
  6189. "name": "owner",
  6190. "in": "path",
  6191. "required": true
  6192. },
  6193. {
  6194. "type": "string",
  6195. "description": "name of the repo",
  6196. "name": "repo",
  6197. "in": "path",
  6198. "required": true
  6199. },
  6200. {
  6201. "type": "integer",
  6202. "format": "int64",
  6203. "description": "index of the pull request to get",
  6204. "name": "index",
  6205. "in": "path",
  6206. "required": true
  6207. }
  6208. ],
  6209. "responses": {
  6210. "200": {
  6211. "$ref": "#/responses/PullRequest"
  6212. },
  6213. "404": {
  6214. "$ref": "#/responses/notFound"
  6215. }
  6216. }
  6217. },
  6218. "patch": {
  6219. "consumes": [
  6220. "application/json"
  6221. ],
  6222. "produces": [
  6223. "application/json"
  6224. ],
  6225. "tags": [
  6226. "repository"
  6227. ],
  6228. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6229. "operationId": "repoEditPullRequest",
  6230. "parameters": [
  6231. {
  6232. "type": "string",
  6233. "description": "owner of the repo",
  6234. "name": "owner",
  6235. "in": "path",
  6236. "required": true
  6237. },
  6238. {
  6239. "type": "string",
  6240. "description": "name of the repo",
  6241. "name": "repo",
  6242. "in": "path",
  6243. "required": true
  6244. },
  6245. {
  6246. "type": "integer",
  6247. "format": "int64",
  6248. "description": "index of the pull request to edit",
  6249. "name": "index",
  6250. "in": "path",
  6251. "required": true
  6252. },
  6253. {
  6254. "name": "body",
  6255. "in": "body",
  6256. "schema": {
  6257. "$ref": "#/definitions/EditPullRequestOption"
  6258. }
  6259. }
  6260. ],
  6261. "responses": {
  6262. "201": {
  6263. "$ref": "#/responses/PullRequest"
  6264. },
  6265. "403": {
  6266. "$ref": "#/responses/forbidden"
  6267. },
  6268. "412": {
  6269. "$ref": "#/responses/error"
  6270. },
  6271. "422": {
  6272. "$ref": "#/responses/validationError"
  6273. }
  6274. }
  6275. }
  6276. },
  6277. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6278. "get": {
  6279. "produces": [
  6280. "application/json"
  6281. ],
  6282. "tags": [
  6283. "repository"
  6284. ],
  6285. "summary": "Check if a pull request has been merged",
  6286. "operationId": "repoPullRequestIsMerged",
  6287. "parameters": [
  6288. {
  6289. "type": "string",
  6290. "description": "owner of the repo",
  6291. "name": "owner",
  6292. "in": "path",
  6293. "required": true
  6294. },
  6295. {
  6296. "type": "string",
  6297. "description": "name of the repo",
  6298. "name": "repo",
  6299. "in": "path",
  6300. "required": true
  6301. },
  6302. {
  6303. "type": "integer",
  6304. "format": "int64",
  6305. "description": "index of the pull request",
  6306. "name": "index",
  6307. "in": "path",
  6308. "required": true
  6309. }
  6310. ],
  6311. "responses": {
  6312. "204": {
  6313. "description": "pull request has been merged"
  6314. },
  6315. "404": {
  6316. "description": "pull request has not been merged"
  6317. }
  6318. }
  6319. },
  6320. "post": {
  6321. "produces": [
  6322. "application/json"
  6323. ],
  6324. "tags": [
  6325. "repository"
  6326. ],
  6327. "summary": "Merge a pull request",
  6328. "operationId": "repoMergePullRequest",
  6329. "parameters": [
  6330. {
  6331. "type": "string",
  6332. "description": "owner of the repo",
  6333. "name": "owner",
  6334. "in": "path",
  6335. "required": true
  6336. },
  6337. {
  6338. "type": "string",
  6339. "description": "name of the repo",
  6340. "name": "repo",
  6341. "in": "path",
  6342. "required": true
  6343. },
  6344. {
  6345. "type": "integer",
  6346. "format": "int64",
  6347. "description": "index of the pull request to merge",
  6348. "name": "index",
  6349. "in": "path",
  6350. "required": true
  6351. },
  6352. {
  6353. "name": "body",
  6354. "in": "body",
  6355. "schema": {
  6356. "$ref": "#/definitions/MergePullRequestOption"
  6357. }
  6358. }
  6359. ],
  6360. "responses": {
  6361. "200": {
  6362. "$ref": "#/responses/empty"
  6363. },
  6364. "405": {
  6365. "$ref": "#/responses/empty"
  6366. },
  6367. "409": {
  6368. "$ref": "#/responses/error"
  6369. }
  6370. }
  6371. }
  6372. },
  6373. "/repos/{owner}/{repo}/raw/{filepath}": {
  6374. "get": {
  6375. "produces": [
  6376. "application/json"
  6377. ],
  6378. "tags": [
  6379. "repository"
  6380. ],
  6381. "summary": "Get a file from a repository",
  6382. "operationId": "repoGetRawFile",
  6383. "parameters": [
  6384. {
  6385. "type": "string",
  6386. "description": "owner of the repo",
  6387. "name": "owner",
  6388. "in": "path",
  6389. "required": true
  6390. },
  6391. {
  6392. "type": "string",
  6393. "description": "name of the repo",
  6394. "name": "repo",
  6395. "in": "path",
  6396. "required": true
  6397. },
  6398. {
  6399. "type": "string",
  6400. "description": "filepath of the file to get",
  6401. "name": "filepath",
  6402. "in": "path",
  6403. "required": true
  6404. }
  6405. ],
  6406. "responses": {
  6407. "200": {
  6408. "description": "success"
  6409. },
  6410. "404": {
  6411. "$ref": "#/responses/notFound"
  6412. }
  6413. }
  6414. }
  6415. },
  6416. "/repos/{owner}/{repo}/releases": {
  6417. "get": {
  6418. "produces": [
  6419. "application/json"
  6420. ],
  6421. "tags": [
  6422. "repository"
  6423. ],
  6424. "summary": "List a repo's releases",
  6425. "operationId": "repoListReleases",
  6426. "parameters": [
  6427. {
  6428. "type": "string",
  6429. "description": "owner of the repo",
  6430. "name": "owner",
  6431. "in": "path",
  6432. "required": true
  6433. },
  6434. {
  6435. "type": "string",
  6436. "description": "name of the repo",
  6437. "name": "repo",
  6438. "in": "path",
  6439. "required": true
  6440. },
  6441. {
  6442. "type": "integer",
  6443. "description": "items count every page wants to load",
  6444. "name": "per_page",
  6445. "in": "query"
  6446. },
  6447. {
  6448. "type": "integer",
  6449. "description": "page number of results to return (1-based)",
  6450. "name": "page",
  6451. "in": "query"
  6452. },
  6453. {
  6454. "type": "integer",
  6455. "description": "page size of results, maximum page size is 50",
  6456. "name": "limit",
  6457. "in": "query"
  6458. }
  6459. ],
  6460. "responses": {
  6461. "200": {
  6462. "$ref": "#/responses/ReleaseList"
  6463. }
  6464. }
  6465. },
  6466. "post": {
  6467. "consumes": [
  6468. "application/json"
  6469. ],
  6470. "produces": [
  6471. "application/json"
  6472. ],
  6473. "tags": [
  6474. "repository"
  6475. ],
  6476. "summary": "Create a release",
  6477. "operationId": "repoCreateRelease",
  6478. "parameters": [
  6479. {
  6480. "type": "string",
  6481. "description": "owner of the repo",
  6482. "name": "owner",
  6483. "in": "path",
  6484. "required": true
  6485. },
  6486. {
  6487. "type": "string",
  6488. "description": "name of the repo",
  6489. "name": "repo",
  6490. "in": "path",
  6491. "required": true
  6492. },
  6493. {
  6494. "name": "body",
  6495. "in": "body",
  6496. "schema": {
  6497. "$ref": "#/definitions/CreateReleaseOption"
  6498. }
  6499. }
  6500. ],
  6501. "responses": {
  6502. "201": {
  6503. "$ref": "#/responses/Release"
  6504. },
  6505. "409": {
  6506. "$ref": "#/responses/error"
  6507. }
  6508. }
  6509. }
  6510. },
  6511. "/repos/{owner}/{repo}/releases/{id}": {
  6512. "get": {
  6513. "produces": [
  6514. "application/json"
  6515. ],
  6516. "tags": [
  6517. "repository"
  6518. ],
  6519. "summary": "Get a release",
  6520. "operationId": "repoGetRelease",
  6521. "parameters": [
  6522. {
  6523. "type": "string",
  6524. "description": "owner of the repo",
  6525. "name": "owner",
  6526. "in": "path",
  6527. "required": true
  6528. },
  6529. {
  6530. "type": "string",
  6531. "description": "name of the repo",
  6532. "name": "repo",
  6533. "in": "path",
  6534. "required": true
  6535. },
  6536. {
  6537. "type": "integer",
  6538. "format": "int64",
  6539. "description": "id of the release to get",
  6540. "name": "id",
  6541. "in": "path",
  6542. "required": true
  6543. }
  6544. ],
  6545. "responses": {
  6546. "200": {
  6547. "$ref": "#/responses/Release"
  6548. }
  6549. }
  6550. },
  6551. "delete": {
  6552. "tags": [
  6553. "repository"
  6554. ],
  6555. "summary": "Delete a release",
  6556. "operationId": "repoDeleteRelease",
  6557. "parameters": [
  6558. {
  6559. "type": "string",
  6560. "description": "owner of the repo",
  6561. "name": "owner",
  6562. "in": "path",
  6563. "required": true
  6564. },
  6565. {
  6566. "type": "string",
  6567. "description": "name of the repo",
  6568. "name": "repo",
  6569. "in": "path",
  6570. "required": true
  6571. },
  6572. {
  6573. "type": "integer",
  6574. "format": "int64",
  6575. "description": "id of the release to delete",
  6576. "name": "id",
  6577. "in": "path",
  6578. "required": true
  6579. }
  6580. ],
  6581. "responses": {
  6582. "204": {
  6583. "$ref": "#/responses/empty"
  6584. }
  6585. }
  6586. },
  6587. "patch": {
  6588. "consumes": [
  6589. "application/json"
  6590. ],
  6591. "produces": [
  6592. "application/json"
  6593. ],
  6594. "tags": [
  6595. "repository"
  6596. ],
  6597. "summary": "Update a release",
  6598. "operationId": "repoEditRelease",
  6599. "parameters": [
  6600. {
  6601. "type": "string",
  6602. "description": "owner of the repo",
  6603. "name": "owner",
  6604. "in": "path",
  6605. "required": true
  6606. },
  6607. {
  6608. "type": "string",
  6609. "description": "name of the repo",
  6610. "name": "repo",
  6611. "in": "path",
  6612. "required": true
  6613. },
  6614. {
  6615. "type": "integer",
  6616. "format": "int64",
  6617. "description": "id of the release to edit",
  6618. "name": "id",
  6619. "in": "path",
  6620. "required": true
  6621. },
  6622. {
  6623. "name": "body",
  6624. "in": "body",
  6625. "schema": {
  6626. "$ref": "#/definitions/EditReleaseOption"
  6627. }
  6628. }
  6629. ],
  6630. "responses": {
  6631. "200": {
  6632. "$ref": "#/responses/Release"
  6633. }
  6634. }
  6635. }
  6636. },
  6637. "/repos/{owner}/{repo}/releases/{id}/assets": {
  6638. "get": {
  6639. "produces": [
  6640. "application/json"
  6641. ],
  6642. "tags": [
  6643. "repository"
  6644. ],
  6645. "summary": "List release's attachments",
  6646. "operationId": "repoListReleaseAttachments",
  6647. "parameters": [
  6648. {
  6649. "type": "string",
  6650. "description": "owner of the repo",
  6651. "name": "owner",
  6652. "in": "path",
  6653. "required": true
  6654. },
  6655. {
  6656. "type": "string",
  6657. "description": "name of the repo",
  6658. "name": "repo",
  6659. "in": "path",
  6660. "required": true
  6661. },
  6662. {
  6663. "type": "integer",
  6664. "format": "int64",
  6665. "description": "id of the release",
  6666. "name": "id",
  6667. "in": "path",
  6668. "required": true
  6669. }
  6670. ],
  6671. "responses": {
  6672. "200": {
  6673. "$ref": "#/responses/AttachmentList"
  6674. }
  6675. }
  6676. },
  6677. "post": {
  6678. "consumes": [
  6679. "multipart/form-data"
  6680. ],
  6681. "produces": [
  6682. "application/json"
  6683. ],
  6684. "tags": [
  6685. "repository"
  6686. ],
  6687. "summary": "Create a release attachment",
  6688. "operationId": "repoCreateReleaseAttachment",
  6689. "parameters": [
  6690. {
  6691. "type": "string",
  6692. "description": "owner of the repo",
  6693. "name": "owner",
  6694. "in": "path",
  6695. "required": true
  6696. },
  6697. {
  6698. "type": "string",
  6699. "description": "name of the repo",
  6700. "name": "repo",
  6701. "in": "path",
  6702. "required": true
  6703. },
  6704. {
  6705. "type": "integer",
  6706. "format": "int64",
  6707. "description": "id of the release",
  6708. "name": "id",
  6709. "in": "path",
  6710. "required": true
  6711. },
  6712. {
  6713. "type": "string",
  6714. "description": "name of the attachment",
  6715. "name": "name",
  6716. "in": "query"
  6717. },
  6718. {
  6719. "type": "file",
  6720. "description": "attachment to upload",
  6721. "name": "attachment",
  6722. "in": "formData",
  6723. "required": true
  6724. }
  6725. ],
  6726. "responses": {
  6727. "201": {
  6728. "$ref": "#/responses/Attachment"
  6729. },
  6730. "400": {
  6731. "$ref": "#/responses/error"
  6732. }
  6733. }
  6734. }
  6735. },
  6736. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  6737. "get": {
  6738. "produces": [
  6739. "application/json"
  6740. ],
  6741. "tags": [
  6742. "repository"
  6743. ],
  6744. "summary": "Get a release attachment",
  6745. "operationId": "repoGetReleaseAttachment",
  6746. "parameters": [
  6747. {
  6748. "type": "string",
  6749. "description": "owner of the repo",
  6750. "name": "owner",
  6751. "in": "path",
  6752. "required": true
  6753. },
  6754. {
  6755. "type": "string",
  6756. "description": "name of the repo",
  6757. "name": "repo",
  6758. "in": "path",
  6759. "required": true
  6760. },
  6761. {
  6762. "type": "integer",
  6763. "format": "int64",
  6764. "description": "id of the release",
  6765. "name": "id",
  6766. "in": "path",
  6767. "required": true
  6768. },
  6769. {
  6770. "type": "integer",
  6771. "format": "int64",
  6772. "description": "id of the attachment to get",
  6773. "name": "attachment_id",
  6774. "in": "path",
  6775. "required": true
  6776. }
  6777. ],
  6778. "responses": {
  6779. "200": {
  6780. "$ref": "#/responses/Attachment"
  6781. }
  6782. }
  6783. },
  6784. "delete": {
  6785. "produces": [
  6786. "application/json"
  6787. ],
  6788. "tags": [
  6789. "repository"
  6790. ],
  6791. "summary": "Delete a release attachment",
  6792. "operationId": "repoDeleteReleaseAttachment",
  6793. "parameters": [
  6794. {
  6795. "type": "string",
  6796. "description": "owner of the repo",
  6797. "name": "owner",
  6798. "in": "path",
  6799. "required": true
  6800. },
  6801. {
  6802. "type": "string",
  6803. "description": "name of the repo",
  6804. "name": "repo",
  6805. "in": "path",
  6806. "required": true
  6807. },
  6808. {
  6809. "type": "integer",
  6810. "format": "int64",
  6811. "description": "id of the release",
  6812. "name": "id",
  6813. "in": "path",
  6814. "required": true
  6815. },
  6816. {
  6817. "type": "integer",
  6818. "format": "int64",
  6819. "description": "id of the attachment to delete",
  6820. "name": "attachment_id",
  6821. "in": "path",
  6822. "required": true
  6823. }
  6824. ],
  6825. "responses": {
  6826. "204": {
  6827. "$ref": "#/responses/empty"
  6828. }
  6829. }
  6830. },
  6831. "patch": {
  6832. "consumes": [
  6833. "application/json"
  6834. ],
  6835. "produces": [
  6836. "application/json"
  6837. ],
  6838. "tags": [
  6839. "repository"
  6840. ],
  6841. "summary": "Edit a release attachment",
  6842. "operationId": "repoEditReleaseAttachment",
  6843. "parameters": [
  6844. {
  6845. "type": "string",
  6846. "description": "owner of the repo",
  6847. "name": "owner",
  6848. "in": "path",
  6849. "required": true
  6850. },
  6851. {
  6852. "type": "string",
  6853. "description": "name of the repo",
  6854. "name": "repo",
  6855. "in": "path",
  6856. "required": true
  6857. },
  6858. {
  6859. "type": "integer",
  6860. "format": "int64",
  6861. "description": "id of the release",
  6862. "name": "id",
  6863. "in": "path",
  6864. "required": true
  6865. },
  6866. {
  6867. "type": "integer",
  6868. "format": "int64",
  6869. "description": "id of the attachment to edit",
  6870. "name": "attachment_id",
  6871. "in": "path",
  6872. "required": true
  6873. },
  6874. {
  6875. "name": "body",
  6876. "in": "body",
  6877. "schema": {
  6878. "$ref": "#/definitions/EditAttachmentOptions"
  6879. }
  6880. }
  6881. ],
  6882. "responses": {
  6883. "201": {
  6884. "$ref": "#/responses/Attachment"
  6885. }
  6886. }
  6887. }
  6888. },
  6889. "/repos/{owner}/{repo}/signing-key.gpg": {
  6890. "get": {
  6891. "produces": [
  6892. "text/plain"
  6893. ],
  6894. "tags": [
  6895. "repository"
  6896. ],
  6897. "summary": "Get signing-key.gpg for given repository",
  6898. "operationId": "repoSigningKey",
  6899. "parameters": [
  6900. {
  6901. "type": "string",
  6902. "description": "owner of the repo",
  6903. "name": "owner",
  6904. "in": "path",
  6905. "required": true
  6906. },
  6907. {
  6908. "type": "string",
  6909. "description": "name of the repo",
  6910. "name": "repo",
  6911. "in": "path",
  6912. "required": true
  6913. }
  6914. ],
  6915. "responses": {
  6916. "200": {
  6917. "description": "GPG armored public key",
  6918. "schema": {
  6919. "type": "string"
  6920. }
  6921. }
  6922. }
  6923. }
  6924. },
  6925. "/repos/{owner}/{repo}/stargazers": {
  6926. "get": {
  6927. "produces": [
  6928. "application/json"
  6929. ],
  6930. "tags": [
  6931. "repository"
  6932. ],
  6933. "summary": "List a repo's stargazers",
  6934. "operationId": "repoListStargazers",
  6935. "parameters": [
  6936. {
  6937. "type": "string",
  6938. "description": "owner of the repo",
  6939. "name": "owner",
  6940. "in": "path",
  6941. "required": true
  6942. },
  6943. {
  6944. "type": "string",
  6945. "description": "name of the repo",
  6946. "name": "repo",
  6947. "in": "path",
  6948. "required": true
  6949. },
  6950. {
  6951. "type": "integer",
  6952. "description": "page number of results to return (1-based)",
  6953. "name": "page",
  6954. "in": "query"
  6955. },
  6956. {
  6957. "type": "integer",
  6958. "description": "page size of results, maximum page size is 50",
  6959. "name": "limit",
  6960. "in": "query"
  6961. }
  6962. ],
  6963. "responses": {
  6964. "200": {
  6965. "$ref": "#/responses/UserList"
  6966. }
  6967. }
  6968. }
  6969. },
  6970. "/repos/{owner}/{repo}/statuses/{sha}": {
  6971. "get": {
  6972. "produces": [
  6973. "application/json"
  6974. ],
  6975. "tags": [
  6976. "repository"
  6977. ],
  6978. "summary": "Get a commit's statuses",
  6979. "operationId": "repoListStatuses",
  6980. "parameters": [
  6981. {
  6982. "type": "string",
  6983. "description": "owner of the repo",
  6984. "name": "owner",
  6985. "in": "path",
  6986. "required": true
  6987. },
  6988. {
  6989. "type": "string",
  6990. "description": "name of the repo",
  6991. "name": "repo",
  6992. "in": "path",
  6993. "required": true
  6994. },
  6995. {
  6996. "type": "string",
  6997. "description": "sha of the commit",
  6998. "name": "sha",
  6999. "in": "path",
  7000. "required": true
  7001. },
  7002. {
  7003. "enum": [
  7004. "oldest",
  7005. "recentupdate",
  7006. "leastupdate",
  7007. "leastindex",
  7008. "highestindex"
  7009. ],
  7010. "type": "string",
  7011. "description": "type of sort",
  7012. "name": "sort",
  7013. "in": "query"
  7014. },
  7015. {
  7016. "enum": [
  7017. "pending",
  7018. "success",
  7019. "error",
  7020. "failure",
  7021. "warning"
  7022. ],
  7023. "type": "string",
  7024. "description": "type of state",
  7025. "name": "state",
  7026. "in": "query"
  7027. },
  7028. {
  7029. "type": "integer",
  7030. "description": "page number of results to return (1-based)",
  7031. "name": "page",
  7032. "in": "query"
  7033. },
  7034. {
  7035. "type": "integer",
  7036. "description": "page size of results, maximum page size is 50",
  7037. "name": "limit",
  7038. "in": "query"
  7039. }
  7040. ],
  7041. "responses": {
  7042. "200": {
  7043. "$ref": "#/responses/StatusList"
  7044. },
  7045. "400": {
  7046. "$ref": "#/responses/error"
  7047. }
  7048. }
  7049. },
  7050. "post": {
  7051. "produces": [
  7052. "application/json"
  7053. ],
  7054. "tags": [
  7055. "repository"
  7056. ],
  7057. "summary": "Create a commit status",
  7058. "operationId": "repoCreateStatus",
  7059. "parameters": [
  7060. {
  7061. "type": "string",
  7062. "description": "owner of the repo",
  7063. "name": "owner",
  7064. "in": "path",
  7065. "required": true
  7066. },
  7067. {
  7068. "type": "string",
  7069. "description": "name of the repo",
  7070. "name": "repo",
  7071. "in": "path",
  7072. "required": true
  7073. },
  7074. {
  7075. "type": "string",
  7076. "description": "sha of the commit",
  7077. "name": "sha",
  7078. "in": "path",
  7079. "required": true
  7080. },
  7081. {
  7082. "name": "body",
  7083. "in": "body",
  7084. "schema": {
  7085. "$ref": "#/definitions/CreateStatusOption"
  7086. }
  7087. }
  7088. ],
  7089. "responses": {
  7090. "201": {
  7091. "$ref": "#/responses/Status"
  7092. },
  7093. "400": {
  7094. "$ref": "#/responses/error"
  7095. }
  7096. }
  7097. }
  7098. },
  7099. "/repos/{owner}/{repo}/subscribers": {
  7100. "get": {
  7101. "produces": [
  7102. "application/json"
  7103. ],
  7104. "tags": [
  7105. "repository"
  7106. ],
  7107. "summary": "List a repo's watchers",
  7108. "operationId": "repoListSubscribers",
  7109. "parameters": [
  7110. {
  7111. "type": "string",
  7112. "description": "owner of the repo",
  7113. "name": "owner",
  7114. "in": "path",
  7115. "required": true
  7116. },
  7117. {
  7118. "type": "string",
  7119. "description": "name of the repo",
  7120. "name": "repo",
  7121. "in": "path",
  7122. "required": true
  7123. },
  7124. {
  7125. "type": "integer",
  7126. "description": "page number of results to return (1-based)",
  7127. "name": "page",
  7128. "in": "query"
  7129. },
  7130. {
  7131. "type": "integer",
  7132. "description": "page size of results, maximum page size is 50",
  7133. "name": "limit",
  7134. "in": "query"
  7135. }
  7136. ],
  7137. "responses": {
  7138. "200": {
  7139. "$ref": "#/responses/UserList"
  7140. }
  7141. }
  7142. }
  7143. },
  7144. "/repos/{owner}/{repo}/subscription": {
  7145. "get": {
  7146. "tags": [
  7147. "repository"
  7148. ],
  7149. "summary": "Check if the current user is watching a repo",
  7150. "operationId": "userCurrentCheckSubscription",
  7151. "parameters": [
  7152. {
  7153. "type": "string",
  7154. "description": "owner of the repo",
  7155. "name": "owner",
  7156. "in": "path",
  7157. "required": true
  7158. },
  7159. {
  7160. "type": "string",
  7161. "description": "name of the repo",
  7162. "name": "repo",
  7163. "in": "path",
  7164. "required": true
  7165. }
  7166. ],
  7167. "responses": {
  7168. "200": {
  7169. "$ref": "#/responses/WatchInfo"
  7170. }
  7171. }
  7172. },
  7173. "put": {
  7174. "tags": [
  7175. "repository"
  7176. ],
  7177. "summary": "Watch a repo",
  7178. "operationId": "userCurrentPutSubscription",
  7179. "parameters": [
  7180. {
  7181. "type": "string",
  7182. "description": "owner of the repo",
  7183. "name": "owner",
  7184. "in": "path",
  7185. "required": true
  7186. },
  7187. {
  7188. "type": "string",
  7189. "description": "name of the repo",
  7190. "name": "repo",
  7191. "in": "path",
  7192. "required": true
  7193. }
  7194. ],
  7195. "responses": {
  7196. "200": {
  7197. "$ref": "#/responses/WatchInfo"
  7198. }
  7199. }
  7200. },
  7201. "delete": {
  7202. "tags": [
  7203. "repository"
  7204. ],
  7205. "summary": "Unwatch a repo",
  7206. "operationId": "userCurrentDeleteSubscription",
  7207. "parameters": [
  7208. {
  7209. "type": "string",
  7210. "description": "owner of the repo",
  7211. "name": "owner",
  7212. "in": "path",
  7213. "required": true
  7214. },
  7215. {
  7216. "type": "string",
  7217. "description": "name of the repo",
  7218. "name": "repo",
  7219. "in": "path",
  7220. "required": true
  7221. }
  7222. ],
  7223. "responses": {
  7224. "204": {
  7225. "$ref": "#/responses/empty"
  7226. }
  7227. }
  7228. }
  7229. },
  7230. "/repos/{owner}/{repo}/tags": {
  7231. "get": {
  7232. "produces": [
  7233. "application/json"
  7234. ],
  7235. "tags": [
  7236. "repository"
  7237. ],
  7238. "summary": "List a repository's tags",
  7239. "operationId": "repoListTags",
  7240. "parameters": [
  7241. {
  7242. "type": "string",
  7243. "description": "owner of the repo",
  7244. "name": "owner",
  7245. "in": "path",
  7246. "required": true
  7247. },
  7248. {
  7249. "type": "string",
  7250. "description": "name of the repo",
  7251. "name": "repo",
  7252. "in": "path",
  7253. "required": true
  7254. },
  7255. {
  7256. "type": "integer",
  7257. "description": "page number of results to return (1-based)",
  7258. "name": "page",
  7259. "in": "query"
  7260. },
  7261. {
  7262. "type": "integer",
  7263. "description": "page size of results, default maximum page size is 50",
  7264. "name": "limit",
  7265. "in": "query"
  7266. }
  7267. ],
  7268. "responses": {
  7269. "200": {
  7270. "$ref": "#/responses/TagList"
  7271. }
  7272. }
  7273. }
  7274. },
  7275. "/repos/{owner}/{repo}/times": {
  7276. "get": {
  7277. "produces": [
  7278. "application/json"
  7279. ],
  7280. "tags": [
  7281. "repository"
  7282. ],
  7283. "summary": "List a repo's tracked times",
  7284. "operationId": "repoTrackedTimes",
  7285. "parameters": [
  7286. {
  7287. "type": "string",
  7288. "description": "owner of the repo",
  7289. "name": "owner",
  7290. "in": "path",
  7291. "required": true
  7292. },
  7293. {
  7294. "type": "string",
  7295. "description": "name of the repo",
  7296. "name": "repo",
  7297. "in": "path",
  7298. "required": true
  7299. },
  7300. {
  7301. "type": "string",
  7302. "description": "optional filter by user",
  7303. "name": "user",
  7304. "in": "query"
  7305. },
  7306. {
  7307. "type": "string",
  7308. "format": "date-time",
  7309. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7310. "name": "since",
  7311. "in": "query"
  7312. },
  7313. {
  7314. "type": "string",
  7315. "format": "date-time",
  7316. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7317. "name": "before",
  7318. "in": "query"
  7319. },
  7320. {
  7321. "type": "integer",
  7322. "description": "page number of results to return (1-based)",
  7323. "name": "page",
  7324. "in": "query"
  7325. },
  7326. {
  7327. "type": "integer",
  7328. "description": "page size of results, maximum page size is 50",
  7329. "name": "limit",
  7330. "in": "query"
  7331. }
  7332. ],
  7333. "responses": {
  7334. "200": {
  7335. "$ref": "#/responses/TrackedTimeList"
  7336. },
  7337. "400": {
  7338. "$ref": "#/responses/error"
  7339. },
  7340. "403": {
  7341. "$ref": "#/responses/forbidden"
  7342. }
  7343. }
  7344. }
  7345. },
  7346. "/repos/{owner}/{repo}/times/{user}": {
  7347. "get": {
  7348. "produces": [
  7349. "application/json"
  7350. ],
  7351. "tags": [
  7352. "repository"
  7353. ],
  7354. "summary": "List a user's tracked times in a repo",
  7355. "operationId": "userTrackedTimes",
  7356. "deprecated": true,
  7357. "parameters": [
  7358. {
  7359. "type": "string",
  7360. "description": "owner of the repo",
  7361. "name": "owner",
  7362. "in": "path",
  7363. "required": true
  7364. },
  7365. {
  7366. "type": "string",
  7367. "description": "name of the repo",
  7368. "name": "repo",
  7369. "in": "path",
  7370. "required": true
  7371. },
  7372. {
  7373. "type": "string",
  7374. "description": "username of user",
  7375. "name": "user",
  7376. "in": "path",
  7377. "required": true
  7378. }
  7379. ],
  7380. "responses": {
  7381. "200": {
  7382. "$ref": "#/responses/TrackedTimeList"
  7383. },
  7384. "400": {
  7385. "$ref": "#/responses/error"
  7386. },
  7387. "403": {
  7388. "$ref": "#/responses/forbidden"
  7389. }
  7390. }
  7391. }
  7392. },
  7393. "/repos/{owner}/{repo}/topics": {
  7394. "get": {
  7395. "produces": [
  7396. "application/json"
  7397. ],
  7398. "tags": [
  7399. "repository"
  7400. ],
  7401. "summary": "Get list of topics that a repository has",
  7402. "operationId": "repoListTopics",
  7403. "parameters": [
  7404. {
  7405. "type": "string",
  7406. "description": "owner of the repo",
  7407. "name": "owner",
  7408. "in": "path",
  7409. "required": true
  7410. },
  7411. {
  7412. "type": "string",
  7413. "description": "name of the repo",
  7414. "name": "repo",
  7415. "in": "path",
  7416. "required": true
  7417. },
  7418. {
  7419. "type": "integer",
  7420. "description": "page number of results to return (1-based)",
  7421. "name": "page",
  7422. "in": "query"
  7423. },
  7424. {
  7425. "type": "integer",
  7426. "description": "page size of results, maximum page size is 50",
  7427. "name": "limit",
  7428. "in": "query"
  7429. }
  7430. ],
  7431. "responses": {
  7432. "200": {
  7433. "$ref": "#/responses/TopicNames"
  7434. }
  7435. }
  7436. },
  7437. "put": {
  7438. "produces": [
  7439. "application/json"
  7440. ],
  7441. "tags": [
  7442. "repository"
  7443. ],
  7444. "summary": "Replace list of topics for a repository",
  7445. "operationId": "repoUpdateTopics",
  7446. "parameters": [
  7447. {
  7448. "type": "string",
  7449. "description": "owner of the repo",
  7450. "name": "owner",
  7451. "in": "path",
  7452. "required": true
  7453. },
  7454. {
  7455. "type": "string",
  7456. "description": "name of the repo",
  7457. "name": "repo",
  7458. "in": "path",
  7459. "required": true
  7460. },
  7461. {
  7462. "name": "body",
  7463. "in": "body",
  7464. "schema": {
  7465. "$ref": "#/definitions/RepoTopicOptions"
  7466. }
  7467. }
  7468. ],
  7469. "responses": {
  7470. "204": {
  7471. "$ref": "#/responses/empty"
  7472. },
  7473. "422": {
  7474. "$ref": "#/responses/invalidTopicsError"
  7475. }
  7476. }
  7477. }
  7478. },
  7479. "/repos/{owner}/{repo}/topics/{topic}": {
  7480. "put": {
  7481. "produces": [
  7482. "application/json"
  7483. ],
  7484. "tags": [
  7485. "repository"
  7486. ],
  7487. "summary": "Add a topic to a repository",
  7488. "operationId": "repoAddTopíc",
  7489. "parameters": [
  7490. {
  7491. "type": "string",
  7492. "description": "owner of the repo",
  7493. "name": "owner",
  7494. "in": "path",
  7495. "required": true
  7496. },
  7497. {
  7498. "type": "string",
  7499. "description": "name of the repo",
  7500. "name": "repo",
  7501. "in": "path",
  7502. "required": true
  7503. },
  7504. {
  7505. "type": "string",
  7506. "description": "name of the topic to add",
  7507. "name": "topic",
  7508. "in": "path",
  7509. "required": true
  7510. }
  7511. ],
  7512. "responses": {
  7513. "204": {
  7514. "$ref": "#/responses/empty"
  7515. },
  7516. "422": {
  7517. "$ref": "#/responses/invalidTopicsError"
  7518. }
  7519. }
  7520. },
  7521. "delete": {
  7522. "produces": [
  7523. "application/json"
  7524. ],
  7525. "tags": [
  7526. "repository"
  7527. ],
  7528. "summary": "Delete a topic from a repository",
  7529. "operationId": "repoDeleteTopic",
  7530. "parameters": [
  7531. {
  7532. "type": "string",
  7533. "description": "owner of the repo",
  7534. "name": "owner",
  7535. "in": "path",
  7536. "required": true
  7537. },
  7538. {
  7539. "type": "string",
  7540. "description": "name of the repo",
  7541. "name": "repo",
  7542. "in": "path",
  7543. "required": true
  7544. },
  7545. {
  7546. "type": "string",
  7547. "description": "name of the topic to delete",
  7548. "name": "topic",
  7549. "in": "path",
  7550. "required": true
  7551. }
  7552. ],
  7553. "responses": {
  7554. "204": {
  7555. "$ref": "#/responses/empty"
  7556. },
  7557. "422": {
  7558. "$ref": "#/responses/invalidTopicsError"
  7559. }
  7560. }
  7561. }
  7562. },
  7563. "/repos/{owner}/{repo}/transfer": {
  7564. "post": {
  7565. "produces": [
  7566. "application/json"
  7567. ],
  7568. "tags": [
  7569. "repository"
  7570. ],
  7571. "summary": "Transfer a repo ownership",
  7572. "operationId": "repoTransfer",
  7573. "parameters": [
  7574. {
  7575. "type": "string",
  7576. "description": "owner of the repo to transfer",
  7577. "name": "owner",
  7578. "in": "path",
  7579. "required": true
  7580. },
  7581. {
  7582. "type": "string",
  7583. "description": "name of the repo to transfer",
  7584. "name": "repo",
  7585. "in": "path",
  7586. "required": true
  7587. },
  7588. {
  7589. "description": "Transfer Options",
  7590. "name": "body",
  7591. "in": "body",
  7592. "required": true,
  7593. "schema": {
  7594. "$ref": "#/definitions/TransferRepoOption"
  7595. }
  7596. }
  7597. ],
  7598. "responses": {
  7599. "202": {
  7600. "$ref": "#/responses/Repository"
  7601. },
  7602. "403": {
  7603. "$ref": "#/responses/forbidden"
  7604. },
  7605. "404": {
  7606. "$ref": "#/responses/notFound"
  7607. },
  7608. "422": {
  7609. "$ref": "#/responses/validationError"
  7610. }
  7611. }
  7612. }
  7613. },
  7614. "/repositories/{id}": {
  7615. "get": {
  7616. "produces": [
  7617. "application/json"
  7618. ],
  7619. "tags": [
  7620. "repository"
  7621. ],
  7622. "summary": "Get a repository by id",
  7623. "operationId": "repoGetByID",
  7624. "parameters": [
  7625. {
  7626. "type": "integer",
  7627. "format": "int64",
  7628. "description": "id of the repo to get",
  7629. "name": "id",
  7630. "in": "path",
  7631. "required": true
  7632. }
  7633. ],
  7634. "responses": {
  7635. "200": {
  7636. "$ref": "#/responses/Repository"
  7637. }
  7638. }
  7639. }
  7640. },
  7641. "/signing-key.gpg": {
  7642. "get": {
  7643. "produces": [
  7644. "text/plain"
  7645. ],
  7646. "tags": [
  7647. "miscellaneous"
  7648. ],
  7649. "summary": "Get default signing-key.gpg",
  7650. "operationId": "getSigningKey",
  7651. "responses": {
  7652. "200": {
  7653. "description": "GPG armored public key",
  7654. "schema": {
  7655. "type": "string"
  7656. }
  7657. }
  7658. }
  7659. }
  7660. },
  7661. "/teams/{id}": {
  7662. "get": {
  7663. "produces": [
  7664. "application/json"
  7665. ],
  7666. "tags": [
  7667. "organization"
  7668. ],
  7669. "summary": "Get a team",
  7670. "operationId": "orgGetTeam",
  7671. "parameters": [
  7672. {
  7673. "type": "integer",
  7674. "format": "int64",
  7675. "description": "id of the team to get",
  7676. "name": "id",
  7677. "in": "path",
  7678. "required": true
  7679. }
  7680. ],
  7681. "responses": {
  7682. "200": {
  7683. "$ref": "#/responses/Team"
  7684. }
  7685. }
  7686. },
  7687. "delete": {
  7688. "tags": [
  7689. "organization"
  7690. ],
  7691. "summary": "Delete a team",
  7692. "operationId": "orgDeleteTeam",
  7693. "parameters": [
  7694. {
  7695. "type": "integer",
  7696. "format": "int64",
  7697. "description": "id of the team to delete",
  7698. "name": "id",
  7699. "in": "path",
  7700. "required": true
  7701. }
  7702. ],
  7703. "responses": {
  7704. "204": {
  7705. "description": "team deleted"
  7706. }
  7707. }
  7708. },
  7709. "patch": {
  7710. "consumes": [
  7711. "application/json"
  7712. ],
  7713. "produces": [
  7714. "application/json"
  7715. ],
  7716. "tags": [
  7717. "organization"
  7718. ],
  7719. "summary": "Edit a team",
  7720. "operationId": "orgEditTeam",
  7721. "parameters": [
  7722. {
  7723. "type": "integer",
  7724. "description": "id of the team to edit",
  7725. "name": "id",
  7726. "in": "path",
  7727. "required": true
  7728. },
  7729. {
  7730. "name": "body",
  7731. "in": "body",
  7732. "schema": {
  7733. "$ref": "#/definitions/EditTeamOption"
  7734. }
  7735. }
  7736. ],
  7737. "responses": {
  7738. "200": {
  7739. "$ref": "#/responses/Team"
  7740. }
  7741. }
  7742. }
  7743. },
  7744. "/teams/{id}/members": {
  7745. "get": {
  7746. "produces": [
  7747. "application/json"
  7748. ],
  7749. "tags": [
  7750. "organization"
  7751. ],
  7752. "summary": "List a team's members",
  7753. "operationId": "orgListTeamMembers",
  7754. "parameters": [
  7755. {
  7756. "type": "integer",
  7757. "format": "int64",
  7758. "description": "id of the team",
  7759. "name": "id",
  7760. "in": "path",
  7761. "required": true
  7762. },
  7763. {
  7764. "type": "integer",
  7765. "description": "page number of results to return (1-based)",
  7766. "name": "page",
  7767. "in": "query"
  7768. },
  7769. {
  7770. "type": "integer",
  7771. "description": "page size of results, maximum page size is 50",
  7772. "name": "limit",
  7773. "in": "query"
  7774. }
  7775. ],
  7776. "responses": {
  7777. "200": {
  7778. "$ref": "#/responses/UserList"
  7779. }
  7780. }
  7781. }
  7782. },
  7783. "/teams/{id}/members/{username}": {
  7784. "get": {
  7785. "produces": [
  7786. "application/json"
  7787. ],
  7788. "tags": [
  7789. "organization"
  7790. ],
  7791. "summary": "List a particular member of team",
  7792. "operationId": "orgListTeamMember",
  7793. "parameters": [
  7794. {
  7795. "type": "integer",
  7796. "format": "int64",
  7797. "description": "id of the team",
  7798. "name": "id",
  7799. "in": "path",
  7800. "required": true
  7801. },
  7802. {
  7803. "type": "string",
  7804. "description": "username of the member to list",
  7805. "name": "username",
  7806. "in": "path",
  7807. "required": true
  7808. }
  7809. ],
  7810. "responses": {
  7811. "200": {
  7812. "$ref": "#/responses/User"
  7813. },
  7814. "404": {
  7815. "$ref": "#/responses/notFound"
  7816. }
  7817. }
  7818. },
  7819. "put": {
  7820. "produces": [
  7821. "application/json"
  7822. ],
  7823. "tags": [
  7824. "organization"
  7825. ],
  7826. "summary": "Add a team member",
  7827. "operationId": "orgAddTeamMember",
  7828. "parameters": [
  7829. {
  7830. "type": "integer",
  7831. "format": "int64",
  7832. "description": "id of the team",
  7833. "name": "id",
  7834. "in": "path",
  7835. "required": true
  7836. },
  7837. {
  7838. "type": "string",
  7839. "description": "username of the user to add",
  7840. "name": "username",
  7841. "in": "path",
  7842. "required": true
  7843. }
  7844. ],
  7845. "responses": {
  7846. "204": {
  7847. "$ref": "#/responses/empty"
  7848. },
  7849. "404": {
  7850. "$ref": "#/responses/notFound"
  7851. }
  7852. }
  7853. },
  7854. "delete": {
  7855. "produces": [
  7856. "application/json"
  7857. ],
  7858. "tags": [
  7859. "organization"
  7860. ],
  7861. "summary": "Remove a team member",
  7862. "operationId": "orgRemoveTeamMember",
  7863. "parameters": [
  7864. {
  7865. "type": "integer",
  7866. "format": "int64",
  7867. "description": "id of the team",
  7868. "name": "id",
  7869. "in": "path",
  7870. "required": true
  7871. },
  7872. {
  7873. "type": "string",
  7874. "description": "username of the user to remove",
  7875. "name": "username",
  7876. "in": "path",
  7877. "required": true
  7878. }
  7879. ],
  7880. "responses": {
  7881. "204": {
  7882. "$ref": "#/responses/empty"
  7883. },
  7884. "404": {
  7885. "$ref": "#/responses/notFound"
  7886. }
  7887. }
  7888. }
  7889. },
  7890. "/teams/{id}/repos": {
  7891. "get": {
  7892. "produces": [
  7893. "application/json"
  7894. ],
  7895. "tags": [
  7896. "organization"
  7897. ],
  7898. "summary": "List a team's repos",
  7899. "operationId": "orgListTeamRepos",
  7900. "parameters": [
  7901. {
  7902. "type": "integer",
  7903. "format": "int64",
  7904. "description": "id of the team",
  7905. "name": "id",
  7906. "in": "path",
  7907. "required": true
  7908. },
  7909. {
  7910. "type": "integer",
  7911. "description": "page number of results to return (1-based)",
  7912. "name": "page",
  7913. "in": "query"
  7914. },
  7915. {
  7916. "type": "integer",
  7917. "description": "page size of results, maximum page size is 50",
  7918. "name": "limit",
  7919. "in": "query"
  7920. }
  7921. ],
  7922. "responses": {
  7923. "200": {
  7924. "$ref": "#/responses/RepositoryList"
  7925. }
  7926. }
  7927. }
  7928. },
  7929. "/teams/{id}/repos/{org}/{repo}": {
  7930. "put": {
  7931. "produces": [
  7932. "application/json"
  7933. ],
  7934. "tags": [
  7935. "organization"
  7936. ],
  7937. "summary": "Add a repository to a team",
  7938. "operationId": "orgAddTeamRepository",
  7939. "parameters": [
  7940. {
  7941. "type": "integer",
  7942. "format": "int64",
  7943. "description": "id of the team",
  7944. "name": "id",
  7945. "in": "path",
  7946. "required": true
  7947. },
  7948. {
  7949. "type": "string",
  7950. "description": "organization that owns the repo to add",
  7951. "name": "org",
  7952. "in": "path",
  7953. "required": true
  7954. },
  7955. {
  7956. "type": "string",
  7957. "description": "name of the repo to add",
  7958. "name": "repo",
  7959. "in": "path",
  7960. "required": true
  7961. }
  7962. ],
  7963. "responses": {
  7964. "204": {
  7965. "$ref": "#/responses/empty"
  7966. },
  7967. "403": {
  7968. "$ref": "#/responses/forbidden"
  7969. }
  7970. }
  7971. },
  7972. "delete": {
  7973. "description": "This does not delete the repository, it only removes the repository from the team.",
  7974. "produces": [
  7975. "application/json"
  7976. ],
  7977. "tags": [
  7978. "organization"
  7979. ],
  7980. "summary": "Remove a repository from a team",
  7981. "operationId": "orgRemoveTeamRepository",
  7982. "parameters": [
  7983. {
  7984. "type": "integer",
  7985. "format": "int64",
  7986. "description": "id of the team",
  7987. "name": "id",
  7988. "in": "path",
  7989. "required": true
  7990. },
  7991. {
  7992. "type": "string",
  7993. "description": "organization that owns the repo to remove",
  7994. "name": "org",
  7995. "in": "path",
  7996. "required": true
  7997. },
  7998. {
  7999. "type": "string",
  8000. "description": "name of the repo to remove",
  8001. "name": "repo",
  8002. "in": "path",
  8003. "required": true
  8004. }
  8005. ],
  8006. "responses": {
  8007. "204": {
  8008. "$ref": "#/responses/empty"
  8009. },
  8010. "403": {
  8011. "$ref": "#/responses/forbidden"
  8012. }
  8013. }
  8014. }
  8015. },
  8016. "/topics/search": {
  8017. "get": {
  8018. "produces": [
  8019. "application/json"
  8020. ],
  8021. "tags": [
  8022. "repository"
  8023. ],
  8024. "summary": "search topics via keyword",
  8025. "operationId": "topicSearch",
  8026. "parameters": [
  8027. {
  8028. "type": "string",
  8029. "description": "keywords to search",
  8030. "name": "q",
  8031. "in": "query",
  8032. "required": true
  8033. },
  8034. {
  8035. "type": "integer",
  8036. "description": "page number of results to return (1-based)",
  8037. "name": "page",
  8038. "in": "query"
  8039. },
  8040. {
  8041. "type": "integer",
  8042. "description": "page size of results, maximum page size is 50",
  8043. "name": "limit",
  8044. "in": "query"
  8045. }
  8046. ],
  8047. "responses": {
  8048. "200": {
  8049. "$ref": "#/responses/TopicListResponse"
  8050. },
  8051. "403": {
  8052. "$ref": "#/responses/forbidden"
  8053. }
  8054. }
  8055. }
  8056. },
  8057. "/user": {
  8058. "get": {
  8059. "produces": [
  8060. "application/json"
  8061. ],
  8062. "tags": [
  8063. "user"
  8064. ],
  8065. "summary": "Get the authenticated user",
  8066. "operationId": "userGetCurrent",
  8067. "responses": {
  8068. "200": {
  8069. "$ref": "#/responses/User"
  8070. }
  8071. }
  8072. }
  8073. },
  8074. "/user/applications/oauth2": {
  8075. "get": {
  8076. "produces": [
  8077. "application/json"
  8078. ],
  8079. "tags": [
  8080. "user"
  8081. ],
  8082. "summary": "List the authenticated user's oauth2 applications",
  8083. "operationId": "userGetOauth2Application",
  8084. "parameters": [
  8085. {
  8086. "type": "integer",
  8087. "description": "page number of results to return (1-based)",
  8088. "name": "page",
  8089. "in": "query"
  8090. },
  8091. {
  8092. "type": "integer",
  8093. "description": "page size of results, maximum page size is 50",
  8094. "name": "limit",
  8095. "in": "query"
  8096. }
  8097. ],
  8098. "responses": {
  8099. "200": {
  8100. "$ref": "#/responses/OAuth2ApplicationList"
  8101. }
  8102. }
  8103. },
  8104. "post": {
  8105. "produces": [
  8106. "application/json"
  8107. ],
  8108. "tags": [
  8109. "user"
  8110. ],
  8111. "summary": "creates a new OAuth2 application",
  8112. "operationId": "userCreateOAuth2Application",
  8113. "parameters": [
  8114. {
  8115. "name": "body",
  8116. "in": "body",
  8117. "required": true,
  8118. "schema": {
  8119. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  8120. }
  8121. }
  8122. ],
  8123. "responses": {
  8124. "201": {
  8125. "$ref": "#/responses/OAuth2Application"
  8126. }
  8127. }
  8128. }
  8129. },
  8130. "/user/applications/oauth2/{id}": {
  8131. "delete": {
  8132. "produces": [
  8133. "application/json"
  8134. ],
  8135. "tags": [
  8136. "user"
  8137. ],
  8138. "summary": "delete an OAuth2 Application",
  8139. "operationId": "userDeleteOAuth2Application",
  8140. "parameters": [
  8141. {
  8142. "type": "integer",
  8143. "format": "int64",
  8144. "description": "token to be deleted",
  8145. "name": "id",
  8146. "in": "path",
  8147. "required": true
  8148. }
  8149. ],
  8150. "responses": {
  8151. "204": {
  8152. "$ref": "#/responses/empty"
  8153. }
  8154. }
  8155. }
  8156. },
  8157. "/user/emails": {
  8158. "get": {
  8159. "produces": [
  8160. "application/json"
  8161. ],
  8162. "tags": [
  8163. "user"
  8164. ],
  8165. "summary": "List the authenticated user's email addresses",
  8166. "operationId": "userListEmails",
  8167. "responses": {
  8168. "200": {
  8169. "$ref": "#/responses/EmailList"
  8170. }
  8171. }
  8172. },
  8173. "post": {
  8174. "produces": [
  8175. "application/json"
  8176. ],
  8177. "tags": [
  8178. "user"
  8179. ],
  8180. "summary": "Add email addresses",
  8181. "operationId": "userAddEmail",
  8182. "parameters": [
  8183. {
  8184. "name": "body",
  8185. "in": "body",
  8186. "schema": {
  8187. "$ref": "#/definitions/CreateEmailOption"
  8188. }
  8189. }
  8190. ],
  8191. "responses": {
  8192. "201": {
  8193. "$ref": "#/responses/EmailList"
  8194. },
  8195. "422": {
  8196. "$ref": "#/responses/validationError"
  8197. }
  8198. }
  8199. },
  8200. "delete": {
  8201. "produces": [
  8202. "application/json"
  8203. ],
  8204. "tags": [
  8205. "user"
  8206. ],
  8207. "summary": "Delete email addresses",
  8208. "operationId": "userDeleteEmail",
  8209. "parameters": [
  8210. {
  8211. "name": "body",
  8212. "in": "body",
  8213. "schema": {
  8214. "$ref": "#/definitions/DeleteEmailOption"
  8215. }
  8216. }
  8217. ],
  8218. "responses": {
  8219. "204": {
  8220. "$ref": "#/responses/empty"
  8221. }
  8222. }
  8223. }
  8224. },
  8225. "/user/followers": {
  8226. "get": {
  8227. "produces": [
  8228. "application/json"
  8229. ],
  8230. "tags": [
  8231. "user"
  8232. ],
  8233. "summary": "List the authenticated user's followers",
  8234. "operationId": "userCurrentListFollowers",
  8235. "parameters": [
  8236. {
  8237. "type": "integer",
  8238. "description": "page number of results to return (1-based)",
  8239. "name": "page",
  8240. "in": "query"
  8241. },
  8242. {
  8243. "type": "integer",
  8244. "description": "page size of results, maximum page size is 50",
  8245. "name": "limit",
  8246. "in": "query"
  8247. }
  8248. ],
  8249. "responses": {
  8250. "200": {
  8251. "$ref": "#/responses/UserList"
  8252. }
  8253. }
  8254. }
  8255. },
  8256. "/user/following": {
  8257. "get": {
  8258. "produces": [
  8259. "application/json"
  8260. ],
  8261. "tags": [
  8262. "user"
  8263. ],
  8264. "summary": "List the users that the authenticated user is following",
  8265. "operationId": "userCurrentListFollowing",
  8266. "parameters": [
  8267. {
  8268. "type": "integer",
  8269. "description": "page number of results to return (1-based)",
  8270. "name": "page",
  8271. "in": "query"
  8272. },
  8273. {
  8274. "type": "integer",
  8275. "description": "page size of results, maximum page size is 50",
  8276. "name": "limit",
  8277. "in": "query"
  8278. }
  8279. ],
  8280. "responses": {
  8281. "200": {
  8282. "$ref": "#/responses/UserList"
  8283. }
  8284. }
  8285. }
  8286. },
  8287. "/user/following/{username}": {
  8288. "get": {
  8289. "tags": [
  8290. "user"
  8291. ],
  8292. "summary": "Check whether a user is followed by the authenticated user",
  8293. "operationId": "userCurrentCheckFollowing",
  8294. "parameters": [
  8295. {
  8296. "type": "string",
  8297. "description": "username of followed user",
  8298. "name": "username",
  8299. "in": "path",
  8300. "required": true
  8301. }
  8302. ],
  8303. "responses": {
  8304. "204": {
  8305. "$ref": "#/responses/empty"
  8306. },
  8307. "404": {
  8308. "$ref": "#/responses/notFound"
  8309. }
  8310. }
  8311. },
  8312. "put": {
  8313. "tags": [
  8314. "user"
  8315. ],
  8316. "summary": "Follow a user",
  8317. "operationId": "userCurrentPutFollow",
  8318. "parameters": [
  8319. {
  8320. "type": "string",
  8321. "description": "username of user to follow",
  8322. "name": "username",
  8323. "in": "path",
  8324. "required": true
  8325. }
  8326. ],
  8327. "responses": {
  8328. "204": {
  8329. "$ref": "#/responses/empty"
  8330. }
  8331. }
  8332. },
  8333. "delete": {
  8334. "tags": [
  8335. "user"
  8336. ],
  8337. "summary": "Unfollow a user",
  8338. "operationId": "userCurrentDeleteFollow",
  8339. "parameters": [
  8340. {
  8341. "type": "string",
  8342. "description": "username of user to unfollow",
  8343. "name": "username",
  8344. "in": "path",
  8345. "required": true
  8346. }
  8347. ],
  8348. "responses": {
  8349. "204": {
  8350. "$ref": "#/responses/empty"
  8351. }
  8352. }
  8353. }
  8354. },
  8355. "/user/gpg_keys": {
  8356. "get": {
  8357. "produces": [
  8358. "application/json"
  8359. ],
  8360. "tags": [
  8361. "user"
  8362. ],
  8363. "summary": "List the authenticated user's GPG keys",
  8364. "operationId": "userCurrentListGPGKeys",
  8365. "parameters": [
  8366. {
  8367. "type": "integer",
  8368. "description": "page number of results to return (1-based)",
  8369. "name": "page",
  8370. "in": "query"
  8371. },
  8372. {
  8373. "type": "integer",
  8374. "description": "page size of results, maximum page size is 50",
  8375. "name": "limit",
  8376. "in": "query"
  8377. }
  8378. ],
  8379. "responses": {
  8380. "200": {
  8381. "$ref": "#/responses/GPGKeyList"
  8382. }
  8383. }
  8384. },
  8385. "post": {
  8386. "consumes": [
  8387. "application/json"
  8388. ],
  8389. "produces": [
  8390. "application/json"
  8391. ],
  8392. "tags": [
  8393. "user"
  8394. ],
  8395. "summary": "Create a GPG key",
  8396. "operationId": "userCurrentPostGPGKey",
  8397. "parameters": [
  8398. {
  8399. "name": "Form",
  8400. "in": "body",
  8401. "schema": {
  8402. "$ref": "#/definitions/CreateGPGKeyOption"
  8403. }
  8404. }
  8405. ],
  8406. "responses": {
  8407. "201": {
  8408. "$ref": "#/responses/GPGKey"
  8409. },
  8410. "422": {
  8411. "$ref": "#/responses/validationError"
  8412. }
  8413. }
  8414. }
  8415. },
  8416. "/user/gpg_keys/{id}": {
  8417. "get": {
  8418. "produces": [
  8419. "application/json"
  8420. ],
  8421. "tags": [
  8422. "user"
  8423. ],
  8424. "summary": "Get a GPG key",
  8425. "operationId": "userCurrentGetGPGKey",
  8426. "parameters": [
  8427. {
  8428. "type": "integer",
  8429. "format": "int64",
  8430. "description": "id of key to get",
  8431. "name": "id",
  8432. "in": "path",
  8433. "required": true
  8434. }
  8435. ],
  8436. "responses": {
  8437. "200": {
  8438. "$ref": "#/responses/GPGKey"
  8439. },
  8440. "404": {
  8441. "$ref": "#/responses/notFound"
  8442. }
  8443. }
  8444. },
  8445. "delete": {
  8446. "produces": [
  8447. "application/json"
  8448. ],
  8449. "tags": [
  8450. "user"
  8451. ],
  8452. "summary": "Remove a GPG key",
  8453. "operationId": "userCurrentDeleteGPGKey",
  8454. "parameters": [
  8455. {
  8456. "type": "integer",
  8457. "format": "int64",
  8458. "description": "id of key to delete",
  8459. "name": "id",
  8460. "in": "path",
  8461. "required": true
  8462. }
  8463. ],
  8464. "responses": {
  8465. "204": {
  8466. "$ref": "#/responses/empty"
  8467. },
  8468. "403": {
  8469. "$ref": "#/responses/forbidden"
  8470. }
  8471. }
  8472. }
  8473. },
  8474. "/user/keys": {
  8475. "get": {
  8476. "produces": [
  8477. "application/json"
  8478. ],
  8479. "tags": [
  8480. "user"
  8481. ],
  8482. "summary": "List the authenticated user's public keys",
  8483. "operationId": "userCurrentListKeys",
  8484. "parameters": [
  8485. {
  8486. "type": "string",
  8487. "description": "fingerprint of the key",
  8488. "name": "fingerprint",
  8489. "in": "query"
  8490. },
  8491. {
  8492. "type": "integer",
  8493. "description": "page number of results to return (1-based)",
  8494. "name": "page",
  8495. "in": "query"
  8496. },
  8497. {
  8498. "type": "integer",
  8499. "description": "page size of results, maximum page size is 50",
  8500. "name": "limit",
  8501. "in": "query"
  8502. }
  8503. ],
  8504. "responses": {
  8505. "200": {
  8506. "$ref": "#/responses/PublicKeyList"
  8507. }
  8508. }
  8509. },
  8510. "post": {
  8511. "consumes": [
  8512. "application/json"
  8513. ],
  8514. "produces": [
  8515. "application/json"
  8516. ],
  8517. "tags": [
  8518. "user"
  8519. ],
  8520. "summary": "Create a public key",
  8521. "operationId": "userCurrentPostKey",
  8522. "parameters": [
  8523. {
  8524. "name": "body",
  8525. "in": "body",
  8526. "schema": {
  8527. "$ref": "#/definitions/CreateKeyOption"
  8528. }
  8529. }
  8530. ],
  8531. "responses": {
  8532. "201": {
  8533. "$ref": "#/responses/PublicKey"
  8534. },
  8535. "422": {
  8536. "$ref": "#/responses/validationError"
  8537. }
  8538. }
  8539. }
  8540. },
  8541. "/user/keys/{id}": {
  8542. "get": {
  8543. "produces": [
  8544. "application/json"
  8545. ],
  8546. "tags": [
  8547. "user"
  8548. ],
  8549. "summary": "Get a public key",
  8550. "operationId": "userCurrentGetKey",
  8551. "parameters": [
  8552. {
  8553. "type": "integer",
  8554. "format": "int64",
  8555. "description": "id of key to get",
  8556. "name": "id",
  8557. "in": "path",
  8558. "required": true
  8559. }
  8560. ],
  8561. "responses": {
  8562. "200": {
  8563. "$ref": "#/responses/PublicKey"
  8564. },
  8565. "404": {
  8566. "$ref": "#/responses/notFound"
  8567. }
  8568. }
  8569. },
  8570. "delete": {
  8571. "produces": [
  8572. "application/json"
  8573. ],
  8574. "tags": [
  8575. "user"
  8576. ],
  8577. "summary": "Delete a public key",
  8578. "operationId": "userCurrentDeleteKey",
  8579. "parameters": [
  8580. {
  8581. "type": "integer",
  8582. "format": "int64",
  8583. "description": "id of key to delete",
  8584. "name": "id",
  8585. "in": "path",
  8586. "required": true
  8587. }
  8588. ],
  8589. "responses": {
  8590. "204": {
  8591. "$ref": "#/responses/empty"
  8592. },
  8593. "403": {
  8594. "$ref": "#/responses/forbidden"
  8595. },
  8596. "404": {
  8597. "$ref": "#/responses/notFound"
  8598. }
  8599. }
  8600. }
  8601. },
  8602. "/user/orgs": {
  8603. "get": {
  8604. "produces": [
  8605. "application/json"
  8606. ],
  8607. "tags": [
  8608. "organization"
  8609. ],
  8610. "summary": "List the current user's organizations",
  8611. "operationId": "orgListCurrentUserOrgs",
  8612. "parameters": [
  8613. {
  8614. "type": "integer",
  8615. "description": "page number of results to return (1-based)",
  8616. "name": "page",
  8617. "in": "query"
  8618. },
  8619. {
  8620. "type": "integer",
  8621. "description": "page size of results, maximum page size is 50",
  8622. "name": "limit",
  8623. "in": "query"
  8624. }
  8625. ],
  8626. "responses": {
  8627. "200": {
  8628. "$ref": "#/responses/OrganizationList"
  8629. }
  8630. }
  8631. }
  8632. },
  8633. "/user/repos": {
  8634. "get": {
  8635. "produces": [
  8636. "application/json"
  8637. ],
  8638. "tags": [
  8639. "user"
  8640. ],
  8641. "summary": "List the repos that the authenticated user owns or has access to",
  8642. "operationId": "userCurrentListRepos",
  8643. "parameters": [
  8644. {
  8645. "type": "integer",
  8646. "description": "page number of results to return (1-based)",
  8647. "name": "page",
  8648. "in": "query"
  8649. },
  8650. {
  8651. "type": "integer",
  8652. "description": "page size of results, maximum page size is 50",
  8653. "name": "limit",
  8654. "in": "query"
  8655. }
  8656. ],
  8657. "responses": {
  8658. "200": {
  8659. "$ref": "#/responses/RepositoryList"
  8660. }
  8661. }
  8662. },
  8663. "post": {
  8664. "consumes": [
  8665. "application/json"
  8666. ],
  8667. "produces": [
  8668. "application/json"
  8669. ],
  8670. "tags": [
  8671. "repository",
  8672. "user"
  8673. ],
  8674. "summary": "Create a repository",
  8675. "operationId": "createCurrentUserRepo",
  8676. "parameters": [
  8677. {
  8678. "name": "body",
  8679. "in": "body",
  8680. "schema": {
  8681. "$ref": "#/definitions/CreateRepoOption"
  8682. }
  8683. }
  8684. ],
  8685. "responses": {
  8686. "201": {
  8687. "$ref": "#/responses/Repository"
  8688. },
  8689. "409": {
  8690. "description": "The repository with the same name already exists."
  8691. },
  8692. "422": {
  8693. "$ref": "#/responses/validationError"
  8694. }
  8695. }
  8696. }
  8697. },
  8698. "/user/starred": {
  8699. "get": {
  8700. "produces": [
  8701. "application/json"
  8702. ],
  8703. "tags": [
  8704. "user"
  8705. ],
  8706. "summary": "The repos that the authenticated user has starred",
  8707. "operationId": "userCurrentListStarred",
  8708. "parameters": [
  8709. {
  8710. "type": "integer",
  8711. "description": "page number of results to return (1-based)",
  8712. "name": "page",
  8713. "in": "query"
  8714. },
  8715. {
  8716. "type": "integer",
  8717. "description": "page size of results, maximum page size is 50",
  8718. "name": "limit",
  8719. "in": "query"
  8720. }
  8721. ],
  8722. "responses": {
  8723. "200": {
  8724. "$ref": "#/responses/RepositoryList"
  8725. }
  8726. }
  8727. }
  8728. },
  8729. "/user/starred/{owner}/{repo}": {
  8730. "get": {
  8731. "tags": [
  8732. "user"
  8733. ],
  8734. "summary": "Whether the authenticated is starring the repo",
  8735. "operationId": "userCurrentCheckStarring",
  8736. "parameters": [
  8737. {
  8738. "type": "string",
  8739. "description": "owner of the repo",
  8740. "name": "owner",
  8741. "in": "path",
  8742. "required": true
  8743. },
  8744. {
  8745. "type": "string",
  8746. "description": "name of the repo",
  8747. "name": "repo",
  8748. "in": "path",
  8749. "required": true
  8750. }
  8751. ],
  8752. "responses": {
  8753. "204": {
  8754. "$ref": "#/responses/empty"
  8755. },
  8756. "404": {
  8757. "$ref": "#/responses/notFound"
  8758. }
  8759. }
  8760. },
  8761. "put": {
  8762. "tags": [
  8763. "user"
  8764. ],
  8765. "summary": "Star the given repo",
  8766. "operationId": "userCurrentPutStar",
  8767. "parameters": [
  8768. {
  8769. "type": "string",
  8770. "description": "owner of the repo to star",
  8771. "name": "owner",
  8772. "in": "path",
  8773. "required": true
  8774. },
  8775. {
  8776. "type": "string",
  8777. "description": "name of the repo to star",
  8778. "name": "repo",
  8779. "in": "path",
  8780. "required": true
  8781. }
  8782. ],
  8783. "responses": {
  8784. "204": {
  8785. "$ref": "#/responses/empty"
  8786. }
  8787. }
  8788. },
  8789. "delete": {
  8790. "tags": [
  8791. "user"
  8792. ],
  8793. "summary": "Unstar the given repo",
  8794. "operationId": "userCurrentDeleteStar",
  8795. "parameters": [
  8796. {
  8797. "type": "string",
  8798. "description": "owner of the repo to unstar",
  8799. "name": "owner",
  8800. "in": "path",
  8801. "required": true
  8802. },
  8803. {
  8804. "type": "string",
  8805. "description": "name of the repo to unstar",
  8806. "name": "repo",
  8807. "in": "path",
  8808. "required": true
  8809. }
  8810. ],
  8811. "responses": {
  8812. "204": {
  8813. "$ref": "#/responses/empty"
  8814. }
  8815. }
  8816. }
  8817. },
  8818. "/user/stopwatches": {
  8819. "get": {
  8820. "consumes": [
  8821. "application/json"
  8822. ],
  8823. "produces": [
  8824. "application/json"
  8825. ],
  8826. "tags": [
  8827. "user"
  8828. ],
  8829. "summary": "Get list of all existing stopwatches",
  8830. "operationId": "userGetStopWatches",
  8831. "parameters": [
  8832. {
  8833. "type": "integer",
  8834. "description": "page number of results to return (1-based)",
  8835. "name": "page",
  8836. "in": "query"
  8837. },
  8838. {
  8839. "type": "integer",
  8840. "description": "page size of results, maximum page size is 50",
  8841. "name": "limit",
  8842. "in": "query"
  8843. }
  8844. ],
  8845. "responses": {
  8846. "200": {
  8847. "$ref": "#/responses/StopWatchList"
  8848. }
  8849. }
  8850. }
  8851. },
  8852. "/user/subscriptions": {
  8853. "get": {
  8854. "produces": [
  8855. "application/json"
  8856. ],
  8857. "tags": [
  8858. "user"
  8859. ],
  8860. "summary": "List repositories watched by the authenticated user",
  8861. "operationId": "userCurrentListSubscriptions",
  8862. "parameters": [
  8863. {
  8864. "type": "integer",
  8865. "description": "page number of results to return (1-based)",
  8866. "name": "page",
  8867. "in": "query"
  8868. },
  8869. {
  8870. "type": "integer",
  8871. "description": "page size of results, maximum page size is 50",
  8872. "name": "limit",
  8873. "in": "query"
  8874. }
  8875. ],
  8876. "responses": {
  8877. "200": {
  8878. "$ref": "#/responses/RepositoryList"
  8879. }
  8880. }
  8881. }
  8882. },
  8883. "/user/teams": {
  8884. "get": {
  8885. "produces": [
  8886. "application/json"
  8887. ],
  8888. "tags": [
  8889. "user"
  8890. ],
  8891. "summary": "List all the teams a user belongs to",
  8892. "operationId": "userListTeams",
  8893. "parameters": [
  8894. {
  8895. "type": "integer",
  8896. "description": "page number of results to return (1-based)",
  8897. "name": "page",
  8898. "in": "query"
  8899. },
  8900. {
  8901. "type": "integer",
  8902. "description": "page size of results, maximum page size is 50",
  8903. "name": "limit",
  8904. "in": "query"
  8905. }
  8906. ],
  8907. "responses": {
  8908. "200": {
  8909. "$ref": "#/responses/TeamList"
  8910. }
  8911. }
  8912. }
  8913. },
  8914. "/user/times": {
  8915. "get": {
  8916. "produces": [
  8917. "application/json"
  8918. ],
  8919. "tags": [
  8920. "user"
  8921. ],
  8922. "summary": "List the current user's tracked times",
  8923. "operationId": "userCurrentTrackedTimes",
  8924. "parameters": [
  8925. {
  8926. "type": "string",
  8927. "format": "date-time",
  8928. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8929. "name": "since",
  8930. "in": "query"
  8931. },
  8932. {
  8933. "type": "string",
  8934. "format": "date-time",
  8935. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8936. "name": "before",
  8937. "in": "query"
  8938. }
  8939. ],
  8940. "responses": {
  8941. "200": {
  8942. "$ref": "#/responses/TrackedTimeList"
  8943. }
  8944. }
  8945. }
  8946. },
  8947. "/users/search": {
  8948. "get": {
  8949. "produces": [
  8950. "application/json"
  8951. ],
  8952. "tags": [
  8953. "user"
  8954. ],
  8955. "summary": "Search for users",
  8956. "operationId": "userSearch",
  8957. "parameters": [
  8958. {
  8959. "type": "string",
  8960. "description": "keyword",
  8961. "name": "q",
  8962. "in": "query"
  8963. },
  8964. {
  8965. "type": "integer",
  8966. "format": "int64",
  8967. "description": "ID of the user to search for",
  8968. "name": "uid",
  8969. "in": "query"
  8970. },
  8971. {
  8972. "type": "integer",
  8973. "description": "page number of results to return (1-based)",
  8974. "name": "page",
  8975. "in": "query"
  8976. },
  8977. {
  8978. "type": "integer",
  8979. "description": "page size of results, maximum page size is 50",
  8980. "name": "limit",
  8981. "in": "query"
  8982. }
  8983. ],
  8984. "responses": {
  8985. "200": {
  8986. "description": "SearchResults of a successful search",
  8987. "schema": {
  8988. "type": "object",
  8989. "properties": {
  8990. "data": {
  8991. "type": "array",
  8992. "items": {
  8993. "$ref": "#/definitions/User"
  8994. }
  8995. },
  8996. "ok": {
  8997. "type": "boolean"
  8998. }
  8999. }
  9000. }
  9001. }
  9002. }
  9003. }
  9004. },
  9005. "/users/{follower}/following/{followee}": {
  9006. "get": {
  9007. "tags": [
  9008. "user"
  9009. ],
  9010. "summary": "Check if one user is following another user",
  9011. "operationId": "userCheckFollowing",
  9012. "parameters": [
  9013. {
  9014. "type": "string",
  9015. "description": "username of following user",
  9016. "name": "follower",
  9017. "in": "path",
  9018. "required": true
  9019. },
  9020. {
  9021. "type": "string",
  9022. "description": "username of followed user",
  9023. "name": "followee",
  9024. "in": "path",
  9025. "required": true
  9026. }
  9027. ],
  9028. "responses": {
  9029. "204": {
  9030. "$ref": "#/responses/empty"
  9031. },
  9032. "404": {
  9033. "$ref": "#/responses/notFound"
  9034. }
  9035. }
  9036. }
  9037. },
  9038. "/users/{username}": {
  9039. "get": {
  9040. "produces": [
  9041. "application/json"
  9042. ],
  9043. "tags": [
  9044. "user"
  9045. ],
  9046. "summary": "Get a user",
  9047. "operationId": "userGet",
  9048. "parameters": [
  9049. {
  9050. "type": "string",
  9051. "description": "username of user to get",
  9052. "name": "username",
  9053. "in": "path",
  9054. "required": true
  9055. }
  9056. ],
  9057. "responses": {
  9058. "200": {
  9059. "$ref": "#/responses/User"
  9060. },
  9061. "404": {
  9062. "$ref": "#/responses/notFound"
  9063. }
  9064. }
  9065. }
  9066. },
  9067. "/users/{username}/followers": {
  9068. "get": {
  9069. "produces": [
  9070. "application/json"
  9071. ],
  9072. "tags": [
  9073. "user"
  9074. ],
  9075. "summary": "List the given user's followers",
  9076. "operationId": "userListFollowers",
  9077. "parameters": [
  9078. {
  9079. "type": "string",
  9080. "description": "username of user",
  9081. "name": "username",
  9082. "in": "path",
  9083. "required": true
  9084. },
  9085. {
  9086. "type": "integer",
  9087. "description": "page number of results to return (1-based)",
  9088. "name": "page",
  9089. "in": "query"
  9090. },
  9091. {
  9092. "type": "integer",
  9093. "description": "page size of results, maximum page size is 50",
  9094. "name": "limit",
  9095. "in": "query"
  9096. }
  9097. ],
  9098. "responses": {
  9099. "200": {
  9100. "$ref": "#/responses/UserList"
  9101. }
  9102. }
  9103. }
  9104. },
  9105. "/users/{username}/following": {
  9106. "get": {
  9107. "produces": [
  9108. "application/json"
  9109. ],
  9110. "tags": [
  9111. "user"
  9112. ],
  9113. "summary": "List the users that the given user is following",
  9114. "operationId": "userListFollowing",
  9115. "parameters": [
  9116. {
  9117. "type": "string",
  9118. "description": "username of user",
  9119. "name": "username",
  9120. "in": "path",
  9121. "required": true
  9122. },
  9123. {
  9124. "type": "integer",
  9125. "description": "page number of results to return (1-based)",
  9126. "name": "page",
  9127. "in": "query"
  9128. },
  9129. {
  9130. "type": "integer",
  9131. "description": "page size of results, maximum page size is 50",
  9132. "name": "limit",
  9133. "in": "query"
  9134. }
  9135. ],
  9136. "responses": {
  9137. "200": {
  9138. "$ref": "#/responses/UserList"
  9139. }
  9140. }
  9141. }
  9142. },
  9143. "/users/{username}/gpg_keys": {
  9144. "get": {
  9145. "produces": [
  9146. "application/json"
  9147. ],
  9148. "tags": [
  9149. "user"
  9150. ],
  9151. "summary": "List the given user's GPG keys",
  9152. "operationId": "userListGPGKeys",
  9153. "parameters": [
  9154. {
  9155. "type": "string",
  9156. "description": "username of user",
  9157. "name": "username",
  9158. "in": "path",
  9159. "required": true
  9160. },
  9161. {
  9162. "type": "integer",
  9163. "description": "page number of results to return (1-based)",
  9164. "name": "page",
  9165. "in": "query"
  9166. },
  9167. {
  9168. "type": "integer",
  9169. "description": "page size of results, maximum page size is 50",
  9170. "name": "limit",
  9171. "in": "query"
  9172. }
  9173. ],
  9174. "responses": {
  9175. "200": {
  9176. "$ref": "#/responses/GPGKeyList"
  9177. }
  9178. }
  9179. }
  9180. },
  9181. "/users/{username}/heatmap": {
  9182. "get": {
  9183. "produces": [
  9184. "application/json"
  9185. ],
  9186. "tags": [
  9187. "user"
  9188. ],
  9189. "summary": "Get a user's heatmap",
  9190. "operationId": "userGetHeatmapData",
  9191. "parameters": [
  9192. {
  9193. "type": "string",
  9194. "description": "username of user to get",
  9195. "name": "username",
  9196. "in": "path",
  9197. "required": true
  9198. }
  9199. ],
  9200. "responses": {
  9201. "200": {
  9202. "$ref": "#/responses/UserHeatmapData"
  9203. },
  9204. "404": {
  9205. "$ref": "#/responses/notFound"
  9206. }
  9207. }
  9208. }
  9209. },
  9210. "/users/{username}/keys": {
  9211. "get": {
  9212. "produces": [
  9213. "application/json"
  9214. ],
  9215. "tags": [
  9216. "user"
  9217. ],
  9218. "summary": "List the given user's public keys",
  9219. "operationId": "userListKeys",
  9220. "parameters": [
  9221. {
  9222. "type": "string",
  9223. "description": "username of user",
  9224. "name": "username",
  9225. "in": "path",
  9226. "required": true
  9227. },
  9228. {
  9229. "type": "string",
  9230. "description": "fingerprint of the key",
  9231. "name": "fingerprint",
  9232. "in": "query"
  9233. },
  9234. {
  9235. "type": "integer",
  9236. "description": "page number of results to return (1-based)",
  9237. "name": "page",
  9238. "in": "query"
  9239. },
  9240. {
  9241. "type": "integer",
  9242. "description": "page size of results, maximum page size is 50",
  9243. "name": "limit",
  9244. "in": "query"
  9245. }
  9246. ],
  9247. "responses": {
  9248. "200": {
  9249. "$ref": "#/responses/PublicKeyList"
  9250. }
  9251. }
  9252. }
  9253. },
  9254. "/users/{username}/orgs": {
  9255. "get": {
  9256. "produces": [
  9257. "application/json"
  9258. ],
  9259. "tags": [
  9260. "organization"
  9261. ],
  9262. "summary": "List a user's organizations",
  9263. "operationId": "orgListUserOrgs",
  9264. "parameters": [
  9265. {
  9266. "type": "string",
  9267. "description": "username of user",
  9268. "name": "username",
  9269. "in": "path",
  9270. "required": true
  9271. },
  9272. {
  9273. "type": "integer",
  9274. "description": "page number of results to return (1-based)",
  9275. "name": "page",
  9276. "in": "query"
  9277. },
  9278. {
  9279. "type": "integer",
  9280. "description": "page size of results, maximum page size is 50",
  9281. "name": "limit",
  9282. "in": "query"
  9283. }
  9284. ],
  9285. "responses": {
  9286. "200": {
  9287. "$ref": "#/responses/OrganizationList"
  9288. }
  9289. }
  9290. }
  9291. },
  9292. "/users/{username}/repos": {
  9293. "get": {
  9294. "produces": [
  9295. "application/json"
  9296. ],
  9297. "tags": [
  9298. "user"
  9299. ],
  9300. "summary": "List the repos owned by the given user",
  9301. "operationId": "userListRepos",
  9302. "parameters": [
  9303. {
  9304. "type": "string",
  9305. "description": "username of user",
  9306. "name": "username",
  9307. "in": "path",
  9308. "required": true
  9309. },
  9310. {
  9311. "type": "integer",
  9312. "description": "page number of results to return (1-based)",
  9313. "name": "page",
  9314. "in": "query"
  9315. },
  9316. {
  9317. "type": "integer",
  9318. "description": "page size of results, maximum page size is 50",
  9319. "name": "limit",
  9320. "in": "query"
  9321. }
  9322. ],
  9323. "responses": {
  9324. "200": {
  9325. "$ref": "#/responses/RepositoryList"
  9326. }
  9327. }
  9328. }
  9329. },
  9330. "/users/{username}/starred": {
  9331. "get": {
  9332. "produces": [
  9333. "application/json"
  9334. ],
  9335. "tags": [
  9336. "user"
  9337. ],
  9338. "summary": "The repos that the given user has starred",
  9339. "operationId": "userListStarred",
  9340. "parameters": [
  9341. {
  9342. "type": "string",
  9343. "description": "username of user",
  9344. "name": "username",
  9345. "in": "path",
  9346. "required": true
  9347. },
  9348. {
  9349. "type": "integer",
  9350. "description": "page number of results to return (1-based)",
  9351. "name": "page",
  9352. "in": "query"
  9353. },
  9354. {
  9355. "type": "integer",
  9356. "description": "page size of results, maximum page size is 50",
  9357. "name": "limit",
  9358. "in": "query"
  9359. }
  9360. ],
  9361. "responses": {
  9362. "200": {
  9363. "$ref": "#/responses/RepositoryList"
  9364. }
  9365. }
  9366. }
  9367. },
  9368. "/users/{username}/subscriptions": {
  9369. "get": {
  9370. "produces": [
  9371. "application/json"
  9372. ],
  9373. "tags": [
  9374. "user"
  9375. ],
  9376. "summary": "List the repositories watched by a user",
  9377. "operationId": "userListSubscriptions",
  9378. "parameters": [
  9379. {
  9380. "type": "string",
  9381. "description": "username of the user",
  9382. "name": "username",
  9383. "in": "path",
  9384. "required": true
  9385. },
  9386. {
  9387. "type": "integer",
  9388. "description": "page number of results to return (1-based)",
  9389. "name": "page",
  9390. "in": "query"
  9391. },
  9392. {
  9393. "type": "integer",
  9394. "description": "page size of results, maximum page size is 50",
  9395. "name": "limit",
  9396. "in": "query"
  9397. }
  9398. ],
  9399. "responses": {
  9400. "200": {
  9401. "$ref": "#/responses/RepositoryList"
  9402. }
  9403. }
  9404. }
  9405. },
  9406. "/users/{username}/tokens": {
  9407. "get": {
  9408. "produces": [
  9409. "application/json"
  9410. ],
  9411. "tags": [
  9412. "user"
  9413. ],
  9414. "summary": "List the authenticated user's access tokens",
  9415. "operationId": "userGetTokens",
  9416. "parameters": [
  9417. {
  9418. "type": "string",
  9419. "description": "username of user",
  9420. "name": "username",
  9421. "in": "path",
  9422. "required": true
  9423. },
  9424. {
  9425. "type": "integer",
  9426. "description": "page number of results to return (1-based)",
  9427. "name": "page",
  9428. "in": "query"
  9429. },
  9430. {
  9431. "type": "integer",
  9432. "description": "page size of results, maximum page size is 50",
  9433. "name": "limit",
  9434. "in": "query"
  9435. }
  9436. ],
  9437. "responses": {
  9438. "200": {
  9439. "$ref": "#/responses/AccessTokenList"
  9440. }
  9441. }
  9442. },
  9443. "post": {
  9444. "consumes": [
  9445. "application/json"
  9446. ],
  9447. "produces": [
  9448. "application/json"
  9449. ],
  9450. "tags": [
  9451. "user"
  9452. ],
  9453. "summary": "Create an access token",
  9454. "operationId": "userCreateToken",
  9455. "parameters": [
  9456. {
  9457. "type": "string",
  9458. "x-go-name": "Name",
  9459. "description": "username of user",
  9460. "name": "username",
  9461. "in": "path",
  9462. "required": true
  9463. },
  9464. {
  9465. "name": "accessToken",
  9466. "in": "body",
  9467. "schema": {
  9468. "type": "object",
  9469. "required": [
  9470. "name"
  9471. ],
  9472. "properties": {
  9473. "name": {
  9474. "type": "string"
  9475. }
  9476. }
  9477. }
  9478. }
  9479. ],
  9480. "responses": {
  9481. "200": {
  9482. "$ref": "#/responses/AccessToken"
  9483. }
  9484. }
  9485. }
  9486. },
  9487. "/users/{username}/tokens/{token}": {
  9488. "delete": {
  9489. "produces": [
  9490. "application/json"
  9491. ],
  9492. "tags": [
  9493. "user"
  9494. ],
  9495. "summary": "delete an access token",
  9496. "operationId": "userDeleteAccessToken",
  9497. "parameters": [
  9498. {
  9499. "type": "string",
  9500. "description": "username of user",
  9501. "name": "username",
  9502. "in": "path",
  9503. "required": true
  9504. },
  9505. {
  9506. "type": "integer",
  9507. "format": "int64",
  9508. "description": "token to be deleted",
  9509. "name": "token",
  9510. "in": "path",
  9511. "required": true
  9512. }
  9513. ],
  9514. "responses": {
  9515. "204": {
  9516. "$ref": "#/responses/empty"
  9517. }
  9518. }
  9519. }
  9520. },
  9521. "/version": {
  9522. "get": {
  9523. "produces": [
  9524. "application/json"
  9525. ],
  9526. "tags": [
  9527. "miscellaneous"
  9528. ],
  9529. "summary": "Returns the version of the Gitea application",
  9530. "operationId": "getVersion",
  9531. "responses": {
  9532. "200": {
  9533. "$ref": "#/responses/ServerVersion"
  9534. }
  9535. }
  9536. }
  9537. }
  9538. },
  9539. "definitions": {
  9540. "APIError": {
  9541. "description": "APIError is an api error with a message",
  9542. "type": "object",
  9543. "properties": {
  9544. "message": {
  9545. "type": "string",
  9546. "x-go-name": "Message"
  9547. },
  9548. "url": {
  9549. "type": "string",
  9550. "x-go-name": "URL"
  9551. }
  9552. },
  9553. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9554. },
  9555. "AccessToken": {
  9556. "type": "object",
  9557. "title": "AccessToken represents an API access token.",
  9558. "properties": {
  9559. "id": {
  9560. "type": "integer",
  9561. "format": "int64",
  9562. "x-go-name": "ID"
  9563. },
  9564. "name": {
  9565. "type": "string",
  9566. "x-go-name": "Name"
  9567. },
  9568. "sha1": {
  9569. "type": "string",
  9570. "x-go-name": "Token"
  9571. },
  9572. "token_last_eight": {
  9573. "type": "string",
  9574. "x-go-name": "TokenLastEight"
  9575. }
  9576. },
  9577. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9578. },
  9579. "AddCollaboratorOption": {
  9580. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  9581. "type": "object",
  9582. "properties": {
  9583. "permission": {
  9584. "type": "string",
  9585. "x-go-name": "Permission"
  9586. }
  9587. },
  9588. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9589. },
  9590. "AddTimeOption": {
  9591. "description": "AddTimeOption options for adding time to an issue",
  9592. "type": "object",
  9593. "required": [
  9594. "time"
  9595. ],
  9596. "properties": {
  9597. "created": {
  9598. "type": "string",
  9599. "format": "date-time",
  9600. "x-go-name": "Created"
  9601. },
  9602. "time": {
  9603. "description": "time in seconds",
  9604. "type": "integer",
  9605. "format": "int64",
  9606. "x-go-name": "Time"
  9607. },
  9608. "user_name": {
  9609. "description": "User who spent the time (optional)",
  9610. "type": "string",
  9611. "x-go-name": "User"
  9612. }
  9613. },
  9614. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9615. },
  9616. "AnnotatedTag": {
  9617. "description": "AnnotatedTag represents an annotated tag",
  9618. "type": "object",
  9619. "properties": {
  9620. "message": {
  9621. "type": "string",
  9622. "x-go-name": "Message"
  9623. },
  9624. "object": {
  9625. "$ref": "#/definitions/AnnotatedTagObject"
  9626. },
  9627. "sha": {
  9628. "type": "string",
  9629. "x-go-name": "SHA"
  9630. },
  9631. "tag": {
  9632. "type": "string",
  9633. "x-go-name": "Tag"
  9634. },
  9635. "tagger": {
  9636. "$ref": "#/definitions/CommitUser"
  9637. },
  9638. "url": {
  9639. "type": "string",
  9640. "x-go-name": "URL"
  9641. },
  9642. "verification": {
  9643. "$ref": "#/definitions/PayloadCommitVerification"
  9644. }
  9645. },
  9646. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9647. },
  9648. "AnnotatedTagObject": {
  9649. "description": "AnnotatedTagObject contains meta information of the tag object",
  9650. "type": "object",
  9651. "properties": {
  9652. "sha": {
  9653. "type": "string",
  9654. "x-go-name": "SHA"
  9655. },
  9656. "type": {
  9657. "type": "string",
  9658. "x-go-name": "Type"
  9659. },
  9660. "url": {
  9661. "type": "string",
  9662. "x-go-name": "URL"
  9663. }
  9664. },
  9665. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9666. },
  9667. "Attachment": {
  9668. "description": "Attachment a generic attachment",
  9669. "type": "object",
  9670. "properties": {
  9671. "browser_download_url": {
  9672. "type": "string",
  9673. "x-go-name": "DownloadURL"
  9674. },
  9675. "created_at": {
  9676. "type": "string",
  9677. "format": "date-time",
  9678. "x-go-name": "Created"
  9679. },
  9680. "download_count": {
  9681. "type": "integer",
  9682. "format": "int64",
  9683. "x-go-name": "DownloadCount"
  9684. },
  9685. "id": {
  9686. "type": "integer",
  9687. "format": "int64",
  9688. "x-go-name": "ID"
  9689. },
  9690. "name": {
  9691. "type": "string",
  9692. "x-go-name": "Name"
  9693. },
  9694. "size": {
  9695. "type": "integer",
  9696. "format": "int64",
  9697. "x-go-name": "Size"
  9698. },
  9699. "uuid": {
  9700. "type": "string",
  9701. "x-go-name": "UUID"
  9702. }
  9703. },
  9704. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9705. },
  9706. "Branch": {
  9707. "description": "Branch represents a repository branch",
  9708. "type": "object",
  9709. "properties": {
  9710. "commit": {
  9711. "$ref": "#/definitions/PayloadCommit"
  9712. },
  9713. "effective_branch_protection_name": {
  9714. "type": "string",
  9715. "x-go-name": "EffectiveBranchProtectionName"
  9716. },
  9717. "enable_status_check": {
  9718. "type": "boolean",
  9719. "x-go-name": "EnableStatusCheck"
  9720. },
  9721. "name": {
  9722. "type": "string",
  9723. "x-go-name": "Name"
  9724. },
  9725. "protected": {
  9726. "type": "boolean",
  9727. "x-go-name": "Protected"
  9728. },
  9729. "required_approvals": {
  9730. "type": "integer",
  9731. "format": "int64",
  9732. "x-go-name": "RequiredApprovals"
  9733. },
  9734. "status_check_contexts": {
  9735. "type": "array",
  9736. "items": {
  9737. "type": "string"
  9738. },
  9739. "x-go-name": "StatusCheckContexts"
  9740. },
  9741. "user_can_merge": {
  9742. "type": "boolean",
  9743. "x-go-name": "UserCanMerge"
  9744. },
  9745. "user_can_push": {
  9746. "type": "boolean",
  9747. "x-go-name": "UserCanPush"
  9748. }
  9749. },
  9750. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9751. },
  9752. "BranchProtection": {
  9753. "description": "BranchProtection represents a branch protection for a repository",
  9754. "type": "object",
  9755. "properties": {
  9756. "approvals_whitelist_teams": {
  9757. "type": "array",
  9758. "items": {
  9759. "type": "string"
  9760. },
  9761. "x-go-name": "ApprovalsWhitelistTeams"
  9762. },
  9763. "approvals_whitelist_username": {
  9764. "type": "array",
  9765. "items": {
  9766. "type": "string"
  9767. },
  9768. "x-go-name": "ApprovalsWhitelistUsernames"
  9769. },
  9770. "block_on_rejected_reviews": {
  9771. "type": "boolean",
  9772. "x-go-name": "BlockOnRejectedReviews"
  9773. },
  9774. "branch_name": {
  9775. "type": "string",
  9776. "x-go-name": "BranchName"
  9777. },
  9778. "created_at": {
  9779. "type": "string",
  9780. "format": "date-time",
  9781. "x-go-name": "Created"
  9782. },
  9783. "dismiss_stale_approvals": {
  9784. "type": "boolean",
  9785. "x-go-name": "DismissStaleApprovals"
  9786. },
  9787. "enable_approvals_whitelist": {
  9788. "type": "boolean",
  9789. "x-go-name": "EnableApprovalsWhitelist"
  9790. },
  9791. "enable_merge_whitelist": {
  9792. "type": "boolean",
  9793. "x-go-name": "EnableMergeWhitelist"
  9794. },
  9795. "enable_push": {
  9796. "type": "boolean",
  9797. "x-go-name": "EnablePush"
  9798. },
  9799. "enable_push_whitelist": {
  9800. "type": "boolean",
  9801. "x-go-name": "EnablePushWhitelist"
  9802. },
  9803. "enable_status_check": {
  9804. "type": "boolean",
  9805. "x-go-name": "EnableStatusCheck"
  9806. },
  9807. "merge_whitelist_teams": {
  9808. "type": "array",
  9809. "items": {
  9810. "type": "string"
  9811. },
  9812. "x-go-name": "MergeWhitelistTeams"
  9813. },
  9814. "merge_whitelist_usernames": {
  9815. "type": "array",
  9816. "items": {
  9817. "type": "string"
  9818. },
  9819. "x-go-name": "MergeWhitelistUsernames"
  9820. },
  9821. "push_whitelist_deploy_keys": {
  9822. "type": "boolean",
  9823. "x-go-name": "PushWhitelistDeployKeys"
  9824. },
  9825. "push_whitelist_teams": {
  9826. "type": "array",
  9827. "items": {
  9828. "type": "string"
  9829. },
  9830. "x-go-name": "PushWhitelistTeams"
  9831. },
  9832. "push_whitelist_usernames": {
  9833. "type": "array",
  9834. "items": {
  9835. "type": "string"
  9836. },
  9837. "x-go-name": "PushWhitelistUsernames"
  9838. },
  9839. "require_signed_commits": {
  9840. "type": "boolean",
  9841. "x-go-name": "RequireSignedCommits"
  9842. },
  9843. "required_approvals": {
  9844. "type": "integer",
  9845. "format": "int64",
  9846. "x-go-name": "RequiredApprovals"
  9847. },
  9848. "status_check_contexts": {
  9849. "type": "array",
  9850. "items": {
  9851. "type": "string"
  9852. },
  9853. "x-go-name": "StatusCheckContexts"
  9854. },
  9855. "updated_at": {
  9856. "type": "string",
  9857. "format": "date-time",
  9858. "x-go-name": "Updated"
  9859. }
  9860. },
  9861. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9862. },
  9863. "Comment": {
  9864. "description": "Comment represents a comment on a commit or issue",
  9865. "type": "object",
  9866. "properties": {
  9867. "body": {
  9868. "type": "string",
  9869. "x-go-name": "Body"
  9870. },
  9871. "created_at": {
  9872. "type": "string",
  9873. "format": "date-time",
  9874. "x-go-name": "Created"
  9875. },
  9876. "html_url": {
  9877. "type": "string",
  9878. "x-go-name": "HTMLURL"
  9879. },
  9880. "id": {
  9881. "type": "integer",
  9882. "format": "int64",
  9883. "x-go-name": "ID"
  9884. },
  9885. "issue_url": {
  9886. "type": "string",
  9887. "x-go-name": "IssueURL"
  9888. },
  9889. "original_author": {
  9890. "type": "string",
  9891. "x-go-name": "OriginalAuthor"
  9892. },
  9893. "original_author_id": {
  9894. "type": "integer",
  9895. "format": "int64",
  9896. "x-go-name": "OriginalAuthorID"
  9897. },
  9898. "pull_request_url": {
  9899. "type": "string",
  9900. "x-go-name": "PRURL"
  9901. },
  9902. "updated_at": {
  9903. "type": "string",
  9904. "format": "date-time",
  9905. "x-go-name": "Updated"
  9906. },
  9907. "user": {
  9908. "$ref": "#/definitions/User"
  9909. }
  9910. },
  9911. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9912. },
  9913. "Commit": {
  9914. "type": "object",
  9915. "title": "Commit contains information generated from a Git commit.",
  9916. "properties": {
  9917. "author": {
  9918. "$ref": "#/definitions/User"
  9919. },
  9920. "commit": {
  9921. "$ref": "#/definitions/RepoCommit"
  9922. },
  9923. "committer": {
  9924. "$ref": "#/definitions/User"
  9925. },
  9926. "html_url": {
  9927. "type": "string",
  9928. "x-go-name": "HTMLURL"
  9929. },
  9930. "parents": {
  9931. "type": "array",
  9932. "items": {
  9933. "$ref": "#/definitions/CommitMeta"
  9934. },
  9935. "x-go-name": "Parents"
  9936. },
  9937. "sha": {
  9938. "type": "string",
  9939. "x-go-name": "SHA"
  9940. },
  9941. "url": {
  9942. "type": "string",
  9943. "x-go-name": "URL"
  9944. }
  9945. },
  9946. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9947. },
  9948. "CommitDateOptions": {
  9949. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  9950. "type": "object",
  9951. "properties": {
  9952. "author": {
  9953. "type": "string",
  9954. "format": "date-time",
  9955. "x-go-name": "Author"
  9956. },
  9957. "committer": {
  9958. "type": "string",
  9959. "format": "date-time",
  9960. "x-go-name": "Committer"
  9961. }
  9962. },
  9963. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9964. },
  9965. "CommitMeta": {
  9966. "type": "object",
  9967. "title": "CommitMeta contains meta information of a commit in terms of API.",
  9968. "properties": {
  9969. "sha": {
  9970. "type": "string",
  9971. "x-go-name": "SHA"
  9972. },
  9973. "url": {
  9974. "type": "string",
  9975. "x-go-name": "URL"
  9976. }
  9977. },
  9978. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9979. },
  9980. "CommitUser": {
  9981. "type": "object",
  9982. "title": "CommitUser contains information of a user in the context of a commit.",
  9983. "properties": {
  9984. "date": {
  9985. "type": "string",
  9986. "x-go-name": "Date"
  9987. },
  9988. "email": {
  9989. "type": "string",
  9990. "format": "email",
  9991. "x-go-name": "Email"
  9992. },
  9993. "name": {
  9994. "type": "string",
  9995. "x-go-name": "Name"
  9996. }
  9997. },
  9998. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9999. },
  10000. "ContentsResponse": {
  10001. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  10002. "type": "object",
  10003. "properties": {
  10004. "_links": {
  10005. "$ref": "#/definitions/FileLinksResponse"
  10006. },
  10007. "content": {
  10008. "description": "`content` is populated when `type` is `file`, otherwise null",
  10009. "type": "string",
  10010. "x-go-name": "Content"
  10011. },
  10012. "download_url": {
  10013. "type": "string",
  10014. "x-go-name": "DownloadURL"
  10015. },
  10016. "encoding": {
  10017. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  10018. "type": "string",
  10019. "x-go-name": "Encoding"
  10020. },
  10021. "git_url": {
  10022. "type": "string",
  10023. "x-go-name": "GitURL"
  10024. },
  10025. "html_url": {
  10026. "type": "string",
  10027. "x-go-name": "HTMLURL"
  10028. },
  10029. "name": {
  10030. "type": "string",
  10031. "x-go-name": "Name"
  10032. },
  10033. "path": {
  10034. "type": "string",
  10035. "x-go-name": "Path"
  10036. },
  10037. "sha": {
  10038. "type": "string",
  10039. "x-go-name": "SHA"
  10040. },
  10041. "size": {
  10042. "type": "integer",
  10043. "format": "int64",
  10044. "x-go-name": "Size"
  10045. },
  10046. "submodule_git_url": {
  10047. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  10048. "type": "string",
  10049. "x-go-name": "SubmoduleGitURL"
  10050. },
  10051. "target": {
  10052. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  10053. "type": "string",
  10054. "x-go-name": "Target"
  10055. },
  10056. "type": {
  10057. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  10058. "type": "string",
  10059. "x-go-name": "Type"
  10060. },
  10061. "url": {
  10062. "type": "string",
  10063. "x-go-name": "URL"
  10064. }
  10065. },
  10066. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10067. },
  10068. "CreateBranchProtectionOption": {
  10069. "description": "CreateBranchProtectionOption options for creating a branch protection",
  10070. "type": "object",
  10071. "properties": {
  10072. "approvals_whitelist_teams": {
  10073. "type": "array",
  10074. "items": {
  10075. "type": "string"
  10076. },
  10077. "x-go-name": "ApprovalsWhitelistTeams"
  10078. },
  10079. "approvals_whitelist_username": {
  10080. "type": "array",
  10081. "items": {
  10082. "type": "string"
  10083. },
  10084. "x-go-name": "ApprovalsWhitelistUsernames"
  10085. },
  10086. "block_on_rejected_reviews": {
  10087. "type": "boolean",
  10088. "x-go-name": "BlockOnRejectedReviews"
  10089. },
  10090. "branch_name": {
  10091. "type": "string",
  10092. "x-go-name": "BranchName"
  10093. },
  10094. "dismiss_stale_approvals": {
  10095. "type": "boolean",
  10096. "x-go-name": "DismissStaleApprovals"
  10097. },
  10098. "enable_approvals_whitelist": {
  10099. "type": "boolean",
  10100. "x-go-name": "EnableApprovalsWhitelist"
  10101. },
  10102. "enable_merge_whitelist": {
  10103. "type": "boolean",
  10104. "x-go-name": "EnableMergeWhitelist"
  10105. },
  10106. "enable_push": {
  10107. "type": "boolean",
  10108. "x-go-name": "EnablePush"
  10109. },
  10110. "enable_push_whitelist": {
  10111. "type": "boolean",
  10112. "x-go-name": "EnablePushWhitelist"
  10113. },
  10114. "enable_status_check": {
  10115. "type": "boolean",
  10116. "x-go-name": "EnableStatusCheck"
  10117. },
  10118. "merge_whitelist_teams": {
  10119. "type": "array",
  10120. "items": {
  10121. "type": "string"
  10122. },
  10123. "x-go-name": "MergeWhitelistTeams"
  10124. },
  10125. "merge_whitelist_usernames": {
  10126. "type": "array",
  10127. "items": {
  10128. "type": "string"
  10129. },
  10130. "x-go-name": "MergeWhitelistUsernames"
  10131. },
  10132. "push_whitelist_deploy_keys": {
  10133. "type": "boolean",
  10134. "x-go-name": "PushWhitelistDeployKeys"
  10135. },
  10136. "push_whitelist_teams": {
  10137. "type": "array",
  10138. "items": {
  10139. "type": "string"
  10140. },
  10141. "x-go-name": "PushWhitelistTeams"
  10142. },
  10143. "push_whitelist_usernames": {
  10144. "type": "array",
  10145. "items": {
  10146. "type": "string"
  10147. },
  10148. "x-go-name": "PushWhitelistUsernames"
  10149. },
  10150. "require_signed_commits": {
  10151. "type": "boolean",
  10152. "x-go-name": "RequireSignedCommits"
  10153. },
  10154. "required_approvals": {
  10155. "type": "integer",
  10156. "format": "int64",
  10157. "x-go-name": "RequiredApprovals"
  10158. },
  10159. "status_check_contexts": {
  10160. "type": "array",
  10161. "items": {
  10162. "type": "string"
  10163. },
  10164. "x-go-name": "StatusCheckContexts"
  10165. }
  10166. },
  10167. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10168. },
  10169. "CreateEmailOption": {
  10170. "description": "CreateEmailOption options when creating email addresses",
  10171. "type": "object",
  10172. "properties": {
  10173. "emails": {
  10174. "description": "email addresses to add",
  10175. "type": "array",
  10176. "items": {
  10177. "type": "string"
  10178. },
  10179. "x-go-name": "Emails"
  10180. }
  10181. },
  10182. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10183. },
  10184. "CreateFileOptions": {
  10185. "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)",
  10186. "type": "object",
  10187. "required": [
  10188. "content"
  10189. ],
  10190. "properties": {
  10191. "author": {
  10192. "$ref": "#/definitions/Identity"
  10193. },
  10194. "branch": {
  10195. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10196. "type": "string",
  10197. "x-go-name": "BranchName"
  10198. },
  10199. "committer": {
  10200. "$ref": "#/definitions/Identity"
  10201. },
  10202. "content": {
  10203. "description": "content must be base64 encoded",
  10204. "type": "string",
  10205. "x-go-name": "Content"
  10206. },
  10207. "dates": {
  10208. "$ref": "#/definitions/CommitDateOptions"
  10209. },
  10210. "message": {
  10211. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10212. "type": "string",
  10213. "x-go-name": "Message"
  10214. },
  10215. "new_branch": {
  10216. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10217. "type": "string",
  10218. "x-go-name": "NewBranchName"
  10219. }
  10220. },
  10221. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10222. },
  10223. "CreateForkOption": {
  10224. "description": "CreateForkOption options for creating a fork",
  10225. "type": "object",
  10226. "properties": {
  10227. "organization": {
  10228. "description": "organization name, if forking into an organization",
  10229. "type": "string",
  10230. "x-go-name": "Organization"
  10231. }
  10232. },
  10233. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10234. },
  10235. "CreateGPGKeyOption": {
  10236. "description": "CreateGPGKeyOption options create user GPG key",
  10237. "type": "object",
  10238. "required": [
  10239. "armored_public_key"
  10240. ],
  10241. "properties": {
  10242. "armored_public_key": {
  10243. "description": "An armored GPG key to add",
  10244. "type": "string",
  10245. "uniqueItems": true,
  10246. "x-go-name": "ArmoredKey"
  10247. }
  10248. },
  10249. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10250. },
  10251. "CreateHookOption": {
  10252. "description": "CreateHookOption options when create a hook",
  10253. "type": "object",
  10254. "required": [
  10255. "type",
  10256. "config"
  10257. ],
  10258. "properties": {
  10259. "active": {
  10260. "type": "boolean",
  10261. "default": false,
  10262. "x-go-name": "Active"
  10263. },
  10264. "branch_filter": {
  10265. "type": "string",
  10266. "x-go-name": "BranchFilter"
  10267. },
  10268. "config": {
  10269. "$ref": "#/definitions/CreateHookOptionConfig"
  10270. },
  10271. "events": {
  10272. "type": "array",
  10273. "items": {
  10274. "type": "string"
  10275. },
  10276. "x-go-name": "Events"
  10277. },
  10278. "type": {
  10279. "type": "string",
  10280. "enum": [
  10281. "dingtalk",
  10282. "discord",
  10283. "gitea",
  10284. "gogs",
  10285. "msteams",
  10286. "slack",
  10287. "telegram",
  10288. "feishu"
  10289. ],
  10290. "x-go-name": "Type"
  10291. }
  10292. },
  10293. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10294. },
  10295. "CreateHookOptionConfig": {
  10296. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  10297. "type": "object",
  10298. "additionalProperties": {
  10299. "type": "string"
  10300. },
  10301. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10302. },
  10303. "CreateIssueCommentOption": {
  10304. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  10305. "type": "object",
  10306. "required": [
  10307. "body"
  10308. ],
  10309. "properties": {
  10310. "body": {
  10311. "type": "string",
  10312. "x-go-name": "Body"
  10313. }
  10314. },
  10315. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10316. },
  10317. "CreateIssueOption": {
  10318. "description": "CreateIssueOption options to create one issue",
  10319. "type": "object",
  10320. "required": [
  10321. "title"
  10322. ],
  10323. "properties": {
  10324. "assignee": {
  10325. "description": "username of assignee",
  10326. "type": "string",
  10327. "x-go-name": "Assignee"
  10328. },
  10329. "assignees": {
  10330. "type": "array",
  10331. "items": {
  10332. "type": "string"
  10333. },
  10334. "x-go-name": "Assignees"
  10335. },
  10336. "body": {
  10337. "type": "string",
  10338. "x-go-name": "Body"
  10339. },
  10340. "closed": {
  10341. "type": "boolean",
  10342. "x-go-name": "Closed"
  10343. },
  10344. "due_date": {
  10345. "type": "string",
  10346. "format": "date-time",
  10347. "x-go-name": "Deadline"
  10348. },
  10349. "labels": {
  10350. "description": "list of label ids",
  10351. "type": "array",
  10352. "items": {
  10353. "type": "integer",
  10354. "format": "int64"
  10355. },
  10356. "x-go-name": "Labels"
  10357. },
  10358. "milestone": {
  10359. "description": "milestone id",
  10360. "type": "integer",
  10361. "format": "int64",
  10362. "x-go-name": "Milestone"
  10363. },
  10364. "title": {
  10365. "type": "string",
  10366. "x-go-name": "Title"
  10367. }
  10368. },
  10369. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10370. },
  10371. "CreateKeyOption": {
  10372. "description": "CreateKeyOption options when creating a key",
  10373. "type": "object",
  10374. "required": [
  10375. "title",
  10376. "key"
  10377. ],
  10378. "properties": {
  10379. "key": {
  10380. "description": "An armored SSH key to add",
  10381. "type": "string",
  10382. "uniqueItems": true,
  10383. "x-go-name": "Key"
  10384. },
  10385. "read_only": {
  10386. "description": "Describe if the key has only read access or read/write",
  10387. "type": "boolean",
  10388. "x-go-name": "ReadOnly"
  10389. },
  10390. "title": {
  10391. "description": "Title of the key to add",
  10392. "type": "string",
  10393. "uniqueItems": true,
  10394. "x-go-name": "Title"
  10395. }
  10396. },
  10397. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10398. },
  10399. "CreateLabelOption": {
  10400. "description": "CreateLabelOption options for creating a label",
  10401. "type": "object",
  10402. "required": [
  10403. "name",
  10404. "color"
  10405. ],
  10406. "properties": {
  10407. "color": {
  10408. "type": "string",
  10409. "x-go-name": "Color",
  10410. "example": "#00aabb"
  10411. },
  10412. "description": {
  10413. "type": "string",
  10414. "x-go-name": "Description"
  10415. },
  10416. "name": {
  10417. "type": "string",
  10418. "x-go-name": "Name"
  10419. }
  10420. },
  10421. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10422. },
  10423. "CreateMilestoneOption": {
  10424. "description": "CreateMilestoneOption options for creating a milestone",
  10425. "type": "object",
  10426. "properties": {
  10427. "description": {
  10428. "type": "string",
  10429. "x-go-name": "Description"
  10430. },
  10431. "due_on": {
  10432. "type": "string",
  10433. "format": "date-time",
  10434. "x-go-name": "Deadline"
  10435. },
  10436. "title": {
  10437. "type": "string",
  10438. "x-go-name": "Title"
  10439. }
  10440. },
  10441. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10442. },
  10443. "CreateOAuth2ApplicationOptions": {
  10444. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  10445. "type": "object",
  10446. "properties": {
  10447. "name": {
  10448. "type": "string",
  10449. "x-go-name": "Name"
  10450. },
  10451. "redirect_uris": {
  10452. "type": "array",
  10453. "items": {
  10454. "type": "string"
  10455. },
  10456. "x-go-name": "RedirectURIs"
  10457. }
  10458. },
  10459. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10460. },
  10461. "CreateOrgOption": {
  10462. "description": "CreateOrgOption options for creating an organization",
  10463. "type": "object",
  10464. "required": [
  10465. "username"
  10466. ],
  10467. "properties": {
  10468. "description": {
  10469. "type": "string",
  10470. "x-go-name": "Description"
  10471. },
  10472. "full_name": {
  10473. "type": "string",
  10474. "x-go-name": "FullName"
  10475. },
  10476. "location": {
  10477. "type": "string",
  10478. "x-go-name": "Location"
  10479. },
  10480. "repo_admin_change_team_access": {
  10481. "type": "boolean",
  10482. "x-go-name": "RepoAdminChangeTeamAccess"
  10483. },
  10484. "username": {
  10485. "type": "string",
  10486. "x-go-name": "UserName"
  10487. },
  10488. "visibility": {
  10489. "description": "possible values are `public` (default), `limited` or `private`",
  10490. "type": "string",
  10491. "enum": [
  10492. "public",
  10493. "limited",
  10494. "private"
  10495. ],
  10496. "x-go-name": "Visibility"
  10497. },
  10498. "website": {
  10499. "type": "string",
  10500. "x-go-name": "Website"
  10501. }
  10502. },
  10503. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10504. },
  10505. "CreatePullRequestOption": {
  10506. "description": "CreatePullRequestOption options when creating a pull request",
  10507. "type": "object",
  10508. "properties": {
  10509. "assignee": {
  10510. "type": "string",
  10511. "x-go-name": "Assignee"
  10512. },
  10513. "assignees": {
  10514. "type": "array",
  10515. "items": {
  10516. "type": "string"
  10517. },
  10518. "x-go-name": "Assignees"
  10519. },
  10520. "base": {
  10521. "type": "string",
  10522. "x-go-name": "Base"
  10523. },
  10524. "body": {
  10525. "type": "string",
  10526. "x-go-name": "Body"
  10527. },
  10528. "due_date": {
  10529. "type": "string",
  10530. "format": "date-time",
  10531. "x-go-name": "Deadline"
  10532. },
  10533. "head": {
  10534. "type": "string",
  10535. "x-go-name": "Head"
  10536. },
  10537. "labels": {
  10538. "type": "array",
  10539. "items": {
  10540. "type": "integer",
  10541. "format": "int64"
  10542. },
  10543. "x-go-name": "Labels"
  10544. },
  10545. "milestone": {
  10546. "type": "integer",
  10547. "format": "int64",
  10548. "x-go-name": "Milestone"
  10549. },
  10550. "title": {
  10551. "type": "string",
  10552. "x-go-name": "Title"
  10553. }
  10554. },
  10555. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10556. },
  10557. "CreateReleaseOption": {
  10558. "description": "CreateReleaseOption options when creating a release",
  10559. "type": "object",
  10560. "required": [
  10561. "tag_name"
  10562. ],
  10563. "properties": {
  10564. "body": {
  10565. "type": "string",
  10566. "x-go-name": "Note"
  10567. },
  10568. "draft": {
  10569. "type": "boolean",
  10570. "x-go-name": "IsDraft"
  10571. },
  10572. "name": {
  10573. "type": "string",
  10574. "x-go-name": "Title"
  10575. },
  10576. "prerelease": {
  10577. "type": "boolean",
  10578. "x-go-name": "IsPrerelease"
  10579. },
  10580. "tag_name": {
  10581. "type": "string",
  10582. "x-go-name": "TagName"
  10583. },
  10584. "target_commitish": {
  10585. "type": "string",
  10586. "x-go-name": "Target"
  10587. }
  10588. },
  10589. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10590. },
  10591. "CreateRepoOption": {
  10592. "description": "CreateRepoOption options when creating repository",
  10593. "type": "object",
  10594. "required": [
  10595. "name"
  10596. ],
  10597. "properties": {
  10598. "auto_init": {
  10599. "description": "Whether the repository should be auto-intialized?",
  10600. "type": "boolean",
  10601. "x-go-name": "AutoInit"
  10602. },
  10603. "description": {
  10604. "description": "Description of the repository to create",
  10605. "type": "string",
  10606. "x-go-name": "Description"
  10607. },
  10608. "gitignores": {
  10609. "description": "Gitignores to use",
  10610. "type": "string",
  10611. "x-go-name": "Gitignores"
  10612. },
  10613. "issue_labels": {
  10614. "description": "Issue Label set to use",
  10615. "type": "string",
  10616. "x-go-name": "IssueLabels"
  10617. },
  10618. "license": {
  10619. "description": "License to use",
  10620. "type": "string",
  10621. "x-go-name": "License"
  10622. },
  10623. "name": {
  10624. "description": "Name of the repository to create",
  10625. "type": "string",
  10626. "uniqueItems": true,
  10627. "x-go-name": "Name"
  10628. },
  10629. "private": {
  10630. "description": "Whether the repository is private",
  10631. "type": "boolean",
  10632. "x-go-name": "Private"
  10633. },
  10634. "readme": {
  10635. "description": "Readme of the repository to create",
  10636. "type": "string",
  10637. "x-go-name": "Readme"
  10638. }
  10639. },
  10640. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10641. },
  10642. "CreateStatusOption": {
  10643. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  10644. "type": "object",
  10645. "properties": {
  10646. "context": {
  10647. "type": "string",
  10648. "x-go-name": "Context"
  10649. },
  10650. "description": {
  10651. "type": "string",
  10652. "x-go-name": "Description"
  10653. },
  10654. "state": {
  10655. "$ref": "#/definitions/StatusState"
  10656. },
  10657. "target_url": {
  10658. "type": "string",
  10659. "x-go-name": "TargetURL"
  10660. }
  10661. },
  10662. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10663. },
  10664. "CreateTeamOption": {
  10665. "description": "CreateTeamOption options for creating a team",
  10666. "type": "object",
  10667. "required": [
  10668. "name"
  10669. ],
  10670. "properties": {
  10671. "can_create_org_repo": {
  10672. "type": "boolean",
  10673. "x-go-name": "CanCreateOrgRepo"
  10674. },
  10675. "description": {
  10676. "type": "string",
  10677. "x-go-name": "Description"
  10678. },
  10679. "includes_all_repositories": {
  10680. "type": "boolean",
  10681. "x-go-name": "IncludesAllRepositories"
  10682. },
  10683. "name": {
  10684. "type": "string",
  10685. "x-go-name": "Name"
  10686. },
  10687. "permission": {
  10688. "type": "string",
  10689. "enum": [
  10690. "read",
  10691. "write",
  10692. "admin"
  10693. ],
  10694. "x-go-name": "Permission"
  10695. },
  10696. "units": {
  10697. "type": "array",
  10698. "items": {
  10699. "type": "string"
  10700. },
  10701. "x-go-name": "Units",
  10702. "example": [
  10703. "repo.code",
  10704. "repo.issues",
  10705. "repo.ext_issues",
  10706. "repo.wiki",
  10707. "repo.pulls",
  10708. "repo.releases",
  10709. "repo.ext_wiki"
  10710. ]
  10711. }
  10712. },
  10713. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10714. },
  10715. "CreateUserOption": {
  10716. "description": "CreateUserOption create user options",
  10717. "type": "object",
  10718. "required": [
  10719. "username",
  10720. "email",
  10721. "password"
  10722. ],
  10723. "properties": {
  10724. "email": {
  10725. "type": "string",
  10726. "format": "email",
  10727. "x-go-name": "Email"
  10728. },
  10729. "full_name": {
  10730. "type": "string",
  10731. "x-go-name": "FullName"
  10732. },
  10733. "login_name": {
  10734. "type": "string",
  10735. "x-go-name": "LoginName"
  10736. },
  10737. "must_change_password": {
  10738. "type": "boolean",
  10739. "x-go-name": "MustChangePassword"
  10740. },
  10741. "password": {
  10742. "type": "string",
  10743. "x-go-name": "Password"
  10744. },
  10745. "send_notify": {
  10746. "type": "boolean",
  10747. "x-go-name": "SendNotify"
  10748. },
  10749. "source_id": {
  10750. "type": "integer",
  10751. "format": "int64",
  10752. "x-go-name": "SourceID"
  10753. },
  10754. "username": {
  10755. "type": "string",
  10756. "x-go-name": "Username"
  10757. }
  10758. },
  10759. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10760. },
  10761. "DeleteEmailOption": {
  10762. "description": "DeleteEmailOption options when deleting email addresses",
  10763. "type": "object",
  10764. "properties": {
  10765. "emails": {
  10766. "description": "email addresses to delete",
  10767. "type": "array",
  10768. "items": {
  10769. "type": "string"
  10770. },
  10771. "x-go-name": "Emails"
  10772. }
  10773. },
  10774. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10775. },
  10776. "DeleteFileOptions": {
  10777. "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)",
  10778. "type": "object",
  10779. "required": [
  10780. "sha"
  10781. ],
  10782. "properties": {
  10783. "author": {
  10784. "$ref": "#/definitions/Identity"
  10785. },
  10786. "branch": {
  10787. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10788. "type": "string",
  10789. "x-go-name": "BranchName"
  10790. },
  10791. "committer": {
  10792. "$ref": "#/definitions/Identity"
  10793. },
  10794. "dates": {
  10795. "$ref": "#/definitions/CommitDateOptions"
  10796. },
  10797. "message": {
  10798. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10799. "type": "string",
  10800. "x-go-name": "Message"
  10801. },
  10802. "new_branch": {
  10803. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10804. "type": "string",
  10805. "x-go-name": "NewBranchName"
  10806. },
  10807. "sha": {
  10808. "description": "sha is the SHA for the file that already exists",
  10809. "type": "string",
  10810. "x-go-name": "SHA"
  10811. }
  10812. },
  10813. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10814. },
  10815. "DeployKey": {
  10816. "description": "DeployKey a deploy key",
  10817. "type": "object",
  10818. "properties": {
  10819. "created_at": {
  10820. "type": "string",
  10821. "format": "date-time",
  10822. "x-go-name": "Created"
  10823. },
  10824. "fingerprint": {
  10825. "type": "string",
  10826. "x-go-name": "Fingerprint"
  10827. },
  10828. "id": {
  10829. "type": "integer",
  10830. "format": "int64",
  10831. "x-go-name": "ID"
  10832. },
  10833. "key": {
  10834. "type": "string",
  10835. "x-go-name": "Key"
  10836. },
  10837. "key_id": {
  10838. "type": "integer",
  10839. "format": "int64",
  10840. "x-go-name": "KeyID"
  10841. },
  10842. "read_only": {
  10843. "type": "boolean",
  10844. "x-go-name": "ReadOnly"
  10845. },
  10846. "repository": {
  10847. "$ref": "#/definitions/Repository"
  10848. },
  10849. "title": {
  10850. "type": "string",
  10851. "x-go-name": "Title"
  10852. },
  10853. "url": {
  10854. "type": "string",
  10855. "x-go-name": "URL"
  10856. }
  10857. },
  10858. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10859. },
  10860. "EditAttachmentOptions": {
  10861. "description": "EditAttachmentOptions options for editing attachments",
  10862. "type": "object",
  10863. "properties": {
  10864. "name": {
  10865. "type": "string",
  10866. "x-go-name": "Name"
  10867. }
  10868. },
  10869. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10870. },
  10871. "EditBranchProtectionOption": {
  10872. "description": "EditBranchProtectionOption options for editing a branch protection",
  10873. "type": "object",
  10874. "properties": {
  10875. "approvals_whitelist_teams": {
  10876. "type": "array",
  10877. "items": {
  10878. "type": "string"
  10879. },
  10880. "x-go-name": "ApprovalsWhitelistTeams"
  10881. },
  10882. "approvals_whitelist_username": {
  10883. "type": "array",
  10884. "items": {
  10885. "type": "string"
  10886. },
  10887. "x-go-name": "ApprovalsWhitelistUsernames"
  10888. },
  10889. "block_on_rejected_reviews": {
  10890. "type": "boolean",
  10891. "x-go-name": "BlockOnRejectedReviews"
  10892. },
  10893. "dismiss_stale_approvals": {
  10894. "type": "boolean",
  10895. "x-go-name": "DismissStaleApprovals"
  10896. },
  10897. "enable_approvals_whitelist": {
  10898. "type": "boolean",
  10899. "x-go-name": "EnableApprovalsWhitelist"
  10900. },
  10901. "enable_merge_whitelist": {
  10902. "type": "boolean",
  10903. "x-go-name": "EnableMergeWhitelist"
  10904. },
  10905. "enable_push": {
  10906. "type": "boolean",
  10907. "x-go-name": "EnablePush"
  10908. },
  10909. "enable_push_whitelist": {
  10910. "type": "boolean",
  10911. "x-go-name": "EnablePushWhitelist"
  10912. },
  10913. "enable_status_check": {
  10914. "type": "boolean",
  10915. "x-go-name": "EnableStatusCheck"
  10916. },
  10917. "merge_whitelist_teams": {
  10918. "type": "array",
  10919. "items": {
  10920. "type": "string"
  10921. },
  10922. "x-go-name": "MergeWhitelistTeams"
  10923. },
  10924. "merge_whitelist_usernames": {
  10925. "type": "array",
  10926. "items": {
  10927. "type": "string"
  10928. },
  10929. "x-go-name": "MergeWhitelistUsernames"
  10930. },
  10931. "push_whitelist_deploy_keys": {
  10932. "type": "boolean",
  10933. "x-go-name": "PushWhitelistDeployKeys"
  10934. },
  10935. "push_whitelist_teams": {
  10936. "type": "array",
  10937. "items": {
  10938. "type": "string"
  10939. },
  10940. "x-go-name": "PushWhitelistTeams"
  10941. },
  10942. "push_whitelist_usernames": {
  10943. "type": "array",
  10944. "items": {
  10945. "type": "string"
  10946. },
  10947. "x-go-name": "PushWhitelistUsernames"
  10948. },
  10949. "require_signed_commits": {
  10950. "type": "boolean",
  10951. "x-go-name": "RequireSignedCommits"
  10952. },
  10953. "required_approvals": {
  10954. "type": "integer",
  10955. "format": "int64",
  10956. "x-go-name": "RequiredApprovals"
  10957. },
  10958. "status_check_contexts": {
  10959. "type": "array",
  10960. "items": {
  10961. "type": "string"
  10962. },
  10963. "x-go-name": "StatusCheckContexts"
  10964. }
  10965. },
  10966. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10967. },
  10968. "EditDeadlineOption": {
  10969. "description": "EditDeadlineOption options for creating a deadline",
  10970. "type": "object",
  10971. "required": [
  10972. "due_date"
  10973. ],
  10974. "properties": {
  10975. "due_date": {
  10976. "type": "string",
  10977. "format": "date-time",
  10978. "x-go-name": "Deadline"
  10979. }
  10980. },
  10981. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10982. },
  10983. "EditGitHookOption": {
  10984. "description": "EditGitHookOption options when modifying one Git hook",
  10985. "type": "object",
  10986. "properties": {
  10987. "content": {
  10988. "type": "string",
  10989. "x-go-name": "Content"
  10990. }
  10991. },
  10992. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10993. },
  10994. "EditHookOption": {
  10995. "description": "EditHookOption options when modify one hook",
  10996. "type": "object",
  10997. "properties": {
  10998. "active": {
  10999. "type": "boolean",
  11000. "x-go-name": "Active"
  11001. },
  11002. "branch_filter": {
  11003. "type": "string",
  11004. "x-go-name": "BranchFilter"
  11005. },
  11006. "config": {
  11007. "type": "object",
  11008. "additionalProperties": {
  11009. "type": "string"
  11010. },
  11011. "x-go-name": "Config"
  11012. },
  11013. "events": {
  11014. "type": "array",
  11015. "items": {
  11016. "type": "string"
  11017. },
  11018. "x-go-name": "Events"
  11019. }
  11020. },
  11021. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11022. },
  11023. "EditIssueCommentOption": {
  11024. "description": "EditIssueCommentOption options for editing a comment",
  11025. "type": "object",
  11026. "required": [
  11027. "body"
  11028. ],
  11029. "properties": {
  11030. "body": {
  11031. "type": "string",
  11032. "x-go-name": "Body"
  11033. }
  11034. },
  11035. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11036. },
  11037. "EditIssueOption": {
  11038. "description": "EditIssueOption options for editing an issue",
  11039. "type": "object",
  11040. "properties": {
  11041. "assignee": {
  11042. "type": "string",
  11043. "x-go-name": "Assignee"
  11044. },
  11045. "assignees": {
  11046. "type": "array",
  11047. "items": {
  11048. "type": "string"
  11049. },
  11050. "x-go-name": "Assignees"
  11051. },
  11052. "body": {
  11053. "type": "string",
  11054. "x-go-name": "Body"
  11055. },
  11056. "due_date": {
  11057. "type": "string",
  11058. "format": "date-time",
  11059. "x-go-name": "Deadline"
  11060. },
  11061. "milestone": {
  11062. "type": "integer",
  11063. "format": "int64",
  11064. "x-go-name": "Milestone"
  11065. },
  11066. "state": {
  11067. "type": "string",
  11068. "x-go-name": "State"
  11069. },
  11070. "title": {
  11071. "type": "string",
  11072. "x-go-name": "Title"
  11073. },
  11074. "unset_due_date": {
  11075. "type": "boolean",
  11076. "x-go-name": "RemoveDeadline"
  11077. }
  11078. },
  11079. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11080. },
  11081. "EditLabelOption": {
  11082. "description": "EditLabelOption options for editing a label",
  11083. "type": "object",
  11084. "properties": {
  11085. "color": {
  11086. "type": "string",
  11087. "x-go-name": "Color"
  11088. },
  11089. "description": {
  11090. "type": "string",
  11091. "x-go-name": "Description"
  11092. },
  11093. "name": {
  11094. "type": "string",
  11095. "x-go-name": "Name"
  11096. }
  11097. },
  11098. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11099. },
  11100. "EditMilestoneOption": {
  11101. "description": "EditMilestoneOption options for editing a milestone",
  11102. "type": "object",
  11103. "properties": {
  11104. "description": {
  11105. "type": "string",
  11106. "x-go-name": "Description"
  11107. },
  11108. "due_on": {
  11109. "type": "string",
  11110. "format": "date-time",
  11111. "x-go-name": "Deadline"
  11112. },
  11113. "state": {
  11114. "type": "string",
  11115. "x-go-name": "State"
  11116. },
  11117. "title": {
  11118. "type": "string",
  11119. "x-go-name": "Title"
  11120. }
  11121. },
  11122. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11123. },
  11124. "EditOrgOption": {
  11125. "description": "EditOrgOption options for editing an organization",
  11126. "type": "object",
  11127. "properties": {
  11128. "description": {
  11129. "type": "string",
  11130. "x-go-name": "Description"
  11131. },
  11132. "full_name": {
  11133. "type": "string",
  11134. "x-go-name": "FullName"
  11135. },
  11136. "location": {
  11137. "type": "string",
  11138. "x-go-name": "Location"
  11139. },
  11140. "repo_admin_change_team_access": {
  11141. "type": "boolean",
  11142. "x-go-name": "RepoAdminChangeTeamAccess"
  11143. },
  11144. "visibility": {
  11145. "description": "possible values are `public`, `limited` or `private`",
  11146. "type": "string",
  11147. "enum": [
  11148. "public",
  11149. "limited",
  11150. "private"
  11151. ],
  11152. "x-go-name": "Visibility"
  11153. },
  11154. "website": {
  11155. "type": "string",
  11156. "x-go-name": "Website"
  11157. }
  11158. },
  11159. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11160. },
  11161. "EditPullRequestOption": {
  11162. "description": "EditPullRequestOption options when modify pull request",
  11163. "type": "object",
  11164. "properties": {
  11165. "assignee": {
  11166. "type": "string",
  11167. "x-go-name": "Assignee"
  11168. },
  11169. "assignees": {
  11170. "type": "array",
  11171. "items": {
  11172. "type": "string"
  11173. },
  11174. "x-go-name": "Assignees"
  11175. },
  11176. "body": {
  11177. "type": "string",
  11178. "x-go-name": "Body"
  11179. },
  11180. "due_date": {
  11181. "type": "string",
  11182. "format": "date-time",
  11183. "x-go-name": "Deadline"
  11184. },
  11185. "labels": {
  11186. "type": "array",
  11187. "items": {
  11188. "type": "integer",
  11189. "format": "int64"
  11190. },
  11191. "x-go-name": "Labels"
  11192. },
  11193. "milestone": {
  11194. "type": "integer",
  11195. "format": "int64",
  11196. "x-go-name": "Milestone"
  11197. },
  11198. "state": {
  11199. "type": "string",
  11200. "x-go-name": "State"
  11201. },
  11202. "title": {
  11203. "type": "string",
  11204. "x-go-name": "Title"
  11205. },
  11206. "unset_due_date": {
  11207. "type": "boolean",
  11208. "x-go-name": "RemoveDeadline"
  11209. }
  11210. },
  11211. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11212. },
  11213. "EditReactionOption": {
  11214. "description": "EditReactionOption contain the reaction type",
  11215. "type": "object",
  11216. "properties": {
  11217. "content": {
  11218. "type": "string",
  11219. "x-go-name": "Reaction"
  11220. }
  11221. },
  11222. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11223. },
  11224. "EditReleaseOption": {
  11225. "description": "EditReleaseOption options when editing a release",
  11226. "type": "object",
  11227. "properties": {
  11228. "body": {
  11229. "type": "string",
  11230. "x-go-name": "Note"
  11231. },
  11232. "draft": {
  11233. "type": "boolean",
  11234. "x-go-name": "IsDraft"
  11235. },
  11236. "name": {
  11237. "type": "string",
  11238. "x-go-name": "Title"
  11239. },
  11240. "prerelease": {
  11241. "type": "boolean",
  11242. "x-go-name": "IsPrerelease"
  11243. },
  11244. "tag_name": {
  11245. "type": "string",
  11246. "x-go-name": "TagName"
  11247. },
  11248. "target_commitish": {
  11249. "type": "string",
  11250. "x-go-name": "Target"
  11251. }
  11252. },
  11253. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11254. },
  11255. "EditRepoOption": {
  11256. "description": "EditRepoOption options when editing a repository's properties",
  11257. "type": "object",
  11258. "properties": {
  11259. "allow_merge_commits": {
  11260. "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`.",
  11261. "type": "boolean",
  11262. "x-go-name": "AllowMerge"
  11263. },
  11264. "allow_rebase": {
  11265. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  11266. "type": "boolean",
  11267. "x-go-name": "AllowRebase"
  11268. },
  11269. "allow_rebase_explicit": {
  11270. "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`.",
  11271. "type": "boolean",
  11272. "x-go-name": "AllowRebaseMerge"
  11273. },
  11274. "allow_squash_merge": {
  11275. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  11276. "type": "boolean",
  11277. "x-go-name": "AllowSquash"
  11278. },
  11279. "archived": {
  11280. "description": "set to `true` to archive this repository.",
  11281. "type": "boolean",
  11282. "x-go-name": "Archived"
  11283. },
  11284. "default_branch": {
  11285. "description": "sets the default branch for this repository.",
  11286. "type": "string",
  11287. "x-go-name": "DefaultBranch"
  11288. },
  11289. "description": {
  11290. "description": "a short description of the repository.",
  11291. "type": "string",
  11292. "x-go-name": "Description"
  11293. },
  11294. "external_tracker": {
  11295. "$ref": "#/definitions/ExternalTracker"
  11296. },
  11297. "external_wiki": {
  11298. "$ref": "#/definitions/ExternalWiki"
  11299. },
  11300. "has_issues": {
  11301. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  11302. "type": "boolean",
  11303. "x-go-name": "HasIssues"
  11304. },
  11305. "has_pull_requests": {
  11306. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  11307. "type": "boolean",
  11308. "x-go-name": "HasPullRequests"
  11309. },
  11310. "has_wiki": {
  11311. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  11312. "type": "boolean",
  11313. "x-go-name": "HasWiki"
  11314. },
  11315. "ignore_whitespace_conflicts": {
  11316. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  11317. "type": "boolean",
  11318. "x-go-name": "IgnoreWhitespaceConflicts"
  11319. },
  11320. "internal_tracker": {
  11321. "$ref": "#/definitions/InternalTracker"
  11322. },
  11323. "name": {
  11324. "description": "name of the repository",
  11325. "type": "string",
  11326. "uniqueItems": true,
  11327. "x-go-name": "Name"
  11328. },
  11329. "private": {
  11330. "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.",
  11331. "type": "boolean",
  11332. "x-go-name": "Private"
  11333. },
  11334. "template": {
  11335. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  11336. "type": "boolean",
  11337. "x-go-name": "Template"
  11338. },
  11339. "website": {
  11340. "description": "a URL with more information about the repository.",
  11341. "type": "string",
  11342. "x-go-name": "Website"
  11343. }
  11344. },
  11345. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11346. },
  11347. "EditTeamOption": {
  11348. "description": "EditTeamOption options for editing a team",
  11349. "type": "object",
  11350. "required": [
  11351. "name"
  11352. ],
  11353. "properties": {
  11354. "can_create_org_repo": {
  11355. "type": "boolean",
  11356. "x-go-name": "CanCreateOrgRepo"
  11357. },
  11358. "description": {
  11359. "type": "string",
  11360. "x-go-name": "Description"
  11361. },
  11362. "includes_all_repositories": {
  11363. "type": "boolean",
  11364. "x-go-name": "IncludesAllRepositories"
  11365. },
  11366. "name": {
  11367. "type": "string",
  11368. "x-go-name": "Name"
  11369. },
  11370. "permission": {
  11371. "type": "string",
  11372. "enum": [
  11373. "read",
  11374. "write",
  11375. "admin"
  11376. ],
  11377. "x-go-name": "Permission"
  11378. },
  11379. "units": {
  11380. "type": "array",
  11381. "items": {
  11382. "type": "string"
  11383. },
  11384. "x-go-name": "Units",
  11385. "example": [
  11386. "repo.code",
  11387. "repo.issues",
  11388. "repo.ext_issues",
  11389. "repo.wiki",
  11390. "repo.pulls",
  11391. "repo.releases",
  11392. "repo.ext_wiki"
  11393. ]
  11394. }
  11395. },
  11396. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11397. },
  11398. "EditUserOption": {
  11399. "description": "EditUserOption edit user options",
  11400. "type": "object",
  11401. "required": [
  11402. "email"
  11403. ],
  11404. "properties": {
  11405. "active": {
  11406. "type": "boolean",
  11407. "x-go-name": "Active"
  11408. },
  11409. "admin": {
  11410. "type": "boolean",
  11411. "x-go-name": "Admin"
  11412. },
  11413. "allow_create_organization": {
  11414. "type": "boolean",
  11415. "x-go-name": "AllowCreateOrganization"
  11416. },
  11417. "allow_git_hook": {
  11418. "type": "boolean",
  11419. "x-go-name": "AllowGitHook"
  11420. },
  11421. "allow_import_local": {
  11422. "type": "boolean",
  11423. "x-go-name": "AllowImportLocal"
  11424. },
  11425. "email": {
  11426. "type": "string",
  11427. "format": "email",
  11428. "x-go-name": "Email"
  11429. },
  11430. "full_name": {
  11431. "type": "string",
  11432. "x-go-name": "FullName"
  11433. },
  11434. "location": {
  11435. "type": "string",
  11436. "x-go-name": "Location"
  11437. },
  11438. "login_name": {
  11439. "type": "string",
  11440. "x-go-name": "LoginName"
  11441. },
  11442. "max_repo_creation": {
  11443. "type": "integer",
  11444. "format": "int64",
  11445. "x-go-name": "MaxRepoCreation"
  11446. },
  11447. "must_change_password": {
  11448. "type": "boolean",
  11449. "x-go-name": "MustChangePassword"
  11450. },
  11451. "password": {
  11452. "type": "string",
  11453. "x-go-name": "Password"
  11454. },
  11455. "prohibit_login": {
  11456. "type": "boolean",
  11457. "x-go-name": "ProhibitLogin"
  11458. },
  11459. "source_id": {
  11460. "type": "integer",
  11461. "format": "int64",
  11462. "x-go-name": "SourceID"
  11463. },
  11464. "website": {
  11465. "type": "string",
  11466. "x-go-name": "Website"
  11467. }
  11468. },
  11469. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11470. },
  11471. "Email": {
  11472. "description": "Email an email address belonging to a user",
  11473. "type": "object",
  11474. "properties": {
  11475. "email": {
  11476. "type": "string",
  11477. "format": "email",
  11478. "x-go-name": "Email"
  11479. },
  11480. "primary": {
  11481. "type": "boolean",
  11482. "x-go-name": "Primary"
  11483. },
  11484. "verified": {
  11485. "type": "boolean",
  11486. "x-go-name": "Verified"
  11487. }
  11488. },
  11489. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11490. },
  11491. "ExternalTracker": {
  11492. "description": "ExternalTracker represents settings for external tracker",
  11493. "type": "object",
  11494. "properties": {
  11495. "external_tracker_format": {
  11496. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  11497. "type": "string",
  11498. "x-go-name": "ExternalTrackerFormat"
  11499. },
  11500. "external_tracker_style": {
  11501. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  11502. "type": "string",
  11503. "x-go-name": "ExternalTrackerStyle"
  11504. },
  11505. "external_tracker_url": {
  11506. "description": "URL of external issue tracker.",
  11507. "type": "string",
  11508. "x-go-name": "ExternalTrackerURL"
  11509. }
  11510. },
  11511. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11512. },
  11513. "ExternalWiki": {
  11514. "description": "ExternalWiki represents setting for external wiki",
  11515. "type": "object",
  11516. "properties": {
  11517. "external_wiki_url": {
  11518. "description": "URL of external wiki.",
  11519. "type": "string",
  11520. "x-go-name": "ExternalWikiURL"
  11521. }
  11522. },
  11523. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11524. },
  11525. "FileCommitResponse": {
  11526. "type": "object",
  11527. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  11528. "properties": {
  11529. "author": {
  11530. "$ref": "#/definitions/CommitUser"
  11531. },
  11532. "committer": {
  11533. "$ref": "#/definitions/CommitUser"
  11534. },
  11535. "html_url": {
  11536. "type": "string",
  11537. "x-go-name": "HTMLURL"
  11538. },
  11539. "message": {
  11540. "type": "string",
  11541. "x-go-name": "Message"
  11542. },
  11543. "parents": {
  11544. "type": "array",
  11545. "items": {
  11546. "$ref": "#/definitions/CommitMeta"
  11547. },
  11548. "x-go-name": "Parents"
  11549. },
  11550. "sha": {
  11551. "type": "string",
  11552. "x-go-name": "SHA"
  11553. },
  11554. "tree": {
  11555. "$ref": "#/definitions/CommitMeta"
  11556. },
  11557. "url": {
  11558. "type": "string",
  11559. "x-go-name": "URL"
  11560. }
  11561. },
  11562. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11563. },
  11564. "FileDeleteResponse": {
  11565. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  11566. "type": "object",
  11567. "properties": {
  11568. "commit": {
  11569. "$ref": "#/definitions/FileCommitResponse"
  11570. },
  11571. "content": {
  11572. "type": "object",
  11573. "x-go-name": "Content"
  11574. },
  11575. "verification": {
  11576. "$ref": "#/definitions/PayloadCommitVerification"
  11577. }
  11578. },
  11579. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11580. },
  11581. "FileLinksResponse": {
  11582. "description": "FileLinksResponse contains the links for a repo's file",
  11583. "type": "object",
  11584. "properties": {
  11585. "git": {
  11586. "type": "string",
  11587. "x-go-name": "GitURL"
  11588. },
  11589. "html": {
  11590. "type": "string",
  11591. "x-go-name": "HTMLURL"
  11592. },
  11593. "self": {
  11594. "type": "string",
  11595. "x-go-name": "Self"
  11596. }
  11597. },
  11598. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11599. },
  11600. "FileResponse": {
  11601. "description": "FileResponse contains information about a repo's file",
  11602. "type": "object",
  11603. "properties": {
  11604. "commit": {
  11605. "$ref": "#/definitions/FileCommitResponse"
  11606. },
  11607. "content": {
  11608. "$ref": "#/definitions/ContentsResponse"
  11609. },
  11610. "verification": {
  11611. "$ref": "#/definitions/PayloadCommitVerification"
  11612. }
  11613. },
  11614. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11615. },
  11616. "GPGKey": {
  11617. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  11618. "type": "object",
  11619. "properties": {
  11620. "can_certify": {
  11621. "type": "boolean",
  11622. "x-go-name": "CanCertify"
  11623. },
  11624. "can_encrypt_comms": {
  11625. "type": "boolean",
  11626. "x-go-name": "CanEncryptComms"
  11627. },
  11628. "can_encrypt_storage": {
  11629. "type": "boolean",
  11630. "x-go-name": "CanEncryptStorage"
  11631. },
  11632. "can_sign": {
  11633. "type": "boolean",
  11634. "x-go-name": "CanSign"
  11635. },
  11636. "created_at": {
  11637. "type": "string",
  11638. "format": "date-time",
  11639. "x-go-name": "Created"
  11640. },
  11641. "emails": {
  11642. "type": "array",
  11643. "items": {
  11644. "$ref": "#/definitions/GPGKeyEmail"
  11645. },
  11646. "x-go-name": "Emails"
  11647. },
  11648. "expires_at": {
  11649. "type": "string",
  11650. "format": "date-time",
  11651. "x-go-name": "Expires"
  11652. },
  11653. "id": {
  11654. "type": "integer",
  11655. "format": "int64",
  11656. "x-go-name": "ID"
  11657. },
  11658. "key_id": {
  11659. "type": "string",
  11660. "x-go-name": "KeyID"
  11661. },
  11662. "primary_key_id": {
  11663. "type": "string",
  11664. "x-go-name": "PrimaryKeyID"
  11665. },
  11666. "public_key": {
  11667. "type": "string",
  11668. "x-go-name": "PublicKey"
  11669. },
  11670. "subkeys": {
  11671. "type": "array",
  11672. "items": {
  11673. "$ref": "#/definitions/GPGKey"
  11674. },
  11675. "x-go-name": "SubsKey"
  11676. }
  11677. },
  11678. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11679. },
  11680. "GPGKeyEmail": {
  11681. "description": "GPGKeyEmail an email attached to a GPGKey",
  11682. "type": "object",
  11683. "properties": {
  11684. "email": {
  11685. "type": "string",
  11686. "x-go-name": "Email"
  11687. },
  11688. "verified": {
  11689. "type": "boolean",
  11690. "x-go-name": "Verified"
  11691. }
  11692. },
  11693. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11694. },
  11695. "GitBlobResponse": {
  11696. "description": "GitBlobResponse represents a git blob",
  11697. "type": "object",
  11698. "properties": {
  11699. "content": {
  11700. "type": "string",
  11701. "x-go-name": "Content"
  11702. },
  11703. "encoding": {
  11704. "type": "string",
  11705. "x-go-name": "Encoding"
  11706. },
  11707. "sha": {
  11708. "type": "string",
  11709. "x-go-name": "SHA"
  11710. },
  11711. "size": {
  11712. "type": "integer",
  11713. "format": "int64",
  11714. "x-go-name": "Size"
  11715. },
  11716. "url": {
  11717. "type": "string",
  11718. "x-go-name": "URL"
  11719. }
  11720. },
  11721. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11722. },
  11723. "GitEntry": {
  11724. "description": "GitEntry represents a git tree",
  11725. "type": "object",
  11726. "properties": {
  11727. "mode": {
  11728. "type": "string",
  11729. "x-go-name": "Mode"
  11730. },
  11731. "path": {
  11732. "type": "string",
  11733. "x-go-name": "Path"
  11734. },
  11735. "sha": {
  11736. "type": "string",
  11737. "x-go-name": "SHA"
  11738. },
  11739. "size": {
  11740. "type": "integer",
  11741. "format": "int64",
  11742. "x-go-name": "Size"
  11743. },
  11744. "type": {
  11745. "type": "string",
  11746. "x-go-name": "Type"
  11747. },
  11748. "url": {
  11749. "type": "string",
  11750. "x-go-name": "URL"
  11751. }
  11752. },
  11753. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11754. },
  11755. "GitHook": {
  11756. "description": "GitHook represents a Git repository hook",
  11757. "type": "object",
  11758. "properties": {
  11759. "content": {
  11760. "type": "string",
  11761. "x-go-name": "Content"
  11762. },
  11763. "is_active": {
  11764. "type": "boolean",
  11765. "x-go-name": "IsActive"
  11766. },
  11767. "name": {
  11768. "type": "string",
  11769. "x-go-name": "Name"
  11770. }
  11771. },
  11772. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11773. },
  11774. "GitObject": {
  11775. "type": "object",
  11776. "title": "GitObject represents a Git object.",
  11777. "properties": {
  11778. "sha": {
  11779. "type": "string",
  11780. "x-go-name": "SHA"
  11781. },
  11782. "type": {
  11783. "type": "string",
  11784. "x-go-name": "Type"
  11785. },
  11786. "url": {
  11787. "type": "string",
  11788. "x-go-name": "URL"
  11789. }
  11790. },
  11791. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11792. },
  11793. "GitTreeResponse": {
  11794. "description": "GitTreeResponse returns a git tree",
  11795. "type": "object",
  11796. "properties": {
  11797. "page": {
  11798. "type": "integer",
  11799. "format": "int64",
  11800. "x-go-name": "Page"
  11801. },
  11802. "sha": {
  11803. "type": "string",
  11804. "x-go-name": "SHA"
  11805. },
  11806. "total_count": {
  11807. "type": "integer",
  11808. "format": "int64",
  11809. "x-go-name": "TotalCount"
  11810. },
  11811. "tree": {
  11812. "type": "array",
  11813. "items": {
  11814. "$ref": "#/definitions/GitEntry"
  11815. },
  11816. "x-go-name": "Entries"
  11817. },
  11818. "truncated": {
  11819. "type": "boolean",
  11820. "x-go-name": "Truncated"
  11821. },
  11822. "url": {
  11823. "type": "string",
  11824. "x-go-name": "URL"
  11825. }
  11826. },
  11827. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11828. },
  11829. "Hook": {
  11830. "description": "Hook a hook is a web hook when one repository changed",
  11831. "type": "object",
  11832. "properties": {
  11833. "active": {
  11834. "type": "boolean",
  11835. "x-go-name": "Active"
  11836. },
  11837. "config": {
  11838. "type": "object",
  11839. "additionalProperties": {
  11840. "type": "string"
  11841. },
  11842. "x-go-name": "Config"
  11843. },
  11844. "created_at": {
  11845. "type": "string",
  11846. "format": "date-time",
  11847. "x-go-name": "Created"
  11848. },
  11849. "events": {
  11850. "type": "array",
  11851. "items": {
  11852. "type": "string"
  11853. },
  11854. "x-go-name": "Events"
  11855. },
  11856. "id": {
  11857. "type": "integer",
  11858. "format": "int64",
  11859. "x-go-name": "ID"
  11860. },
  11861. "type": {
  11862. "type": "string",
  11863. "x-go-name": "Type"
  11864. },
  11865. "updated_at": {
  11866. "type": "string",
  11867. "format": "date-time",
  11868. "x-go-name": "Updated"
  11869. }
  11870. },
  11871. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11872. },
  11873. "Identity": {
  11874. "description": "Identity for a person's identity like an author or committer",
  11875. "type": "object",
  11876. "properties": {
  11877. "email": {
  11878. "type": "string",
  11879. "format": "email",
  11880. "x-go-name": "Email"
  11881. },
  11882. "name": {
  11883. "type": "string",
  11884. "x-go-name": "Name"
  11885. }
  11886. },
  11887. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11888. },
  11889. "InternalTracker": {
  11890. "description": "InternalTracker represents settings for internal tracker",
  11891. "type": "object",
  11892. "properties": {
  11893. "allow_only_contributors_to_track_time": {
  11894. "description": "Let only contributors track time (Built-in issue tracker)",
  11895. "type": "boolean",
  11896. "x-go-name": "AllowOnlyContributorsToTrackTime"
  11897. },
  11898. "enable_issue_dependencies": {
  11899. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  11900. "type": "boolean",
  11901. "x-go-name": "EnableIssueDependencies"
  11902. },
  11903. "enable_time_tracker": {
  11904. "description": "Enable time tracking (Built-in issue tracker)",
  11905. "type": "boolean",
  11906. "x-go-name": "EnableTimeTracker"
  11907. }
  11908. },
  11909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11910. },
  11911. "Issue": {
  11912. "description": "Issue represents an issue in a repository",
  11913. "type": "object",
  11914. "properties": {
  11915. "assignee": {
  11916. "$ref": "#/definitions/User"
  11917. },
  11918. "assignees": {
  11919. "type": "array",
  11920. "items": {
  11921. "$ref": "#/definitions/User"
  11922. },
  11923. "x-go-name": "Assignees"
  11924. },
  11925. "body": {
  11926. "type": "string",
  11927. "x-go-name": "Body"
  11928. },
  11929. "closed_at": {
  11930. "type": "string",
  11931. "format": "date-time",
  11932. "x-go-name": "Closed"
  11933. },
  11934. "comments": {
  11935. "type": "integer",
  11936. "format": "int64",
  11937. "x-go-name": "Comments"
  11938. },
  11939. "created_at": {
  11940. "type": "string",
  11941. "format": "date-time",
  11942. "x-go-name": "Created"
  11943. },
  11944. "due_date": {
  11945. "type": "string",
  11946. "format": "date-time",
  11947. "x-go-name": "Deadline"
  11948. },
  11949. "html_url": {
  11950. "type": "string",
  11951. "x-go-name": "HTMLURL"
  11952. },
  11953. "id": {
  11954. "type": "integer",
  11955. "format": "int64",
  11956. "x-go-name": "ID"
  11957. },
  11958. "labels": {
  11959. "type": "array",
  11960. "items": {
  11961. "$ref": "#/definitions/Label"
  11962. },
  11963. "x-go-name": "Labels"
  11964. },
  11965. "milestone": {
  11966. "$ref": "#/definitions/Milestone"
  11967. },
  11968. "number": {
  11969. "type": "integer",
  11970. "format": "int64",
  11971. "x-go-name": "Index"
  11972. },
  11973. "original_author": {
  11974. "type": "string",
  11975. "x-go-name": "OriginalAuthor"
  11976. },
  11977. "original_author_id": {
  11978. "type": "integer",
  11979. "format": "int64",
  11980. "x-go-name": "OriginalAuthorID"
  11981. },
  11982. "pull_request": {
  11983. "$ref": "#/definitions/PullRequestMeta"
  11984. },
  11985. "repository": {
  11986. "$ref": "#/definitions/RepositoryMeta"
  11987. },
  11988. "state": {
  11989. "$ref": "#/definitions/StateType"
  11990. },
  11991. "title": {
  11992. "type": "string",
  11993. "x-go-name": "Title"
  11994. },
  11995. "updated_at": {
  11996. "type": "string",
  11997. "format": "date-time",
  11998. "x-go-name": "Updated"
  11999. },
  12000. "url": {
  12001. "type": "string",
  12002. "x-go-name": "URL"
  12003. },
  12004. "user": {
  12005. "$ref": "#/definitions/User"
  12006. }
  12007. },
  12008. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12009. },
  12010. "IssueDeadline": {
  12011. "description": "IssueDeadline represents an issue deadline",
  12012. "type": "object",
  12013. "properties": {
  12014. "due_date": {
  12015. "type": "string",
  12016. "format": "date-time",
  12017. "x-go-name": "Deadline"
  12018. }
  12019. },
  12020. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12021. },
  12022. "IssueLabelsOption": {
  12023. "description": "IssueLabelsOption a collection of labels",
  12024. "type": "object",
  12025. "properties": {
  12026. "labels": {
  12027. "description": "list of label IDs",
  12028. "type": "array",
  12029. "items": {
  12030. "type": "integer",
  12031. "format": "int64"
  12032. },
  12033. "x-go-name": "Labels"
  12034. }
  12035. },
  12036. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12037. },
  12038. "Label": {
  12039. "description": "Label a label to an issue or a pr",
  12040. "type": "object",
  12041. "properties": {
  12042. "color": {
  12043. "type": "string",
  12044. "x-go-name": "Color",
  12045. "example": "00aabb"
  12046. },
  12047. "description": {
  12048. "type": "string",
  12049. "x-go-name": "Description"
  12050. },
  12051. "id": {
  12052. "type": "integer",
  12053. "format": "int64",
  12054. "x-go-name": "ID"
  12055. },
  12056. "name": {
  12057. "type": "string",
  12058. "x-go-name": "Name"
  12059. },
  12060. "url": {
  12061. "type": "string",
  12062. "x-go-name": "URL"
  12063. }
  12064. },
  12065. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12066. },
  12067. "MarkdownOption": {
  12068. "description": "MarkdownOption markdown options",
  12069. "type": "object",
  12070. "properties": {
  12071. "Context": {
  12072. "description": "Context to render\n\nin: body",
  12073. "type": "string"
  12074. },
  12075. "Mode": {
  12076. "description": "Mode to render\n\nin: body",
  12077. "type": "string"
  12078. },
  12079. "Text": {
  12080. "description": "Text markdown to render\n\nin: body",
  12081. "type": "string"
  12082. },
  12083. "Wiki": {
  12084. "description": "Is it a wiki page ?\n\nin: body",
  12085. "type": "boolean"
  12086. }
  12087. },
  12088. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12089. },
  12090. "MergePullRequestOption": {
  12091. "description": "MergePullRequestForm form for merging Pull Request",
  12092. "type": "object",
  12093. "required": [
  12094. "Do"
  12095. ],
  12096. "properties": {
  12097. "Do": {
  12098. "type": "string",
  12099. "enum": [
  12100. "merge",
  12101. "rebase",
  12102. "rebase-merge",
  12103. "squash"
  12104. ]
  12105. },
  12106. "MergeMessageField": {
  12107. "type": "string"
  12108. },
  12109. "MergeTitleField": {
  12110. "type": "string"
  12111. },
  12112. "force_merge": {
  12113. "type": "boolean",
  12114. "x-go-name": "ForceMerge"
  12115. }
  12116. },
  12117. "x-go-name": "MergePullRequestForm",
  12118. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12119. },
  12120. "MigrateRepoForm": {
  12121. "description": "MigrateRepoForm form for migrating repository",
  12122. "type": "object",
  12123. "required": [
  12124. "clone_addr",
  12125. "uid",
  12126. "repo_name"
  12127. ],
  12128. "properties": {
  12129. "auth_password": {
  12130. "type": "string",
  12131. "x-go-name": "AuthPassword"
  12132. },
  12133. "auth_username": {
  12134. "type": "string",
  12135. "x-go-name": "AuthUsername"
  12136. },
  12137. "clone_addr": {
  12138. "type": "string",
  12139. "x-go-name": "CloneAddr"
  12140. },
  12141. "description": {
  12142. "type": "string",
  12143. "x-go-name": "Description"
  12144. },
  12145. "issues": {
  12146. "type": "boolean",
  12147. "x-go-name": "Issues"
  12148. },
  12149. "labels": {
  12150. "type": "boolean",
  12151. "x-go-name": "Labels"
  12152. },
  12153. "milestones": {
  12154. "type": "boolean",
  12155. "x-go-name": "Milestones"
  12156. },
  12157. "mirror": {
  12158. "type": "boolean",
  12159. "x-go-name": "Mirror"
  12160. },
  12161. "private": {
  12162. "type": "boolean",
  12163. "x-go-name": "Private"
  12164. },
  12165. "pull_requests": {
  12166. "type": "boolean",
  12167. "x-go-name": "PullRequests"
  12168. },
  12169. "releases": {
  12170. "type": "boolean",
  12171. "x-go-name": "Releases"
  12172. },
  12173. "repo_name": {
  12174. "type": "string",
  12175. "x-go-name": "RepoName"
  12176. },
  12177. "uid": {
  12178. "type": "integer",
  12179. "format": "int64",
  12180. "x-go-name": "UID"
  12181. },
  12182. "wiki": {
  12183. "type": "boolean",
  12184. "x-go-name": "Wiki"
  12185. }
  12186. },
  12187. "x-go-package": "code.gitea.io/gitea/modules/auth"
  12188. },
  12189. "Milestone": {
  12190. "description": "Milestone milestone is a collection of issues on one repository",
  12191. "type": "object",
  12192. "properties": {
  12193. "closed_at": {
  12194. "type": "string",
  12195. "format": "date-time",
  12196. "x-go-name": "Closed"
  12197. },
  12198. "closed_issues": {
  12199. "type": "integer",
  12200. "format": "int64",
  12201. "x-go-name": "ClosedIssues"
  12202. },
  12203. "description": {
  12204. "type": "string",
  12205. "x-go-name": "Description"
  12206. },
  12207. "due_on": {
  12208. "type": "string",
  12209. "format": "date-time",
  12210. "x-go-name": "Deadline"
  12211. },
  12212. "id": {
  12213. "type": "integer",
  12214. "format": "int64",
  12215. "x-go-name": "ID"
  12216. },
  12217. "open_issues": {
  12218. "type": "integer",
  12219. "format": "int64",
  12220. "x-go-name": "OpenIssues"
  12221. },
  12222. "state": {
  12223. "$ref": "#/definitions/StateType"
  12224. },
  12225. "title": {
  12226. "type": "string",
  12227. "x-go-name": "Title"
  12228. }
  12229. },
  12230. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12231. },
  12232. "NotificationCount": {
  12233. "description": "NotificationCount number of unread notifications",
  12234. "type": "object",
  12235. "properties": {
  12236. "new": {
  12237. "type": "integer",
  12238. "format": "int64",
  12239. "x-go-name": "New"
  12240. }
  12241. },
  12242. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12243. },
  12244. "NotificationSubject": {
  12245. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  12246. "type": "object",
  12247. "properties": {
  12248. "latest_comment_url": {
  12249. "type": "string",
  12250. "x-go-name": "LatestCommentURL"
  12251. },
  12252. "title": {
  12253. "type": "string",
  12254. "x-go-name": "Title"
  12255. },
  12256. "type": {
  12257. "type": "string",
  12258. "x-go-name": "Type"
  12259. },
  12260. "url": {
  12261. "type": "string",
  12262. "x-go-name": "URL"
  12263. }
  12264. },
  12265. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12266. },
  12267. "NotificationThread": {
  12268. "description": "NotificationThread expose Notification on API",
  12269. "type": "object",
  12270. "properties": {
  12271. "id": {
  12272. "type": "integer",
  12273. "format": "int64",
  12274. "x-go-name": "ID"
  12275. },
  12276. "pinned": {
  12277. "type": "boolean",
  12278. "x-go-name": "Pinned"
  12279. },
  12280. "repository": {
  12281. "$ref": "#/definitions/Repository"
  12282. },
  12283. "subject": {
  12284. "$ref": "#/definitions/NotificationSubject"
  12285. },
  12286. "unread": {
  12287. "type": "boolean",
  12288. "x-go-name": "Unread"
  12289. },
  12290. "updated_at": {
  12291. "type": "string",
  12292. "format": "date-time",
  12293. "x-go-name": "UpdatedAt"
  12294. },
  12295. "url": {
  12296. "type": "string",
  12297. "x-go-name": "URL"
  12298. }
  12299. },
  12300. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12301. },
  12302. "OAuth2Application": {
  12303. "type": "object",
  12304. "title": "OAuth2Application represents an OAuth2 application.",
  12305. "properties": {
  12306. "client_id": {
  12307. "type": "string",
  12308. "x-go-name": "ClientID"
  12309. },
  12310. "client_secret": {
  12311. "type": "string",
  12312. "x-go-name": "ClientSecret"
  12313. },
  12314. "created": {
  12315. "type": "string",
  12316. "format": "date-time",
  12317. "x-go-name": "Created"
  12318. },
  12319. "id": {
  12320. "type": "integer",
  12321. "format": "int64",
  12322. "x-go-name": "ID"
  12323. },
  12324. "name": {
  12325. "type": "string",
  12326. "x-go-name": "Name"
  12327. },
  12328. "redirect_uris": {
  12329. "type": "array",
  12330. "items": {
  12331. "type": "string"
  12332. },
  12333. "x-go-name": "RedirectURIs"
  12334. }
  12335. },
  12336. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12337. },
  12338. "Organization": {
  12339. "description": "Organization represents an organization",
  12340. "type": "object",
  12341. "properties": {
  12342. "avatar_url": {
  12343. "type": "string",
  12344. "x-go-name": "AvatarURL"
  12345. },
  12346. "description": {
  12347. "type": "string",
  12348. "x-go-name": "Description"
  12349. },
  12350. "full_name": {
  12351. "type": "string",
  12352. "x-go-name": "FullName"
  12353. },
  12354. "id": {
  12355. "type": "integer",
  12356. "format": "int64",
  12357. "x-go-name": "ID"
  12358. },
  12359. "location": {
  12360. "type": "string",
  12361. "x-go-name": "Location"
  12362. },
  12363. "repo_admin_change_team_access": {
  12364. "type": "boolean",
  12365. "x-go-name": "RepoAdminChangeTeamAccess"
  12366. },
  12367. "username": {
  12368. "type": "string",
  12369. "x-go-name": "UserName"
  12370. },
  12371. "visibility": {
  12372. "type": "string",
  12373. "x-go-name": "Visibility"
  12374. },
  12375. "website": {
  12376. "type": "string",
  12377. "x-go-name": "Website"
  12378. }
  12379. },
  12380. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12381. },
  12382. "PRBranchInfo": {
  12383. "description": "PRBranchInfo information about a branch",
  12384. "type": "object",
  12385. "properties": {
  12386. "label": {
  12387. "type": "string",
  12388. "x-go-name": "Name"
  12389. },
  12390. "ref": {
  12391. "type": "string",
  12392. "x-go-name": "Ref"
  12393. },
  12394. "repo": {
  12395. "$ref": "#/definitions/Repository"
  12396. },
  12397. "repo_id": {
  12398. "type": "integer",
  12399. "format": "int64",
  12400. "x-go-name": "RepoID"
  12401. },
  12402. "sha": {
  12403. "type": "string",
  12404. "x-go-name": "Sha"
  12405. }
  12406. },
  12407. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12408. },
  12409. "PayloadCommit": {
  12410. "description": "PayloadCommit represents a commit",
  12411. "type": "object",
  12412. "properties": {
  12413. "added": {
  12414. "type": "array",
  12415. "items": {
  12416. "type": "string"
  12417. },
  12418. "x-go-name": "Added"
  12419. },
  12420. "author": {
  12421. "$ref": "#/definitions/PayloadUser"
  12422. },
  12423. "committer": {
  12424. "$ref": "#/definitions/PayloadUser"
  12425. },
  12426. "id": {
  12427. "description": "sha1 hash of the commit",
  12428. "type": "string",
  12429. "x-go-name": "ID"
  12430. },
  12431. "message": {
  12432. "type": "string",
  12433. "x-go-name": "Message"
  12434. },
  12435. "modified": {
  12436. "type": "array",
  12437. "items": {
  12438. "type": "string"
  12439. },
  12440. "x-go-name": "Modified"
  12441. },
  12442. "removed": {
  12443. "type": "array",
  12444. "items": {
  12445. "type": "string"
  12446. },
  12447. "x-go-name": "Removed"
  12448. },
  12449. "timestamp": {
  12450. "type": "string",
  12451. "format": "date-time",
  12452. "x-go-name": "Timestamp"
  12453. },
  12454. "url": {
  12455. "type": "string",
  12456. "x-go-name": "URL"
  12457. },
  12458. "verification": {
  12459. "$ref": "#/definitions/PayloadCommitVerification"
  12460. }
  12461. },
  12462. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12463. },
  12464. "PayloadCommitVerification": {
  12465. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  12466. "type": "object",
  12467. "properties": {
  12468. "payload": {
  12469. "type": "string",
  12470. "x-go-name": "Payload"
  12471. },
  12472. "reason": {
  12473. "type": "string",
  12474. "x-go-name": "Reason"
  12475. },
  12476. "signature": {
  12477. "type": "string",
  12478. "x-go-name": "Signature"
  12479. },
  12480. "signer": {
  12481. "$ref": "#/definitions/PayloadUser"
  12482. },
  12483. "verified": {
  12484. "type": "boolean",
  12485. "x-go-name": "Verified"
  12486. }
  12487. },
  12488. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12489. },
  12490. "PayloadUser": {
  12491. "description": "PayloadUser represents the author or committer of a commit",
  12492. "type": "object",
  12493. "properties": {
  12494. "email": {
  12495. "type": "string",
  12496. "format": "email",
  12497. "x-go-name": "Email"
  12498. },
  12499. "name": {
  12500. "description": "Full name of the commit author",
  12501. "type": "string",
  12502. "x-go-name": "Name"
  12503. },
  12504. "username": {
  12505. "type": "string",
  12506. "x-go-name": "UserName"
  12507. }
  12508. },
  12509. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12510. },
  12511. "Permission": {
  12512. "description": "Permission represents a set of permissions",
  12513. "type": "object",
  12514. "properties": {
  12515. "admin": {
  12516. "type": "boolean",
  12517. "x-go-name": "Admin"
  12518. },
  12519. "pull": {
  12520. "type": "boolean",
  12521. "x-go-name": "Pull"
  12522. },
  12523. "push": {
  12524. "type": "boolean",
  12525. "x-go-name": "Push"
  12526. }
  12527. },
  12528. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12529. },
  12530. "PublicKey": {
  12531. "description": "PublicKey publickey is a user key to push code to repository",
  12532. "type": "object",
  12533. "properties": {
  12534. "created_at": {
  12535. "type": "string",
  12536. "format": "date-time",
  12537. "x-go-name": "Created"
  12538. },
  12539. "fingerprint": {
  12540. "type": "string",
  12541. "x-go-name": "Fingerprint"
  12542. },
  12543. "id": {
  12544. "type": "integer",
  12545. "format": "int64",
  12546. "x-go-name": "ID"
  12547. },
  12548. "key": {
  12549. "type": "string",
  12550. "x-go-name": "Key"
  12551. },
  12552. "key_type": {
  12553. "type": "string",
  12554. "x-go-name": "KeyType"
  12555. },
  12556. "read_only": {
  12557. "type": "boolean",
  12558. "x-go-name": "ReadOnly"
  12559. },
  12560. "title": {
  12561. "type": "string",
  12562. "x-go-name": "Title"
  12563. },
  12564. "url": {
  12565. "type": "string",
  12566. "x-go-name": "URL"
  12567. },
  12568. "user": {
  12569. "$ref": "#/definitions/User"
  12570. }
  12571. },
  12572. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12573. },
  12574. "PullRequest": {
  12575. "description": "PullRequest represents a pull request",
  12576. "type": "object",
  12577. "properties": {
  12578. "assignee": {
  12579. "$ref": "#/definitions/User"
  12580. },
  12581. "assignees": {
  12582. "type": "array",
  12583. "items": {
  12584. "$ref": "#/definitions/User"
  12585. },
  12586. "x-go-name": "Assignees"
  12587. },
  12588. "base": {
  12589. "$ref": "#/definitions/PRBranchInfo"
  12590. },
  12591. "body": {
  12592. "type": "string",
  12593. "x-go-name": "Body"
  12594. },
  12595. "closed_at": {
  12596. "type": "string",
  12597. "format": "date-time",
  12598. "x-go-name": "Closed"
  12599. },
  12600. "comments": {
  12601. "type": "integer",
  12602. "format": "int64",
  12603. "x-go-name": "Comments"
  12604. },
  12605. "created_at": {
  12606. "type": "string",
  12607. "format": "date-time",
  12608. "x-go-name": "Created"
  12609. },
  12610. "diff_url": {
  12611. "type": "string",
  12612. "x-go-name": "DiffURL"
  12613. },
  12614. "due_date": {
  12615. "type": "string",
  12616. "format": "date-time",
  12617. "x-go-name": "Deadline"
  12618. },
  12619. "head": {
  12620. "$ref": "#/definitions/PRBranchInfo"
  12621. },
  12622. "html_url": {
  12623. "type": "string",
  12624. "x-go-name": "HTMLURL"
  12625. },
  12626. "id": {
  12627. "type": "integer",
  12628. "format": "int64",
  12629. "x-go-name": "ID"
  12630. },
  12631. "labels": {
  12632. "type": "array",
  12633. "items": {
  12634. "$ref": "#/definitions/Label"
  12635. },
  12636. "x-go-name": "Labels"
  12637. },
  12638. "merge_base": {
  12639. "type": "string",
  12640. "x-go-name": "MergeBase"
  12641. },
  12642. "merge_commit_sha": {
  12643. "type": "string",
  12644. "x-go-name": "MergedCommitID"
  12645. },
  12646. "mergeable": {
  12647. "type": "boolean",
  12648. "x-go-name": "Mergeable"
  12649. },
  12650. "merged": {
  12651. "type": "boolean",
  12652. "x-go-name": "HasMerged"
  12653. },
  12654. "merged_at": {
  12655. "type": "string",
  12656. "format": "date-time",
  12657. "x-go-name": "Merged"
  12658. },
  12659. "merged_by": {
  12660. "$ref": "#/definitions/User"
  12661. },
  12662. "milestone": {
  12663. "$ref": "#/definitions/Milestone"
  12664. },
  12665. "number": {
  12666. "type": "integer",
  12667. "format": "int64",
  12668. "x-go-name": "Index"
  12669. },
  12670. "patch_url": {
  12671. "type": "string",
  12672. "x-go-name": "PatchURL"
  12673. },
  12674. "state": {
  12675. "$ref": "#/definitions/StateType"
  12676. },
  12677. "title": {
  12678. "type": "string",
  12679. "x-go-name": "Title"
  12680. },
  12681. "updated_at": {
  12682. "type": "string",
  12683. "format": "date-time",
  12684. "x-go-name": "Updated"
  12685. },
  12686. "url": {
  12687. "type": "string",
  12688. "x-go-name": "URL"
  12689. },
  12690. "user": {
  12691. "$ref": "#/definitions/User"
  12692. }
  12693. },
  12694. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12695. },
  12696. "PullRequestMeta": {
  12697. "description": "PullRequestMeta PR info if an issue is a PR",
  12698. "type": "object",
  12699. "properties": {
  12700. "merged": {
  12701. "type": "boolean",
  12702. "x-go-name": "HasMerged"
  12703. },
  12704. "merged_at": {
  12705. "type": "string",
  12706. "format": "date-time",
  12707. "x-go-name": "Merged"
  12708. }
  12709. },
  12710. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12711. },
  12712. "Reaction": {
  12713. "description": "Reaction contain one reaction",
  12714. "type": "object",
  12715. "properties": {
  12716. "content": {
  12717. "type": "string",
  12718. "x-go-name": "Reaction"
  12719. },
  12720. "created_at": {
  12721. "type": "string",
  12722. "format": "date-time",
  12723. "x-go-name": "Created"
  12724. },
  12725. "user": {
  12726. "$ref": "#/definitions/User"
  12727. }
  12728. },
  12729. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12730. },
  12731. "Reference": {
  12732. "type": "object",
  12733. "title": "Reference represents a Git reference.",
  12734. "properties": {
  12735. "object": {
  12736. "$ref": "#/definitions/GitObject"
  12737. },
  12738. "ref": {
  12739. "type": "string",
  12740. "x-go-name": "Ref"
  12741. },
  12742. "url": {
  12743. "type": "string",
  12744. "x-go-name": "URL"
  12745. }
  12746. },
  12747. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12748. },
  12749. "Release": {
  12750. "description": "Release represents a repository release",
  12751. "type": "object",
  12752. "properties": {
  12753. "assets": {
  12754. "type": "array",
  12755. "items": {
  12756. "$ref": "#/definitions/Attachment"
  12757. },
  12758. "x-go-name": "Attachments"
  12759. },
  12760. "author": {
  12761. "$ref": "#/definitions/User"
  12762. },
  12763. "body": {
  12764. "type": "string",
  12765. "x-go-name": "Note"
  12766. },
  12767. "created_at": {
  12768. "type": "string",
  12769. "format": "date-time",
  12770. "x-go-name": "CreatedAt"
  12771. },
  12772. "draft": {
  12773. "type": "boolean",
  12774. "x-go-name": "IsDraft"
  12775. },
  12776. "id": {
  12777. "type": "integer",
  12778. "format": "int64",
  12779. "x-go-name": "ID"
  12780. },
  12781. "name": {
  12782. "type": "string",
  12783. "x-go-name": "Title"
  12784. },
  12785. "prerelease": {
  12786. "type": "boolean",
  12787. "x-go-name": "IsPrerelease"
  12788. },
  12789. "published_at": {
  12790. "type": "string",
  12791. "format": "date-time",
  12792. "x-go-name": "PublishedAt"
  12793. },
  12794. "tag_name": {
  12795. "type": "string",
  12796. "x-go-name": "TagName"
  12797. },
  12798. "tarball_url": {
  12799. "type": "string",
  12800. "x-go-name": "TarURL"
  12801. },
  12802. "target_commitish": {
  12803. "type": "string",
  12804. "x-go-name": "Target"
  12805. },
  12806. "url": {
  12807. "type": "string",
  12808. "x-go-name": "URL"
  12809. },
  12810. "zipball_url": {
  12811. "type": "string",
  12812. "x-go-name": "ZipURL"
  12813. }
  12814. },
  12815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12816. },
  12817. "RepoCommit": {
  12818. "type": "object",
  12819. "title": "RepoCommit contains information of a commit in the context of a repository.",
  12820. "properties": {
  12821. "author": {
  12822. "$ref": "#/definitions/CommitUser"
  12823. },
  12824. "committer": {
  12825. "$ref": "#/definitions/CommitUser"
  12826. },
  12827. "message": {
  12828. "type": "string",
  12829. "x-go-name": "Message"
  12830. },
  12831. "tree": {
  12832. "$ref": "#/definitions/CommitMeta"
  12833. },
  12834. "url": {
  12835. "type": "string",
  12836. "x-go-name": "URL"
  12837. }
  12838. },
  12839. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12840. },
  12841. "RepoTopicOptions": {
  12842. "description": "RepoTopicOptions a collection of repo topic names",
  12843. "type": "object",
  12844. "properties": {
  12845. "topics": {
  12846. "description": "list of topic names",
  12847. "type": "array",
  12848. "items": {
  12849. "type": "string"
  12850. },
  12851. "x-go-name": "Topics"
  12852. }
  12853. },
  12854. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12855. },
  12856. "Repository": {
  12857. "description": "Repository represents a repository",
  12858. "type": "object",
  12859. "properties": {
  12860. "allow_merge_commits": {
  12861. "type": "boolean",
  12862. "x-go-name": "AllowMerge"
  12863. },
  12864. "allow_rebase": {
  12865. "type": "boolean",
  12866. "x-go-name": "AllowRebase"
  12867. },
  12868. "allow_rebase_explicit": {
  12869. "type": "boolean",
  12870. "x-go-name": "AllowRebaseMerge"
  12871. },
  12872. "allow_squash_merge": {
  12873. "type": "boolean",
  12874. "x-go-name": "AllowSquash"
  12875. },
  12876. "archived": {
  12877. "type": "boolean",
  12878. "x-go-name": "Archived"
  12879. },
  12880. "avatar_url": {
  12881. "type": "string",
  12882. "x-go-name": "AvatarURL"
  12883. },
  12884. "clone_url": {
  12885. "type": "string",
  12886. "x-go-name": "CloneURL"
  12887. },
  12888. "created_at": {
  12889. "type": "string",
  12890. "format": "date-time",
  12891. "x-go-name": "Created"
  12892. },
  12893. "default_branch": {
  12894. "type": "string",
  12895. "x-go-name": "DefaultBranch"
  12896. },
  12897. "description": {
  12898. "type": "string",
  12899. "x-go-name": "Description"
  12900. },
  12901. "empty": {
  12902. "type": "boolean",
  12903. "x-go-name": "Empty"
  12904. },
  12905. "external_tracker": {
  12906. "$ref": "#/definitions/ExternalTracker"
  12907. },
  12908. "external_wiki": {
  12909. "$ref": "#/definitions/ExternalWiki"
  12910. },
  12911. "fork": {
  12912. "type": "boolean",
  12913. "x-go-name": "Fork"
  12914. },
  12915. "forks_count": {
  12916. "type": "integer",
  12917. "format": "int64",
  12918. "x-go-name": "Forks"
  12919. },
  12920. "full_name": {
  12921. "type": "string",
  12922. "x-go-name": "FullName"
  12923. },
  12924. "has_issues": {
  12925. "type": "boolean",
  12926. "x-go-name": "HasIssues"
  12927. },
  12928. "has_pull_requests": {
  12929. "type": "boolean",
  12930. "x-go-name": "HasPullRequests"
  12931. },
  12932. "has_wiki": {
  12933. "type": "boolean",
  12934. "x-go-name": "HasWiki"
  12935. },
  12936. "html_url": {
  12937. "type": "string",
  12938. "x-go-name": "HTMLURL"
  12939. },
  12940. "id": {
  12941. "type": "integer",
  12942. "format": "int64",
  12943. "x-go-name": "ID"
  12944. },
  12945. "ignore_whitespace_conflicts": {
  12946. "type": "boolean",
  12947. "x-go-name": "IgnoreWhitespaceConflicts"
  12948. },
  12949. "internal_tracker": {
  12950. "$ref": "#/definitions/InternalTracker"
  12951. },
  12952. "mirror": {
  12953. "type": "boolean",
  12954. "x-go-name": "Mirror"
  12955. },
  12956. "name": {
  12957. "type": "string",
  12958. "x-go-name": "Name"
  12959. },
  12960. "open_issues_count": {
  12961. "type": "integer",
  12962. "format": "int64",
  12963. "x-go-name": "OpenIssues"
  12964. },
  12965. "open_pr_counter": {
  12966. "type": "integer",
  12967. "format": "int64",
  12968. "x-go-name": "OpenPulls"
  12969. },
  12970. "original_url": {
  12971. "type": "string",
  12972. "x-go-name": "OriginalURL"
  12973. },
  12974. "owner": {
  12975. "$ref": "#/definitions/User"
  12976. },
  12977. "parent": {
  12978. "$ref": "#/definitions/Repository"
  12979. },
  12980. "permissions": {
  12981. "$ref": "#/definitions/Permission"
  12982. },
  12983. "private": {
  12984. "type": "boolean",
  12985. "x-go-name": "Private"
  12986. },
  12987. "release_counter": {
  12988. "type": "integer",
  12989. "format": "int64",
  12990. "x-go-name": "Releases"
  12991. },
  12992. "size": {
  12993. "type": "integer",
  12994. "format": "int64",
  12995. "x-go-name": "Size"
  12996. },
  12997. "ssh_url": {
  12998. "type": "string",
  12999. "x-go-name": "SSHURL"
  13000. },
  13001. "stars_count": {
  13002. "type": "integer",
  13003. "format": "int64",
  13004. "x-go-name": "Stars"
  13005. },
  13006. "template": {
  13007. "type": "boolean",
  13008. "x-go-name": "Template"
  13009. },
  13010. "updated_at": {
  13011. "type": "string",
  13012. "format": "date-time",
  13013. "x-go-name": "Updated"
  13014. },
  13015. "watchers_count": {
  13016. "type": "integer",
  13017. "format": "int64",
  13018. "x-go-name": "Watchers"
  13019. },
  13020. "website": {
  13021. "type": "string",
  13022. "x-go-name": "Website"
  13023. }
  13024. },
  13025. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13026. },
  13027. "RepositoryMeta": {
  13028. "description": "RepositoryMeta basic repository information",
  13029. "type": "object",
  13030. "properties": {
  13031. "full_name": {
  13032. "type": "string",
  13033. "x-go-name": "FullName"
  13034. },
  13035. "id": {
  13036. "type": "integer",
  13037. "format": "int64",
  13038. "x-go-name": "ID"
  13039. },
  13040. "name": {
  13041. "type": "string",
  13042. "x-go-name": "Name"
  13043. },
  13044. "owner": {
  13045. "type": "string",
  13046. "x-go-name": "Owner"
  13047. }
  13048. },
  13049. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13050. },
  13051. "SearchResults": {
  13052. "description": "SearchResults results of a successful search",
  13053. "type": "object",
  13054. "properties": {
  13055. "data": {
  13056. "type": "array",
  13057. "items": {
  13058. "$ref": "#/definitions/Repository"
  13059. },
  13060. "x-go-name": "Data"
  13061. },
  13062. "ok": {
  13063. "type": "boolean",
  13064. "x-go-name": "OK"
  13065. }
  13066. },
  13067. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13068. },
  13069. "ServerVersion": {
  13070. "description": "ServerVersion wraps the version of the server",
  13071. "type": "object",
  13072. "properties": {
  13073. "version": {
  13074. "type": "string",
  13075. "x-go-name": "Version"
  13076. }
  13077. },
  13078. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13079. },
  13080. "StateType": {
  13081. "description": "StateType issue state type",
  13082. "type": "string",
  13083. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13084. },
  13085. "Status": {
  13086. "description": "Status holds a single Status of a single Commit",
  13087. "type": "object",
  13088. "properties": {
  13089. "context": {
  13090. "type": "string",
  13091. "x-go-name": "Context"
  13092. },
  13093. "created_at": {
  13094. "type": "string",
  13095. "format": "date-time",
  13096. "x-go-name": "Created"
  13097. },
  13098. "creator": {
  13099. "$ref": "#/definitions/User"
  13100. },
  13101. "description": {
  13102. "type": "string",
  13103. "x-go-name": "Description"
  13104. },
  13105. "id": {
  13106. "type": "integer",
  13107. "format": "int64",
  13108. "x-go-name": "ID"
  13109. },
  13110. "status": {
  13111. "$ref": "#/definitions/StatusState"
  13112. },
  13113. "target_url": {
  13114. "type": "string",
  13115. "x-go-name": "TargetURL"
  13116. },
  13117. "updated_at": {
  13118. "type": "string",
  13119. "format": "date-time",
  13120. "x-go-name": "Updated"
  13121. },
  13122. "url": {
  13123. "type": "string",
  13124. "x-go-name": "URL"
  13125. }
  13126. },
  13127. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13128. },
  13129. "StatusState": {
  13130. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  13131. "type": "string",
  13132. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13133. },
  13134. "StopWatch": {
  13135. "description": "StopWatch represent a running stopwatch",
  13136. "type": "object",
  13137. "properties": {
  13138. "created": {
  13139. "type": "string",
  13140. "format": "date-time",
  13141. "x-go-name": "Created"
  13142. },
  13143. "issue_index": {
  13144. "type": "integer",
  13145. "format": "int64",
  13146. "x-go-name": "IssueIndex"
  13147. }
  13148. },
  13149. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13150. },
  13151. "Tag": {
  13152. "description": "Tag represents a repository tag",
  13153. "type": "object",
  13154. "properties": {
  13155. "commit": {
  13156. "$ref": "#/definitions/CommitMeta"
  13157. },
  13158. "id": {
  13159. "type": "string",
  13160. "x-go-name": "ID"
  13161. },
  13162. "name": {
  13163. "type": "string",
  13164. "x-go-name": "Name"
  13165. },
  13166. "tarball_url": {
  13167. "type": "string",
  13168. "x-go-name": "TarballURL"
  13169. },
  13170. "zipball_url": {
  13171. "type": "string",
  13172. "x-go-name": "ZipballURL"
  13173. }
  13174. },
  13175. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13176. },
  13177. "Team": {
  13178. "description": "Team represents a team in an organization",
  13179. "type": "object",
  13180. "properties": {
  13181. "can_create_org_repo": {
  13182. "type": "boolean",
  13183. "x-go-name": "CanCreateOrgRepo"
  13184. },
  13185. "description": {
  13186. "type": "string",
  13187. "x-go-name": "Description"
  13188. },
  13189. "id": {
  13190. "type": "integer",
  13191. "format": "int64",
  13192. "x-go-name": "ID"
  13193. },
  13194. "includes_all_repositories": {
  13195. "type": "boolean",
  13196. "x-go-name": "IncludesAllRepositories"
  13197. },
  13198. "name": {
  13199. "type": "string",
  13200. "x-go-name": "Name"
  13201. },
  13202. "organization": {
  13203. "$ref": "#/definitions/Organization"
  13204. },
  13205. "permission": {
  13206. "type": "string",
  13207. "enum": [
  13208. "none",
  13209. "read",
  13210. "write",
  13211. "admin",
  13212. "owner"
  13213. ],
  13214. "x-go-name": "Permission"
  13215. },
  13216. "units": {
  13217. "type": "array",
  13218. "items": {
  13219. "type": "string"
  13220. },
  13221. "x-go-name": "Units",
  13222. "example": [
  13223. "repo.code",
  13224. "repo.issues",
  13225. "repo.ext_issues",
  13226. "repo.wiki",
  13227. "repo.pulls",
  13228. "repo.releases",
  13229. "repo.ext_wiki"
  13230. ]
  13231. }
  13232. },
  13233. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13234. },
  13235. "TimeStamp": {
  13236. "description": "TimeStamp defines a timestamp",
  13237. "type": "integer",
  13238. "format": "int64",
  13239. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  13240. },
  13241. "TopicName": {
  13242. "description": "TopicName a list of repo topic names",
  13243. "type": "object",
  13244. "properties": {
  13245. "topics": {
  13246. "type": "array",
  13247. "items": {
  13248. "type": "string"
  13249. },
  13250. "x-go-name": "TopicNames"
  13251. }
  13252. },
  13253. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13254. },
  13255. "TopicResponse": {
  13256. "description": "TopicResponse for returning topics",
  13257. "type": "object",
  13258. "properties": {
  13259. "created": {
  13260. "type": "string",
  13261. "format": "date-time",
  13262. "x-go-name": "Created"
  13263. },
  13264. "id": {
  13265. "type": "integer",
  13266. "format": "int64",
  13267. "x-go-name": "ID"
  13268. },
  13269. "repo_count": {
  13270. "type": "integer",
  13271. "format": "int64",
  13272. "x-go-name": "RepoCount"
  13273. },
  13274. "topic_name": {
  13275. "type": "string",
  13276. "x-go-name": "Name"
  13277. },
  13278. "updated": {
  13279. "type": "string",
  13280. "format": "date-time",
  13281. "x-go-name": "Updated"
  13282. }
  13283. },
  13284. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13285. },
  13286. "TrackedTime": {
  13287. "description": "TrackedTime worked time for an issue / pr",
  13288. "type": "object",
  13289. "properties": {
  13290. "created": {
  13291. "type": "string",
  13292. "format": "date-time",
  13293. "x-go-name": "Created"
  13294. },
  13295. "id": {
  13296. "type": "integer",
  13297. "format": "int64",
  13298. "x-go-name": "ID"
  13299. },
  13300. "issue": {
  13301. "$ref": "#/definitions/Issue"
  13302. },
  13303. "issue_id": {
  13304. "description": "deprecated (only for backwards compatibility)",
  13305. "type": "integer",
  13306. "format": "int64",
  13307. "x-go-name": "IssueID"
  13308. },
  13309. "time": {
  13310. "description": "Time in seconds",
  13311. "type": "integer",
  13312. "format": "int64",
  13313. "x-go-name": "Time"
  13314. },
  13315. "user_id": {
  13316. "description": "deprecated (only for backwards compatibility)",
  13317. "type": "integer",
  13318. "format": "int64",
  13319. "x-go-name": "UserID"
  13320. },
  13321. "user_name": {
  13322. "type": "string",
  13323. "x-go-name": "UserName"
  13324. }
  13325. },
  13326. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13327. },
  13328. "TransferRepoOption": {
  13329. "description": "TransferRepoOption options when transfer a repository's ownership",
  13330. "type": "object",
  13331. "required": [
  13332. "new_owner"
  13333. ],
  13334. "properties": {
  13335. "new_owner": {
  13336. "type": "string",
  13337. "x-go-name": "NewOwner"
  13338. },
  13339. "team_ids": {
  13340. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  13341. "type": "array",
  13342. "items": {
  13343. "type": "integer",
  13344. "format": "int64"
  13345. },
  13346. "x-go-name": "TeamIDs"
  13347. }
  13348. },
  13349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13350. },
  13351. "UpdateFileOptions": {
  13352. "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)",
  13353. "type": "object",
  13354. "required": [
  13355. "sha",
  13356. "content"
  13357. ],
  13358. "properties": {
  13359. "author": {
  13360. "$ref": "#/definitions/Identity"
  13361. },
  13362. "branch": {
  13363. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  13364. "type": "string",
  13365. "x-go-name": "BranchName"
  13366. },
  13367. "committer": {
  13368. "$ref": "#/definitions/Identity"
  13369. },
  13370. "content": {
  13371. "description": "content must be base64 encoded",
  13372. "type": "string",
  13373. "x-go-name": "Content"
  13374. },
  13375. "dates": {
  13376. "$ref": "#/definitions/CommitDateOptions"
  13377. },
  13378. "from_path": {
  13379. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  13380. "type": "string",
  13381. "x-go-name": "FromPath"
  13382. },
  13383. "message": {
  13384. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  13385. "type": "string",
  13386. "x-go-name": "Message"
  13387. },
  13388. "new_branch": {
  13389. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  13390. "type": "string",
  13391. "x-go-name": "NewBranchName"
  13392. },
  13393. "sha": {
  13394. "description": "sha is the SHA for the file that already exists",
  13395. "type": "string",
  13396. "x-go-name": "SHA"
  13397. }
  13398. },
  13399. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13400. },
  13401. "User": {
  13402. "description": "User represents a user",
  13403. "type": "object",
  13404. "properties": {
  13405. "avatar_url": {
  13406. "description": "URL to the user's avatar",
  13407. "type": "string",
  13408. "x-go-name": "AvatarURL"
  13409. },
  13410. "created": {
  13411. "type": "string",
  13412. "format": "date-time",
  13413. "x-go-name": "Created"
  13414. },
  13415. "email": {
  13416. "type": "string",
  13417. "format": "email",
  13418. "x-go-name": "Email"
  13419. },
  13420. "full_name": {
  13421. "description": "the user's full name",
  13422. "type": "string",
  13423. "x-go-name": "FullName"
  13424. },
  13425. "id": {
  13426. "description": "the user's id",
  13427. "type": "integer",
  13428. "format": "int64",
  13429. "x-go-name": "ID"
  13430. },
  13431. "is_admin": {
  13432. "description": "Is the user an administrator",
  13433. "type": "boolean",
  13434. "x-go-name": "IsAdmin"
  13435. },
  13436. "language": {
  13437. "description": "User locale",
  13438. "type": "string",
  13439. "x-go-name": "Language"
  13440. },
  13441. "last_login": {
  13442. "type": "string",
  13443. "format": "date-time",
  13444. "x-go-name": "LastLogin"
  13445. },
  13446. "login": {
  13447. "description": "the user's username",
  13448. "type": "string",
  13449. "x-go-name": "UserName"
  13450. }
  13451. },
  13452. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13453. },
  13454. "UserHeatmapData": {
  13455. "description": "UserHeatmapData represents the data needed to create a heatmap",
  13456. "type": "object",
  13457. "properties": {
  13458. "contributions": {
  13459. "type": "integer",
  13460. "format": "int64",
  13461. "x-go-name": "Contributions"
  13462. },
  13463. "timestamp": {
  13464. "$ref": "#/definitions/TimeStamp"
  13465. }
  13466. },
  13467. "x-go-package": "code.gitea.io/gitea/models"
  13468. },
  13469. "WatchInfo": {
  13470. "description": "WatchInfo represents an API watch status of one repository",
  13471. "type": "object",
  13472. "properties": {
  13473. "created_at": {
  13474. "type": "string",
  13475. "format": "date-time",
  13476. "x-go-name": "CreatedAt"
  13477. },
  13478. "ignored": {
  13479. "type": "boolean",
  13480. "x-go-name": "Ignored"
  13481. },
  13482. "reason": {
  13483. "type": "object",
  13484. "x-go-name": "Reason"
  13485. },
  13486. "repository_url": {
  13487. "type": "string",
  13488. "x-go-name": "RepositoryURL"
  13489. },
  13490. "subscribed": {
  13491. "type": "boolean",
  13492. "x-go-name": "Subscribed"
  13493. },
  13494. "url": {
  13495. "type": "string",
  13496. "x-go-name": "URL"
  13497. }
  13498. },
  13499. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13500. }
  13501. },
  13502. "responses": {
  13503. "AccessToken": {
  13504. "description": "AccessToken represents an API access token.",
  13505. "headers": {
  13506. "id": {
  13507. "type": "integer",
  13508. "format": "int64"
  13509. },
  13510. "name": {
  13511. "type": "string"
  13512. },
  13513. "sha1": {
  13514. "type": "string"
  13515. },
  13516. "token_last_eight": {
  13517. "type": "string"
  13518. }
  13519. }
  13520. },
  13521. "AccessTokenList": {
  13522. "description": "AccessTokenList represents a list of API access token.",
  13523. "schema": {
  13524. "type": "array",
  13525. "items": {
  13526. "$ref": "#/definitions/AccessToken"
  13527. }
  13528. }
  13529. },
  13530. "AnnotatedTag": {
  13531. "description": "AnnotatedTag",
  13532. "schema": {
  13533. "$ref": "#/definitions/AnnotatedTag"
  13534. }
  13535. },
  13536. "Attachment": {
  13537. "description": "Attachment",
  13538. "schema": {
  13539. "$ref": "#/definitions/Attachment"
  13540. }
  13541. },
  13542. "AttachmentList": {
  13543. "description": "AttachmentList",
  13544. "schema": {
  13545. "type": "array",
  13546. "items": {
  13547. "$ref": "#/definitions/Attachment"
  13548. }
  13549. }
  13550. },
  13551. "Branch": {
  13552. "description": "Branch",
  13553. "schema": {
  13554. "$ref": "#/definitions/Branch"
  13555. }
  13556. },
  13557. "BranchList": {
  13558. "description": "BranchList",
  13559. "schema": {
  13560. "type": "array",
  13561. "items": {
  13562. "$ref": "#/definitions/Branch"
  13563. }
  13564. }
  13565. },
  13566. "BranchProtection": {
  13567. "description": "BranchProtection",
  13568. "schema": {
  13569. "$ref": "#/definitions/BranchProtection"
  13570. }
  13571. },
  13572. "BranchProtectionList": {
  13573. "description": "BranchProtectionList",
  13574. "schema": {
  13575. "type": "array",
  13576. "items": {
  13577. "$ref": "#/definitions/BranchProtection"
  13578. }
  13579. }
  13580. },
  13581. "Comment": {
  13582. "description": "Comment",
  13583. "schema": {
  13584. "$ref": "#/definitions/Comment"
  13585. }
  13586. },
  13587. "CommentList": {
  13588. "description": "CommentList",
  13589. "schema": {
  13590. "type": "array",
  13591. "items": {
  13592. "$ref": "#/definitions/Comment"
  13593. }
  13594. }
  13595. },
  13596. "Commit": {
  13597. "description": "Commit",
  13598. "schema": {
  13599. "$ref": "#/definitions/Commit"
  13600. }
  13601. },
  13602. "CommitList": {
  13603. "description": "CommitList",
  13604. "schema": {
  13605. "type": "array",
  13606. "items": {
  13607. "$ref": "#/definitions/Commit"
  13608. }
  13609. },
  13610. "headers": {
  13611. "X-HasMore": {
  13612. "type": "boolean",
  13613. "description": "True if there is another page"
  13614. },
  13615. "X-Page": {
  13616. "type": "integer",
  13617. "format": "int64",
  13618. "description": "The current page"
  13619. },
  13620. "X-PageCount": {
  13621. "type": "integer",
  13622. "format": "int64",
  13623. "description": "Total number of pages"
  13624. },
  13625. "X-PerPage": {
  13626. "type": "integer",
  13627. "format": "int64",
  13628. "description": "Commits per page"
  13629. },
  13630. "X-Total": {
  13631. "type": "integer",
  13632. "format": "int64",
  13633. "description": "Total commit count"
  13634. }
  13635. }
  13636. },
  13637. "ContentsListResponse": {
  13638. "description": "ContentsListResponse",
  13639. "schema": {
  13640. "type": "array",
  13641. "items": {
  13642. "$ref": "#/definitions/ContentsResponse"
  13643. }
  13644. }
  13645. },
  13646. "ContentsResponse": {
  13647. "description": "ContentsResponse",
  13648. "schema": {
  13649. "$ref": "#/definitions/ContentsResponse"
  13650. }
  13651. },
  13652. "DeployKey": {
  13653. "description": "DeployKey",
  13654. "schema": {
  13655. "$ref": "#/definitions/DeployKey"
  13656. }
  13657. },
  13658. "DeployKeyList": {
  13659. "description": "DeployKeyList",
  13660. "schema": {
  13661. "type": "array",
  13662. "items": {
  13663. "$ref": "#/definitions/DeployKey"
  13664. }
  13665. }
  13666. },
  13667. "EmailList": {
  13668. "description": "EmailList",
  13669. "schema": {
  13670. "type": "array",
  13671. "items": {
  13672. "$ref": "#/definitions/Email"
  13673. }
  13674. }
  13675. },
  13676. "EmptyRepository": {
  13677. "description": "EmptyRepository",
  13678. "schema": {
  13679. "$ref": "#/definitions/APIError"
  13680. }
  13681. },
  13682. "FileDeleteResponse": {
  13683. "description": "FileDeleteResponse",
  13684. "schema": {
  13685. "$ref": "#/definitions/FileDeleteResponse"
  13686. }
  13687. },
  13688. "FileResponse": {
  13689. "description": "FileResponse",
  13690. "schema": {
  13691. "$ref": "#/definitions/FileResponse"
  13692. }
  13693. },
  13694. "GPGKey": {
  13695. "description": "GPGKey",
  13696. "schema": {
  13697. "$ref": "#/definitions/GPGKey"
  13698. }
  13699. },
  13700. "GPGKeyList": {
  13701. "description": "GPGKeyList",
  13702. "schema": {
  13703. "type": "array",
  13704. "items": {
  13705. "$ref": "#/definitions/GPGKey"
  13706. }
  13707. }
  13708. },
  13709. "GitBlobResponse": {
  13710. "description": "GitBlobResponse",
  13711. "schema": {
  13712. "$ref": "#/definitions/GitBlobResponse"
  13713. }
  13714. },
  13715. "GitHook": {
  13716. "description": "GitHook",
  13717. "schema": {
  13718. "$ref": "#/definitions/GitHook"
  13719. }
  13720. },
  13721. "GitHookList": {
  13722. "description": "GitHookList",
  13723. "schema": {
  13724. "type": "array",
  13725. "items": {
  13726. "$ref": "#/definitions/GitHook"
  13727. }
  13728. }
  13729. },
  13730. "GitTreeResponse": {
  13731. "description": "GitTreeResponse",
  13732. "schema": {
  13733. "$ref": "#/definitions/GitTreeResponse"
  13734. }
  13735. },
  13736. "Hook": {
  13737. "description": "Hook",
  13738. "schema": {
  13739. "$ref": "#/definitions/Hook"
  13740. }
  13741. },
  13742. "HookList": {
  13743. "description": "HookList",
  13744. "schema": {
  13745. "type": "array",
  13746. "items": {
  13747. "$ref": "#/definitions/Hook"
  13748. }
  13749. }
  13750. },
  13751. "Issue": {
  13752. "description": "Issue",
  13753. "schema": {
  13754. "$ref": "#/definitions/Issue"
  13755. }
  13756. },
  13757. "IssueDeadline": {
  13758. "description": "IssueDeadline",
  13759. "schema": {
  13760. "$ref": "#/definitions/IssueDeadline"
  13761. }
  13762. },
  13763. "IssueList": {
  13764. "description": "IssueList",
  13765. "schema": {
  13766. "type": "array",
  13767. "items": {
  13768. "$ref": "#/definitions/Issue"
  13769. }
  13770. }
  13771. },
  13772. "Label": {
  13773. "description": "Label",
  13774. "schema": {
  13775. "$ref": "#/definitions/Label"
  13776. }
  13777. },
  13778. "LabelList": {
  13779. "description": "LabelList",
  13780. "schema": {
  13781. "type": "array",
  13782. "items": {
  13783. "$ref": "#/definitions/Label"
  13784. }
  13785. }
  13786. },
  13787. "MarkdownRender": {
  13788. "description": "MarkdownRender is a rendered markdown document",
  13789. "schema": {
  13790. "type": "string"
  13791. }
  13792. },
  13793. "Milestone": {
  13794. "description": "Milestone",
  13795. "schema": {
  13796. "$ref": "#/definitions/Milestone"
  13797. }
  13798. },
  13799. "MilestoneList": {
  13800. "description": "MilestoneList",
  13801. "schema": {
  13802. "type": "array",
  13803. "items": {
  13804. "$ref": "#/definitions/Milestone"
  13805. }
  13806. }
  13807. },
  13808. "NotificationCount": {
  13809. "description": "Number of unread notifications",
  13810. "schema": {
  13811. "$ref": "#/definitions/NotificationCount"
  13812. }
  13813. },
  13814. "NotificationThread": {
  13815. "description": "NotificationThread",
  13816. "schema": {
  13817. "$ref": "#/definitions/NotificationThread"
  13818. }
  13819. },
  13820. "NotificationThreadList": {
  13821. "description": "NotificationThreadList",
  13822. "schema": {
  13823. "type": "array",
  13824. "items": {
  13825. "$ref": "#/definitions/NotificationThread"
  13826. }
  13827. }
  13828. },
  13829. "OAuth2Application": {
  13830. "description": "OAuth2Application",
  13831. "schema": {
  13832. "$ref": "#/definitions/OAuth2Application"
  13833. }
  13834. },
  13835. "OAuth2ApplicationList": {
  13836. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  13837. "schema": {
  13838. "type": "array",
  13839. "items": {
  13840. "$ref": "#/definitions/OAuth2Application"
  13841. }
  13842. }
  13843. },
  13844. "Organization": {
  13845. "description": "Organization",
  13846. "schema": {
  13847. "$ref": "#/definitions/Organization"
  13848. }
  13849. },
  13850. "OrganizationList": {
  13851. "description": "OrganizationList",
  13852. "schema": {
  13853. "type": "array",
  13854. "items": {
  13855. "$ref": "#/definitions/Organization"
  13856. }
  13857. }
  13858. },
  13859. "PublicKey": {
  13860. "description": "PublicKey",
  13861. "schema": {
  13862. "$ref": "#/definitions/PublicKey"
  13863. }
  13864. },
  13865. "PublicKeyList": {
  13866. "description": "PublicKeyList",
  13867. "schema": {
  13868. "type": "array",
  13869. "items": {
  13870. "$ref": "#/definitions/PublicKey"
  13871. }
  13872. }
  13873. },
  13874. "PullRequest": {
  13875. "description": "PullRequest",
  13876. "schema": {
  13877. "$ref": "#/definitions/PullRequest"
  13878. }
  13879. },
  13880. "PullRequestList": {
  13881. "description": "PullRequestList",
  13882. "schema": {
  13883. "type": "array",
  13884. "items": {
  13885. "$ref": "#/definitions/PullRequest"
  13886. }
  13887. }
  13888. },
  13889. "Reaction": {
  13890. "description": "Reaction",
  13891. "schema": {
  13892. "$ref": "#/definitions/Reaction"
  13893. }
  13894. },
  13895. "ReactionList": {
  13896. "description": "ReactionList",
  13897. "schema": {
  13898. "type": "array",
  13899. "items": {
  13900. "$ref": "#/definitions/Reaction"
  13901. }
  13902. }
  13903. },
  13904. "Reference": {
  13905. "description": "Reference",
  13906. "schema": {
  13907. "$ref": "#/definitions/Reference"
  13908. }
  13909. },
  13910. "ReferenceList": {
  13911. "description": "ReferenceList",
  13912. "schema": {
  13913. "type": "array",
  13914. "items": {
  13915. "$ref": "#/definitions/Reference"
  13916. }
  13917. }
  13918. },
  13919. "Release": {
  13920. "description": "Release",
  13921. "schema": {
  13922. "$ref": "#/definitions/Release"
  13923. }
  13924. },
  13925. "ReleaseList": {
  13926. "description": "ReleaseList",
  13927. "schema": {
  13928. "type": "array",
  13929. "items": {
  13930. "$ref": "#/definitions/Release"
  13931. }
  13932. }
  13933. },
  13934. "Repository": {
  13935. "description": "Repository",
  13936. "schema": {
  13937. "$ref": "#/definitions/Repository"
  13938. }
  13939. },
  13940. "RepositoryList": {
  13941. "description": "RepositoryList",
  13942. "schema": {
  13943. "type": "array",
  13944. "items": {
  13945. "$ref": "#/definitions/Repository"
  13946. }
  13947. }
  13948. },
  13949. "SearchResults": {
  13950. "description": "SearchResults",
  13951. "schema": {
  13952. "$ref": "#/definitions/SearchResults"
  13953. }
  13954. },
  13955. "ServerVersion": {
  13956. "description": "ServerVersion",
  13957. "schema": {
  13958. "$ref": "#/definitions/ServerVersion"
  13959. }
  13960. },
  13961. "Status": {
  13962. "description": "Status",
  13963. "schema": {
  13964. "$ref": "#/definitions/Status"
  13965. }
  13966. },
  13967. "StatusList": {
  13968. "description": "StatusList",
  13969. "schema": {
  13970. "type": "array",
  13971. "items": {
  13972. "$ref": "#/definitions/Status"
  13973. }
  13974. }
  13975. },
  13976. "StopWatch": {
  13977. "description": "StopWatch",
  13978. "schema": {
  13979. "$ref": "#/definitions/StopWatch"
  13980. }
  13981. },
  13982. "StopWatchList": {
  13983. "description": "StopWatchList",
  13984. "schema": {
  13985. "type": "array",
  13986. "items": {
  13987. "$ref": "#/definitions/StopWatch"
  13988. }
  13989. }
  13990. },
  13991. "Tag": {
  13992. "description": "Tag",
  13993. "schema": {
  13994. "$ref": "#/definitions/Tag"
  13995. }
  13996. },
  13997. "TagList": {
  13998. "description": "TagList",
  13999. "schema": {
  14000. "type": "array",
  14001. "items": {
  14002. "$ref": "#/definitions/Tag"
  14003. }
  14004. }
  14005. },
  14006. "Team": {
  14007. "description": "Team",
  14008. "schema": {
  14009. "$ref": "#/definitions/Team"
  14010. }
  14011. },
  14012. "TeamList": {
  14013. "description": "TeamList",
  14014. "schema": {
  14015. "type": "array",
  14016. "items": {
  14017. "$ref": "#/definitions/Team"
  14018. }
  14019. }
  14020. },
  14021. "TopicListResponse": {
  14022. "description": "TopicListResponse",
  14023. "schema": {
  14024. "type": "array",
  14025. "items": {
  14026. "$ref": "#/definitions/TopicResponse"
  14027. }
  14028. }
  14029. },
  14030. "TopicNames": {
  14031. "description": "TopicNames",
  14032. "schema": {
  14033. "$ref": "#/definitions/TopicName"
  14034. }
  14035. },
  14036. "TrackedTime": {
  14037. "description": "TrackedTime",
  14038. "schema": {
  14039. "$ref": "#/definitions/TrackedTime"
  14040. }
  14041. },
  14042. "TrackedTimeList": {
  14043. "description": "TrackedTimeList",
  14044. "schema": {
  14045. "type": "array",
  14046. "items": {
  14047. "$ref": "#/definitions/TrackedTime"
  14048. }
  14049. }
  14050. },
  14051. "User": {
  14052. "description": "User",
  14053. "schema": {
  14054. "$ref": "#/definitions/User"
  14055. }
  14056. },
  14057. "UserHeatmapData": {
  14058. "description": "UserHeatmapData",
  14059. "schema": {
  14060. "type": "array",
  14061. "items": {
  14062. "$ref": "#/definitions/UserHeatmapData"
  14063. }
  14064. }
  14065. },
  14066. "UserList": {
  14067. "description": "UserList",
  14068. "schema": {
  14069. "type": "array",
  14070. "items": {
  14071. "$ref": "#/definitions/User"
  14072. }
  14073. }
  14074. },
  14075. "WatchInfo": {
  14076. "description": "WatchInfo",
  14077. "schema": {
  14078. "$ref": "#/definitions/WatchInfo"
  14079. }
  14080. },
  14081. "empty": {
  14082. "description": "APIEmpty is an empty response"
  14083. },
  14084. "error": {
  14085. "description": "APIError is error format response",
  14086. "headers": {
  14087. "message": {
  14088. "type": "string"
  14089. },
  14090. "url": {
  14091. "type": "string"
  14092. }
  14093. }
  14094. },
  14095. "forbidden": {
  14096. "description": "APIForbiddenError is a forbidden error response",
  14097. "headers": {
  14098. "message": {
  14099. "type": "string"
  14100. },
  14101. "url": {
  14102. "type": "string"
  14103. }
  14104. }
  14105. },
  14106. "invalidTopicsError": {
  14107. "description": "APIInvalidTopicsError is error format response to invalid topics",
  14108. "headers": {
  14109. "invalidTopics": {
  14110. "type": "array",
  14111. "items": {
  14112. "type": "string"
  14113. }
  14114. },
  14115. "message": {
  14116. "type": "string"
  14117. }
  14118. }
  14119. },
  14120. "notFound": {
  14121. "description": "APINotFound is a not found empty response"
  14122. },
  14123. "parameterBodies": {
  14124. "description": "parameterBodies",
  14125. "schema": {
  14126. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  14127. }
  14128. },
  14129. "redirect": {
  14130. "description": "APIRedirect is a redirect response"
  14131. },
  14132. "validationError": {
  14133. "description": "APIValidationError is error format response related to input validation",
  14134. "headers": {
  14135. "message": {
  14136. "type": "string"
  14137. },
  14138. "url": {
  14139. "type": "string"
  14140. }
  14141. }
  14142. }
  14143. },
  14144. "securityDefinitions": {
  14145. "AccessToken": {
  14146. "type": "apiKey",
  14147. "name": "access_token",
  14148. "in": "query"
  14149. },
  14150. "AuthorizationHeaderToken": {
  14151. "description": "API tokens must be prepended with \"token\" followed by a space.",
  14152. "type": "apiKey",
  14153. "name": "Authorization",
  14154. "in": "header"
  14155. },
  14156. "BasicAuth": {
  14157. "type": "basic"
  14158. },
  14159. "SudoHeader": {
  14160. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  14161. "type": "apiKey",
  14162. "name": "Sudo",
  14163. "in": "header"
  14164. },
  14165. "SudoParam": {
  14166. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  14167. "type": "apiKey",
  14168. "name": "sudo",
  14169. "in": "query"
  14170. },
  14171. "Token": {
  14172. "type": "apiKey",
  14173. "name": "token",
  14174. "in": "query"
  14175. }
  14176. },
  14177. "security": [
  14178. {
  14179. "BasicAuth": []
  14180. },
  14181. {
  14182. "Token": []
  14183. },
  14184. {
  14185. "AccessToken": []
  14186. },
  14187. {
  14188. "AuthorizationHeaderToken": []
  14189. },
  14190. {
  14191. "SudoParam": []
  14192. },
  14193. {
  14194. "SudoHeader": []
  14195. }
  14196. ]
  14197. }