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

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