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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416
  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. "responses": {
  37. "200": {
  38. "$ref": "#/responses/OrganizationList"
  39. },
  40. "403": {
  41. "$ref": "#/responses/forbidden"
  42. }
  43. }
  44. }
  45. },
  46. "/admin/users": {
  47. "get": {
  48. "produces": [
  49. "application/json"
  50. ],
  51. "tags": [
  52. "admin"
  53. ],
  54. "summary": "List all users",
  55. "operationId": "adminGetAllUsers",
  56. "responses": {
  57. "200": {
  58. "$ref": "#/responses/UserList"
  59. },
  60. "403": {
  61. "$ref": "#/responses/forbidden"
  62. }
  63. }
  64. },
  65. "post": {
  66. "consumes": [
  67. "application/json"
  68. ],
  69. "produces": [
  70. "application/json"
  71. ],
  72. "tags": [
  73. "admin"
  74. ],
  75. "summary": "Create a user",
  76. "operationId": "adminCreateUser",
  77. "parameters": [
  78. {
  79. "name": "body",
  80. "in": "body",
  81. "schema": {
  82. "$ref": "#/definitions/CreateUserOption"
  83. }
  84. }
  85. ],
  86. "responses": {
  87. "201": {
  88. "$ref": "#/responses/User"
  89. },
  90. "403": {
  91. "$ref": "#/responses/forbidden"
  92. },
  93. "422": {
  94. "$ref": "#/responses/validationError"
  95. }
  96. }
  97. }
  98. },
  99. "/admin/users/{username}": {
  100. "delete": {
  101. "produces": [
  102. "application/json"
  103. ],
  104. "tags": [
  105. "admin"
  106. ],
  107. "summary": "Delete a user",
  108. "operationId": "adminDeleteUser",
  109. "parameters": [
  110. {
  111. "type": "string",
  112. "description": "username of user to delete",
  113. "name": "username",
  114. "in": "path",
  115. "required": true
  116. }
  117. ],
  118. "responses": {
  119. "204": {
  120. "$ref": "#/responses/empty"
  121. },
  122. "403": {
  123. "$ref": "#/responses/forbidden"
  124. },
  125. "422": {
  126. "$ref": "#/responses/validationError"
  127. }
  128. }
  129. },
  130. "patch": {
  131. "consumes": [
  132. "application/json"
  133. ],
  134. "produces": [
  135. "application/json"
  136. ],
  137. "tags": [
  138. "admin"
  139. ],
  140. "summary": "Edit an existing user",
  141. "operationId": "adminEditUser",
  142. "parameters": [
  143. {
  144. "type": "string",
  145. "description": "username of user to edit",
  146. "name": "username",
  147. "in": "path",
  148. "required": true
  149. },
  150. {
  151. "name": "body",
  152. "in": "body",
  153. "schema": {
  154. "$ref": "#/definitions/EditUserOption"
  155. }
  156. }
  157. ],
  158. "responses": {
  159. "200": {
  160. "$ref": "#/responses/User"
  161. },
  162. "403": {
  163. "$ref": "#/responses/forbidden"
  164. },
  165. "422": {
  166. "$ref": "#/responses/validationError"
  167. }
  168. }
  169. }
  170. },
  171. "/admin/users/{username}/keys": {
  172. "post": {
  173. "consumes": [
  174. "application/json"
  175. ],
  176. "produces": [
  177. "application/json"
  178. ],
  179. "tags": [
  180. "admin"
  181. ],
  182. "summary": "Add a public key on behalf of a user",
  183. "operationId": "adminCreatePublicKey",
  184. "parameters": [
  185. {
  186. "type": "string",
  187. "description": "username of the user",
  188. "name": "username",
  189. "in": "path",
  190. "required": true
  191. },
  192. {
  193. "name": "key",
  194. "in": "body",
  195. "schema": {
  196. "$ref": "#/definitions/CreateKeyOption"
  197. }
  198. }
  199. ],
  200. "responses": {
  201. "201": {
  202. "$ref": "#/responses/PublicKey"
  203. },
  204. "403": {
  205. "$ref": "#/responses/forbidden"
  206. },
  207. "422": {
  208. "$ref": "#/responses/validationError"
  209. }
  210. }
  211. }
  212. },
  213. "/admin/users/{username}/keys/{id}": {
  214. "delete": {
  215. "produces": [
  216. "application/json"
  217. ],
  218. "tags": [
  219. "admin"
  220. ],
  221. "summary": "Delete a user's public key",
  222. "operationId": "adminDeleteUserPublicKey",
  223. "parameters": [
  224. {
  225. "type": "string",
  226. "description": "username of user",
  227. "name": "username",
  228. "in": "path",
  229. "required": true
  230. },
  231. {
  232. "type": "integer",
  233. "format": "int64",
  234. "description": "id of the key to delete",
  235. "name": "id",
  236. "in": "path",
  237. "required": true
  238. }
  239. ],
  240. "responses": {
  241. "204": {
  242. "$ref": "#/responses/empty"
  243. },
  244. "403": {
  245. "$ref": "#/responses/forbidden"
  246. },
  247. "404": {
  248. "$ref": "#/responses/notFound"
  249. }
  250. }
  251. }
  252. },
  253. "/admin/users/{username}/orgs": {
  254. "post": {
  255. "consumes": [
  256. "application/json"
  257. ],
  258. "produces": [
  259. "application/json"
  260. ],
  261. "tags": [
  262. "admin"
  263. ],
  264. "summary": "Create an organization",
  265. "operationId": "adminCreateOrg",
  266. "parameters": [
  267. {
  268. "type": "string",
  269. "description": "username of the user that will own the created organization",
  270. "name": "username",
  271. "in": "path",
  272. "required": true
  273. },
  274. {
  275. "name": "organization",
  276. "in": "body",
  277. "required": true,
  278. "schema": {
  279. "$ref": "#/definitions/CreateOrgOption"
  280. }
  281. }
  282. ],
  283. "responses": {
  284. "201": {
  285. "$ref": "#/responses/Organization"
  286. },
  287. "403": {
  288. "$ref": "#/responses/forbidden"
  289. },
  290. "422": {
  291. "$ref": "#/responses/validationError"
  292. }
  293. }
  294. }
  295. },
  296. "/admin/users/{username}/repos": {
  297. "post": {
  298. "consumes": [
  299. "application/json"
  300. ],
  301. "produces": [
  302. "application/json"
  303. ],
  304. "tags": [
  305. "admin"
  306. ],
  307. "summary": "Create a repository on behalf a user",
  308. "operationId": "adminCreateRepo",
  309. "parameters": [
  310. {
  311. "type": "string",
  312. "description": "username of the user. This user will own the created repository",
  313. "name": "username",
  314. "in": "path",
  315. "required": true
  316. },
  317. {
  318. "name": "repository",
  319. "in": "body",
  320. "required": true,
  321. "schema": {
  322. "$ref": "#/definitions/CreateRepoOption"
  323. }
  324. }
  325. ],
  326. "responses": {
  327. "201": {
  328. "$ref": "#/responses/Repository"
  329. },
  330. "403": {
  331. "$ref": "#/responses/forbidden"
  332. },
  333. "422": {
  334. "$ref": "#/responses/validationError"
  335. }
  336. }
  337. }
  338. },
  339. "/markdown": {
  340. "post": {
  341. "consumes": [
  342. "application/json"
  343. ],
  344. "produces": [
  345. "text/html"
  346. ],
  347. "tags": [
  348. "miscellaneous"
  349. ],
  350. "summary": "Render a markdown document as HTML",
  351. "operationId": "renderMarkdown",
  352. "parameters": [
  353. {
  354. "name": "body",
  355. "in": "body",
  356. "schema": {
  357. "$ref": "#/definitions/MarkdownOption"
  358. }
  359. }
  360. ],
  361. "responses": {
  362. "200": {
  363. "$ref": "#/responses/MarkdownRender"
  364. },
  365. "422": {
  366. "$ref": "#/responses/validationError"
  367. }
  368. }
  369. }
  370. },
  371. "/markdown/raw": {
  372. "post": {
  373. "consumes": [
  374. "text/plain"
  375. ],
  376. "produces": [
  377. "text/html"
  378. ],
  379. "tags": [
  380. "miscellaneous"
  381. ],
  382. "summary": "Render raw markdown as HTML",
  383. "operationId": "renderMarkdownRaw",
  384. "parameters": [
  385. {
  386. "description": "Request body to render",
  387. "name": "body",
  388. "in": "body",
  389. "required": true,
  390. "schema": {
  391. "type": "string"
  392. }
  393. }
  394. ],
  395. "responses": {
  396. "200": {
  397. "$ref": "#/responses/MarkdownRender"
  398. },
  399. "422": {
  400. "$ref": "#/responses/validationError"
  401. }
  402. }
  403. }
  404. },
  405. "/org/{org}/repos": {
  406. "post": {
  407. "consumes": [
  408. "application/json"
  409. ],
  410. "produces": [
  411. "application/json"
  412. ],
  413. "tags": [
  414. "organization"
  415. ],
  416. "summary": "Create a repository in an organization",
  417. "operationId": "createOrgRepo",
  418. "parameters": [
  419. {
  420. "type": "string",
  421. "description": "name of organization",
  422. "name": "org",
  423. "in": "path",
  424. "required": true
  425. },
  426. {
  427. "name": "body",
  428. "in": "body",
  429. "schema": {
  430. "$ref": "#/definitions/CreateRepoOption"
  431. }
  432. }
  433. ],
  434. "responses": {
  435. "201": {
  436. "$ref": "#/responses/Repository"
  437. },
  438. "403": {
  439. "$ref": "#/responses/forbidden"
  440. },
  441. "422": {
  442. "$ref": "#/responses/validationError"
  443. }
  444. }
  445. }
  446. },
  447. "/orgs": {
  448. "post": {
  449. "consumes": [
  450. "application/json"
  451. ],
  452. "produces": [
  453. "application/json"
  454. ],
  455. "tags": [
  456. "organization"
  457. ],
  458. "summary": "Create an organization",
  459. "operationId": "orgCreate",
  460. "parameters": [
  461. {
  462. "name": "organization",
  463. "in": "body",
  464. "required": true,
  465. "schema": {
  466. "$ref": "#/definitions/CreateOrgOption"
  467. }
  468. }
  469. ],
  470. "responses": {
  471. "201": {
  472. "$ref": "#/responses/Organization"
  473. },
  474. "403": {
  475. "$ref": "#/responses/forbidden"
  476. },
  477. "422": {
  478. "$ref": "#/responses/validationError"
  479. }
  480. }
  481. }
  482. },
  483. "/orgs/{org}": {
  484. "get": {
  485. "produces": [
  486. "application/json"
  487. ],
  488. "tags": [
  489. "organization"
  490. ],
  491. "summary": "Get an organization",
  492. "operationId": "orgGet",
  493. "parameters": [
  494. {
  495. "type": "string",
  496. "description": "name of the organization to get",
  497. "name": "org",
  498. "in": "path",
  499. "required": true
  500. }
  501. ],
  502. "responses": {
  503. "200": {
  504. "$ref": "#/responses/Organization"
  505. }
  506. }
  507. },
  508. "delete": {
  509. "produces": [
  510. "application/json"
  511. ],
  512. "tags": [
  513. "organization"
  514. ],
  515. "summary": "Delete an organization",
  516. "operationId": "orgDelete",
  517. "parameters": [
  518. {
  519. "type": "string",
  520. "description": "organization that is to be deleted",
  521. "name": "org",
  522. "in": "path",
  523. "required": true
  524. }
  525. ],
  526. "responses": {
  527. "204": {
  528. "$ref": "#/responses/empty"
  529. }
  530. }
  531. },
  532. "patch": {
  533. "consumes": [
  534. "application/json"
  535. ],
  536. "produces": [
  537. "application/json"
  538. ],
  539. "tags": [
  540. "organization"
  541. ],
  542. "summary": "Edit an organization",
  543. "operationId": "orgEdit",
  544. "parameters": [
  545. {
  546. "type": "string",
  547. "description": "name of the organization to edit",
  548. "name": "org",
  549. "in": "path",
  550. "required": true
  551. },
  552. {
  553. "name": "body",
  554. "in": "body",
  555. "required": true,
  556. "schema": {
  557. "$ref": "#/definitions/EditOrgOption"
  558. }
  559. }
  560. ],
  561. "responses": {
  562. "200": {
  563. "$ref": "#/responses/Organization"
  564. }
  565. }
  566. }
  567. },
  568. "/orgs/{org}/hooks": {
  569. "get": {
  570. "produces": [
  571. "application/json"
  572. ],
  573. "tags": [
  574. "organization"
  575. ],
  576. "summary": "List an organization's webhooks",
  577. "operationId": "orgListHooks",
  578. "parameters": [
  579. {
  580. "type": "string",
  581. "description": "name of the organization",
  582. "name": "org",
  583. "in": "path",
  584. "required": true
  585. }
  586. ],
  587. "responses": {
  588. "200": {
  589. "$ref": "#/responses/HookList"
  590. }
  591. }
  592. }
  593. },
  594. "/orgs/{org}/hooks/": {
  595. "post": {
  596. "consumes": [
  597. "application/json"
  598. ],
  599. "produces": [
  600. "application/json"
  601. ],
  602. "tags": [
  603. "organization"
  604. ],
  605. "summary": "Create a hook",
  606. "operationId": "orgCreateHook",
  607. "parameters": [
  608. {
  609. "type": "string",
  610. "description": "name of the organization",
  611. "name": "org",
  612. "in": "path",
  613. "required": true
  614. },
  615. {
  616. "name": "body",
  617. "in": "body",
  618. "required": true,
  619. "schema": {
  620. "$ref": "#/definitions/CreateHookOption"
  621. }
  622. }
  623. ],
  624. "responses": {
  625. "201": {
  626. "$ref": "#/responses/Hook"
  627. }
  628. }
  629. }
  630. },
  631. "/orgs/{org}/hooks/{id}": {
  632. "get": {
  633. "produces": [
  634. "application/json"
  635. ],
  636. "tags": [
  637. "organization"
  638. ],
  639. "summary": "Get a hook",
  640. "operationId": "orgGetHook",
  641. "parameters": [
  642. {
  643. "type": "string",
  644. "description": "name of the organization",
  645. "name": "org",
  646. "in": "path",
  647. "required": true
  648. },
  649. {
  650. "type": "integer",
  651. "format": "int64",
  652. "description": "id of the hook to get",
  653. "name": "id",
  654. "in": "path",
  655. "required": true
  656. }
  657. ],
  658. "responses": {
  659. "200": {
  660. "$ref": "#/responses/Hook"
  661. }
  662. }
  663. },
  664. "delete": {
  665. "produces": [
  666. "application/json"
  667. ],
  668. "tags": [
  669. "organization"
  670. ],
  671. "summary": "Delete a hook",
  672. "operationId": "orgDeleteHook",
  673. "parameters": [
  674. {
  675. "type": "string",
  676. "description": "name of the organization",
  677. "name": "org",
  678. "in": "path",
  679. "required": true
  680. },
  681. {
  682. "type": "integer",
  683. "format": "int64",
  684. "description": "id of the hook to delete",
  685. "name": "id",
  686. "in": "path",
  687. "required": true
  688. }
  689. ],
  690. "responses": {
  691. "204": {
  692. "$ref": "#/responses/empty"
  693. }
  694. }
  695. },
  696. "patch": {
  697. "consumes": [
  698. "application/json"
  699. ],
  700. "produces": [
  701. "application/json"
  702. ],
  703. "tags": [
  704. "organization"
  705. ],
  706. "summary": "Update a hook",
  707. "operationId": "orgEditHook",
  708. "parameters": [
  709. {
  710. "type": "string",
  711. "description": "name of the organization",
  712. "name": "org",
  713. "in": "path",
  714. "required": true
  715. },
  716. {
  717. "type": "integer",
  718. "format": "int64",
  719. "description": "id of the hook to update",
  720. "name": "id",
  721. "in": "path",
  722. "required": true
  723. },
  724. {
  725. "name": "body",
  726. "in": "body",
  727. "schema": {
  728. "$ref": "#/definitions/EditHookOption"
  729. }
  730. }
  731. ],
  732. "responses": {
  733. "200": {
  734. "$ref": "#/responses/Hook"
  735. }
  736. }
  737. }
  738. },
  739. "/orgs/{org}/members": {
  740. "get": {
  741. "produces": [
  742. "application/json"
  743. ],
  744. "tags": [
  745. "organization"
  746. ],
  747. "summary": "List an organization's members",
  748. "operationId": "orgListMembers",
  749. "parameters": [
  750. {
  751. "type": "string",
  752. "description": "name of the organization",
  753. "name": "org",
  754. "in": "path",
  755. "required": true
  756. }
  757. ],
  758. "responses": {
  759. "200": {
  760. "$ref": "#/responses/UserList"
  761. }
  762. }
  763. }
  764. },
  765. "/orgs/{org}/members/{username}": {
  766. "get": {
  767. "tags": [
  768. "organization"
  769. ],
  770. "summary": "Check if a user is a member of an organization",
  771. "operationId": "orgIsMember",
  772. "parameters": [
  773. {
  774. "type": "string",
  775. "description": "name of the organization",
  776. "name": "org",
  777. "in": "path",
  778. "required": true
  779. },
  780. {
  781. "type": "string",
  782. "description": "username of the user",
  783. "name": "username",
  784. "in": "path",
  785. "required": true
  786. }
  787. ],
  788. "responses": {
  789. "204": {
  790. "description": "user is a member"
  791. },
  792. "404": {
  793. "description": "user is not a member"
  794. }
  795. }
  796. },
  797. "delete": {
  798. "produces": [
  799. "application/json"
  800. ],
  801. "tags": [
  802. "organization"
  803. ],
  804. "summary": "Remove a member from an organization",
  805. "operationId": "orgDeleteMember",
  806. "parameters": [
  807. {
  808. "type": "string",
  809. "description": "name of the organization",
  810. "name": "org",
  811. "in": "path",
  812. "required": true
  813. },
  814. {
  815. "type": "string",
  816. "description": "username of the user",
  817. "name": "username",
  818. "in": "path",
  819. "required": true
  820. }
  821. ],
  822. "responses": {
  823. "204": {
  824. "description": "member removed"
  825. }
  826. }
  827. }
  828. },
  829. "/orgs/{org}/public_members": {
  830. "get": {
  831. "produces": [
  832. "application/json"
  833. ],
  834. "tags": [
  835. "organization"
  836. ],
  837. "summary": "List an organization's public members",
  838. "operationId": "orgListPublicMembers",
  839. "parameters": [
  840. {
  841. "type": "string",
  842. "description": "name of the organization",
  843. "name": "org",
  844. "in": "path",
  845. "required": true
  846. }
  847. ],
  848. "responses": {
  849. "200": {
  850. "$ref": "#/responses/UserList"
  851. }
  852. }
  853. }
  854. },
  855. "/orgs/{org}/public_members/{username}": {
  856. "get": {
  857. "tags": [
  858. "organization"
  859. ],
  860. "summary": "Check if a user is a public member of an organization",
  861. "operationId": "orgIsPublicMember",
  862. "parameters": [
  863. {
  864. "type": "string",
  865. "description": "name of the organization",
  866. "name": "org",
  867. "in": "path",
  868. "required": true
  869. },
  870. {
  871. "type": "string",
  872. "description": "username of the user",
  873. "name": "username",
  874. "in": "path",
  875. "required": true
  876. }
  877. ],
  878. "responses": {
  879. "204": {
  880. "description": "user is a public member"
  881. },
  882. "404": {
  883. "description": "user is not a public member"
  884. }
  885. }
  886. },
  887. "put": {
  888. "produces": [
  889. "application/json"
  890. ],
  891. "tags": [
  892. "organization"
  893. ],
  894. "summary": "Publicize a user's membership",
  895. "operationId": "orgPublicizeMember",
  896. "parameters": [
  897. {
  898. "type": "string",
  899. "description": "name of the organization",
  900. "name": "org",
  901. "in": "path",
  902. "required": true
  903. },
  904. {
  905. "type": "string",
  906. "description": "username of the user",
  907. "name": "username",
  908. "in": "path",
  909. "required": true
  910. }
  911. ],
  912. "responses": {
  913. "204": {
  914. "description": "membership publicized"
  915. }
  916. }
  917. },
  918. "delete": {
  919. "produces": [
  920. "application/json"
  921. ],
  922. "tags": [
  923. "organization"
  924. ],
  925. "summary": "Conceal a user's membership",
  926. "operationId": "orgConcealMember",
  927. "parameters": [
  928. {
  929. "type": "string",
  930. "description": "name of the organization",
  931. "name": "org",
  932. "in": "path",
  933. "required": true
  934. },
  935. {
  936. "type": "string",
  937. "description": "username of the user",
  938. "name": "username",
  939. "in": "path",
  940. "required": true
  941. }
  942. ],
  943. "responses": {
  944. "204": {
  945. "$ref": "#/responses/empty"
  946. }
  947. }
  948. }
  949. },
  950. "/orgs/{org}/repos": {
  951. "get": {
  952. "produces": [
  953. "application/json"
  954. ],
  955. "tags": [
  956. "organization"
  957. ],
  958. "summary": "List an organization's repos",
  959. "operationId": "orgListRepos",
  960. "parameters": [
  961. {
  962. "type": "string",
  963. "description": "name of the organization",
  964. "name": "org",
  965. "in": "path",
  966. "required": true
  967. }
  968. ],
  969. "responses": {
  970. "200": {
  971. "$ref": "#/responses/RepositoryList"
  972. }
  973. }
  974. }
  975. },
  976. "/orgs/{org}/teams": {
  977. "get": {
  978. "produces": [
  979. "application/json"
  980. ],
  981. "tags": [
  982. "organization"
  983. ],
  984. "summary": "List an organization's teams",
  985. "operationId": "orgListTeams",
  986. "parameters": [
  987. {
  988. "type": "string",
  989. "description": "name of the organization",
  990. "name": "org",
  991. "in": "path",
  992. "required": true
  993. }
  994. ],
  995. "responses": {
  996. "200": {
  997. "$ref": "#/responses/TeamList"
  998. }
  999. }
  1000. },
  1001. "post": {
  1002. "consumes": [
  1003. "application/json"
  1004. ],
  1005. "produces": [
  1006. "application/json"
  1007. ],
  1008. "tags": [
  1009. "organization"
  1010. ],
  1011. "summary": "Create a team",
  1012. "operationId": "orgCreateTeam",
  1013. "parameters": [
  1014. {
  1015. "type": "string",
  1016. "description": "name of the organization",
  1017. "name": "org",
  1018. "in": "path",
  1019. "required": true
  1020. },
  1021. {
  1022. "name": "body",
  1023. "in": "body",
  1024. "schema": {
  1025. "$ref": "#/definitions/CreateTeamOption"
  1026. }
  1027. }
  1028. ],
  1029. "responses": {
  1030. "201": {
  1031. "$ref": "#/responses/Team"
  1032. }
  1033. }
  1034. }
  1035. },
  1036. "/repos/migrate": {
  1037. "post": {
  1038. "consumes": [
  1039. "application/json"
  1040. ],
  1041. "produces": [
  1042. "application/json"
  1043. ],
  1044. "tags": [
  1045. "repository"
  1046. ],
  1047. "summary": "Migrate a remote git repository",
  1048. "operationId": "repoMigrate",
  1049. "parameters": [
  1050. {
  1051. "name": "body",
  1052. "in": "body",
  1053. "schema": {
  1054. "$ref": "#/definitions/MigrateRepoForm"
  1055. }
  1056. }
  1057. ],
  1058. "responses": {
  1059. "201": {
  1060. "$ref": "#/responses/Repository"
  1061. }
  1062. }
  1063. }
  1064. },
  1065. "/repos/search": {
  1066. "get": {
  1067. "produces": [
  1068. "application/json"
  1069. ],
  1070. "tags": [
  1071. "repository"
  1072. ],
  1073. "summary": "Search for repositories",
  1074. "operationId": "repoSearch",
  1075. "parameters": [
  1076. {
  1077. "type": "string",
  1078. "description": "keyword",
  1079. "name": "q",
  1080. "in": "query"
  1081. },
  1082. {
  1083. "type": "integer",
  1084. "format": "int64",
  1085. "description": "search only for repos that the user with the given id owns or contributes to",
  1086. "name": "uid",
  1087. "in": "query"
  1088. },
  1089. {
  1090. "type": "integer",
  1091. "format": "int64",
  1092. "description": "search only for repos that the user with the given id has starred",
  1093. "name": "starredBy",
  1094. "in": "query"
  1095. },
  1096. {
  1097. "type": "boolean",
  1098. "description": "include private repositories this user has access to (defaults to true)",
  1099. "name": "private",
  1100. "in": "query"
  1101. },
  1102. {
  1103. "type": "integer",
  1104. "description": "page number of results to return (1-based)",
  1105. "name": "page",
  1106. "in": "query"
  1107. },
  1108. {
  1109. "type": "integer",
  1110. "description": "page size of results, maximum page size is 50",
  1111. "name": "limit",
  1112. "in": "query"
  1113. },
  1114. {
  1115. "type": "string",
  1116. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1117. "name": "mode",
  1118. "in": "query"
  1119. },
  1120. {
  1121. "type": "boolean",
  1122. "description": "if `uid` is given, search only for repos that the user owns",
  1123. "name": "exclusive",
  1124. "in": "query"
  1125. },
  1126. {
  1127. "type": "string",
  1128. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1129. "name": "sort",
  1130. "in": "query"
  1131. },
  1132. {
  1133. "type": "string",
  1134. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1135. "name": "order",
  1136. "in": "query"
  1137. }
  1138. ],
  1139. "responses": {
  1140. "200": {
  1141. "$ref": "#/responses/SearchResults"
  1142. },
  1143. "422": {
  1144. "$ref": "#/responses/validationError"
  1145. }
  1146. }
  1147. }
  1148. },
  1149. "/repos/{owner}/{repo}": {
  1150. "get": {
  1151. "produces": [
  1152. "application/json"
  1153. ],
  1154. "tags": [
  1155. "repository"
  1156. ],
  1157. "summary": "Get a repository",
  1158. "operationId": "repoGet",
  1159. "parameters": [
  1160. {
  1161. "type": "string",
  1162. "description": "owner of the repo",
  1163. "name": "owner",
  1164. "in": "path",
  1165. "required": true
  1166. },
  1167. {
  1168. "type": "string",
  1169. "description": "name of the repo",
  1170. "name": "repo",
  1171. "in": "path",
  1172. "required": true
  1173. }
  1174. ],
  1175. "responses": {
  1176. "200": {
  1177. "$ref": "#/responses/Repository"
  1178. }
  1179. }
  1180. },
  1181. "delete": {
  1182. "produces": [
  1183. "application/json"
  1184. ],
  1185. "tags": [
  1186. "repository"
  1187. ],
  1188. "summary": "Delete a repository",
  1189. "operationId": "repoDelete",
  1190. "parameters": [
  1191. {
  1192. "type": "string",
  1193. "description": "owner of the repo to delete",
  1194. "name": "owner",
  1195. "in": "path",
  1196. "required": true
  1197. },
  1198. {
  1199. "type": "string",
  1200. "description": "name of the repo to delete",
  1201. "name": "repo",
  1202. "in": "path",
  1203. "required": true
  1204. }
  1205. ],
  1206. "responses": {
  1207. "204": {
  1208. "$ref": "#/responses/empty"
  1209. },
  1210. "403": {
  1211. "$ref": "#/responses/forbidden"
  1212. }
  1213. }
  1214. },
  1215. "patch": {
  1216. "produces": [
  1217. "application/json"
  1218. ],
  1219. "tags": [
  1220. "repository"
  1221. ],
  1222. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1223. "operationId": "repoEdit",
  1224. "parameters": [
  1225. {
  1226. "type": "string",
  1227. "description": "owner of the repo to edit",
  1228. "name": "owner",
  1229. "in": "path",
  1230. "required": true
  1231. },
  1232. {
  1233. "type": "string",
  1234. "description": "name of the repo to edit",
  1235. "name": "repo",
  1236. "in": "path",
  1237. "required": true
  1238. },
  1239. {
  1240. "description": "Properties of a repo that you can edit",
  1241. "name": "body",
  1242. "in": "body",
  1243. "schema": {
  1244. "$ref": "#/definitions/EditRepoOption"
  1245. }
  1246. }
  1247. ],
  1248. "responses": {
  1249. "200": {
  1250. "$ref": "#/responses/Repository"
  1251. },
  1252. "403": {
  1253. "$ref": "#/responses/forbidden"
  1254. },
  1255. "422": {
  1256. "$ref": "#/responses/validationError"
  1257. }
  1258. }
  1259. }
  1260. },
  1261. "/repos/{owner}/{repo}/archive/{archive}": {
  1262. "get": {
  1263. "produces": [
  1264. "application/json"
  1265. ],
  1266. "tags": [
  1267. "repository"
  1268. ],
  1269. "summary": "Get an archive of a repository",
  1270. "operationId": "repoGetArchive",
  1271. "parameters": [
  1272. {
  1273. "type": "string",
  1274. "description": "owner of the repo",
  1275. "name": "owner",
  1276. "in": "path",
  1277. "required": true
  1278. },
  1279. {
  1280. "type": "string",
  1281. "description": "name of the repo",
  1282. "name": "repo",
  1283. "in": "path",
  1284. "required": true
  1285. },
  1286. {
  1287. "type": "string",
  1288. "description": "archive to download, consisting of a git reference and archive",
  1289. "name": "archive",
  1290. "in": "path",
  1291. "required": true
  1292. }
  1293. ],
  1294. "responses": {
  1295. "200": {
  1296. "description": "success"
  1297. }
  1298. }
  1299. }
  1300. },
  1301. "/repos/{owner}/{repo}/branches": {
  1302. "get": {
  1303. "produces": [
  1304. "application/json"
  1305. ],
  1306. "tags": [
  1307. "repository"
  1308. ],
  1309. "summary": "List a repository's branches",
  1310. "operationId": "repoListBranches",
  1311. "parameters": [
  1312. {
  1313. "type": "string",
  1314. "description": "owner of the repo",
  1315. "name": "owner",
  1316. "in": "path",
  1317. "required": true
  1318. },
  1319. {
  1320. "type": "string",
  1321. "description": "name of the repo",
  1322. "name": "repo",
  1323. "in": "path",
  1324. "required": true
  1325. }
  1326. ],
  1327. "responses": {
  1328. "200": {
  1329. "$ref": "#/responses/BranchList"
  1330. }
  1331. }
  1332. }
  1333. },
  1334. "/repos/{owner}/{repo}/branches/{branch}": {
  1335. "get": {
  1336. "produces": [
  1337. "application/json"
  1338. ],
  1339. "tags": [
  1340. "repository"
  1341. ],
  1342. "summary": "Retrieve a specific branch from a repository",
  1343. "operationId": "repoGetBranch",
  1344. "parameters": [
  1345. {
  1346. "type": "string",
  1347. "description": "owner of the repo",
  1348. "name": "owner",
  1349. "in": "path",
  1350. "required": true
  1351. },
  1352. {
  1353. "type": "string",
  1354. "description": "name of the repo",
  1355. "name": "repo",
  1356. "in": "path",
  1357. "required": true
  1358. },
  1359. {
  1360. "type": "string",
  1361. "description": "branch to get",
  1362. "name": "branch",
  1363. "in": "path",
  1364. "required": true
  1365. }
  1366. ],
  1367. "responses": {
  1368. "200": {
  1369. "$ref": "#/responses/Branch"
  1370. }
  1371. }
  1372. }
  1373. },
  1374. "/repos/{owner}/{repo}/collaborators": {
  1375. "get": {
  1376. "produces": [
  1377. "application/json"
  1378. ],
  1379. "tags": [
  1380. "repository"
  1381. ],
  1382. "summary": "List a repository's collaborators",
  1383. "operationId": "repoListCollaborators",
  1384. "parameters": [
  1385. {
  1386. "type": "string",
  1387. "description": "owner of the repo",
  1388. "name": "owner",
  1389. "in": "path",
  1390. "required": true
  1391. },
  1392. {
  1393. "type": "string",
  1394. "description": "name of the repo",
  1395. "name": "repo",
  1396. "in": "path",
  1397. "required": true
  1398. }
  1399. ],
  1400. "responses": {
  1401. "200": {
  1402. "$ref": "#/responses/UserList"
  1403. }
  1404. }
  1405. }
  1406. },
  1407. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  1408. "get": {
  1409. "produces": [
  1410. "application/json"
  1411. ],
  1412. "tags": [
  1413. "repository"
  1414. ],
  1415. "summary": "Check if a user is a collaborator of a repository",
  1416. "operationId": "repoCheckCollaborator",
  1417. "parameters": [
  1418. {
  1419. "type": "string",
  1420. "description": "owner of the repo",
  1421. "name": "owner",
  1422. "in": "path",
  1423. "required": true
  1424. },
  1425. {
  1426. "type": "string",
  1427. "description": "name of the repo",
  1428. "name": "repo",
  1429. "in": "path",
  1430. "required": true
  1431. },
  1432. {
  1433. "type": "string",
  1434. "description": "username of the collaborator",
  1435. "name": "collaborator",
  1436. "in": "path",
  1437. "required": true
  1438. }
  1439. ],
  1440. "responses": {
  1441. "204": {
  1442. "$ref": "#/responses/empty"
  1443. },
  1444. "404": {
  1445. "$ref": "#/responses/empty"
  1446. }
  1447. }
  1448. },
  1449. "put": {
  1450. "produces": [
  1451. "application/json"
  1452. ],
  1453. "tags": [
  1454. "repository"
  1455. ],
  1456. "summary": "Add a collaborator to a repository",
  1457. "operationId": "repoAddCollaborator",
  1458. "parameters": [
  1459. {
  1460. "type": "string",
  1461. "description": "owner of the repo",
  1462. "name": "owner",
  1463. "in": "path",
  1464. "required": true
  1465. },
  1466. {
  1467. "type": "string",
  1468. "description": "name of the repo",
  1469. "name": "repo",
  1470. "in": "path",
  1471. "required": true
  1472. },
  1473. {
  1474. "type": "string",
  1475. "description": "username of the collaborator to add",
  1476. "name": "collaborator",
  1477. "in": "path",
  1478. "required": true
  1479. },
  1480. {
  1481. "name": "body",
  1482. "in": "body",
  1483. "schema": {
  1484. "$ref": "#/definitions/AddCollaboratorOption"
  1485. }
  1486. }
  1487. ],
  1488. "responses": {
  1489. "204": {
  1490. "$ref": "#/responses/empty"
  1491. }
  1492. }
  1493. },
  1494. "delete": {
  1495. "produces": [
  1496. "application/json"
  1497. ],
  1498. "tags": [
  1499. "repository"
  1500. ],
  1501. "summary": "Delete a collaborator from a repository",
  1502. "operationId": "repoDeleteCollaborator",
  1503. "parameters": [
  1504. {
  1505. "type": "string",
  1506. "description": "owner of the repo",
  1507. "name": "owner",
  1508. "in": "path",
  1509. "required": true
  1510. },
  1511. {
  1512. "type": "string",
  1513. "description": "name of the repo",
  1514. "name": "repo",
  1515. "in": "path",
  1516. "required": true
  1517. },
  1518. {
  1519. "type": "string",
  1520. "description": "username of the collaborator to delete",
  1521. "name": "collaborator",
  1522. "in": "path",
  1523. "required": true
  1524. }
  1525. ],
  1526. "responses": {
  1527. "204": {
  1528. "$ref": "#/responses/empty"
  1529. }
  1530. }
  1531. }
  1532. },
  1533. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  1534. "get": {
  1535. "produces": [
  1536. "application/json"
  1537. ],
  1538. "tags": [
  1539. "repository"
  1540. ],
  1541. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  1542. "operationId": "repoGetCombinedStatusByRef",
  1543. "parameters": [
  1544. {
  1545. "type": "string",
  1546. "description": "owner of the repo",
  1547. "name": "owner",
  1548. "in": "path",
  1549. "required": true
  1550. },
  1551. {
  1552. "type": "string",
  1553. "description": "name of the repo",
  1554. "name": "repo",
  1555. "in": "path",
  1556. "required": true
  1557. },
  1558. {
  1559. "type": "string",
  1560. "description": "name of branch/tag/commit",
  1561. "name": "ref",
  1562. "in": "path",
  1563. "required": true
  1564. }
  1565. ],
  1566. "responses": {
  1567. "200": {
  1568. "$ref": "#/responses/Status"
  1569. }
  1570. }
  1571. }
  1572. },
  1573. "/repos/{owner}/{repo}/contents": {
  1574. "get": {
  1575. "produces": [
  1576. "application/json"
  1577. ],
  1578. "tags": [
  1579. "repository"
  1580. ],
  1581. "summary": "Gets the metadata of all the entries of the root dir",
  1582. "operationId": "repoGetContentsList",
  1583. "parameters": [
  1584. {
  1585. "type": "string",
  1586. "description": "owner of the repo",
  1587. "name": "owner",
  1588. "in": "path",
  1589. "required": true
  1590. },
  1591. {
  1592. "type": "string",
  1593. "description": "name of the repo",
  1594. "name": "repo",
  1595. "in": "path",
  1596. "required": true
  1597. },
  1598. {
  1599. "type": "string",
  1600. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  1601. "name": "ref",
  1602. "in": "query"
  1603. }
  1604. ],
  1605. "responses": {
  1606. "200": {
  1607. "$ref": "#/responses/ContentsListResponse"
  1608. }
  1609. }
  1610. }
  1611. },
  1612. "/repos/{owner}/{repo}/contents/{filepath}": {
  1613. "get": {
  1614. "produces": [
  1615. "application/json"
  1616. ],
  1617. "tags": [
  1618. "repository"
  1619. ],
  1620. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  1621. "operationId": "repoGetContents",
  1622. "parameters": [
  1623. {
  1624. "type": "string",
  1625. "description": "owner of the repo",
  1626. "name": "owner",
  1627. "in": "path",
  1628. "required": true
  1629. },
  1630. {
  1631. "type": "string",
  1632. "description": "name of the repo",
  1633. "name": "repo",
  1634. "in": "path",
  1635. "required": true
  1636. },
  1637. {
  1638. "type": "string",
  1639. "description": "path of the dir, file, symlink or submodule in the repo",
  1640. "name": "filepath",
  1641. "in": "path",
  1642. "required": true
  1643. },
  1644. {
  1645. "type": "string",
  1646. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  1647. "name": "ref",
  1648. "in": "query"
  1649. }
  1650. ],
  1651. "responses": {
  1652. "200": {
  1653. "$ref": "#/responses/ContentsResponse"
  1654. }
  1655. }
  1656. },
  1657. "put": {
  1658. "consumes": [
  1659. "application/json"
  1660. ],
  1661. "produces": [
  1662. "application/json"
  1663. ],
  1664. "tags": [
  1665. "repository"
  1666. ],
  1667. "summary": "Update a file in a repository",
  1668. "operationId": "repoUpdateFile",
  1669. "parameters": [
  1670. {
  1671. "type": "string",
  1672. "description": "owner of the repo",
  1673. "name": "owner",
  1674. "in": "path",
  1675. "required": true
  1676. },
  1677. {
  1678. "type": "string",
  1679. "description": "name of the repo",
  1680. "name": "repo",
  1681. "in": "path",
  1682. "required": true
  1683. },
  1684. {
  1685. "type": "string",
  1686. "description": "path of the file to update",
  1687. "name": "filepath",
  1688. "in": "path",
  1689. "required": true
  1690. },
  1691. {
  1692. "name": "body",
  1693. "in": "body",
  1694. "required": true,
  1695. "schema": {
  1696. "$ref": "#/definitions/UpdateFileOptions"
  1697. }
  1698. }
  1699. ],
  1700. "responses": {
  1701. "200": {
  1702. "$ref": "#/responses/FileResponse"
  1703. }
  1704. }
  1705. },
  1706. "post": {
  1707. "consumes": [
  1708. "application/json"
  1709. ],
  1710. "produces": [
  1711. "application/json"
  1712. ],
  1713. "tags": [
  1714. "repository"
  1715. ],
  1716. "summary": "Create a file in a repository",
  1717. "operationId": "repoCreateFile",
  1718. "parameters": [
  1719. {
  1720. "type": "string",
  1721. "description": "owner of the repo",
  1722. "name": "owner",
  1723. "in": "path",
  1724. "required": true
  1725. },
  1726. {
  1727. "type": "string",
  1728. "description": "name of the repo",
  1729. "name": "repo",
  1730. "in": "path",
  1731. "required": true
  1732. },
  1733. {
  1734. "type": "string",
  1735. "description": "path of the file to create",
  1736. "name": "filepath",
  1737. "in": "path",
  1738. "required": true
  1739. },
  1740. {
  1741. "name": "body",
  1742. "in": "body",
  1743. "required": true,
  1744. "schema": {
  1745. "$ref": "#/definitions/CreateFileOptions"
  1746. }
  1747. }
  1748. ],
  1749. "responses": {
  1750. "201": {
  1751. "$ref": "#/responses/FileResponse"
  1752. }
  1753. }
  1754. },
  1755. "delete": {
  1756. "consumes": [
  1757. "application/json"
  1758. ],
  1759. "produces": [
  1760. "application/json"
  1761. ],
  1762. "tags": [
  1763. "repository"
  1764. ],
  1765. "summary": "Delete a file in a repository",
  1766. "operationId": "repoDeleteFile",
  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": "path of the file to delete",
  1785. "name": "filepath",
  1786. "in": "path",
  1787. "required": true
  1788. },
  1789. {
  1790. "name": "body",
  1791. "in": "body",
  1792. "required": true,
  1793. "schema": {
  1794. "$ref": "#/definitions/DeleteFileOptions"
  1795. }
  1796. }
  1797. ],
  1798. "responses": {
  1799. "200": {
  1800. "$ref": "#/responses/FileDeleteResponse"
  1801. }
  1802. }
  1803. }
  1804. },
  1805. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  1806. "get": {
  1807. "produces": [
  1808. "application/json"
  1809. ],
  1810. "tags": [
  1811. "repository"
  1812. ],
  1813. "summary": "Get the EditorConfig definitions of a file in a repository",
  1814. "operationId": "repoGetEditorConfig",
  1815. "parameters": [
  1816. {
  1817. "type": "string",
  1818. "description": "owner of the repo",
  1819. "name": "owner",
  1820. "in": "path",
  1821. "required": true
  1822. },
  1823. {
  1824. "type": "string",
  1825. "description": "name of the repo",
  1826. "name": "repo",
  1827. "in": "path",
  1828. "required": true
  1829. },
  1830. {
  1831. "type": "string",
  1832. "description": "filepath of file to get",
  1833. "name": "filepath",
  1834. "in": "path",
  1835. "required": true
  1836. }
  1837. ],
  1838. "responses": {
  1839. "200": {
  1840. "description": "success"
  1841. }
  1842. }
  1843. }
  1844. },
  1845. "/repos/{owner}/{repo}/forks": {
  1846. "get": {
  1847. "produces": [
  1848. "application/json"
  1849. ],
  1850. "tags": [
  1851. "repository"
  1852. ],
  1853. "summary": "List a repository's forks",
  1854. "operationId": "listForks",
  1855. "parameters": [
  1856. {
  1857. "type": "string",
  1858. "description": "owner of the repo",
  1859. "name": "owner",
  1860. "in": "path",
  1861. "required": true
  1862. },
  1863. {
  1864. "type": "string",
  1865. "description": "name of the repo",
  1866. "name": "repo",
  1867. "in": "path",
  1868. "required": true
  1869. }
  1870. ],
  1871. "responses": {
  1872. "200": {
  1873. "$ref": "#/responses/RepositoryList"
  1874. }
  1875. }
  1876. },
  1877. "post": {
  1878. "produces": [
  1879. "application/json"
  1880. ],
  1881. "tags": [
  1882. "repository"
  1883. ],
  1884. "summary": "Fork a repository",
  1885. "operationId": "createFork",
  1886. "parameters": [
  1887. {
  1888. "type": "string",
  1889. "description": "owner of the repo to fork",
  1890. "name": "owner",
  1891. "in": "path",
  1892. "required": true
  1893. },
  1894. {
  1895. "type": "string",
  1896. "description": "name of the repo to fork",
  1897. "name": "repo",
  1898. "in": "path",
  1899. "required": true
  1900. },
  1901. {
  1902. "name": "body",
  1903. "in": "body",
  1904. "schema": {
  1905. "$ref": "#/definitions/CreateForkOption"
  1906. }
  1907. }
  1908. ],
  1909. "responses": {
  1910. "202": {
  1911. "$ref": "#/responses/Repository"
  1912. }
  1913. }
  1914. }
  1915. },
  1916. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  1917. "get": {
  1918. "produces": [
  1919. "application/json"
  1920. ],
  1921. "tags": [
  1922. "repository"
  1923. ],
  1924. "summary": "Gets the blob of a repository.",
  1925. "operationId": "GetBlob",
  1926. "parameters": [
  1927. {
  1928. "type": "string",
  1929. "description": "owner of the repo",
  1930. "name": "owner",
  1931. "in": "path",
  1932. "required": true
  1933. },
  1934. {
  1935. "type": "string",
  1936. "description": "name of the repo",
  1937. "name": "repo",
  1938. "in": "path",
  1939. "required": true
  1940. },
  1941. {
  1942. "type": "string",
  1943. "description": "sha of the commit",
  1944. "name": "sha",
  1945. "in": "path",
  1946. "required": true
  1947. }
  1948. ],
  1949. "responses": {
  1950. "200": {
  1951. "$ref": "#/responses/GitBlobResponse"
  1952. }
  1953. }
  1954. }
  1955. },
  1956. "/repos/{owner}/{repo}/git/commits/{sha}": {
  1957. "get": {
  1958. "produces": [
  1959. "application/json"
  1960. ],
  1961. "tags": [
  1962. "repository"
  1963. ],
  1964. "summary": "Get a single commit from a repository",
  1965. "operationId": "repoGetSingleCommit",
  1966. "parameters": [
  1967. {
  1968. "type": "string",
  1969. "description": "owner of the repo",
  1970. "name": "owner",
  1971. "in": "path",
  1972. "required": true
  1973. },
  1974. {
  1975. "type": "string",
  1976. "description": "name of the repo",
  1977. "name": "repo",
  1978. "in": "path",
  1979. "required": true
  1980. },
  1981. {
  1982. "type": "string",
  1983. "description": "the commit hash",
  1984. "name": "sha",
  1985. "in": "path",
  1986. "required": true
  1987. }
  1988. ],
  1989. "responses": {
  1990. "200": {
  1991. "$ref": "#/responses/Commit"
  1992. },
  1993. "404": {
  1994. "$ref": "#/responses/notFound"
  1995. }
  1996. }
  1997. }
  1998. },
  1999. "/repos/{owner}/{repo}/git/refs": {
  2000. "get": {
  2001. "produces": [
  2002. "application/json"
  2003. ],
  2004. "tags": [
  2005. "repository"
  2006. ],
  2007. "summary": "Get specified ref or filtered repository's refs",
  2008. "operationId": "repoListAllGitRefs",
  2009. "parameters": [
  2010. {
  2011. "type": "string",
  2012. "description": "owner of the repo",
  2013. "name": "owner",
  2014. "in": "path",
  2015. "required": true
  2016. },
  2017. {
  2018. "type": "string",
  2019. "description": "name of the repo",
  2020. "name": "repo",
  2021. "in": "path",
  2022. "required": true
  2023. }
  2024. ],
  2025. "responses": {
  2026. "200": {
  2027. "$ref": "#/responses/ReferenceList"
  2028. },
  2029. "404": {
  2030. "$ref": "#/responses/notFound"
  2031. }
  2032. }
  2033. }
  2034. },
  2035. "/repos/{owner}/{repo}/git/refs/{ref}": {
  2036. "get": {
  2037. "produces": [
  2038. "application/json"
  2039. ],
  2040. "tags": [
  2041. "repository"
  2042. ],
  2043. "summary": "Get specified ref or filtered repository's refs",
  2044. "operationId": "repoListGitRefs",
  2045. "parameters": [
  2046. {
  2047. "type": "string",
  2048. "description": "owner of the repo",
  2049. "name": "owner",
  2050. "in": "path",
  2051. "required": true
  2052. },
  2053. {
  2054. "type": "string",
  2055. "description": "name of the repo",
  2056. "name": "repo",
  2057. "in": "path",
  2058. "required": true
  2059. },
  2060. {
  2061. "type": "string",
  2062. "description": "part or full name of the ref",
  2063. "name": "ref",
  2064. "in": "path",
  2065. "required": true
  2066. }
  2067. ],
  2068. "responses": {
  2069. "200": {
  2070. "$ref": "#/responses/ReferenceList"
  2071. },
  2072. "404": {
  2073. "$ref": "#/responses/notFound"
  2074. }
  2075. }
  2076. }
  2077. },
  2078. "/repos/{owner}/{repo}/git/tags/{sha}": {
  2079. "get": {
  2080. "produces": [
  2081. "application/json"
  2082. ],
  2083. "tags": [
  2084. "repository"
  2085. ],
  2086. "summary": "Gets the tag of a repository.",
  2087. "operationId": "GetTag",
  2088. "parameters": [
  2089. {
  2090. "type": "string",
  2091. "description": "owner of the repo",
  2092. "name": "owner",
  2093. "in": "path",
  2094. "required": true
  2095. },
  2096. {
  2097. "type": "string",
  2098. "description": "name of the repo",
  2099. "name": "repo",
  2100. "in": "path",
  2101. "required": true
  2102. },
  2103. {
  2104. "type": "string",
  2105. "description": "sha of the tag",
  2106. "name": "sha",
  2107. "in": "path",
  2108. "required": true
  2109. }
  2110. ],
  2111. "responses": {
  2112. "200": {
  2113. "$ref": "#/responses/AnnotatedTag"
  2114. }
  2115. }
  2116. }
  2117. },
  2118. "/repos/{owner}/{repo}/git/trees/{sha}": {
  2119. "get": {
  2120. "produces": [
  2121. "application/json"
  2122. ],
  2123. "tags": [
  2124. "repository"
  2125. ],
  2126. "summary": "Gets the tree of a repository.",
  2127. "operationId": "GetTree",
  2128. "parameters": [
  2129. {
  2130. "type": "string",
  2131. "description": "owner of the repo",
  2132. "name": "owner",
  2133. "in": "path",
  2134. "required": true
  2135. },
  2136. {
  2137. "type": "string",
  2138. "description": "name of the repo",
  2139. "name": "repo",
  2140. "in": "path",
  2141. "required": true
  2142. },
  2143. {
  2144. "type": "string",
  2145. "description": "sha of the commit",
  2146. "name": "sha",
  2147. "in": "path",
  2148. "required": true
  2149. },
  2150. {
  2151. "type": "boolean",
  2152. "description": "show all directories and files",
  2153. "name": "recursive",
  2154. "in": "query"
  2155. },
  2156. {
  2157. "type": "integer",
  2158. "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",
  2159. "name": "page",
  2160. "in": "query"
  2161. },
  2162. {
  2163. "type": "integer",
  2164. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  2165. "name": "per_page",
  2166. "in": "query"
  2167. }
  2168. ],
  2169. "responses": {
  2170. "200": {
  2171. "$ref": "#/responses/GitTreeResponse"
  2172. }
  2173. }
  2174. }
  2175. },
  2176. "/repos/{owner}/{repo}/hooks": {
  2177. "get": {
  2178. "produces": [
  2179. "application/json"
  2180. ],
  2181. "tags": [
  2182. "repository"
  2183. ],
  2184. "summary": "List the hooks in a repository",
  2185. "operationId": "repoListHooks",
  2186. "parameters": [
  2187. {
  2188. "type": "string",
  2189. "description": "owner of the repo",
  2190. "name": "owner",
  2191. "in": "path",
  2192. "required": true
  2193. },
  2194. {
  2195. "type": "string",
  2196. "description": "name of the repo",
  2197. "name": "repo",
  2198. "in": "path",
  2199. "required": true
  2200. }
  2201. ],
  2202. "responses": {
  2203. "200": {
  2204. "$ref": "#/responses/HookList"
  2205. }
  2206. }
  2207. },
  2208. "post": {
  2209. "consumes": [
  2210. "application/json"
  2211. ],
  2212. "produces": [
  2213. "application/json"
  2214. ],
  2215. "tags": [
  2216. "repository"
  2217. ],
  2218. "summary": "Create a hook",
  2219. "operationId": "repoCreateHook",
  2220. "parameters": [
  2221. {
  2222. "type": "string",
  2223. "description": "owner of the repo",
  2224. "name": "owner",
  2225. "in": "path",
  2226. "required": true
  2227. },
  2228. {
  2229. "type": "string",
  2230. "description": "name of the repo",
  2231. "name": "repo",
  2232. "in": "path",
  2233. "required": true
  2234. },
  2235. {
  2236. "name": "body",
  2237. "in": "body",
  2238. "schema": {
  2239. "$ref": "#/definitions/CreateHookOption"
  2240. }
  2241. }
  2242. ],
  2243. "responses": {
  2244. "201": {
  2245. "$ref": "#/responses/Hook"
  2246. }
  2247. }
  2248. }
  2249. },
  2250. "/repos/{owner}/{repo}/hooks/git": {
  2251. "get": {
  2252. "produces": [
  2253. "application/json"
  2254. ],
  2255. "tags": [
  2256. "repository"
  2257. ],
  2258. "summary": "List the Git hooks in a repository",
  2259. "operationId": "repoListGitHooks",
  2260. "parameters": [
  2261. {
  2262. "type": "string",
  2263. "description": "owner of the repo",
  2264. "name": "owner",
  2265. "in": "path",
  2266. "required": true
  2267. },
  2268. {
  2269. "type": "string",
  2270. "description": "name of the repo",
  2271. "name": "repo",
  2272. "in": "path",
  2273. "required": true
  2274. }
  2275. ],
  2276. "responses": {
  2277. "200": {
  2278. "$ref": "#/responses/GitHookList"
  2279. }
  2280. }
  2281. }
  2282. },
  2283. "/repos/{owner}/{repo}/hooks/git/{id}": {
  2284. "get": {
  2285. "produces": [
  2286. "application/json"
  2287. ],
  2288. "tags": [
  2289. "repository"
  2290. ],
  2291. "summary": "Get a Git hook",
  2292. "operationId": "repoGetGitHook",
  2293. "parameters": [
  2294. {
  2295. "type": "string",
  2296. "description": "owner of the repo",
  2297. "name": "owner",
  2298. "in": "path",
  2299. "required": true
  2300. },
  2301. {
  2302. "type": "string",
  2303. "description": "name of the repo",
  2304. "name": "repo",
  2305. "in": "path",
  2306. "required": true
  2307. },
  2308. {
  2309. "type": "string",
  2310. "description": "id of the hook to get",
  2311. "name": "id",
  2312. "in": "path",
  2313. "required": true
  2314. }
  2315. ],
  2316. "responses": {
  2317. "200": {
  2318. "$ref": "#/responses/GitHook"
  2319. },
  2320. "404": {
  2321. "$ref": "#/responses/notFound"
  2322. }
  2323. }
  2324. },
  2325. "delete": {
  2326. "produces": [
  2327. "application/json"
  2328. ],
  2329. "tags": [
  2330. "repository"
  2331. ],
  2332. "summary": "Delete a Git hook in a repository",
  2333. "operationId": "repoDeleteGitHook",
  2334. "parameters": [
  2335. {
  2336. "type": "string",
  2337. "description": "owner of the repo",
  2338. "name": "owner",
  2339. "in": "path",
  2340. "required": true
  2341. },
  2342. {
  2343. "type": "string",
  2344. "description": "name of the repo",
  2345. "name": "repo",
  2346. "in": "path",
  2347. "required": true
  2348. },
  2349. {
  2350. "type": "string",
  2351. "description": "id of the hook to get",
  2352. "name": "id",
  2353. "in": "path",
  2354. "required": true
  2355. }
  2356. ],
  2357. "responses": {
  2358. "204": {
  2359. "$ref": "#/responses/empty"
  2360. },
  2361. "404": {
  2362. "$ref": "#/responses/notFound"
  2363. }
  2364. }
  2365. },
  2366. "patch": {
  2367. "produces": [
  2368. "application/json"
  2369. ],
  2370. "tags": [
  2371. "repository"
  2372. ],
  2373. "summary": "Edit a Git hook in a repository",
  2374. "operationId": "repoEditGitHook",
  2375. "parameters": [
  2376. {
  2377. "type": "string",
  2378. "description": "owner of the repo",
  2379. "name": "owner",
  2380. "in": "path",
  2381. "required": true
  2382. },
  2383. {
  2384. "type": "string",
  2385. "description": "name of the repo",
  2386. "name": "repo",
  2387. "in": "path",
  2388. "required": true
  2389. },
  2390. {
  2391. "type": "string",
  2392. "description": "id of the hook to get",
  2393. "name": "id",
  2394. "in": "path",
  2395. "required": true
  2396. },
  2397. {
  2398. "name": "body",
  2399. "in": "body",
  2400. "schema": {
  2401. "$ref": "#/definitions/EditGitHookOption"
  2402. }
  2403. }
  2404. ],
  2405. "responses": {
  2406. "200": {
  2407. "$ref": "#/responses/GitHook"
  2408. },
  2409. "404": {
  2410. "$ref": "#/responses/notFound"
  2411. }
  2412. }
  2413. }
  2414. },
  2415. "/repos/{owner}/{repo}/hooks/{id}": {
  2416. "get": {
  2417. "produces": [
  2418. "application/json"
  2419. ],
  2420. "tags": [
  2421. "repository"
  2422. ],
  2423. "summary": "Get a hook",
  2424. "operationId": "repoGetHook",
  2425. "parameters": [
  2426. {
  2427. "type": "string",
  2428. "description": "owner of the repo",
  2429. "name": "owner",
  2430. "in": "path",
  2431. "required": true
  2432. },
  2433. {
  2434. "type": "string",
  2435. "description": "name of the repo",
  2436. "name": "repo",
  2437. "in": "path",
  2438. "required": true
  2439. },
  2440. {
  2441. "type": "integer",
  2442. "format": "int64",
  2443. "description": "id of the hook to get",
  2444. "name": "id",
  2445. "in": "path",
  2446. "required": true
  2447. }
  2448. ],
  2449. "responses": {
  2450. "200": {
  2451. "$ref": "#/responses/Hook"
  2452. }
  2453. }
  2454. },
  2455. "delete": {
  2456. "produces": [
  2457. "application/json"
  2458. ],
  2459. "tags": [
  2460. "repository"
  2461. ],
  2462. "summary": "Delete a hook in a repository",
  2463. "operationId": "repoDeleteHook",
  2464. "parameters": [
  2465. {
  2466. "type": "string",
  2467. "description": "owner of the repo",
  2468. "name": "owner",
  2469. "in": "path",
  2470. "required": true
  2471. },
  2472. {
  2473. "type": "string",
  2474. "description": "name of the repo",
  2475. "name": "repo",
  2476. "in": "path",
  2477. "required": true
  2478. },
  2479. {
  2480. "type": "integer",
  2481. "format": "int64",
  2482. "description": "id of the hook to delete",
  2483. "name": "id",
  2484. "in": "path",
  2485. "required": true
  2486. }
  2487. ],
  2488. "responses": {
  2489. "204": {
  2490. "$ref": "#/responses/empty"
  2491. },
  2492. "404": {
  2493. "$ref": "#/responses/notFound"
  2494. }
  2495. }
  2496. },
  2497. "patch": {
  2498. "produces": [
  2499. "application/json"
  2500. ],
  2501. "tags": [
  2502. "repository"
  2503. ],
  2504. "summary": "Edit a hook in a repository",
  2505. "operationId": "repoEditHook",
  2506. "parameters": [
  2507. {
  2508. "type": "string",
  2509. "description": "owner of the repo",
  2510. "name": "owner",
  2511. "in": "path",
  2512. "required": true
  2513. },
  2514. {
  2515. "type": "string",
  2516. "description": "name of the repo",
  2517. "name": "repo",
  2518. "in": "path",
  2519. "required": true
  2520. },
  2521. {
  2522. "type": "integer",
  2523. "format": "int64",
  2524. "description": "index of the hook",
  2525. "name": "id",
  2526. "in": "path",
  2527. "required": true
  2528. },
  2529. {
  2530. "name": "body",
  2531. "in": "body",
  2532. "schema": {
  2533. "$ref": "#/definitions/EditHookOption"
  2534. }
  2535. }
  2536. ],
  2537. "responses": {
  2538. "200": {
  2539. "$ref": "#/responses/Hook"
  2540. }
  2541. }
  2542. }
  2543. },
  2544. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  2545. "post": {
  2546. "produces": [
  2547. "application/json"
  2548. ],
  2549. "tags": [
  2550. "repository"
  2551. ],
  2552. "summary": "Test a push webhook",
  2553. "operationId": "repoTestHook",
  2554. "parameters": [
  2555. {
  2556. "type": "string",
  2557. "description": "owner of the repo",
  2558. "name": "owner",
  2559. "in": "path",
  2560. "required": true
  2561. },
  2562. {
  2563. "type": "string",
  2564. "description": "name of the repo",
  2565. "name": "repo",
  2566. "in": "path",
  2567. "required": true
  2568. },
  2569. {
  2570. "type": "integer",
  2571. "format": "int64",
  2572. "description": "id of the hook to test",
  2573. "name": "id",
  2574. "in": "path",
  2575. "required": true
  2576. }
  2577. ],
  2578. "responses": {
  2579. "204": {
  2580. "$ref": "#/responses/empty"
  2581. }
  2582. }
  2583. }
  2584. },
  2585. "/repos/{owner}/{repo}/issues": {
  2586. "get": {
  2587. "produces": [
  2588. "application/json"
  2589. ],
  2590. "tags": [
  2591. "issue"
  2592. ],
  2593. "summary": "List a repository's issues",
  2594. "operationId": "issueListIssues",
  2595. "parameters": [
  2596. {
  2597. "type": "string",
  2598. "description": "owner of the repo",
  2599. "name": "owner",
  2600. "in": "path",
  2601. "required": true
  2602. },
  2603. {
  2604. "type": "string",
  2605. "description": "name of the repo",
  2606. "name": "repo",
  2607. "in": "path",
  2608. "required": true
  2609. },
  2610. {
  2611. "type": "string",
  2612. "description": "whether issue is open or closed",
  2613. "name": "state",
  2614. "in": "query"
  2615. },
  2616. {
  2617. "type": "string",
  2618. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  2619. "name": "labels",
  2620. "in": "query"
  2621. },
  2622. {
  2623. "type": "integer",
  2624. "description": "page number of requested issues",
  2625. "name": "page",
  2626. "in": "query"
  2627. },
  2628. {
  2629. "type": "string",
  2630. "description": "search string",
  2631. "name": "q",
  2632. "in": "query"
  2633. }
  2634. ],
  2635. "responses": {
  2636. "200": {
  2637. "$ref": "#/responses/IssueList"
  2638. }
  2639. }
  2640. },
  2641. "post": {
  2642. "consumes": [
  2643. "application/json"
  2644. ],
  2645. "produces": [
  2646. "application/json"
  2647. ],
  2648. "tags": [
  2649. "issue"
  2650. ],
  2651. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  2652. "operationId": "issueCreateIssue",
  2653. "parameters": [
  2654. {
  2655. "type": "string",
  2656. "description": "owner of the repo",
  2657. "name": "owner",
  2658. "in": "path",
  2659. "required": true
  2660. },
  2661. {
  2662. "type": "string",
  2663. "description": "name of the repo",
  2664. "name": "repo",
  2665. "in": "path",
  2666. "required": true
  2667. },
  2668. {
  2669. "name": "body",
  2670. "in": "body",
  2671. "schema": {
  2672. "$ref": "#/definitions/CreateIssueOption"
  2673. }
  2674. }
  2675. ],
  2676. "responses": {
  2677. "201": {
  2678. "$ref": "#/responses/Issue"
  2679. }
  2680. }
  2681. }
  2682. },
  2683. "/repos/{owner}/{repo}/issues/comments": {
  2684. "get": {
  2685. "produces": [
  2686. "application/json"
  2687. ],
  2688. "tags": [
  2689. "issue"
  2690. ],
  2691. "summary": "List all comments in a repository",
  2692. "operationId": "issueGetRepoComments",
  2693. "parameters": [
  2694. {
  2695. "type": "string",
  2696. "description": "owner of the repo",
  2697. "name": "owner",
  2698. "in": "path",
  2699. "required": true
  2700. },
  2701. {
  2702. "type": "string",
  2703. "description": "name of the repo",
  2704. "name": "repo",
  2705. "in": "path",
  2706. "required": true
  2707. },
  2708. {
  2709. "type": "string",
  2710. "description": "if provided, only comments updated since the provided time are returned.",
  2711. "name": "since",
  2712. "in": "query"
  2713. }
  2714. ],
  2715. "responses": {
  2716. "200": {
  2717. "$ref": "#/responses/CommentList"
  2718. }
  2719. }
  2720. }
  2721. },
  2722. "/repos/{owner}/{repo}/issues/comments/{id}": {
  2723. "delete": {
  2724. "tags": [
  2725. "issue"
  2726. ],
  2727. "summary": "Delete a comment",
  2728. "operationId": "issueDeleteComment",
  2729. "parameters": [
  2730. {
  2731. "type": "string",
  2732. "description": "owner of the repo",
  2733. "name": "owner",
  2734. "in": "path",
  2735. "required": true
  2736. },
  2737. {
  2738. "type": "string",
  2739. "description": "name of the repo",
  2740. "name": "repo",
  2741. "in": "path",
  2742. "required": true
  2743. },
  2744. {
  2745. "type": "integer",
  2746. "format": "int64",
  2747. "description": "id of comment to delete",
  2748. "name": "id",
  2749. "in": "path",
  2750. "required": true
  2751. }
  2752. ],
  2753. "responses": {
  2754. "204": {
  2755. "$ref": "#/responses/empty"
  2756. }
  2757. }
  2758. },
  2759. "patch": {
  2760. "consumes": [
  2761. "application/json"
  2762. ],
  2763. "produces": [
  2764. "application/json"
  2765. ],
  2766. "tags": [
  2767. "issue"
  2768. ],
  2769. "summary": "Edit a comment",
  2770. "operationId": "issueEditComment",
  2771. "parameters": [
  2772. {
  2773. "type": "string",
  2774. "description": "owner of the repo",
  2775. "name": "owner",
  2776. "in": "path",
  2777. "required": true
  2778. },
  2779. {
  2780. "type": "string",
  2781. "description": "name of the repo",
  2782. "name": "repo",
  2783. "in": "path",
  2784. "required": true
  2785. },
  2786. {
  2787. "type": "integer",
  2788. "format": "int64",
  2789. "description": "id of the comment to edit",
  2790. "name": "id",
  2791. "in": "path",
  2792. "required": true
  2793. },
  2794. {
  2795. "name": "body",
  2796. "in": "body",
  2797. "schema": {
  2798. "$ref": "#/definitions/EditIssueCommentOption"
  2799. }
  2800. }
  2801. ],
  2802. "responses": {
  2803. "200": {
  2804. "$ref": "#/responses/Comment"
  2805. }
  2806. }
  2807. }
  2808. },
  2809. "/repos/{owner}/{repo}/issues/{id}/times": {
  2810. "get": {
  2811. "produces": [
  2812. "application/json"
  2813. ],
  2814. "tags": [
  2815. "issue"
  2816. ],
  2817. "summary": "List an issue's tracked times",
  2818. "operationId": "issueTrackedTimes",
  2819. "parameters": [
  2820. {
  2821. "type": "string",
  2822. "description": "owner of the repo",
  2823. "name": "owner",
  2824. "in": "path",
  2825. "required": true
  2826. },
  2827. {
  2828. "type": "string",
  2829. "description": "name of the repo",
  2830. "name": "repo",
  2831. "in": "path",
  2832. "required": true
  2833. },
  2834. {
  2835. "type": "integer",
  2836. "format": "int64",
  2837. "description": "index of the issue",
  2838. "name": "id",
  2839. "in": "path",
  2840. "required": true
  2841. }
  2842. ],
  2843. "responses": {
  2844. "200": {
  2845. "$ref": "#/responses/TrackedTimeList"
  2846. }
  2847. }
  2848. },
  2849. "post": {
  2850. "consumes": [
  2851. "application/json"
  2852. ],
  2853. "produces": [
  2854. "application/json"
  2855. ],
  2856. "tags": [
  2857. "issue"
  2858. ],
  2859. "summary": "Add a tracked time to a issue",
  2860. "operationId": "issueAddTime",
  2861. "parameters": [
  2862. {
  2863. "type": "string",
  2864. "description": "owner of the repo",
  2865. "name": "owner",
  2866. "in": "path",
  2867. "required": true
  2868. },
  2869. {
  2870. "type": "string",
  2871. "description": "name of the repo",
  2872. "name": "repo",
  2873. "in": "path",
  2874. "required": true
  2875. },
  2876. {
  2877. "type": "integer",
  2878. "format": "int64",
  2879. "description": "index of the issue to add tracked time to",
  2880. "name": "id",
  2881. "in": "path",
  2882. "required": true
  2883. },
  2884. {
  2885. "name": "body",
  2886. "in": "body",
  2887. "schema": {
  2888. "$ref": "#/definitions/AddTimeOption"
  2889. }
  2890. }
  2891. ],
  2892. "responses": {
  2893. "200": {
  2894. "$ref": "#/responses/TrackedTime"
  2895. },
  2896. "400": {
  2897. "$ref": "#/responses/error"
  2898. },
  2899. "403": {
  2900. "$ref": "#/responses/error"
  2901. }
  2902. }
  2903. }
  2904. },
  2905. "/repos/{owner}/{repo}/issues/{index}": {
  2906. "get": {
  2907. "produces": [
  2908. "application/json"
  2909. ],
  2910. "tags": [
  2911. "issue"
  2912. ],
  2913. "summary": "Get an issue",
  2914. "operationId": "issueGetIssue",
  2915. "parameters": [
  2916. {
  2917. "type": "string",
  2918. "description": "owner of the repo",
  2919. "name": "owner",
  2920. "in": "path",
  2921. "required": true
  2922. },
  2923. {
  2924. "type": "string",
  2925. "description": "name of the repo",
  2926. "name": "repo",
  2927. "in": "path",
  2928. "required": true
  2929. },
  2930. {
  2931. "type": "integer",
  2932. "format": "int64",
  2933. "description": "index of the issue to get",
  2934. "name": "index",
  2935. "in": "path",
  2936. "required": true
  2937. }
  2938. ],
  2939. "responses": {
  2940. "200": {
  2941. "$ref": "#/responses/Issue"
  2942. }
  2943. }
  2944. },
  2945. "patch": {
  2946. "consumes": [
  2947. "application/json"
  2948. ],
  2949. "produces": [
  2950. "application/json"
  2951. ],
  2952. "tags": [
  2953. "issue"
  2954. ],
  2955. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  2956. "operationId": "issueEditIssue",
  2957. "parameters": [
  2958. {
  2959. "type": "string",
  2960. "description": "owner of the repo",
  2961. "name": "owner",
  2962. "in": "path",
  2963. "required": true
  2964. },
  2965. {
  2966. "type": "string",
  2967. "description": "name of the repo",
  2968. "name": "repo",
  2969. "in": "path",
  2970. "required": true
  2971. },
  2972. {
  2973. "type": "integer",
  2974. "format": "int64",
  2975. "description": "index of the issue to edit",
  2976. "name": "index",
  2977. "in": "path",
  2978. "required": true
  2979. },
  2980. {
  2981. "name": "body",
  2982. "in": "body",
  2983. "schema": {
  2984. "$ref": "#/definitions/EditIssueOption"
  2985. }
  2986. }
  2987. ],
  2988. "responses": {
  2989. "201": {
  2990. "$ref": "#/responses/Issue"
  2991. }
  2992. }
  2993. }
  2994. },
  2995. "/repos/{owner}/{repo}/issues/{index}/comments": {
  2996. "get": {
  2997. "produces": [
  2998. "application/json"
  2999. ],
  3000. "tags": [
  3001. "issue"
  3002. ],
  3003. "summary": "List all comments on an issue",
  3004. "operationId": "issueGetComments",
  3005. "parameters": [
  3006. {
  3007. "type": "string",
  3008. "description": "owner of the repo",
  3009. "name": "owner",
  3010. "in": "path",
  3011. "required": true
  3012. },
  3013. {
  3014. "type": "string",
  3015. "description": "name of the repo",
  3016. "name": "repo",
  3017. "in": "path",
  3018. "required": true
  3019. },
  3020. {
  3021. "type": "integer",
  3022. "format": "int64",
  3023. "description": "index of the issue",
  3024. "name": "index",
  3025. "in": "path",
  3026. "required": true
  3027. },
  3028. {
  3029. "type": "string",
  3030. "description": "if provided, only comments updated since the specified time are returned.",
  3031. "name": "since",
  3032. "in": "query"
  3033. }
  3034. ],
  3035. "responses": {
  3036. "200": {
  3037. "$ref": "#/responses/CommentList"
  3038. }
  3039. }
  3040. },
  3041. "post": {
  3042. "consumes": [
  3043. "application/json"
  3044. ],
  3045. "produces": [
  3046. "application/json"
  3047. ],
  3048. "tags": [
  3049. "issue"
  3050. ],
  3051. "summary": "Add a comment to an issue",
  3052. "operationId": "issueCreateComment",
  3053. "parameters": [
  3054. {
  3055. "type": "string",
  3056. "description": "owner of the repo",
  3057. "name": "owner",
  3058. "in": "path",
  3059. "required": true
  3060. },
  3061. {
  3062. "type": "string",
  3063. "description": "name of the repo",
  3064. "name": "repo",
  3065. "in": "path",
  3066. "required": true
  3067. },
  3068. {
  3069. "type": "integer",
  3070. "format": "int64",
  3071. "description": "index of the issue",
  3072. "name": "index",
  3073. "in": "path",
  3074. "required": true
  3075. },
  3076. {
  3077. "name": "body",
  3078. "in": "body",
  3079. "schema": {
  3080. "$ref": "#/definitions/CreateIssueCommentOption"
  3081. }
  3082. }
  3083. ],
  3084. "responses": {
  3085. "201": {
  3086. "$ref": "#/responses/Comment"
  3087. }
  3088. }
  3089. }
  3090. },
  3091. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  3092. "delete": {
  3093. "tags": [
  3094. "issue"
  3095. ],
  3096. "summary": "Delete a comment",
  3097. "operationId": "issueDeleteCommentDeprecated",
  3098. "deprecated": true,
  3099. "parameters": [
  3100. {
  3101. "type": "string",
  3102. "description": "owner of the repo",
  3103. "name": "owner",
  3104. "in": "path",
  3105. "required": true
  3106. },
  3107. {
  3108. "type": "string",
  3109. "description": "name of the repo",
  3110. "name": "repo",
  3111. "in": "path",
  3112. "required": true
  3113. },
  3114. {
  3115. "type": "integer",
  3116. "description": "this parameter is ignored",
  3117. "name": "index",
  3118. "in": "path",
  3119. "required": true
  3120. },
  3121. {
  3122. "type": "integer",
  3123. "format": "int64",
  3124. "description": "id of comment to delete",
  3125. "name": "id",
  3126. "in": "path",
  3127. "required": true
  3128. }
  3129. ],
  3130. "responses": {
  3131. "204": {
  3132. "$ref": "#/responses/empty"
  3133. }
  3134. }
  3135. },
  3136. "patch": {
  3137. "consumes": [
  3138. "application/json"
  3139. ],
  3140. "produces": [
  3141. "application/json"
  3142. ],
  3143. "tags": [
  3144. "issue"
  3145. ],
  3146. "summary": "Edit a comment",
  3147. "operationId": "issueEditCommentDeprecated",
  3148. "deprecated": true,
  3149. "parameters": [
  3150. {
  3151. "type": "string",
  3152. "description": "owner of the repo",
  3153. "name": "owner",
  3154. "in": "path",
  3155. "required": true
  3156. },
  3157. {
  3158. "type": "string",
  3159. "description": "name of the repo",
  3160. "name": "repo",
  3161. "in": "path",
  3162. "required": true
  3163. },
  3164. {
  3165. "type": "integer",
  3166. "description": "this parameter is ignored",
  3167. "name": "index",
  3168. "in": "path",
  3169. "required": true
  3170. },
  3171. {
  3172. "type": "integer",
  3173. "format": "int64",
  3174. "description": "id of the comment to edit",
  3175. "name": "id",
  3176. "in": "path",
  3177. "required": true
  3178. },
  3179. {
  3180. "name": "body",
  3181. "in": "body",
  3182. "schema": {
  3183. "$ref": "#/definitions/EditIssueCommentOption"
  3184. }
  3185. }
  3186. ],
  3187. "responses": {
  3188. "200": {
  3189. "$ref": "#/responses/Comment"
  3190. }
  3191. }
  3192. }
  3193. },
  3194. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  3195. "post": {
  3196. "consumes": [
  3197. "application/json"
  3198. ],
  3199. "produces": [
  3200. "application/json"
  3201. ],
  3202. "tags": [
  3203. "issue"
  3204. ],
  3205. "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.",
  3206. "operationId": "issueEditIssueDeadline",
  3207. "parameters": [
  3208. {
  3209. "type": "string",
  3210. "description": "owner of the repo",
  3211. "name": "owner",
  3212. "in": "path",
  3213. "required": true
  3214. },
  3215. {
  3216. "type": "string",
  3217. "description": "name of the repo",
  3218. "name": "repo",
  3219. "in": "path",
  3220. "required": true
  3221. },
  3222. {
  3223. "type": "integer",
  3224. "format": "int64",
  3225. "description": "index of the issue to create or update a deadline on",
  3226. "name": "index",
  3227. "in": "path",
  3228. "required": true
  3229. },
  3230. {
  3231. "name": "body",
  3232. "in": "body",
  3233. "schema": {
  3234. "$ref": "#/definitions/EditDeadlineOption"
  3235. }
  3236. }
  3237. ],
  3238. "responses": {
  3239. "201": {
  3240. "$ref": "#/responses/IssueDeadline"
  3241. },
  3242. "403": {
  3243. "description": "Not repo writer"
  3244. },
  3245. "404": {
  3246. "description": "Issue not found"
  3247. }
  3248. }
  3249. }
  3250. },
  3251. "/repos/{owner}/{repo}/issues/{index}/labels": {
  3252. "get": {
  3253. "produces": [
  3254. "application/json"
  3255. ],
  3256. "tags": [
  3257. "issue"
  3258. ],
  3259. "summary": "Get an issue's labels",
  3260. "operationId": "issueGetLabels",
  3261. "parameters": [
  3262. {
  3263. "type": "string",
  3264. "description": "owner of the repo",
  3265. "name": "owner",
  3266. "in": "path",
  3267. "required": true
  3268. },
  3269. {
  3270. "type": "string",
  3271. "description": "name of the repo",
  3272. "name": "repo",
  3273. "in": "path",
  3274. "required": true
  3275. },
  3276. {
  3277. "type": "integer",
  3278. "format": "int64",
  3279. "description": "index of the issue",
  3280. "name": "index",
  3281. "in": "path",
  3282. "required": true
  3283. }
  3284. ],
  3285. "responses": {
  3286. "200": {
  3287. "$ref": "#/responses/LabelList"
  3288. },
  3289. "404": {
  3290. "$ref": "#/responses/notFound"
  3291. }
  3292. }
  3293. },
  3294. "put": {
  3295. "consumes": [
  3296. "application/json"
  3297. ],
  3298. "produces": [
  3299. "application/json"
  3300. ],
  3301. "tags": [
  3302. "issue"
  3303. ],
  3304. "summary": "Replace an issue's labels",
  3305. "operationId": "issueReplaceLabels",
  3306. "parameters": [
  3307. {
  3308. "type": "string",
  3309. "description": "owner of the repo",
  3310. "name": "owner",
  3311. "in": "path",
  3312. "required": true
  3313. },
  3314. {
  3315. "type": "string",
  3316. "description": "name of the repo",
  3317. "name": "repo",
  3318. "in": "path",
  3319. "required": true
  3320. },
  3321. {
  3322. "type": "integer",
  3323. "format": "int64",
  3324. "description": "index of the issue",
  3325. "name": "index",
  3326. "in": "path",
  3327. "required": true
  3328. },
  3329. {
  3330. "name": "body",
  3331. "in": "body",
  3332. "schema": {
  3333. "$ref": "#/definitions/IssueLabelsOption"
  3334. }
  3335. }
  3336. ],
  3337. "responses": {
  3338. "200": {
  3339. "$ref": "#/responses/LabelList"
  3340. }
  3341. }
  3342. },
  3343. "post": {
  3344. "consumes": [
  3345. "application/json"
  3346. ],
  3347. "produces": [
  3348. "application/json"
  3349. ],
  3350. "tags": [
  3351. "issue"
  3352. ],
  3353. "summary": "Add a label to an issue",
  3354. "operationId": "issueAddLabel",
  3355. "parameters": [
  3356. {
  3357. "type": "string",
  3358. "description": "owner of the repo",
  3359. "name": "owner",
  3360. "in": "path",
  3361. "required": true
  3362. },
  3363. {
  3364. "type": "string",
  3365. "description": "name of the repo",
  3366. "name": "repo",
  3367. "in": "path",
  3368. "required": true
  3369. },
  3370. {
  3371. "type": "integer",
  3372. "format": "int64",
  3373. "description": "index of the issue",
  3374. "name": "index",
  3375. "in": "path",
  3376. "required": true
  3377. },
  3378. {
  3379. "name": "body",
  3380. "in": "body",
  3381. "schema": {
  3382. "$ref": "#/definitions/IssueLabelsOption"
  3383. }
  3384. }
  3385. ],
  3386. "responses": {
  3387. "200": {
  3388. "$ref": "#/responses/LabelList"
  3389. }
  3390. }
  3391. },
  3392. "delete": {
  3393. "produces": [
  3394. "application/json"
  3395. ],
  3396. "tags": [
  3397. "issue"
  3398. ],
  3399. "summary": "Remove all labels from an issue",
  3400. "operationId": "issueClearLabels",
  3401. "parameters": [
  3402. {
  3403. "type": "string",
  3404. "description": "owner of the repo",
  3405. "name": "owner",
  3406. "in": "path",
  3407. "required": true
  3408. },
  3409. {
  3410. "type": "string",
  3411. "description": "name of the repo",
  3412. "name": "repo",
  3413. "in": "path",
  3414. "required": true
  3415. },
  3416. {
  3417. "type": "integer",
  3418. "format": "int64",
  3419. "description": "index of the issue",
  3420. "name": "index",
  3421. "in": "path",
  3422. "required": true
  3423. }
  3424. ],
  3425. "responses": {
  3426. "204": {
  3427. "$ref": "#/responses/empty"
  3428. }
  3429. }
  3430. }
  3431. },
  3432. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  3433. "delete": {
  3434. "produces": [
  3435. "application/json"
  3436. ],
  3437. "tags": [
  3438. "issue"
  3439. ],
  3440. "summary": "Remove a label from an issue",
  3441. "operationId": "issueRemoveLabel",
  3442. "parameters": [
  3443. {
  3444. "type": "string",
  3445. "description": "owner of the repo",
  3446. "name": "owner",
  3447. "in": "path",
  3448. "required": true
  3449. },
  3450. {
  3451. "type": "string",
  3452. "description": "name of the repo",
  3453. "name": "repo",
  3454. "in": "path",
  3455. "required": true
  3456. },
  3457. {
  3458. "type": "integer",
  3459. "format": "int64",
  3460. "description": "index of the issue",
  3461. "name": "index",
  3462. "in": "path",
  3463. "required": true
  3464. },
  3465. {
  3466. "type": "integer",
  3467. "format": "int64",
  3468. "description": "id of the label to remove",
  3469. "name": "id",
  3470. "in": "path",
  3471. "required": true
  3472. }
  3473. ],
  3474. "responses": {
  3475. "204": {
  3476. "$ref": "#/responses/empty"
  3477. }
  3478. }
  3479. }
  3480. },
  3481. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  3482. "post": {
  3483. "consumes": [
  3484. "application/json"
  3485. ],
  3486. "produces": [
  3487. "application/json"
  3488. ],
  3489. "tags": [
  3490. "issue"
  3491. ],
  3492. "summary": "Start stopwatch on an issue.",
  3493. "operationId": "issueStartStopWatch",
  3494. "parameters": [
  3495. {
  3496. "type": "string",
  3497. "description": "owner of the repo",
  3498. "name": "owner",
  3499. "in": "path",
  3500. "required": true
  3501. },
  3502. {
  3503. "type": "string",
  3504. "description": "name of the repo",
  3505. "name": "repo",
  3506. "in": "path",
  3507. "required": true
  3508. },
  3509. {
  3510. "type": "integer",
  3511. "format": "int64",
  3512. "description": "index of the issue to create the stopwatch on",
  3513. "name": "index",
  3514. "in": "path",
  3515. "required": true
  3516. }
  3517. ],
  3518. "responses": {
  3519. "201": {
  3520. "$ref": "#/responses/empty"
  3521. },
  3522. "403": {
  3523. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  3524. },
  3525. "404": {
  3526. "description": "Issue not found"
  3527. },
  3528. "409": {
  3529. "description": "Cannot start a stopwatch again if it already exists"
  3530. }
  3531. }
  3532. }
  3533. },
  3534. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  3535. "post": {
  3536. "consumes": [
  3537. "application/json"
  3538. ],
  3539. "produces": [
  3540. "application/json"
  3541. ],
  3542. "tags": [
  3543. "issue"
  3544. ],
  3545. "summary": "Stop an issue's existing stopwatch.",
  3546. "operationId": "issueStopWatch",
  3547. "parameters": [
  3548. {
  3549. "type": "string",
  3550. "description": "owner of the repo",
  3551. "name": "owner",
  3552. "in": "path",
  3553. "required": true
  3554. },
  3555. {
  3556. "type": "string",
  3557. "description": "name of the repo",
  3558. "name": "repo",
  3559. "in": "path",
  3560. "required": true
  3561. },
  3562. {
  3563. "type": "integer",
  3564. "format": "int64",
  3565. "description": "index of the issue to stop the stopwatch on",
  3566. "name": "index",
  3567. "in": "path",
  3568. "required": true
  3569. }
  3570. ],
  3571. "responses": {
  3572. "201": {
  3573. "$ref": "#/responses/empty"
  3574. },
  3575. "403": {
  3576. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  3577. },
  3578. "404": {
  3579. "description": "Issue not found"
  3580. },
  3581. "409": {
  3582. "description": "Cannot stop a non existent stopwatch"
  3583. }
  3584. }
  3585. }
  3586. },
  3587. "/repos/{owner}/{repo}/keys": {
  3588. "get": {
  3589. "produces": [
  3590. "application/json"
  3591. ],
  3592. "tags": [
  3593. "repository"
  3594. ],
  3595. "summary": "List a repository's keys",
  3596. "operationId": "repoListKeys",
  3597. "parameters": [
  3598. {
  3599. "type": "string",
  3600. "description": "owner of the repo",
  3601. "name": "owner",
  3602. "in": "path",
  3603. "required": true
  3604. },
  3605. {
  3606. "type": "string",
  3607. "description": "name of the repo",
  3608. "name": "repo",
  3609. "in": "path",
  3610. "required": true
  3611. },
  3612. {
  3613. "type": "integer",
  3614. "description": "the key_id to search for",
  3615. "name": "key_id",
  3616. "in": "query"
  3617. },
  3618. {
  3619. "type": "string",
  3620. "description": "fingerprint of the key",
  3621. "name": "fingerprint",
  3622. "in": "query"
  3623. }
  3624. ],
  3625. "responses": {
  3626. "200": {
  3627. "$ref": "#/responses/DeployKeyList"
  3628. }
  3629. }
  3630. },
  3631. "post": {
  3632. "consumes": [
  3633. "application/json"
  3634. ],
  3635. "produces": [
  3636. "application/json"
  3637. ],
  3638. "tags": [
  3639. "repository"
  3640. ],
  3641. "summary": "Add a key to a repository",
  3642. "operationId": "repoCreateKey",
  3643. "parameters": [
  3644. {
  3645. "type": "string",
  3646. "description": "owner of the repo",
  3647. "name": "owner",
  3648. "in": "path",
  3649. "required": true
  3650. },
  3651. {
  3652. "type": "string",
  3653. "description": "name of the repo",
  3654. "name": "repo",
  3655. "in": "path",
  3656. "required": true
  3657. },
  3658. {
  3659. "name": "body",
  3660. "in": "body",
  3661. "schema": {
  3662. "$ref": "#/definitions/CreateKeyOption"
  3663. }
  3664. }
  3665. ],
  3666. "responses": {
  3667. "201": {
  3668. "$ref": "#/responses/DeployKey"
  3669. }
  3670. }
  3671. }
  3672. },
  3673. "/repos/{owner}/{repo}/keys/{id}": {
  3674. "get": {
  3675. "produces": [
  3676. "application/json"
  3677. ],
  3678. "tags": [
  3679. "repository"
  3680. ],
  3681. "summary": "Get a repository's key by id",
  3682. "operationId": "repoGetKey",
  3683. "parameters": [
  3684. {
  3685. "type": "string",
  3686. "description": "owner of the repo",
  3687. "name": "owner",
  3688. "in": "path",
  3689. "required": true
  3690. },
  3691. {
  3692. "type": "string",
  3693. "description": "name of the repo",
  3694. "name": "repo",
  3695. "in": "path",
  3696. "required": true
  3697. },
  3698. {
  3699. "type": "integer",
  3700. "format": "int64",
  3701. "description": "id of the key to get",
  3702. "name": "id",
  3703. "in": "path",
  3704. "required": true
  3705. }
  3706. ],
  3707. "responses": {
  3708. "200": {
  3709. "$ref": "#/responses/DeployKey"
  3710. }
  3711. }
  3712. },
  3713. "delete": {
  3714. "tags": [
  3715. "repository"
  3716. ],
  3717. "summary": "Delete a key from a repository",
  3718. "operationId": "repoDeleteKey",
  3719. "parameters": [
  3720. {
  3721. "type": "string",
  3722. "description": "owner of the repo",
  3723. "name": "owner",
  3724. "in": "path",
  3725. "required": true
  3726. },
  3727. {
  3728. "type": "string",
  3729. "description": "name of the repo",
  3730. "name": "repo",
  3731. "in": "path",
  3732. "required": true
  3733. },
  3734. {
  3735. "type": "integer",
  3736. "format": "int64",
  3737. "description": "id of the key to delete",
  3738. "name": "id",
  3739. "in": "path",
  3740. "required": true
  3741. }
  3742. ],
  3743. "responses": {
  3744. "204": {
  3745. "$ref": "#/responses/empty"
  3746. }
  3747. }
  3748. }
  3749. },
  3750. "/repos/{owner}/{repo}/labels": {
  3751. "get": {
  3752. "produces": [
  3753. "application/json"
  3754. ],
  3755. "tags": [
  3756. "issue"
  3757. ],
  3758. "summary": "Get all of a repository's labels",
  3759. "operationId": "issueListLabels",
  3760. "parameters": [
  3761. {
  3762. "type": "string",
  3763. "description": "owner of the repo",
  3764. "name": "owner",
  3765. "in": "path",
  3766. "required": true
  3767. },
  3768. {
  3769. "type": "string",
  3770. "description": "name of the repo",
  3771. "name": "repo",
  3772. "in": "path",
  3773. "required": true
  3774. }
  3775. ],
  3776. "responses": {
  3777. "200": {
  3778. "$ref": "#/responses/LabelList"
  3779. }
  3780. }
  3781. },
  3782. "post": {
  3783. "consumes": [
  3784. "application/json"
  3785. ],
  3786. "produces": [
  3787. "application/json"
  3788. ],
  3789. "tags": [
  3790. "issue"
  3791. ],
  3792. "summary": "Create a label",
  3793. "operationId": "issueCreateLabel",
  3794. "parameters": [
  3795. {
  3796. "type": "string",
  3797. "description": "owner of the repo",
  3798. "name": "owner",
  3799. "in": "path",
  3800. "required": true
  3801. },
  3802. {
  3803. "type": "string",
  3804. "description": "name of the repo",
  3805. "name": "repo",
  3806. "in": "path",
  3807. "required": true
  3808. },
  3809. {
  3810. "name": "body",
  3811. "in": "body",
  3812. "schema": {
  3813. "$ref": "#/definitions/CreateLabelOption"
  3814. }
  3815. }
  3816. ],
  3817. "responses": {
  3818. "201": {
  3819. "$ref": "#/responses/Label"
  3820. }
  3821. }
  3822. }
  3823. },
  3824. "/repos/{owner}/{repo}/labels/{id}": {
  3825. "get": {
  3826. "produces": [
  3827. "application/json"
  3828. ],
  3829. "tags": [
  3830. "issue"
  3831. ],
  3832. "summary": "Get a single label",
  3833. "operationId": "issueGetLabel",
  3834. "parameters": [
  3835. {
  3836. "type": "string",
  3837. "description": "owner of the repo",
  3838. "name": "owner",
  3839. "in": "path",
  3840. "required": true
  3841. },
  3842. {
  3843. "type": "string",
  3844. "description": "name of the repo",
  3845. "name": "repo",
  3846. "in": "path",
  3847. "required": true
  3848. },
  3849. {
  3850. "type": "integer",
  3851. "format": "int64",
  3852. "description": "id of the label to get",
  3853. "name": "id",
  3854. "in": "path",
  3855. "required": true
  3856. }
  3857. ],
  3858. "responses": {
  3859. "200": {
  3860. "$ref": "#/responses/Label"
  3861. }
  3862. }
  3863. },
  3864. "delete": {
  3865. "tags": [
  3866. "issue"
  3867. ],
  3868. "summary": "Delete a label",
  3869. "operationId": "issueDeleteLabel",
  3870. "parameters": [
  3871. {
  3872. "type": "string",
  3873. "description": "owner of the repo",
  3874. "name": "owner",
  3875. "in": "path",
  3876. "required": true
  3877. },
  3878. {
  3879. "type": "string",
  3880. "description": "name of the repo",
  3881. "name": "repo",
  3882. "in": "path",
  3883. "required": true
  3884. },
  3885. {
  3886. "type": "integer",
  3887. "format": "int64",
  3888. "description": "id of the label to delete",
  3889. "name": "id",
  3890. "in": "path",
  3891. "required": true
  3892. }
  3893. ],
  3894. "responses": {
  3895. "204": {
  3896. "$ref": "#/responses/empty"
  3897. }
  3898. }
  3899. },
  3900. "patch": {
  3901. "consumes": [
  3902. "application/json"
  3903. ],
  3904. "produces": [
  3905. "application/json"
  3906. ],
  3907. "tags": [
  3908. "issue"
  3909. ],
  3910. "summary": "Update a label",
  3911. "operationId": "issueEditLabel",
  3912. "parameters": [
  3913. {
  3914. "type": "string",
  3915. "description": "owner of the repo",
  3916. "name": "owner",
  3917. "in": "path",
  3918. "required": true
  3919. },
  3920. {
  3921. "type": "string",
  3922. "description": "name of the repo",
  3923. "name": "repo",
  3924. "in": "path",
  3925. "required": true
  3926. },
  3927. {
  3928. "type": "integer",
  3929. "format": "int64",
  3930. "description": "id of the label to edit",
  3931. "name": "id",
  3932. "in": "path",
  3933. "required": true
  3934. },
  3935. {
  3936. "name": "body",
  3937. "in": "body",
  3938. "schema": {
  3939. "$ref": "#/definitions/EditLabelOption"
  3940. }
  3941. }
  3942. ],
  3943. "responses": {
  3944. "200": {
  3945. "$ref": "#/responses/Label"
  3946. }
  3947. }
  3948. }
  3949. },
  3950. "/repos/{owner}/{repo}/milestones": {
  3951. "get": {
  3952. "produces": [
  3953. "application/json"
  3954. ],
  3955. "tags": [
  3956. "issue"
  3957. ],
  3958. "summary": "Get all of a repository's opened milestones",
  3959. "operationId": "issueGetMilestonesList",
  3960. "parameters": [
  3961. {
  3962. "type": "string",
  3963. "description": "owner of the repo",
  3964. "name": "owner",
  3965. "in": "path",
  3966. "required": true
  3967. },
  3968. {
  3969. "type": "string",
  3970. "description": "name of the repo",
  3971. "name": "repo",
  3972. "in": "path",
  3973. "required": true
  3974. },
  3975. {
  3976. "type": "string",
  3977. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  3978. "name": "state",
  3979. "in": "query"
  3980. }
  3981. ],
  3982. "responses": {
  3983. "200": {
  3984. "$ref": "#/responses/MilestoneList"
  3985. }
  3986. }
  3987. },
  3988. "post": {
  3989. "consumes": [
  3990. "application/json"
  3991. ],
  3992. "produces": [
  3993. "application/json"
  3994. ],
  3995. "tags": [
  3996. "issue"
  3997. ],
  3998. "summary": "Create a milestone",
  3999. "operationId": "issueCreateMilestone",
  4000. "parameters": [
  4001. {
  4002. "type": "string",
  4003. "description": "owner of the repo",
  4004. "name": "owner",
  4005. "in": "path",
  4006. "required": true
  4007. },
  4008. {
  4009. "type": "string",
  4010. "description": "name of the repo",
  4011. "name": "repo",
  4012. "in": "path",
  4013. "required": true
  4014. },
  4015. {
  4016. "name": "body",
  4017. "in": "body",
  4018. "schema": {
  4019. "$ref": "#/definitions/CreateMilestoneOption"
  4020. }
  4021. }
  4022. ],
  4023. "responses": {
  4024. "201": {
  4025. "$ref": "#/responses/Milestone"
  4026. }
  4027. }
  4028. }
  4029. },
  4030. "/repos/{owner}/{repo}/milestones/{id}": {
  4031. "get": {
  4032. "produces": [
  4033. "application/json"
  4034. ],
  4035. "tags": [
  4036. "issue"
  4037. ],
  4038. "summary": "Get a milestone",
  4039. "operationId": "issueGetMilestone",
  4040. "parameters": [
  4041. {
  4042. "type": "string",
  4043. "description": "owner of the repo",
  4044. "name": "owner",
  4045. "in": "path",
  4046. "required": true
  4047. },
  4048. {
  4049. "type": "string",
  4050. "description": "name of the repo",
  4051. "name": "repo",
  4052. "in": "path",
  4053. "required": true
  4054. },
  4055. {
  4056. "type": "integer",
  4057. "format": "int64",
  4058. "description": "id of the milestone",
  4059. "name": "id",
  4060. "in": "path",
  4061. "required": true
  4062. }
  4063. ],
  4064. "responses": {
  4065. "200": {
  4066. "$ref": "#/responses/Milestone"
  4067. }
  4068. }
  4069. },
  4070. "delete": {
  4071. "tags": [
  4072. "issue"
  4073. ],
  4074. "summary": "Delete a milestone",
  4075. "operationId": "issueDeleteMilestone",
  4076. "parameters": [
  4077. {
  4078. "type": "string",
  4079. "description": "owner of the repo",
  4080. "name": "owner",
  4081. "in": "path",
  4082. "required": true
  4083. },
  4084. {
  4085. "type": "string",
  4086. "description": "name of the repo",
  4087. "name": "repo",
  4088. "in": "path",
  4089. "required": true
  4090. },
  4091. {
  4092. "type": "integer",
  4093. "format": "int64",
  4094. "description": "id of the milestone to delete",
  4095. "name": "id",
  4096. "in": "path",
  4097. "required": true
  4098. }
  4099. ],
  4100. "responses": {
  4101. "204": {
  4102. "$ref": "#/responses/empty"
  4103. }
  4104. }
  4105. },
  4106. "patch": {
  4107. "consumes": [
  4108. "application/json"
  4109. ],
  4110. "produces": [
  4111. "application/json"
  4112. ],
  4113. "tags": [
  4114. "issue"
  4115. ],
  4116. "summary": "Update a milestone",
  4117. "operationId": "issueEditMilestone",
  4118. "parameters": [
  4119. {
  4120. "type": "string",
  4121. "description": "owner of the repo",
  4122. "name": "owner",
  4123. "in": "path",
  4124. "required": true
  4125. },
  4126. {
  4127. "type": "string",
  4128. "description": "name of the repo",
  4129. "name": "repo",
  4130. "in": "path",
  4131. "required": true
  4132. },
  4133. {
  4134. "type": "integer",
  4135. "format": "int64",
  4136. "description": "id of the milestone",
  4137. "name": "id",
  4138. "in": "path",
  4139. "required": true
  4140. },
  4141. {
  4142. "name": "body",
  4143. "in": "body",
  4144. "schema": {
  4145. "$ref": "#/definitions/EditMilestoneOption"
  4146. }
  4147. }
  4148. ],
  4149. "responses": {
  4150. "200": {
  4151. "$ref": "#/responses/Milestone"
  4152. }
  4153. }
  4154. }
  4155. },
  4156. "/repos/{owner}/{repo}/mirror-sync": {
  4157. "post": {
  4158. "produces": [
  4159. "application/json"
  4160. ],
  4161. "tags": [
  4162. "repository"
  4163. ],
  4164. "summary": "Sync a mirrored repository",
  4165. "operationId": "repoMirrorSync",
  4166. "parameters": [
  4167. {
  4168. "type": "string",
  4169. "description": "owner of the repo to sync",
  4170. "name": "owner",
  4171. "in": "path",
  4172. "required": true
  4173. },
  4174. {
  4175. "type": "string",
  4176. "description": "name of the repo to sync",
  4177. "name": "repo",
  4178. "in": "path",
  4179. "required": true
  4180. }
  4181. ],
  4182. "responses": {
  4183. "200": {
  4184. "$ref": "#/responses/empty"
  4185. }
  4186. }
  4187. }
  4188. },
  4189. "/repos/{owner}/{repo}/pulls": {
  4190. "get": {
  4191. "produces": [
  4192. "application/json"
  4193. ],
  4194. "tags": [
  4195. "repository"
  4196. ],
  4197. "summary": "List a repo's pull requests",
  4198. "operationId": "repoListPullRequests",
  4199. "parameters": [
  4200. {
  4201. "type": "string",
  4202. "description": "owner of the repo",
  4203. "name": "owner",
  4204. "in": "path",
  4205. "required": true
  4206. },
  4207. {
  4208. "type": "string",
  4209. "description": "name of the repo",
  4210. "name": "repo",
  4211. "in": "path",
  4212. "required": true
  4213. },
  4214. {
  4215. "type": "integer",
  4216. "description": "Page number",
  4217. "name": "page",
  4218. "in": "query"
  4219. },
  4220. {
  4221. "enum": [
  4222. "closed",
  4223. "open",
  4224. "all"
  4225. ],
  4226. "type": "string",
  4227. "description": "State of pull request: open or closed (optional)",
  4228. "name": "state",
  4229. "in": "query"
  4230. },
  4231. {
  4232. "enum": [
  4233. "oldest",
  4234. "recentupdate",
  4235. "leastupdate",
  4236. "mostcomment",
  4237. "leastcomment",
  4238. "priority"
  4239. ],
  4240. "type": "string",
  4241. "description": "Type of sort",
  4242. "name": "sort",
  4243. "in": "query"
  4244. },
  4245. {
  4246. "type": "integer",
  4247. "format": "int64",
  4248. "description": "ID of the milestone",
  4249. "name": "milestone",
  4250. "in": "query"
  4251. },
  4252. {
  4253. "type": "array",
  4254. "items": {
  4255. "type": "integer",
  4256. "format": "int64"
  4257. },
  4258. "collectionFormat": "multi",
  4259. "description": "Label IDs",
  4260. "name": "labels",
  4261. "in": "query"
  4262. }
  4263. ],
  4264. "responses": {
  4265. "200": {
  4266. "$ref": "#/responses/PullRequestList"
  4267. }
  4268. }
  4269. },
  4270. "post": {
  4271. "consumes": [
  4272. "application/json"
  4273. ],
  4274. "produces": [
  4275. "application/json"
  4276. ],
  4277. "tags": [
  4278. "repository"
  4279. ],
  4280. "summary": "Create a pull request",
  4281. "operationId": "repoCreatePullRequest",
  4282. "parameters": [
  4283. {
  4284. "type": "string",
  4285. "description": "owner of the repo",
  4286. "name": "owner",
  4287. "in": "path",
  4288. "required": true
  4289. },
  4290. {
  4291. "type": "string",
  4292. "description": "name of the repo",
  4293. "name": "repo",
  4294. "in": "path",
  4295. "required": true
  4296. },
  4297. {
  4298. "name": "body",
  4299. "in": "body",
  4300. "schema": {
  4301. "$ref": "#/definitions/CreatePullRequestOption"
  4302. }
  4303. }
  4304. ],
  4305. "responses": {
  4306. "201": {
  4307. "$ref": "#/responses/PullRequest"
  4308. }
  4309. }
  4310. }
  4311. },
  4312. "/repos/{owner}/{repo}/pulls/{index}": {
  4313. "get": {
  4314. "produces": [
  4315. "application/json"
  4316. ],
  4317. "tags": [
  4318. "repository"
  4319. ],
  4320. "summary": "Get a pull request",
  4321. "operationId": "repoGetPullRequest",
  4322. "parameters": [
  4323. {
  4324. "type": "string",
  4325. "description": "owner of the repo",
  4326. "name": "owner",
  4327. "in": "path",
  4328. "required": true
  4329. },
  4330. {
  4331. "type": "string",
  4332. "description": "name of the repo",
  4333. "name": "repo",
  4334. "in": "path",
  4335. "required": true
  4336. },
  4337. {
  4338. "type": "integer",
  4339. "format": "int64",
  4340. "description": "index of the pull request to get",
  4341. "name": "index",
  4342. "in": "path",
  4343. "required": true
  4344. }
  4345. ],
  4346. "responses": {
  4347. "200": {
  4348. "$ref": "#/responses/PullRequest"
  4349. }
  4350. }
  4351. },
  4352. "patch": {
  4353. "consumes": [
  4354. "application/json"
  4355. ],
  4356. "produces": [
  4357. "application/json"
  4358. ],
  4359. "tags": [
  4360. "repository"
  4361. ],
  4362. "summary": "Update a pull request",
  4363. "operationId": "repoEditPullRequest",
  4364. "parameters": [
  4365. {
  4366. "type": "string",
  4367. "description": "owner of the repo",
  4368. "name": "owner",
  4369. "in": "path",
  4370. "required": true
  4371. },
  4372. {
  4373. "type": "string",
  4374. "description": "name of the repo",
  4375. "name": "repo",
  4376. "in": "path",
  4377. "required": true
  4378. },
  4379. {
  4380. "type": "integer",
  4381. "format": "int64",
  4382. "description": "index of the pull request to edit",
  4383. "name": "index",
  4384. "in": "path",
  4385. "required": true
  4386. },
  4387. {
  4388. "name": "body",
  4389. "in": "body",
  4390. "schema": {
  4391. "$ref": "#/definitions/EditPullRequestOption"
  4392. }
  4393. }
  4394. ],
  4395. "responses": {
  4396. "201": {
  4397. "$ref": "#/responses/PullRequest"
  4398. }
  4399. }
  4400. }
  4401. },
  4402. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  4403. "get": {
  4404. "produces": [
  4405. "application/json"
  4406. ],
  4407. "tags": [
  4408. "repository"
  4409. ],
  4410. "summary": "Check if a pull request has been merged",
  4411. "operationId": "repoPullRequestIsMerged",
  4412. "parameters": [
  4413. {
  4414. "type": "string",
  4415. "description": "owner of the repo",
  4416. "name": "owner",
  4417. "in": "path",
  4418. "required": true
  4419. },
  4420. {
  4421. "type": "string",
  4422. "description": "name of the repo",
  4423. "name": "repo",
  4424. "in": "path",
  4425. "required": true
  4426. },
  4427. {
  4428. "type": "integer",
  4429. "format": "int64",
  4430. "description": "index of the pull request",
  4431. "name": "index",
  4432. "in": "path",
  4433. "required": true
  4434. }
  4435. ],
  4436. "responses": {
  4437. "204": {
  4438. "description": "pull request has been merged"
  4439. },
  4440. "404": {
  4441. "description": "pull request has not been merged"
  4442. }
  4443. }
  4444. },
  4445. "post": {
  4446. "produces": [
  4447. "application/json"
  4448. ],
  4449. "tags": [
  4450. "repository"
  4451. ],
  4452. "summary": "Merge a pull request",
  4453. "operationId": "repoMergePullRequest",
  4454. "parameters": [
  4455. {
  4456. "type": "string",
  4457. "description": "owner of the repo",
  4458. "name": "owner",
  4459. "in": "path",
  4460. "required": true
  4461. },
  4462. {
  4463. "type": "string",
  4464. "description": "name of the repo",
  4465. "name": "repo",
  4466. "in": "path",
  4467. "required": true
  4468. },
  4469. {
  4470. "type": "integer",
  4471. "format": "int64",
  4472. "description": "index of the pull request to merge",
  4473. "name": "index",
  4474. "in": "path",
  4475. "required": true
  4476. },
  4477. {
  4478. "name": "body",
  4479. "in": "body",
  4480. "schema": {
  4481. "$ref": "#/definitions/MergePullRequestOption"
  4482. }
  4483. }
  4484. ],
  4485. "responses": {
  4486. "200": {
  4487. "$ref": "#/responses/empty"
  4488. },
  4489. "405": {
  4490. "$ref": "#/responses/empty"
  4491. }
  4492. }
  4493. }
  4494. },
  4495. "/repos/{owner}/{repo}/raw/{filepath}": {
  4496. "get": {
  4497. "produces": [
  4498. "application/json"
  4499. ],
  4500. "tags": [
  4501. "repository"
  4502. ],
  4503. "summary": "Get a file from a repository",
  4504. "operationId": "repoGetRawFile",
  4505. "parameters": [
  4506. {
  4507. "type": "string",
  4508. "description": "owner of the repo",
  4509. "name": "owner",
  4510. "in": "path",
  4511. "required": true
  4512. },
  4513. {
  4514. "type": "string",
  4515. "description": "name of the repo",
  4516. "name": "repo",
  4517. "in": "path",
  4518. "required": true
  4519. },
  4520. {
  4521. "type": "string",
  4522. "description": "filepath of the file to get",
  4523. "name": "filepath",
  4524. "in": "path",
  4525. "required": true
  4526. }
  4527. ],
  4528. "responses": {
  4529. "200": {
  4530. "description": "success"
  4531. }
  4532. }
  4533. }
  4534. },
  4535. "/repos/{owner}/{repo}/releases": {
  4536. "get": {
  4537. "produces": [
  4538. "application/json"
  4539. ],
  4540. "tags": [
  4541. "repository"
  4542. ],
  4543. "summary": "List a repo's releases",
  4544. "operationId": "repoListReleases",
  4545. "parameters": [
  4546. {
  4547. "type": "string",
  4548. "description": "owner of the repo",
  4549. "name": "owner",
  4550. "in": "path",
  4551. "required": true
  4552. },
  4553. {
  4554. "type": "string",
  4555. "description": "name of the repo",
  4556. "name": "repo",
  4557. "in": "path",
  4558. "required": true
  4559. },
  4560. {
  4561. "type": "integer",
  4562. "description": "page wants to load",
  4563. "name": "page",
  4564. "in": "query"
  4565. },
  4566. {
  4567. "type": "integer",
  4568. "description": "items count every page wants to load",
  4569. "name": "per_page",
  4570. "in": "query"
  4571. }
  4572. ],
  4573. "responses": {
  4574. "200": {
  4575. "$ref": "#/responses/ReleaseList"
  4576. }
  4577. }
  4578. },
  4579. "post": {
  4580. "consumes": [
  4581. "application/json"
  4582. ],
  4583. "produces": [
  4584. "application/json"
  4585. ],
  4586. "tags": [
  4587. "repository"
  4588. ],
  4589. "summary": "Create a release",
  4590. "operationId": "repoCreateRelease",
  4591. "parameters": [
  4592. {
  4593. "type": "string",
  4594. "description": "owner of the repo",
  4595. "name": "owner",
  4596. "in": "path",
  4597. "required": true
  4598. },
  4599. {
  4600. "type": "string",
  4601. "description": "name of the repo",
  4602. "name": "repo",
  4603. "in": "path",
  4604. "required": true
  4605. },
  4606. {
  4607. "name": "body",
  4608. "in": "body",
  4609. "schema": {
  4610. "$ref": "#/definitions/CreateReleaseOption"
  4611. }
  4612. }
  4613. ],
  4614. "responses": {
  4615. "201": {
  4616. "$ref": "#/responses/Release"
  4617. }
  4618. }
  4619. }
  4620. },
  4621. "/repos/{owner}/{repo}/releases/{id}": {
  4622. "get": {
  4623. "produces": [
  4624. "application/json"
  4625. ],
  4626. "tags": [
  4627. "repository"
  4628. ],
  4629. "summary": "Get a release",
  4630. "operationId": "repoGetRelease",
  4631. "parameters": [
  4632. {
  4633. "type": "string",
  4634. "description": "owner of the repo",
  4635. "name": "owner",
  4636. "in": "path",
  4637. "required": true
  4638. },
  4639. {
  4640. "type": "string",
  4641. "description": "name of the repo",
  4642. "name": "repo",
  4643. "in": "path",
  4644. "required": true
  4645. },
  4646. {
  4647. "type": "integer",
  4648. "format": "int64",
  4649. "description": "id of the release to get",
  4650. "name": "id",
  4651. "in": "path",
  4652. "required": true
  4653. }
  4654. ],
  4655. "responses": {
  4656. "200": {
  4657. "$ref": "#/responses/Release"
  4658. }
  4659. }
  4660. },
  4661. "delete": {
  4662. "tags": [
  4663. "repository"
  4664. ],
  4665. "summary": "Delete a release",
  4666. "operationId": "repoDeleteRelease",
  4667. "parameters": [
  4668. {
  4669. "type": "string",
  4670. "description": "owner of the repo",
  4671. "name": "owner",
  4672. "in": "path",
  4673. "required": true
  4674. },
  4675. {
  4676. "type": "string",
  4677. "description": "name of the repo",
  4678. "name": "repo",
  4679. "in": "path",
  4680. "required": true
  4681. },
  4682. {
  4683. "type": "integer",
  4684. "format": "int64",
  4685. "description": "id of the release to delete",
  4686. "name": "id",
  4687. "in": "path",
  4688. "required": true
  4689. }
  4690. ],
  4691. "responses": {
  4692. "204": {
  4693. "$ref": "#/responses/empty"
  4694. }
  4695. }
  4696. },
  4697. "patch": {
  4698. "consumes": [
  4699. "application/json"
  4700. ],
  4701. "produces": [
  4702. "application/json"
  4703. ],
  4704. "tags": [
  4705. "repository"
  4706. ],
  4707. "summary": "Update a release",
  4708. "operationId": "repoEditRelease",
  4709. "parameters": [
  4710. {
  4711. "type": "string",
  4712. "description": "owner of the repo",
  4713. "name": "owner",
  4714. "in": "path",
  4715. "required": true
  4716. },
  4717. {
  4718. "type": "string",
  4719. "description": "name of the repo",
  4720. "name": "repo",
  4721. "in": "path",
  4722. "required": true
  4723. },
  4724. {
  4725. "type": "integer",
  4726. "format": "int64",
  4727. "description": "id of the release to edit",
  4728. "name": "id",
  4729. "in": "path",
  4730. "required": true
  4731. },
  4732. {
  4733. "name": "body",
  4734. "in": "body",
  4735. "schema": {
  4736. "$ref": "#/definitions/EditReleaseOption"
  4737. }
  4738. }
  4739. ],
  4740. "responses": {
  4741. "200": {
  4742. "$ref": "#/responses/Release"
  4743. }
  4744. }
  4745. }
  4746. },
  4747. "/repos/{owner}/{repo}/releases/{id}/assets": {
  4748. "get": {
  4749. "produces": [
  4750. "application/json"
  4751. ],
  4752. "tags": [
  4753. "repository"
  4754. ],
  4755. "summary": "List release's attachments",
  4756. "operationId": "repoListReleaseAttachments",
  4757. "parameters": [
  4758. {
  4759. "type": "string",
  4760. "description": "owner of the repo",
  4761. "name": "owner",
  4762. "in": "path",
  4763. "required": true
  4764. },
  4765. {
  4766. "type": "string",
  4767. "description": "name of the repo",
  4768. "name": "repo",
  4769. "in": "path",
  4770. "required": true
  4771. },
  4772. {
  4773. "type": "integer",
  4774. "format": "int64",
  4775. "description": "id of the release",
  4776. "name": "id",
  4777. "in": "path",
  4778. "required": true
  4779. }
  4780. ],
  4781. "responses": {
  4782. "200": {
  4783. "$ref": "#/responses/AttachmentList"
  4784. }
  4785. }
  4786. },
  4787. "post": {
  4788. "consumes": [
  4789. "multipart/form-data"
  4790. ],
  4791. "produces": [
  4792. "application/json"
  4793. ],
  4794. "tags": [
  4795. "repository"
  4796. ],
  4797. "summary": "Create a release attachment",
  4798. "operationId": "repoCreateReleaseAttachment",
  4799. "parameters": [
  4800. {
  4801. "type": "string",
  4802. "description": "owner of the repo",
  4803. "name": "owner",
  4804. "in": "path",
  4805. "required": true
  4806. },
  4807. {
  4808. "type": "string",
  4809. "description": "name of the repo",
  4810. "name": "repo",
  4811. "in": "path",
  4812. "required": true
  4813. },
  4814. {
  4815. "type": "integer",
  4816. "format": "int64",
  4817. "description": "id of the release",
  4818. "name": "id",
  4819. "in": "path",
  4820. "required": true
  4821. },
  4822. {
  4823. "type": "string",
  4824. "description": "name of the attachment",
  4825. "name": "name",
  4826. "in": "query"
  4827. },
  4828. {
  4829. "type": "file",
  4830. "description": "attachment to upload",
  4831. "name": "attachment",
  4832. "in": "formData",
  4833. "required": true
  4834. }
  4835. ],
  4836. "responses": {
  4837. "201": {
  4838. "$ref": "#/responses/Attachment"
  4839. }
  4840. }
  4841. }
  4842. },
  4843. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  4844. "get": {
  4845. "produces": [
  4846. "application/json"
  4847. ],
  4848. "tags": [
  4849. "repository"
  4850. ],
  4851. "summary": "Get a release attachment",
  4852. "operationId": "repoGetReleaseAttachment",
  4853. "parameters": [
  4854. {
  4855. "type": "string",
  4856. "description": "owner of the repo",
  4857. "name": "owner",
  4858. "in": "path",
  4859. "required": true
  4860. },
  4861. {
  4862. "type": "string",
  4863. "description": "name of the repo",
  4864. "name": "repo",
  4865. "in": "path",
  4866. "required": true
  4867. },
  4868. {
  4869. "type": "integer",
  4870. "format": "int64",
  4871. "description": "id of the release",
  4872. "name": "id",
  4873. "in": "path",
  4874. "required": true
  4875. },
  4876. {
  4877. "type": "integer",
  4878. "format": "int64",
  4879. "description": "id of the attachment to get",
  4880. "name": "attachment_id",
  4881. "in": "path",
  4882. "required": true
  4883. }
  4884. ],
  4885. "responses": {
  4886. "200": {
  4887. "$ref": "#/responses/Attachment"
  4888. }
  4889. }
  4890. },
  4891. "delete": {
  4892. "produces": [
  4893. "application/json"
  4894. ],
  4895. "tags": [
  4896. "repository"
  4897. ],
  4898. "summary": "Delete a release attachment",
  4899. "operationId": "repoDeleteReleaseAttachment",
  4900. "parameters": [
  4901. {
  4902. "type": "string",
  4903. "description": "owner of the repo",
  4904. "name": "owner",
  4905. "in": "path",
  4906. "required": true
  4907. },
  4908. {
  4909. "type": "string",
  4910. "description": "name of the repo",
  4911. "name": "repo",
  4912. "in": "path",
  4913. "required": true
  4914. },
  4915. {
  4916. "type": "integer",
  4917. "format": "int64",
  4918. "description": "id of the release",
  4919. "name": "id",
  4920. "in": "path",
  4921. "required": true
  4922. },
  4923. {
  4924. "type": "integer",
  4925. "format": "int64",
  4926. "description": "id of the attachment to delete",
  4927. "name": "attachment_id",
  4928. "in": "path",
  4929. "required": true
  4930. }
  4931. ],
  4932. "responses": {
  4933. "204": {
  4934. "$ref": "#/responses/empty"
  4935. }
  4936. }
  4937. },
  4938. "patch": {
  4939. "consumes": [
  4940. "application/json"
  4941. ],
  4942. "produces": [
  4943. "application/json"
  4944. ],
  4945. "tags": [
  4946. "repository"
  4947. ],
  4948. "summary": "Edit a release attachment",
  4949. "operationId": "repoEditReleaseAttachment",
  4950. "parameters": [
  4951. {
  4952. "type": "string",
  4953. "description": "owner of the repo",
  4954. "name": "owner",
  4955. "in": "path",
  4956. "required": true
  4957. },
  4958. {
  4959. "type": "string",
  4960. "description": "name of the repo",
  4961. "name": "repo",
  4962. "in": "path",
  4963. "required": true
  4964. },
  4965. {
  4966. "type": "integer",
  4967. "format": "int64",
  4968. "description": "id of the release",
  4969. "name": "id",
  4970. "in": "path",
  4971. "required": true
  4972. },
  4973. {
  4974. "type": "integer",
  4975. "format": "int64",
  4976. "description": "id of the attachment to edit",
  4977. "name": "attachment_id",
  4978. "in": "path",
  4979. "required": true
  4980. },
  4981. {
  4982. "name": "body",
  4983. "in": "body",
  4984. "schema": {
  4985. "$ref": "#/definitions/EditAttachmentOptions"
  4986. }
  4987. }
  4988. ],
  4989. "responses": {
  4990. "201": {
  4991. "$ref": "#/responses/Attachment"
  4992. }
  4993. }
  4994. }
  4995. },
  4996. "/repos/{owner}/{repo}/stargazers": {
  4997. "get": {
  4998. "produces": [
  4999. "application/json"
  5000. ],
  5001. "tags": [
  5002. "repository"
  5003. ],
  5004. "summary": "List a repo's stargazers",
  5005. "operationId": "repoListStargazers",
  5006. "parameters": [
  5007. {
  5008. "type": "string",
  5009. "description": "owner of the repo",
  5010. "name": "owner",
  5011. "in": "path",
  5012. "required": true
  5013. },
  5014. {
  5015. "type": "string",
  5016. "description": "name of the repo",
  5017. "name": "repo",
  5018. "in": "path",
  5019. "required": true
  5020. }
  5021. ],
  5022. "responses": {
  5023. "200": {
  5024. "$ref": "#/responses/UserList"
  5025. }
  5026. }
  5027. }
  5028. },
  5029. "/repos/{owner}/{repo}/statuses/{sha}": {
  5030. "get": {
  5031. "produces": [
  5032. "application/json"
  5033. ],
  5034. "tags": [
  5035. "repository"
  5036. ],
  5037. "summary": "Get a commit's statuses",
  5038. "operationId": "repoListStatuses",
  5039. "parameters": [
  5040. {
  5041. "type": "string",
  5042. "description": "owner of the repo",
  5043. "name": "owner",
  5044. "in": "path",
  5045. "required": true
  5046. },
  5047. {
  5048. "type": "string",
  5049. "description": "name of the repo",
  5050. "name": "repo",
  5051. "in": "path",
  5052. "required": true
  5053. },
  5054. {
  5055. "type": "string",
  5056. "description": "sha of the commit",
  5057. "name": "sha",
  5058. "in": "path",
  5059. "required": true
  5060. }
  5061. ],
  5062. "responses": {
  5063. "200": {
  5064. "$ref": "#/responses/StatusList"
  5065. }
  5066. }
  5067. },
  5068. "post": {
  5069. "produces": [
  5070. "application/json"
  5071. ],
  5072. "tags": [
  5073. "repository"
  5074. ],
  5075. "summary": "Create a commit status",
  5076. "operationId": "repoCreateStatus",
  5077. "parameters": [
  5078. {
  5079. "type": "string",
  5080. "description": "owner of the repo",
  5081. "name": "owner",
  5082. "in": "path",
  5083. "required": true
  5084. },
  5085. {
  5086. "type": "string",
  5087. "description": "name of the repo",
  5088. "name": "repo",
  5089. "in": "path",
  5090. "required": true
  5091. },
  5092. {
  5093. "type": "string",
  5094. "description": "sha of the commit",
  5095. "name": "sha",
  5096. "in": "path",
  5097. "required": true
  5098. },
  5099. {
  5100. "name": "body",
  5101. "in": "body",
  5102. "schema": {
  5103. "$ref": "#/definitions/CreateStatusOption"
  5104. }
  5105. }
  5106. ],
  5107. "responses": {
  5108. "200": {
  5109. "$ref": "#/responses/StatusList"
  5110. }
  5111. }
  5112. }
  5113. },
  5114. "/repos/{owner}/{repo}/subscribers": {
  5115. "get": {
  5116. "produces": [
  5117. "application/json"
  5118. ],
  5119. "tags": [
  5120. "repository"
  5121. ],
  5122. "summary": "List a repo's watchers",
  5123. "operationId": "repoListSubscribers",
  5124. "parameters": [
  5125. {
  5126. "type": "string",
  5127. "description": "owner of the repo",
  5128. "name": "owner",
  5129. "in": "path",
  5130. "required": true
  5131. },
  5132. {
  5133. "type": "string",
  5134. "description": "name of the repo",
  5135. "name": "repo",
  5136. "in": "path",
  5137. "required": true
  5138. }
  5139. ],
  5140. "responses": {
  5141. "200": {
  5142. "$ref": "#/responses/UserList"
  5143. }
  5144. }
  5145. }
  5146. },
  5147. "/repos/{owner}/{repo}/subscription": {
  5148. "get": {
  5149. "tags": [
  5150. "repository"
  5151. ],
  5152. "summary": "Check if the current user is watching a repo",
  5153. "operationId": "userCurrentCheckSubscription",
  5154. "parameters": [
  5155. {
  5156. "type": "string",
  5157. "description": "owner of the repo",
  5158. "name": "owner",
  5159. "in": "path",
  5160. "required": true
  5161. },
  5162. {
  5163. "type": "string",
  5164. "description": "name of the repo",
  5165. "name": "repo",
  5166. "in": "path",
  5167. "required": true
  5168. }
  5169. ],
  5170. "responses": {
  5171. "200": {
  5172. "$ref": "#/responses/WatchInfo"
  5173. }
  5174. }
  5175. },
  5176. "put": {
  5177. "tags": [
  5178. "repository"
  5179. ],
  5180. "summary": "Watch a repo",
  5181. "operationId": "userCurrentPutSubscription",
  5182. "parameters": [
  5183. {
  5184. "type": "string",
  5185. "description": "owner of the repo",
  5186. "name": "owner",
  5187. "in": "path",
  5188. "required": true
  5189. },
  5190. {
  5191. "type": "string",
  5192. "description": "name of the repo",
  5193. "name": "repo",
  5194. "in": "path",
  5195. "required": true
  5196. }
  5197. ],
  5198. "responses": {
  5199. "200": {
  5200. "$ref": "#/responses/WatchInfo"
  5201. }
  5202. }
  5203. },
  5204. "delete": {
  5205. "tags": [
  5206. "repository"
  5207. ],
  5208. "summary": "Unwatch a repo",
  5209. "operationId": "userCurrentDeleteSubscription",
  5210. "parameters": [
  5211. {
  5212. "type": "string",
  5213. "description": "owner of the repo",
  5214. "name": "owner",
  5215. "in": "path",
  5216. "required": true
  5217. },
  5218. {
  5219. "type": "string",
  5220. "description": "name of the repo",
  5221. "name": "repo",
  5222. "in": "path",
  5223. "required": true
  5224. }
  5225. ],
  5226. "responses": {
  5227. "204": {
  5228. "$ref": "#/responses/empty"
  5229. }
  5230. }
  5231. }
  5232. },
  5233. "/repos/{owner}/{repo}/tags": {
  5234. "get": {
  5235. "produces": [
  5236. "application/json"
  5237. ],
  5238. "tags": [
  5239. "repository"
  5240. ],
  5241. "summary": "List a repository's tags",
  5242. "operationId": "repoListTags",
  5243. "parameters": [
  5244. {
  5245. "type": "string",
  5246. "description": "owner of the repo",
  5247. "name": "owner",
  5248. "in": "path",
  5249. "required": true
  5250. },
  5251. {
  5252. "type": "string",
  5253. "description": "name of the repo",
  5254. "name": "repo",
  5255. "in": "path",
  5256. "required": true
  5257. }
  5258. ],
  5259. "responses": {
  5260. "200": {
  5261. "$ref": "#/responses/TagList"
  5262. }
  5263. }
  5264. }
  5265. },
  5266. "/repos/{owner}/{repo}/times": {
  5267. "get": {
  5268. "produces": [
  5269. "application/json"
  5270. ],
  5271. "tags": [
  5272. "repository"
  5273. ],
  5274. "summary": "List a repo's tracked times",
  5275. "operationId": "repoTrackedTimes",
  5276. "parameters": [
  5277. {
  5278. "type": "string",
  5279. "description": "owner of the repo",
  5280. "name": "owner",
  5281. "in": "path",
  5282. "required": true
  5283. },
  5284. {
  5285. "type": "string",
  5286. "description": "name of the repo",
  5287. "name": "repo",
  5288. "in": "path",
  5289. "required": true
  5290. }
  5291. ],
  5292. "responses": {
  5293. "200": {
  5294. "$ref": "#/responses/TrackedTimeList"
  5295. }
  5296. }
  5297. }
  5298. },
  5299. "/repos/{owner}/{repo}/times/{user}": {
  5300. "get": {
  5301. "produces": [
  5302. "application/json"
  5303. ],
  5304. "tags": [
  5305. "user"
  5306. ],
  5307. "summary": "List a user's tracked times in a repo",
  5308. "operationId": "userTrackedTimes",
  5309. "parameters": [
  5310. {
  5311. "type": "string",
  5312. "description": "owner of the repo",
  5313. "name": "owner",
  5314. "in": "path",
  5315. "required": true
  5316. },
  5317. {
  5318. "type": "string",
  5319. "description": "name of the repo",
  5320. "name": "repo",
  5321. "in": "path",
  5322. "required": true
  5323. },
  5324. {
  5325. "type": "string",
  5326. "description": "username of user",
  5327. "name": "user",
  5328. "in": "path",
  5329. "required": true
  5330. }
  5331. ],
  5332. "responses": {
  5333. "200": {
  5334. "$ref": "#/responses/TrackedTimeList"
  5335. }
  5336. }
  5337. }
  5338. },
  5339. "/repositories/{id}": {
  5340. "get": {
  5341. "produces": [
  5342. "application/json"
  5343. ],
  5344. "tags": [
  5345. "repository"
  5346. ],
  5347. "summary": "Get a repository by id",
  5348. "operationId": "repoGetByID",
  5349. "parameters": [
  5350. {
  5351. "type": "integer",
  5352. "format": "int64",
  5353. "description": "id of the repo to get",
  5354. "name": "id",
  5355. "in": "path",
  5356. "required": true
  5357. }
  5358. ],
  5359. "responses": {
  5360. "200": {
  5361. "$ref": "#/responses/Repository"
  5362. }
  5363. }
  5364. }
  5365. },
  5366. "/teams/{id}": {
  5367. "get": {
  5368. "produces": [
  5369. "application/json"
  5370. ],
  5371. "tags": [
  5372. "organization"
  5373. ],
  5374. "summary": "Get a team",
  5375. "operationId": "orgGetTeam",
  5376. "parameters": [
  5377. {
  5378. "type": "integer",
  5379. "format": "int64",
  5380. "description": "id of the team to get",
  5381. "name": "id",
  5382. "in": "path",
  5383. "required": true
  5384. }
  5385. ],
  5386. "responses": {
  5387. "200": {
  5388. "$ref": "#/responses/Team"
  5389. }
  5390. }
  5391. },
  5392. "delete": {
  5393. "tags": [
  5394. "organization"
  5395. ],
  5396. "summary": "Delete a team",
  5397. "operationId": "orgDeleteTeam",
  5398. "parameters": [
  5399. {
  5400. "type": "integer",
  5401. "format": "int64",
  5402. "description": "id of the team to delete",
  5403. "name": "id",
  5404. "in": "path",
  5405. "required": true
  5406. }
  5407. ],
  5408. "responses": {
  5409. "204": {
  5410. "description": "team deleted"
  5411. }
  5412. }
  5413. },
  5414. "patch": {
  5415. "consumes": [
  5416. "application/json"
  5417. ],
  5418. "produces": [
  5419. "application/json"
  5420. ],
  5421. "tags": [
  5422. "organization"
  5423. ],
  5424. "summary": "Edit a team",
  5425. "operationId": "orgEditTeam",
  5426. "parameters": [
  5427. {
  5428. "type": "integer",
  5429. "description": "id of the team to edit",
  5430. "name": "id",
  5431. "in": "path",
  5432. "required": true
  5433. },
  5434. {
  5435. "name": "body",
  5436. "in": "body",
  5437. "schema": {
  5438. "$ref": "#/definitions/EditTeamOption"
  5439. }
  5440. }
  5441. ],
  5442. "responses": {
  5443. "200": {
  5444. "$ref": "#/responses/Team"
  5445. }
  5446. }
  5447. }
  5448. },
  5449. "/teams/{id}/members": {
  5450. "get": {
  5451. "produces": [
  5452. "application/json"
  5453. ],
  5454. "tags": [
  5455. "organization"
  5456. ],
  5457. "summary": "List a team's members",
  5458. "operationId": "orgListTeamMembers",
  5459. "parameters": [
  5460. {
  5461. "type": "integer",
  5462. "format": "int64",
  5463. "description": "id of the team",
  5464. "name": "id",
  5465. "in": "path",
  5466. "required": true
  5467. }
  5468. ],
  5469. "responses": {
  5470. "200": {
  5471. "$ref": "#/responses/UserList"
  5472. }
  5473. }
  5474. }
  5475. },
  5476. "/teams/{id}/members/{username}": {
  5477. "get": {
  5478. "produces": [
  5479. "application/json"
  5480. ],
  5481. "tags": [
  5482. "organization"
  5483. ],
  5484. "summary": "List a particular member of team",
  5485. "operationId": "orgListTeamMember",
  5486. "parameters": [
  5487. {
  5488. "type": "integer",
  5489. "format": "int64",
  5490. "description": "id of the team",
  5491. "name": "id",
  5492. "in": "path",
  5493. "required": true
  5494. },
  5495. {
  5496. "type": "string",
  5497. "description": "username of the member to list",
  5498. "name": "username",
  5499. "in": "path",
  5500. "required": true
  5501. }
  5502. ],
  5503. "responses": {
  5504. "200": {
  5505. "$ref": "#/responses/User"
  5506. }
  5507. }
  5508. },
  5509. "put": {
  5510. "produces": [
  5511. "application/json"
  5512. ],
  5513. "tags": [
  5514. "organization"
  5515. ],
  5516. "summary": "Add a team member",
  5517. "operationId": "orgAddTeamMember",
  5518. "parameters": [
  5519. {
  5520. "type": "integer",
  5521. "format": "int64",
  5522. "description": "id of the team",
  5523. "name": "id",
  5524. "in": "path",
  5525. "required": true
  5526. },
  5527. {
  5528. "type": "string",
  5529. "description": "username of the user to add",
  5530. "name": "username",
  5531. "in": "path",
  5532. "required": true
  5533. }
  5534. ],
  5535. "responses": {
  5536. "204": {
  5537. "$ref": "#/responses/empty"
  5538. }
  5539. }
  5540. },
  5541. "delete": {
  5542. "produces": [
  5543. "application/json"
  5544. ],
  5545. "tags": [
  5546. "organization"
  5547. ],
  5548. "summary": "Remove a team member",
  5549. "operationId": "orgRemoveTeamMember",
  5550. "parameters": [
  5551. {
  5552. "type": "integer",
  5553. "format": "int64",
  5554. "description": "id of the team",
  5555. "name": "id",
  5556. "in": "path",
  5557. "required": true
  5558. },
  5559. {
  5560. "type": "string",
  5561. "description": "username of the user to remove",
  5562. "name": "username",
  5563. "in": "path",
  5564. "required": true
  5565. }
  5566. ],
  5567. "responses": {
  5568. "204": {
  5569. "$ref": "#/responses/empty"
  5570. }
  5571. }
  5572. }
  5573. },
  5574. "/teams/{id}/repos": {
  5575. "get": {
  5576. "produces": [
  5577. "application/json"
  5578. ],
  5579. "tags": [
  5580. "organization"
  5581. ],
  5582. "summary": "List a team's repos",
  5583. "operationId": "orgListTeamRepos",
  5584. "parameters": [
  5585. {
  5586. "type": "integer",
  5587. "format": "int64",
  5588. "description": "id of the team",
  5589. "name": "id",
  5590. "in": "path",
  5591. "required": true
  5592. }
  5593. ],
  5594. "responses": {
  5595. "200": {
  5596. "$ref": "#/responses/RepositoryList"
  5597. }
  5598. }
  5599. }
  5600. },
  5601. "/teams/{id}/repos/{org}/{repo}": {
  5602. "put": {
  5603. "produces": [
  5604. "application/json"
  5605. ],
  5606. "tags": [
  5607. "organization"
  5608. ],
  5609. "summary": "Add a repository to a team",
  5610. "operationId": "orgAddTeamRepository",
  5611. "parameters": [
  5612. {
  5613. "type": "integer",
  5614. "format": "int64",
  5615. "description": "id of the team",
  5616. "name": "id",
  5617. "in": "path",
  5618. "required": true
  5619. },
  5620. {
  5621. "type": "string",
  5622. "description": "organization that owns the repo to add",
  5623. "name": "org",
  5624. "in": "path",
  5625. "required": true
  5626. },
  5627. {
  5628. "type": "string",
  5629. "description": "name of the repo to add",
  5630. "name": "repo",
  5631. "in": "path",
  5632. "required": true
  5633. }
  5634. ],
  5635. "responses": {
  5636. "204": {
  5637. "$ref": "#/responses/empty"
  5638. }
  5639. }
  5640. },
  5641. "delete": {
  5642. "description": "This does not delete the repository, it only removes the repository from the team.",
  5643. "produces": [
  5644. "application/json"
  5645. ],
  5646. "tags": [
  5647. "organization"
  5648. ],
  5649. "summary": "Remove a repository from a team",
  5650. "operationId": "orgRemoveTeamRepository",
  5651. "parameters": [
  5652. {
  5653. "type": "integer",
  5654. "format": "int64",
  5655. "description": "id of the team",
  5656. "name": "id",
  5657. "in": "path",
  5658. "required": true
  5659. },
  5660. {
  5661. "type": "string",
  5662. "description": "organization that owns the repo to remove",
  5663. "name": "org",
  5664. "in": "path",
  5665. "required": true
  5666. },
  5667. {
  5668. "type": "string",
  5669. "description": "name of the repo to remove",
  5670. "name": "repo",
  5671. "in": "path",
  5672. "required": true
  5673. }
  5674. ],
  5675. "responses": {
  5676. "204": {
  5677. "$ref": "#/responses/empty"
  5678. }
  5679. }
  5680. }
  5681. },
  5682. "/topics/search": {
  5683. "get": {
  5684. "produces": [
  5685. "application/json"
  5686. ],
  5687. "tags": [
  5688. "repository"
  5689. ],
  5690. "summary": "search topics via keyword",
  5691. "operationId": "topicSearch",
  5692. "parameters": [
  5693. {
  5694. "type": "string",
  5695. "description": "keywords to search",
  5696. "name": "q",
  5697. "in": "query",
  5698. "required": true
  5699. }
  5700. ],
  5701. "responses": {
  5702. "200": {
  5703. "$ref": "#/responses/Repository"
  5704. }
  5705. }
  5706. }
  5707. },
  5708. "/user": {
  5709. "get": {
  5710. "produces": [
  5711. "application/json"
  5712. ],
  5713. "tags": [
  5714. "user"
  5715. ],
  5716. "summary": "Get the authenticated user",
  5717. "operationId": "userGetCurrent",
  5718. "responses": {
  5719. "200": {
  5720. "$ref": "#/responses/User"
  5721. }
  5722. }
  5723. }
  5724. },
  5725. "/user/emails": {
  5726. "get": {
  5727. "produces": [
  5728. "application/json"
  5729. ],
  5730. "tags": [
  5731. "user"
  5732. ],
  5733. "summary": "List the authenticated user's email addresses",
  5734. "operationId": "userListEmails",
  5735. "responses": {
  5736. "200": {
  5737. "$ref": "#/responses/EmailList"
  5738. }
  5739. }
  5740. },
  5741. "post": {
  5742. "produces": [
  5743. "application/json"
  5744. ],
  5745. "tags": [
  5746. "user"
  5747. ],
  5748. "summary": "Add email addresses",
  5749. "operationId": "userAddEmail",
  5750. "parameters": [
  5751. {
  5752. "name": "body",
  5753. "in": "body",
  5754. "schema": {
  5755. "$ref": "#/definitions/CreateEmailOption"
  5756. }
  5757. }
  5758. ],
  5759. "responses": {
  5760. "201": {
  5761. "$ref": "#/responses/EmailList"
  5762. }
  5763. }
  5764. },
  5765. "delete": {
  5766. "produces": [
  5767. "application/json"
  5768. ],
  5769. "tags": [
  5770. "user"
  5771. ],
  5772. "summary": "Delete email addresses",
  5773. "operationId": "userDeleteEmail",
  5774. "parameters": [
  5775. {
  5776. "name": "body",
  5777. "in": "body",
  5778. "schema": {
  5779. "$ref": "#/definitions/DeleteEmailOption"
  5780. }
  5781. }
  5782. ],
  5783. "responses": {
  5784. "204": {
  5785. "$ref": "#/responses/empty"
  5786. }
  5787. }
  5788. }
  5789. },
  5790. "/user/followers": {
  5791. "get": {
  5792. "produces": [
  5793. "application/json"
  5794. ],
  5795. "tags": [
  5796. "user"
  5797. ],
  5798. "summary": "List the authenticated user's followers",
  5799. "operationId": "userCurrentListFollowers",
  5800. "responses": {
  5801. "200": {
  5802. "$ref": "#/responses/UserList"
  5803. }
  5804. }
  5805. }
  5806. },
  5807. "/user/following": {
  5808. "get": {
  5809. "produces": [
  5810. "application/json"
  5811. ],
  5812. "tags": [
  5813. "user"
  5814. ],
  5815. "summary": "List the users that the authenticated user is following",
  5816. "operationId": "userCurrentListFollowing",
  5817. "responses": {
  5818. "200": {
  5819. "$ref": "#/responses/UserList"
  5820. }
  5821. }
  5822. }
  5823. },
  5824. "/user/following/{username}": {
  5825. "get": {
  5826. "tags": [
  5827. "user"
  5828. ],
  5829. "summary": "Check whether a user is followed by the authenticated user",
  5830. "operationId": "userCurrentCheckFollowing",
  5831. "parameters": [
  5832. {
  5833. "type": "string",
  5834. "description": "username of followed user",
  5835. "name": "username",
  5836. "in": "path",
  5837. "required": true
  5838. }
  5839. ],
  5840. "responses": {
  5841. "204": {
  5842. "$ref": "#/responses/empty"
  5843. },
  5844. "404": {
  5845. "$ref": "#/responses/notFound"
  5846. }
  5847. }
  5848. },
  5849. "put": {
  5850. "tags": [
  5851. "user"
  5852. ],
  5853. "summary": "Follow a user",
  5854. "operationId": "userCurrentPutFollow",
  5855. "parameters": [
  5856. {
  5857. "type": "string",
  5858. "description": "username of user to follow",
  5859. "name": "username",
  5860. "in": "path",
  5861. "required": true
  5862. }
  5863. ],
  5864. "responses": {
  5865. "204": {
  5866. "$ref": "#/responses/empty"
  5867. }
  5868. }
  5869. },
  5870. "delete": {
  5871. "tags": [
  5872. "user"
  5873. ],
  5874. "summary": "Unfollow a user",
  5875. "operationId": "userCurrentDeleteFollow",
  5876. "parameters": [
  5877. {
  5878. "type": "string",
  5879. "description": "username of user to unfollow",
  5880. "name": "username",
  5881. "in": "path",
  5882. "required": true
  5883. }
  5884. ],
  5885. "responses": {
  5886. "204": {
  5887. "$ref": "#/responses/empty"
  5888. }
  5889. }
  5890. }
  5891. },
  5892. "/user/gpg_keys": {
  5893. "get": {
  5894. "produces": [
  5895. "application/json"
  5896. ],
  5897. "tags": [
  5898. "user"
  5899. ],
  5900. "summary": "List the authenticated user's GPG keys",
  5901. "operationId": "userCurrentListGPGKeys",
  5902. "responses": {
  5903. "200": {
  5904. "$ref": "#/responses/GPGKeyList"
  5905. }
  5906. }
  5907. },
  5908. "post": {
  5909. "consumes": [
  5910. "application/json"
  5911. ],
  5912. "produces": [
  5913. "application/json"
  5914. ],
  5915. "tags": [
  5916. "user"
  5917. ],
  5918. "summary": "Create a GPG key",
  5919. "operationId": "userCurrentPostGPGKey",
  5920. "parameters": [
  5921. {
  5922. "name": "Form",
  5923. "in": "body",
  5924. "schema": {
  5925. "$ref": "#/definitions/CreateGPGKeyOption"
  5926. }
  5927. }
  5928. ],
  5929. "responses": {
  5930. "201": {
  5931. "$ref": "#/responses/GPGKey"
  5932. },
  5933. "422": {
  5934. "$ref": "#/responses/validationError"
  5935. }
  5936. }
  5937. }
  5938. },
  5939. "/user/gpg_keys/{id}": {
  5940. "get": {
  5941. "produces": [
  5942. "application/json"
  5943. ],
  5944. "tags": [
  5945. "user"
  5946. ],
  5947. "summary": "Get a GPG key",
  5948. "operationId": "userCurrentGetGPGKey",
  5949. "parameters": [
  5950. {
  5951. "type": "integer",
  5952. "format": "int64",
  5953. "description": "id of key to get",
  5954. "name": "id",
  5955. "in": "path",
  5956. "required": true
  5957. }
  5958. ],
  5959. "responses": {
  5960. "200": {
  5961. "$ref": "#/responses/GPGKey"
  5962. },
  5963. "404": {
  5964. "$ref": "#/responses/notFound"
  5965. }
  5966. }
  5967. },
  5968. "delete": {
  5969. "produces": [
  5970. "application/json"
  5971. ],
  5972. "tags": [
  5973. "user"
  5974. ],
  5975. "summary": "Remove a GPG key",
  5976. "operationId": "userCurrentDeleteGPGKey",
  5977. "parameters": [
  5978. {
  5979. "type": "integer",
  5980. "format": "int64",
  5981. "description": "id of key to delete",
  5982. "name": "id",
  5983. "in": "path",
  5984. "required": true
  5985. }
  5986. ],
  5987. "responses": {
  5988. "204": {
  5989. "$ref": "#/responses/empty"
  5990. },
  5991. "403": {
  5992. "$ref": "#/responses/forbidden"
  5993. }
  5994. }
  5995. }
  5996. },
  5997. "/user/keys": {
  5998. "get": {
  5999. "produces": [
  6000. "application/json"
  6001. ],
  6002. "tags": [
  6003. "user"
  6004. ],
  6005. "summary": "List the authenticated user's public keys",
  6006. "operationId": "userCurrentListKeys",
  6007. "parameters": [
  6008. {
  6009. "type": "string",
  6010. "description": "fingerprint of the key",
  6011. "name": "fingerprint",
  6012. "in": "query"
  6013. }
  6014. ],
  6015. "responses": {
  6016. "200": {
  6017. "$ref": "#/responses/PublicKeyList"
  6018. }
  6019. }
  6020. },
  6021. "post": {
  6022. "consumes": [
  6023. "application/json"
  6024. ],
  6025. "produces": [
  6026. "application/json"
  6027. ],
  6028. "tags": [
  6029. "user"
  6030. ],
  6031. "summary": "Create a public key",
  6032. "operationId": "userCurrentPostKey",
  6033. "parameters": [
  6034. {
  6035. "name": "body",
  6036. "in": "body",
  6037. "schema": {
  6038. "$ref": "#/definitions/CreateKeyOption"
  6039. }
  6040. }
  6041. ],
  6042. "responses": {
  6043. "201": {
  6044. "$ref": "#/responses/PublicKey"
  6045. },
  6046. "422": {
  6047. "$ref": "#/responses/validationError"
  6048. }
  6049. }
  6050. }
  6051. },
  6052. "/user/keys/{id}": {
  6053. "get": {
  6054. "produces": [
  6055. "application/json"
  6056. ],
  6057. "tags": [
  6058. "user"
  6059. ],
  6060. "summary": "Get a public key",
  6061. "operationId": "userCurrentGetKey",
  6062. "parameters": [
  6063. {
  6064. "type": "integer",
  6065. "format": "int64",
  6066. "description": "id of key to get",
  6067. "name": "id",
  6068. "in": "path",
  6069. "required": true
  6070. }
  6071. ],
  6072. "responses": {
  6073. "200": {
  6074. "$ref": "#/responses/PublicKey"
  6075. },
  6076. "404": {
  6077. "$ref": "#/responses/notFound"
  6078. }
  6079. }
  6080. },
  6081. "delete": {
  6082. "produces": [
  6083. "application/json"
  6084. ],
  6085. "tags": [
  6086. "user"
  6087. ],
  6088. "summary": "Delete a public key",
  6089. "operationId": "userCurrentDeleteKey",
  6090. "parameters": [
  6091. {
  6092. "type": "integer",
  6093. "format": "int64",
  6094. "description": "id of key to delete",
  6095. "name": "id",
  6096. "in": "path",
  6097. "required": true
  6098. }
  6099. ],
  6100. "responses": {
  6101. "204": {
  6102. "$ref": "#/responses/empty"
  6103. },
  6104. "403": {
  6105. "$ref": "#/responses/forbidden"
  6106. },
  6107. "404": {
  6108. "$ref": "#/responses/notFound"
  6109. }
  6110. }
  6111. }
  6112. },
  6113. "/user/orgs": {
  6114. "get": {
  6115. "produces": [
  6116. "application/json"
  6117. ],
  6118. "tags": [
  6119. "organization"
  6120. ],
  6121. "summary": "List the current user's organizations",
  6122. "operationId": "orgListCurrentUserOrgs",
  6123. "responses": {
  6124. "200": {
  6125. "$ref": "#/responses/OrganizationList"
  6126. }
  6127. }
  6128. }
  6129. },
  6130. "/user/repos": {
  6131. "get": {
  6132. "produces": [
  6133. "application/json"
  6134. ],
  6135. "tags": [
  6136. "user"
  6137. ],
  6138. "summary": "List the repos that the authenticated user owns or has access to",
  6139. "operationId": "userCurrentListRepos",
  6140. "responses": {
  6141. "200": {
  6142. "$ref": "#/responses/RepositoryList"
  6143. }
  6144. }
  6145. },
  6146. "post": {
  6147. "consumes": [
  6148. "application/json"
  6149. ],
  6150. "produces": [
  6151. "application/json"
  6152. ],
  6153. "tags": [
  6154. "repository",
  6155. "user"
  6156. ],
  6157. "summary": "Create a repository",
  6158. "operationId": "createCurrentUserRepo",
  6159. "parameters": [
  6160. {
  6161. "name": "body",
  6162. "in": "body",
  6163. "schema": {
  6164. "$ref": "#/definitions/CreateRepoOption"
  6165. }
  6166. }
  6167. ],
  6168. "responses": {
  6169. "201": {
  6170. "$ref": "#/responses/Repository"
  6171. },
  6172. "409": {
  6173. "description": "The repository with the same name already exists."
  6174. },
  6175. "422": {
  6176. "$ref": "#/responses/validationError"
  6177. }
  6178. }
  6179. }
  6180. },
  6181. "/user/starred": {
  6182. "get": {
  6183. "produces": [
  6184. "application/json"
  6185. ],
  6186. "tags": [
  6187. "user"
  6188. ],
  6189. "summary": "The repos that the authenticated user has starred",
  6190. "operationId": "userCurrentListStarred",
  6191. "responses": {
  6192. "200": {
  6193. "$ref": "#/responses/RepositoryList"
  6194. }
  6195. }
  6196. }
  6197. },
  6198. "/user/starred/{owner}/{repo}": {
  6199. "get": {
  6200. "tags": [
  6201. "user"
  6202. ],
  6203. "summary": "Whether the authenticated is starring the repo",
  6204. "operationId": "userCurrentCheckStarring",
  6205. "parameters": [
  6206. {
  6207. "type": "string",
  6208. "description": "owner of the repo",
  6209. "name": "owner",
  6210. "in": "path",
  6211. "required": true
  6212. },
  6213. {
  6214. "type": "string",
  6215. "description": "name of the repo",
  6216. "name": "repo",
  6217. "in": "path",
  6218. "required": true
  6219. }
  6220. ],
  6221. "responses": {
  6222. "204": {
  6223. "$ref": "#/responses/empty"
  6224. },
  6225. "404": {
  6226. "$ref": "#/responses/notFound"
  6227. }
  6228. }
  6229. },
  6230. "put": {
  6231. "tags": [
  6232. "user"
  6233. ],
  6234. "summary": "Star the given repo",
  6235. "operationId": "userCurrentPutStar",
  6236. "parameters": [
  6237. {
  6238. "type": "string",
  6239. "description": "owner of the repo to star",
  6240. "name": "owner",
  6241. "in": "path",
  6242. "required": true
  6243. },
  6244. {
  6245. "type": "string",
  6246. "description": "name of the repo to star",
  6247. "name": "repo",
  6248. "in": "path",
  6249. "required": true
  6250. }
  6251. ],
  6252. "responses": {
  6253. "204": {
  6254. "$ref": "#/responses/empty"
  6255. }
  6256. }
  6257. },
  6258. "delete": {
  6259. "tags": [
  6260. "user"
  6261. ],
  6262. "summary": "Unstar the given repo",
  6263. "operationId": "userCurrentDeleteStar",
  6264. "parameters": [
  6265. {
  6266. "type": "string",
  6267. "description": "owner of the repo to unstar",
  6268. "name": "owner",
  6269. "in": "path",
  6270. "required": true
  6271. },
  6272. {
  6273. "type": "string",
  6274. "description": "name of the repo to unstar",
  6275. "name": "repo",
  6276. "in": "path",
  6277. "required": true
  6278. }
  6279. ],
  6280. "responses": {
  6281. "204": {
  6282. "$ref": "#/responses/empty"
  6283. }
  6284. }
  6285. }
  6286. },
  6287. "/user/subscriptions": {
  6288. "get": {
  6289. "produces": [
  6290. "application/json"
  6291. ],
  6292. "tags": [
  6293. "user"
  6294. ],
  6295. "summary": "List repositories watched by the authenticated user",
  6296. "operationId": "userCurrentListSubscriptions",
  6297. "responses": {
  6298. "200": {
  6299. "$ref": "#/responses/RepositoryList"
  6300. }
  6301. }
  6302. }
  6303. },
  6304. "/user/teams": {
  6305. "get": {
  6306. "produces": [
  6307. "application/json"
  6308. ],
  6309. "tags": [
  6310. "user"
  6311. ],
  6312. "summary": "List all the teams a user belongs to",
  6313. "operationId": "userListTeams",
  6314. "responses": {
  6315. "200": {
  6316. "$ref": "#/responses/TeamList"
  6317. }
  6318. }
  6319. }
  6320. },
  6321. "/user/times": {
  6322. "get": {
  6323. "produces": [
  6324. "application/json"
  6325. ],
  6326. "tags": [
  6327. "user"
  6328. ],
  6329. "summary": "List the current user's tracked times",
  6330. "operationId": "userCurrentTrackedTimes",
  6331. "responses": {
  6332. "200": {
  6333. "$ref": "#/responses/TrackedTimeList"
  6334. }
  6335. }
  6336. }
  6337. },
  6338. "/users/search": {
  6339. "get": {
  6340. "produces": [
  6341. "application/json"
  6342. ],
  6343. "tags": [
  6344. "user"
  6345. ],
  6346. "summary": "Search for users",
  6347. "operationId": "userSearch",
  6348. "parameters": [
  6349. {
  6350. "type": "string",
  6351. "description": "keyword",
  6352. "name": "q",
  6353. "in": "query"
  6354. },
  6355. {
  6356. "type": "integer",
  6357. "format": "int64",
  6358. "description": "ID of the user to search for",
  6359. "name": "uid",
  6360. "in": "query"
  6361. },
  6362. {
  6363. "type": "integer",
  6364. "description": "maximum number of users to return",
  6365. "name": "limit",
  6366. "in": "query"
  6367. }
  6368. ],
  6369. "responses": {
  6370. "200": {
  6371. "description": "SearchResults of a successful search",
  6372. "schema": {
  6373. "type": "object",
  6374. "properties": {
  6375. "data": {
  6376. "type": "array",
  6377. "items": {
  6378. "$ref": "#/definitions/User"
  6379. }
  6380. },
  6381. "ok": {
  6382. "type": "boolean"
  6383. }
  6384. }
  6385. }
  6386. }
  6387. }
  6388. }
  6389. },
  6390. "/users/{follower}/following/{followee}": {
  6391. "get": {
  6392. "tags": [
  6393. "user"
  6394. ],
  6395. "summary": "Check if one user is following another user",
  6396. "operationId": "userCheckFollowing",
  6397. "parameters": [
  6398. {
  6399. "type": "string",
  6400. "description": "username of following user",
  6401. "name": "follower",
  6402. "in": "path",
  6403. "required": true
  6404. },
  6405. {
  6406. "type": "string",
  6407. "description": "username of followed user",
  6408. "name": "followee",
  6409. "in": "path",
  6410. "required": true
  6411. }
  6412. ],
  6413. "responses": {
  6414. "204": {
  6415. "$ref": "#/responses/empty"
  6416. },
  6417. "404": {
  6418. "$ref": "#/responses/notFound"
  6419. }
  6420. }
  6421. }
  6422. },
  6423. "/users/{username}": {
  6424. "get": {
  6425. "produces": [
  6426. "application/json"
  6427. ],
  6428. "tags": [
  6429. "user"
  6430. ],
  6431. "summary": "Get a user",
  6432. "operationId": "userGet",
  6433. "parameters": [
  6434. {
  6435. "type": "string",
  6436. "description": "username of user to get",
  6437. "name": "username",
  6438. "in": "path",
  6439. "required": true
  6440. }
  6441. ],
  6442. "responses": {
  6443. "200": {
  6444. "$ref": "#/responses/User"
  6445. },
  6446. "404": {
  6447. "$ref": "#/responses/notFound"
  6448. }
  6449. }
  6450. }
  6451. },
  6452. "/users/{username}/followers": {
  6453. "get": {
  6454. "produces": [
  6455. "application/json"
  6456. ],
  6457. "tags": [
  6458. "user"
  6459. ],
  6460. "summary": "List the given user's followers",
  6461. "operationId": "userListFollowers",
  6462. "parameters": [
  6463. {
  6464. "type": "string",
  6465. "description": "username of user",
  6466. "name": "username",
  6467. "in": "path",
  6468. "required": true
  6469. }
  6470. ],
  6471. "responses": {
  6472. "200": {
  6473. "$ref": "#/responses/UserList"
  6474. }
  6475. }
  6476. }
  6477. },
  6478. "/users/{username}/following": {
  6479. "get": {
  6480. "produces": [
  6481. "application/json"
  6482. ],
  6483. "tags": [
  6484. "user"
  6485. ],
  6486. "summary": "List the users that the given user is following",
  6487. "operationId": "userListFollowing",
  6488. "parameters": [
  6489. {
  6490. "type": "string",
  6491. "description": "username of user",
  6492. "name": "username",
  6493. "in": "path",
  6494. "required": true
  6495. }
  6496. ],
  6497. "responses": {
  6498. "200": {
  6499. "$ref": "#/responses/UserList"
  6500. }
  6501. }
  6502. }
  6503. },
  6504. "/users/{username}/gpg_keys": {
  6505. "get": {
  6506. "produces": [
  6507. "application/json"
  6508. ],
  6509. "tags": [
  6510. "user"
  6511. ],
  6512. "summary": "List the given user's GPG keys",
  6513. "operationId": "userListGPGKeys",
  6514. "parameters": [
  6515. {
  6516. "type": "string",
  6517. "description": "username of user",
  6518. "name": "username",
  6519. "in": "path",
  6520. "required": true
  6521. }
  6522. ],
  6523. "responses": {
  6524. "200": {
  6525. "$ref": "#/responses/GPGKeyList"
  6526. }
  6527. }
  6528. }
  6529. },
  6530. "/users/{username}/heatmap": {
  6531. "get": {
  6532. "produces": [
  6533. "application/json"
  6534. ],
  6535. "tags": [
  6536. "user"
  6537. ],
  6538. "summary": "Get a user's heatmap",
  6539. "operationId": "userGetHeatmapData",
  6540. "parameters": [
  6541. {
  6542. "type": "string",
  6543. "description": "username of user to get",
  6544. "name": "username",
  6545. "in": "path",
  6546. "required": true
  6547. }
  6548. ],
  6549. "responses": {
  6550. "200": {
  6551. "$ref": "#/responses/UserHeatmapData"
  6552. },
  6553. "404": {
  6554. "$ref": "#/responses/notFound"
  6555. }
  6556. }
  6557. }
  6558. },
  6559. "/users/{username}/keys": {
  6560. "get": {
  6561. "produces": [
  6562. "application/json"
  6563. ],
  6564. "tags": [
  6565. "user"
  6566. ],
  6567. "summary": "List the given user's public keys",
  6568. "operationId": "userListKeys",
  6569. "parameters": [
  6570. {
  6571. "type": "string",
  6572. "description": "username of user",
  6573. "name": "username",
  6574. "in": "path",
  6575. "required": true
  6576. },
  6577. {
  6578. "type": "string",
  6579. "description": "fingerprint of the key",
  6580. "name": "fingerprint",
  6581. "in": "query"
  6582. }
  6583. ],
  6584. "responses": {
  6585. "200": {
  6586. "$ref": "#/responses/PublicKeyList"
  6587. }
  6588. }
  6589. }
  6590. },
  6591. "/users/{username}/orgs": {
  6592. "get": {
  6593. "produces": [
  6594. "application/json"
  6595. ],
  6596. "tags": [
  6597. "organization"
  6598. ],
  6599. "summary": "List a user's organizations",
  6600. "operationId": "orgListUserOrgs",
  6601. "parameters": [
  6602. {
  6603. "type": "string",
  6604. "description": "username of user",
  6605. "name": "username",
  6606. "in": "path",
  6607. "required": true
  6608. }
  6609. ],
  6610. "responses": {
  6611. "200": {
  6612. "$ref": "#/responses/OrganizationList"
  6613. }
  6614. }
  6615. }
  6616. },
  6617. "/users/{username}/repos": {
  6618. "get": {
  6619. "produces": [
  6620. "application/json"
  6621. ],
  6622. "tags": [
  6623. "user"
  6624. ],
  6625. "summary": "List the repos owned by the given user",
  6626. "operationId": "userListRepos",
  6627. "parameters": [
  6628. {
  6629. "type": "string",
  6630. "description": "username of user",
  6631. "name": "username",
  6632. "in": "path",
  6633. "required": true
  6634. }
  6635. ],
  6636. "responses": {
  6637. "200": {
  6638. "$ref": "#/responses/RepositoryList"
  6639. }
  6640. }
  6641. }
  6642. },
  6643. "/users/{username}/starred": {
  6644. "get": {
  6645. "produces": [
  6646. "application/json"
  6647. ],
  6648. "tags": [
  6649. "user"
  6650. ],
  6651. "summary": "The repos that the given user has starred",
  6652. "operationId": "userListStarred",
  6653. "parameters": [
  6654. {
  6655. "type": "string",
  6656. "description": "username of user",
  6657. "name": "username",
  6658. "in": "path",
  6659. "required": true
  6660. }
  6661. ],
  6662. "responses": {
  6663. "200": {
  6664. "$ref": "#/responses/RepositoryList"
  6665. }
  6666. }
  6667. }
  6668. },
  6669. "/users/{username}/subscriptions": {
  6670. "get": {
  6671. "produces": [
  6672. "application/json"
  6673. ],
  6674. "tags": [
  6675. "user"
  6676. ],
  6677. "summary": "List the repositories watched by a user",
  6678. "operationId": "userListSubscriptions",
  6679. "parameters": [
  6680. {
  6681. "type": "string",
  6682. "description": "username of the user",
  6683. "name": "username",
  6684. "in": "path",
  6685. "required": true
  6686. }
  6687. ],
  6688. "responses": {
  6689. "200": {
  6690. "$ref": "#/responses/RepositoryList"
  6691. }
  6692. }
  6693. }
  6694. },
  6695. "/users/{username}/tokens": {
  6696. "get": {
  6697. "produces": [
  6698. "application/json"
  6699. ],
  6700. "tags": [
  6701. "user"
  6702. ],
  6703. "summary": "List the authenticated user's access tokens",
  6704. "operationId": "userGetTokens",
  6705. "parameters": [
  6706. {
  6707. "type": "string",
  6708. "description": "username of user",
  6709. "name": "username",
  6710. "in": "path",
  6711. "required": true
  6712. }
  6713. ],
  6714. "responses": {
  6715. "200": {
  6716. "$ref": "#/responses/AccessTokenList"
  6717. }
  6718. }
  6719. },
  6720. "post": {
  6721. "consumes": [
  6722. "application/json"
  6723. ],
  6724. "produces": [
  6725. "application/json"
  6726. ],
  6727. "tags": [
  6728. "user"
  6729. ],
  6730. "summary": "Create an access token",
  6731. "operationId": "userCreateToken",
  6732. "parameters": [
  6733. {
  6734. "type": "string",
  6735. "x-go-name": "Name",
  6736. "description": "username of user",
  6737. "name": "username",
  6738. "in": "path",
  6739. "required": true
  6740. },
  6741. {
  6742. "name": "accessToken",
  6743. "in": "body",
  6744. "schema": {
  6745. "type": "object",
  6746. "required": [
  6747. "name"
  6748. ],
  6749. "properties": {
  6750. "name": {
  6751. "type": "string"
  6752. }
  6753. }
  6754. }
  6755. }
  6756. ],
  6757. "responses": {
  6758. "200": {
  6759. "$ref": "#/responses/AccessToken"
  6760. }
  6761. }
  6762. }
  6763. },
  6764. "/users/{username}/tokens/{token}": {
  6765. "delete": {
  6766. "produces": [
  6767. "application/json"
  6768. ],
  6769. "tags": [
  6770. "user"
  6771. ],
  6772. "summary": "delete an access token",
  6773. "operationId": "userDeleteAccessToken",
  6774. "parameters": [
  6775. {
  6776. "type": "string",
  6777. "description": "username of user",
  6778. "name": "username",
  6779. "in": "path",
  6780. "required": true
  6781. },
  6782. {
  6783. "type": "integer",
  6784. "format": "int64",
  6785. "description": "token to be deleted",
  6786. "name": "token",
  6787. "in": "path",
  6788. "required": true
  6789. }
  6790. ],
  6791. "responses": {
  6792. "204": {
  6793. "$ref": "#/responses/empty"
  6794. }
  6795. }
  6796. }
  6797. },
  6798. "/version": {
  6799. "get": {
  6800. "produces": [
  6801. "application/json"
  6802. ],
  6803. "tags": [
  6804. "miscellaneous"
  6805. ],
  6806. "summary": "Returns the version of the Gitea application",
  6807. "operationId": "getVersion",
  6808. "responses": {
  6809. "200": {
  6810. "$ref": "#/responses/ServerVersion"
  6811. }
  6812. }
  6813. }
  6814. }
  6815. },
  6816. "definitions": {
  6817. "AddCollaboratorOption": {
  6818. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  6819. "type": "object",
  6820. "properties": {
  6821. "permission": {
  6822. "type": "string",
  6823. "x-go-name": "Permission"
  6824. }
  6825. },
  6826. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6827. },
  6828. "AddTimeOption": {
  6829. "description": "AddTimeOption options for adding time to an issue",
  6830. "type": "object",
  6831. "required": [
  6832. "time"
  6833. ],
  6834. "properties": {
  6835. "time": {
  6836. "description": "time in seconds",
  6837. "type": "integer",
  6838. "format": "int64",
  6839. "x-go-name": "Time"
  6840. }
  6841. },
  6842. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6843. },
  6844. "AnnotatedTag": {
  6845. "description": "AnnotatedTag represents an annotated tag",
  6846. "type": "object",
  6847. "properties": {
  6848. "message": {
  6849. "type": "string",
  6850. "x-go-name": "Message"
  6851. },
  6852. "object": {
  6853. "$ref": "#/definitions/AnnotatedTagObject"
  6854. },
  6855. "sha": {
  6856. "type": "string",
  6857. "x-go-name": "SHA"
  6858. },
  6859. "tag": {
  6860. "type": "string",
  6861. "x-go-name": "Tag"
  6862. },
  6863. "tagger": {
  6864. "$ref": "#/definitions/CommitUser"
  6865. },
  6866. "url": {
  6867. "type": "string",
  6868. "x-go-name": "URL"
  6869. },
  6870. "verification": {
  6871. "$ref": "#/definitions/PayloadCommitVerification"
  6872. }
  6873. },
  6874. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6875. },
  6876. "AnnotatedTagObject": {
  6877. "description": "AnnotatedTagObject contains meta information of the tag object",
  6878. "type": "object",
  6879. "properties": {
  6880. "sha": {
  6881. "type": "string",
  6882. "x-go-name": "SHA"
  6883. },
  6884. "type": {
  6885. "type": "string",
  6886. "x-go-name": "Type"
  6887. },
  6888. "url": {
  6889. "type": "string",
  6890. "x-go-name": "URL"
  6891. }
  6892. },
  6893. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6894. },
  6895. "Attachment": {
  6896. "description": "Attachment a generic attachment",
  6897. "type": "object",
  6898. "properties": {
  6899. "browser_download_url": {
  6900. "type": "string",
  6901. "x-go-name": "DownloadURL"
  6902. },
  6903. "created_at": {
  6904. "type": "string",
  6905. "format": "date-time",
  6906. "x-go-name": "Created"
  6907. },
  6908. "download_count": {
  6909. "type": "integer",
  6910. "format": "int64",
  6911. "x-go-name": "DownloadCount"
  6912. },
  6913. "id": {
  6914. "type": "integer",
  6915. "format": "int64",
  6916. "x-go-name": "ID"
  6917. },
  6918. "name": {
  6919. "type": "string",
  6920. "x-go-name": "Name"
  6921. },
  6922. "size": {
  6923. "type": "integer",
  6924. "format": "int64",
  6925. "x-go-name": "Size"
  6926. },
  6927. "uuid": {
  6928. "type": "string",
  6929. "x-go-name": "UUID"
  6930. }
  6931. },
  6932. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6933. },
  6934. "Branch": {
  6935. "description": "Branch represents a repository branch",
  6936. "type": "object",
  6937. "properties": {
  6938. "commit": {
  6939. "$ref": "#/definitions/PayloadCommit"
  6940. },
  6941. "name": {
  6942. "type": "string",
  6943. "x-go-name": "Name"
  6944. }
  6945. },
  6946. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6947. },
  6948. "Comment": {
  6949. "description": "Comment represents a comment on a commit or issue",
  6950. "type": "object",
  6951. "properties": {
  6952. "body": {
  6953. "type": "string",
  6954. "x-go-name": "Body"
  6955. },
  6956. "created_at": {
  6957. "type": "string",
  6958. "format": "date-time",
  6959. "x-go-name": "Created"
  6960. },
  6961. "html_url": {
  6962. "type": "string",
  6963. "x-go-name": "HTMLURL"
  6964. },
  6965. "id": {
  6966. "type": "integer",
  6967. "format": "int64",
  6968. "x-go-name": "ID"
  6969. },
  6970. "issue_url": {
  6971. "type": "string",
  6972. "x-go-name": "IssueURL"
  6973. },
  6974. "pull_request_url": {
  6975. "type": "string",
  6976. "x-go-name": "PRURL"
  6977. },
  6978. "updated_at": {
  6979. "type": "string",
  6980. "format": "date-time",
  6981. "x-go-name": "Updated"
  6982. },
  6983. "user": {
  6984. "$ref": "#/definitions/User"
  6985. }
  6986. },
  6987. "x-go-package": "code.gitea.io/gitea/modules/structs"
  6988. },
  6989. "Commit": {
  6990. "type": "object",
  6991. "title": "Commit contains information generated from a Git commit.",
  6992. "properties": {
  6993. "author": {
  6994. "$ref": "#/definitions/User"
  6995. },
  6996. "commit": {
  6997. "$ref": "#/definitions/RepoCommit"
  6998. },
  6999. "committer": {
  7000. "$ref": "#/definitions/User"
  7001. },
  7002. "html_url": {
  7003. "type": "string",
  7004. "x-go-name": "HTMLURL"
  7005. },
  7006. "parents": {
  7007. "type": "array",
  7008. "items": {
  7009. "$ref": "#/definitions/CommitMeta"
  7010. },
  7011. "x-go-name": "Parents"
  7012. },
  7013. "sha": {
  7014. "type": "string",
  7015. "x-go-name": "SHA"
  7016. },
  7017. "url": {
  7018. "type": "string",
  7019. "x-go-name": "URL"
  7020. }
  7021. },
  7022. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7023. },
  7024. "CommitMeta": {
  7025. "type": "object",
  7026. "title": "CommitMeta contains meta information of a commit in terms of API.",
  7027. "properties": {
  7028. "sha": {
  7029. "type": "string",
  7030. "x-go-name": "SHA"
  7031. },
  7032. "url": {
  7033. "type": "string",
  7034. "x-go-name": "URL"
  7035. }
  7036. },
  7037. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7038. },
  7039. "CommitUser": {
  7040. "type": "object",
  7041. "title": "CommitUser contains information of a user in the context of a commit.",
  7042. "properties": {
  7043. "date": {
  7044. "type": "string",
  7045. "x-go-name": "Date"
  7046. },
  7047. "email": {
  7048. "type": "string",
  7049. "format": "email",
  7050. "x-go-name": "Email"
  7051. },
  7052. "name": {
  7053. "type": "string",
  7054. "x-go-name": "Name"
  7055. }
  7056. },
  7057. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7058. },
  7059. "ContentsResponse": {
  7060. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  7061. "type": "object",
  7062. "properties": {
  7063. "_links": {
  7064. "$ref": "#/definitions/FileLinksResponse"
  7065. },
  7066. "content": {
  7067. "description": "`content` is populated when `type` is `file`, otherwise null",
  7068. "type": "string",
  7069. "x-go-name": "Content"
  7070. },
  7071. "download_url": {
  7072. "type": "string",
  7073. "x-go-name": "DownloadURL"
  7074. },
  7075. "encoding": {
  7076. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  7077. "type": "string",
  7078. "x-go-name": "Encoding"
  7079. },
  7080. "git_url": {
  7081. "type": "string",
  7082. "x-go-name": "GitURL"
  7083. },
  7084. "html_url": {
  7085. "type": "string",
  7086. "x-go-name": "HTMLURL"
  7087. },
  7088. "name": {
  7089. "type": "string",
  7090. "x-go-name": "Name"
  7091. },
  7092. "path": {
  7093. "type": "string",
  7094. "x-go-name": "Path"
  7095. },
  7096. "sha": {
  7097. "type": "string",
  7098. "x-go-name": "SHA"
  7099. },
  7100. "size": {
  7101. "type": "integer",
  7102. "format": "int64",
  7103. "x-go-name": "Size"
  7104. },
  7105. "submodule_git_url": {
  7106. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  7107. "type": "string",
  7108. "x-go-name": "SubmoduleGitURL"
  7109. },
  7110. "target": {
  7111. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  7112. "type": "string",
  7113. "x-go-name": "Target"
  7114. },
  7115. "type": {
  7116. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  7117. "type": "string",
  7118. "x-go-name": "Type"
  7119. },
  7120. "url": {
  7121. "type": "string",
  7122. "x-go-name": "URL"
  7123. }
  7124. },
  7125. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7126. },
  7127. "CreateEmailOption": {
  7128. "description": "CreateEmailOption options when creating email addresses",
  7129. "type": "object",
  7130. "properties": {
  7131. "emails": {
  7132. "description": "email addresses to add",
  7133. "type": "array",
  7134. "items": {
  7135. "type": "string"
  7136. },
  7137. "x-go-name": "Emails"
  7138. }
  7139. },
  7140. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7141. },
  7142. "CreateFileOptions": {
  7143. "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)",
  7144. "type": "object",
  7145. "required": [
  7146. "content"
  7147. ],
  7148. "properties": {
  7149. "author": {
  7150. "$ref": "#/definitions/Identity"
  7151. },
  7152. "branch": {
  7153. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  7154. "type": "string",
  7155. "x-go-name": "BranchName"
  7156. },
  7157. "committer": {
  7158. "$ref": "#/definitions/Identity"
  7159. },
  7160. "content": {
  7161. "description": "content must be base64 encoded",
  7162. "type": "string",
  7163. "x-go-name": "Content"
  7164. },
  7165. "message": {
  7166. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  7167. "type": "string",
  7168. "x-go-name": "Message"
  7169. },
  7170. "new_branch": {
  7171. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  7172. "type": "string",
  7173. "x-go-name": "NewBranchName"
  7174. }
  7175. },
  7176. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7177. },
  7178. "CreateForkOption": {
  7179. "description": "CreateForkOption options for creating a fork",
  7180. "type": "object",
  7181. "properties": {
  7182. "organization": {
  7183. "description": "organization name, if forking into an organization",
  7184. "type": "string",
  7185. "x-go-name": "Organization"
  7186. }
  7187. },
  7188. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7189. },
  7190. "CreateGPGKeyOption": {
  7191. "description": "CreateGPGKeyOption options create user GPG key",
  7192. "type": "object",
  7193. "required": [
  7194. "armored_public_key"
  7195. ],
  7196. "properties": {
  7197. "armored_public_key": {
  7198. "description": "An armored GPG key to add",
  7199. "type": "string",
  7200. "uniqueItems": true,
  7201. "x-go-name": "ArmoredKey"
  7202. }
  7203. },
  7204. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7205. },
  7206. "CreateHookOption": {
  7207. "description": "CreateHookOption options when create a hook",
  7208. "type": "object",
  7209. "required": [
  7210. "type",
  7211. "config"
  7212. ],
  7213. "properties": {
  7214. "active": {
  7215. "type": "boolean",
  7216. "default": false,
  7217. "x-go-name": "Active"
  7218. },
  7219. "config": {
  7220. "type": "object",
  7221. "additionalProperties": {
  7222. "type": "string"
  7223. },
  7224. "x-go-name": "Config"
  7225. },
  7226. "events": {
  7227. "type": "array",
  7228. "items": {
  7229. "type": "string"
  7230. },
  7231. "x-go-name": "Events"
  7232. },
  7233. "type": {
  7234. "type": "string",
  7235. "enum": [
  7236. "gitea",
  7237. "gogs",
  7238. "slack",
  7239. "discord"
  7240. ],
  7241. "x-go-name": "Type"
  7242. }
  7243. },
  7244. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7245. },
  7246. "CreateIssueCommentOption": {
  7247. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  7248. "type": "object",
  7249. "required": [
  7250. "body"
  7251. ],
  7252. "properties": {
  7253. "body": {
  7254. "type": "string",
  7255. "x-go-name": "Body"
  7256. }
  7257. },
  7258. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7259. },
  7260. "CreateIssueOption": {
  7261. "description": "CreateIssueOption options to create one issue",
  7262. "type": "object",
  7263. "required": [
  7264. "title"
  7265. ],
  7266. "properties": {
  7267. "assignee": {
  7268. "description": "username of assignee",
  7269. "type": "string",
  7270. "x-go-name": "Assignee"
  7271. },
  7272. "assignees": {
  7273. "type": "array",
  7274. "items": {
  7275. "type": "string"
  7276. },
  7277. "x-go-name": "Assignees"
  7278. },
  7279. "body": {
  7280. "type": "string",
  7281. "x-go-name": "Body"
  7282. },
  7283. "closed": {
  7284. "type": "boolean",
  7285. "x-go-name": "Closed"
  7286. },
  7287. "due_date": {
  7288. "type": "string",
  7289. "format": "date-time",
  7290. "x-go-name": "Deadline"
  7291. },
  7292. "labels": {
  7293. "description": "list of label ids",
  7294. "type": "array",
  7295. "items": {
  7296. "type": "integer",
  7297. "format": "int64"
  7298. },
  7299. "x-go-name": "Labels"
  7300. },
  7301. "milestone": {
  7302. "description": "milestone id",
  7303. "type": "integer",
  7304. "format": "int64",
  7305. "x-go-name": "Milestone"
  7306. },
  7307. "title": {
  7308. "type": "string",
  7309. "x-go-name": "Title"
  7310. }
  7311. },
  7312. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7313. },
  7314. "CreateKeyOption": {
  7315. "description": "CreateKeyOption options when creating a key",
  7316. "type": "object",
  7317. "required": [
  7318. "title",
  7319. "key"
  7320. ],
  7321. "properties": {
  7322. "key": {
  7323. "description": "An armored SSH key to add",
  7324. "type": "string",
  7325. "uniqueItems": true,
  7326. "x-go-name": "Key"
  7327. },
  7328. "read_only": {
  7329. "description": "Describe if the key has only read access or read/write",
  7330. "type": "boolean",
  7331. "x-go-name": "ReadOnly"
  7332. },
  7333. "title": {
  7334. "description": "Title of the key to add",
  7335. "type": "string",
  7336. "uniqueItems": true,
  7337. "x-go-name": "Title"
  7338. }
  7339. },
  7340. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7341. },
  7342. "CreateLabelOption": {
  7343. "description": "CreateLabelOption options for creating a label",
  7344. "type": "object",
  7345. "required": [
  7346. "name",
  7347. "color"
  7348. ],
  7349. "properties": {
  7350. "color": {
  7351. "type": "string",
  7352. "x-go-name": "Color",
  7353. "example": "#00aabb"
  7354. },
  7355. "description": {
  7356. "type": "string",
  7357. "x-go-name": "Description"
  7358. },
  7359. "name": {
  7360. "type": "string",
  7361. "x-go-name": "Name"
  7362. }
  7363. },
  7364. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7365. },
  7366. "CreateMilestoneOption": {
  7367. "description": "CreateMilestoneOption options for creating a milestone",
  7368. "type": "object",
  7369. "properties": {
  7370. "description": {
  7371. "type": "string",
  7372. "x-go-name": "Description"
  7373. },
  7374. "due_on": {
  7375. "type": "string",
  7376. "format": "date-time",
  7377. "x-go-name": "Deadline"
  7378. },
  7379. "title": {
  7380. "type": "string",
  7381. "x-go-name": "Title"
  7382. }
  7383. },
  7384. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7385. },
  7386. "CreateOrgOption": {
  7387. "description": "CreateOrgOption options for creating an organization",
  7388. "type": "object",
  7389. "required": [
  7390. "username"
  7391. ],
  7392. "properties": {
  7393. "description": {
  7394. "type": "string",
  7395. "x-go-name": "Description"
  7396. },
  7397. "full_name": {
  7398. "type": "string",
  7399. "x-go-name": "FullName"
  7400. },
  7401. "location": {
  7402. "type": "string",
  7403. "x-go-name": "Location"
  7404. },
  7405. "username": {
  7406. "type": "string",
  7407. "x-go-name": "UserName"
  7408. },
  7409. "visibility": {
  7410. "description": "possible values are `public` (default), `limited` or `private`",
  7411. "type": "string",
  7412. "enum": [
  7413. "public",
  7414. "limited",
  7415. "private"
  7416. ],
  7417. "x-go-name": "Visibility"
  7418. },
  7419. "website": {
  7420. "type": "string",
  7421. "x-go-name": "Website"
  7422. }
  7423. },
  7424. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7425. },
  7426. "CreatePullRequestOption": {
  7427. "description": "CreatePullRequestOption options when creating a pull request",
  7428. "type": "object",
  7429. "properties": {
  7430. "assignee": {
  7431. "type": "string",
  7432. "x-go-name": "Assignee"
  7433. },
  7434. "assignees": {
  7435. "type": "array",
  7436. "items": {
  7437. "type": "string"
  7438. },
  7439. "x-go-name": "Assignees"
  7440. },
  7441. "base": {
  7442. "type": "string",
  7443. "x-go-name": "Base"
  7444. },
  7445. "body": {
  7446. "type": "string",
  7447. "x-go-name": "Body"
  7448. },
  7449. "due_date": {
  7450. "type": "string",
  7451. "format": "date-time",
  7452. "x-go-name": "Deadline"
  7453. },
  7454. "head": {
  7455. "type": "string",
  7456. "x-go-name": "Head"
  7457. },
  7458. "labels": {
  7459. "type": "array",
  7460. "items": {
  7461. "type": "integer",
  7462. "format": "int64"
  7463. },
  7464. "x-go-name": "Labels"
  7465. },
  7466. "milestone": {
  7467. "type": "integer",
  7468. "format": "int64",
  7469. "x-go-name": "Milestone"
  7470. },
  7471. "title": {
  7472. "type": "string",
  7473. "x-go-name": "Title"
  7474. }
  7475. },
  7476. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7477. },
  7478. "CreateReleaseOption": {
  7479. "description": "CreateReleaseOption options when creating a release",
  7480. "type": "object",
  7481. "required": [
  7482. "tag_name"
  7483. ],
  7484. "properties": {
  7485. "body": {
  7486. "type": "string",
  7487. "x-go-name": "Note"
  7488. },
  7489. "draft": {
  7490. "type": "boolean",
  7491. "x-go-name": "IsDraft"
  7492. },
  7493. "name": {
  7494. "type": "string",
  7495. "x-go-name": "Title"
  7496. },
  7497. "prerelease": {
  7498. "type": "boolean",
  7499. "x-go-name": "IsPrerelease"
  7500. },
  7501. "tag_name": {
  7502. "type": "string",
  7503. "x-go-name": "TagName"
  7504. },
  7505. "target_commitish": {
  7506. "type": "string",
  7507. "x-go-name": "Target"
  7508. }
  7509. },
  7510. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7511. },
  7512. "CreateRepoOption": {
  7513. "description": "CreateRepoOption options when creating repository",
  7514. "type": "object",
  7515. "required": [
  7516. "name"
  7517. ],
  7518. "properties": {
  7519. "auto_init": {
  7520. "description": "Whether the repository should be auto-intialized?",
  7521. "type": "boolean",
  7522. "x-go-name": "AutoInit"
  7523. },
  7524. "description": {
  7525. "description": "Description of the repository to create",
  7526. "type": "string",
  7527. "x-go-name": "Description"
  7528. },
  7529. "gitignores": {
  7530. "description": "Gitignores to use",
  7531. "type": "string",
  7532. "x-go-name": "Gitignores"
  7533. },
  7534. "license": {
  7535. "description": "License to use",
  7536. "type": "string",
  7537. "x-go-name": "License"
  7538. },
  7539. "name": {
  7540. "description": "Name of the repository to create",
  7541. "type": "string",
  7542. "uniqueItems": true,
  7543. "x-go-name": "Name"
  7544. },
  7545. "private": {
  7546. "description": "Whether the repository is private",
  7547. "type": "boolean",
  7548. "x-go-name": "Private"
  7549. },
  7550. "readme": {
  7551. "description": "Readme of the repository to create",
  7552. "type": "string",
  7553. "x-go-name": "Readme"
  7554. }
  7555. },
  7556. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7557. },
  7558. "CreateStatusOption": {
  7559. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  7560. "type": "object",
  7561. "properties": {
  7562. "context": {
  7563. "type": "string",
  7564. "x-go-name": "Context"
  7565. },
  7566. "description": {
  7567. "type": "string",
  7568. "x-go-name": "Description"
  7569. },
  7570. "state": {
  7571. "$ref": "#/definitions/StatusState"
  7572. },
  7573. "target_url": {
  7574. "type": "string",
  7575. "x-go-name": "TargetURL"
  7576. }
  7577. },
  7578. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7579. },
  7580. "CreateTeamOption": {
  7581. "description": "CreateTeamOption options for creating a team",
  7582. "type": "object",
  7583. "required": [
  7584. "name"
  7585. ],
  7586. "properties": {
  7587. "description": {
  7588. "type": "string",
  7589. "x-go-name": "Description"
  7590. },
  7591. "name": {
  7592. "type": "string",
  7593. "x-go-name": "Name"
  7594. },
  7595. "permission": {
  7596. "type": "string",
  7597. "enum": [
  7598. "read",
  7599. "write",
  7600. "admin"
  7601. ],
  7602. "x-go-name": "Permission"
  7603. },
  7604. "units": {
  7605. "type": "array",
  7606. "enum": [
  7607. "repo.code",
  7608. "repo.issues",
  7609. "repo.ext_issues",
  7610. "repo.wiki",
  7611. "repo.pulls",
  7612. "repo.releases",
  7613. "repo.ext_wiki"
  7614. ],
  7615. "items": {
  7616. "type": "string"
  7617. },
  7618. "x-go-name": "Units"
  7619. }
  7620. },
  7621. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7622. },
  7623. "CreateUserOption": {
  7624. "description": "CreateUserOption create user options",
  7625. "type": "object",
  7626. "required": [
  7627. "username",
  7628. "email",
  7629. "password"
  7630. ],
  7631. "properties": {
  7632. "email": {
  7633. "type": "string",
  7634. "format": "email",
  7635. "x-go-name": "Email"
  7636. },
  7637. "full_name": {
  7638. "type": "string",
  7639. "x-go-name": "FullName"
  7640. },
  7641. "login_name": {
  7642. "type": "string",
  7643. "x-go-name": "LoginName"
  7644. },
  7645. "must_change_password": {
  7646. "type": "boolean",
  7647. "x-go-name": "MustChangePassword"
  7648. },
  7649. "password": {
  7650. "type": "string",
  7651. "x-go-name": "Password"
  7652. },
  7653. "send_notify": {
  7654. "type": "boolean",
  7655. "x-go-name": "SendNotify"
  7656. },
  7657. "source_id": {
  7658. "type": "integer",
  7659. "format": "int64",
  7660. "x-go-name": "SourceID"
  7661. },
  7662. "username": {
  7663. "type": "string",
  7664. "x-go-name": "Username"
  7665. }
  7666. },
  7667. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7668. },
  7669. "DeleteEmailOption": {
  7670. "description": "DeleteEmailOption options when deleting email addresses",
  7671. "type": "object",
  7672. "properties": {
  7673. "emails": {
  7674. "description": "email addresses to delete",
  7675. "type": "array",
  7676. "items": {
  7677. "type": "string"
  7678. },
  7679. "x-go-name": "Emails"
  7680. }
  7681. },
  7682. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7683. },
  7684. "DeleteFileOptions": {
  7685. "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)",
  7686. "type": "object",
  7687. "required": [
  7688. "sha"
  7689. ],
  7690. "properties": {
  7691. "author": {
  7692. "$ref": "#/definitions/Identity"
  7693. },
  7694. "branch": {
  7695. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  7696. "type": "string",
  7697. "x-go-name": "BranchName"
  7698. },
  7699. "committer": {
  7700. "$ref": "#/definitions/Identity"
  7701. },
  7702. "message": {
  7703. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  7704. "type": "string",
  7705. "x-go-name": "Message"
  7706. },
  7707. "new_branch": {
  7708. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  7709. "type": "string",
  7710. "x-go-name": "NewBranchName"
  7711. },
  7712. "sha": {
  7713. "description": "sha is the SHA for the file that already exists",
  7714. "type": "string",
  7715. "x-go-name": "SHA"
  7716. }
  7717. },
  7718. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7719. },
  7720. "DeployKey": {
  7721. "description": "DeployKey a deploy key",
  7722. "type": "object",
  7723. "properties": {
  7724. "created_at": {
  7725. "type": "string",
  7726. "format": "date-time",
  7727. "x-go-name": "Created"
  7728. },
  7729. "fingerprint": {
  7730. "type": "string",
  7731. "x-go-name": "Fingerprint"
  7732. },
  7733. "id": {
  7734. "type": "integer",
  7735. "format": "int64",
  7736. "x-go-name": "ID"
  7737. },
  7738. "key": {
  7739. "type": "string",
  7740. "x-go-name": "Key"
  7741. },
  7742. "key_id": {
  7743. "type": "integer",
  7744. "format": "int64",
  7745. "x-go-name": "KeyID"
  7746. },
  7747. "read_only": {
  7748. "type": "boolean",
  7749. "x-go-name": "ReadOnly"
  7750. },
  7751. "repository": {
  7752. "$ref": "#/definitions/Repository"
  7753. },
  7754. "title": {
  7755. "type": "string",
  7756. "x-go-name": "Title"
  7757. },
  7758. "url": {
  7759. "type": "string",
  7760. "x-go-name": "URL"
  7761. }
  7762. },
  7763. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7764. },
  7765. "EditAttachmentOptions": {
  7766. "description": "EditAttachmentOptions options for editing attachments",
  7767. "type": "object",
  7768. "properties": {
  7769. "name": {
  7770. "type": "string",
  7771. "x-go-name": "Name"
  7772. }
  7773. },
  7774. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7775. },
  7776. "EditDeadlineOption": {
  7777. "description": "EditDeadlineOption options for creating a deadline",
  7778. "type": "object",
  7779. "required": [
  7780. "due_date"
  7781. ],
  7782. "properties": {
  7783. "due_date": {
  7784. "type": "string",
  7785. "format": "date-time",
  7786. "x-go-name": "Deadline"
  7787. }
  7788. },
  7789. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7790. },
  7791. "EditGitHookOption": {
  7792. "description": "EditGitHookOption options when modifying one Git hook",
  7793. "type": "object",
  7794. "properties": {
  7795. "content": {
  7796. "type": "string",
  7797. "x-go-name": "Content"
  7798. }
  7799. },
  7800. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7801. },
  7802. "EditHookOption": {
  7803. "description": "EditHookOption options when modify one hook",
  7804. "type": "object",
  7805. "properties": {
  7806. "active": {
  7807. "type": "boolean",
  7808. "x-go-name": "Active"
  7809. },
  7810. "config": {
  7811. "type": "object",
  7812. "additionalProperties": {
  7813. "type": "string"
  7814. },
  7815. "x-go-name": "Config"
  7816. },
  7817. "events": {
  7818. "type": "array",
  7819. "items": {
  7820. "type": "string"
  7821. },
  7822. "x-go-name": "Events"
  7823. }
  7824. },
  7825. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7826. },
  7827. "EditIssueCommentOption": {
  7828. "description": "EditIssueCommentOption options for editing a comment",
  7829. "type": "object",
  7830. "required": [
  7831. "body"
  7832. ],
  7833. "properties": {
  7834. "body": {
  7835. "type": "string",
  7836. "x-go-name": "Body"
  7837. }
  7838. },
  7839. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7840. },
  7841. "EditIssueOption": {
  7842. "description": "EditIssueOption options for editing an issue",
  7843. "type": "object",
  7844. "properties": {
  7845. "assignee": {
  7846. "type": "string",
  7847. "x-go-name": "Assignee"
  7848. },
  7849. "assignees": {
  7850. "type": "array",
  7851. "items": {
  7852. "type": "string"
  7853. },
  7854. "x-go-name": "Assignees"
  7855. },
  7856. "body": {
  7857. "type": "string",
  7858. "x-go-name": "Body"
  7859. },
  7860. "due_date": {
  7861. "type": "string",
  7862. "format": "date-time",
  7863. "x-go-name": "Deadline"
  7864. },
  7865. "milestone": {
  7866. "type": "integer",
  7867. "format": "int64",
  7868. "x-go-name": "Milestone"
  7869. },
  7870. "state": {
  7871. "type": "string",
  7872. "x-go-name": "State"
  7873. },
  7874. "title": {
  7875. "type": "string",
  7876. "x-go-name": "Title"
  7877. }
  7878. },
  7879. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7880. },
  7881. "EditLabelOption": {
  7882. "description": "EditLabelOption options for editing a label",
  7883. "type": "object",
  7884. "properties": {
  7885. "color": {
  7886. "type": "string",
  7887. "x-go-name": "Color"
  7888. },
  7889. "description": {
  7890. "type": "string",
  7891. "x-go-name": "Description"
  7892. },
  7893. "name": {
  7894. "type": "string",
  7895. "x-go-name": "Name"
  7896. }
  7897. },
  7898. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7899. },
  7900. "EditMilestoneOption": {
  7901. "description": "EditMilestoneOption options for editing a milestone",
  7902. "type": "object",
  7903. "properties": {
  7904. "description": {
  7905. "type": "string",
  7906. "x-go-name": "Description"
  7907. },
  7908. "due_on": {
  7909. "type": "string",
  7910. "format": "date-time",
  7911. "x-go-name": "Deadline"
  7912. },
  7913. "state": {
  7914. "type": "string",
  7915. "x-go-name": "State"
  7916. },
  7917. "title": {
  7918. "type": "string",
  7919. "x-go-name": "Title"
  7920. }
  7921. },
  7922. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7923. },
  7924. "EditOrgOption": {
  7925. "description": "EditOrgOption options for editing an organization",
  7926. "type": "object",
  7927. "properties": {
  7928. "description": {
  7929. "type": "string",
  7930. "x-go-name": "Description"
  7931. },
  7932. "full_name": {
  7933. "type": "string",
  7934. "x-go-name": "FullName"
  7935. },
  7936. "location": {
  7937. "type": "string",
  7938. "x-go-name": "Location"
  7939. },
  7940. "visibility": {
  7941. "description": "possible values are `public`, `limited` or `private`",
  7942. "type": "string",
  7943. "enum": [
  7944. "public",
  7945. "limited",
  7946. "private"
  7947. ],
  7948. "x-go-name": "Visibility"
  7949. },
  7950. "website": {
  7951. "type": "string",
  7952. "x-go-name": "Website"
  7953. }
  7954. },
  7955. "x-go-package": "code.gitea.io/gitea/modules/structs"
  7956. },
  7957. "EditPullRequestOption": {
  7958. "description": "EditPullRequestOption options when modify pull request",
  7959. "type": "object",
  7960. "properties": {
  7961. "assignee": {
  7962. "type": "string",
  7963. "x-go-name": "Assignee"
  7964. },
  7965. "assignees": {
  7966. "type": "array",
  7967. "items": {
  7968. "type": "string"
  7969. },
  7970. "x-go-name": "Assignees"
  7971. },
  7972. "body": {
  7973. "type": "string",
  7974. "x-go-name": "Body"
  7975. },
  7976. "due_date": {
  7977. "type": "string",
  7978. "format": "date-time",
  7979. "x-go-name": "Deadline"
  7980. },
  7981. "labels": {
  7982. "type": "array",
  7983. "items": {
  7984. "type": "integer",
  7985. "format": "int64"
  7986. },
  7987. "x-go-name": "Labels"
  7988. },
  7989. "milestone": {
  7990. "type": "integer",
  7991. "format": "int64",
  7992. "x-go-name": "Milestone"
  7993. },
  7994. "state": {
  7995. "type": "string",
  7996. "x-go-name": "State"
  7997. },
  7998. "title": {
  7999. "type": "string",
  8000. "x-go-name": "Title"
  8001. }
  8002. },
  8003. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8004. },
  8005. "EditReleaseOption": {
  8006. "description": "EditReleaseOption options when editing a release",
  8007. "type": "object",
  8008. "properties": {
  8009. "body": {
  8010. "type": "string",
  8011. "x-go-name": "Note"
  8012. },
  8013. "draft": {
  8014. "type": "boolean",
  8015. "x-go-name": "IsDraft"
  8016. },
  8017. "name": {
  8018. "type": "string",
  8019. "x-go-name": "Title"
  8020. },
  8021. "prerelease": {
  8022. "type": "boolean",
  8023. "x-go-name": "IsPrerelease"
  8024. },
  8025. "tag_name": {
  8026. "type": "string",
  8027. "x-go-name": "TagName"
  8028. },
  8029. "target_commitish": {
  8030. "type": "string",
  8031. "x-go-name": "Target"
  8032. }
  8033. },
  8034. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8035. },
  8036. "EditRepoOption": {
  8037. "description": "EditRepoOption options when editing a repository's properties",
  8038. "type": "object",
  8039. "properties": {
  8040. "allow_merge_commits": {
  8041. "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`.",
  8042. "type": "boolean",
  8043. "x-go-name": "AllowMerge"
  8044. },
  8045. "allow_rebase": {
  8046. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  8047. "type": "boolean",
  8048. "x-go-name": "AllowRebase"
  8049. },
  8050. "allow_rebase_explicit": {
  8051. "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`.",
  8052. "type": "boolean",
  8053. "x-go-name": "AllowRebaseMerge"
  8054. },
  8055. "allow_squash_merge": {
  8056. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  8057. "type": "boolean",
  8058. "x-go-name": "AllowSquash"
  8059. },
  8060. "archived": {
  8061. "description": "set to `true` to archive this repository.",
  8062. "type": "boolean",
  8063. "x-go-name": "Archived"
  8064. },
  8065. "default_branch": {
  8066. "description": "sets the default branch for this repository.",
  8067. "type": "string",
  8068. "x-go-name": "DefaultBranch"
  8069. },
  8070. "description": {
  8071. "description": "a short description of the repository.",
  8072. "type": "string",
  8073. "x-go-name": "Description"
  8074. },
  8075. "has_issues": {
  8076. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  8077. "type": "boolean",
  8078. "x-go-name": "HasIssues"
  8079. },
  8080. "has_pull_requests": {
  8081. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  8082. "type": "boolean",
  8083. "x-go-name": "HasPullRequests"
  8084. },
  8085. "has_wiki": {
  8086. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  8087. "type": "boolean",
  8088. "x-go-name": "HasWiki"
  8089. },
  8090. "ignore_whitespace_conflicts": {
  8091. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  8092. "type": "boolean",
  8093. "x-go-name": "IgnoreWhitespaceConflicts"
  8094. },
  8095. "name": {
  8096. "description": "name of the repository",
  8097. "type": "string",
  8098. "uniqueItems": true,
  8099. "x-go-name": "Name"
  8100. },
  8101. "private": {
  8102. "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.",
  8103. "type": "boolean",
  8104. "x-go-name": "Private"
  8105. },
  8106. "website": {
  8107. "description": "a URL with more information about the repository.",
  8108. "type": "string",
  8109. "x-go-name": "Website"
  8110. }
  8111. },
  8112. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8113. },
  8114. "EditTeamOption": {
  8115. "description": "EditTeamOption options for editing a team",
  8116. "type": "object",
  8117. "required": [
  8118. "name"
  8119. ],
  8120. "properties": {
  8121. "description": {
  8122. "type": "string",
  8123. "x-go-name": "Description"
  8124. },
  8125. "name": {
  8126. "type": "string",
  8127. "x-go-name": "Name"
  8128. },
  8129. "permission": {
  8130. "type": "string",
  8131. "enum": [
  8132. "read",
  8133. "write",
  8134. "admin"
  8135. ],
  8136. "x-go-name": "Permission"
  8137. },
  8138. "units": {
  8139. "type": "array",
  8140. "enum": [
  8141. "repo.code",
  8142. "repo.issues",
  8143. "repo.ext_issues",
  8144. "repo.wiki",
  8145. "repo.pulls",
  8146. "repo.releases",
  8147. "repo.ext_wiki"
  8148. ],
  8149. "items": {
  8150. "type": "string"
  8151. },
  8152. "x-go-name": "Units"
  8153. }
  8154. },
  8155. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8156. },
  8157. "EditUserOption": {
  8158. "description": "EditUserOption edit user options",
  8159. "type": "object",
  8160. "required": [
  8161. "email"
  8162. ],
  8163. "properties": {
  8164. "active": {
  8165. "type": "boolean",
  8166. "x-go-name": "Active"
  8167. },
  8168. "admin": {
  8169. "type": "boolean",
  8170. "x-go-name": "Admin"
  8171. },
  8172. "allow_create_organization": {
  8173. "type": "boolean",
  8174. "x-go-name": "AllowCreateOrganization"
  8175. },
  8176. "allow_git_hook": {
  8177. "type": "boolean",
  8178. "x-go-name": "AllowGitHook"
  8179. },
  8180. "allow_import_local": {
  8181. "type": "boolean",
  8182. "x-go-name": "AllowImportLocal"
  8183. },
  8184. "email": {
  8185. "type": "string",
  8186. "format": "email",
  8187. "x-go-name": "Email"
  8188. },
  8189. "full_name": {
  8190. "type": "string",
  8191. "x-go-name": "FullName"
  8192. },
  8193. "location": {
  8194. "type": "string",
  8195. "x-go-name": "Location"
  8196. },
  8197. "login_name": {
  8198. "type": "string",
  8199. "x-go-name": "LoginName"
  8200. },
  8201. "max_repo_creation": {
  8202. "type": "integer",
  8203. "format": "int64",
  8204. "x-go-name": "MaxRepoCreation"
  8205. },
  8206. "must_change_password": {
  8207. "type": "boolean",
  8208. "x-go-name": "MustChangePassword"
  8209. },
  8210. "password": {
  8211. "type": "string",
  8212. "x-go-name": "Password"
  8213. },
  8214. "prohibit_login": {
  8215. "type": "boolean",
  8216. "x-go-name": "ProhibitLogin"
  8217. },
  8218. "source_id": {
  8219. "type": "integer",
  8220. "format": "int64",
  8221. "x-go-name": "SourceID"
  8222. },
  8223. "website": {
  8224. "type": "string",
  8225. "x-go-name": "Website"
  8226. }
  8227. },
  8228. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8229. },
  8230. "Email": {
  8231. "description": "Email an email address belonging to a user",
  8232. "type": "object",
  8233. "properties": {
  8234. "email": {
  8235. "type": "string",
  8236. "format": "email",
  8237. "x-go-name": "Email"
  8238. },
  8239. "primary": {
  8240. "type": "boolean",
  8241. "x-go-name": "Primary"
  8242. },
  8243. "verified": {
  8244. "type": "boolean",
  8245. "x-go-name": "Verified"
  8246. }
  8247. },
  8248. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8249. },
  8250. "FileCommitResponse": {
  8251. "type": "object",
  8252. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  8253. "properties": {
  8254. "author": {
  8255. "$ref": "#/definitions/CommitUser"
  8256. },
  8257. "committer": {
  8258. "$ref": "#/definitions/CommitUser"
  8259. },
  8260. "html_url": {
  8261. "type": "string",
  8262. "x-go-name": "HTMLURL"
  8263. },
  8264. "message": {
  8265. "type": "string",
  8266. "x-go-name": "Message"
  8267. },
  8268. "parents": {
  8269. "type": "array",
  8270. "items": {
  8271. "$ref": "#/definitions/CommitMeta"
  8272. },
  8273. "x-go-name": "Parents"
  8274. },
  8275. "sha": {
  8276. "type": "string",
  8277. "x-go-name": "SHA"
  8278. },
  8279. "tree": {
  8280. "$ref": "#/definitions/CommitMeta"
  8281. },
  8282. "url": {
  8283. "type": "string",
  8284. "x-go-name": "URL"
  8285. }
  8286. },
  8287. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8288. },
  8289. "FileDeleteResponse": {
  8290. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  8291. "type": "object",
  8292. "properties": {
  8293. "commit": {
  8294. "$ref": "#/definitions/FileCommitResponse"
  8295. },
  8296. "content": {
  8297. "type": "object",
  8298. "x-go-name": "Content"
  8299. },
  8300. "verification": {
  8301. "$ref": "#/definitions/PayloadCommitVerification"
  8302. }
  8303. },
  8304. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8305. },
  8306. "FileLinksResponse": {
  8307. "description": "FileLinksResponse contains the links for a repo's file",
  8308. "type": "object",
  8309. "properties": {
  8310. "git": {
  8311. "type": "string",
  8312. "x-go-name": "GitURL"
  8313. },
  8314. "html": {
  8315. "type": "string",
  8316. "x-go-name": "HTMLURL"
  8317. },
  8318. "self": {
  8319. "type": "string",
  8320. "x-go-name": "Self"
  8321. }
  8322. },
  8323. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8324. },
  8325. "FileResponse": {
  8326. "description": "FileResponse contains information about a repo's file",
  8327. "type": "object",
  8328. "properties": {
  8329. "commit": {
  8330. "$ref": "#/definitions/FileCommitResponse"
  8331. },
  8332. "content": {
  8333. "$ref": "#/definitions/ContentsResponse"
  8334. },
  8335. "verification": {
  8336. "$ref": "#/definitions/PayloadCommitVerification"
  8337. }
  8338. },
  8339. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8340. },
  8341. "GPGKey": {
  8342. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  8343. "type": "object",
  8344. "properties": {
  8345. "can_certify": {
  8346. "type": "boolean",
  8347. "x-go-name": "CanCertify"
  8348. },
  8349. "can_encrypt_comms": {
  8350. "type": "boolean",
  8351. "x-go-name": "CanEncryptComms"
  8352. },
  8353. "can_encrypt_storage": {
  8354. "type": "boolean",
  8355. "x-go-name": "CanEncryptStorage"
  8356. },
  8357. "can_sign": {
  8358. "type": "boolean",
  8359. "x-go-name": "CanSign"
  8360. },
  8361. "created_at": {
  8362. "type": "string",
  8363. "format": "date-time",
  8364. "x-go-name": "Created"
  8365. },
  8366. "emails": {
  8367. "type": "array",
  8368. "items": {
  8369. "$ref": "#/definitions/GPGKeyEmail"
  8370. },
  8371. "x-go-name": "Emails"
  8372. },
  8373. "expires_at": {
  8374. "type": "string",
  8375. "format": "date-time",
  8376. "x-go-name": "Expires"
  8377. },
  8378. "id": {
  8379. "type": "integer",
  8380. "format": "int64",
  8381. "x-go-name": "ID"
  8382. },
  8383. "key_id": {
  8384. "type": "string",
  8385. "x-go-name": "KeyID"
  8386. },
  8387. "primary_key_id": {
  8388. "type": "string",
  8389. "x-go-name": "PrimaryKeyID"
  8390. },
  8391. "public_key": {
  8392. "type": "string",
  8393. "x-go-name": "PublicKey"
  8394. },
  8395. "subkeys": {
  8396. "type": "array",
  8397. "items": {
  8398. "$ref": "#/definitions/GPGKey"
  8399. },
  8400. "x-go-name": "SubsKey"
  8401. }
  8402. },
  8403. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8404. },
  8405. "GPGKeyEmail": {
  8406. "description": "GPGKeyEmail an email attached to a GPGKey",
  8407. "type": "object",
  8408. "properties": {
  8409. "email": {
  8410. "type": "string",
  8411. "x-go-name": "Email"
  8412. },
  8413. "verified": {
  8414. "type": "boolean",
  8415. "x-go-name": "Verified"
  8416. }
  8417. },
  8418. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8419. },
  8420. "GitBlobResponse": {
  8421. "description": "GitBlobResponse represents a git blob",
  8422. "type": "object",
  8423. "properties": {
  8424. "content": {
  8425. "type": "string",
  8426. "x-go-name": "Content"
  8427. },
  8428. "encoding": {
  8429. "type": "string",
  8430. "x-go-name": "Encoding"
  8431. },
  8432. "sha": {
  8433. "type": "string",
  8434. "x-go-name": "SHA"
  8435. },
  8436. "size": {
  8437. "type": "integer",
  8438. "format": "int64",
  8439. "x-go-name": "Size"
  8440. },
  8441. "url": {
  8442. "type": "string",
  8443. "x-go-name": "URL"
  8444. }
  8445. },
  8446. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8447. },
  8448. "GitEntry": {
  8449. "description": "GitEntry represents a git tree",
  8450. "type": "object",
  8451. "properties": {
  8452. "mode": {
  8453. "type": "string",
  8454. "x-go-name": "Mode"
  8455. },
  8456. "path": {
  8457. "type": "string",
  8458. "x-go-name": "Path"
  8459. },
  8460. "sha": {
  8461. "type": "string",
  8462. "x-go-name": "SHA"
  8463. },
  8464. "size": {
  8465. "type": "integer",
  8466. "format": "int64",
  8467. "x-go-name": "Size"
  8468. },
  8469. "type": {
  8470. "type": "string",
  8471. "x-go-name": "Type"
  8472. },
  8473. "url": {
  8474. "type": "string",
  8475. "x-go-name": "URL"
  8476. }
  8477. },
  8478. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8479. },
  8480. "GitHook": {
  8481. "description": "GitHook represents a Git repository hook",
  8482. "type": "object",
  8483. "properties": {
  8484. "content": {
  8485. "type": "string",
  8486. "x-go-name": "Content"
  8487. },
  8488. "is_active": {
  8489. "type": "boolean",
  8490. "x-go-name": "IsActive"
  8491. },
  8492. "name": {
  8493. "type": "string",
  8494. "x-go-name": "Name"
  8495. }
  8496. },
  8497. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8498. },
  8499. "GitObject": {
  8500. "type": "object",
  8501. "title": "GitObject represents a Git object.",
  8502. "properties": {
  8503. "sha": {
  8504. "type": "string",
  8505. "x-go-name": "SHA"
  8506. },
  8507. "type": {
  8508. "type": "string",
  8509. "x-go-name": "Type"
  8510. },
  8511. "url": {
  8512. "type": "string",
  8513. "x-go-name": "URL"
  8514. }
  8515. },
  8516. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8517. },
  8518. "GitTreeResponse": {
  8519. "description": "GitTreeResponse returns a git tree",
  8520. "type": "object",
  8521. "properties": {
  8522. "page": {
  8523. "type": "integer",
  8524. "format": "int64",
  8525. "x-go-name": "Page"
  8526. },
  8527. "sha": {
  8528. "type": "string",
  8529. "x-go-name": "SHA"
  8530. },
  8531. "total_count": {
  8532. "type": "integer",
  8533. "format": "int64",
  8534. "x-go-name": "TotalCount"
  8535. },
  8536. "tree": {
  8537. "type": "array",
  8538. "items": {
  8539. "$ref": "#/definitions/GitEntry"
  8540. },
  8541. "x-go-name": "Entries"
  8542. },
  8543. "truncated": {
  8544. "type": "boolean",
  8545. "x-go-name": "Truncated"
  8546. },
  8547. "url": {
  8548. "type": "string",
  8549. "x-go-name": "URL"
  8550. }
  8551. },
  8552. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8553. },
  8554. "Hook": {
  8555. "description": "Hook a hook is a web hook when one repository changed",
  8556. "type": "object",
  8557. "properties": {
  8558. "active": {
  8559. "type": "boolean",
  8560. "x-go-name": "Active"
  8561. },
  8562. "config": {
  8563. "type": "object",
  8564. "additionalProperties": {
  8565. "type": "string"
  8566. },
  8567. "x-go-name": "Config"
  8568. },
  8569. "created_at": {
  8570. "type": "string",
  8571. "format": "date-time",
  8572. "x-go-name": "Created"
  8573. },
  8574. "events": {
  8575. "type": "array",
  8576. "items": {
  8577. "type": "string"
  8578. },
  8579. "x-go-name": "Events"
  8580. },
  8581. "id": {
  8582. "type": "integer",
  8583. "format": "int64",
  8584. "x-go-name": "ID"
  8585. },
  8586. "type": {
  8587. "type": "string",
  8588. "x-go-name": "Type"
  8589. },
  8590. "updated_at": {
  8591. "type": "string",
  8592. "format": "date-time",
  8593. "x-go-name": "Updated"
  8594. }
  8595. },
  8596. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8597. },
  8598. "Identity": {
  8599. "description": "Identity for a person's identity like an author or committer",
  8600. "type": "object",
  8601. "properties": {
  8602. "email": {
  8603. "type": "string",
  8604. "format": "email",
  8605. "x-go-name": "Email"
  8606. },
  8607. "name": {
  8608. "type": "string",
  8609. "x-go-name": "Name"
  8610. }
  8611. },
  8612. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8613. },
  8614. "Issue": {
  8615. "description": "Issue represents an issue in a repository",
  8616. "type": "object",
  8617. "properties": {
  8618. "assignee": {
  8619. "$ref": "#/definitions/User"
  8620. },
  8621. "assignees": {
  8622. "type": "array",
  8623. "items": {
  8624. "$ref": "#/definitions/User"
  8625. },
  8626. "x-go-name": "Assignees"
  8627. },
  8628. "body": {
  8629. "type": "string",
  8630. "x-go-name": "Body"
  8631. },
  8632. "closed_at": {
  8633. "type": "string",
  8634. "format": "date-time",
  8635. "x-go-name": "Closed"
  8636. },
  8637. "comments": {
  8638. "type": "integer",
  8639. "format": "int64",
  8640. "x-go-name": "Comments"
  8641. },
  8642. "created_at": {
  8643. "type": "string",
  8644. "format": "date-time",
  8645. "x-go-name": "Created"
  8646. },
  8647. "due_date": {
  8648. "type": "string",
  8649. "format": "date-time",
  8650. "x-go-name": "Deadline"
  8651. },
  8652. "id": {
  8653. "type": "integer",
  8654. "format": "int64",
  8655. "x-go-name": "ID"
  8656. },
  8657. "labels": {
  8658. "type": "array",
  8659. "items": {
  8660. "$ref": "#/definitions/Label"
  8661. },
  8662. "x-go-name": "Labels"
  8663. },
  8664. "milestone": {
  8665. "$ref": "#/definitions/Milestone"
  8666. },
  8667. "number": {
  8668. "type": "integer",
  8669. "format": "int64",
  8670. "x-go-name": "Index"
  8671. },
  8672. "pull_request": {
  8673. "$ref": "#/definitions/PullRequestMeta"
  8674. },
  8675. "state": {
  8676. "$ref": "#/definitions/StateType"
  8677. },
  8678. "title": {
  8679. "type": "string",
  8680. "x-go-name": "Title"
  8681. },
  8682. "updated_at": {
  8683. "type": "string",
  8684. "format": "date-time",
  8685. "x-go-name": "Updated"
  8686. },
  8687. "url": {
  8688. "type": "string",
  8689. "x-go-name": "URL"
  8690. },
  8691. "user": {
  8692. "$ref": "#/definitions/User"
  8693. }
  8694. },
  8695. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8696. },
  8697. "IssueDeadline": {
  8698. "description": "IssueDeadline represents an issue deadline",
  8699. "type": "object",
  8700. "properties": {
  8701. "due_date": {
  8702. "type": "string",
  8703. "format": "date-time",
  8704. "x-go-name": "Deadline"
  8705. }
  8706. },
  8707. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8708. },
  8709. "IssueLabelsOption": {
  8710. "description": "IssueLabelsOption a collection of labels",
  8711. "type": "object",
  8712. "properties": {
  8713. "labels": {
  8714. "description": "list of label IDs",
  8715. "type": "array",
  8716. "items": {
  8717. "type": "integer",
  8718. "format": "int64"
  8719. },
  8720. "x-go-name": "Labels"
  8721. }
  8722. },
  8723. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8724. },
  8725. "Label": {
  8726. "description": "Label a label to an issue or a pr",
  8727. "type": "object",
  8728. "properties": {
  8729. "color": {
  8730. "type": "string",
  8731. "x-go-name": "Color",
  8732. "example": "00aabb"
  8733. },
  8734. "description": {
  8735. "type": "string",
  8736. "x-go-name": "Description"
  8737. },
  8738. "id": {
  8739. "type": "integer",
  8740. "format": "int64",
  8741. "x-go-name": "ID"
  8742. },
  8743. "name": {
  8744. "type": "string",
  8745. "x-go-name": "Name"
  8746. },
  8747. "url": {
  8748. "type": "string",
  8749. "x-go-name": "URL"
  8750. }
  8751. },
  8752. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8753. },
  8754. "MarkdownOption": {
  8755. "description": "MarkdownOption markdown options",
  8756. "type": "object",
  8757. "properties": {
  8758. "Context": {
  8759. "description": "Context to render\n\nin: body",
  8760. "type": "string"
  8761. },
  8762. "Mode": {
  8763. "description": "Mode to render\n\nin: body",
  8764. "type": "string"
  8765. },
  8766. "Text": {
  8767. "description": "Text markdown to render\n\nin: body",
  8768. "type": "string"
  8769. },
  8770. "Wiki": {
  8771. "description": "Is it a wiki page ?\n\nin: body",
  8772. "type": "boolean"
  8773. }
  8774. },
  8775. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8776. },
  8777. "MergePullRequestOption": {
  8778. "description": "MergePullRequestForm form for merging Pull Request",
  8779. "type": "object",
  8780. "required": [
  8781. "Do"
  8782. ],
  8783. "properties": {
  8784. "Do": {
  8785. "type": "string",
  8786. "enum": [
  8787. "merge",
  8788. "rebase",
  8789. "rebase-merge",
  8790. "squash"
  8791. ]
  8792. },
  8793. "MergeMessageField": {
  8794. "type": "string"
  8795. },
  8796. "MergeTitleField": {
  8797. "type": "string"
  8798. }
  8799. },
  8800. "x-go-name": "MergePullRequestForm",
  8801. "x-go-package": "code.gitea.io/gitea/modules/auth"
  8802. },
  8803. "MigrateRepoForm": {
  8804. "description": "MigrateRepoForm form for migrating repository",
  8805. "type": "object",
  8806. "required": [
  8807. "clone_addr",
  8808. "uid",
  8809. "repo_name"
  8810. ],
  8811. "properties": {
  8812. "auth_password": {
  8813. "type": "string",
  8814. "x-go-name": "AuthPassword"
  8815. },
  8816. "auth_username": {
  8817. "type": "string",
  8818. "x-go-name": "AuthUsername"
  8819. },
  8820. "clone_addr": {
  8821. "type": "string",
  8822. "x-go-name": "CloneAddr"
  8823. },
  8824. "description": {
  8825. "type": "string",
  8826. "x-go-name": "Description"
  8827. },
  8828. "issues": {
  8829. "type": "boolean",
  8830. "x-go-name": "Issues"
  8831. },
  8832. "labels": {
  8833. "type": "boolean",
  8834. "x-go-name": "Labels"
  8835. },
  8836. "milestones": {
  8837. "type": "boolean",
  8838. "x-go-name": "Milestones"
  8839. },
  8840. "mirror": {
  8841. "type": "boolean",
  8842. "x-go-name": "Mirror"
  8843. },
  8844. "private": {
  8845. "type": "boolean",
  8846. "x-go-name": "Private"
  8847. },
  8848. "pull_requests": {
  8849. "type": "boolean",
  8850. "x-go-name": "PullRequests"
  8851. },
  8852. "releases": {
  8853. "type": "boolean",
  8854. "x-go-name": "Releases"
  8855. },
  8856. "repo_name": {
  8857. "type": "string",
  8858. "x-go-name": "RepoName"
  8859. },
  8860. "uid": {
  8861. "type": "integer",
  8862. "format": "int64",
  8863. "x-go-name": "UID"
  8864. },
  8865. "wiki": {
  8866. "type": "boolean",
  8867. "x-go-name": "Wiki"
  8868. }
  8869. },
  8870. "x-go-package": "code.gitea.io/gitea/modules/auth"
  8871. },
  8872. "Milestone": {
  8873. "description": "Milestone milestone is a collection of issues on one repository",
  8874. "type": "object",
  8875. "properties": {
  8876. "closed_at": {
  8877. "type": "string",
  8878. "format": "date-time",
  8879. "x-go-name": "Closed"
  8880. },
  8881. "closed_issues": {
  8882. "type": "integer",
  8883. "format": "int64",
  8884. "x-go-name": "ClosedIssues"
  8885. },
  8886. "description": {
  8887. "type": "string",
  8888. "x-go-name": "Description"
  8889. },
  8890. "due_on": {
  8891. "type": "string",
  8892. "format": "date-time",
  8893. "x-go-name": "Deadline"
  8894. },
  8895. "id": {
  8896. "type": "integer",
  8897. "format": "int64",
  8898. "x-go-name": "ID"
  8899. },
  8900. "open_issues": {
  8901. "type": "integer",
  8902. "format": "int64",
  8903. "x-go-name": "OpenIssues"
  8904. },
  8905. "state": {
  8906. "$ref": "#/definitions/StateType"
  8907. },
  8908. "title": {
  8909. "type": "string",
  8910. "x-go-name": "Title"
  8911. }
  8912. },
  8913. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8914. },
  8915. "Organization": {
  8916. "description": "Organization represents an organization",
  8917. "type": "object",
  8918. "properties": {
  8919. "avatar_url": {
  8920. "type": "string",
  8921. "x-go-name": "AvatarURL"
  8922. },
  8923. "description": {
  8924. "type": "string",
  8925. "x-go-name": "Description"
  8926. },
  8927. "full_name": {
  8928. "type": "string",
  8929. "x-go-name": "FullName"
  8930. },
  8931. "id": {
  8932. "type": "integer",
  8933. "format": "int64",
  8934. "x-go-name": "ID"
  8935. },
  8936. "location": {
  8937. "type": "string",
  8938. "x-go-name": "Location"
  8939. },
  8940. "username": {
  8941. "type": "string",
  8942. "x-go-name": "UserName"
  8943. },
  8944. "visibility": {
  8945. "type": "string",
  8946. "x-go-name": "Visibility"
  8947. },
  8948. "website": {
  8949. "type": "string",
  8950. "x-go-name": "Website"
  8951. }
  8952. },
  8953. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8954. },
  8955. "PRBranchInfo": {
  8956. "description": "PRBranchInfo information about a branch",
  8957. "type": "object",
  8958. "properties": {
  8959. "label": {
  8960. "type": "string",
  8961. "x-go-name": "Name"
  8962. },
  8963. "ref": {
  8964. "type": "string",
  8965. "x-go-name": "Ref"
  8966. },
  8967. "repo": {
  8968. "$ref": "#/definitions/Repository"
  8969. },
  8970. "repo_id": {
  8971. "type": "integer",
  8972. "format": "int64",
  8973. "x-go-name": "RepoID"
  8974. },
  8975. "sha": {
  8976. "type": "string",
  8977. "x-go-name": "Sha"
  8978. }
  8979. },
  8980. "x-go-package": "code.gitea.io/gitea/modules/structs"
  8981. },
  8982. "PayloadCommit": {
  8983. "description": "PayloadCommit represents a commit",
  8984. "type": "object",
  8985. "properties": {
  8986. "added": {
  8987. "type": "array",
  8988. "items": {
  8989. "type": "string"
  8990. },
  8991. "x-go-name": "Added"
  8992. },
  8993. "author": {
  8994. "$ref": "#/definitions/PayloadUser"
  8995. },
  8996. "committer": {
  8997. "$ref": "#/definitions/PayloadUser"
  8998. },
  8999. "id": {
  9000. "description": "sha1 hash of the commit",
  9001. "type": "string",
  9002. "x-go-name": "ID"
  9003. },
  9004. "message": {
  9005. "type": "string",
  9006. "x-go-name": "Message"
  9007. },
  9008. "modified": {
  9009. "type": "array",
  9010. "items": {
  9011. "type": "string"
  9012. },
  9013. "x-go-name": "Modified"
  9014. },
  9015. "removed": {
  9016. "type": "array",
  9017. "items": {
  9018. "type": "string"
  9019. },
  9020. "x-go-name": "Removed"
  9021. },
  9022. "timestamp": {
  9023. "type": "string",
  9024. "format": "date-time",
  9025. "x-go-name": "Timestamp"
  9026. },
  9027. "url": {
  9028. "type": "string",
  9029. "x-go-name": "URL"
  9030. },
  9031. "verification": {
  9032. "$ref": "#/definitions/PayloadCommitVerification"
  9033. }
  9034. },
  9035. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9036. },
  9037. "PayloadCommitVerification": {
  9038. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  9039. "type": "object",
  9040. "properties": {
  9041. "payload": {
  9042. "type": "string",
  9043. "x-go-name": "Payload"
  9044. },
  9045. "reason": {
  9046. "type": "string",
  9047. "x-go-name": "Reason"
  9048. },
  9049. "signature": {
  9050. "type": "string",
  9051. "x-go-name": "Signature"
  9052. },
  9053. "verified": {
  9054. "type": "boolean",
  9055. "x-go-name": "Verified"
  9056. }
  9057. },
  9058. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9059. },
  9060. "PayloadUser": {
  9061. "description": "PayloadUser represents the author or committer of a commit",
  9062. "type": "object",
  9063. "properties": {
  9064. "email": {
  9065. "type": "string",
  9066. "format": "email",
  9067. "x-go-name": "Email"
  9068. },
  9069. "name": {
  9070. "description": "Full name of the commit author",
  9071. "type": "string",
  9072. "x-go-name": "Name"
  9073. },
  9074. "username": {
  9075. "type": "string",
  9076. "x-go-name": "UserName"
  9077. }
  9078. },
  9079. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9080. },
  9081. "Permission": {
  9082. "description": "Permission represents a set of permissions",
  9083. "type": "object",
  9084. "properties": {
  9085. "admin": {
  9086. "type": "boolean",
  9087. "x-go-name": "Admin"
  9088. },
  9089. "pull": {
  9090. "type": "boolean",
  9091. "x-go-name": "Pull"
  9092. },
  9093. "push": {
  9094. "type": "boolean",
  9095. "x-go-name": "Push"
  9096. }
  9097. },
  9098. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9099. },
  9100. "PublicKey": {
  9101. "description": "PublicKey publickey is a user key to push code to repository",
  9102. "type": "object",
  9103. "properties": {
  9104. "created_at": {
  9105. "type": "string",
  9106. "format": "date-time",
  9107. "x-go-name": "Created"
  9108. },
  9109. "fingerprint": {
  9110. "type": "string",
  9111. "x-go-name": "Fingerprint"
  9112. },
  9113. "id": {
  9114. "type": "integer",
  9115. "format": "int64",
  9116. "x-go-name": "ID"
  9117. },
  9118. "key": {
  9119. "type": "string",
  9120. "x-go-name": "Key"
  9121. },
  9122. "key_type": {
  9123. "type": "string",
  9124. "x-go-name": "KeyType"
  9125. },
  9126. "read_only": {
  9127. "type": "boolean",
  9128. "x-go-name": "ReadOnly"
  9129. },
  9130. "title": {
  9131. "type": "string",
  9132. "x-go-name": "Title"
  9133. },
  9134. "url": {
  9135. "type": "string",
  9136. "x-go-name": "URL"
  9137. },
  9138. "user": {
  9139. "$ref": "#/definitions/User"
  9140. }
  9141. },
  9142. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9143. },
  9144. "PullRequest": {
  9145. "description": "PullRequest represents a pull request",
  9146. "type": "object",
  9147. "properties": {
  9148. "assignee": {
  9149. "$ref": "#/definitions/User"
  9150. },
  9151. "assignees": {
  9152. "type": "array",
  9153. "items": {
  9154. "$ref": "#/definitions/User"
  9155. },
  9156. "x-go-name": "Assignees"
  9157. },
  9158. "base": {
  9159. "$ref": "#/definitions/PRBranchInfo"
  9160. },
  9161. "body": {
  9162. "type": "string",
  9163. "x-go-name": "Body"
  9164. },
  9165. "closed_at": {
  9166. "type": "string",
  9167. "format": "date-time",
  9168. "x-go-name": "Closed"
  9169. },
  9170. "comments": {
  9171. "type": "integer",
  9172. "format": "int64",
  9173. "x-go-name": "Comments"
  9174. },
  9175. "created_at": {
  9176. "type": "string",
  9177. "format": "date-time",
  9178. "x-go-name": "Created"
  9179. },
  9180. "diff_url": {
  9181. "type": "string",
  9182. "x-go-name": "DiffURL"
  9183. },
  9184. "due_date": {
  9185. "type": "string",
  9186. "format": "date-time",
  9187. "x-go-name": "Deadline"
  9188. },
  9189. "head": {
  9190. "$ref": "#/definitions/PRBranchInfo"
  9191. },
  9192. "html_url": {
  9193. "type": "string",
  9194. "x-go-name": "HTMLURL"
  9195. },
  9196. "id": {
  9197. "type": "integer",
  9198. "format": "int64",
  9199. "x-go-name": "ID"
  9200. },
  9201. "labels": {
  9202. "type": "array",
  9203. "items": {
  9204. "$ref": "#/definitions/Label"
  9205. },
  9206. "x-go-name": "Labels"
  9207. },
  9208. "merge_base": {
  9209. "type": "string",
  9210. "x-go-name": "MergeBase"
  9211. },
  9212. "merge_commit_sha": {
  9213. "type": "string",
  9214. "x-go-name": "MergedCommitID"
  9215. },
  9216. "mergeable": {
  9217. "type": "boolean",
  9218. "x-go-name": "Mergeable"
  9219. },
  9220. "merged": {
  9221. "type": "boolean",
  9222. "x-go-name": "HasMerged"
  9223. },
  9224. "merged_at": {
  9225. "type": "string",
  9226. "format": "date-time",
  9227. "x-go-name": "Merged"
  9228. },
  9229. "merged_by": {
  9230. "$ref": "#/definitions/User"
  9231. },
  9232. "milestone": {
  9233. "$ref": "#/definitions/Milestone"
  9234. },
  9235. "number": {
  9236. "type": "integer",
  9237. "format": "int64",
  9238. "x-go-name": "Index"
  9239. },
  9240. "patch_url": {
  9241. "type": "string",
  9242. "x-go-name": "PatchURL"
  9243. },
  9244. "state": {
  9245. "$ref": "#/definitions/StateType"
  9246. },
  9247. "title": {
  9248. "type": "string",
  9249. "x-go-name": "Title"
  9250. },
  9251. "updated_at": {
  9252. "type": "string",
  9253. "format": "date-time",
  9254. "x-go-name": "Updated"
  9255. },
  9256. "url": {
  9257. "type": "string",
  9258. "x-go-name": "URL"
  9259. },
  9260. "user": {
  9261. "$ref": "#/definitions/User"
  9262. }
  9263. },
  9264. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9265. },
  9266. "PullRequestMeta": {
  9267. "description": "PullRequestMeta PR info if an issue is a PR",
  9268. "type": "object",
  9269. "properties": {
  9270. "merged": {
  9271. "type": "boolean",
  9272. "x-go-name": "HasMerged"
  9273. },
  9274. "merged_at": {
  9275. "type": "string",
  9276. "format": "date-time",
  9277. "x-go-name": "Merged"
  9278. }
  9279. },
  9280. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9281. },
  9282. "Reference": {
  9283. "type": "object",
  9284. "title": "Reference represents a Git reference.",
  9285. "properties": {
  9286. "object": {
  9287. "$ref": "#/definitions/GitObject"
  9288. },
  9289. "ref": {
  9290. "type": "string",
  9291. "x-go-name": "Ref"
  9292. },
  9293. "url": {
  9294. "type": "string",
  9295. "x-go-name": "URL"
  9296. }
  9297. },
  9298. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9299. },
  9300. "Release": {
  9301. "description": "Release represents a repository release",
  9302. "type": "object",
  9303. "properties": {
  9304. "assets": {
  9305. "type": "array",
  9306. "items": {
  9307. "$ref": "#/definitions/Attachment"
  9308. },
  9309. "x-go-name": "Attachments"
  9310. },
  9311. "author": {
  9312. "$ref": "#/definitions/User"
  9313. },
  9314. "body": {
  9315. "type": "string",
  9316. "x-go-name": "Note"
  9317. },
  9318. "created_at": {
  9319. "type": "string",
  9320. "format": "date-time",
  9321. "x-go-name": "CreatedAt"
  9322. },
  9323. "draft": {
  9324. "type": "boolean",
  9325. "x-go-name": "IsDraft"
  9326. },
  9327. "id": {
  9328. "type": "integer",
  9329. "format": "int64",
  9330. "x-go-name": "ID"
  9331. },
  9332. "name": {
  9333. "type": "string",
  9334. "x-go-name": "Title"
  9335. },
  9336. "prerelease": {
  9337. "type": "boolean",
  9338. "x-go-name": "IsPrerelease"
  9339. },
  9340. "published_at": {
  9341. "type": "string",
  9342. "format": "date-time",
  9343. "x-go-name": "PublishedAt"
  9344. },
  9345. "tag_name": {
  9346. "type": "string",
  9347. "x-go-name": "TagName"
  9348. },
  9349. "tarball_url": {
  9350. "type": "string",
  9351. "x-go-name": "TarURL"
  9352. },
  9353. "target_commitish": {
  9354. "type": "string",
  9355. "x-go-name": "Target"
  9356. },
  9357. "url": {
  9358. "type": "string",
  9359. "x-go-name": "URL"
  9360. },
  9361. "zipball_url": {
  9362. "type": "string",
  9363. "x-go-name": "ZipURL"
  9364. }
  9365. },
  9366. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9367. },
  9368. "RepoCommit": {
  9369. "type": "object",
  9370. "title": "RepoCommit contains information of a commit in the context of a repository.",
  9371. "properties": {
  9372. "author": {
  9373. "$ref": "#/definitions/CommitUser"
  9374. },
  9375. "committer": {
  9376. "$ref": "#/definitions/CommitUser"
  9377. },
  9378. "message": {
  9379. "type": "string",
  9380. "x-go-name": "Message"
  9381. },
  9382. "tree": {
  9383. "$ref": "#/definitions/CommitMeta"
  9384. },
  9385. "url": {
  9386. "type": "string",
  9387. "x-go-name": "URL"
  9388. }
  9389. },
  9390. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9391. },
  9392. "Repository": {
  9393. "description": "Repository represents a repository",
  9394. "type": "object",
  9395. "properties": {
  9396. "allow_merge_commits": {
  9397. "type": "boolean",
  9398. "x-go-name": "AllowMerge"
  9399. },
  9400. "allow_rebase": {
  9401. "type": "boolean",
  9402. "x-go-name": "AllowRebase"
  9403. },
  9404. "allow_rebase_explicit": {
  9405. "type": "boolean",
  9406. "x-go-name": "AllowRebaseMerge"
  9407. },
  9408. "allow_squash_merge": {
  9409. "type": "boolean",
  9410. "x-go-name": "AllowSquash"
  9411. },
  9412. "archived": {
  9413. "type": "boolean",
  9414. "x-go-name": "Archived"
  9415. },
  9416. "avatar_url": {
  9417. "type": "string",
  9418. "x-go-name": "AvatarURL"
  9419. },
  9420. "clone_url": {
  9421. "type": "string",
  9422. "x-go-name": "CloneURL"
  9423. },
  9424. "created_at": {
  9425. "type": "string",
  9426. "format": "date-time",
  9427. "x-go-name": "Created"
  9428. },
  9429. "default_branch": {
  9430. "type": "string",
  9431. "x-go-name": "DefaultBranch"
  9432. },
  9433. "description": {
  9434. "type": "string",
  9435. "x-go-name": "Description"
  9436. },
  9437. "empty": {
  9438. "type": "boolean",
  9439. "x-go-name": "Empty"
  9440. },
  9441. "fork": {
  9442. "type": "boolean",
  9443. "x-go-name": "Fork"
  9444. },
  9445. "forks_count": {
  9446. "type": "integer",
  9447. "format": "int64",
  9448. "x-go-name": "Forks"
  9449. },
  9450. "full_name": {
  9451. "type": "string",
  9452. "x-go-name": "FullName"
  9453. },
  9454. "has_issues": {
  9455. "type": "boolean",
  9456. "x-go-name": "HasIssues"
  9457. },
  9458. "has_pull_requests": {
  9459. "type": "boolean",
  9460. "x-go-name": "HasPullRequests"
  9461. },
  9462. "has_wiki": {
  9463. "type": "boolean",
  9464. "x-go-name": "HasWiki"
  9465. },
  9466. "html_url": {
  9467. "type": "string",
  9468. "x-go-name": "HTMLURL"
  9469. },
  9470. "id": {
  9471. "type": "integer",
  9472. "format": "int64",
  9473. "x-go-name": "ID"
  9474. },
  9475. "ignore_whitespace_conflicts": {
  9476. "type": "boolean",
  9477. "x-go-name": "IgnoreWhitespaceConflicts"
  9478. },
  9479. "mirror": {
  9480. "type": "boolean",
  9481. "x-go-name": "Mirror"
  9482. },
  9483. "name": {
  9484. "type": "string",
  9485. "x-go-name": "Name"
  9486. },
  9487. "open_issues_count": {
  9488. "type": "integer",
  9489. "format": "int64",
  9490. "x-go-name": "OpenIssues"
  9491. },
  9492. "owner": {
  9493. "$ref": "#/definitions/User"
  9494. },
  9495. "parent": {
  9496. "$ref": "#/definitions/Repository"
  9497. },
  9498. "permissions": {
  9499. "$ref": "#/definitions/Permission"
  9500. },
  9501. "private": {
  9502. "type": "boolean",
  9503. "x-go-name": "Private"
  9504. },
  9505. "size": {
  9506. "type": "integer",
  9507. "format": "int64",
  9508. "x-go-name": "Size"
  9509. },
  9510. "ssh_url": {
  9511. "type": "string",
  9512. "x-go-name": "SSHURL"
  9513. },
  9514. "stars_count": {
  9515. "type": "integer",
  9516. "format": "int64",
  9517. "x-go-name": "Stars"
  9518. },
  9519. "updated_at": {
  9520. "type": "string",
  9521. "format": "date-time",
  9522. "x-go-name": "Updated"
  9523. },
  9524. "watchers_count": {
  9525. "type": "integer",
  9526. "format": "int64",
  9527. "x-go-name": "Watchers"
  9528. },
  9529. "website": {
  9530. "type": "string",
  9531. "x-go-name": "Website"
  9532. }
  9533. },
  9534. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9535. },
  9536. "SearchResults": {
  9537. "description": "SearchResults results of a successful search",
  9538. "type": "object",
  9539. "properties": {
  9540. "data": {
  9541. "type": "array",
  9542. "items": {
  9543. "$ref": "#/definitions/Repository"
  9544. },
  9545. "x-go-name": "Data"
  9546. },
  9547. "ok": {
  9548. "type": "boolean",
  9549. "x-go-name": "OK"
  9550. }
  9551. },
  9552. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9553. },
  9554. "ServerVersion": {
  9555. "description": "ServerVersion wraps the version of the server",
  9556. "type": "object",
  9557. "properties": {
  9558. "version": {
  9559. "type": "string",
  9560. "x-go-name": "Version"
  9561. }
  9562. },
  9563. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9564. },
  9565. "StateType": {
  9566. "description": "StateType issue state type",
  9567. "type": "string",
  9568. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9569. },
  9570. "Status": {
  9571. "description": "Status holds a single Status of a single Commit",
  9572. "type": "object",
  9573. "properties": {
  9574. "context": {
  9575. "type": "string",
  9576. "x-go-name": "Context"
  9577. },
  9578. "created_at": {
  9579. "type": "string",
  9580. "format": "date-time",
  9581. "x-go-name": "Created"
  9582. },
  9583. "creator": {
  9584. "$ref": "#/definitions/User"
  9585. },
  9586. "description": {
  9587. "type": "string",
  9588. "x-go-name": "Description"
  9589. },
  9590. "id": {
  9591. "type": "integer",
  9592. "format": "int64",
  9593. "x-go-name": "ID"
  9594. },
  9595. "status": {
  9596. "$ref": "#/definitions/StatusState"
  9597. },
  9598. "target_url": {
  9599. "type": "string",
  9600. "x-go-name": "TargetURL"
  9601. },
  9602. "updated_at": {
  9603. "type": "string",
  9604. "format": "date-time",
  9605. "x-go-name": "Updated"
  9606. },
  9607. "url": {
  9608. "type": "string",
  9609. "x-go-name": "URL"
  9610. }
  9611. },
  9612. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9613. },
  9614. "StatusState": {
  9615. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  9616. "type": "string",
  9617. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9618. },
  9619. "Tag": {
  9620. "description": "Tag represents a repository tag",
  9621. "type": "object",
  9622. "properties": {
  9623. "commit": {
  9624. "$ref": "#/definitions/CommitMeta"
  9625. },
  9626. "id": {
  9627. "type": "string",
  9628. "x-go-name": "ID"
  9629. },
  9630. "name": {
  9631. "type": "string",
  9632. "x-go-name": "Name"
  9633. },
  9634. "tarball_url": {
  9635. "type": "string",
  9636. "x-go-name": "TarballURL"
  9637. },
  9638. "zipball_url": {
  9639. "type": "string",
  9640. "x-go-name": "ZipballURL"
  9641. }
  9642. },
  9643. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9644. },
  9645. "Team": {
  9646. "description": "Team represents a team in an organization",
  9647. "type": "object",
  9648. "properties": {
  9649. "description": {
  9650. "type": "string",
  9651. "x-go-name": "Description"
  9652. },
  9653. "id": {
  9654. "type": "integer",
  9655. "format": "int64",
  9656. "x-go-name": "ID"
  9657. },
  9658. "name": {
  9659. "type": "string",
  9660. "x-go-name": "Name"
  9661. },
  9662. "organization": {
  9663. "$ref": "#/definitions/Organization"
  9664. },
  9665. "permission": {
  9666. "type": "string",
  9667. "enum": [
  9668. "none",
  9669. "read",
  9670. "write",
  9671. "admin",
  9672. "owner"
  9673. ],
  9674. "x-go-name": "Permission"
  9675. },
  9676. "units": {
  9677. "type": "array",
  9678. "enum": [
  9679. "repo.code",
  9680. "repo.issues",
  9681. "repo.ext_issues",
  9682. "repo.wiki",
  9683. "repo.pulls",
  9684. "repo.releases",
  9685. "repo.ext_wiki"
  9686. ],
  9687. "items": {
  9688. "type": "string"
  9689. },
  9690. "x-go-name": "Units"
  9691. }
  9692. },
  9693. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9694. },
  9695. "TimeStamp": {
  9696. "description": "TimeStamp defines a timestamp",
  9697. "type": "integer",
  9698. "format": "int64",
  9699. "x-go-package": "code.gitea.io/gitea/modules/util"
  9700. },
  9701. "TrackedTime": {
  9702. "description": "TrackedTime worked time for an issue / pr",
  9703. "type": "object",
  9704. "properties": {
  9705. "created": {
  9706. "type": "string",
  9707. "format": "date-time",
  9708. "x-go-name": "Created"
  9709. },
  9710. "id": {
  9711. "type": "integer",
  9712. "format": "int64",
  9713. "x-go-name": "ID"
  9714. },
  9715. "issue_id": {
  9716. "type": "integer",
  9717. "format": "int64",
  9718. "x-go-name": "IssueID"
  9719. },
  9720. "time": {
  9721. "description": "Time in seconds",
  9722. "type": "integer",
  9723. "format": "int64",
  9724. "x-go-name": "Time"
  9725. },
  9726. "user_id": {
  9727. "type": "integer",
  9728. "format": "int64",
  9729. "x-go-name": "UserID"
  9730. }
  9731. },
  9732. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9733. },
  9734. "UpdateFileOptions": {
  9735. "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)",
  9736. "type": "object",
  9737. "required": [
  9738. "sha",
  9739. "content"
  9740. ],
  9741. "properties": {
  9742. "author": {
  9743. "$ref": "#/definitions/Identity"
  9744. },
  9745. "branch": {
  9746. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  9747. "type": "string",
  9748. "x-go-name": "BranchName"
  9749. },
  9750. "committer": {
  9751. "$ref": "#/definitions/Identity"
  9752. },
  9753. "content": {
  9754. "description": "content must be base64 encoded",
  9755. "type": "string",
  9756. "x-go-name": "Content"
  9757. },
  9758. "from_path": {
  9759. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  9760. "type": "string",
  9761. "x-go-name": "FromPath"
  9762. },
  9763. "message": {
  9764. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  9765. "type": "string",
  9766. "x-go-name": "Message"
  9767. },
  9768. "new_branch": {
  9769. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  9770. "type": "string",
  9771. "x-go-name": "NewBranchName"
  9772. },
  9773. "sha": {
  9774. "description": "sha is the SHA for the file that already exists",
  9775. "type": "string",
  9776. "x-go-name": "SHA"
  9777. }
  9778. },
  9779. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9780. },
  9781. "User": {
  9782. "description": "User represents a user",
  9783. "type": "object",
  9784. "properties": {
  9785. "avatar_url": {
  9786. "description": "URL to the user's avatar",
  9787. "type": "string",
  9788. "x-go-name": "AvatarURL"
  9789. },
  9790. "created": {
  9791. "type": "string",
  9792. "format": "date-time",
  9793. "x-go-name": "Created"
  9794. },
  9795. "email": {
  9796. "type": "string",
  9797. "format": "email",
  9798. "x-go-name": "Email"
  9799. },
  9800. "full_name": {
  9801. "description": "the user's full name",
  9802. "type": "string",
  9803. "x-go-name": "FullName"
  9804. },
  9805. "id": {
  9806. "description": "the user's id",
  9807. "type": "integer",
  9808. "format": "int64",
  9809. "x-go-name": "ID"
  9810. },
  9811. "is_admin": {
  9812. "description": "Is the user an administrator",
  9813. "type": "boolean",
  9814. "x-go-name": "IsAdmin"
  9815. },
  9816. "language": {
  9817. "description": "User locale",
  9818. "type": "string",
  9819. "x-go-name": "Language"
  9820. },
  9821. "last_login": {
  9822. "type": "string",
  9823. "format": "date-time",
  9824. "x-go-name": "LastLogin"
  9825. },
  9826. "login": {
  9827. "description": "the user's username",
  9828. "type": "string",
  9829. "x-go-name": "UserName"
  9830. }
  9831. },
  9832. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9833. },
  9834. "UserHeatmapData": {
  9835. "description": "UserHeatmapData represents the data needed to create a heatmap",
  9836. "type": "object",
  9837. "properties": {
  9838. "contributions": {
  9839. "type": "integer",
  9840. "format": "int64",
  9841. "x-go-name": "Contributions"
  9842. },
  9843. "timestamp": {
  9844. "$ref": "#/definitions/TimeStamp"
  9845. }
  9846. },
  9847. "x-go-package": "code.gitea.io/gitea/models"
  9848. },
  9849. "WatchInfo": {
  9850. "description": "WatchInfo represents an API watch status of one repository",
  9851. "type": "object",
  9852. "properties": {
  9853. "created_at": {
  9854. "type": "string",
  9855. "format": "date-time",
  9856. "x-go-name": "CreatedAt"
  9857. },
  9858. "ignored": {
  9859. "type": "boolean",
  9860. "x-go-name": "Ignored"
  9861. },
  9862. "reason": {
  9863. "type": "object",
  9864. "x-go-name": "Reason"
  9865. },
  9866. "repository_url": {
  9867. "type": "string",
  9868. "x-go-name": "RepositoryURL"
  9869. },
  9870. "subscribed": {
  9871. "type": "boolean",
  9872. "x-go-name": "Subscribed"
  9873. },
  9874. "url": {
  9875. "type": "string",
  9876. "x-go-name": "URL"
  9877. }
  9878. },
  9879. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9880. }
  9881. },
  9882. "responses": {
  9883. "AccessToken": {
  9884. "description": "AccessToken represents an API access token.",
  9885. "headers": {
  9886. "id": {
  9887. "type": "integer",
  9888. "format": "int64"
  9889. },
  9890. "name": {
  9891. "type": "string"
  9892. },
  9893. "sha1": {
  9894. "type": "string"
  9895. },
  9896. "token_last_eight": {
  9897. "type": "string"
  9898. }
  9899. }
  9900. },
  9901. "AccessTokenList": {
  9902. "description": "AccessTokenList represents a list of API access token."
  9903. },
  9904. "AnnotatedTag": {
  9905. "description": "AnnotatedTag",
  9906. "schema": {
  9907. "$ref": "#/definitions/AnnotatedTag"
  9908. }
  9909. },
  9910. "Attachment": {
  9911. "description": "Attachment",
  9912. "schema": {
  9913. "$ref": "#/definitions/Attachment"
  9914. }
  9915. },
  9916. "AttachmentList": {
  9917. "description": "AttachmentList",
  9918. "schema": {
  9919. "type": "array",
  9920. "items": {
  9921. "$ref": "#/definitions/Attachment"
  9922. }
  9923. }
  9924. },
  9925. "Branch": {
  9926. "description": "Branch",
  9927. "schema": {
  9928. "$ref": "#/definitions/Branch"
  9929. }
  9930. },
  9931. "BranchList": {
  9932. "description": "BranchList",
  9933. "schema": {
  9934. "type": "array",
  9935. "items": {
  9936. "$ref": "#/definitions/Branch"
  9937. }
  9938. }
  9939. },
  9940. "Comment": {
  9941. "description": "Comment",
  9942. "schema": {
  9943. "$ref": "#/definitions/Comment"
  9944. }
  9945. },
  9946. "CommentList": {
  9947. "description": "CommentList",
  9948. "schema": {
  9949. "type": "array",
  9950. "items": {
  9951. "$ref": "#/definitions/Comment"
  9952. }
  9953. }
  9954. },
  9955. "Commit": {
  9956. "description": "Commit",
  9957. "schema": {
  9958. "$ref": "#/definitions/Commit"
  9959. }
  9960. },
  9961. "ContentsListResponse": {
  9962. "description": "ContentsListResponse",
  9963. "schema": {
  9964. "type": "array",
  9965. "items": {
  9966. "$ref": "#/definitions/ContentsResponse"
  9967. }
  9968. }
  9969. },
  9970. "ContentsResponse": {
  9971. "description": "ContentsResponse",
  9972. "schema": {
  9973. "$ref": "#/definitions/ContentsResponse"
  9974. }
  9975. },
  9976. "DeployKey": {
  9977. "description": "DeployKey",
  9978. "schema": {
  9979. "$ref": "#/definitions/DeployKey"
  9980. }
  9981. },
  9982. "DeployKeyList": {
  9983. "description": "DeployKeyList",
  9984. "schema": {
  9985. "type": "array",
  9986. "items": {
  9987. "$ref": "#/definitions/DeployKey"
  9988. }
  9989. }
  9990. },
  9991. "EmailList": {
  9992. "description": "EmailList",
  9993. "schema": {
  9994. "type": "array",
  9995. "items": {
  9996. "$ref": "#/definitions/Email"
  9997. }
  9998. }
  9999. },
  10000. "FileDeleteResponse": {
  10001. "description": "FileDeleteResponse",
  10002. "schema": {
  10003. "$ref": "#/definitions/FileDeleteResponse"
  10004. }
  10005. },
  10006. "FileResponse": {
  10007. "description": "FileResponse",
  10008. "schema": {
  10009. "$ref": "#/definitions/FileResponse"
  10010. }
  10011. },
  10012. "GPGKey": {
  10013. "description": "GPGKey",
  10014. "schema": {
  10015. "$ref": "#/definitions/GPGKey"
  10016. }
  10017. },
  10018. "GPGKeyList": {
  10019. "description": "GPGKeyList",
  10020. "schema": {
  10021. "type": "array",
  10022. "items": {
  10023. "$ref": "#/definitions/GPGKey"
  10024. }
  10025. }
  10026. },
  10027. "GitBlobResponse": {
  10028. "description": "GitBlobResponse",
  10029. "schema": {
  10030. "$ref": "#/definitions/GitBlobResponse"
  10031. }
  10032. },
  10033. "GitHook": {
  10034. "description": "GitHook",
  10035. "schema": {
  10036. "$ref": "#/definitions/GitHook"
  10037. }
  10038. },
  10039. "GitHookList": {
  10040. "description": "GitHookList",
  10041. "schema": {
  10042. "type": "array",
  10043. "items": {
  10044. "$ref": "#/definitions/GitHook"
  10045. }
  10046. }
  10047. },
  10048. "GitTreeResponse": {
  10049. "description": "GitTreeResponse",
  10050. "schema": {
  10051. "$ref": "#/definitions/GitTreeResponse"
  10052. }
  10053. },
  10054. "Hook": {
  10055. "description": "Hook",
  10056. "schema": {
  10057. "$ref": "#/definitions/Hook"
  10058. }
  10059. },
  10060. "HookList": {
  10061. "description": "HookList",
  10062. "schema": {
  10063. "type": "array",
  10064. "items": {
  10065. "$ref": "#/definitions/Hook"
  10066. }
  10067. }
  10068. },
  10069. "Issue": {
  10070. "description": "Issue",
  10071. "schema": {
  10072. "$ref": "#/definitions/Issue"
  10073. }
  10074. },
  10075. "IssueDeadline": {
  10076. "description": "IssueDeadline",
  10077. "schema": {
  10078. "$ref": "#/definitions/IssueDeadline"
  10079. }
  10080. },
  10081. "IssueList": {
  10082. "description": "IssueList",
  10083. "schema": {
  10084. "type": "array",
  10085. "items": {
  10086. "$ref": "#/definitions/Issue"
  10087. }
  10088. }
  10089. },
  10090. "Label": {
  10091. "description": "Label",
  10092. "schema": {
  10093. "$ref": "#/definitions/Label"
  10094. }
  10095. },
  10096. "LabelList": {
  10097. "description": "LabelList",
  10098. "schema": {
  10099. "type": "array",
  10100. "items": {
  10101. "$ref": "#/definitions/Label"
  10102. }
  10103. }
  10104. },
  10105. "MarkdownRender": {
  10106. "description": "MarkdownRender is a rendered markdown document"
  10107. },
  10108. "Milestone": {
  10109. "description": "Milestone",
  10110. "schema": {
  10111. "$ref": "#/definitions/Milestone"
  10112. }
  10113. },
  10114. "MilestoneList": {
  10115. "description": "MilestoneList",
  10116. "schema": {
  10117. "type": "array",
  10118. "items": {
  10119. "$ref": "#/definitions/Milestone"
  10120. }
  10121. }
  10122. },
  10123. "Organization": {
  10124. "description": "Organization",
  10125. "schema": {
  10126. "$ref": "#/definitions/Organization"
  10127. }
  10128. },
  10129. "OrganizationList": {
  10130. "description": "OrganizationList",
  10131. "schema": {
  10132. "type": "array",
  10133. "items": {
  10134. "$ref": "#/definitions/Organization"
  10135. }
  10136. }
  10137. },
  10138. "PublicKey": {
  10139. "description": "PublicKey",
  10140. "schema": {
  10141. "$ref": "#/definitions/PublicKey"
  10142. }
  10143. },
  10144. "PublicKeyList": {
  10145. "description": "PublicKeyList",
  10146. "schema": {
  10147. "type": "array",
  10148. "items": {
  10149. "$ref": "#/definitions/PublicKey"
  10150. }
  10151. }
  10152. },
  10153. "PullRequest": {
  10154. "description": "PullRequest",
  10155. "schema": {
  10156. "$ref": "#/definitions/PullRequest"
  10157. }
  10158. },
  10159. "PullRequestList": {
  10160. "description": "PullRequestList",
  10161. "schema": {
  10162. "type": "array",
  10163. "items": {
  10164. "$ref": "#/definitions/PullRequest"
  10165. }
  10166. }
  10167. },
  10168. "Reference": {
  10169. "description": "Reference",
  10170. "schema": {
  10171. "$ref": "#/definitions/Reference"
  10172. }
  10173. },
  10174. "ReferenceList": {
  10175. "description": "ReferenceList",
  10176. "schema": {
  10177. "type": "array",
  10178. "items": {
  10179. "$ref": "#/definitions/Reference"
  10180. }
  10181. }
  10182. },
  10183. "Release": {
  10184. "description": "Release",
  10185. "schema": {
  10186. "$ref": "#/definitions/Release"
  10187. }
  10188. },
  10189. "ReleaseList": {
  10190. "description": "ReleaseList",
  10191. "schema": {
  10192. "type": "array",
  10193. "items": {
  10194. "$ref": "#/definitions/Release"
  10195. }
  10196. }
  10197. },
  10198. "Repository": {
  10199. "description": "Repository",
  10200. "schema": {
  10201. "$ref": "#/definitions/Repository"
  10202. }
  10203. },
  10204. "RepositoryList": {
  10205. "description": "RepositoryList",
  10206. "schema": {
  10207. "type": "array",
  10208. "items": {
  10209. "$ref": "#/definitions/Repository"
  10210. }
  10211. }
  10212. },
  10213. "SearchResults": {
  10214. "description": "SearchResults",
  10215. "schema": {
  10216. "$ref": "#/definitions/SearchResults"
  10217. }
  10218. },
  10219. "ServerVersion": {
  10220. "description": "ServerVersion",
  10221. "schema": {
  10222. "$ref": "#/definitions/ServerVersion"
  10223. }
  10224. },
  10225. "Status": {
  10226. "description": "Status",
  10227. "schema": {
  10228. "$ref": "#/definitions/Status"
  10229. }
  10230. },
  10231. "StatusList": {
  10232. "description": "StatusList",
  10233. "schema": {
  10234. "type": "array",
  10235. "items": {
  10236. "$ref": "#/definitions/Status"
  10237. }
  10238. }
  10239. },
  10240. "Tag": {
  10241. "description": "Tag",
  10242. "schema": {
  10243. "$ref": "#/definitions/Tag"
  10244. }
  10245. },
  10246. "TagList": {
  10247. "description": "TagList",
  10248. "schema": {
  10249. "type": "array",
  10250. "items": {
  10251. "$ref": "#/definitions/Tag"
  10252. }
  10253. }
  10254. },
  10255. "Team": {
  10256. "description": "Team",
  10257. "schema": {
  10258. "$ref": "#/definitions/Team"
  10259. }
  10260. },
  10261. "TeamList": {
  10262. "description": "TeamList",
  10263. "schema": {
  10264. "type": "array",
  10265. "items": {
  10266. "$ref": "#/definitions/Team"
  10267. }
  10268. }
  10269. },
  10270. "TrackedTime": {
  10271. "description": "TrackedTime",
  10272. "schema": {
  10273. "$ref": "#/definitions/TrackedTime"
  10274. }
  10275. },
  10276. "TrackedTimeList": {
  10277. "description": "TrackedTimeList",
  10278. "schema": {
  10279. "type": "array",
  10280. "items": {
  10281. "$ref": "#/definitions/TrackedTime"
  10282. }
  10283. }
  10284. },
  10285. "User": {
  10286. "description": "User",
  10287. "schema": {
  10288. "$ref": "#/definitions/User"
  10289. }
  10290. },
  10291. "UserHeatmapData": {
  10292. "description": "UserHeatmapData",
  10293. "schema": {
  10294. "type": "array",
  10295. "items": {
  10296. "$ref": "#/definitions/UserHeatmapData"
  10297. }
  10298. }
  10299. },
  10300. "UserList": {
  10301. "description": "UserList",
  10302. "schema": {
  10303. "type": "array",
  10304. "items": {
  10305. "$ref": "#/definitions/User"
  10306. }
  10307. }
  10308. },
  10309. "WatchInfo": {
  10310. "description": "WatchInfo",
  10311. "schema": {
  10312. "$ref": "#/definitions/WatchInfo"
  10313. }
  10314. },
  10315. "empty": {
  10316. "description": "APIEmpty is an empty response"
  10317. },
  10318. "error": {
  10319. "description": "APIError is error format response",
  10320. "headers": {
  10321. "message": {
  10322. "type": "string"
  10323. },
  10324. "url": {
  10325. "type": "string"
  10326. }
  10327. }
  10328. },
  10329. "forbidden": {
  10330. "description": "APIForbiddenError is a forbidden error response",
  10331. "headers": {
  10332. "message": {
  10333. "type": "string"
  10334. },
  10335. "url": {
  10336. "type": "string"
  10337. }
  10338. }
  10339. },
  10340. "notFound": {
  10341. "description": "APINotFound is a not found empty response"
  10342. },
  10343. "parameterBodies": {
  10344. "description": "parameterBodies",
  10345. "schema": {
  10346. "$ref": "#/definitions/DeleteFileOptions"
  10347. }
  10348. },
  10349. "redirect": {
  10350. "description": "APIRedirect is a redirect response"
  10351. },
  10352. "validationError": {
  10353. "description": "APIValidationError is error format response related to input validation",
  10354. "headers": {
  10355. "message": {
  10356. "type": "string"
  10357. },
  10358. "url": {
  10359. "type": "string"
  10360. }
  10361. }
  10362. }
  10363. },
  10364. "securityDefinitions": {
  10365. "AccessToken": {
  10366. "type": "apiKey",
  10367. "name": "access_token",
  10368. "in": "query"
  10369. },
  10370. "AuthorizationHeaderToken": {
  10371. "type": "apiKey",
  10372. "name": "Authorization",
  10373. "in": "header"
  10374. },
  10375. "BasicAuth": {
  10376. "type": "basic"
  10377. },
  10378. "SudoHeader": {
  10379. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  10380. "type": "apiKey",
  10381. "name": "Sudo",
  10382. "in": "header"
  10383. },
  10384. "SudoParam": {
  10385. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  10386. "type": "apiKey",
  10387. "name": "sudo",
  10388. "in": "query"
  10389. },
  10390. "Token": {
  10391. "type": "apiKey",
  10392. "name": "token",
  10393. "in": "query"
  10394. }
  10395. },
  10396. "security": [
  10397. {
  10398. "BasicAuth": []
  10399. },
  10400. {
  10401. "Token": []
  10402. },
  10403. {
  10404. "AccessToken": []
  10405. },
  10406. {
  10407. "AuthorizationHeaderToken": []
  10408. },
  10409. {
  10410. "SudoParam": []
  10411. },
  10412. {
  10413. "SudoHeader": []
  10414. }
  10415. ]
  10416. }