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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API.",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "1.1.1"
  23. },
  24. "basePath": "{{AppSubUrl}}/api/v1",
  25. "paths": {
  26. "/admin/orgs": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List all organizations",
  35. "operationId": "adminGetAllOrgs",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results, maximum page size is 50",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/OrganizationList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/users": {
  61. "get": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "List all users",
  69. "operationId": "adminGetAllUsers",
  70. "parameters": [
  71. {
  72. "type": "integer",
  73. "description": "page number of results to return (1-based)",
  74. "name": "page",
  75. "in": "query"
  76. },
  77. {
  78. "type": "integer",
  79. "description": "page size of results, maximum page size is 50",
  80. "name": "limit",
  81. "in": "query"
  82. }
  83. ],
  84. "responses": {
  85. "200": {
  86. "$ref": "#/responses/UserList"
  87. },
  88. "403": {
  89. "$ref": "#/responses/forbidden"
  90. }
  91. }
  92. },
  93. "post": {
  94. "consumes": [
  95. "application/json"
  96. ],
  97. "produces": [
  98. "application/json"
  99. ],
  100. "tags": [
  101. "admin"
  102. ],
  103. "summary": "Create a user",
  104. "operationId": "adminCreateUser",
  105. "parameters": [
  106. {
  107. "name": "body",
  108. "in": "body",
  109. "schema": {
  110. "$ref": "#/definitions/CreateUserOption"
  111. }
  112. }
  113. ],
  114. "responses": {
  115. "201": {
  116. "$ref": "#/responses/User"
  117. },
  118. "400": {
  119. "$ref": "#/responses/error"
  120. },
  121. "403": {
  122. "$ref": "#/responses/forbidden"
  123. },
  124. "422": {
  125. "$ref": "#/responses/validationError"
  126. }
  127. }
  128. }
  129. },
  130. "/admin/users/{username}": {
  131. "delete": {
  132. "produces": [
  133. "application/json"
  134. ],
  135. "tags": [
  136. "admin"
  137. ],
  138. "summary": "Delete a user",
  139. "operationId": "adminDeleteUser",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "username of user to delete",
  144. "name": "username",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "204": {
  151. "$ref": "#/responses/empty"
  152. },
  153. "403": {
  154. "$ref": "#/responses/forbidden"
  155. },
  156. "422": {
  157. "$ref": "#/responses/validationError"
  158. }
  159. }
  160. },
  161. "patch": {
  162. "consumes": [
  163. "application/json"
  164. ],
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Edit an existing user",
  172. "operationId": "adminEditUser",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "username of user to edit",
  177. "name": "username",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "name": "body",
  183. "in": "body",
  184. "schema": {
  185. "$ref": "#/definitions/EditUserOption"
  186. }
  187. }
  188. ],
  189. "responses": {
  190. "200": {
  191. "$ref": "#/responses/User"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "422": {
  197. "$ref": "#/responses/validationError"
  198. }
  199. }
  200. }
  201. },
  202. "/admin/users/{username}/keys": {
  203. "post": {
  204. "consumes": [
  205. "application/json"
  206. ],
  207. "produces": [
  208. "application/json"
  209. ],
  210. "tags": [
  211. "admin"
  212. ],
  213. "summary": "Add a public key on behalf of a user",
  214. "operationId": "adminCreatePublicKey",
  215. "parameters": [
  216. {
  217. "type": "string",
  218. "description": "username of the user",
  219. "name": "username",
  220. "in": "path",
  221. "required": true
  222. },
  223. {
  224. "name": "key",
  225. "in": "body",
  226. "schema": {
  227. "$ref": "#/definitions/CreateKeyOption"
  228. }
  229. }
  230. ],
  231. "responses": {
  232. "201": {
  233. "$ref": "#/responses/PublicKey"
  234. },
  235. "403": {
  236. "$ref": "#/responses/forbidden"
  237. },
  238. "422": {
  239. "$ref": "#/responses/validationError"
  240. }
  241. }
  242. }
  243. },
  244. "/admin/users/{username}/keys/{id}": {
  245. "delete": {
  246. "produces": [
  247. "application/json"
  248. ],
  249. "tags": [
  250. "admin"
  251. ],
  252. "summary": "Delete a user's public key",
  253. "operationId": "adminDeleteUserPublicKey",
  254. "parameters": [
  255. {
  256. "type": "string",
  257. "description": "username of user",
  258. "name": "username",
  259. "in": "path",
  260. "required": true
  261. },
  262. {
  263. "type": "integer",
  264. "format": "int64",
  265. "description": "id of the key to delete",
  266. "name": "id",
  267. "in": "path",
  268. "required": true
  269. }
  270. ],
  271. "responses": {
  272. "204": {
  273. "$ref": "#/responses/empty"
  274. },
  275. "403": {
  276. "$ref": "#/responses/forbidden"
  277. },
  278. "404": {
  279. "$ref": "#/responses/notFound"
  280. }
  281. }
  282. }
  283. },
  284. "/admin/users/{username}/orgs": {
  285. "post": {
  286. "consumes": [
  287. "application/json"
  288. ],
  289. "produces": [
  290. "application/json"
  291. ],
  292. "tags": [
  293. "admin"
  294. ],
  295. "summary": "Create an organization",
  296. "operationId": "adminCreateOrg",
  297. "parameters": [
  298. {
  299. "type": "string",
  300. "description": "username of the user that will own the created organization",
  301. "name": "username",
  302. "in": "path",
  303. "required": true
  304. },
  305. {
  306. "name": "organization",
  307. "in": "body",
  308. "required": true,
  309. "schema": {
  310. "$ref": "#/definitions/CreateOrgOption"
  311. }
  312. }
  313. ],
  314. "responses": {
  315. "201": {
  316. "$ref": "#/responses/Organization"
  317. },
  318. "403": {
  319. "$ref": "#/responses/forbidden"
  320. },
  321. "422": {
  322. "$ref": "#/responses/validationError"
  323. }
  324. }
  325. }
  326. },
  327. "/admin/users/{username}/repos": {
  328. "post": {
  329. "consumes": [
  330. "application/json"
  331. ],
  332. "produces": [
  333. "application/json"
  334. ],
  335. "tags": [
  336. "admin"
  337. ],
  338. "summary": "Create a repository on behalf of a user",
  339. "operationId": "adminCreateRepo",
  340. "parameters": [
  341. {
  342. "type": "string",
  343. "description": "username of the user. This user will own the created repository",
  344. "name": "username",
  345. "in": "path",
  346. "required": true
  347. },
  348. {
  349. "name": "repository",
  350. "in": "body",
  351. "required": true,
  352. "schema": {
  353. "$ref": "#/definitions/CreateRepoOption"
  354. }
  355. }
  356. ],
  357. "responses": {
  358. "201": {
  359. "$ref": "#/responses/Repository"
  360. },
  361. "403": {
  362. "$ref": "#/responses/forbidden"
  363. },
  364. "404": {
  365. "$ref": "#/responses/notFound"
  366. },
  367. "409": {
  368. "$ref": "#/responses/error"
  369. },
  370. "422": {
  371. "$ref": "#/responses/validationError"
  372. }
  373. }
  374. }
  375. },
  376. "/markdown": {
  377. "post": {
  378. "consumes": [
  379. "application/json"
  380. ],
  381. "produces": [
  382. "text/html"
  383. ],
  384. "tags": [
  385. "miscellaneous"
  386. ],
  387. "summary": "Render a markdown document as HTML",
  388. "operationId": "renderMarkdown",
  389. "parameters": [
  390. {
  391. "name": "body",
  392. "in": "body",
  393. "schema": {
  394. "$ref": "#/definitions/MarkdownOption"
  395. }
  396. }
  397. ],
  398. "responses": {
  399. "200": {
  400. "$ref": "#/responses/MarkdownRender"
  401. },
  402. "422": {
  403. "$ref": "#/responses/validationError"
  404. }
  405. }
  406. }
  407. },
  408. "/markdown/raw": {
  409. "post": {
  410. "consumes": [
  411. "text/plain"
  412. ],
  413. "produces": [
  414. "text/html"
  415. ],
  416. "tags": [
  417. "miscellaneous"
  418. ],
  419. "summary": "Render raw markdown as HTML",
  420. "operationId": "renderMarkdownRaw",
  421. "parameters": [
  422. {
  423. "description": "Request body to render",
  424. "name": "body",
  425. "in": "body",
  426. "required": true,
  427. "schema": {
  428. "type": "string"
  429. }
  430. }
  431. ],
  432. "responses": {
  433. "200": {
  434. "$ref": "#/responses/MarkdownRender"
  435. },
  436. "422": {
  437. "$ref": "#/responses/validationError"
  438. }
  439. }
  440. }
  441. },
  442. "/notifications": {
  443. "get": {
  444. "consumes": [
  445. "application/json"
  446. ],
  447. "produces": [
  448. "application/json"
  449. ],
  450. "tags": [
  451. "notification"
  452. ],
  453. "summary": "List users's notification threads",
  454. "operationId": "notifyGetList",
  455. "parameters": [
  456. {
  457. "type": "string",
  458. "description": "If true, show notifications marked as read. Default value is false",
  459. "name": "all",
  460. "in": "query"
  461. },
  462. {
  463. "type": "string",
  464. "format": "date-time",
  465. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  466. "name": "since",
  467. "in": "query"
  468. },
  469. {
  470. "type": "string",
  471. "format": "date-time",
  472. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  473. "name": "before",
  474. "in": "query"
  475. },
  476. {
  477. "type": "integer",
  478. "description": "page number of results to return (1-based)",
  479. "name": "page",
  480. "in": "query"
  481. },
  482. {
  483. "type": "integer",
  484. "description": "page size of results, maximum page size is 50",
  485. "name": "limit",
  486. "in": "query"
  487. }
  488. ],
  489. "responses": {
  490. "200": {
  491. "$ref": "#/responses/NotificationThreadList"
  492. }
  493. }
  494. },
  495. "put": {
  496. "consumes": [
  497. "application/json"
  498. ],
  499. "produces": [
  500. "application/json"
  501. ],
  502. "tags": [
  503. "notification"
  504. ],
  505. "summary": "Mark notification threads as read",
  506. "operationId": "notifyReadList",
  507. "parameters": [
  508. {
  509. "type": "string",
  510. "format": "date-time",
  511. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  512. "name": "last_read_at",
  513. "in": "query"
  514. }
  515. ],
  516. "responses": {
  517. "205": {
  518. "$ref": "#/responses/empty"
  519. }
  520. }
  521. }
  522. },
  523. "/notifications/new": {
  524. "get": {
  525. "tags": [
  526. "notification"
  527. ],
  528. "summary": "Check if unread notifications exist",
  529. "operationId": "notifyNewAvailable",
  530. "responses": {
  531. "200": {
  532. "$ref": "#/responses/NotificationCount"
  533. },
  534. "204": {
  535. "description": "No unread notification"
  536. }
  537. }
  538. }
  539. },
  540. "/notifications/threads/{id}": {
  541. "get": {
  542. "consumes": [
  543. "application/json"
  544. ],
  545. "produces": [
  546. "application/json"
  547. ],
  548. "tags": [
  549. "notification"
  550. ],
  551. "summary": "Get notification thread by ID",
  552. "operationId": "notifyGetThread",
  553. "parameters": [
  554. {
  555. "type": "string",
  556. "description": "id of notification thread",
  557. "name": "id",
  558. "in": "path",
  559. "required": true
  560. }
  561. ],
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/NotificationThread"
  565. },
  566. "403": {
  567. "$ref": "#/responses/forbidden"
  568. },
  569. "404": {
  570. "$ref": "#/responses/notFound"
  571. }
  572. }
  573. },
  574. "patch": {
  575. "consumes": [
  576. "application/json"
  577. ],
  578. "produces": [
  579. "application/json"
  580. ],
  581. "tags": [
  582. "notification"
  583. ],
  584. "summary": "Mark notification thread as read by ID",
  585. "operationId": "notifyReadThread",
  586. "parameters": [
  587. {
  588. "type": "string",
  589. "description": "id of notification thread",
  590. "name": "id",
  591. "in": "path",
  592. "required": true
  593. }
  594. ],
  595. "responses": {
  596. "205": {
  597. "$ref": "#/responses/empty"
  598. },
  599. "403": {
  600. "$ref": "#/responses/forbidden"
  601. },
  602. "404": {
  603. "$ref": "#/responses/notFound"
  604. }
  605. }
  606. }
  607. },
  608. "/org/{org}/repos": {
  609. "post": {
  610. "consumes": [
  611. "application/json"
  612. ],
  613. "produces": [
  614. "application/json"
  615. ],
  616. "tags": [
  617. "organization"
  618. ],
  619. "summary": "Create a repository in an organization",
  620. "operationId": "createOrgRepoDeprecated",
  621. "deprecated": true,
  622. "parameters": [
  623. {
  624. "type": "string",
  625. "description": "name of organization",
  626. "name": "org",
  627. "in": "path",
  628. "required": true
  629. },
  630. {
  631. "name": "body",
  632. "in": "body",
  633. "schema": {
  634. "$ref": "#/definitions/CreateRepoOption"
  635. }
  636. }
  637. ],
  638. "responses": {
  639. "201": {
  640. "$ref": "#/responses/Repository"
  641. },
  642. "403": {
  643. "$ref": "#/responses/forbidden"
  644. },
  645. "422": {
  646. "$ref": "#/responses/validationError"
  647. }
  648. }
  649. }
  650. },
  651. "/orgs": {
  652. "get": {
  653. "produces": [
  654. "application/json"
  655. ],
  656. "tags": [
  657. "organization"
  658. ],
  659. "summary": "Get list of organizations",
  660. "operationId": "orgGetAll",
  661. "parameters": [
  662. {
  663. "type": "integer",
  664. "description": "page number of results to return (1-based)",
  665. "name": "page",
  666. "in": "query"
  667. },
  668. {
  669. "type": "integer",
  670. "description": "page size of results, maximum page size is 50",
  671. "name": "limit",
  672. "in": "query"
  673. }
  674. ],
  675. "responses": {
  676. "200": {
  677. "$ref": "#/responses/OrganizationList"
  678. }
  679. }
  680. },
  681. "post": {
  682. "consumes": [
  683. "application/json"
  684. ],
  685. "produces": [
  686. "application/json"
  687. ],
  688. "tags": [
  689. "organization"
  690. ],
  691. "summary": "Create an organization",
  692. "operationId": "orgCreate",
  693. "parameters": [
  694. {
  695. "name": "organization",
  696. "in": "body",
  697. "required": true,
  698. "schema": {
  699. "$ref": "#/definitions/CreateOrgOption"
  700. }
  701. }
  702. ],
  703. "responses": {
  704. "201": {
  705. "$ref": "#/responses/Organization"
  706. },
  707. "403": {
  708. "$ref": "#/responses/forbidden"
  709. },
  710. "422": {
  711. "$ref": "#/responses/validationError"
  712. }
  713. }
  714. }
  715. },
  716. "/orgs/{org}": {
  717. "get": {
  718. "produces": [
  719. "application/json"
  720. ],
  721. "tags": [
  722. "organization"
  723. ],
  724. "summary": "Get an organization",
  725. "operationId": "orgGet",
  726. "parameters": [
  727. {
  728. "type": "string",
  729. "description": "name of the organization to get",
  730. "name": "org",
  731. "in": "path",
  732. "required": true
  733. }
  734. ],
  735. "responses": {
  736. "200": {
  737. "$ref": "#/responses/Organization"
  738. }
  739. }
  740. },
  741. "delete": {
  742. "produces": [
  743. "application/json"
  744. ],
  745. "tags": [
  746. "organization"
  747. ],
  748. "summary": "Delete an organization",
  749. "operationId": "orgDelete",
  750. "parameters": [
  751. {
  752. "type": "string",
  753. "description": "organization that is to be deleted",
  754. "name": "org",
  755. "in": "path",
  756. "required": true
  757. }
  758. ],
  759. "responses": {
  760. "204": {
  761. "$ref": "#/responses/empty"
  762. }
  763. }
  764. },
  765. "patch": {
  766. "consumes": [
  767. "application/json"
  768. ],
  769. "produces": [
  770. "application/json"
  771. ],
  772. "tags": [
  773. "organization"
  774. ],
  775. "summary": "Edit an organization",
  776. "operationId": "orgEdit",
  777. "parameters": [
  778. {
  779. "type": "string",
  780. "description": "name of the organization to edit",
  781. "name": "org",
  782. "in": "path",
  783. "required": true
  784. },
  785. {
  786. "name": "body",
  787. "in": "body",
  788. "required": true,
  789. "schema": {
  790. "$ref": "#/definitions/EditOrgOption"
  791. }
  792. }
  793. ],
  794. "responses": {
  795. "200": {
  796. "$ref": "#/responses/Organization"
  797. }
  798. }
  799. }
  800. },
  801. "/orgs/{org}/hooks": {
  802. "get": {
  803. "produces": [
  804. "application/json"
  805. ],
  806. "tags": [
  807. "organization"
  808. ],
  809. "summary": "List an organization's webhooks",
  810. "operationId": "orgListHooks",
  811. "parameters": [
  812. {
  813. "type": "string",
  814. "description": "name of the organization",
  815. "name": "org",
  816. "in": "path",
  817. "required": true
  818. },
  819. {
  820. "type": "integer",
  821. "description": "page number of results to return (1-based)",
  822. "name": "page",
  823. "in": "query"
  824. },
  825. {
  826. "type": "integer",
  827. "description": "page size of results, maximum page size is 50",
  828. "name": "limit",
  829. "in": "query"
  830. }
  831. ],
  832. "responses": {
  833. "200": {
  834. "$ref": "#/responses/HookList"
  835. }
  836. }
  837. }
  838. },
  839. "/orgs/{org}/hooks/": {
  840. "post": {
  841. "consumes": [
  842. "application/json"
  843. ],
  844. "produces": [
  845. "application/json"
  846. ],
  847. "tags": [
  848. "organization"
  849. ],
  850. "summary": "Create a hook",
  851. "operationId": "orgCreateHook",
  852. "parameters": [
  853. {
  854. "type": "string",
  855. "description": "name of the organization",
  856. "name": "org",
  857. "in": "path",
  858. "required": true
  859. },
  860. {
  861. "name": "body",
  862. "in": "body",
  863. "required": true,
  864. "schema": {
  865. "$ref": "#/definitions/CreateHookOption"
  866. }
  867. }
  868. ],
  869. "responses": {
  870. "201": {
  871. "$ref": "#/responses/Hook"
  872. }
  873. }
  874. }
  875. },
  876. "/orgs/{org}/hooks/{id}": {
  877. "get": {
  878. "produces": [
  879. "application/json"
  880. ],
  881. "tags": [
  882. "organization"
  883. ],
  884. "summary": "Get a hook",
  885. "operationId": "orgGetHook",
  886. "parameters": [
  887. {
  888. "type": "string",
  889. "description": "name of the organization",
  890. "name": "org",
  891. "in": "path",
  892. "required": true
  893. },
  894. {
  895. "type": "integer",
  896. "format": "int64",
  897. "description": "id of the hook to get",
  898. "name": "id",
  899. "in": "path",
  900. "required": true
  901. }
  902. ],
  903. "responses": {
  904. "200": {
  905. "$ref": "#/responses/Hook"
  906. }
  907. }
  908. },
  909. "delete": {
  910. "produces": [
  911. "application/json"
  912. ],
  913. "tags": [
  914. "organization"
  915. ],
  916. "summary": "Delete a hook",
  917. "operationId": "orgDeleteHook",
  918. "parameters": [
  919. {
  920. "type": "string",
  921. "description": "name of the organization",
  922. "name": "org",
  923. "in": "path",
  924. "required": true
  925. },
  926. {
  927. "type": "integer",
  928. "format": "int64",
  929. "description": "id of the hook to delete",
  930. "name": "id",
  931. "in": "path",
  932. "required": true
  933. }
  934. ],
  935. "responses": {
  936. "204": {
  937. "$ref": "#/responses/empty"
  938. }
  939. }
  940. },
  941. "patch": {
  942. "consumes": [
  943. "application/json"
  944. ],
  945. "produces": [
  946. "application/json"
  947. ],
  948. "tags": [
  949. "organization"
  950. ],
  951. "summary": "Update a hook",
  952. "operationId": "orgEditHook",
  953. "parameters": [
  954. {
  955. "type": "string",
  956. "description": "name of the organization",
  957. "name": "org",
  958. "in": "path",
  959. "required": true
  960. },
  961. {
  962. "type": "integer",
  963. "format": "int64",
  964. "description": "id of the hook to update",
  965. "name": "id",
  966. "in": "path",
  967. "required": true
  968. },
  969. {
  970. "name": "body",
  971. "in": "body",
  972. "schema": {
  973. "$ref": "#/definitions/EditHookOption"
  974. }
  975. }
  976. ],
  977. "responses": {
  978. "200": {
  979. "$ref": "#/responses/Hook"
  980. }
  981. }
  982. }
  983. },
  984. "/orgs/{org}/members": {
  985. "get": {
  986. "produces": [
  987. "application/json"
  988. ],
  989. "tags": [
  990. "organization"
  991. ],
  992. "summary": "List an organization's members",
  993. "operationId": "orgListMembers",
  994. "parameters": [
  995. {
  996. "type": "string",
  997. "description": "name of the organization",
  998. "name": "org",
  999. "in": "path",
  1000. "required": true
  1001. },
  1002. {
  1003. "type": "integer",
  1004. "description": "page number of results to return (1-based)",
  1005. "name": "page",
  1006. "in": "query"
  1007. },
  1008. {
  1009. "type": "integer",
  1010. "description": "page size of results, maximum page size is 50",
  1011. "name": "limit",
  1012. "in": "query"
  1013. }
  1014. ],
  1015. "responses": {
  1016. "200": {
  1017. "$ref": "#/responses/UserList"
  1018. }
  1019. }
  1020. }
  1021. },
  1022. "/orgs/{org}/members/{username}": {
  1023. "get": {
  1024. "tags": [
  1025. "organization"
  1026. ],
  1027. "summary": "Check if a user is a member of an organization",
  1028. "operationId": "orgIsMember",
  1029. "parameters": [
  1030. {
  1031. "type": "string",
  1032. "description": "name of the organization",
  1033. "name": "org",
  1034. "in": "path",
  1035. "required": true
  1036. },
  1037. {
  1038. "type": "string",
  1039. "description": "username of the user",
  1040. "name": "username",
  1041. "in": "path",
  1042. "required": true
  1043. }
  1044. ],
  1045. "responses": {
  1046. "204": {
  1047. "description": "user is a member"
  1048. },
  1049. "302": {
  1050. "description": "redirection to /orgs/{org}/public_members/{username}"
  1051. },
  1052. "404": {
  1053. "description": "user is not a member"
  1054. }
  1055. }
  1056. },
  1057. "delete": {
  1058. "produces": [
  1059. "application/json"
  1060. ],
  1061. "tags": [
  1062. "organization"
  1063. ],
  1064. "summary": "Remove a member from an organization",
  1065. "operationId": "orgDeleteMember",
  1066. "parameters": [
  1067. {
  1068. "type": "string",
  1069. "description": "name of the organization",
  1070. "name": "org",
  1071. "in": "path",
  1072. "required": true
  1073. },
  1074. {
  1075. "type": "string",
  1076. "description": "username of the user",
  1077. "name": "username",
  1078. "in": "path",
  1079. "required": true
  1080. }
  1081. ],
  1082. "responses": {
  1083. "204": {
  1084. "description": "member removed"
  1085. }
  1086. }
  1087. }
  1088. },
  1089. "/orgs/{org}/public_members": {
  1090. "get": {
  1091. "produces": [
  1092. "application/json"
  1093. ],
  1094. "tags": [
  1095. "organization"
  1096. ],
  1097. "summary": "List an organization's public members",
  1098. "operationId": "orgListPublicMembers",
  1099. "parameters": [
  1100. {
  1101. "type": "string",
  1102. "description": "name of the organization",
  1103. "name": "org",
  1104. "in": "path",
  1105. "required": true
  1106. },
  1107. {
  1108. "type": "integer",
  1109. "description": "page number of results to return (1-based)",
  1110. "name": "page",
  1111. "in": "query"
  1112. },
  1113. {
  1114. "type": "integer",
  1115. "description": "page size of results, maximum page size is 50",
  1116. "name": "limit",
  1117. "in": "query"
  1118. }
  1119. ],
  1120. "responses": {
  1121. "200": {
  1122. "$ref": "#/responses/UserList"
  1123. }
  1124. }
  1125. }
  1126. },
  1127. "/orgs/{org}/public_members/{username}": {
  1128. "get": {
  1129. "tags": [
  1130. "organization"
  1131. ],
  1132. "summary": "Check if a user is a public member of an organization",
  1133. "operationId": "orgIsPublicMember",
  1134. "parameters": [
  1135. {
  1136. "type": "string",
  1137. "description": "name of the organization",
  1138. "name": "org",
  1139. "in": "path",
  1140. "required": true
  1141. },
  1142. {
  1143. "type": "string",
  1144. "description": "username of the user",
  1145. "name": "username",
  1146. "in": "path",
  1147. "required": true
  1148. }
  1149. ],
  1150. "responses": {
  1151. "204": {
  1152. "description": "user is a public member"
  1153. },
  1154. "404": {
  1155. "description": "user is not a public member"
  1156. }
  1157. }
  1158. },
  1159. "put": {
  1160. "produces": [
  1161. "application/json"
  1162. ],
  1163. "tags": [
  1164. "organization"
  1165. ],
  1166. "summary": "Publicize a user's membership",
  1167. "operationId": "orgPublicizeMember",
  1168. "parameters": [
  1169. {
  1170. "type": "string",
  1171. "description": "name of the organization",
  1172. "name": "org",
  1173. "in": "path",
  1174. "required": true
  1175. },
  1176. {
  1177. "type": "string",
  1178. "description": "username of the user",
  1179. "name": "username",
  1180. "in": "path",
  1181. "required": true
  1182. }
  1183. ],
  1184. "responses": {
  1185. "204": {
  1186. "description": "membership publicized"
  1187. },
  1188. "403": {
  1189. "$ref": "#/responses/forbidden"
  1190. }
  1191. }
  1192. },
  1193. "delete": {
  1194. "produces": [
  1195. "application/json"
  1196. ],
  1197. "tags": [
  1198. "organization"
  1199. ],
  1200. "summary": "Conceal a user's membership",
  1201. "operationId": "orgConcealMember",
  1202. "parameters": [
  1203. {
  1204. "type": "string",
  1205. "description": "name of the organization",
  1206. "name": "org",
  1207. "in": "path",
  1208. "required": true
  1209. },
  1210. {
  1211. "type": "string",
  1212. "description": "username of the user",
  1213. "name": "username",
  1214. "in": "path",
  1215. "required": true
  1216. }
  1217. ],
  1218. "responses": {
  1219. "204": {
  1220. "$ref": "#/responses/empty"
  1221. },
  1222. "403": {
  1223. "$ref": "#/responses/forbidden"
  1224. }
  1225. }
  1226. }
  1227. },
  1228. "/orgs/{org}/repos": {
  1229. "get": {
  1230. "produces": [
  1231. "application/json"
  1232. ],
  1233. "tags": [
  1234. "organization"
  1235. ],
  1236. "summary": "List an organization's repos",
  1237. "operationId": "orgListRepos",
  1238. "parameters": [
  1239. {
  1240. "type": "string",
  1241. "description": "name of the organization",
  1242. "name": "org",
  1243. "in": "path",
  1244. "required": true
  1245. },
  1246. {
  1247. "type": "integer",
  1248. "description": "page number of results to return (1-based)",
  1249. "name": "page",
  1250. "in": "query"
  1251. },
  1252. {
  1253. "type": "integer",
  1254. "description": "page size of results, maximum page size is 50",
  1255. "name": "limit",
  1256. "in": "query"
  1257. }
  1258. ],
  1259. "responses": {
  1260. "200": {
  1261. "$ref": "#/responses/RepositoryList"
  1262. }
  1263. }
  1264. },
  1265. "post": {
  1266. "consumes": [
  1267. "application/json"
  1268. ],
  1269. "produces": [
  1270. "application/json"
  1271. ],
  1272. "tags": [
  1273. "organization"
  1274. ],
  1275. "summary": "Create a repository in an organization",
  1276. "operationId": "createOrgRepo",
  1277. "parameters": [
  1278. {
  1279. "type": "string",
  1280. "description": "name of organization",
  1281. "name": "org",
  1282. "in": "path",
  1283. "required": true
  1284. },
  1285. {
  1286. "name": "body",
  1287. "in": "body",
  1288. "schema": {
  1289. "$ref": "#/definitions/CreateRepoOption"
  1290. }
  1291. }
  1292. ],
  1293. "responses": {
  1294. "201": {
  1295. "$ref": "#/responses/Repository"
  1296. },
  1297. "403": {
  1298. "$ref": "#/responses/forbidden"
  1299. },
  1300. "404": {
  1301. "$ref": "#/responses/notFound"
  1302. }
  1303. }
  1304. }
  1305. },
  1306. "/orgs/{org}/teams": {
  1307. "get": {
  1308. "produces": [
  1309. "application/json"
  1310. ],
  1311. "tags": [
  1312. "organization"
  1313. ],
  1314. "summary": "List an organization's teams",
  1315. "operationId": "orgListTeams",
  1316. "parameters": [
  1317. {
  1318. "type": "string",
  1319. "description": "name of the organization",
  1320. "name": "org",
  1321. "in": "path",
  1322. "required": true
  1323. },
  1324. {
  1325. "type": "integer",
  1326. "description": "page number of results to return (1-based)",
  1327. "name": "page",
  1328. "in": "query"
  1329. },
  1330. {
  1331. "type": "integer",
  1332. "description": "page size of results, maximum page size is 50",
  1333. "name": "limit",
  1334. "in": "query"
  1335. }
  1336. ],
  1337. "responses": {
  1338. "200": {
  1339. "$ref": "#/responses/TeamList"
  1340. }
  1341. }
  1342. },
  1343. "post": {
  1344. "consumes": [
  1345. "application/json"
  1346. ],
  1347. "produces": [
  1348. "application/json"
  1349. ],
  1350. "tags": [
  1351. "organization"
  1352. ],
  1353. "summary": "Create a team",
  1354. "operationId": "orgCreateTeam",
  1355. "parameters": [
  1356. {
  1357. "type": "string",
  1358. "description": "name of the organization",
  1359. "name": "org",
  1360. "in": "path",
  1361. "required": true
  1362. },
  1363. {
  1364. "name": "body",
  1365. "in": "body",
  1366. "schema": {
  1367. "$ref": "#/definitions/CreateTeamOption"
  1368. }
  1369. }
  1370. ],
  1371. "responses": {
  1372. "201": {
  1373. "$ref": "#/responses/Team"
  1374. },
  1375. "422": {
  1376. "$ref": "#/responses/validationError"
  1377. }
  1378. }
  1379. }
  1380. },
  1381. "/orgs/{org}/teams/search": {
  1382. "get": {
  1383. "produces": [
  1384. "application/json"
  1385. ],
  1386. "tags": [
  1387. "organization"
  1388. ],
  1389. "summary": "Search for teams within an organization",
  1390. "operationId": "teamSearch",
  1391. "parameters": [
  1392. {
  1393. "type": "string",
  1394. "description": "name of the organization",
  1395. "name": "org",
  1396. "in": "path",
  1397. "required": true
  1398. },
  1399. {
  1400. "type": "string",
  1401. "description": "keywords to search",
  1402. "name": "q",
  1403. "in": "query"
  1404. },
  1405. {
  1406. "type": "boolean",
  1407. "description": "include search within team description (defaults to true)",
  1408. "name": "include_desc",
  1409. "in": "query"
  1410. },
  1411. {
  1412. "type": "integer",
  1413. "description": "page number of results to return (1-based)",
  1414. "name": "page",
  1415. "in": "query"
  1416. },
  1417. {
  1418. "type": "integer",
  1419. "description": "page size of results, maximum page size is 50",
  1420. "name": "limit",
  1421. "in": "query"
  1422. }
  1423. ],
  1424. "responses": {
  1425. "200": {
  1426. "description": "SearchResults of a successful search",
  1427. "schema": {
  1428. "type": "object",
  1429. "properties": {
  1430. "data": {
  1431. "type": "array",
  1432. "items": {
  1433. "$ref": "#/definitions/Team"
  1434. }
  1435. },
  1436. "ok": {
  1437. "type": "boolean"
  1438. }
  1439. }
  1440. }
  1441. }
  1442. }
  1443. }
  1444. },
  1445. "/repos/issues/search": {
  1446. "get": {
  1447. "produces": [
  1448. "application/json"
  1449. ],
  1450. "tags": [
  1451. "issue"
  1452. ],
  1453. "summary": "Search for issues across the repositories that the user has access to",
  1454. "operationId": "issueSearchIssues",
  1455. "parameters": [
  1456. {
  1457. "type": "string",
  1458. "description": "whether issue is open or closed",
  1459. "name": "state",
  1460. "in": "query"
  1461. },
  1462. {
  1463. "type": "string",
  1464. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1465. "name": "labels",
  1466. "in": "query"
  1467. },
  1468. {
  1469. "type": "string",
  1470. "description": "search string",
  1471. "name": "q",
  1472. "in": "query"
  1473. },
  1474. {
  1475. "type": "integer",
  1476. "format": "int64",
  1477. "description": "repository to prioritize in the results",
  1478. "name": "priority_repo_id",
  1479. "in": "query"
  1480. },
  1481. {
  1482. "type": "string",
  1483. "description": "filter by type (issues / pulls) if set",
  1484. "name": "type",
  1485. "in": "query"
  1486. },
  1487. {
  1488. "type": "integer",
  1489. "description": "page number of requested issues",
  1490. "name": "page",
  1491. "in": "query"
  1492. }
  1493. ],
  1494. "responses": {
  1495. "200": {
  1496. "$ref": "#/responses/IssueList"
  1497. }
  1498. }
  1499. }
  1500. },
  1501. "/repos/migrate": {
  1502. "post": {
  1503. "consumes": [
  1504. "application/json"
  1505. ],
  1506. "produces": [
  1507. "application/json"
  1508. ],
  1509. "tags": [
  1510. "repository"
  1511. ],
  1512. "summary": "Migrate a remote git repository",
  1513. "operationId": "repoMigrate",
  1514. "parameters": [
  1515. {
  1516. "name": "body",
  1517. "in": "body",
  1518. "schema": {
  1519. "$ref": "#/definitions/MigrateRepoForm"
  1520. }
  1521. }
  1522. ],
  1523. "responses": {
  1524. "201": {
  1525. "$ref": "#/responses/Repository"
  1526. },
  1527. "403": {
  1528. "$ref": "#/responses/forbidden"
  1529. },
  1530. "422": {
  1531. "$ref": "#/responses/validationError"
  1532. }
  1533. }
  1534. }
  1535. },
  1536. "/repos/search": {
  1537. "get": {
  1538. "produces": [
  1539. "application/json"
  1540. ],
  1541. "tags": [
  1542. "repository"
  1543. ],
  1544. "summary": "Search for repositories",
  1545. "operationId": "repoSearch",
  1546. "parameters": [
  1547. {
  1548. "type": "string",
  1549. "description": "keyword",
  1550. "name": "q",
  1551. "in": "query"
  1552. },
  1553. {
  1554. "type": "boolean",
  1555. "description": "Limit search to repositories with keyword as topic",
  1556. "name": "topic",
  1557. "in": "query"
  1558. },
  1559. {
  1560. "type": "boolean",
  1561. "description": "include search of keyword within repository description",
  1562. "name": "includeDesc",
  1563. "in": "query"
  1564. },
  1565. {
  1566. "type": "integer",
  1567. "format": "int64",
  1568. "description": "search only for repos that the user with the given id owns or contributes to",
  1569. "name": "uid",
  1570. "in": "query"
  1571. },
  1572. {
  1573. "type": "integer",
  1574. "format": "int64",
  1575. "description": "repo owner to prioritize in the results",
  1576. "name": "priority_owner_id",
  1577. "in": "query"
  1578. },
  1579. {
  1580. "type": "integer",
  1581. "format": "int64",
  1582. "description": "search only for repos that the user with the given id has starred",
  1583. "name": "starredBy",
  1584. "in": "query"
  1585. },
  1586. {
  1587. "type": "boolean",
  1588. "description": "include private repositories this user has access to (defaults to true)",
  1589. "name": "private",
  1590. "in": "query"
  1591. },
  1592. {
  1593. "type": "boolean",
  1594. "description": "include template repositories this user has access to (defaults to true)",
  1595. "name": "template",
  1596. "in": "query"
  1597. },
  1598. {
  1599. "type": "string",
  1600. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1601. "name": "mode",
  1602. "in": "query"
  1603. },
  1604. {
  1605. "type": "boolean",
  1606. "description": "if `uid` is given, search only for repos that the user owns",
  1607. "name": "exclusive",
  1608. "in": "query"
  1609. },
  1610. {
  1611. "type": "string",
  1612. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1613. "name": "sort",
  1614. "in": "query"
  1615. },
  1616. {
  1617. "type": "string",
  1618. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1619. "name": "order",
  1620. "in": "query"
  1621. },
  1622. {
  1623. "type": "integer",
  1624. "description": "page number of results to return (1-based)",
  1625. "name": "page",
  1626. "in": "query"
  1627. },
  1628. {
  1629. "type": "integer",
  1630. "description": "page size of results, maximum page size is 50",
  1631. "name": "limit",
  1632. "in": "query"
  1633. }
  1634. ],
  1635. "responses": {
  1636. "200": {
  1637. "$ref": "#/responses/SearchResults"
  1638. },
  1639. "422": {
  1640. "$ref": "#/responses/validationError"
  1641. }
  1642. }
  1643. }
  1644. },
  1645. "/repos/{owner}/{repo}": {
  1646. "get": {
  1647. "produces": [
  1648. "application/json"
  1649. ],
  1650. "tags": [
  1651. "repository"
  1652. ],
  1653. "summary": "Get a repository",
  1654. "operationId": "repoGet",
  1655. "parameters": [
  1656. {
  1657. "type": "string",
  1658. "description": "owner of the repo",
  1659. "name": "owner",
  1660. "in": "path",
  1661. "required": true
  1662. },
  1663. {
  1664. "type": "string",
  1665. "description": "name of the repo",
  1666. "name": "repo",
  1667. "in": "path",
  1668. "required": true
  1669. }
  1670. ],
  1671. "responses": {
  1672. "200": {
  1673. "$ref": "#/responses/Repository"
  1674. }
  1675. }
  1676. },
  1677. "delete": {
  1678. "produces": [
  1679. "application/json"
  1680. ],
  1681. "tags": [
  1682. "repository"
  1683. ],
  1684. "summary": "Delete a repository",
  1685. "operationId": "repoDelete",
  1686. "parameters": [
  1687. {
  1688. "type": "string",
  1689. "description": "owner of the repo to delete",
  1690. "name": "owner",
  1691. "in": "path",
  1692. "required": true
  1693. },
  1694. {
  1695. "type": "string",
  1696. "description": "name of the repo to delete",
  1697. "name": "repo",
  1698. "in": "path",
  1699. "required": true
  1700. }
  1701. ],
  1702. "responses": {
  1703. "204": {
  1704. "$ref": "#/responses/empty"
  1705. },
  1706. "403": {
  1707. "$ref": "#/responses/forbidden"
  1708. }
  1709. }
  1710. },
  1711. "patch": {
  1712. "produces": [
  1713. "application/json"
  1714. ],
  1715. "tags": [
  1716. "repository"
  1717. ],
  1718. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1719. "operationId": "repoEdit",
  1720. "parameters": [
  1721. {
  1722. "type": "string",
  1723. "description": "owner of the repo to edit",
  1724. "name": "owner",
  1725. "in": "path",
  1726. "required": true
  1727. },
  1728. {
  1729. "type": "string",
  1730. "description": "name of the repo to edit",
  1731. "name": "repo",
  1732. "in": "path",
  1733. "required": true
  1734. },
  1735. {
  1736. "description": "Properties of a repo that you can edit",
  1737. "name": "body",
  1738. "in": "body",
  1739. "schema": {
  1740. "$ref": "#/definitions/EditRepoOption"
  1741. }
  1742. }
  1743. ],
  1744. "responses": {
  1745. "200": {
  1746. "$ref": "#/responses/Repository"
  1747. },
  1748. "403": {
  1749. "$ref": "#/responses/forbidden"
  1750. },
  1751. "422": {
  1752. "$ref": "#/responses/validationError"
  1753. }
  1754. }
  1755. }
  1756. },
  1757. "/repos/{owner}/{repo}/archive/{archive}": {
  1758. "get": {
  1759. "produces": [
  1760. "application/json"
  1761. ],
  1762. "tags": [
  1763. "repository"
  1764. ],
  1765. "summary": "Get an archive of a repository",
  1766. "operationId": "repoGetArchive",
  1767. "parameters": [
  1768. {
  1769. "type": "string",
  1770. "description": "owner of the repo",
  1771. "name": "owner",
  1772. "in": "path",
  1773. "required": true
  1774. },
  1775. {
  1776. "type": "string",
  1777. "description": "name of the repo",
  1778. "name": "repo",
  1779. "in": "path",
  1780. "required": true
  1781. },
  1782. {
  1783. "type": "string",
  1784. "description": "archive to download, consisting of a git reference and archive",
  1785. "name": "archive",
  1786. "in": "path",
  1787. "required": true
  1788. }
  1789. ],
  1790. "responses": {
  1791. "200": {
  1792. "description": "success"
  1793. },
  1794. "404": {
  1795. "$ref": "#/responses/notFound"
  1796. }
  1797. }
  1798. }
  1799. },
  1800. "/repos/{owner}/{repo}/branches": {
  1801. "get": {
  1802. "produces": [
  1803. "application/json"
  1804. ],
  1805. "tags": [
  1806. "repository"
  1807. ],
  1808. "summary": "List a repository's branches",
  1809. "operationId": "repoListBranches",
  1810. "parameters": [
  1811. {
  1812. "type": "string",
  1813. "description": "owner of the repo",
  1814. "name": "owner",
  1815. "in": "path",
  1816. "required": true
  1817. },
  1818. {
  1819. "type": "string",
  1820. "description": "name of the repo",
  1821. "name": "repo",
  1822. "in": "path",
  1823. "required": true
  1824. }
  1825. ],
  1826. "responses": {
  1827. "200": {
  1828. "$ref": "#/responses/BranchList"
  1829. }
  1830. }
  1831. }
  1832. },
  1833. "/repos/{owner}/{repo}/branches/{branch}": {
  1834. "get": {
  1835. "produces": [
  1836. "application/json"
  1837. ],
  1838. "tags": [
  1839. "repository"
  1840. ],
  1841. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  1842. "operationId": "repoGetBranch",
  1843. "parameters": [
  1844. {
  1845. "type": "string",
  1846. "description": "owner of the repo",
  1847. "name": "owner",
  1848. "in": "path",
  1849. "required": true
  1850. },
  1851. {
  1852. "type": "string",
  1853. "description": "name of the repo",
  1854. "name": "repo",
  1855. "in": "path",
  1856. "required": true
  1857. },
  1858. {
  1859. "type": "string",
  1860. "description": "branch to get",
  1861. "name": "branch",
  1862. "in": "path",
  1863. "required": true
  1864. }
  1865. ],
  1866. "responses": {
  1867. "200": {
  1868. "$ref": "#/responses/Branch"
  1869. }
  1870. }
  1871. }
  1872. },
  1873. "/repos/{owner}/{repo}/collaborators": {
  1874. "get": {
  1875. "produces": [
  1876. "application/json"
  1877. ],
  1878. "tags": [
  1879. "repository"
  1880. ],
  1881. "summary": "List a repository's collaborators",
  1882. "operationId": "repoListCollaborators",
  1883. "parameters": [
  1884. {
  1885. "type": "string",
  1886. "description": "owner of the repo",
  1887. "name": "owner",
  1888. "in": "path",
  1889. "required": true
  1890. },
  1891. {
  1892. "type": "string",
  1893. "description": "name of the repo",
  1894. "name": "repo",
  1895. "in": "path",
  1896. "required": true
  1897. },
  1898. {
  1899. "type": "integer",
  1900. "description": "page number of results to return (1-based)",
  1901. "name": "page",
  1902. "in": "query"
  1903. },
  1904. {
  1905. "type": "integer",
  1906. "description": "page size of results, maximum page size is 50",
  1907. "name": "limit",
  1908. "in": "query"
  1909. }
  1910. ],
  1911. "responses": {
  1912. "200": {
  1913. "$ref": "#/responses/UserList"
  1914. }
  1915. }
  1916. }
  1917. },
  1918. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  1919. "get": {
  1920. "produces": [
  1921. "application/json"
  1922. ],
  1923. "tags": [
  1924. "repository"
  1925. ],
  1926. "summary": "Check if a user is a collaborator of a repository",
  1927. "operationId": "repoCheckCollaborator",
  1928. "parameters": [
  1929. {
  1930. "type": "string",
  1931. "description": "owner of the repo",
  1932. "name": "owner",
  1933. "in": "path",
  1934. "required": true
  1935. },
  1936. {
  1937. "type": "string",
  1938. "description": "name of the repo",
  1939. "name": "repo",
  1940. "in": "path",
  1941. "required": true
  1942. },
  1943. {
  1944. "type": "string",
  1945. "description": "username of the collaborator",
  1946. "name": "collaborator",
  1947. "in": "path",
  1948. "required": true
  1949. }
  1950. ],
  1951. "responses": {
  1952. "204": {
  1953. "$ref": "#/responses/empty"
  1954. },
  1955. "404": {
  1956. "$ref": "#/responses/notFound"
  1957. },
  1958. "422": {
  1959. "$ref": "#/responses/validationError"
  1960. }
  1961. }
  1962. },
  1963. "put": {
  1964. "produces": [
  1965. "application/json"
  1966. ],
  1967. "tags": [
  1968. "repository"
  1969. ],
  1970. "summary": "Add a collaborator to a repository",
  1971. "operationId": "repoAddCollaborator",
  1972. "parameters": [
  1973. {
  1974. "type": "string",
  1975. "description": "owner of the repo",
  1976. "name": "owner",
  1977. "in": "path",
  1978. "required": true
  1979. },
  1980. {
  1981. "type": "string",
  1982. "description": "name of the repo",
  1983. "name": "repo",
  1984. "in": "path",
  1985. "required": true
  1986. },
  1987. {
  1988. "type": "string",
  1989. "description": "username of the collaborator to add",
  1990. "name": "collaborator",
  1991. "in": "path",
  1992. "required": true
  1993. },
  1994. {
  1995. "name": "body",
  1996. "in": "body",
  1997. "schema": {
  1998. "$ref": "#/definitions/AddCollaboratorOption"
  1999. }
  2000. }
  2001. ],
  2002. "responses": {
  2003. "204": {
  2004. "$ref": "#/responses/empty"
  2005. },
  2006. "422": {
  2007. "$ref": "#/responses/validationError"
  2008. }
  2009. }
  2010. },
  2011. "delete": {
  2012. "produces": [
  2013. "application/json"
  2014. ],
  2015. "tags": [
  2016. "repository"
  2017. ],
  2018. "summary": "Delete a collaborator from a repository",
  2019. "operationId": "repoDeleteCollaborator",
  2020. "parameters": [
  2021. {
  2022. "type": "string",
  2023. "description": "owner of the repo",
  2024. "name": "owner",
  2025. "in": "path",
  2026. "required": true
  2027. },
  2028. {
  2029. "type": "string",
  2030. "description": "name of the repo",
  2031. "name": "repo",
  2032. "in": "path",
  2033. "required": true
  2034. },
  2035. {
  2036. "type": "string",
  2037. "description": "username of the collaborator to delete",
  2038. "name": "collaborator",
  2039. "in": "path",
  2040. "required": true
  2041. }
  2042. ],
  2043. "responses": {
  2044. "204": {
  2045. "$ref": "#/responses/empty"
  2046. },
  2047. "422": {
  2048. "$ref": "#/responses/validationError"
  2049. }
  2050. }
  2051. }
  2052. },
  2053. "/repos/{owner}/{repo}/commits": {
  2054. "get": {
  2055. "produces": [
  2056. "application/json"
  2057. ],
  2058. "tags": [
  2059. "repository"
  2060. ],
  2061. "summary": "Get a list of all commits from a repository",
  2062. "operationId": "repoGetAllCommits",
  2063. "parameters": [
  2064. {
  2065. "type": "string",
  2066. "description": "owner of the repo",
  2067. "name": "owner",
  2068. "in": "path",
  2069. "required": true
  2070. },
  2071. {
  2072. "type": "string",
  2073. "description": "name of the repo",
  2074. "name": "repo",
  2075. "in": "path",
  2076. "required": true
  2077. },
  2078. {
  2079. "type": "string",
  2080. "description": "SHA or branch to start listing commits from (usually 'master')",
  2081. "name": "sha",
  2082. "in": "query"
  2083. },
  2084. {
  2085. "type": "integer",
  2086. "description": "page number of results to return (1-based)",
  2087. "name": "page",
  2088. "in": "query"
  2089. },
  2090. {
  2091. "type": "integer",
  2092. "description": "page size of results, maximum page size is 50",
  2093. "name": "limit",
  2094. "in": "query"
  2095. }
  2096. ],
  2097. "responses": {
  2098. "200": {
  2099. "$ref": "#/responses/CommitList"
  2100. },
  2101. "404": {
  2102. "$ref": "#/responses/notFound"
  2103. },
  2104. "409": {
  2105. "$ref": "#/responses/EmptyRepository"
  2106. }
  2107. }
  2108. }
  2109. },
  2110. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2111. "get": {
  2112. "produces": [
  2113. "application/json"
  2114. ],
  2115. "tags": [
  2116. "repository"
  2117. ],
  2118. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2119. "operationId": "repoGetCombinedStatusByRef",
  2120. "parameters": [
  2121. {
  2122. "type": "string",
  2123. "description": "owner of the repo",
  2124. "name": "owner",
  2125. "in": "path",
  2126. "required": true
  2127. },
  2128. {
  2129. "type": "string",
  2130. "description": "name of the repo",
  2131. "name": "repo",
  2132. "in": "path",
  2133. "required": true
  2134. },
  2135. {
  2136. "type": "string",
  2137. "description": "name of branch/tag/commit",
  2138. "name": "ref",
  2139. "in": "path",
  2140. "required": true
  2141. },
  2142. {
  2143. "type": "integer",
  2144. "description": "page number of results",
  2145. "name": "page",
  2146. "in": "query"
  2147. }
  2148. ],
  2149. "responses": {
  2150. "200": {
  2151. "$ref": "#/responses/Status"
  2152. },
  2153. "400": {
  2154. "$ref": "#/responses/error"
  2155. }
  2156. }
  2157. }
  2158. },
  2159. "/repos/{owner}/{repo}/contents": {
  2160. "get": {
  2161. "produces": [
  2162. "application/json"
  2163. ],
  2164. "tags": [
  2165. "repository"
  2166. ],
  2167. "summary": "Gets the metadata of all the entries of the root dir",
  2168. "operationId": "repoGetContentsList",
  2169. "parameters": [
  2170. {
  2171. "type": "string",
  2172. "description": "owner of the repo",
  2173. "name": "owner",
  2174. "in": "path",
  2175. "required": true
  2176. },
  2177. {
  2178. "type": "string",
  2179. "description": "name of the repo",
  2180. "name": "repo",
  2181. "in": "path",
  2182. "required": true
  2183. },
  2184. {
  2185. "type": "string",
  2186. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2187. "name": "ref",
  2188. "in": "query"
  2189. }
  2190. ],
  2191. "responses": {
  2192. "200": {
  2193. "$ref": "#/responses/ContentsListResponse"
  2194. }
  2195. }
  2196. }
  2197. },
  2198. "/repos/{owner}/{repo}/contents/{filepath}": {
  2199. "get": {
  2200. "produces": [
  2201. "application/json"
  2202. ],
  2203. "tags": [
  2204. "repository"
  2205. ],
  2206. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2207. "operationId": "repoGetContents",
  2208. "parameters": [
  2209. {
  2210. "type": "string",
  2211. "description": "owner of the repo",
  2212. "name": "owner",
  2213. "in": "path",
  2214. "required": true
  2215. },
  2216. {
  2217. "type": "string",
  2218. "description": "name of the repo",
  2219. "name": "repo",
  2220. "in": "path",
  2221. "required": true
  2222. },
  2223. {
  2224. "type": "string",
  2225. "description": "path of the dir, file, symlink or submodule in the repo",
  2226. "name": "filepath",
  2227. "in": "path",
  2228. "required": true
  2229. },
  2230. {
  2231. "type": "string",
  2232. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2233. "name": "ref",
  2234. "in": "query"
  2235. }
  2236. ],
  2237. "responses": {
  2238. "200": {
  2239. "$ref": "#/responses/ContentsResponse"
  2240. }
  2241. }
  2242. },
  2243. "put": {
  2244. "consumes": [
  2245. "application/json"
  2246. ],
  2247. "produces": [
  2248. "application/json"
  2249. ],
  2250. "tags": [
  2251. "repository"
  2252. ],
  2253. "summary": "Update a file in a repository",
  2254. "operationId": "repoUpdateFile",
  2255. "parameters": [
  2256. {
  2257. "type": "string",
  2258. "description": "owner of the repo",
  2259. "name": "owner",
  2260. "in": "path",
  2261. "required": true
  2262. },
  2263. {
  2264. "type": "string",
  2265. "description": "name of the repo",
  2266. "name": "repo",
  2267. "in": "path",
  2268. "required": true
  2269. },
  2270. {
  2271. "type": "string",
  2272. "description": "path of the file to update",
  2273. "name": "filepath",
  2274. "in": "path",
  2275. "required": true
  2276. },
  2277. {
  2278. "name": "body",
  2279. "in": "body",
  2280. "required": true,
  2281. "schema": {
  2282. "$ref": "#/definitions/UpdateFileOptions"
  2283. }
  2284. }
  2285. ],
  2286. "responses": {
  2287. "200": {
  2288. "$ref": "#/responses/FileResponse"
  2289. }
  2290. }
  2291. },
  2292. "post": {
  2293. "consumes": [
  2294. "application/json"
  2295. ],
  2296. "produces": [
  2297. "application/json"
  2298. ],
  2299. "tags": [
  2300. "repository"
  2301. ],
  2302. "summary": "Create a file in a repository",
  2303. "operationId": "repoCreateFile",
  2304. "parameters": [
  2305. {
  2306. "type": "string",
  2307. "description": "owner of the repo",
  2308. "name": "owner",
  2309. "in": "path",
  2310. "required": true
  2311. },
  2312. {
  2313. "type": "string",
  2314. "description": "name of the repo",
  2315. "name": "repo",
  2316. "in": "path",
  2317. "required": true
  2318. },
  2319. {
  2320. "type": "string",
  2321. "description": "path of the file to create",
  2322. "name": "filepath",
  2323. "in": "path",
  2324. "required": true
  2325. },
  2326. {
  2327. "name": "body",
  2328. "in": "body",
  2329. "required": true,
  2330. "schema": {
  2331. "$ref": "#/definitions/CreateFileOptions"
  2332. }
  2333. }
  2334. ],
  2335. "responses": {
  2336. "201": {
  2337. "$ref": "#/responses/FileResponse"
  2338. }
  2339. }
  2340. },
  2341. "delete": {
  2342. "consumes": [
  2343. "application/json"
  2344. ],
  2345. "produces": [
  2346. "application/json"
  2347. ],
  2348. "tags": [
  2349. "repository"
  2350. ],
  2351. "summary": "Delete a file in a repository",
  2352. "operationId": "repoDeleteFile",
  2353. "parameters": [
  2354. {
  2355. "type": "string",
  2356. "description": "owner of the repo",
  2357. "name": "owner",
  2358. "in": "path",
  2359. "required": true
  2360. },
  2361. {
  2362. "type": "string",
  2363. "description": "name of the repo",
  2364. "name": "repo",
  2365. "in": "path",
  2366. "required": true
  2367. },
  2368. {
  2369. "type": "string",
  2370. "description": "path of the file to delete",
  2371. "name": "filepath",
  2372. "in": "path",
  2373. "required": true
  2374. },
  2375. {
  2376. "name": "body",
  2377. "in": "body",
  2378. "required": true,
  2379. "schema": {
  2380. "$ref": "#/definitions/DeleteFileOptions"
  2381. }
  2382. }
  2383. ],
  2384. "responses": {
  2385. "200": {
  2386. "$ref": "#/responses/FileDeleteResponse"
  2387. }
  2388. }
  2389. }
  2390. },
  2391. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2392. "get": {
  2393. "produces": [
  2394. "application/json"
  2395. ],
  2396. "tags": [
  2397. "repository"
  2398. ],
  2399. "summary": "Get the EditorConfig definitions of a file in a repository",
  2400. "operationId": "repoGetEditorConfig",
  2401. "parameters": [
  2402. {
  2403. "type": "string",
  2404. "description": "owner of the repo",
  2405. "name": "owner",
  2406. "in": "path",
  2407. "required": true
  2408. },
  2409. {
  2410. "type": "string",
  2411. "description": "name of the repo",
  2412. "name": "repo",
  2413. "in": "path",
  2414. "required": true
  2415. },
  2416. {
  2417. "type": "string",
  2418. "description": "filepath of file to get",
  2419. "name": "filepath",
  2420. "in": "path",
  2421. "required": true
  2422. }
  2423. ],
  2424. "responses": {
  2425. "200": {
  2426. "description": "success"
  2427. },
  2428. "404": {
  2429. "$ref": "#/responses/notFound"
  2430. }
  2431. }
  2432. }
  2433. },
  2434. "/repos/{owner}/{repo}/forks": {
  2435. "get": {
  2436. "produces": [
  2437. "application/json"
  2438. ],
  2439. "tags": [
  2440. "repository"
  2441. ],
  2442. "summary": "List a repository's forks",
  2443. "operationId": "listForks",
  2444. "parameters": [
  2445. {
  2446. "type": "string",
  2447. "description": "owner of the repo",
  2448. "name": "owner",
  2449. "in": "path",
  2450. "required": true
  2451. },
  2452. {
  2453. "type": "string",
  2454. "description": "name of the repo",
  2455. "name": "repo",
  2456. "in": "path",
  2457. "required": true
  2458. },
  2459. {
  2460. "type": "integer",
  2461. "description": "page number of results to return (1-based)",
  2462. "name": "page",
  2463. "in": "query"
  2464. },
  2465. {
  2466. "type": "integer",
  2467. "description": "page size of results, maximum page size is 50",
  2468. "name": "limit",
  2469. "in": "query"
  2470. }
  2471. ],
  2472. "responses": {
  2473. "200": {
  2474. "$ref": "#/responses/RepositoryList"
  2475. }
  2476. }
  2477. },
  2478. "post": {
  2479. "produces": [
  2480. "application/json"
  2481. ],
  2482. "tags": [
  2483. "repository"
  2484. ],
  2485. "summary": "Fork a repository",
  2486. "operationId": "createFork",
  2487. "parameters": [
  2488. {
  2489. "type": "string",
  2490. "description": "owner of the repo to fork",
  2491. "name": "owner",
  2492. "in": "path",
  2493. "required": true
  2494. },
  2495. {
  2496. "type": "string",
  2497. "description": "name of the repo to fork",
  2498. "name": "repo",
  2499. "in": "path",
  2500. "required": true
  2501. },
  2502. {
  2503. "name": "body",
  2504. "in": "body",
  2505. "schema": {
  2506. "$ref": "#/definitions/CreateForkOption"
  2507. }
  2508. }
  2509. ],
  2510. "responses": {
  2511. "202": {
  2512. "$ref": "#/responses/Repository"
  2513. },
  2514. "403": {
  2515. "$ref": "#/responses/forbidden"
  2516. },
  2517. "422": {
  2518. "$ref": "#/responses/validationError"
  2519. }
  2520. }
  2521. }
  2522. },
  2523. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  2524. "get": {
  2525. "produces": [
  2526. "application/json"
  2527. ],
  2528. "tags": [
  2529. "repository"
  2530. ],
  2531. "summary": "Gets the blob of a repository.",
  2532. "operationId": "GetBlob",
  2533. "parameters": [
  2534. {
  2535. "type": "string",
  2536. "description": "owner of the repo",
  2537. "name": "owner",
  2538. "in": "path",
  2539. "required": true
  2540. },
  2541. {
  2542. "type": "string",
  2543. "description": "name of the repo",
  2544. "name": "repo",
  2545. "in": "path",
  2546. "required": true
  2547. },
  2548. {
  2549. "type": "string",
  2550. "description": "sha of the commit",
  2551. "name": "sha",
  2552. "in": "path",
  2553. "required": true
  2554. }
  2555. ],
  2556. "responses": {
  2557. "200": {
  2558. "$ref": "#/responses/GitBlobResponse"
  2559. },
  2560. "400": {
  2561. "$ref": "#/responses/error"
  2562. }
  2563. }
  2564. }
  2565. },
  2566. "/repos/{owner}/{repo}/git/commits/{sha}": {
  2567. "get": {
  2568. "produces": [
  2569. "application/json"
  2570. ],
  2571. "tags": [
  2572. "repository"
  2573. ],
  2574. "summary": "Get a single commit from a repository",
  2575. "operationId": "repoGetSingleCommit",
  2576. "parameters": [
  2577. {
  2578. "type": "string",
  2579. "description": "owner of the repo",
  2580. "name": "owner",
  2581. "in": "path",
  2582. "required": true
  2583. },
  2584. {
  2585. "type": "string",
  2586. "description": "name of the repo",
  2587. "name": "repo",
  2588. "in": "path",
  2589. "required": true
  2590. },
  2591. {
  2592. "type": "string",
  2593. "description": "the commit hash",
  2594. "name": "sha",
  2595. "in": "path",
  2596. "required": true
  2597. }
  2598. ],
  2599. "responses": {
  2600. "200": {
  2601. "$ref": "#/responses/Commit"
  2602. },
  2603. "404": {
  2604. "$ref": "#/responses/notFound"
  2605. }
  2606. }
  2607. }
  2608. },
  2609. "/repos/{owner}/{repo}/git/refs": {
  2610. "get": {
  2611. "produces": [
  2612. "application/json"
  2613. ],
  2614. "tags": [
  2615. "repository"
  2616. ],
  2617. "summary": "Get specified ref or filtered repository's refs",
  2618. "operationId": "repoListAllGitRefs",
  2619. "parameters": [
  2620. {
  2621. "type": "string",
  2622. "description": "owner of the repo",
  2623. "name": "owner",
  2624. "in": "path",
  2625. "required": true
  2626. },
  2627. {
  2628. "type": "string",
  2629. "description": "name of the repo",
  2630. "name": "repo",
  2631. "in": "path",
  2632. "required": true
  2633. }
  2634. ],
  2635. "responses": {
  2636. "200": {
  2637. "$ref": "#/responses/ReferenceList"
  2638. },
  2639. "404": {
  2640. "$ref": "#/responses/notFound"
  2641. }
  2642. }
  2643. }
  2644. },
  2645. "/repos/{owner}/{repo}/git/refs/{ref}": {
  2646. "get": {
  2647. "produces": [
  2648. "application/json"
  2649. ],
  2650. "tags": [
  2651. "repository"
  2652. ],
  2653. "summary": "Get specified ref or filtered repository's refs",
  2654. "operationId": "repoListGitRefs",
  2655. "parameters": [
  2656. {
  2657. "type": "string",
  2658. "description": "owner of the repo",
  2659. "name": "owner",
  2660. "in": "path",
  2661. "required": true
  2662. },
  2663. {
  2664. "type": "string",
  2665. "description": "name of the repo",
  2666. "name": "repo",
  2667. "in": "path",
  2668. "required": true
  2669. },
  2670. {
  2671. "type": "string",
  2672. "description": "part or full name of the ref",
  2673. "name": "ref",
  2674. "in": "path",
  2675. "required": true
  2676. }
  2677. ],
  2678. "responses": {
  2679. "200": {
  2680. "$ref": "#/responses/ReferenceList"
  2681. },
  2682. "404": {
  2683. "$ref": "#/responses/notFound"
  2684. }
  2685. }
  2686. }
  2687. },
  2688. "/repos/{owner}/{repo}/git/tags/{sha}": {
  2689. "get": {
  2690. "produces": [
  2691. "application/json"
  2692. ],
  2693. "tags": [
  2694. "repository"
  2695. ],
  2696. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  2697. "operationId": "GetTag",
  2698. "parameters": [
  2699. {
  2700. "type": "string",
  2701. "description": "owner of the repo",
  2702. "name": "owner",
  2703. "in": "path",
  2704. "required": true
  2705. },
  2706. {
  2707. "type": "string",
  2708. "description": "name of the repo",
  2709. "name": "repo",
  2710. "in": "path",
  2711. "required": true
  2712. },
  2713. {
  2714. "type": "string",
  2715. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  2716. "name": "sha",
  2717. "in": "path",
  2718. "required": true
  2719. }
  2720. ],
  2721. "responses": {
  2722. "200": {
  2723. "$ref": "#/responses/AnnotatedTag"
  2724. },
  2725. "400": {
  2726. "$ref": "#/responses/error"
  2727. }
  2728. }
  2729. }
  2730. },
  2731. "/repos/{owner}/{repo}/git/trees/{sha}": {
  2732. "get": {
  2733. "produces": [
  2734. "application/json"
  2735. ],
  2736. "tags": [
  2737. "repository"
  2738. ],
  2739. "summary": "Gets the tree of a repository.",
  2740. "operationId": "GetTree",
  2741. "parameters": [
  2742. {
  2743. "type": "string",
  2744. "description": "owner of the repo",
  2745. "name": "owner",
  2746. "in": "path",
  2747. "required": true
  2748. },
  2749. {
  2750. "type": "string",
  2751. "description": "name of the repo",
  2752. "name": "repo",
  2753. "in": "path",
  2754. "required": true
  2755. },
  2756. {
  2757. "type": "string",
  2758. "description": "sha of the commit",
  2759. "name": "sha",
  2760. "in": "path",
  2761. "required": true
  2762. },
  2763. {
  2764. "type": "boolean",
  2765. "description": "show all directories and files",
  2766. "name": "recursive",
  2767. "in": "query"
  2768. },
  2769. {
  2770. "type": "integer",
  2771. "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",
  2772. "name": "page",
  2773. "in": "query"
  2774. },
  2775. {
  2776. "type": "integer",
  2777. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  2778. "name": "per_page",
  2779. "in": "query"
  2780. }
  2781. ],
  2782. "responses": {
  2783. "200": {
  2784. "$ref": "#/responses/GitTreeResponse"
  2785. },
  2786. "400": {
  2787. "$ref": "#/responses/error"
  2788. }
  2789. }
  2790. }
  2791. },
  2792. "/repos/{owner}/{repo}/hooks": {
  2793. "get": {
  2794. "produces": [
  2795. "application/json"
  2796. ],
  2797. "tags": [
  2798. "repository"
  2799. ],
  2800. "summary": "List the hooks in a repository",
  2801. "operationId": "repoListHooks",
  2802. "parameters": [
  2803. {
  2804. "type": "string",
  2805. "description": "owner of the repo",
  2806. "name": "owner",
  2807. "in": "path",
  2808. "required": true
  2809. },
  2810. {
  2811. "type": "string",
  2812. "description": "name of the repo",
  2813. "name": "repo",
  2814. "in": "path",
  2815. "required": true
  2816. },
  2817. {
  2818. "type": "integer",
  2819. "description": "page number of results to return (1-based)",
  2820. "name": "page",
  2821. "in": "query"
  2822. },
  2823. {
  2824. "type": "integer",
  2825. "description": "page size of results, maximum page size is 50",
  2826. "name": "limit",
  2827. "in": "query"
  2828. }
  2829. ],
  2830. "responses": {
  2831. "200": {
  2832. "$ref": "#/responses/HookList"
  2833. }
  2834. }
  2835. },
  2836. "post": {
  2837. "consumes": [
  2838. "application/json"
  2839. ],
  2840. "produces": [
  2841. "application/json"
  2842. ],
  2843. "tags": [
  2844. "repository"
  2845. ],
  2846. "summary": "Create a hook",
  2847. "operationId": "repoCreateHook",
  2848. "parameters": [
  2849. {
  2850. "type": "string",
  2851. "description": "owner of the repo",
  2852. "name": "owner",
  2853. "in": "path",
  2854. "required": true
  2855. },
  2856. {
  2857. "type": "string",
  2858. "description": "name of the repo",
  2859. "name": "repo",
  2860. "in": "path",
  2861. "required": true
  2862. },
  2863. {
  2864. "name": "body",
  2865. "in": "body",
  2866. "schema": {
  2867. "$ref": "#/definitions/CreateHookOption"
  2868. }
  2869. }
  2870. ],
  2871. "responses": {
  2872. "201": {
  2873. "$ref": "#/responses/Hook"
  2874. }
  2875. }
  2876. }
  2877. },
  2878. "/repos/{owner}/{repo}/hooks/git": {
  2879. "get": {
  2880. "produces": [
  2881. "application/json"
  2882. ],
  2883. "tags": [
  2884. "repository"
  2885. ],
  2886. "summary": "List the Git hooks in a repository",
  2887. "operationId": "repoListGitHooks",
  2888. "parameters": [
  2889. {
  2890. "type": "string",
  2891. "description": "owner of the repo",
  2892. "name": "owner",
  2893. "in": "path",
  2894. "required": true
  2895. },
  2896. {
  2897. "type": "string",
  2898. "description": "name of the repo",
  2899. "name": "repo",
  2900. "in": "path",
  2901. "required": true
  2902. }
  2903. ],
  2904. "responses": {
  2905. "200": {
  2906. "$ref": "#/responses/GitHookList"
  2907. }
  2908. }
  2909. }
  2910. },
  2911. "/repos/{owner}/{repo}/hooks/git/{id}": {
  2912. "get": {
  2913. "produces": [
  2914. "application/json"
  2915. ],
  2916. "tags": [
  2917. "repository"
  2918. ],
  2919. "summary": "Get a Git hook",
  2920. "operationId": "repoGetGitHook",
  2921. "parameters": [
  2922. {
  2923. "type": "string",
  2924. "description": "owner of the repo",
  2925. "name": "owner",
  2926. "in": "path",
  2927. "required": true
  2928. },
  2929. {
  2930. "type": "string",
  2931. "description": "name of the repo",
  2932. "name": "repo",
  2933. "in": "path",
  2934. "required": true
  2935. },
  2936. {
  2937. "type": "string",
  2938. "description": "id of the hook to get",
  2939. "name": "id",
  2940. "in": "path",
  2941. "required": true
  2942. }
  2943. ],
  2944. "responses": {
  2945. "200": {
  2946. "$ref": "#/responses/GitHook"
  2947. },
  2948. "404": {
  2949. "$ref": "#/responses/notFound"
  2950. }
  2951. }
  2952. },
  2953. "delete": {
  2954. "produces": [
  2955. "application/json"
  2956. ],
  2957. "tags": [
  2958. "repository"
  2959. ],
  2960. "summary": "Delete a Git hook in a repository",
  2961. "operationId": "repoDeleteGitHook",
  2962. "parameters": [
  2963. {
  2964. "type": "string",
  2965. "description": "owner of the repo",
  2966. "name": "owner",
  2967. "in": "path",
  2968. "required": true
  2969. },
  2970. {
  2971. "type": "string",
  2972. "description": "name of the repo",
  2973. "name": "repo",
  2974. "in": "path",
  2975. "required": true
  2976. },
  2977. {
  2978. "type": "string",
  2979. "description": "id of the hook to get",
  2980. "name": "id",
  2981. "in": "path",
  2982. "required": true
  2983. }
  2984. ],
  2985. "responses": {
  2986. "204": {
  2987. "$ref": "#/responses/empty"
  2988. },
  2989. "404": {
  2990. "$ref": "#/responses/notFound"
  2991. }
  2992. }
  2993. },
  2994. "patch": {
  2995. "produces": [
  2996. "application/json"
  2997. ],
  2998. "tags": [
  2999. "repository"
  3000. ],
  3001. "summary": "Edit a Git hook in a repository",
  3002. "operationId": "repoEditGitHook",
  3003. "parameters": [
  3004. {
  3005. "type": "string",
  3006. "description": "owner of the repo",
  3007. "name": "owner",
  3008. "in": "path",
  3009. "required": true
  3010. },
  3011. {
  3012. "type": "string",
  3013. "description": "name of the repo",
  3014. "name": "repo",
  3015. "in": "path",
  3016. "required": true
  3017. },
  3018. {
  3019. "type": "string",
  3020. "description": "id of the hook to get",
  3021. "name": "id",
  3022. "in": "path",
  3023. "required": true
  3024. },
  3025. {
  3026. "name": "body",
  3027. "in": "body",
  3028. "schema": {
  3029. "$ref": "#/definitions/EditGitHookOption"
  3030. }
  3031. }
  3032. ],
  3033. "responses": {
  3034. "200": {
  3035. "$ref": "#/responses/GitHook"
  3036. },
  3037. "404": {
  3038. "$ref": "#/responses/notFound"
  3039. }
  3040. }
  3041. }
  3042. },
  3043. "/repos/{owner}/{repo}/hooks/{id}": {
  3044. "get": {
  3045. "produces": [
  3046. "application/json"
  3047. ],
  3048. "tags": [
  3049. "repository"
  3050. ],
  3051. "summary": "Get a hook",
  3052. "operationId": "repoGetHook",
  3053. "parameters": [
  3054. {
  3055. "type": "string",
  3056. "description": "owner of the repo",
  3057. "name": "owner",
  3058. "in": "path",
  3059. "required": true
  3060. },
  3061. {
  3062. "type": "string",
  3063. "description": "name of the repo",
  3064. "name": "repo",
  3065. "in": "path",
  3066. "required": true
  3067. },
  3068. {
  3069. "type": "integer",
  3070. "format": "int64",
  3071. "description": "id of the hook to get",
  3072. "name": "id",
  3073. "in": "path",
  3074. "required": true
  3075. }
  3076. ],
  3077. "responses": {
  3078. "200": {
  3079. "$ref": "#/responses/Hook"
  3080. },
  3081. "404": {
  3082. "$ref": "#/responses/notFound"
  3083. }
  3084. }
  3085. },
  3086. "delete": {
  3087. "produces": [
  3088. "application/json"
  3089. ],
  3090. "tags": [
  3091. "repository"
  3092. ],
  3093. "summary": "Delete a hook in a repository",
  3094. "operationId": "repoDeleteHook",
  3095. "parameters": [
  3096. {
  3097. "type": "string",
  3098. "description": "owner of the repo",
  3099. "name": "owner",
  3100. "in": "path",
  3101. "required": true
  3102. },
  3103. {
  3104. "type": "string",
  3105. "description": "name of the repo",
  3106. "name": "repo",
  3107. "in": "path",
  3108. "required": true
  3109. },
  3110. {
  3111. "type": "integer",
  3112. "format": "int64",
  3113. "description": "id of the hook to delete",
  3114. "name": "id",
  3115. "in": "path",
  3116. "required": true
  3117. }
  3118. ],
  3119. "responses": {
  3120. "204": {
  3121. "$ref": "#/responses/empty"
  3122. },
  3123. "404": {
  3124. "$ref": "#/responses/notFound"
  3125. }
  3126. }
  3127. },
  3128. "patch": {
  3129. "produces": [
  3130. "application/json"
  3131. ],
  3132. "tags": [
  3133. "repository"
  3134. ],
  3135. "summary": "Edit a hook in a repository",
  3136. "operationId": "repoEditHook",
  3137. "parameters": [
  3138. {
  3139. "type": "string",
  3140. "description": "owner of the repo",
  3141. "name": "owner",
  3142. "in": "path",
  3143. "required": true
  3144. },
  3145. {
  3146. "type": "string",
  3147. "description": "name of the repo",
  3148. "name": "repo",
  3149. "in": "path",
  3150. "required": true
  3151. },
  3152. {
  3153. "type": "integer",
  3154. "format": "int64",
  3155. "description": "index of the hook",
  3156. "name": "id",
  3157. "in": "path",
  3158. "required": true
  3159. },
  3160. {
  3161. "name": "body",
  3162. "in": "body",
  3163. "schema": {
  3164. "$ref": "#/definitions/EditHookOption"
  3165. }
  3166. }
  3167. ],
  3168. "responses": {
  3169. "200": {
  3170. "$ref": "#/responses/Hook"
  3171. }
  3172. }
  3173. }
  3174. },
  3175. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3176. "post": {
  3177. "produces": [
  3178. "application/json"
  3179. ],
  3180. "tags": [
  3181. "repository"
  3182. ],
  3183. "summary": "Test a push webhook",
  3184. "operationId": "repoTestHook",
  3185. "parameters": [
  3186. {
  3187. "type": "string",
  3188. "description": "owner of the repo",
  3189. "name": "owner",
  3190. "in": "path",
  3191. "required": true
  3192. },
  3193. {
  3194. "type": "string",
  3195. "description": "name of the repo",
  3196. "name": "repo",
  3197. "in": "path",
  3198. "required": true
  3199. },
  3200. {
  3201. "type": "integer",
  3202. "format": "int64",
  3203. "description": "id of the hook to test",
  3204. "name": "id",
  3205. "in": "path",
  3206. "required": true
  3207. }
  3208. ],
  3209. "responses": {
  3210. "204": {
  3211. "$ref": "#/responses/empty"
  3212. }
  3213. }
  3214. }
  3215. },
  3216. "/repos/{owner}/{repo}/issues": {
  3217. "get": {
  3218. "produces": [
  3219. "application/json"
  3220. ],
  3221. "tags": [
  3222. "issue"
  3223. ],
  3224. "summary": "List a repository's issues",
  3225. "operationId": "issueListIssues",
  3226. "parameters": [
  3227. {
  3228. "type": "string",
  3229. "description": "owner of the repo",
  3230. "name": "owner",
  3231. "in": "path",
  3232. "required": true
  3233. },
  3234. {
  3235. "type": "string",
  3236. "description": "name of the repo",
  3237. "name": "repo",
  3238. "in": "path",
  3239. "required": true
  3240. },
  3241. {
  3242. "type": "string",
  3243. "description": "whether issue is open or closed",
  3244. "name": "state",
  3245. "in": "query"
  3246. },
  3247. {
  3248. "type": "string",
  3249. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3250. "name": "labels",
  3251. "in": "query"
  3252. },
  3253. {
  3254. "type": "string",
  3255. "description": "search string",
  3256. "name": "q",
  3257. "in": "query"
  3258. },
  3259. {
  3260. "type": "string",
  3261. "description": "filter by type (issues / pulls) if set",
  3262. "name": "type",
  3263. "in": "query"
  3264. },
  3265. {
  3266. "type": "integer",
  3267. "description": "page number of results to return (1-based)",
  3268. "name": "page",
  3269. "in": "query"
  3270. },
  3271. {
  3272. "type": "integer",
  3273. "description": "page size of results, maximum page size is 50",
  3274. "name": "limit",
  3275. "in": "query"
  3276. }
  3277. ],
  3278. "responses": {
  3279. "200": {
  3280. "$ref": "#/responses/IssueList"
  3281. }
  3282. }
  3283. },
  3284. "post": {
  3285. "consumes": [
  3286. "application/json"
  3287. ],
  3288. "produces": [
  3289. "application/json"
  3290. ],
  3291. "tags": [
  3292. "issue"
  3293. ],
  3294. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3295. "operationId": "issueCreateIssue",
  3296. "parameters": [
  3297. {
  3298. "type": "string",
  3299. "description": "owner of the repo",
  3300. "name": "owner",
  3301. "in": "path",
  3302. "required": true
  3303. },
  3304. {
  3305. "type": "string",
  3306. "description": "name of the repo",
  3307. "name": "repo",
  3308. "in": "path",
  3309. "required": true
  3310. },
  3311. {
  3312. "name": "body",
  3313. "in": "body",
  3314. "schema": {
  3315. "$ref": "#/definitions/CreateIssueOption"
  3316. }
  3317. }
  3318. ],
  3319. "responses": {
  3320. "201": {
  3321. "$ref": "#/responses/Issue"
  3322. },
  3323. "403": {
  3324. "$ref": "#/responses/forbidden"
  3325. },
  3326. "412": {
  3327. "$ref": "#/responses/error"
  3328. },
  3329. "422": {
  3330. "$ref": "#/responses/validationError"
  3331. }
  3332. }
  3333. }
  3334. },
  3335. "/repos/{owner}/{repo}/issues/comments": {
  3336. "get": {
  3337. "produces": [
  3338. "application/json"
  3339. ],
  3340. "tags": [
  3341. "issue"
  3342. ],
  3343. "summary": "List all comments in a repository",
  3344. "operationId": "issueGetRepoComments",
  3345. "parameters": [
  3346. {
  3347. "type": "string",
  3348. "description": "owner of the repo",
  3349. "name": "owner",
  3350. "in": "path",
  3351. "required": true
  3352. },
  3353. {
  3354. "type": "string",
  3355. "description": "name of the repo",
  3356. "name": "repo",
  3357. "in": "path",
  3358. "required": true
  3359. },
  3360. {
  3361. "type": "string",
  3362. "format": "date-time",
  3363. "description": "if provided, only comments updated since the provided time are returned.",
  3364. "name": "since",
  3365. "in": "query"
  3366. },
  3367. {
  3368. "type": "string",
  3369. "format": "date-time",
  3370. "description": "if provided, only comments updated before the provided time are returned.",
  3371. "name": "before",
  3372. "in": "query"
  3373. },
  3374. {
  3375. "type": "integer",
  3376. "description": "page number of results to return (1-based)",
  3377. "name": "page",
  3378. "in": "query"
  3379. },
  3380. {
  3381. "type": "integer",
  3382. "description": "page size of results, maximum page size is 50",
  3383. "name": "limit",
  3384. "in": "query"
  3385. }
  3386. ],
  3387. "responses": {
  3388. "200": {
  3389. "$ref": "#/responses/CommentList"
  3390. }
  3391. }
  3392. }
  3393. },
  3394. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3395. "get": {
  3396. "consumes": [
  3397. "application/json"
  3398. ],
  3399. "produces": [
  3400. "application/json"
  3401. ],
  3402. "tags": [
  3403. "issue"
  3404. ],
  3405. "summary": "Get a comment",
  3406. "operationId": "issueGetComment",
  3407. "parameters": [
  3408. {
  3409. "type": "string",
  3410. "description": "owner of the repo",
  3411. "name": "owner",
  3412. "in": "path",
  3413. "required": true
  3414. },
  3415. {
  3416. "type": "string",
  3417. "description": "name of the repo",
  3418. "name": "repo",
  3419. "in": "path",
  3420. "required": true
  3421. },
  3422. {
  3423. "type": "integer",
  3424. "format": "int64",
  3425. "description": "id of the comment",
  3426. "name": "id",
  3427. "in": "path",
  3428. "required": true
  3429. }
  3430. ],
  3431. "responses": {
  3432. "200": {
  3433. "$ref": "#/responses/Comment"
  3434. },
  3435. "204": {
  3436. "$ref": "#/responses/empty"
  3437. },
  3438. "403": {
  3439. "$ref": "#/responses/forbidden"
  3440. },
  3441. "404": {
  3442. "$ref": "#/responses/notFound"
  3443. }
  3444. }
  3445. },
  3446. "delete": {
  3447. "tags": [
  3448. "issue"
  3449. ],
  3450. "summary": "Delete a comment",
  3451. "operationId": "issueDeleteComment",
  3452. "parameters": [
  3453. {
  3454. "type": "string",
  3455. "description": "owner of the repo",
  3456. "name": "owner",
  3457. "in": "path",
  3458. "required": true
  3459. },
  3460. {
  3461. "type": "string",
  3462. "description": "name of the repo",
  3463. "name": "repo",
  3464. "in": "path",
  3465. "required": true
  3466. },
  3467. {
  3468. "type": "integer",
  3469. "format": "int64",
  3470. "description": "id of comment to delete",
  3471. "name": "id",
  3472. "in": "path",
  3473. "required": true
  3474. }
  3475. ],
  3476. "responses": {
  3477. "204": {
  3478. "$ref": "#/responses/empty"
  3479. },
  3480. "403": {
  3481. "$ref": "#/responses/forbidden"
  3482. },
  3483. "404": {
  3484. "$ref": "#/responses/notFound"
  3485. }
  3486. }
  3487. },
  3488. "patch": {
  3489. "consumes": [
  3490. "application/json"
  3491. ],
  3492. "produces": [
  3493. "application/json"
  3494. ],
  3495. "tags": [
  3496. "issue"
  3497. ],
  3498. "summary": "Edit a comment",
  3499. "operationId": "issueEditComment",
  3500. "parameters": [
  3501. {
  3502. "type": "string",
  3503. "description": "owner of the repo",
  3504. "name": "owner",
  3505. "in": "path",
  3506. "required": true
  3507. },
  3508. {
  3509. "type": "string",
  3510. "description": "name of the repo",
  3511. "name": "repo",
  3512. "in": "path",
  3513. "required": true
  3514. },
  3515. {
  3516. "type": "integer",
  3517. "format": "int64",
  3518. "description": "id of the comment to edit",
  3519. "name": "id",
  3520. "in": "path",
  3521. "required": true
  3522. },
  3523. {
  3524. "name": "body",
  3525. "in": "body",
  3526. "schema": {
  3527. "$ref": "#/definitions/EditIssueCommentOption"
  3528. }
  3529. }
  3530. ],
  3531. "responses": {
  3532. "200": {
  3533. "$ref": "#/responses/Comment"
  3534. },
  3535. "204": {
  3536. "$ref": "#/responses/empty"
  3537. },
  3538. "403": {
  3539. "$ref": "#/responses/forbidden"
  3540. },
  3541. "404": {
  3542. "$ref": "#/responses/notFound"
  3543. }
  3544. }
  3545. }
  3546. },
  3547. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  3548. "get": {
  3549. "consumes": [
  3550. "application/json"
  3551. ],
  3552. "produces": [
  3553. "application/json"
  3554. ],
  3555. "tags": [
  3556. "issue"
  3557. ],
  3558. "summary": "Get a list of reactions from a comment of an issue",
  3559. "operationId": "issueGetCommentReactions",
  3560. "parameters": [
  3561. {
  3562. "type": "string",
  3563. "description": "owner of the repo",
  3564. "name": "owner",
  3565. "in": "path",
  3566. "required": true
  3567. },
  3568. {
  3569. "type": "string",
  3570. "description": "name of the repo",
  3571. "name": "repo",
  3572. "in": "path",
  3573. "required": true
  3574. },
  3575. {
  3576. "type": "integer",
  3577. "format": "int64",
  3578. "description": "id of the comment to edit",
  3579. "name": "id",
  3580. "in": "path",
  3581. "required": true
  3582. }
  3583. ],
  3584. "responses": {
  3585. "200": {
  3586. "$ref": "#/responses/ReactionList"
  3587. },
  3588. "403": {
  3589. "$ref": "#/responses/forbidden"
  3590. }
  3591. }
  3592. },
  3593. "post": {
  3594. "consumes": [
  3595. "application/json"
  3596. ],
  3597. "produces": [
  3598. "application/json"
  3599. ],
  3600. "tags": [
  3601. "issue"
  3602. ],
  3603. "summary": "Add a reaction to a comment of an issue",
  3604. "operationId": "issuePostCommentReaction",
  3605. "parameters": [
  3606. {
  3607. "type": "string",
  3608. "description": "owner of the repo",
  3609. "name": "owner",
  3610. "in": "path",
  3611. "required": true
  3612. },
  3613. {
  3614. "type": "string",
  3615. "description": "name of the repo",
  3616. "name": "repo",
  3617. "in": "path",
  3618. "required": true
  3619. },
  3620. {
  3621. "type": "integer",
  3622. "format": "int64",
  3623. "description": "id of the comment to edit",
  3624. "name": "id",
  3625. "in": "path",
  3626. "required": true
  3627. },
  3628. {
  3629. "name": "content",
  3630. "in": "body",
  3631. "schema": {
  3632. "$ref": "#/definitions/EditReactionOption"
  3633. }
  3634. }
  3635. ],
  3636. "responses": {
  3637. "200": {
  3638. "$ref": "#/responses/Reaction"
  3639. },
  3640. "201": {
  3641. "$ref": "#/responses/Reaction"
  3642. },
  3643. "403": {
  3644. "$ref": "#/responses/forbidden"
  3645. }
  3646. }
  3647. },
  3648. "delete": {
  3649. "consumes": [
  3650. "application/json"
  3651. ],
  3652. "produces": [
  3653. "application/json"
  3654. ],
  3655. "tags": [
  3656. "issue"
  3657. ],
  3658. "summary": "Remove a reaction from a comment of an issue",
  3659. "operationId": "issueDeleteCommentReaction",
  3660. "parameters": [
  3661. {
  3662. "type": "string",
  3663. "description": "owner of the repo",
  3664. "name": "owner",
  3665. "in": "path",
  3666. "required": true
  3667. },
  3668. {
  3669. "type": "string",
  3670. "description": "name of the repo",
  3671. "name": "repo",
  3672. "in": "path",
  3673. "required": true
  3674. },
  3675. {
  3676. "type": "integer",
  3677. "format": "int64",
  3678. "description": "id of the comment to edit",
  3679. "name": "id",
  3680. "in": "path",
  3681. "required": true
  3682. },
  3683. {
  3684. "name": "content",
  3685. "in": "body",
  3686. "schema": {
  3687. "$ref": "#/definitions/EditReactionOption"
  3688. }
  3689. }
  3690. ],
  3691. "responses": {
  3692. "200": {
  3693. "$ref": "#/responses/empty"
  3694. },
  3695. "403": {
  3696. "$ref": "#/responses/forbidden"
  3697. }
  3698. }
  3699. }
  3700. },
  3701. "/repos/{owner}/{repo}/issues/{index}": {
  3702. "get": {
  3703. "produces": [
  3704. "application/json"
  3705. ],
  3706. "tags": [
  3707. "issue"
  3708. ],
  3709. "summary": "Get an issue",
  3710. "operationId": "issueGetIssue",
  3711. "parameters": [
  3712. {
  3713. "type": "string",
  3714. "description": "owner of the repo",
  3715. "name": "owner",
  3716. "in": "path",
  3717. "required": true
  3718. },
  3719. {
  3720. "type": "string",
  3721. "description": "name of the repo",
  3722. "name": "repo",
  3723. "in": "path",
  3724. "required": true
  3725. },
  3726. {
  3727. "type": "integer",
  3728. "format": "int64",
  3729. "description": "index of the issue to get",
  3730. "name": "index",
  3731. "in": "path",
  3732. "required": true
  3733. }
  3734. ],
  3735. "responses": {
  3736. "200": {
  3737. "$ref": "#/responses/Issue"
  3738. },
  3739. "404": {
  3740. "$ref": "#/responses/notFound"
  3741. }
  3742. }
  3743. },
  3744. "patch": {
  3745. "consumes": [
  3746. "application/json"
  3747. ],
  3748. "produces": [
  3749. "application/json"
  3750. ],
  3751. "tags": [
  3752. "issue"
  3753. ],
  3754. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3755. "operationId": "issueEditIssue",
  3756. "parameters": [
  3757. {
  3758. "type": "string",
  3759. "description": "owner of the repo",
  3760. "name": "owner",
  3761. "in": "path",
  3762. "required": true
  3763. },
  3764. {
  3765. "type": "string",
  3766. "description": "name of the repo",
  3767. "name": "repo",
  3768. "in": "path",
  3769. "required": true
  3770. },
  3771. {
  3772. "type": "integer",
  3773. "format": "int64",
  3774. "description": "index of the issue to edit",
  3775. "name": "index",
  3776. "in": "path",
  3777. "required": true
  3778. },
  3779. {
  3780. "name": "body",
  3781. "in": "body",
  3782. "schema": {
  3783. "$ref": "#/definitions/EditIssueOption"
  3784. }
  3785. }
  3786. ],
  3787. "responses": {
  3788. "201": {
  3789. "$ref": "#/responses/Issue"
  3790. },
  3791. "403": {
  3792. "$ref": "#/responses/forbidden"
  3793. },
  3794. "404": {
  3795. "$ref": "#/responses/notFound"
  3796. },
  3797. "412": {
  3798. "$ref": "#/responses/error"
  3799. }
  3800. }
  3801. }
  3802. },
  3803. "/repos/{owner}/{repo}/issues/{index}/comments": {
  3804. "get": {
  3805. "produces": [
  3806. "application/json"
  3807. ],
  3808. "tags": [
  3809. "issue"
  3810. ],
  3811. "summary": "List all comments on an issue",
  3812. "operationId": "issueGetComments",
  3813. "parameters": [
  3814. {
  3815. "type": "string",
  3816. "description": "owner of the repo",
  3817. "name": "owner",
  3818. "in": "path",
  3819. "required": true
  3820. },
  3821. {
  3822. "type": "string",
  3823. "description": "name of the repo",
  3824. "name": "repo",
  3825. "in": "path",
  3826. "required": true
  3827. },
  3828. {
  3829. "type": "integer",
  3830. "format": "int64",
  3831. "description": "index of the issue",
  3832. "name": "index",
  3833. "in": "path",
  3834. "required": true
  3835. },
  3836. {
  3837. "type": "string",
  3838. "format": "date-time",
  3839. "description": "if provided, only comments updated since the specified time are returned.",
  3840. "name": "since",
  3841. "in": "query"
  3842. },
  3843. {
  3844. "type": "string",
  3845. "format": "date-time",
  3846. "description": "if provided, only comments updated before the provided time are returned.",
  3847. "name": "before",
  3848. "in": "query"
  3849. }
  3850. ],
  3851. "responses": {
  3852. "200": {
  3853. "$ref": "#/responses/CommentList"
  3854. }
  3855. }
  3856. },
  3857. "post": {
  3858. "consumes": [
  3859. "application/json"
  3860. ],
  3861. "produces": [
  3862. "application/json"
  3863. ],
  3864. "tags": [
  3865. "issue"
  3866. ],
  3867. "summary": "Add a comment to an issue",
  3868. "operationId": "issueCreateComment",
  3869. "parameters": [
  3870. {
  3871. "type": "string",
  3872. "description": "owner of the repo",
  3873. "name": "owner",
  3874. "in": "path",
  3875. "required": true
  3876. },
  3877. {
  3878. "type": "string",
  3879. "description": "name of the repo",
  3880. "name": "repo",
  3881. "in": "path",
  3882. "required": true
  3883. },
  3884. {
  3885. "type": "integer",
  3886. "format": "int64",
  3887. "description": "index of the issue",
  3888. "name": "index",
  3889. "in": "path",
  3890. "required": true
  3891. },
  3892. {
  3893. "name": "body",
  3894. "in": "body",
  3895. "schema": {
  3896. "$ref": "#/definitions/CreateIssueCommentOption"
  3897. }
  3898. }
  3899. ],
  3900. "responses": {
  3901. "201": {
  3902. "$ref": "#/responses/Comment"
  3903. },
  3904. "403": {
  3905. "$ref": "#/responses/forbidden"
  3906. }
  3907. }
  3908. }
  3909. },
  3910. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  3911. "delete": {
  3912. "tags": [
  3913. "issue"
  3914. ],
  3915. "summary": "Delete a comment",
  3916. "operationId": "issueDeleteCommentDeprecated",
  3917. "deprecated": true,
  3918. "parameters": [
  3919. {
  3920. "type": "string",
  3921. "description": "owner of the repo",
  3922. "name": "owner",
  3923. "in": "path",
  3924. "required": true
  3925. },
  3926. {
  3927. "type": "string",
  3928. "description": "name of the repo",
  3929. "name": "repo",
  3930. "in": "path",
  3931. "required": true
  3932. },
  3933. {
  3934. "type": "integer",
  3935. "description": "this parameter is ignored",
  3936. "name": "index",
  3937. "in": "path",
  3938. "required": true
  3939. },
  3940. {
  3941. "type": "integer",
  3942. "format": "int64",
  3943. "description": "id of comment to delete",
  3944. "name": "id",
  3945. "in": "path",
  3946. "required": true
  3947. }
  3948. ],
  3949. "responses": {
  3950. "204": {
  3951. "$ref": "#/responses/empty"
  3952. },
  3953. "403": {
  3954. "$ref": "#/responses/forbidden"
  3955. },
  3956. "404": {
  3957. "$ref": "#/responses/notFound"
  3958. }
  3959. }
  3960. },
  3961. "patch": {
  3962. "consumes": [
  3963. "application/json"
  3964. ],
  3965. "produces": [
  3966. "application/json"
  3967. ],
  3968. "tags": [
  3969. "issue"
  3970. ],
  3971. "summary": "Edit a comment",
  3972. "operationId": "issueEditCommentDeprecated",
  3973. "deprecated": true,
  3974. "parameters": [
  3975. {
  3976. "type": "string",
  3977. "description": "owner of the repo",
  3978. "name": "owner",
  3979. "in": "path",
  3980. "required": true
  3981. },
  3982. {
  3983. "type": "string",
  3984. "description": "name of the repo",
  3985. "name": "repo",
  3986. "in": "path",
  3987. "required": true
  3988. },
  3989. {
  3990. "type": "integer",
  3991. "description": "this parameter is ignored",
  3992. "name": "index",
  3993. "in": "path",
  3994. "required": true
  3995. },
  3996. {
  3997. "type": "integer",
  3998. "format": "int64",
  3999. "description": "id of the comment to edit",
  4000. "name": "id",
  4001. "in": "path",
  4002. "required": true
  4003. },
  4004. {
  4005. "name": "body",
  4006. "in": "body",
  4007. "schema": {
  4008. "$ref": "#/definitions/EditIssueCommentOption"
  4009. }
  4010. }
  4011. ],
  4012. "responses": {
  4013. "200": {
  4014. "$ref": "#/responses/Comment"
  4015. },
  4016. "204": {
  4017. "$ref": "#/responses/empty"
  4018. },
  4019. "403": {
  4020. "$ref": "#/responses/forbidden"
  4021. },
  4022. "404": {
  4023. "$ref": "#/responses/notFound"
  4024. }
  4025. }
  4026. }
  4027. },
  4028. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4029. "post": {
  4030. "consumes": [
  4031. "application/json"
  4032. ],
  4033. "produces": [
  4034. "application/json"
  4035. ],
  4036. "tags": [
  4037. "issue"
  4038. ],
  4039. "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.",
  4040. "operationId": "issueEditIssueDeadline",
  4041. "parameters": [
  4042. {
  4043. "type": "string",
  4044. "description": "owner of the repo",
  4045. "name": "owner",
  4046. "in": "path",
  4047. "required": true
  4048. },
  4049. {
  4050. "type": "string",
  4051. "description": "name of the repo",
  4052. "name": "repo",
  4053. "in": "path",
  4054. "required": true
  4055. },
  4056. {
  4057. "type": "integer",
  4058. "format": "int64",
  4059. "description": "index of the issue to create or update a deadline on",
  4060. "name": "index",
  4061. "in": "path",
  4062. "required": true
  4063. },
  4064. {
  4065. "name": "body",
  4066. "in": "body",
  4067. "schema": {
  4068. "$ref": "#/definitions/EditDeadlineOption"
  4069. }
  4070. }
  4071. ],
  4072. "responses": {
  4073. "201": {
  4074. "$ref": "#/responses/IssueDeadline"
  4075. },
  4076. "403": {
  4077. "$ref": "#/responses/forbidden"
  4078. },
  4079. "404": {
  4080. "$ref": "#/responses/notFound"
  4081. }
  4082. }
  4083. }
  4084. },
  4085. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4086. "get": {
  4087. "produces": [
  4088. "application/json"
  4089. ],
  4090. "tags": [
  4091. "issue"
  4092. ],
  4093. "summary": "Get an issue's labels",
  4094. "operationId": "issueGetLabels",
  4095. "parameters": [
  4096. {
  4097. "type": "string",
  4098. "description": "owner of the repo",
  4099. "name": "owner",
  4100. "in": "path",
  4101. "required": true
  4102. },
  4103. {
  4104. "type": "string",
  4105. "description": "name of the repo",
  4106. "name": "repo",
  4107. "in": "path",
  4108. "required": true
  4109. },
  4110. {
  4111. "type": "integer",
  4112. "format": "int64",
  4113. "description": "index of the issue",
  4114. "name": "index",
  4115. "in": "path",
  4116. "required": true
  4117. }
  4118. ],
  4119. "responses": {
  4120. "200": {
  4121. "$ref": "#/responses/LabelList"
  4122. },
  4123. "404": {
  4124. "$ref": "#/responses/notFound"
  4125. }
  4126. }
  4127. },
  4128. "put": {
  4129. "consumes": [
  4130. "application/json"
  4131. ],
  4132. "produces": [
  4133. "application/json"
  4134. ],
  4135. "tags": [
  4136. "issue"
  4137. ],
  4138. "summary": "Replace an issue's labels",
  4139. "operationId": "issueReplaceLabels",
  4140. "parameters": [
  4141. {
  4142. "type": "string",
  4143. "description": "owner of the repo",
  4144. "name": "owner",
  4145. "in": "path",
  4146. "required": true
  4147. },
  4148. {
  4149. "type": "string",
  4150. "description": "name of the repo",
  4151. "name": "repo",
  4152. "in": "path",
  4153. "required": true
  4154. },
  4155. {
  4156. "type": "integer",
  4157. "format": "int64",
  4158. "description": "index of the issue",
  4159. "name": "index",
  4160. "in": "path",
  4161. "required": true
  4162. },
  4163. {
  4164. "name": "body",
  4165. "in": "body",
  4166. "schema": {
  4167. "$ref": "#/definitions/IssueLabelsOption"
  4168. }
  4169. }
  4170. ],
  4171. "responses": {
  4172. "200": {
  4173. "$ref": "#/responses/LabelList"
  4174. },
  4175. "403": {
  4176. "$ref": "#/responses/forbidden"
  4177. }
  4178. }
  4179. },
  4180. "post": {
  4181. "consumes": [
  4182. "application/json"
  4183. ],
  4184. "produces": [
  4185. "application/json"
  4186. ],
  4187. "tags": [
  4188. "issue"
  4189. ],
  4190. "summary": "Add a label to an issue",
  4191. "operationId": "issueAddLabel",
  4192. "parameters": [
  4193. {
  4194. "type": "string",
  4195. "description": "owner of the repo",
  4196. "name": "owner",
  4197. "in": "path",
  4198. "required": true
  4199. },
  4200. {
  4201. "type": "string",
  4202. "description": "name of the repo",
  4203. "name": "repo",
  4204. "in": "path",
  4205. "required": true
  4206. },
  4207. {
  4208. "type": "integer",
  4209. "format": "int64",
  4210. "description": "index of the issue",
  4211. "name": "index",
  4212. "in": "path",
  4213. "required": true
  4214. },
  4215. {
  4216. "name": "body",
  4217. "in": "body",
  4218. "schema": {
  4219. "$ref": "#/definitions/IssueLabelsOption"
  4220. }
  4221. }
  4222. ],
  4223. "responses": {
  4224. "200": {
  4225. "$ref": "#/responses/LabelList"
  4226. },
  4227. "403": {
  4228. "$ref": "#/responses/forbidden"
  4229. }
  4230. }
  4231. },
  4232. "delete": {
  4233. "produces": [
  4234. "application/json"
  4235. ],
  4236. "tags": [
  4237. "issue"
  4238. ],
  4239. "summary": "Remove all labels from an issue",
  4240. "operationId": "issueClearLabels",
  4241. "parameters": [
  4242. {
  4243. "type": "string",
  4244. "description": "owner of the repo",
  4245. "name": "owner",
  4246. "in": "path",
  4247. "required": true
  4248. },
  4249. {
  4250. "type": "string",
  4251. "description": "name of the repo",
  4252. "name": "repo",
  4253. "in": "path",
  4254. "required": true
  4255. },
  4256. {
  4257. "type": "integer",
  4258. "format": "int64",
  4259. "description": "index of the issue",
  4260. "name": "index",
  4261. "in": "path",
  4262. "required": true
  4263. }
  4264. ],
  4265. "responses": {
  4266. "204": {
  4267. "$ref": "#/responses/empty"
  4268. },
  4269. "403": {
  4270. "$ref": "#/responses/forbidden"
  4271. }
  4272. }
  4273. }
  4274. },
  4275. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4276. "delete": {
  4277. "produces": [
  4278. "application/json"
  4279. ],
  4280. "tags": [
  4281. "issue"
  4282. ],
  4283. "summary": "Remove a label from an issue",
  4284. "operationId": "issueRemoveLabel",
  4285. "parameters": [
  4286. {
  4287. "type": "string",
  4288. "description": "owner of the repo",
  4289. "name": "owner",
  4290. "in": "path",
  4291. "required": true
  4292. },
  4293. {
  4294. "type": "string",
  4295. "description": "name of the repo",
  4296. "name": "repo",
  4297. "in": "path",
  4298. "required": true
  4299. },
  4300. {
  4301. "type": "integer",
  4302. "format": "int64",
  4303. "description": "index of the issue",
  4304. "name": "index",
  4305. "in": "path",
  4306. "required": true
  4307. },
  4308. {
  4309. "type": "integer",
  4310. "format": "int64",
  4311. "description": "id of the label to remove",
  4312. "name": "id",
  4313. "in": "path",
  4314. "required": true
  4315. }
  4316. ],
  4317. "responses": {
  4318. "204": {
  4319. "$ref": "#/responses/empty"
  4320. },
  4321. "403": {
  4322. "$ref": "#/responses/forbidden"
  4323. },
  4324. "422": {
  4325. "$ref": "#/responses/validationError"
  4326. }
  4327. }
  4328. }
  4329. },
  4330. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4331. "get": {
  4332. "consumes": [
  4333. "application/json"
  4334. ],
  4335. "produces": [
  4336. "application/json"
  4337. ],
  4338. "tags": [
  4339. "issue"
  4340. ],
  4341. "summary": "Get a list reactions of an issue",
  4342. "operationId": "issueGetIssueReactions",
  4343. "parameters": [
  4344. {
  4345. "type": "string",
  4346. "description": "owner of the repo",
  4347. "name": "owner",
  4348. "in": "path",
  4349. "required": true
  4350. },
  4351. {
  4352. "type": "string",
  4353. "description": "name of the repo",
  4354. "name": "repo",
  4355. "in": "path",
  4356. "required": true
  4357. },
  4358. {
  4359. "type": "integer",
  4360. "format": "int64",
  4361. "description": "index of the issue",
  4362. "name": "index",
  4363. "in": "path",
  4364. "required": true
  4365. },
  4366. {
  4367. "type": "integer",
  4368. "description": "page number of results to return (1-based)",
  4369. "name": "page",
  4370. "in": "query"
  4371. },
  4372. {
  4373. "type": "integer",
  4374. "description": "page size of results, maximum page size is 50",
  4375. "name": "limit",
  4376. "in": "query"
  4377. }
  4378. ],
  4379. "responses": {
  4380. "200": {
  4381. "$ref": "#/responses/ReactionList"
  4382. },
  4383. "403": {
  4384. "$ref": "#/responses/forbidden"
  4385. }
  4386. }
  4387. },
  4388. "post": {
  4389. "consumes": [
  4390. "application/json"
  4391. ],
  4392. "produces": [
  4393. "application/json"
  4394. ],
  4395. "tags": [
  4396. "issue"
  4397. ],
  4398. "summary": "Add a reaction to an issue",
  4399. "operationId": "issuePostIssueReaction",
  4400. "parameters": [
  4401. {
  4402. "type": "string",
  4403. "description": "owner of the repo",
  4404. "name": "owner",
  4405. "in": "path",
  4406. "required": true
  4407. },
  4408. {
  4409. "type": "string",
  4410. "description": "name of the repo",
  4411. "name": "repo",
  4412. "in": "path",
  4413. "required": true
  4414. },
  4415. {
  4416. "type": "integer",
  4417. "format": "int64",
  4418. "description": "index of the issue",
  4419. "name": "index",
  4420. "in": "path",
  4421. "required": true
  4422. },
  4423. {
  4424. "name": "content",
  4425. "in": "body",
  4426. "schema": {
  4427. "$ref": "#/definitions/EditReactionOption"
  4428. }
  4429. }
  4430. ],
  4431. "responses": {
  4432. "200": {
  4433. "$ref": "#/responses/Reaction"
  4434. },
  4435. "201": {
  4436. "$ref": "#/responses/Reaction"
  4437. },
  4438. "403": {
  4439. "$ref": "#/responses/forbidden"
  4440. }
  4441. }
  4442. },
  4443. "delete": {
  4444. "consumes": [
  4445. "application/json"
  4446. ],
  4447. "produces": [
  4448. "application/json"
  4449. ],
  4450. "tags": [
  4451. "issue"
  4452. ],
  4453. "summary": "Remove a reaction from an issue",
  4454. "operationId": "issueDeleteIssueReaction",
  4455. "parameters": [
  4456. {
  4457. "type": "string",
  4458. "description": "owner of the repo",
  4459. "name": "owner",
  4460. "in": "path",
  4461. "required": true
  4462. },
  4463. {
  4464. "type": "string",
  4465. "description": "name of the repo",
  4466. "name": "repo",
  4467. "in": "path",
  4468. "required": true
  4469. },
  4470. {
  4471. "type": "integer",
  4472. "format": "int64",
  4473. "description": "index of the issue",
  4474. "name": "index",
  4475. "in": "path",
  4476. "required": true
  4477. },
  4478. {
  4479. "name": "content",
  4480. "in": "body",
  4481. "schema": {
  4482. "$ref": "#/definitions/EditReactionOption"
  4483. }
  4484. }
  4485. ],
  4486. "responses": {
  4487. "200": {
  4488. "$ref": "#/responses/empty"
  4489. },
  4490. "403": {
  4491. "$ref": "#/responses/forbidden"
  4492. }
  4493. }
  4494. }
  4495. },
  4496. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4497. "delete": {
  4498. "consumes": [
  4499. "application/json"
  4500. ],
  4501. "produces": [
  4502. "application/json"
  4503. ],
  4504. "tags": [
  4505. "issue"
  4506. ],
  4507. "summary": "Delete an issue's existing stopwatch.",
  4508. "operationId": "issueDeleteStopWatch",
  4509. "parameters": [
  4510. {
  4511. "type": "string",
  4512. "description": "owner of the repo",
  4513. "name": "owner",
  4514. "in": "path",
  4515. "required": true
  4516. },
  4517. {
  4518. "type": "string",
  4519. "description": "name of the repo",
  4520. "name": "repo",
  4521. "in": "path",
  4522. "required": true
  4523. },
  4524. {
  4525. "type": "integer",
  4526. "format": "int64",
  4527. "description": "index of the issue to stop the stopwatch on",
  4528. "name": "index",
  4529. "in": "path",
  4530. "required": true
  4531. }
  4532. ],
  4533. "responses": {
  4534. "204": {
  4535. "$ref": "#/responses/empty"
  4536. },
  4537. "403": {
  4538. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4539. },
  4540. "404": {
  4541. "$ref": "#/responses/notFound"
  4542. },
  4543. "409": {
  4544. "description": "Cannot cancel a non existent stopwatch"
  4545. }
  4546. }
  4547. }
  4548. },
  4549. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  4550. "post": {
  4551. "consumes": [
  4552. "application/json"
  4553. ],
  4554. "produces": [
  4555. "application/json"
  4556. ],
  4557. "tags": [
  4558. "issue"
  4559. ],
  4560. "summary": "Start stopwatch on an issue.",
  4561. "operationId": "issueStartStopWatch",
  4562. "parameters": [
  4563. {
  4564. "type": "string",
  4565. "description": "owner of the repo",
  4566. "name": "owner",
  4567. "in": "path",
  4568. "required": true
  4569. },
  4570. {
  4571. "type": "string",
  4572. "description": "name of the repo",
  4573. "name": "repo",
  4574. "in": "path",
  4575. "required": true
  4576. },
  4577. {
  4578. "type": "integer",
  4579. "format": "int64",
  4580. "description": "index of the issue to create the stopwatch on",
  4581. "name": "index",
  4582. "in": "path",
  4583. "required": true
  4584. }
  4585. ],
  4586. "responses": {
  4587. "201": {
  4588. "$ref": "#/responses/empty"
  4589. },
  4590. "403": {
  4591. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4592. },
  4593. "404": {
  4594. "$ref": "#/responses/notFound"
  4595. },
  4596. "409": {
  4597. "description": "Cannot start a stopwatch again if it already exists"
  4598. }
  4599. }
  4600. }
  4601. },
  4602. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  4603. "post": {
  4604. "consumes": [
  4605. "application/json"
  4606. ],
  4607. "produces": [
  4608. "application/json"
  4609. ],
  4610. "tags": [
  4611. "issue"
  4612. ],
  4613. "summary": "Stop an issue's existing stopwatch.",
  4614. "operationId": "issueStopStopWatch",
  4615. "parameters": [
  4616. {
  4617. "type": "string",
  4618. "description": "owner of the repo",
  4619. "name": "owner",
  4620. "in": "path",
  4621. "required": true
  4622. },
  4623. {
  4624. "type": "string",
  4625. "description": "name of the repo",
  4626. "name": "repo",
  4627. "in": "path",
  4628. "required": true
  4629. },
  4630. {
  4631. "type": "integer",
  4632. "format": "int64",
  4633. "description": "index of the issue to stop the stopwatch on",
  4634. "name": "index",
  4635. "in": "path",
  4636. "required": true
  4637. }
  4638. ],
  4639. "responses": {
  4640. "201": {
  4641. "$ref": "#/responses/empty"
  4642. },
  4643. "403": {
  4644. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4645. },
  4646. "404": {
  4647. "$ref": "#/responses/notFound"
  4648. },
  4649. "409": {
  4650. "description": "Cannot stop a non existent stopwatch"
  4651. }
  4652. }
  4653. }
  4654. },
  4655. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  4656. "get": {
  4657. "consumes": [
  4658. "application/json"
  4659. ],
  4660. "produces": [
  4661. "application/json"
  4662. ],
  4663. "tags": [
  4664. "issue"
  4665. ],
  4666. "summary": "Get users who subscribed on an issue.",
  4667. "operationId": "issueSubscriptions",
  4668. "parameters": [
  4669. {
  4670. "type": "string",
  4671. "description": "owner of the repo",
  4672. "name": "owner",
  4673. "in": "path",
  4674. "required": true
  4675. },
  4676. {
  4677. "type": "string",
  4678. "description": "name of the repo",
  4679. "name": "repo",
  4680. "in": "path",
  4681. "required": true
  4682. },
  4683. {
  4684. "type": "integer",
  4685. "format": "int64",
  4686. "description": "index of the issue",
  4687. "name": "index",
  4688. "in": "path",
  4689. "required": true
  4690. },
  4691. {
  4692. "type": "integer",
  4693. "description": "page number of results to return (1-based)",
  4694. "name": "page",
  4695. "in": "query"
  4696. },
  4697. {
  4698. "type": "integer",
  4699. "description": "page size of results, maximum page size is 50",
  4700. "name": "limit",
  4701. "in": "query"
  4702. }
  4703. ],
  4704. "responses": {
  4705. "200": {
  4706. "$ref": "#/responses/UserList"
  4707. },
  4708. "404": {
  4709. "$ref": "#/responses/notFound"
  4710. }
  4711. }
  4712. }
  4713. },
  4714. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  4715. "put": {
  4716. "consumes": [
  4717. "application/json"
  4718. ],
  4719. "produces": [
  4720. "application/json"
  4721. ],
  4722. "tags": [
  4723. "issue"
  4724. ],
  4725. "summary": "Subscribe user to issue",
  4726. "operationId": "issueAddSubscription",
  4727. "parameters": [
  4728. {
  4729. "type": "string",
  4730. "description": "owner of the repo",
  4731. "name": "owner",
  4732. "in": "path",
  4733. "required": true
  4734. },
  4735. {
  4736. "type": "string",
  4737. "description": "name of the repo",
  4738. "name": "repo",
  4739. "in": "path",
  4740. "required": true
  4741. },
  4742. {
  4743. "type": "integer",
  4744. "format": "int64",
  4745. "description": "index of the issue",
  4746. "name": "index",
  4747. "in": "path",
  4748. "required": true
  4749. },
  4750. {
  4751. "type": "string",
  4752. "description": "user to subscribe",
  4753. "name": "user",
  4754. "in": "path",
  4755. "required": true
  4756. }
  4757. ],
  4758. "responses": {
  4759. "201": {
  4760. "$ref": "#/responses/empty"
  4761. },
  4762. "304": {
  4763. "description": "User can only subscribe itself if he is no admin"
  4764. },
  4765. "404": {
  4766. "$ref": "#/responses/notFound"
  4767. }
  4768. }
  4769. },
  4770. "delete": {
  4771. "consumes": [
  4772. "application/json"
  4773. ],
  4774. "produces": [
  4775. "application/json"
  4776. ],
  4777. "tags": [
  4778. "issue"
  4779. ],
  4780. "summary": "Unsubscribe user from issue",
  4781. "operationId": "issueDeleteSubscription",
  4782. "parameters": [
  4783. {
  4784. "type": "string",
  4785. "description": "owner of the repo",
  4786. "name": "owner",
  4787. "in": "path",
  4788. "required": true
  4789. },
  4790. {
  4791. "type": "string",
  4792. "description": "name of the repo",
  4793. "name": "repo",
  4794. "in": "path",
  4795. "required": true
  4796. },
  4797. {
  4798. "type": "integer",
  4799. "format": "int64",
  4800. "description": "index of the issue",
  4801. "name": "index",
  4802. "in": "path",
  4803. "required": true
  4804. },
  4805. {
  4806. "type": "string",
  4807. "description": "user witch unsubscribe",
  4808. "name": "user",
  4809. "in": "path",
  4810. "required": true
  4811. }
  4812. ],
  4813. "responses": {
  4814. "201": {
  4815. "$ref": "#/responses/empty"
  4816. },
  4817. "304": {
  4818. "description": "User can only subscribe itself if he is no admin"
  4819. },
  4820. "404": {
  4821. "$ref": "#/responses/notFound"
  4822. }
  4823. }
  4824. }
  4825. },
  4826. "/repos/{owner}/{repo}/issues/{index}/times": {
  4827. "get": {
  4828. "produces": [
  4829. "application/json"
  4830. ],
  4831. "tags": [
  4832. "issue"
  4833. ],
  4834. "summary": "List an issue's tracked times",
  4835. "operationId": "issueTrackedTimes",
  4836. "parameters": [
  4837. {
  4838. "type": "string",
  4839. "description": "owner of the repo",
  4840. "name": "owner",
  4841. "in": "path",
  4842. "required": true
  4843. },
  4844. {
  4845. "type": "string",
  4846. "description": "name of the repo",
  4847. "name": "repo",
  4848. "in": "path",
  4849. "required": true
  4850. },
  4851. {
  4852. "type": "integer",
  4853. "format": "int64",
  4854. "description": "index of the issue",
  4855. "name": "index",
  4856. "in": "path",
  4857. "required": true
  4858. },
  4859. {
  4860. "type": "string",
  4861. "format": "date-time",
  4862. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  4863. "name": "since",
  4864. "in": "query"
  4865. },
  4866. {
  4867. "type": "string",
  4868. "format": "date-time",
  4869. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  4870. "name": "before",
  4871. "in": "query"
  4872. },
  4873. {
  4874. "type": "integer",
  4875. "description": "page number of results to return (1-based)",
  4876. "name": "page",
  4877. "in": "query"
  4878. },
  4879. {
  4880. "type": "integer",
  4881. "description": "page size of results, maximum page size is 50",
  4882. "name": "limit",
  4883. "in": "query"
  4884. }
  4885. ],
  4886. "responses": {
  4887. "200": {
  4888. "$ref": "#/responses/TrackedTimeList"
  4889. },
  4890. "404": {
  4891. "$ref": "#/responses/notFound"
  4892. }
  4893. }
  4894. },
  4895. "post": {
  4896. "consumes": [
  4897. "application/json"
  4898. ],
  4899. "produces": [
  4900. "application/json"
  4901. ],
  4902. "tags": [
  4903. "issue"
  4904. ],
  4905. "summary": "Add tracked time to a issue",
  4906. "operationId": "issueAddTime",
  4907. "parameters": [
  4908. {
  4909. "type": "string",
  4910. "description": "owner of the repo",
  4911. "name": "owner",
  4912. "in": "path",
  4913. "required": true
  4914. },
  4915. {
  4916. "type": "string",
  4917. "description": "name of the repo",
  4918. "name": "repo",
  4919. "in": "path",
  4920. "required": true
  4921. },
  4922. {
  4923. "type": "integer",
  4924. "format": "int64",
  4925. "description": "index of the issue",
  4926. "name": "index",
  4927. "in": "path",
  4928. "required": true
  4929. },
  4930. {
  4931. "name": "body",
  4932. "in": "body",
  4933. "schema": {
  4934. "$ref": "#/definitions/AddTimeOption"
  4935. }
  4936. }
  4937. ],
  4938. "responses": {
  4939. "200": {
  4940. "$ref": "#/responses/TrackedTime"
  4941. },
  4942. "400": {
  4943. "$ref": "#/responses/error"
  4944. },
  4945. "403": {
  4946. "$ref": "#/responses/forbidden"
  4947. }
  4948. }
  4949. },
  4950. "delete": {
  4951. "consumes": [
  4952. "application/json"
  4953. ],
  4954. "produces": [
  4955. "application/json"
  4956. ],
  4957. "tags": [
  4958. "issue"
  4959. ],
  4960. "summary": "Reset a tracked time of an issue",
  4961. "operationId": "issueResetTime",
  4962. "parameters": [
  4963. {
  4964. "type": "string",
  4965. "description": "owner of the repo",
  4966. "name": "owner",
  4967. "in": "path",
  4968. "required": true
  4969. },
  4970. {
  4971. "type": "string",
  4972. "description": "name of the repo",
  4973. "name": "repo",
  4974. "in": "path",
  4975. "required": true
  4976. },
  4977. {
  4978. "type": "integer",
  4979. "format": "int64",
  4980. "description": "index of the issue to add tracked time to",
  4981. "name": "index",
  4982. "in": "path",
  4983. "required": true
  4984. }
  4985. ],
  4986. "responses": {
  4987. "204": {
  4988. "$ref": "#/responses/empty"
  4989. },
  4990. "400": {
  4991. "$ref": "#/responses/error"
  4992. },
  4993. "403": {
  4994. "$ref": "#/responses/forbidden"
  4995. }
  4996. }
  4997. }
  4998. },
  4999. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5000. "delete": {
  5001. "consumes": [
  5002. "application/json"
  5003. ],
  5004. "produces": [
  5005. "application/json"
  5006. ],
  5007. "tags": [
  5008. "issue"
  5009. ],
  5010. "summary": "Delete specific tracked time",
  5011. "operationId": "issueDeleteTime",
  5012. "parameters": [
  5013. {
  5014. "type": "string",
  5015. "description": "owner of the repo",
  5016. "name": "owner",
  5017. "in": "path",
  5018. "required": true
  5019. },
  5020. {
  5021. "type": "string",
  5022. "description": "name of the repo",
  5023. "name": "repo",
  5024. "in": "path",
  5025. "required": true
  5026. },
  5027. {
  5028. "type": "integer",
  5029. "format": "int64",
  5030. "description": "index of the issue",
  5031. "name": "index",
  5032. "in": "path",
  5033. "required": true
  5034. },
  5035. {
  5036. "type": "integer",
  5037. "format": "int64",
  5038. "description": "id of time to delete",
  5039. "name": "id",
  5040. "in": "path",
  5041. "required": true
  5042. }
  5043. ],
  5044. "responses": {
  5045. "204": {
  5046. "$ref": "#/responses/empty"
  5047. },
  5048. "400": {
  5049. "$ref": "#/responses/error"
  5050. },
  5051. "403": {
  5052. "$ref": "#/responses/forbidden"
  5053. }
  5054. }
  5055. }
  5056. },
  5057. "/repos/{owner}/{repo}/keys": {
  5058. "get": {
  5059. "produces": [
  5060. "application/json"
  5061. ],
  5062. "tags": [
  5063. "repository"
  5064. ],
  5065. "summary": "List a repository's keys",
  5066. "operationId": "repoListKeys",
  5067. "parameters": [
  5068. {
  5069. "type": "string",
  5070. "description": "owner of the repo",
  5071. "name": "owner",
  5072. "in": "path",
  5073. "required": true
  5074. },
  5075. {
  5076. "type": "string",
  5077. "description": "name of the repo",
  5078. "name": "repo",
  5079. "in": "path",
  5080. "required": true
  5081. },
  5082. {
  5083. "type": "integer",
  5084. "description": "the key_id to search for",
  5085. "name": "key_id",
  5086. "in": "query"
  5087. },
  5088. {
  5089. "type": "string",
  5090. "description": "fingerprint of the key",
  5091. "name": "fingerprint",
  5092. "in": "query"
  5093. },
  5094. {
  5095. "type": "integer",
  5096. "description": "page number of results to return (1-based)",
  5097. "name": "page",
  5098. "in": "query"
  5099. },
  5100. {
  5101. "type": "integer",
  5102. "description": "page size of results, maximum page size is 50",
  5103. "name": "limit",
  5104. "in": "query"
  5105. }
  5106. ],
  5107. "responses": {
  5108. "200": {
  5109. "$ref": "#/responses/DeployKeyList"
  5110. }
  5111. }
  5112. },
  5113. "post": {
  5114. "consumes": [
  5115. "application/json"
  5116. ],
  5117. "produces": [
  5118. "application/json"
  5119. ],
  5120. "tags": [
  5121. "repository"
  5122. ],
  5123. "summary": "Add a key to a repository",
  5124. "operationId": "repoCreateKey",
  5125. "parameters": [
  5126. {
  5127. "type": "string",
  5128. "description": "owner of the repo",
  5129. "name": "owner",
  5130. "in": "path",
  5131. "required": true
  5132. },
  5133. {
  5134. "type": "string",
  5135. "description": "name of the repo",
  5136. "name": "repo",
  5137. "in": "path",
  5138. "required": true
  5139. },
  5140. {
  5141. "name": "body",
  5142. "in": "body",
  5143. "schema": {
  5144. "$ref": "#/definitions/CreateKeyOption"
  5145. }
  5146. }
  5147. ],
  5148. "responses": {
  5149. "201": {
  5150. "$ref": "#/responses/DeployKey"
  5151. },
  5152. "422": {
  5153. "$ref": "#/responses/validationError"
  5154. }
  5155. }
  5156. }
  5157. },
  5158. "/repos/{owner}/{repo}/keys/{id}": {
  5159. "get": {
  5160. "produces": [
  5161. "application/json"
  5162. ],
  5163. "tags": [
  5164. "repository"
  5165. ],
  5166. "summary": "Get a repository's key by id",
  5167. "operationId": "repoGetKey",
  5168. "parameters": [
  5169. {
  5170. "type": "string",
  5171. "description": "owner of the repo",
  5172. "name": "owner",
  5173. "in": "path",
  5174. "required": true
  5175. },
  5176. {
  5177. "type": "string",
  5178. "description": "name of the repo",
  5179. "name": "repo",
  5180. "in": "path",
  5181. "required": true
  5182. },
  5183. {
  5184. "type": "integer",
  5185. "format": "int64",
  5186. "description": "id of the key to get",
  5187. "name": "id",
  5188. "in": "path",
  5189. "required": true
  5190. }
  5191. ],
  5192. "responses": {
  5193. "200": {
  5194. "$ref": "#/responses/DeployKey"
  5195. }
  5196. }
  5197. },
  5198. "delete": {
  5199. "tags": [
  5200. "repository"
  5201. ],
  5202. "summary": "Delete a key from a repository",
  5203. "operationId": "repoDeleteKey",
  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. "type": "integer",
  5221. "format": "int64",
  5222. "description": "id of the key to delete",
  5223. "name": "id",
  5224. "in": "path",
  5225. "required": true
  5226. }
  5227. ],
  5228. "responses": {
  5229. "204": {
  5230. "$ref": "#/responses/empty"
  5231. },
  5232. "403": {
  5233. "$ref": "#/responses/forbidden"
  5234. }
  5235. }
  5236. }
  5237. },
  5238. "/repos/{owner}/{repo}/labels": {
  5239. "get": {
  5240. "produces": [
  5241. "application/json"
  5242. ],
  5243. "tags": [
  5244. "issue"
  5245. ],
  5246. "summary": "Get all of a repository's labels",
  5247. "operationId": "issueListLabels",
  5248. "parameters": [
  5249. {
  5250. "type": "string",
  5251. "description": "owner of the repo",
  5252. "name": "owner",
  5253. "in": "path",
  5254. "required": true
  5255. },
  5256. {
  5257. "type": "string",
  5258. "description": "name of the repo",
  5259. "name": "repo",
  5260. "in": "path",
  5261. "required": true
  5262. },
  5263. {
  5264. "type": "integer",
  5265. "description": "page number of results to return (1-based)",
  5266. "name": "page",
  5267. "in": "query"
  5268. },
  5269. {
  5270. "type": "integer",
  5271. "description": "page size of results, maximum page size is 50",
  5272. "name": "limit",
  5273. "in": "query"
  5274. }
  5275. ],
  5276. "responses": {
  5277. "200": {
  5278. "$ref": "#/responses/LabelList"
  5279. }
  5280. }
  5281. },
  5282. "post": {
  5283. "consumes": [
  5284. "application/json"
  5285. ],
  5286. "produces": [
  5287. "application/json"
  5288. ],
  5289. "tags": [
  5290. "issue"
  5291. ],
  5292. "summary": "Create a label",
  5293. "operationId": "issueCreateLabel",
  5294. "parameters": [
  5295. {
  5296. "type": "string",
  5297. "description": "owner of the repo",
  5298. "name": "owner",
  5299. "in": "path",
  5300. "required": true
  5301. },
  5302. {
  5303. "type": "string",
  5304. "description": "name of the repo",
  5305. "name": "repo",
  5306. "in": "path",
  5307. "required": true
  5308. },
  5309. {
  5310. "name": "body",
  5311. "in": "body",
  5312. "schema": {
  5313. "$ref": "#/definitions/CreateLabelOption"
  5314. }
  5315. }
  5316. ],
  5317. "responses": {
  5318. "201": {
  5319. "$ref": "#/responses/Label"
  5320. }
  5321. }
  5322. }
  5323. },
  5324. "/repos/{owner}/{repo}/labels/{id}": {
  5325. "get": {
  5326. "produces": [
  5327. "application/json"
  5328. ],
  5329. "tags": [
  5330. "issue"
  5331. ],
  5332. "summary": "Get a single label",
  5333. "operationId": "issueGetLabel",
  5334. "parameters": [
  5335. {
  5336. "type": "string",
  5337. "description": "owner of the repo",
  5338. "name": "owner",
  5339. "in": "path",
  5340. "required": true
  5341. },
  5342. {
  5343. "type": "string",
  5344. "description": "name of the repo",
  5345. "name": "repo",
  5346. "in": "path",
  5347. "required": true
  5348. },
  5349. {
  5350. "type": "integer",
  5351. "format": "int64",
  5352. "description": "id of the label to get",
  5353. "name": "id",
  5354. "in": "path",
  5355. "required": true
  5356. }
  5357. ],
  5358. "responses": {
  5359. "200": {
  5360. "$ref": "#/responses/Label"
  5361. }
  5362. }
  5363. },
  5364. "delete": {
  5365. "tags": [
  5366. "issue"
  5367. ],
  5368. "summary": "Delete a label",
  5369. "operationId": "issueDeleteLabel",
  5370. "parameters": [
  5371. {
  5372. "type": "string",
  5373. "description": "owner of the repo",
  5374. "name": "owner",
  5375. "in": "path",
  5376. "required": true
  5377. },
  5378. {
  5379. "type": "string",
  5380. "description": "name of the repo",
  5381. "name": "repo",
  5382. "in": "path",
  5383. "required": true
  5384. },
  5385. {
  5386. "type": "integer",
  5387. "format": "int64",
  5388. "description": "id of the label to delete",
  5389. "name": "id",
  5390. "in": "path",
  5391. "required": true
  5392. }
  5393. ],
  5394. "responses": {
  5395. "204": {
  5396. "$ref": "#/responses/empty"
  5397. }
  5398. }
  5399. },
  5400. "patch": {
  5401. "consumes": [
  5402. "application/json"
  5403. ],
  5404. "produces": [
  5405. "application/json"
  5406. ],
  5407. "tags": [
  5408. "issue"
  5409. ],
  5410. "summary": "Update a label",
  5411. "operationId": "issueEditLabel",
  5412. "parameters": [
  5413. {
  5414. "type": "string",
  5415. "description": "owner of the repo",
  5416. "name": "owner",
  5417. "in": "path",
  5418. "required": true
  5419. },
  5420. {
  5421. "type": "string",
  5422. "description": "name of the repo",
  5423. "name": "repo",
  5424. "in": "path",
  5425. "required": true
  5426. },
  5427. {
  5428. "type": "integer",
  5429. "format": "int64",
  5430. "description": "id of the label to edit",
  5431. "name": "id",
  5432. "in": "path",
  5433. "required": true
  5434. },
  5435. {
  5436. "name": "body",
  5437. "in": "body",
  5438. "schema": {
  5439. "$ref": "#/definitions/EditLabelOption"
  5440. }
  5441. }
  5442. ],
  5443. "responses": {
  5444. "200": {
  5445. "$ref": "#/responses/Label"
  5446. }
  5447. }
  5448. }
  5449. },
  5450. "/repos/{owner}/{repo}/milestones": {
  5451. "get": {
  5452. "produces": [
  5453. "application/json"
  5454. ],
  5455. "tags": [
  5456. "issue"
  5457. ],
  5458. "summary": "Get all of a repository's opened milestones",
  5459. "operationId": "issueGetMilestonesList",
  5460. "parameters": [
  5461. {
  5462. "type": "string",
  5463. "description": "owner of the repo",
  5464. "name": "owner",
  5465. "in": "path",
  5466. "required": true
  5467. },
  5468. {
  5469. "type": "string",
  5470. "description": "name of the repo",
  5471. "name": "repo",
  5472. "in": "path",
  5473. "required": true
  5474. },
  5475. {
  5476. "type": "string",
  5477. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  5478. "name": "state",
  5479. "in": "query"
  5480. },
  5481. {
  5482. "type": "integer",
  5483. "description": "page number of results to return (1-based)",
  5484. "name": "page",
  5485. "in": "query"
  5486. },
  5487. {
  5488. "type": "integer",
  5489. "description": "page size of results, maximum page size is 50",
  5490. "name": "limit",
  5491. "in": "query"
  5492. }
  5493. ],
  5494. "responses": {
  5495. "200": {
  5496. "$ref": "#/responses/MilestoneList"
  5497. }
  5498. }
  5499. },
  5500. "post": {
  5501. "consumes": [
  5502. "application/json"
  5503. ],
  5504. "produces": [
  5505. "application/json"
  5506. ],
  5507. "tags": [
  5508. "issue"
  5509. ],
  5510. "summary": "Create a milestone",
  5511. "operationId": "issueCreateMilestone",
  5512. "parameters": [
  5513. {
  5514. "type": "string",
  5515. "description": "owner of the repo",
  5516. "name": "owner",
  5517. "in": "path",
  5518. "required": true
  5519. },
  5520. {
  5521. "type": "string",
  5522. "description": "name of the repo",
  5523. "name": "repo",
  5524. "in": "path",
  5525. "required": true
  5526. },
  5527. {
  5528. "name": "body",
  5529. "in": "body",
  5530. "schema": {
  5531. "$ref": "#/definitions/CreateMilestoneOption"
  5532. }
  5533. }
  5534. ],
  5535. "responses": {
  5536. "201": {
  5537. "$ref": "#/responses/Milestone"
  5538. }
  5539. }
  5540. }
  5541. },
  5542. "/repos/{owner}/{repo}/milestones/{id}": {
  5543. "get": {
  5544. "produces": [
  5545. "application/json"
  5546. ],
  5547. "tags": [
  5548. "issue"
  5549. ],
  5550. "summary": "Get a milestone",
  5551. "operationId": "issueGetMilestone",
  5552. "parameters": [
  5553. {
  5554. "type": "string",
  5555. "description": "owner of the repo",
  5556. "name": "owner",
  5557. "in": "path",
  5558. "required": true
  5559. },
  5560. {
  5561. "type": "string",
  5562. "description": "name of the repo",
  5563. "name": "repo",
  5564. "in": "path",
  5565. "required": true
  5566. },
  5567. {
  5568. "type": "integer",
  5569. "format": "int64",
  5570. "description": "id of the milestone",
  5571. "name": "id",
  5572. "in": "path",
  5573. "required": true
  5574. }
  5575. ],
  5576. "responses": {
  5577. "200": {
  5578. "$ref": "#/responses/Milestone"
  5579. }
  5580. }
  5581. },
  5582. "delete": {
  5583. "tags": [
  5584. "issue"
  5585. ],
  5586. "summary": "Delete a milestone",
  5587. "operationId": "issueDeleteMilestone",
  5588. "parameters": [
  5589. {
  5590. "type": "string",
  5591. "description": "owner of the repo",
  5592. "name": "owner",
  5593. "in": "path",
  5594. "required": true
  5595. },
  5596. {
  5597. "type": "string",
  5598. "description": "name of the repo",
  5599. "name": "repo",
  5600. "in": "path",
  5601. "required": true
  5602. },
  5603. {
  5604. "type": "integer",
  5605. "format": "int64",
  5606. "description": "id of the milestone to delete",
  5607. "name": "id",
  5608. "in": "path",
  5609. "required": true
  5610. }
  5611. ],
  5612. "responses": {
  5613. "204": {
  5614. "$ref": "#/responses/empty"
  5615. }
  5616. }
  5617. },
  5618. "patch": {
  5619. "consumes": [
  5620. "application/json"
  5621. ],
  5622. "produces": [
  5623. "application/json"
  5624. ],
  5625. "tags": [
  5626. "issue"
  5627. ],
  5628. "summary": "Update a milestone",
  5629. "operationId": "issueEditMilestone",
  5630. "parameters": [
  5631. {
  5632. "type": "string",
  5633. "description": "owner of the repo",
  5634. "name": "owner",
  5635. "in": "path",
  5636. "required": true
  5637. },
  5638. {
  5639. "type": "string",
  5640. "description": "name of the repo",
  5641. "name": "repo",
  5642. "in": "path",
  5643. "required": true
  5644. },
  5645. {
  5646. "type": "integer",
  5647. "format": "int64",
  5648. "description": "id of the milestone",
  5649. "name": "id",
  5650. "in": "path",
  5651. "required": true
  5652. },
  5653. {
  5654. "name": "body",
  5655. "in": "body",
  5656. "schema": {
  5657. "$ref": "#/definitions/EditMilestoneOption"
  5658. }
  5659. }
  5660. ],
  5661. "responses": {
  5662. "200": {
  5663. "$ref": "#/responses/Milestone"
  5664. }
  5665. }
  5666. }
  5667. },
  5668. "/repos/{owner}/{repo}/mirror-sync": {
  5669. "post": {
  5670. "produces": [
  5671. "application/json"
  5672. ],
  5673. "tags": [
  5674. "repository"
  5675. ],
  5676. "summary": "Sync a mirrored repository",
  5677. "operationId": "repoMirrorSync",
  5678. "parameters": [
  5679. {
  5680. "type": "string",
  5681. "description": "owner of the repo to sync",
  5682. "name": "owner",
  5683. "in": "path",
  5684. "required": true
  5685. },
  5686. {
  5687. "type": "string",
  5688. "description": "name of the repo to sync",
  5689. "name": "repo",
  5690. "in": "path",
  5691. "required": true
  5692. }
  5693. ],
  5694. "responses": {
  5695. "200": {
  5696. "$ref": "#/responses/empty"
  5697. },
  5698. "403": {
  5699. "$ref": "#/responses/forbidden"
  5700. }
  5701. }
  5702. }
  5703. },
  5704. "/repos/{owner}/{repo}/notifications": {
  5705. "get": {
  5706. "consumes": [
  5707. "application/json"
  5708. ],
  5709. "produces": [
  5710. "application/json"
  5711. ],
  5712. "tags": [
  5713. "notification"
  5714. ],
  5715. "summary": "List users's notification threads on a specific repo",
  5716. "operationId": "notifyGetRepoList",
  5717. "parameters": [
  5718. {
  5719. "type": "string",
  5720. "description": "owner of the repo",
  5721. "name": "owner",
  5722. "in": "path",
  5723. "required": true
  5724. },
  5725. {
  5726. "type": "string",
  5727. "description": "name of the repo",
  5728. "name": "repo",
  5729. "in": "path",
  5730. "required": true
  5731. },
  5732. {
  5733. "type": "string",
  5734. "description": "If true, show notifications marked as read. Default value is false",
  5735. "name": "all",
  5736. "in": "query"
  5737. },
  5738. {
  5739. "type": "string",
  5740. "format": "date-time",
  5741. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  5742. "name": "since",
  5743. "in": "query"
  5744. },
  5745. {
  5746. "type": "string",
  5747. "format": "date-time",
  5748. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  5749. "name": "before",
  5750. "in": "query"
  5751. },
  5752. {
  5753. "type": "integer",
  5754. "description": "page number of results to return (1-based)",
  5755. "name": "page",
  5756. "in": "query"
  5757. },
  5758. {
  5759. "type": "integer",
  5760. "description": "page size of results, maximum page size is 50",
  5761. "name": "limit",
  5762. "in": "query"
  5763. }
  5764. ],
  5765. "responses": {
  5766. "200": {
  5767. "$ref": "#/responses/NotificationThreadList"
  5768. }
  5769. }
  5770. },
  5771. "put": {
  5772. "consumes": [
  5773. "application/json"
  5774. ],
  5775. "produces": [
  5776. "application/json"
  5777. ],
  5778. "tags": [
  5779. "notification"
  5780. ],
  5781. "summary": "Mark notification threads as read on a specific repo",
  5782. "operationId": "notifyReadRepoList",
  5783. "parameters": [
  5784. {
  5785. "type": "string",
  5786. "description": "owner of the repo",
  5787. "name": "owner",
  5788. "in": "path",
  5789. "required": true
  5790. },
  5791. {
  5792. "type": "string",
  5793. "description": "name of the repo",
  5794. "name": "repo",
  5795. "in": "path",
  5796. "required": true
  5797. },
  5798. {
  5799. "type": "string",
  5800. "format": "date-time",
  5801. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  5802. "name": "last_read_at",
  5803. "in": "query"
  5804. }
  5805. ],
  5806. "responses": {
  5807. "205": {
  5808. "$ref": "#/responses/empty"
  5809. }
  5810. }
  5811. }
  5812. },
  5813. "/repos/{owner}/{repo}/pulls": {
  5814. "get": {
  5815. "produces": [
  5816. "application/json"
  5817. ],
  5818. "tags": [
  5819. "repository"
  5820. ],
  5821. "summary": "List a repo's pull requests",
  5822. "operationId": "repoListPullRequests",
  5823. "parameters": [
  5824. {
  5825. "type": "string",
  5826. "description": "owner of the repo",
  5827. "name": "owner",
  5828. "in": "path",
  5829. "required": true
  5830. },
  5831. {
  5832. "type": "string",
  5833. "description": "name of the repo",
  5834. "name": "repo",
  5835. "in": "path",
  5836. "required": true
  5837. },
  5838. {
  5839. "enum": [
  5840. "closed",
  5841. "open",
  5842. "all"
  5843. ],
  5844. "type": "string",
  5845. "description": "State of pull request: open or closed (optional)",
  5846. "name": "state",
  5847. "in": "query"
  5848. },
  5849. {
  5850. "enum": [
  5851. "oldest",
  5852. "recentupdate",
  5853. "leastupdate",
  5854. "mostcomment",
  5855. "leastcomment",
  5856. "priority"
  5857. ],
  5858. "type": "string",
  5859. "description": "Type of sort",
  5860. "name": "sort",
  5861. "in": "query"
  5862. },
  5863. {
  5864. "type": "integer",
  5865. "format": "int64",
  5866. "description": "ID of the milestone",
  5867. "name": "milestone",
  5868. "in": "query"
  5869. },
  5870. {
  5871. "type": "array",
  5872. "items": {
  5873. "type": "integer",
  5874. "format": "int64"
  5875. },
  5876. "collectionFormat": "multi",
  5877. "description": "Label IDs",
  5878. "name": "labels",
  5879. "in": "query"
  5880. },
  5881. {
  5882. "type": "integer",
  5883. "description": "page number of results to return (1-based)",
  5884. "name": "page",
  5885. "in": "query"
  5886. },
  5887. {
  5888. "type": "integer",
  5889. "description": "page size of results, maximum page size is 50",
  5890. "name": "limit",
  5891. "in": "query"
  5892. }
  5893. ],
  5894. "responses": {
  5895. "200": {
  5896. "$ref": "#/responses/PullRequestList"
  5897. }
  5898. }
  5899. },
  5900. "post": {
  5901. "consumes": [
  5902. "application/json"
  5903. ],
  5904. "produces": [
  5905. "application/json"
  5906. ],
  5907. "tags": [
  5908. "repository"
  5909. ],
  5910. "summary": "Create a pull request",
  5911. "operationId": "repoCreatePullRequest",
  5912. "parameters": [
  5913. {
  5914. "type": "string",
  5915. "description": "owner of the repo",
  5916. "name": "owner",
  5917. "in": "path",
  5918. "required": true
  5919. },
  5920. {
  5921. "type": "string",
  5922. "description": "name of the repo",
  5923. "name": "repo",
  5924. "in": "path",
  5925. "required": true
  5926. },
  5927. {
  5928. "name": "body",
  5929. "in": "body",
  5930. "schema": {
  5931. "$ref": "#/definitions/CreatePullRequestOption"
  5932. }
  5933. }
  5934. ],
  5935. "responses": {
  5936. "201": {
  5937. "$ref": "#/responses/PullRequest"
  5938. },
  5939. "409": {
  5940. "$ref": "#/responses/error"
  5941. },
  5942. "422": {
  5943. "$ref": "#/responses/validationError"
  5944. }
  5945. }
  5946. }
  5947. },
  5948. "/repos/{owner}/{repo}/pulls/{index}": {
  5949. "get": {
  5950. "produces": [
  5951. "application/json"
  5952. ],
  5953. "tags": [
  5954. "repository"
  5955. ],
  5956. "summary": "Get a pull request",
  5957. "operationId": "repoGetPullRequest",
  5958. "parameters": [
  5959. {
  5960. "type": "string",
  5961. "description": "owner of the repo",
  5962. "name": "owner",
  5963. "in": "path",
  5964. "required": true
  5965. },
  5966. {
  5967. "type": "string",
  5968. "description": "name of the repo",
  5969. "name": "repo",
  5970. "in": "path",
  5971. "required": true
  5972. },
  5973. {
  5974. "type": "integer",
  5975. "format": "int64",
  5976. "description": "index of the pull request to get",
  5977. "name": "index",
  5978. "in": "path",
  5979. "required": true
  5980. }
  5981. ],
  5982. "responses": {
  5983. "200": {
  5984. "$ref": "#/responses/PullRequest"
  5985. },
  5986. "404": {
  5987. "$ref": "#/responses/notFound"
  5988. }
  5989. }
  5990. },
  5991. "patch": {
  5992. "consumes": [
  5993. "application/json"
  5994. ],
  5995. "produces": [
  5996. "application/json"
  5997. ],
  5998. "tags": [
  5999. "repository"
  6000. ],
  6001. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6002. "operationId": "repoEditPullRequest",
  6003. "parameters": [
  6004. {
  6005. "type": "string",
  6006. "description": "owner of the repo",
  6007. "name": "owner",
  6008. "in": "path",
  6009. "required": true
  6010. },
  6011. {
  6012. "type": "string",
  6013. "description": "name of the repo",
  6014. "name": "repo",
  6015. "in": "path",
  6016. "required": true
  6017. },
  6018. {
  6019. "type": "integer",
  6020. "format": "int64",
  6021. "description": "index of the pull request to edit",
  6022. "name": "index",
  6023. "in": "path",
  6024. "required": true
  6025. },
  6026. {
  6027. "name": "body",
  6028. "in": "body",
  6029. "schema": {
  6030. "$ref": "#/definitions/EditPullRequestOption"
  6031. }
  6032. }
  6033. ],
  6034. "responses": {
  6035. "201": {
  6036. "$ref": "#/responses/PullRequest"
  6037. },
  6038. "403": {
  6039. "$ref": "#/responses/forbidden"
  6040. },
  6041. "412": {
  6042. "$ref": "#/responses/error"
  6043. },
  6044. "422": {
  6045. "$ref": "#/responses/validationError"
  6046. }
  6047. }
  6048. }
  6049. },
  6050. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6051. "get": {
  6052. "produces": [
  6053. "application/json"
  6054. ],
  6055. "tags": [
  6056. "repository"
  6057. ],
  6058. "summary": "Check if a pull request has been merged",
  6059. "operationId": "repoPullRequestIsMerged",
  6060. "parameters": [
  6061. {
  6062. "type": "string",
  6063. "description": "owner of the repo",
  6064. "name": "owner",
  6065. "in": "path",
  6066. "required": true
  6067. },
  6068. {
  6069. "type": "string",
  6070. "description": "name of the repo",
  6071. "name": "repo",
  6072. "in": "path",
  6073. "required": true
  6074. },
  6075. {
  6076. "type": "integer",
  6077. "format": "int64",
  6078. "description": "index of the pull request",
  6079. "name": "index",
  6080. "in": "path",
  6081. "required": true
  6082. }
  6083. ],
  6084. "responses": {
  6085. "204": {
  6086. "description": "pull request has been merged"
  6087. },
  6088. "404": {
  6089. "description": "pull request has not been merged"
  6090. }
  6091. }
  6092. },
  6093. "post": {
  6094. "produces": [
  6095. "application/json"
  6096. ],
  6097. "tags": [
  6098. "repository"
  6099. ],
  6100. "summary": "Merge a pull request",
  6101. "operationId": "repoMergePullRequest",
  6102. "parameters": [
  6103. {
  6104. "type": "string",
  6105. "description": "owner of the repo",
  6106. "name": "owner",
  6107. "in": "path",
  6108. "required": true
  6109. },
  6110. {
  6111. "type": "string",
  6112. "description": "name of the repo",
  6113. "name": "repo",
  6114. "in": "path",
  6115. "required": true
  6116. },
  6117. {
  6118. "type": "integer",
  6119. "format": "int64",
  6120. "description": "index of the pull request to merge",
  6121. "name": "index",
  6122. "in": "path",
  6123. "required": true
  6124. },
  6125. {
  6126. "name": "body",
  6127. "in": "body",
  6128. "schema": {
  6129. "$ref": "#/definitions/MergePullRequestOption"
  6130. }
  6131. }
  6132. ],
  6133. "responses": {
  6134. "200": {
  6135. "$ref": "#/responses/empty"
  6136. },
  6137. "405": {
  6138. "$ref": "#/responses/empty"
  6139. },
  6140. "409": {
  6141. "$ref": "#/responses/error"
  6142. }
  6143. }
  6144. }
  6145. },
  6146. "/repos/{owner}/{repo}/raw/{filepath}": {
  6147. "get": {
  6148. "produces": [
  6149. "application/json"
  6150. ],
  6151. "tags": [
  6152. "repository"
  6153. ],
  6154. "summary": "Get a file from a repository",
  6155. "operationId": "repoGetRawFile",
  6156. "parameters": [
  6157. {
  6158. "type": "string",
  6159. "description": "owner of the repo",
  6160. "name": "owner",
  6161. "in": "path",
  6162. "required": true
  6163. },
  6164. {
  6165. "type": "string",
  6166. "description": "name of the repo",
  6167. "name": "repo",
  6168. "in": "path",
  6169. "required": true
  6170. },
  6171. {
  6172. "type": "string",
  6173. "description": "filepath of the file to get",
  6174. "name": "filepath",
  6175. "in": "path",
  6176. "required": true
  6177. }
  6178. ],
  6179. "responses": {
  6180. "200": {
  6181. "description": "success"
  6182. },
  6183. "404": {
  6184. "$ref": "#/responses/notFound"
  6185. }
  6186. }
  6187. }
  6188. },
  6189. "/repos/{owner}/{repo}/releases": {
  6190. "get": {
  6191. "produces": [
  6192. "application/json"
  6193. ],
  6194. "tags": [
  6195. "repository"
  6196. ],
  6197. "summary": "List a repo's releases",
  6198. "operationId": "repoListReleases",
  6199. "parameters": [
  6200. {
  6201. "type": "string",
  6202. "description": "owner of the repo",
  6203. "name": "owner",
  6204. "in": "path",
  6205. "required": true
  6206. },
  6207. {
  6208. "type": "string",
  6209. "description": "name of the repo",
  6210. "name": "repo",
  6211. "in": "path",
  6212. "required": true
  6213. },
  6214. {
  6215. "type": "integer",
  6216. "description": "items count every page wants to load",
  6217. "name": "per_page",
  6218. "in": "query"
  6219. },
  6220. {
  6221. "type": "integer",
  6222. "description": "page number of results to return (1-based)",
  6223. "name": "page",
  6224. "in": "query"
  6225. },
  6226. {
  6227. "type": "integer",
  6228. "description": "page size of results, maximum page size is 50",
  6229. "name": "limit",
  6230. "in": "query"
  6231. }
  6232. ],
  6233. "responses": {
  6234. "200": {
  6235. "$ref": "#/responses/ReleaseList"
  6236. }
  6237. }
  6238. },
  6239. "post": {
  6240. "consumes": [
  6241. "application/json"
  6242. ],
  6243. "produces": [
  6244. "application/json"
  6245. ],
  6246. "tags": [
  6247. "repository"
  6248. ],
  6249. "summary": "Create a release",
  6250. "operationId": "repoCreateRelease",
  6251. "parameters": [
  6252. {
  6253. "type": "string",
  6254. "description": "owner of the repo",
  6255. "name": "owner",
  6256. "in": "path",
  6257. "required": true
  6258. },
  6259. {
  6260. "type": "string",
  6261. "description": "name of the repo",
  6262. "name": "repo",
  6263. "in": "path",
  6264. "required": true
  6265. },
  6266. {
  6267. "name": "body",
  6268. "in": "body",
  6269. "schema": {
  6270. "$ref": "#/definitions/CreateReleaseOption"
  6271. }
  6272. }
  6273. ],
  6274. "responses": {
  6275. "201": {
  6276. "$ref": "#/responses/Release"
  6277. },
  6278. "409": {
  6279. "$ref": "#/responses/error"
  6280. }
  6281. }
  6282. }
  6283. },
  6284. "/repos/{owner}/{repo}/releases/{id}": {
  6285. "get": {
  6286. "produces": [
  6287. "application/json"
  6288. ],
  6289. "tags": [
  6290. "repository"
  6291. ],
  6292. "summary": "Get a release",
  6293. "operationId": "repoGetRelease",
  6294. "parameters": [
  6295. {
  6296. "type": "string",
  6297. "description": "owner of the repo",
  6298. "name": "owner",
  6299. "in": "path",
  6300. "required": true
  6301. },
  6302. {
  6303. "type": "string",
  6304. "description": "name of the repo",
  6305. "name": "repo",
  6306. "in": "path",
  6307. "required": true
  6308. },
  6309. {
  6310. "type": "integer",
  6311. "format": "int64",
  6312. "description": "id of the release to get",
  6313. "name": "id",
  6314. "in": "path",
  6315. "required": true
  6316. }
  6317. ],
  6318. "responses": {
  6319. "200": {
  6320. "$ref": "#/responses/Release"
  6321. }
  6322. }
  6323. },
  6324. "delete": {
  6325. "tags": [
  6326. "repository"
  6327. ],
  6328. "summary": "Delete a release",
  6329. "operationId": "repoDeleteRelease",
  6330. "parameters": [
  6331. {
  6332. "type": "string",
  6333. "description": "owner of the repo",
  6334. "name": "owner",
  6335. "in": "path",
  6336. "required": true
  6337. },
  6338. {
  6339. "type": "string",
  6340. "description": "name of the repo",
  6341. "name": "repo",
  6342. "in": "path",
  6343. "required": true
  6344. },
  6345. {
  6346. "type": "integer",
  6347. "format": "int64",
  6348. "description": "id of the release to delete",
  6349. "name": "id",
  6350. "in": "path",
  6351. "required": true
  6352. }
  6353. ],
  6354. "responses": {
  6355. "204": {
  6356. "$ref": "#/responses/empty"
  6357. }
  6358. }
  6359. },
  6360. "patch": {
  6361. "consumes": [
  6362. "application/json"
  6363. ],
  6364. "produces": [
  6365. "application/json"
  6366. ],
  6367. "tags": [
  6368. "repository"
  6369. ],
  6370. "summary": "Update a release",
  6371. "operationId": "repoEditRelease",
  6372. "parameters": [
  6373. {
  6374. "type": "string",
  6375. "description": "owner of the repo",
  6376. "name": "owner",
  6377. "in": "path",
  6378. "required": true
  6379. },
  6380. {
  6381. "type": "string",
  6382. "description": "name of the repo",
  6383. "name": "repo",
  6384. "in": "path",
  6385. "required": true
  6386. },
  6387. {
  6388. "type": "integer",
  6389. "format": "int64",
  6390. "description": "id of the release to edit",
  6391. "name": "id",
  6392. "in": "path",
  6393. "required": true
  6394. },
  6395. {
  6396. "name": "body",
  6397. "in": "body",
  6398. "schema": {
  6399. "$ref": "#/definitions/EditReleaseOption"
  6400. }
  6401. }
  6402. ],
  6403. "responses": {
  6404. "200": {
  6405. "$ref": "#/responses/Release"
  6406. }
  6407. }
  6408. }
  6409. },
  6410. "/repos/{owner}/{repo}/releases/{id}/assets": {
  6411. "get": {
  6412. "produces": [
  6413. "application/json"
  6414. ],
  6415. "tags": [
  6416. "repository"
  6417. ],
  6418. "summary": "List release's attachments",
  6419. "operationId": "repoListReleaseAttachments",
  6420. "parameters": [
  6421. {
  6422. "type": "string",
  6423. "description": "owner of the repo",
  6424. "name": "owner",
  6425. "in": "path",
  6426. "required": true
  6427. },
  6428. {
  6429. "type": "string",
  6430. "description": "name of the repo",
  6431. "name": "repo",
  6432. "in": "path",
  6433. "required": true
  6434. },
  6435. {
  6436. "type": "integer",
  6437. "format": "int64",
  6438. "description": "id of the release",
  6439. "name": "id",
  6440. "in": "path",
  6441. "required": true
  6442. }
  6443. ],
  6444. "responses": {
  6445. "200": {
  6446. "$ref": "#/responses/AttachmentList"
  6447. }
  6448. }
  6449. },
  6450. "post": {
  6451. "consumes": [
  6452. "multipart/form-data"
  6453. ],
  6454. "produces": [
  6455. "application/json"
  6456. ],
  6457. "tags": [
  6458. "repository"
  6459. ],
  6460. "summary": "Create a release attachment",
  6461. "operationId": "repoCreateReleaseAttachment",
  6462. "parameters": [
  6463. {
  6464. "type": "string",
  6465. "description": "owner of the repo",
  6466. "name": "owner",
  6467. "in": "path",
  6468. "required": true
  6469. },
  6470. {
  6471. "type": "string",
  6472. "description": "name of the repo",
  6473. "name": "repo",
  6474. "in": "path",
  6475. "required": true
  6476. },
  6477. {
  6478. "type": "integer",
  6479. "format": "int64",
  6480. "description": "id of the release",
  6481. "name": "id",
  6482. "in": "path",
  6483. "required": true
  6484. },
  6485. {
  6486. "type": "string",
  6487. "description": "name of the attachment",
  6488. "name": "name",
  6489. "in": "query"
  6490. },
  6491. {
  6492. "type": "file",
  6493. "description": "attachment to upload",
  6494. "name": "attachment",
  6495. "in": "formData",
  6496. "required": true
  6497. }
  6498. ],
  6499. "responses": {
  6500. "201": {
  6501. "$ref": "#/responses/Attachment"
  6502. },
  6503. "400": {
  6504. "$ref": "#/responses/error"
  6505. }
  6506. }
  6507. }
  6508. },
  6509. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  6510. "get": {
  6511. "produces": [
  6512. "application/json"
  6513. ],
  6514. "tags": [
  6515. "repository"
  6516. ],
  6517. "summary": "Get a release attachment",
  6518. "operationId": "repoGetReleaseAttachment",
  6519. "parameters": [
  6520. {
  6521. "type": "string",
  6522. "description": "owner of the repo",
  6523. "name": "owner",
  6524. "in": "path",
  6525. "required": true
  6526. },
  6527. {
  6528. "type": "string",
  6529. "description": "name of the repo",
  6530. "name": "repo",
  6531. "in": "path",
  6532. "required": true
  6533. },
  6534. {
  6535. "type": "integer",
  6536. "format": "int64",
  6537. "description": "id of the release",
  6538. "name": "id",
  6539. "in": "path",
  6540. "required": true
  6541. },
  6542. {
  6543. "type": "integer",
  6544. "format": "int64",
  6545. "description": "id of the attachment to get",
  6546. "name": "attachment_id",
  6547. "in": "path",
  6548. "required": true
  6549. }
  6550. ],
  6551. "responses": {
  6552. "200": {
  6553. "$ref": "#/responses/Attachment"
  6554. }
  6555. }
  6556. },
  6557. "delete": {
  6558. "produces": [
  6559. "application/json"
  6560. ],
  6561. "tags": [
  6562. "repository"
  6563. ],
  6564. "summary": "Delete a release attachment",
  6565. "operationId": "repoDeleteReleaseAttachment",
  6566. "parameters": [
  6567. {
  6568. "type": "string",
  6569. "description": "owner of the repo",
  6570. "name": "owner",
  6571. "in": "path",
  6572. "required": true
  6573. },
  6574. {
  6575. "type": "string",
  6576. "description": "name of the repo",
  6577. "name": "repo",
  6578. "in": "path",
  6579. "required": true
  6580. },
  6581. {
  6582. "type": "integer",
  6583. "format": "int64",
  6584. "description": "id of the release",
  6585. "name": "id",
  6586. "in": "path",
  6587. "required": true
  6588. },
  6589. {
  6590. "type": "integer",
  6591. "format": "int64",
  6592. "description": "id of the attachment to delete",
  6593. "name": "attachment_id",
  6594. "in": "path",
  6595. "required": true
  6596. }
  6597. ],
  6598. "responses": {
  6599. "204": {
  6600. "$ref": "#/responses/empty"
  6601. }
  6602. }
  6603. },
  6604. "patch": {
  6605. "consumes": [
  6606. "application/json"
  6607. ],
  6608. "produces": [
  6609. "application/json"
  6610. ],
  6611. "tags": [
  6612. "repository"
  6613. ],
  6614. "summary": "Edit a release attachment",
  6615. "operationId": "repoEditReleaseAttachment",
  6616. "parameters": [
  6617. {
  6618. "type": "string",
  6619. "description": "owner of the repo",
  6620. "name": "owner",
  6621. "in": "path",
  6622. "required": true
  6623. },
  6624. {
  6625. "type": "string",
  6626. "description": "name of the repo",
  6627. "name": "repo",
  6628. "in": "path",
  6629. "required": true
  6630. },
  6631. {
  6632. "type": "integer",
  6633. "format": "int64",
  6634. "description": "id of the release",
  6635. "name": "id",
  6636. "in": "path",
  6637. "required": true
  6638. },
  6639. {
  6640. "type": "integer",
  6641. "format": "int64",
  6642. "description": "id of the attachment to edit",
  6643. "name": "attachment_id",
  6644. "in": "path",
  6645. "required": true
  6646. },
  6647. {
  6648. "name": "body",
  6649. "in": "body",
  6650. "schema": {
  6651. "$ref": "#/definitions/EditAttachmentOptions"
  6652. }
  6653. }
  6654. ],
  6655. "responses": {
  6656. "201": {
  6657. "$ref": "#/responses/Attachment"
  6658. }
  6659. }
  6660. }
  6661. },
  6662. "/repos/{owner}/{repo}/signing-key.gpg": {
  6663. "get": {
  6664. "produces": [
  6665. "text/plain"
  6666. ],
  6667. "tags": [
  6668. "repository"
  6669. ],
  6670. "summary": "Get signing-key.gpg for given repository",
  6671. "operationId": "repoSigningKey",
  6672. "parameters": [
  6673. {
  6674. "type": "string",
  6675. "description": "owner of the repo",
  6676. "name": "owner",
  6677. "in": "path",
  6678. "required": true
  6679. },
  6680. {
  6681. "type": "string",
  6682. "description": "name of the repo",
  6683. "name": "repo",
  6684. "in": "path",
  6685. "required": true
  6686. }
  6687. ],
  6688. "responses": {
  6689. "200": {
  6690. "description": "GPG armored public key",
  6691. "schema": {
  6692. "type": "string"
  6693. }
  6694. }
  6695. }
  6696. }
  6697. },
  6698. "/repos/{owner}/{repo}/stargazers": {
  6699. "get": {
  6700. "produces": [
  6701. "application/json"
  6702. ],
  6703. "tags": [
  6704. "repository"
  6705. ],
  6706. "summary": "List a repo's stargazers",
  6707. "operationId": "repoListStargazers",
  6708. "parameters": [
  6709. {
  6710. "type": "string",
  6711. "description": "owner of the repo",
  6712. "name": "owner",
  6713. "in": "path",
  6714. "required": true
  6715. },
  6716. {
  6717. "type": "string",
  6718. "description": "name of the repo",
  6719. "name": "repo",
  6720. "in": "path",
  6721. "required": true
  6722. },
  6723. {
  6724. "type": "integer",
  6725. "description": "page number of results to return (1-based)",
  6726. "name": "page",
  6727. "in": "query"
  6728. },
  6729. {
  6730. "type": "integer",
  6731. "description": "page size of results, maximum page size is 50",
  6732. "name": "limit",
  6733. "in": "query"
  6734. }
  6735. ],
  6736. "responses": {
  6737. "200": {
  6738. "$ref": "#/responses/UserList"
  6739. }
  6740. }
  6741. }
  6742. },
  6743. "/repos/{owner}/{repo}/statuses/{sha}": {
  6744. "get": {
  6745. "produces": [
  6746. "application/json"
  6747. ],
  6748. "tags": [
  6749. "repository"
  6750. ],
  6751. "summary": "Get a commit's statuses",
  6752. "operationId": "repoListStatuses",
  6753. "parameters": [
  6754. {
  6755. "type": "string",
  6756. "description": "owner of the repo",
  6757. "name": "owner",
  6758. "in": "path",
  6759. "required": true
  6760. },
  6761. {
  6762. "type": "string",
  6763. "description": "name of the repo",
  6764. "name": "repo",
  6765. "in": "path",
  6766. "required": true
  6767. },
  6768. {
  6769. "type": "string",
  6770. "description": "sha of the commit",
  6771. "name": "sha",
  6772. "in": "path",
  6773. "required": true
  6774. },
  6775. {
  6776. "enum": [
  6777. "oldest",
  6778. "recentupdate",
  6779. "leastupdate",
  6780. "leastindex",
  6781. "highestindex"
  6782. ],
  6783. "type": "string",
  6784. "description": "type of sort",
  6785. "name": "sort",
  6786. "in": "query"
  6787. },
  6788. {
  6789. "enum": [
  6790. "pending",
  6791. "success",
  6792. "error",
  6793. "failure",
  6794. "warning"
  6795. ],
  6796. "type": "string",
  6797. "description": "type of state",
  6798. "name": "state",
  6799. "in": "query"
  6800. },
  6801. {
  6802. "type": "integer",
  6803. "description": "page number of results to return (1-based)",
  6804. "name": "page",
  6805. "in": "query"
  6806. },
  6807. {
  6808. "type": "integer",
  6809. "description": "page size of results, maximum page size is 50",
  6810. "name": "limit",
  6811. "in": "query"
  6812. }
  6813. ],
  6814. "responses": {
  6815. "200": {
  6816. "$ref": "#/responses/StatusList"
  6817. },
  6818. "400": {
  6819. "$ref": "#/responses/error"
  6820. }
  6821. }
  6822. },
  6823. "post": {
  6824. "produces": [
  6825. "application/json"
  6826. ],
  6827. "tags": [
  6828. "repository"
  6829. ],
  6830. "summary": "Create a commit status",
  6831. "operationId": "repoCreateStatus",
  6832. "parameters": [
  6833. {
  6834. "type": "string",
  6835. "description": "owner of the repo",
  6836. "name": "owner",
  6837. "in": "path",
  6838. "required": true
  6839. },
  6840. {
  6841. "type": "string",
  6842. "description": "name of the repo",
  6843. "name": "repo",
  6844. "in": "path",
  6845. "required": true
  6846. },
  6847. {
  6848. "type": "string",
  6849. "description": "sha of the commit",
  6850. "name": "sha",
  6851. "in": "path",
  6852. "required": true
  6853. },
  6854. {
  6855. "name": "body",
  6856. "in": "body",
  6857. "schema": {
  6858. "$ref": "#/definitions/CreateStatusOption"
  6859. }
  6860. }
  6861. ],
  6862. "responses": {
  6863. "201": {
  6864. "$ref": "#/responses/Status"
  6865. },
  6866. "400": {
  6867. "$ref": "#/responses/error"
  6868. }
  6869. }
  6870. }
  6871. },
  6872. "/repos/{owner}/{repo}/subscribers": {
  6873. "get": {
  6874. "produces": [
  6875. "application/json"
  6876. ],
  6877. "tags": [
  6878. "repository"
  6879. ],
  6880. "summary": "List a repo's watchers",
  6881. "operationId": "repoListSubscribers",
  6882. "parameters": [
  6883. {
  6884. "type": "string",
  6885. "description": "owner of the repo",
  6886. "name": "owner",
  6887. "in": "path",
  6888. "required": true
  6889. },
  6890. {
  6891. "type": "string",
  6892. "description": "name of the repo",
  6893. "name": "repo",
  6894. "in": "path",
  6895. "required": true
  6896. },
  6897. {
  6898. "type": "integer",
  6899. "description": "page number of results to return (1-based)",
  6900. "name": "page",
  6901. "in": "query"
  6902. },
  6903. {
  6904. "type": "integer",
  6905. "description": "page size of results, maximum page size is 50",
  6906. "name": "limit",
  6907. "in": "query"
  6908. }
  6909. ],
  6910. "responses": {
  6911. "200": {
  6912. "$ref": "#/responses/UserList"
  6913. }
  6914. }
  6915. }
  6916. },
  6917. "/repos/{owner}/{repo}/subscription": {
  6918. "get": {
  6919. "tags": [
  6920. "repository"
  6921. ],
  6922. "summary": "Check if the current user is watching a repo",
  6923. "operationId": "userCurrentCheckSubscription",
  6924. "parameters": [
  6925. {
  6926. "type": "string",
  6927. "description": "owner of the repo",
  6928. "name": "owner",
  6929. "in": "path",
  6930. "required": true
  6931. },
  6932. {
  6933. "type": "string",
  6934. "description": "name of the repo",
  6935. "name": "repo",
  6936. "in": "path",
  6937. "required": true
  6938. }
  6939. ],
  6940. "responses": {
  6941. "200": {
  6942. "$ref": "#/responses/WatchInfo"
  6943. }
  6944. }
  6945. },
  6946. "put": {
  6947. "tags": [
  6948. "repository"
  6949. ],
  6950. "summary": "Watch a repo",
  6951. "operationId": "userCurrentPutSubscription",
  6952. "parameters": [
  6953. {
  6954. "type": "string",
  6955. "description": "owner of the repo",
  6956. "name": "owner",
  6957. "in": "path",
  6958. "required": true
  6959. },
  6960. {
  6961. "type": "string",
  6962. "description": "name of the repo",
  6963. "name": "repo",
  6964. "in": "path",
  6965. "required": true
  6966. }
  6967. ],
  6968. "responses": {
  6969. "200": {
  6970. "$ref": "#/responses/WatchInfo"
  6971. }
  6972. }
  6973. },
  6974. "delete": {
  6975. "tags": [
  6976. "repository"
  6977. ],
  6978. "summary": "Unwatch a repo",
  6979. "operationId": "userCurrentDeleteSubscription",
  6980. "parameters": [
  6981. {
  6982. "type": "string",
  6983. "description": "owner of the repo",
  6984. "name": "owner",
  6985. "in": "path",
  6986. "required": true
  6987. },
  6988. {
  6989. "type": "string",
  6990. "description": "name of the repo",
  6991. "name": "repo",
  6992. "in": "path",
  6993. "required": true
  6994. }
  6995. ],
  6996. "responses": {
  6997. "204": {
  6998. "$ref": "#/responses/empty"
  6999. }
  7000. }
  7001. }
  7002. },
  7003. "/repos/{owner}/{repo}/tags": {
  7004. "get": {
  7005. "produces": [
  7006. "application/json"
  7007. ],
  7008. "tags": [
  7009. "repository"
  7010. ],
  7011. "summary": "List a repository's tags",
  7012. "operationId": "repoListTags",
  7013. "parameters": [
  7014. {
  7015. "type": "string",
  7016. "description": "owner of the repo",
  7017. "name": "owner",
  7018. "in": "path",
  7019. "required": true
  7020. },
  7021. {
  7022. "type": "string",
  7023. "description": "name of the repo",
  7024. "name": "repo",
  7025. "in": "path",
  7026. "required": true
  7027. }
  7028. ],
  7029. "responses": {
  7030. "200": {
  7031. "$ref": "#/responses/TagList"
  7032. }
  7033. }
  7034. }
  7035. },
  7036. "/repos/{owner}/{repo}/times": {
  7037. "get": {
  7038. "produces": [
  7039. "application/json"
  7040. ],
  7041. "tags": [
  7042. "repository"
  7043. ],
  7044. "summary": "List a repo's tracked times",
  7045. "operationId": "repoTrackedTimes",
  7046. "parameters": [
  7047. {
  7048. "type": "string",
  7049. "description": "owner of the repo",
  7050. "name": "owner",
  7051. "in": "path",
  7052. "required": true
  7053. },
  7054. {
  7055. "type": "string",
  7056. "description": "name of the repo",
  7057. "name": "repo",
  7058. "in": "path",
  7059. "required": true
  7060. },
  7061. {
  7062. "type": "string",
  7063. "description": "optional filter by user",
  7064. "name": "user",
  7065. "in": "query"
  7066. },
  7067. {
  7068. "type": "string",
  7069. "format": "date-time",
  7070. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7071. "name": "since",
  7072. "in": "query"
  7073. },
  7074. {
  7075. "type": "string",
  7076. "format": "date-time",
  7077. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7078. "name": "before",
  7079. "in": "query"
  7080. },
  7081. {
  7082. "type": "integer",
  7083. "description": "page number of results to return (1-based)",
  7084. "name": "page",
  7085. "in": "query"
  7086. },
  7087. {
  7088. "type": "integer",
  7089. "description": "page size of results, maximum page size is 50",
  7090. "name": "limit",
  7091. "in": "query"
  7092. }
  7093. ],
  7094. "responses": {
  7095. "200": {
  7096. "$ref": "#/responses/TrackedTimeList"
  7097. },
  7098. "400": {
  7099. "$ref": "#/responses/error"
  7100. },
  7101. "403": {
  7102. "$ref": "#/responses/forbidden"
  7103. }
  7104. }
  7105. }
  7106. },
  7107. "/repos/{owner}/{repo}/times/{user}": {
  7108. "get": {
  7109. "produces": [
  7110. "application/json"
  7111. ],
  7112. "tags": [
  7113. "repository"
  7114. ],
  7115. "summary": "List a user's tracked times in a repo",
  7116. "operationId": "userTrackedTimes",
  7117. "deprecated": true,
  7118. "parameters": [
  7119. {
  7120. "type": "string",
  7121. "description": "owner of the repo",
  7122. "name": "owner",
  7123. "in": "path",
  7124. "required": true
  7125. },
  7126. {
  7127. "type": "string",
  7128. "description": "name of the repo",
  7129. "name": "repo",
  7130. "in": "path",
  7131. "required": true
  7132. },
  7133. {
  7134. "type": "string",
  7135. "description": "username of user",
  7136. "name": "user",
  7137. "in": "path",
  7138. "required": true
  7139. }
  7140. ],
  7141. "responses": {
  7142. "200": {
  7143. "$ref": "#/responses/TrackedTimeList"
  7144. },
  7145. "400": {
  7146. "$ref": "#/responses/error"
  7147. },
  7148. "403": {
  7149. "$ref": "#/responses/forbidden"
  7150. }
  7151. }
  7152. }
  7153. },
  7154. "/repos/{owner}/{repo}/topics": {
  7155. "get": {
  7156. "produces": [
  7157. "application/json"
  7158. ],
  7159. "tags": [
  7160. "repository"
  7161. ],
  7162. "summary": "Get list of topics that a repository has",
  7163. "operationId": "repoListTopics",
  7164. "parameters": [
  7165. {
  7166. "type": "string",
  7167. "description": "owner of the repo",
  7168. "name": "owner",
  7169. "in": "path",
  7170. "required": true
  7171. },
  7172. {
  7173. "type": "string",
  7174. "description": "name of the repo",
  7175. "name": "repo",
  7176. "in": "path",
  7177. "required": true
  7178. },
  7179. {
  7180. "type": "integer",
  7181. "description": "page number of results to return (1-based)",
  7182. "name": "page",
  7183. "in": "query"
  7184. },
  7185. {
  7186. "type": "integer",
  7187. "description": "page size of results, maximum page size is 50",
  7188. "name": "limit",
  7189. "in": "query"
  7190. }
  7191. ],
  7192. "responses": {
  7193. "200": {
  7194. "$ref": "#/responses/TopicNames"
  7195. }
  7196. }
  7197. },
  7198. "put": {
  7199. "produces": [
  7200. "application/json"
  7201. ],
  7202. "tags": [
  7203. "repository"
  7204. ],
  7205. "summary": "Replace list of topics for a repository",
  7206. "operationId": "repoUpdateTopics",
  7207. "parameters": [
  7208. {
  7209. "type": "string",
  7210. "description": "owner of the repo",
  7211. "name": "owner",
  7212. "in": "path",
  7213. "required": true
  7214. },
  7215. {
  7216. "type": "string",
  7217. "description": "name of the repo",
  7218. "name": "repo",
  7219. "in": "path",
  7220. "required": true
  7221. },
  7222. {
  7223. "name": "body",
  7224. "in": "body",
  7225. "schema": {
  7226. "$ref": "#/definitions/RepoTopicOptions"
  7227. }
  7228. }
  7229. ],
  7230. "responses": {
  7231. "204": {
  7232. "$ref": "#/responses/empty"
  7233. },
  7234. "422": {
  7235. "$ref": "#/responses/invalidTopicsError"
  7236. }
  7237. }
  7238. }
  7239. },
  7240. "/repos/{owner}/{repo}/topics/{topic}": {
  7241. "put": {
  7242. "produces": [
  7243. "application/json"
  7244. ],
  7245. "tags": [
  7246. "repository"
  7247. ],
  7248. "summary": "Add a topic to a repository",
  7249. "operationId": "repoAddTopíc",
  7250. "parameters": [
  7251. {
  7252. "type": "string",
  7253. "description": "owner of the repo",
  7254. "name": "owner",
  7255. "in": "path",
  7256. "required": true
  7257. },
  7258. {
  7259. "type": "string",
  7260. "description": "name of the repo",
  7261. "name": "repo",
  7262. "in": "path",
  7263. "required": true
  7264. },
  7265. {
  7266. "type": "string",
  7267. "description": "name of the topic to add",
  7268. "name": "topic",
  7269. "in": "path",
  7270. "required": true
  7271. }
  7272. ],
  7273. "responses": {
  7274. "204": {
  7275. "$ref": "#/responses/empty"
  7276. },
  7277. "422": {
  7278. "$ref": "#/responses/invalidTopicsError"
  7279. }
  7280. }
  7281. },
  7282. "delete": {
  7283. "produces": [
  7284. "application/json"
  7285. ],
  7286. "tags": [
  7287. "repository"
  7288. ],
  7289. "summary": "Delete a topic from a repository",
  7290. "operationId": "repoDeleteTopic",
  7291. "parameters": [
  7292. {
  7293. "type": "string",
  7294. "description": "owner of the repo",
  7295. "name": "owner",
  7296. "in": "path",
  7297. "required": true
  7298. },
  7299. {
  7300. "type": "string",
  7301. "description": "name of the repo",
  7302. "name": "repo",
  7303. "in": "path",
  7304. "required": true
  7305. },
  7306. {
  7307. "type": "string",
  7308. "description": "name of the topic to delete",
  7309. "name": "topic",
  7310. "in": "path",
  7311. "required": true
  7312. }
  7313. ],
  7314. "responses": {
  7315. "204": {
  7316. "$ref": "#/responses/empty"
  7317. },
  7318. "422": {
  7319. "$ref": "#/responses/invalidTopicsError"
  7320. }
  7321. }
  7322. }
  7323. },
  7324. "/repos/{owner}/{repo}/transfer": {
  7325. "post": {
  7326. "produces": [
  7327. "application/json"
  7328. ],
  7329. "tags": [
  7330. "repository"
  7331. ],
  7332. "summary": "Transfer a repo ownership",
  7333. "operationId": "repoTransfer",
  7334. "parameters": [
  7335. {
  7336. "type": "string",
  7337. "description": "owner of the repo to transfer",
  7338. "name": "owner",
  7339. "in": "path",
  7340. "required": true
  7341. },
  7342. {
  7343. "type": "string",
  7344. "description": "name of the repo to transfer",
  7345. "name": "repo",
  7346. "in": "path",
  7347. "required": true
  7348. },
  7349. {
  7350. "description": "Transfer Options",
  7351. "name": "body",
  7352. "in": "body",
  7353. "required": true,
  7354. "schema": {
  7355. "$ref": "#/definitions/TransferRepoOption"
  7356. }
  7357. }
  7358. ],
  7359. "responses": {
  7360. "202": {
  7361. "$ref": "#/responses/Repository"
  7362. },
  7363. "403": {
  7364. "$ref": "#/responses/forbidden"
  7365. },
  7366. "404": {
  7367. "$ref": "#/responses/notFound"
  7368. },
  7369. "422": {
  7370. "$ref": "#/responses/validationError"
  7371. }
  7372. }
  7373. }
  7374. },
  7375. "/repositories/{id}": {
  7376. "get": {
  7377. "produces": [
  7378. "application/json"
  7379. ],
  7380. "tags": [
  7381. "repository"
  7382. ],
  7383. "summary": "Get a repository by id",
  7384. "operationId": "repoGetByID",
  7385. "parameters": [
  7386. {
  7387. "type": "integer",
  7388. "format": "int64",
  7389. "description": "id of the repo to get",
  7390. "name": "id",
  7391. "in": "path",
  7392. "required": true
  7393. }
  7394. ],
  7395. "responses": {
  7396. "200": {
  7397. "$ref": "#/responses/Repository"
  7398. }
  7399. }
  7400. }
  7401. },
  7402. "/signing-key.gpg": {
  7403. "get": {
  7404. "produces": [
  7405. "text/plain"
  7406. ],
  7407. "tags": [
  7408. "miscellaneous"
  7409. ],
  7410. "summary": "Get default signing-key.gpg",
  7411. "operationId": "getSigningKey",
  7412. "responses": {
  7413. "200": {
  7414. "description": "GPG armored public key",
  7415. "schema": {
  7416. "type": "string"
  7417. }
  7418. }
  7419. }
  7420. }
  7421. },
  7422. "/teams/{id}": {
  7423. "get": {
  7424. "produces": [
  7425. "application/json"
  7426. ],
  7427. "tags": [
  7428. "organization"
  7429. ],
  7430. "summary": "Get a team",
  7431. "operationId": "orgGetTeam",
  7432. "parameters": [
  7433. {
  7434. "type": "integer",
  7435. "format": "int64",
  7436. "description": "id of the team to get",
  7437. "name": "id",
  7438. "in": "path",
  7439. "required": true
  7440. }
  7441. ],
  7442. "responses": {
  7443. "200": {
  7444. "$ref": "#/responses/Team"
  7445. }
  7446. }
  7447. },
  7448. "delete": {
  7449. "tags": [
  7450. "organization"
  7451. ],
  7452. "summary": "Delete a team",
  7453. "operationId": "orgDeleteTeam",
  7454. "parameters": [
  7455. {
  7456. "type": "integer",
  7457. "format": "int64",
  7458. "description": "id of the team to delete",
  7459. "name": "id",
  7460. "in": "path",
  7461. "required": true
  7462. }
  7463. ],
  7464. "responses": {
  7465. "204": {
  7466. "description": "team deleted"
  7467. }
  7468. }
  7469. },
  7470. "patch": {
  7471. "consumes": [
  7472. "application/json"
  7473. ],
  7474. "produces": [
  7475. "application/json"
  7476. ],
  7477. "tags": [
  7478. "organization"
  7479. ],
  7480. "summary": "Edit a team",
  7481. "operationId": "orgEditTeam",
  7482. "parameters": [
  7483. {
  7484. "type": "integer",
  7485. "description": "id of the team to edit",
  7486. "name": "id",
  7487. "in": "path",
  7488. "required": true
  7489. },
  7490. {
  7491. "name": "body",
  7492. "in": "body",
  7493. "schema": {
  7494. "$ref": "#/definitions/EditTeamOption"
  7495. }
  7496. }
  7497. ],
  7498. "responses": {
  7499. "200": {
  7500. "$ref": "#/responses/Team"
  7501. }
  7502. }
  7503. }
  7504. },
  7505. "/teams/{id}/members": {
  7506. "get": {
  7507. "produces": [
  7508. "application/json"
  7509. ],
  7510. "tags": [
  7511. "organization"
  7512. ],
  7513. "summary": "List a team's members",
  7514. "operationId": "orgListTeamMembers",
  7515. "parameters": [
  7516. {
  7517. "type": "integer",
  7518. "format": "int64",
  7519. "description": "id of the team",
  7520. "name": "id",
  7521. "in": "path",
  7522. "required": true
  7523. },
  7524. {
  7525. "type": "integer",
  7526. "description": "page number of results to return (1-based)",
  7527. "name": "page",
  7528. "in": "query"
  7529. },
  7530. {
  7531. "type": "integer",
  7532. "description": "page size of results, maximum page size is 50",
  7533. "name": "limit",
  7534. "in": "query"
  7535. }
  7536. ],
  7537. "responses": {
  7538. "200": {
  7539. "$ref": "#/responses/UserList"
  7540. }
  7541. }
  7542. }
  7543. },
  7544. "/teams/{id}/members/{username}": {
  7545. "get": {
  7546. "produces": [
  7547. "application/json"
  7548. ],
  7549. "tags": [
  7550. "organization"
  7551. ],
  7552. "summary": "List a particular member of team",
  7553. "operationId": "orgListTeamMember",
  7554. "parameters": [
  7555. {
  7556. "type": "integer",
  7557. "format": "int64",
  7558. "description": "id of the team",
  7559. "name": "id",
  7560. "in": "path",
  7561. "required": true
  7562. },
  7563. {
  7564. "type": "string",
  7565. "description": "username of the member to list",
  7566. "name": "username",
  7567. "in": "path",
  7568. "required": true
  7569. }
  7570. ],
  7571. "responses": {
  7572. "200": {
  7573. "$ref": "#/responses/User"
  7574. },
  7575. "404": {
  7576. "$ref": "#/responses/notFound"
  7577. }
  7578. }
  7579. },
  7580. "put": {
  7581. "produces": [
  7582. "application/json"
  7583. ],
  7584. "tags": [
  7585. "organization"
  7586. ],
  7587. "summary": "Add a team member",
  7588. "operationId": "orgAddTeamMember",
  7589. "parameters": [
  7590. {
  7591. "type": "integer",
  7592. "format": "int64",
  7593. "description": "id of the team",
  7594. "name": "id",
  7595. "in": "path",
  7596. "required": true
  7597. },
  7598. {
  7599. "type": "string",
  7600. "description": "username of the user to add",
  7601. "name": "username",
  7602. "in": "path",
  7603. "required": true
  7604. }
  7605. ],
  7606. "responses": {
  7607. "204": {
  7608. "$ref": "#/responses/empty"
  7609. },
  7610. "404": {
  7611. "$ref": "#/responses/notFound"
  7612. }
  7613. }
  7614. },
  7615. "delete": {
  7616. "produces": [
  7617. "application/json"
  7618. ],
  7619. "tags": [
  7620. "organization"
  7621. ],
  7622. "summary": "Remove a team member",
  7623. "operationId": "orgRemoveTeamMember",
  7624. "parameters": [
  7625. {
  7626. "type": "integer",
  7627. "format": "int64",
  7628. "description": "id of the team",
  7629. "name": "id",
  7630. "in": "path",
  7631. "required": true
  7632. },
  7633. {
  7634. "type": "string",
  7635. "description": "username of the user to remove",
  7636. "name": "username",
  7637. "in": "path",
  7638. "required": true
  7639. }
  7640. ],
  7641. "responses": {
  7642. "204": {
  7643. "$ref": "#/responses/empty"
  7644. },
  7645. "404": {
  7646. "$ref": "#/responses/notFound"
  7647. }
  7648. }
  7649. }
  7650. },
  7651. "/teams/{id}/repos": {
  7652. "get": {
  7653. "produces": [
  7654. "application/json"
  7655. ],
  7656. "tags": [
  7657. "organization"
  7658. ],
  7659. "summary": "List a team's repos",
  7660. "operationId": "orgListTeamRepos",
  7661. "parameters": [
  7662. {
  7663. "type": "integer",
  7664. "format": "int64",
  7665. "description": "id of the team",
  7666. "name": "id",
  7667. "in": "path",
  7668. "required": true
  7669. },
  7670. {
  7671. "type": "integer",
  7672. "description": "page number of results to return (1-based)",
  7673. "name": "page",
  7674. "in": "query"
  7675. },
  7676. {
  7677. "type": "integer",
  7678. "description": "page size of results, maximum page size is 50",
  7679. "name": "limit",
  7680. "in": "query"
  7681. }
  7682. ],
  7683. "responses": {
  7684. "200": {
  7685. "$ref": "#/responses/RepositoryList"
  7686. }
  7687. }
  7688. }
  7689. },
  7690. "/teams/{id}/repos/{org}/{repo}": {
  7691. "put": {
  7692. "produces": [
  7693. "application/json"
  7694. ],
  7695. "tags": [
  7696. "organization"
  7697. ],
  7698. "summary": "Add a repository to a team",
  7699. "operationId": "orgAddTeamRepository",
  7700. "parameters": [
  7701. {
  7702. "type": "integer",
  7703. "format": "int64",
  7704. "description": "id of the team",
  7705. "name": "id",
  7706. "in": "path",
  7707. "required": true
  7708. },
  7709. {
  7710. "type": "string",
  7711. "description": "organization that owns the repo to add",
  7712. "name": "org",
  7713. "in": "path",
  7714. "required": true
  7715. },
  7716. {
  7717. "type": "string",
  7718. "description": "name of the repo to add",
  7719. "name": "repo",
  7720. "in": "path",
  7721. "required": true
  7722. }
  7723. ],
  7724. "responses": {
  7725. "204": {
  7726. "$ref": "#/responses/empty"
  7727. },
  7728. "403": {
  7729. "$ref": "#/responses/forbidden"
  7730. }
  7731. }
  7732. },
  7733. "delete": {
  7734. "description": "This does not delete the repository, it only removes the repository from the team.",
  7735. "produces": [
  7736. "application/json"
  7737. ],
  7738. "tags": [
  7739. "organization"
  7740. ],
  7741. "summary": "Remove a repository from a team",
  7742. "operationId": "orgRemoveTeamRepository",
  7743. "parameters": [
  7744. {
  7745. "type": "integer",
  7746. "format": "int64",
  7747. "description": "id of the team",
  7748. "name": "id",
  7749. "in": "path",
  7750. "required": true
  7751. },
  7752. {
  7753. "type": "string",
  7754. "description": "organization that owns the repo to remove",
  7755. "name": "org",
  7756. "in": "path",
  7757. "required": true
  7758. },
  7759. {
  7760. "type": "string",
  7761. "description": "name of the repo to remove",
  7762. "name": "repo",
  7763. "in": "path",
  7764. "required": true
  7765. }
  7766. ],
  7767. "responses": {
  7768. "204": {
  7769. "$ref": "#/responses/empty"
  7770. },
  7771. "403": {
  7772. "$ref": "#/responses/forbidden"
  7773. }
  7774. }
  7775. }
  7776. },
  7777. "/topics/search": {
  7778. "get": {
  7779. "produces": [
  7780. "application/json"
  7781. ],
  7782. "tags": [
  7783. "repository"
  7784. ],
  7785. "summary": "search topics via keyword",
  7786. "operationId": "topicSearch",
  7787. "parameters": [
  7788. {
  7789. "type": "string",
  7790. "description": "keywords to search",
  7791. "name": "q",
  7792. "in": "query",
  7793. "required": true
  7794. },
  7795. {
  7796. "type": "integer",
  7797. "description": "page number of results to return (1-based)",
  7798. "name": "page",
  7799. "in": "query"
  7800. },
  7801. {
  7802. "type": "integer",
  7803. "description": "page size of results, maximum page size is 50",
  7804. "name": "limit",
  7805. "in": "query"
  7806. }
  7807. ],
  7808. "responses": {
  7809. "200": {
  7810. "$ref": "#/responses/TopicListResponse"
  7811. },
  7812. "403": {
  7813. "$ref": "#/responses/forbidden"
  7814. }
  7815. }
  7816. }
  7817. },
  7818. "/user": {
  7819. "get": {
  7820. "produces": [
  7821. "application/json"
  7822. ],
  7823. "tags": [
  7824. "user"
  7825. ],
  7826. "summary": "Get the authenticated user",
  7827. "operationId": "userGetCurrent",
  7828. "responses": {
  7829. "200": {
  7830. "$ref": "#/responses/User"
  7831. }
  7832. }
  7833. }
  7834. },
  7835. "/user/emails": {
  7836. "get": {
  7837. "produces": [
  7838. "application/json"
  7839. ],
  7840. "tags": [
  7841. "user"
  7842. ],
  7843. "summary": "List the authenticated user's email addresses",
  7844. "operationId": "userListEmails",
  7845. "responses": {
  7846. "200": {
  7847. "$ref": "#/responses/EmailList"
  7848. }
  7849. }
  7850. },
  7851. "post": {
  7852. "produces": [
  7853. "application/json"
  7854. ],
  7855. "tags": [
  7856. "user"
  7857. ],
  7858. "summary": "Add email addresses",
  7859. "operationId": "userAddEmail",
  7860. "parameters": [
  7861. {
  7862. "name": "body",
  7863. "in": "body",
  7864. "schema": {
  7865. "$ref": "#/definitions/CreateEmailOption"
  7866. }
  7867. }
  7868. ],
  7869. "responses": {
  7870. "201": {
  7871. "$ref": "#/responses/EmailList"
  7872. },
  7873. "422": {
  7874. "$ref": "#/responses/validationError"
  7875. }
  7876. }
  7877. },
  7878. "delete": {
  7879. "produces": [
  7880. "application/json"
  7881. ],
  7882. "tags": [
  7883. "user"
  7884. ],
  7885. "summary": "Delete email addresses",
  7886. "operationId": "userDeleteEmail",
  7887. "parameters": [
  7888. {
  7889. "name": "body",
  7890. "in": "body",
  7891. "schema": {
  7892. "$ref": "#/definitions/DeleteEmailOption"
  7893. }
  7894. }
  7895. ],
  7896. "responses": {
  7897. "204": {
  7898. "$ref": "#/responses/empty"
  7899. }
  7900. }
  7901. }
  7902. },
  7903. "/user/followers": {
  7904. "get": {
  7905. "produces": [
  7906. "application/json"
  7907. ],
  7908. "tags": [
  7909. "user"
  7910. ],
  7911. "summary": "List the authenticated user's followers",
  7912. "operationId": "userCurrentListFollowers",
  7913. "parameters": [
  7914. {
  7915. "type": "integer",
  7916. "description": "page number of results to return (1-based)",
  7917. "name": "page",
  7918. "in": "query"
  7919. },
  7920. {
  7921. "type": "integer",
  7922. "description": "page size of results, maximum page size is 50",
  7923. "name": "limit",
  7924. "in": "query"
  7925. }
  7926. ],
  7927. "responses": {
  7928. "200": {
  7929. "$ref": "#/responses/UserList"
  7930. }
  7931. }
  7932. }
  7933. },
  7934. "/user/following": {
  7935. "get": {
  7936. "produces": [
  7937. "application/json"
  7938. ],
  7939. "tags": [
  7940. "user"
  7941. ],
  7942. "summary": "List the users that the authenticated user is following",
  7943. "operationId": "userCurrentListFollowing",
  7944. "parameters": [
  7945. {
  7946. "type": "integer",
  7947. "description": "page number of results to return (1-based)",
  7948. "name": "page",
  7949. "in": "query"
  7950. },
  7951. {
  7952. "type": "integer",
  7953. "description": "page size of results, maximum page size is 50",
  7954. "name": "limit",
  7955. "in": "query"
  7956. }
  7957. ],
  7958. "responses": {
  7959. "200": {
  7960. "$ref": "#/responses/UserList"
  7961. }
  7962. }
  7963. }
  7964. },
  7965. "/user/following/{username}": {
  7966. "get": {
  7967. "tags": [
  7968. "user"
  7969. ],
  7970. "summary": "Check whether a user is followed by the authenticated user",
  7971. "operationId": "userCurrentCheckFollowing",
  7972. "parameters": [
  7973. {
  7974. "type": "string",
  7975. "description": "username of followed user",
  7976. "name": "username",
  7977. "in": "path",
  7978. "required": true
  7979. }
  7980. ],
  7981. "responses": {
  7982. "204": {
  7983. "$ref": "#/responses/empty"
  7984. },
  7985. "404": {
  7986. "$ref": "#/responses/notFound"
  7987. }
  7988. }
  7989. },
  7990. "put": {
  7991. "tags": [
  7992. "user"
  7993. ],
  7994. "summary": "Follow a user",
  7995. "operationId": "userCurrentPutFollow",
  7996. "parameters": [
  7997. {
  7998. "type": "string",
  7999. "description": "username of user to follow",
  8000. "name": "username",
  8001. "in": "path",
  8002. "required": true
  8003. }
  8004. ],
  8005. "responses": {
  8006. "204": {
  8007. "$ref": "#/responses/empty"
  8008. }
  8009. }
  8010. },
  8011. "delete": {
  8012. "tags": [
  8013. "user"
  8014. ],
  8015. "summary": "Unfollow a user",
  8016. "operationId": "userCurrentDeleteFollow",
  8017. "parameters": [
  8018. {
  8019. "type": "string",
  8020. "description": "username of user to unfollow",
  8021. "name": "username",
  8022. "in": "path",
  8023. "required": true
  8024. }
  8025. ],
  8026. "responses": {
  8027. "204": {
  8028. "$ref": "#/responses/empty"
  8029. }
  8030. }
  8031. }
  8032. },
  8033. "/user/gpg_keys": {
  8034. "get": {
  8035. "produces": [
  8036. "application/json"
  8037. ],
  8038. "tags": [
  8039. "user"
  8040. ],
  8041. "summary": "List the authenticated user's GPG keys",
  8042. "operationId": "userCurrentListGPGKeys",
  8043. "parameters": [
  8044. {
  8045. "type": "integer",
  8046. "description": "page number of results to return (1-based)",
  8047. "name": "page",
  8048. "in": "query"
  8049. },
  8050. {
  8051. "type": "integer",
  8052. "description": "page size of results, maximum page size is 50",
  8053. "name": "limit",
  8054. "in": "query"
  8055. }
  8056. ],
  8057. "responses": {
  8058. "200": {
  8059. "$ref": "#/responses/GPGKeyList"
  8060. }
  8061. }
  8062. },
  8063. "post": {
  8064. "consumes": [
  8065. "application/json"
  8066. ],
  8067. "produces": [
  8068. "application/json"
  8069. ],
  8070. "tags": [
  8071. "user"
  8072. ],
  8073. "summary": "Create a GPG key",
  8074. "operationId": "userCurrentPostGPGKey",
  8075. "parameters": [
  8076. {
  8077. "name": "Form",
  8078. "in": "body",
  8079. "schema": {
  8080. "$ref": "#/definitions/CreateGPGKeyOption"
  8081. }
  8082. }
  8083. ],
  8084. "responses": {
  8085. "201": {
  8086. "$ref": "#/responses/GPGKey"
  8087. },
  8088. "422": {
  8089. "$ref": "#/responses/validationError"
  8090. }
  8091. }
  8092. }
  8093. },
  8094. "/user/gpg_keys/{id}": {
  8095. "get": {
  8096. "produces": [
  8097. "application/json"
  8098. ],
  8099. "tags": [
  8100. "user"
  8101. ],
  8102. "summary": "Get a GPG key",
  8103. "operationId": "userCurrentGetGPGKey",
  8104. "parameters": [
  8105. {
  8106. "type": "integer",
  8107. "format": "int64",
  8108. "description": "id of key to get",
  8109. "name": "id",
  8110. "in": "path",
  8111. "required": true
  8112. }
  8113. ],
  8114. "responses": {
  8115. "200": {
  8116. "$ref": "#/responses/GPGKey"
  8117. },
  8118. "404": {
  8119. "$ref": "#/responses/notFound"
  8120. }
  8121. }
  8122. },
  8123. "delete": {
  8124. "produces": [
  8125. "application/json"
  8126. ],
  8127. "tags": [
  8128. "user"
  8129. ],
  8130. "summary": "Remove a GPG key",
  8131. "operationId": "userCurrentDeleteGPGKey",
  8132. "parameters": [
  8133. {
  8134. "type": "integer",
  8135. "format": "int64",
  8136. "description": "id of key to delete",
  8137. "name": "id",
  8138. "in": "path",
  8139. "required": true
  8140. }
  8141. ],
  8142. "responses": {
  8143. "204": {
  8144. "$ref": "#/responses/empty"
  8145. },
  8146. "403": {
  8147. "$ref": "#/responses/forbidden"
  8148. }
  8149. }
  8150. }
  8151. },
  8152. "/user/keys": {
  8153. "get": {
  8154. "produces": [
  8155. "application/json"
  8156. ],
  8157. "tags": [
  8158. "user"
  8159. ],
  8160. "summary": "List the authenticated user's public keys",
  8161. "operationId": "userCurrentListKeys",
  8162. "parameters": [
  8163. {
  8164. "type": "string",
  8165. "description": "fingerprint of the key",
  8166. "name": "fingerprint",
  8167. "in": "query"
  8168. },
  8169. {
  8170. "type": "integer",
  8171. "description": "page number of results to return (1-based)",
  8172. "name": "page",
  8173. "in": "query"
  8174. },
  8175. {
  8176. "type": "integer",
  8177. "description": "page size of results, maximum page size is 50",
  8178. "name": "limit",
  8179. "in": "query"
  8180. }
  8181. ],
  8182. "responses": {
  8183. "200": {
  8184. "$ref": "#/responses/PublicKeyList"
  8185. }
  8186. }
  8187. },
  8188. "post": {
  8189. "consumes": [
  8190. "application/json"
  8191. ],
  8192. "produces": [
  8193. "application/json"
  8194. ],
  8195. "tags": [
  8196. "user"
  8197. ],
  8198. "summary": "Create a public key",
  8199. "operationId": "userCurrentPostKey",
  8200. "parameters": [
  8201. {
  8202. "name": "body",
  8203. "in": "body",
  8204. "schema": {
  8205. "$ref": "#/definitions/CreateKeyOption"
  8206. }
  8207. }
  8208. ],
  8209. "responses": {
  8210. "201": {
  8211. "$ref": "#/responses/PublicKey"
  8212. },
  8213. "422": {
  8214. "$ref": "#/responses/validationError"
  8215. }
  8216. }
  8217. }
  8218. },
  8219. "/user/keys/{id}": {
  8220. "get": {
  8221. "produces": [
  8222. "application/json"
  8223. ],
  8224. "tags": [
  8225. "user"
  8226. ],
  8227. "summary": "Get a public key",
  8228. "operationId": "userCurrentGetKey",
  8229. "parameters": [
  8230. {
  8231. "type": "integer",
  8232. "format": "int64",
  8233. "description": "id of key to get",
  8234. "name": "id",
  8235. "in": "path",
  8236. "required": true
  8237. }
  8238. ],
  8239. "responses": {
  8240. "200": {
  8241. "$ref": "#/responses/PublicKey"
  8242. },
  8243. "404": {
  8244. "$ref": "#/responses/notFound"
  8245. }
  8246. }
  8247. },
  8248. "delete": {
  8249. "produces": [
  8250. "application/json"
  8251. ],
  8252. "tags": [
  8253. "user"
  8254. ],
  8255. "summary": "Delete a public key",
  8256. "operationId": "userCurrentDeleteKey",
  8257. "parameters": [
  8258. {
  8259. "type": "integer",
  8260. "format": "int64",
  8261. "description": "id of key to delete",
  8262. "name": "id",
  8263. "in": "path",
  8264. "required": true
  8265. }
  8266. ],
  8267. "responses": {
  8268. "204": {
  8269. "$ref": "#/responses/empty"
  8270. },
  8271. "403": {
  8272. "$ref": "#/responses/forbidden"
  8273. },
  8274. "404": {
  8275. "$ref": "#/responses/notFound"
  8276. }
  8277. }
  8278. }
  8279. },
  8280. "/user/orgs": {
  8281. "get": {
  8282. "produces": [
  8283. "application/json"
  8284. ],
  8285. "tags": [
  8286. "organization"
  8287. ],
  8288. "summary": "List the current user's organizations",
  8289. "operationId": "orgListCurrentUserOrgs",
  8290. "parameters": [
  8291. {
  8292. "type": "integer",
  8293. "description": "page number of results to return (1-based)",
  8294. "name": "page",
  8295. "in": "query"
  8296. },
  8297. {
  8298. "type": "integer",
  8299. "description": "page size of results, maximum page size is 50",
  8300. "name": "limit",
  8301. "in": "query"
  8302. }
  8303. ],
  8304. "responses": {
  8305. "200": {
  8306. "$ref": "#/responses/OrganizationList"
  8307. }
  8308. }
  8309. }
  8310. },
  8311. "/user/repos": {
  8312. "get": {
  8313. "produces": [
  8314. "application/json"
  8315. ],
  8316. "tags": [
  8317. "user"
  8318. ],
  8319. "summary": "List the repos that the authenticated user owns or has access to",
  8320. "operationId": "userCurrentListRepos",
  8321. "parameters": [
  8322. {
  8323. "type": "integer",
  8324. "description": "page number of results to return (1-based)",
  8325. "name": "page",
  8326. "in": "query"
  8327. },
  8328. {
  8329. "type": "integer",
  8330. "description": "page size of results, maximum page size is 50",
  8331. "name": "limit",
  8332. "in": "query"
  8333. }
  8334. ],
  8335. "responses": {
  8336. "200": {
  8337. "$ref": "#/responses/RepositoryList"
  8338. }
  8339. }
  8340. },
  8341. "post": {
  8342. "consumes": [
  8343. "application/json"
  8344. ],
  8345. "produces": [
  8346. "application/json"
  8347. ],
  8348. "tags": [
  8349. "repository",
  8350. "user"
  8351. ],
  8352. "summary": "Create a repository",
  8353. "operationId": "createCurrentUserRepo",
  8354. "parameters": [
  8355. {
  8356. "name": "body",
  8357. "in": "body",
  8358. "schema": {
  8359. "$ref": "#/definitions/CreateRepoOption"
  8360. }
  8361. }
  8362. ],
  8363. "responses": {
  8364. "201": {
  8365. "$ref": "#/responses/Repository"
  8366. },
  8367. "409": {
  8368. "description": "The repository with the same name already exists."
  8369. },
  8370. "422": {
  8371. "$ref": "#/responses/validationError"
  8372. }
  8373. }
  8374. }
  8375. },
  8376. "/user/starred": {
  8377. "get": {
  8378. "produces": [
  8379. "application/json"
  8380. ],
  8381. "tags": [
  8382. "user"
  8383. ],
  8384. "summary": "The repos that the authenticated user has starred",
  8385. "operationId": "userCurrentListStarred",
  8386. "parameters": [
  8387. {
  8388. "type": "integer",
  8389. "description": "page number of results to return (1-based)",
  8390. "name": "page",
  8391. "in": "query"
  8392. },
  8393. {
  8394. "type": "integer",
  8395. "description": "page size of results, maximum page size is 50",
  8396. "name": "limit",
  8397. "in": "query"
  8398. }
  8399. ],
  8400. "responses": {
  8401. "200": {
  8402. "$ref": "#/responses/RepositoryList"
  8403. }
  8404. }
  8405. }
  8406. },
  8407. "/user/starred/{owner}/{repo}": {
  8408. "get": {
  8409. "tags": [
  8410. "user"
  8411. ],
  8412. "summary": "Whether the authenticated is starring the repo",
  8413. "operationId": "userCurrentCheckStarring",
  8414. "parameters": [
  8415. {
  8416. "type": "string",
  8417. "description": "owner of the repo",
  8418. "name": "owner",
  8419. "in": "path",
  8420. "required": true
  8421. },
  8422. {
  8423. "type": "string",
  8424. "description": "name of the repo",
  8425. "name": "repo",
  8426. "in": "path",
  8427. "required": true
  8428. }
  8429. ],
  8430. "responses": {
  8431. "204": {
  8432. "$ref": "#/responses/empty"
  8433. },
  8434. "404": {
  8435. "$ref": "#/responses/notFound"
  8436. }
  8437. }
  8438. },
  8439. "put": {
  8440. "tags": [
  8441. "user"
  8442. ],
  8443. "summary": "Star the given repo",
  8444. "operationId": "userCurrentPutStar",
  8445. "parameters": [
  8446. {
  8447. "type": "string",
  8448. "description": "owner of the repo to star",
  8449. "name": "owner",
  8450. "in": "path",
  8451. "required": true
  8452. },
  8453. {
  8454. "type": "string",
  8455. "description": "name of the repo to star",
  8456. "name": "repo",
  8457. "in": "path",
  8458. "required": true
  8459. }
  8460. ],
  8461. "responses": {
  8462. "204": {
  8463. "$ref": "#/responses/empty"
  8464. }
  8465. }
  8466. },
  8467. "delete": {
  8468. "tags": [
  8469. "user"
  8470. ],
  8471. "summary": "Unstar the given repo",
  8472. "operationId": "userCurrentDeleteStar",
  8473. "parameters": [
  8474. {
  8475. "type": "string",
  8476. "description": "owner of the repo to unstar",
  8477. "name": "owner",
  8478. "in": "path",
  8479. "required": true
  8480. },
  8481. {
  8482. "type": "string",
  8483. "description": "name of the repo to unstar",
  8484. "name": "repo",
  8485. "in": "path",
  8486. "required": true
  8487. }
  8488. ],
  8489. "responses": {
  8490. "204": {
  8491. "$ref": "#/responses/empty"
  8492. }
  8493. }
  8494. }
  8495. },
  8496. "/user/stopwatches": {
  8497. "get": {
  8498. "consumes": [
  8499. "application/json"
  8500. ],
  8501. "produces": [
  8502. "application/json"
  8503. ],
  8504. "tags": [
  8505. "user"
  8506. ],
  8507. "summary": "Get list of all existing stopwatches",
  8508. "operationId": "userGetStopWatches",
  8509. "parameters": [
  8510. {
  8511. "type": "integer",
  8512. "description": "page number of results to return (1-based)",
  8513. "name": "page",
  8514. "in": "query"
  8515. },
  8516. {
  8517. "type": "integer",
  8518. "description": "page size of results, maximum page size is 50",
  8519. "name": "limit",
  8520. "in": "query"
  8521. }
  8522. ],
  8523. "responses": {
  8524. "200": {
  8525. "$ref": "#/responses/StopWatchList"
  8526. }
  8527. }
  8528. }
  8529. },
  8530. "/user/subscriptions": {
  8531. "get": {
  8532. "produces": [
  8533. "application/json"
  8534. ],
  8535. "tags": [
  8536. "user"
  8537. ],
  8538. "summary": "List repositories watched by the authenticated user",
  8539. "operationId": "userCurrentListSubscriptions",
  8540. "parameters": [
  8541. {
  8542. "type": "integer",
  8543. "description": "page number of results to return (1-based)",
  8544. "name": "page",
  8545. "in": "query"
  8546. },
  8547. {
  8548. "type": "integer",
  8549. "description": "page size of results, maximum page size is 50",
  8550. "name": "limit",
  8551. "in": "query"
  8552. }
  8553. ],
  8554. "responses": {
  8555. "200": {
  8556. "$ref": "#/responses/RepositoryList"
  8557. }
  8558. }
  8559. }
  8560. },
  8561. "/user/teams": {
  8562. "get": {
  8563. "produces": [
  8564. "application/json"
  8565. ],
  8566. "tags": [
  8567. "user"
  8568. ],
  8569. "summary": "List all the teams a user belongs to",
  8570. "operationId": "userListTeams",
  8571. "parameters": [
  8572. {
  8573. "type": "integer",
  8574. "description": "page number of results to return (1-based)",
  8575. "name": "page",
  8576. "in": "query"
  8577. },
  8578. {
  8579. "type": "integer",
  8580. "description": "page size of results, maximum page size is 50",
  8581. "name": "limit",
  8582. "in": "query"
  8583. }
  8584. ],
  8585. "responses": {
  8586. "200": {
  8587. "$ref": "#/responses/TeamList"
  8588. }
  8589. }
  8590. }
  8591. },
  8592. "/user/times": {
  8593. "get": {
  8594. "produces": [
  8595. "application/json"
  8596. ],
  8597. "tags": [
  8598. "user"
  8599. ],
  8600. "summary": "List the current user's tracked times",
  8601. "operationId": "userCurrentTrackedTimes",
  8602. "parameters": [
  8603. {
  8604. "type": "string",
  8605. "format": "date-time",
  8606. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8607. "name": "since",
  8608. "in": "query"
  8609. },
  8610. {
  8611. "type": "string",
  8612. "format": "date-time",
  8613. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8614. "name": "before",
  8615. "in": "query"
  8616. }
  8617. ],
  8618. "responses": {
  8619. "200": {
  8620. "$ref": "#/responses/TrackedTimeList"
  8621. }
  8622. }
  8623. }
  8624. },
  8625. "/users/search": {
  8626. "get": {
  8627. "produces": [
  8628. "application/json"
  8629. ],
  8630. "tags": [
  8631. "user"
  8632. ],
  8633. "summary": "Search for users",
  8634. "operationId": "userSearch",
  8635. "parameters": [
  8636. {
  8637. "type": "string",
  8638. "description": "keyword",
  8639. "name": "q",
  8640. "in": "query"
  8641. },
  8642. {
  8643. "type": "integer",
  8644. "format": "int64",
  8645. "description": "ID of the user to search for",
  8646. "name": "uid",
  8647. "in": "query"
  8648. },
  8649. {
  8650. "type": "integer",
  8651. "description": "page number of results to return (1-based)",
  8652. "name": "page",
  8653. "in": "query"
  8654. },
  8655. {
  8656. "type": "integer",
  8657. "description": "page size of results, maximum page size is 50",
  8658. "name": "limit",
  8659. "in": "query"
  8660. }
  8661. ],
  8662. "responses": {
  8663. "200": {
  8664. "description": "SearchResults of a successful search",
  8665. "schema": {
  8666. "type": "object",
  8667. "properties": {
  8668. "data": {
  8669. "type": "array",
  8670. "items": {
  8671. "$ref": "#/definitions/User"
  8672. }
  8673. },
  8674. "ok": {
  8675. "type": "boolean"
  8676. }
  8677. }
  8678. }
  8679. }
  8680. }
  8681. }
  8682. },
  8683. "/users/{follower}/following/{followee}": {
  8684. "get": {
  8685. "tags": [
  8686. "user"
  8687. ],
  8688. "summary": "Check if one user is following another user",
  8689. "operationId": "userCheckFollowing",
  8690. "parameters": [
  8691. {
  8692. "type": "string",
  8693. "description": "username of following user",
  8694. "name": "follower",
  8695. "in": "path",
  8696. "required": true
  8697. },
  8698. {
  8699. "type": "string",
  8700. "description": "username of followed user",
  8701. "name": "followee",
  8702. "in": "path",
  8703. "required": true
  8704. }
  8705. ],
  8706. "responses": {
  8707. "204": {
  8708. "$ref": "#/responses/empty"
  8709. },
  8710. "404": {
  8711. "$ref": "#/responses/notFound"
  8712. }
  8713. }
  8714. }
  8715. },
  8716. "/users/{username}": {
  8717. "get": {
  8718. "produces": [
  8719. "application/json"
  8720. ],
  8721. "tags": [
  8722. "user"
  8723. ],
  8724. "summary": "Get a user",
  8725. "operationId": "userGet",
  8726. "parameters": [
  8727. {
  8728. "type": "string",
  8729. "description": "username of user to get",
  8730. "name": "username",
  8731. "in": "path",
  8732. "required": true
  8733. }
  8734. ],
  8735. "responses": {
  8736. "200": {
  8737. "$ref": "#/responses/User"
  8738. },
  8739. "404": {
  8740. "$ref": "#/responses/notFound"
  8741. }
  8742. }
  8743. }
  8744. },
  8745. "/users/{username}/followers": {
  8746. "get": {
  8747. "produces": [
  8748. "application/json"
  8749. ],
  8750. "tags": [
  8751. "user"
  8752. ],
  8753. "summary": "List the given user's followers",
  8754. "operationId": "userListFollowers",
  8755. "parameters": [
  8756. {
  8757. "type": "string",
  8758. "description": "username of user",
  8759. "name": "username",
  8760. "in": "path",
  8761. "required": true
  8762. },
  8763. {
  8764. "type": "integer",
  8765. "description": "page number of results to return (1-based)",
  8766. "name": "page",
  8767. "in": "query"
  8768. },
  8769. {
  8770. "type": "integer",
  8771. "description": "page size of results, maximum page size is 50",
  8772. "name": "limit",
  8773. "in": "query"
  8774. }
  8775. ],
  8776. "responses": {
  8777. "200": {
  8778. "$ref": "#/responses/UserList"
  8779. }
  8780. }
  8781. }
  8782. },
  8783. "/users/{username}/following": {
  8784. "get": {
  8785. "produces": [
  8786. "application/json"
  8787. ],
  8788. "tags": [
  8789. "user"
  8790. ],
  8791. "summary": "List the users that the given user is following",
  8792. "operationId": "userListFollowing",
  8793. "parameters": [
  8794. {
  8795. "type": "string",
  8796. "description": "username of user",
  8797. "name": "username",
  8798. "in": "path",
  8799. "required": true
  8800. },
  8801. {
  8802. "type": "integer",
  8803. "description": "page number of results to return (1-based)",
  8804. "name": "page",
  8805. "in": "query"
  8806. },
  8807. {
  8808. "type": "integer",
  8809. "description": "page size of results, maximum page size is 50",
  8810. "name": "limit",
  8811. "in": "query"
  8812. }
  8813. ],
  8814. "responses": {
  8815. "200": {
  8816. "$ref": "#/responses/UserList"
  8817. }
  8818. }
  8819. }
  8820. },
  8821. "/users/{username}/gpg_keys": {
  8822. "get": {
  8823. "produces": [
  8824. "application/json"
  8825. ],
  8826. "tags": [
  8827. "user"
  8828. ],
  8829. "summary": "List the given user's GPG keys",
  8830. "operationId": "userListGPGKeys",
  8831. "parameters": [
  8832. {
  8833. "type": "string",
  8834. "description": "username of user",
  8835. "name": "username",
  8836. "in": "path",
  8837. "required": true
  8838. },
  8839. {
  8840. "type": "integer",
  8841. "description": "page number of results to return (1-based)",
  8842. "name": "page",
  8843. "in": "query"
  8844. },
  8845. {
  8846. "type": "integer",
  8847. "description": "page size of results, maximum page size is 50",
  8848. "name": "limit",
  8849. "in": "query"
  8850. }
  8851. ],
  8852. "responses": {
  8853. "200": {
  8854. "$ref": "#/responses/GPGKeyList"
  8855. }
  8856. }
  8857. }
  8858. },
  8859. "/users/{username}/heatmap": {
  8860. "get": {
  8861. "produces": [
  8862. "application/json"
  8863. ],
  8864. "tags": [
  8865. "user"
  8866. ],
  8867. "summary": "Get a user's heatmap",
  8868. "operationId": "userGetHeatmapData",
  8869. "parameters": [
  8870. {
  8871. "type": "string",
  8872. "description": "username of user to get",
  8873. "name": "username",
  8874. "in": "path",
  8875. "required": true
  8876. }
  8877. ],
  8878. "responses": {
  8879. "200": {
  8880. "$ref": "#/responses/UserHeatmapData"
  8881. },
  8882. "404": {
  8883. "$ref": "#/responses/notFound"
  8884. }
  8885. }
  8886. }
  8887. },
  8888. "/users/{username}/keys": {
  8889. "get": {
  8890. "produces": [
  8891. "application/json"
  8892. ],
  8893. "tags": [
  8894. "user"
  8895. ],
  8896. "summary": "List the given user's public keys",
  8897. "operationId": "userListKeys",
  8898. "parameters": [
  8899. {
  8900. "type": "string",
  8901. "description": "username of user",
  8902. "name": "username",
  8903. "in": "path",
  8904. "required": true
  8905. },
  8906. {
  8907. "type": "string",
  8908. "description": "fingerprint of the key",
  8909. "name": "fingerprint",
  8910. "in": "query"
  8911. },
  8912. {
  8913. "type": "integer",
  8914. "description": "page number of results to return (1-based)",
  8915. "name": "page",
  8916. "in": "query"
  8917. },
  8918. {
  8919. "type": "integer",
  8920. "description": "page size of results, maximum page size is 50",
  8921. "name": "limit",
  8922. "in": "query"
  8923. }
  8924. ],
  8925. "responses": {
  8926. "200": {
  8927. "$ref": "#/responses/PublicKeyList"
  8928. }
  8929. }
  8930. }
  8931. },
  8932. "/users/{username}/orgs": {
  8933. "get": {
  8934. "produces": [
  8935. "application/json"
  8936. ],
  8937. "tags": [
  8938. "organization"
  8939. ],
  8940. "summary": "List a user's organizations",
  8941. "operationId": "orgListUserOrgs",
  8942. "parameters": [
  8943. {
  8944. "type": "string",
  8945. "description": "username of user",
  8946. "name": "username",
  8947. "in": "path",
  8948. "required": true
  8949. },
  8950. {
  8951. "type": "integer",
  8952. "description": "page number of results to return (1-based)",
  8953. "name": "page",
  8954. "in": "query"
  8955. },
  8956. {
  8957. "type": "integer",
  8958. "description": "page size of results, maximum page size is 50",
  8959. "name": "limit",
  8960. "in": "query"
  8961. }
  8962. ],
  8963. "responses": {
  8964. "200": {
  8965. "$ref": "#/responses/OrganizationList"
  8966. }
  8967. }
  8968. }
  8969. },
  8970. "/users/{username}/repos": {
  8971. "get": {
  8972. "produces": [
  8973. "application/json"
  8974. ],
  8975. "tags": [
  8976. "user"
  8977. ],
  8978. "summary": "List the repos owned by the given user",
  8979. "operationId": "userListRepos",
  8980. "parameters": [
  8981. {
  8982. "type": "string",
  8983. "description": "username of user",
  8984. "name": "username",
  8985. "in": "path",
  8986. "required": true
  8987. },
  8988. {
  8989. "type": "integer",
  8990. "description": "page number of results to return (1-based)",
  8991. "name": "page",
  8992. "in": "query"
  8993. },
  8994. {
  8995. "type": "integer",
  8996. "description": "page size of results, maximum page size is 50",
  8997. "name": "limit",
  8998. "in": "query"
  8999. }
  9000. ],
  9001. "responses": {
  9002. "200": {
  9003. "$ref": "#/responses/RepositoryList"
  9004. }
  9005. }
  9006. }
  9007. },
  9008. "/users/{username}/starred": {
  9009. "get": {
  9010. "produces": [
  9011. "application/json"
  9012. ],
  9013. "tags": [
  9014. "user"
  9015. ],
  9016. "summary": "The repos that the given user has starred",
  9017. "operationId": "userListStarred",
  9018. "parameters": [
  9019. {
  9020. "type": "string",
  9021. "description": "username of user",
  9022. "name": "username",
  9023. "in": "path",
  9024. "required": true
  9025. },
  9026. {
  9027. "type": "integer",
  9028. "description": "page number of results to return (1-based)",
  9029. "name": "page",
  9030. "in": "query"
  9031. },
  9032. {
  9033. "type": "integer",
  9034. "description": "page size of results, maximum page size is 50",
  9035. "name": "limit",
  9036. "in": "query"
  9037. }
  9038. ],
  9039. "responses": {
  9040. "200": {
  9041. "$ref": "#/responses/RepositoryList"
  9042. }
  9043. }
  9044. }
  9045. },
  9046. "/users/{username}/subscriptions": {
  9047. "get": {
  9048. "produces": [
  9049. "application/json"
  9050. ],
  9051. "tags": [
  9052. "user"
  9053. ],
  9054. "summary": "List the repositories watched by a user",
  9055. "operationId": "userListSubscriptions",
  9056. "parameters": [
  9057. {
  9058. "type": "string",
  9059. "description": "username of the user",
  9060. "name": "username",
  9061. "in": "path",
  9062. "required": true
  9063. },
  9064. {
  9065. "type": "integer",
  9066. "description": "page number of results to return (1-based)",
  9067. "name": "page",
  9068. "in": "query"
  9069. },
  9070. {
  9071. "type": "integer",
  9072. "description": "page size of results, maximum page size is 50",
  9073. "name": "limit",
  9074. "in": "query"
  9075. }
  9076. ],
  9077. "responses": {
  9078. "200": {
  9079. "$ref": "#/responses/RepositoryList"
  9080. }
  9081. }
  9082. }
  9083. },
  9084. "/users/{username}/tokens": {
  9085. "get": {
  9086. "produces": [
  9087. "application/json"
  9088. ],
  9089. "tags": [
  9090. "user"
  9091. ],
  9092. "summary": "List the authenticated user's access tokens",
  9093. "operationId": "userGetTokens",
  9094. "parameters": [
  9095. {
  9096. "type": "string",
  9097. "description": "username of user",
  9098. "name": "username",
  9099. "in": "path",
  9100. "required": true
  9101. },
  9102. {
  9103. "type": "integer",
  9104. "description": "page number of results to return (1-based)",
  9105. "name": "page",
  9106. "in": "query"
  9107. },
  9108. {
  9109. "type": "integer",
  9110. "description": "page size of results, maximum page size is 50",
  9111. "name": "limit",
  9112. "in": "query"
  9113. }
  9114. ],
  9115. "responses": {
  9116. "200": {
  9117. "$ref": "#/responses/AccessTokenList"
  9118. }
  9119. }
  9120. },
  9121. "post": {
  9122. "consumes": [
  9123. "application/json"
  9124. ],
  9125. "produces": [
  9126. "application/json"
  9127. ],
  9128. "tags": [
  9129. "user"
  9130. ],
  9131. "summary": "Create an access token",
  9132. "operationId": "userCreateToken",
  9133. "parameters": [
  9134. {
  9135. "type": "string",
  9136. "x-go-name": "Name",
  9137. "description": "username of user",
  9138. "name": "username",
  9139. "in": "path",
  9140. "required": true
  9141. },
  9142. {
  9143. "name": "accessToken",
  9144. "in": "body",
  9145. "schema": {
  9146. "type": "object",
  9147. "required": [
  9148. "name"
  9149. ],
  9150. "properties": {
  9151. "name": {
  9152. "type": "string"
  9153. }
  9154. }
  9155. }
  9156. }
  9157. ],
  9158. "responses": {
  9159. "200": {
  9160. "$ref": "#/responses/AccessToken"
  9161. }
  9162. }
  9163. }
  9164. },
  9165. "/users/{username}/tokens/{token}": {
  9166. "delete": {
  9167. "produces": [
  9168. "application/json"
  9169. ],
  9170. "tags": [
  9171. "user"
  9172. ],
  9173. "summary": "delete an access token",
  9174. "operationId": "userDeleteAccessToken",
  9175. "parameters": [
  9176. {
  9177. "type": "string",
  9178. "description": "username of user",
  9179. "name": "username",
  9180. "in": "path",
  9181. "required": true
  9182. },
  9183. {
  9184. "type": "integer",
  9185. "format": "int64",
  9186. "description": "token to be deleted",
  9187. "name": "token",
  9188. "in": "path",
  9189. "required": true
  9190. }
  9191. ],
  9192. "responses": {
  9193. "204": {
  9194. "$ref": "#/responses/empty"
  9195. }
  9196. }
  9197. }
  9198. },
  9199. "/version": {
  9200. "get": {
  9201. "produces": [
  9202. "application/json"
  9203. ],
  9204. "tags": [
  9205. "miscellaneous"
  9206. ],
  9207. "summary": "Returns the version of the Gitea application",
  9208. "operationId": "getVersion",
  9209. "responses": {
  9210. "200": {
  9211. "$ref": "#/responses/ServerVersion"
  9212. }
  9213. }
  9214. }
  9215. }
  9216. },
  9217. "definitions": {
  9218. "APIError": {
  9219. "description": "APIError is an api error with a message",
  9220. "type": "object",
  9221. "properties": {
  9222. "message": {
  9223. "type": "string",
  9224. "x-go-name": "Message"
  9225. },
  9226. "url": {
  9227. "type": "string",
  9228. "x-go-name": "URL"
  9229. }
  9230. },
  9231. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9232. },
  9233. "AccessToken": {
  9234. "type": "object",
  9235. "title": "AccessToken represents an API access token.",
  9236. "properties": {
  9237. "id": {
  9238. "type": "integer",
  9239. "format": "int64",
  9240. "x-go-name": "ID"
  9241. },
  9242. "name": {
  9243. "type": "string",
  9244. "x-go-name": "Name"
  9245. },
  9246. "sha1": {
  9247. "type": "string",
  9248. "x-go-name": "Token"
  9249. },
  9250. "token_last_eight": {
  9251. "type": "string",
  9252. "x-go-name": "TokenLastEight"
  9253. }
  9254. },
  9255. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9256. },
  9257. "AddCollaboratorOption": {
  9258. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  9259. "type": "object",
  9260. "properties": {
  9261. "permission": {
  9262. "type": "string",
  9263. "x-go-name": "Permission"
  9264. }
  9265. },
  9266. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9267. },
  9268. "AddTimeOption": {
  9269. "description": "AddTimeOption options for adding time to an issue",
  9270. "type": "object",
  9271. "required": [
  9272. "time"
  9273. ],
  9274. "properties": {
  9275. "created": {
  9276. "type": "string",
  9277. "format": "date-time",
  9278. "x-go-name": "Created"
  9279. },
  9280. "time": {
  9281. "description": "time in seconds",
  9282. "type": "integer",
  9283. "format": "int64",
  9284. "x-go-name": "Time"
  9285. },
  9286. "user_name": {
  9287. "description": "User who spent the time (optional)",
  9288. "type": "string",
  9289. "x-go-name": "User"
  9290. }
  9291. },
  9292. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9293. },
  9294. "AnnotatedTag": {
  9295. "description": "AnnotatedTag represents an annotated tag",
  9296. "type": "object",
  9297. "properties": {
  9298. "message": {
  9299. "type": "string",
  9300. "x-go-name": "Message"
  9301. },
  9302. "object": {
  9303. "$ref": "#/definitions/AnnotatedTagObject"
  9304. },
  9305. "sha": {
  9306. "type": "string",
  9307. "x-go-name": "SHA"
  9308. },
  9309. "tag": {
  9310. "type": "string",
  9311. "x-go-name": "Tag"
  9312. },
  9313. "tagger": {
  9314. "$ref": "#/definitions/CommitUser"
  9315. },
  9316. "url": {
  9317. "type": "string",
  9318. "x-go-name": "URL"
  9319. },
  9320. "verification": {
  9321. "$ref": "#/definitions/PayloadCommitVerification"
  9322. }
  9323. },
  9324. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9325. },
  9326. "AnnotatedTagObject": {
  9327. "description": "AnnotatedTagObject contains meta information of the tag object",
  9328. "type": "object",
  9329. "properties": {
  9330. "sha": {
  9331. "type": "string",
  9332. "x-go-name": "SHA"
  9333. },
  9334. "type": {
  9335. "type": "string",
  9336. "x-go-name": "Type"
  9337. },
  9338. "url": {
  9339. "type": "string",
  9340. "x-go-name": "URL"
  9341. }
  9342. },
  9343. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9344. },
  9345. "Attachment": {
  9346. "description": "Attachment a generic attachment",
  9347. "type": "object",
  9348. "properties": {
  9349. "browser_download_url": {
  9350. "type": "string",
  9351. "x-go-name": "DownloadURL"
  9352. },
  9353. "created_at": {
  9354. "type": "string",
  9355. "format": "date-time",
  9356. "x-go-name": "Created"
  9357. },
  9358. "download_count": {
  9359. "type": "integer",
  9360. "format": "int64",
  9361. "x-go-name": "DownloadCount"
  9362. },
  9363. "id": {
  9364. "type": "integer",
  9365. "format": "int64",
  9366. "x-go-name": "ID"
  9367. },
  9368. "name": {
  9369. "type": "string",
  9370. "x-go-name": "Name"
  9371. },
  9372. "size": {
  9373. "type": "integer",
  9374. "format": "int64",
  9375. "x-go-name": "Size"
  9376. },
  9377. "uuid": {
  9378. "type": "string",
  9379. "x-go-name": "UUID"
  9380. }
  9381. },
  9382. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9383. },
  9384. "Branch": {
  9385. "description": "Branch represents a repository branch",
  9386. "type": "object",
  9387. "properties": {
  9388. "commit": {
  9389. "$ref": "#/definitions/PayloadCommit"
  9390. },
  9391. "enable_status_check": {
  9392. "type": "boolean",
  9393. "x-go-name": "EnableStatusCheck"
  9394. },
  9395. "name": {
  9396. "type": "string",
  9397. "x-go-name": "Name"
  9398. },
  9399. "protected": {
  9400. "type": "boolean",
  9401. "x-go-name": "Protected"
  9402. },
  9403. "required_approvals": {
  9404. "type": "integer",
  9405. "format": "int64",
  9406. "x-go-name": "RequiredApprovals"
  9407. },
  9408. "status_check_contexts": {
  9409. "type": "array",
  9410. "items": {
  9411. "type": "string"
  9412. },
  9413. "x-go-name": "StatusCheckContexts"
  9414. },
  9415. "user_can_merge": {
  9416. "type": "boolean",
  9417. "x-go-name": "UserCanMerge"
  9418. },
  9419. "user_can_push": {
  9420. "type": "boolean",
  9421. "x-go-name": "UserCanPush"
  9422. }
  9423. },
  9424. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9425. },
  9426. "Comment": {
  9427. "description": "Comment represents a comment on a commit or issue",
  9428. "type": "object",
  9429. "properties": {
  9430. "body": {
  9431. "type": "string",
  9432. "x-go-name": "Body"
  9433. },
  9434. "created_at": {
  9435. "type": "string",
  9436. "format": "date-time",
  9437. "x-go-name": "Created"
  9438. },
  9439. "html_url": {
  9440. "type": "string",
  9441. "x-go-name": "HTMLURL"
  9442. },
  9443. "id": {
  9444. "type": "integer",
  9445. "format": "int64",
  9446. "x-go-name": "ID"
  9447. },
  9448. "issue_url": {
  9449. "type": "string",
  9450. "x-go-name": "IssueURL"
  9451. },
  9452. "original_author": {
  9453. "type": "string",
  9454. "x-go-name": "OriginalAuthor"
  9455. },
  9456. "original_author_id": {
  9457. "type": "integer",
  9458. "format": "int64",
  9459. "x-go-name": "OriginalAuthorID"
  9460. },
  9461. "pull_request_url": {
  9462. "type": "string",
  9463. "x-go-name": "PRURL"
  9464. },
  9465. "updated_at": {
  9466. "type": "string",
  9467. "format": "date-time",
  9468. "x-go-name": "Updated"
  9469. },
  9470. "user": {
  9471. "$ref": "#/definitions/User"
  9472. }
  9473. },
  9474. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9475. },
  9476. "Commit": {
  9477. "type": "object",
  9478. "title": "Commit contains information generated from a Git commit.",
  9479. "properties": {
  9480. "author": {
  9481. "$ref": "#/definitions/User"
  9482. },
  9483. "commit": {
  9484. "$ref": "#/definitions/RepoCommit"
  9485. },
  9486. "committer": {
  9487. "$ref": "#/definitions/User"
  9488. },
  9489. "html_url": {
  9490. "type": "string",
  9491. "x-go-name": "HTMLURL"
  9492. },
  9493. "parents": {
  9494. "type": "array",
  9495. "items": {
  9496. "$ref": "#/definitions/CommitMeta"
  9497. },
  9498. "x-go-name": "Parents"
  9499. },
  9500. "sha": {
  9501. "type": "string",
  9502. "x-go-name": "SHA"
  9503. },
  9504. "url": {
  9505. "type": "string",
  9506. "x-go-name": "URL"
  9507. }
  9508. },
  9509. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9510. },
  9511. "CommitDateOptions": {
  9512. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  9513. "type": "object",
  9514. "properties": {
  9515. "author": {
  9516. "type": "string",
  9517. "format": "date-time",
  9518. "x-go-name": "Author"
  9519. },
  9520. "committer": {
  9521. "type": "string",
  9522. "format": "date-time",
  9523. "x-go-name": "Committer"
  9524. }
  9525. },
  9526. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9527. },
  9528. "CommitMeta": {
  9529. "type": "object",
  9530. "title": "CommitMeta contains meta information of a commit in terms of API.",
  9531. "properties": {
  9532. "sha": {
  9533. "type": "string",
  9534. "x-go-name": "SHA"
  9535. },
  9536. "url": {
  9537. "type": "string",
  9538. "x-go-name": "URL"
  9539. }
  9540. },
  9541. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9542. },
  9543. "CommitUser": {
  9544. "type": "object",
  9545. "title": "CommitUser contains information of a user in the context of a commit.",
  9546. "properties": {
  9547. "date": {
  9548. "type": "string",
  9549. "x-go-name": "Date"
  9550. },
  9551. "email": {
  9552. "type": "string",
  9553. "format": "email",
  9554. "x-go-name": "Email"
  9555. },
  9556. "name": {
  9557. "type": "string",
  9558. "x-go-name": "Name"
  9559. }
  9560. },
  9561. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9562. },
  9563. "ContentsResponse": {
  9564. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  9565. "type": "object",
  9566. "properties": {
  9567. "_links": {
  9568. "$ref": "#/definitions/FileLinksResponse"
  9569. },
  9570. "content": {
  9571. "description": "`content` is populated when `type` is `file`, otherwise null",
  9572. "type": "string",
  9573. "x-go-name": "Content"
  9574. },
  9575. "download_url": {
  9576. "type": "string",
  9577. "x-go-name": "DownloadURL"
  9578. },
  9579. "encoding": {
  9580. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  9581. "type": "string",
  9582. "x-go-name": "Encoding"
  9583. },
  9584. "git_url": {
  9585. "type": "string",
  9586. "x-go-name": "GitURL"
  9587. },
  9588. "html_url": {
  9589. "type": "string",
  9590. "x-go-name": "HTMLURL"
  9591. },
  9592. "name": {
  9593. "type": "string",
  9594. "x-go-name": "Name"
  9595. },
  9596. "path": {
  9597. "type": "string",
  9598. "x-go-name": "Path"
  9599. },
  9600. "sha": {
  9601. "type": "string",
  9602. "x-go-name": "SHA"
  9603. },
  9604. "size": {
  9605. "type": "integer",
  9606. "format": "int64",
  9607. "x-go-name": "Size"
  9608. },
  9609. "submodule_git_url": {
  9610. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  9611. "type": "string",
  9612. "x-go-name": "SubmoduleGitURL"
  9613. },
  9614. "target": {
  9615. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  9616. "type": "string",
  9617. "x-go-name": "Target"
  9618. },
  9619. "type": {
  9620. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  9621. "type": "string",
  9622. "x-go-name": "Type"
  9623. },
  9624. "url": {
  9625. "type": "string",
  9626. "x-go-name": "URL"
  9627. }
  9628. },
  9629. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9630. },
  9631. "CreateEmailOption": {
  9632. "description": "CreateEmailOption options when creating email addresses",
  9633. "type": "object",
  9634. "properties": {
  9635. "emails": {
  9636. "description": "email addresses to add",
  9637. "type": "array",
  9638. "items": {
  9639. "type": "string"
  9640. },
  9641. "x-go-name": "Emails"
  9642. }
  9643. },
  9644. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9645. },
  9646. "CreateFileOptions": {
  9647. "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)",
  9648. "type": "object",
  9649. "required": [
  9650. "content"
  9651. ],
  9652. "properties": {
  9653. "author": {
  9654. "$ref": "#/definitions/Identity"
  9655. },
  9656. "branch": {
  9657. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  9658. "type": "string",
  9659. "x-go-name": "BranchName"
  9660. },
  9661. "committer": {
  9662. "$ref": "#/definitions/Identity"
  9663. },
  9664. "content": {
  9665. "description": "content must be base64 encoded",
  9666. "type": "string",
  9667. "x-go-name": "Content"
  9668. },
  9669. "dates": {
  9670. "$ref": "#/definitions/CommitDateOptions"
  9671. },
  9672. "message": {
  9673. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  9674. "type": "string",
  9675. "x-go-name": "Message"
  9676. },
  9677. "new_branch": {
  9678. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  9679. "type": "string",
  9680. "x-go-name": "NewBranchName"
  9681. }
  9682. },
  9683. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9684. },
  9685. "CreateForkOption": {
  9686. "description": "CreateForkOption options for creating a fork",
  9687. "type": "object",
  9688. "properties": {
  9689. "organization": {
  9690. "description": "organization name, if forking into an organization",
  9691. "type": "string",
  9692. "x-go-name": "Organization"
  9693. }
  9694. },
  9695. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9696. },
  9697. "CreateGPGKeyOption": {
  9698. "description": "CreateGPGKeyOption options create user GPG key",
  9699. "type": "object",
  9700. "required": [
  9701. "armored_public_key"
  9702. ],
  9703. "properties": {
  9704. "armored_public_key": {
  9705. "description": "An armored GPG key to add",
  9706. "type": "string",
  9707. "uniqueItems": true,
  9708. "x-go-name": "ArmoredKey"
  9709. }
  9710. },
  9711. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9712. },
  9713. "CreateHookOption": {
  9714. "description": "CreateHookOption options when create a hook",
  9715. "type": "object",
  9716. "required": [
  9717. "type",
  9718. "config"
  9719. ],
  9720. "properties": {
  9721. "active": {
  9722. "type": "boolean",
  9723. "default": false,
  9724. "x-go-name": "Active"
  9725. },
  9726. "branch_filter": {
  9727. "type": "string",
  9728. "x-go-name": "BranchFilter"
  9729. },
  9730. "config": {
  9731. "$ref": "#/definitions/CreateHookOptionConfig"
  9732. },
  9733. "events": {
  9734. "type": "array",
  9735. "items": {
  9736. "type": "string"
  9737. },
  9738. "x-go-name": "Events"
  9739. },
  9740. "type": {
  9741. "type": "string",
  9742. "enum": [
  9743. "dingtalk",
  9744. "discord",
  9745. "gitea",
  9746. "gogs",
  9747. "msteams",
  9748. "slack",
  9749. "telegram"
  9750. ],
  9751. "x-go-name": "Type"
  9752. }
  9753. },
  9754. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9755. },
  9756. "CreateHookOptionConfig": {
  9757. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  9758. "type": "object",
  9759. "additionalProperties": {
  9760. "type": "string"
  9761. },
  9762. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9763. },
  9764. "CreateIssueCommentOption": {
  9765. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  9766. "type": "object",
  9767. "required": [
  9768. "body"
  9769. ],
  9770. "properties": {
  9771. "body": {
  9772. "type": "string",
  9773. "x-go-name": "Body"
  9774. }
  9775. },
  9776. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9777. },
  9778. "CreateIssueOption": {
  9779. "description": "CreateIssueOption options to create one issue",
  9780. "type": "object",
  9781. "required": [
  9782. "title"
  9783. ],
  9784. "properties": {
  9785. "assignee": {
  9786. "description": "username of assignee",
  9787. "type": "string",
  9788. "x-go-name": "Assignee"
  9789. },
  9790. "assignees": {
  9791. "type": "array",
  9792. "items": {
  9793. "type": "string"
  9794. },
  9795. "x-go-name": "Assignees"
  9796. },
  9797. "body": {
  9798. "type": "string",
  9799. "x-go-name": "Body"
  9800. },
  9801. "closed": {
  9802. "type": "boolean",
  9803. "x-go-name": "Closed"
  9804. },
  9805. "due_date": {
  9806. "type": "string",
  9807. "format": "date-time",
  9808. "x-go-name": "Deadline"
  9809. },
  9810. "labels": {
  9811. "description": "list of label ids",
  9812. "type": "array",
  9813. "items": {
  9814. "type": "integer",
  9815. "format": "int64"
  9816. },
  9817. "x-go-name": "Labels"
  9818. },
  9819. "milestone": {
  9820. "description": "milestone id",
  9821. "type": "integer",
  9822. "format": "int64",
  9823. "x-go-name": "Milestone"
  9824. },
  9825. "title": {
  9826. "type": "string",
  9827. "x-go-name": "Title"
  9828. }
  9829. },
  9830. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9831. },
  9832. "CreateKeyOption": {
  9833. "description": "CreateKeyOption options when creating a key",
  9834. "type": "object",
  9835. "required": [
  9836. "title",
  9837. "key"
  9838. ],
  9839. "properties": {
  9840. "key": {
  9841. "description": "An armored SSH key to add",
  9842. "type": "string",
  9843. "uniqueItems": true,
  9844. "x-go-name": "Key"
  9845. },
  9846. "read_only": {
  9847. "description": "Describe if the key has only read access or read/write",
  9848. "type": "boolean",
  9849. "x-go-name": "ReadOnly"
  9850. },
  9851. "title": {
  9852. "description": "Title of the key to add",
  9853. "type": "string",
  9854. "uniqueItems": true,
  9855. "x-go-name": "Title"
  9856. }
  9857. },
  9858. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9859. },
  9860. "CreateLabelOption": {
  9861. "description": "CreateLabelOption options for creating a label",
  9862. "type": "object",
  9863. "required": [
  9864. "name",
  9865. "color"
  9866. ],
  9867. "properties": {
  9868. "color": {
  9869. "type": "string",
  9870. "x-go-name": "Color",
  9871. "example": "#00aabb"
  9872. },
  9873. "description": {
  9874. "type": "string",
  9875. "x-go-name": "Description"
  9876. },
  9877. "name": {
  9878. "type": "string",
  9879. "x-go-name": "Name"
  9880. }
  9881. },
  9882. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9883. },
  9884. "CreateMilestoneOption": {
  9885. "description": "CreateMilestoneOption options for creating a milestone",
  9886. "type": "object",
  9887. "properties": {
  9888. "description": {
  9889. "type": "string",
  9890. "x-go-name": "Description"
  9891. },
  9892. "due_on": {
  9893. "type": "string",
  9894. "format": "date-time",
  9895. "x-go-name": "Deadline"
  9896. },
  9897. "title": {
  9898. "type": "string",
  9899. "x-go-name": "Title"
  9900. }
  9901. },
  9902. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9903. },
  9904. "CreateOrgOption": {
  9905. "description": "CreateOrgOption options for creating an organization",
  9906. "type": "object",
  9907. "required": [
  9908. "username"
  9909. ],
  9910. "properties": {
  9911. "description": {
  9912. "type": "string",
  9913. "x-go-name": "Description"
  9914. },
  9915. "full_name": {
  9916. "type": "string",
  9917. "x-go-name": "FullName"
  9918. },
  9919. "location": {
  9920. "type": "string",
  9921. "x-go-name": "Location"
  9922. },
  9923. "repo_admin_change_team_access": {
  9924. "type": "boolean",
  9925. "x-go-name": "RepoAdminChangeTeamAccess"
  9926. },
  9927. "username": {
  9928. "type": "string",
  9929. "x-go-name": "UserName"
  9930. },
  9931. "visibility": {
  9932. "description": "possible values are `public` (default), `limited` or `private`",
  9933. "type": "string",
  9934. "enum": [
  9935. "public",
  9936. "limited",
  9937. "private"
  9938. ],
  9939. "x-go-name": "Visibility"
  9940. },
  9941. "website": {
  9942. "type": "string",
  9943. "x-go-name": "Website"
  9944. }
  9945. },
  9946. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9947. },
  9948. "CreatePullRequestOption": {
  9949. "description": "CreatePullRequestOption options when creating a pull request",
  9950. "type": "object",
  9951. "properties": {
  9952. "assignee": {
  9953. "type": "string",
  9954. "x-go-name": "Assignee"
  9955. },
  9956. "assignees": {
  9957. "type": "array",
  9958. "items": {
  9959. "type": "string"
  9960. },
  9961. "x-go-name": "Assignees"
  9962. },
  9963. "base": {
  9964. "type": "string",
  9965. "x-go-name": "Base"
  9966. },
  9967. "body": {
  9968. "type": "string",
  9969. "x-go-name": "Body"
  9970. },
  9971. "due_date": {
  9972. "type": "string",
  9973. "format": "date-time",
  9974. "x-go-name": "Deadline"
  9975. },
  9976. "head": {
  9977. "type": "string",
  9978. "x-go-name": "Head"
  9979. },
  9980. "labels": {
  9981. "type": "array",
  9982. "items": {
  9983. "type": "integer",
  9984. "format": "int64"
  9985. },
  9986. "x-go-name": "Labels"
  9987. },
  9988. "milestone": {
  9989. "type": "integer",
  9990. "format": "int64",
  9991. "x-go-name": "Milestone"
  9992. },
  9993. "title": {
  9994. "type": "string",
  9995. "x-go-name": "Title"
  9996. }
  9997. },
  9998. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9999. },
  10000. "CreateReleaseOption": {
  10001. "description": "CreateReleaseOption options when creating a release",
  10002. "type": "object",
  10003. "required": [
  10004. "tag_name"
  10005. ],
  10006. "properties": {
  10007. "body": {
  10008. "type": "string",
  10009. "x-go-name": "Note"
  10010. },
  10011. "draft": {
  10012. "type": "boolean",
  10013. "x-go-name": "IsDraft"
  10014. },
  10015. "name": {
  10016. "type": "string",
  10017. "x-go-name": "Title"
  10018. },
  10019. "prerelease": {
  10020. "type": "boolean",
  10021. "x-go-name": "IsPrerelease"
  10022. },
  10023. "tag_name": {
  10024. "type": "string",
  10025. "x-go-name": "TagName"
  10026. },
  10027. "target_commitish": {
  10028. "type": "string",
  10029. "x-go-name": "Target"
  10030. }
  10031. },
  10032. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10033. },
  10034. "CreateRepoOption": {
  10035. "description": "CreateRepoOption options when creating repository",
  10036. "type": "object",
  10037. "required": [
  10038. "name"
  10039. ],
  10040. "properties": {
  10041. "auto_init": {
  10042. "description": "Whether the repository should be auto-intialized?",
  10043. "type": "boolean",
  10044. "x-go-name": "AutoInit"
  10045. },
  10046. "description": {
  10047. "description": "Description of the repository to create",
  10048. "type": "string",
  10049. "x-go-name": "Description"
  10050. },
  10051. "gitignores": {
  10052. "description": "Gitignores to use",
  10053. "type": "string",
  10054. "x-go-name": "Gitignores"
  10055. },
  10056. "issue_labels": {
  10057. "description": "Issue Label set to use",
  10058. "type": "string",
  10059. "x-go-name": "IssueLabels"
  10060. },
  10061. "license": {
  10062. "description": "License to use",
  10063. "type": "string",
  10064. "x-go-name": "License"
  10065. },
  10066. "name": {
  10067. "description": "Name of the repository to create",
  10068. "type": "string",
  10069. "uniqueItems": true,
  10070. "x-go-name": "Name"
  10071. },
  10072. "private": {
  10073. "description": "Whether the repository is private",
  10074. "type": "boolean",
  10075. "x-go-name": "Private"
  10076. },
  10077. "readme": {
  10078. "description": "Readme of the repository to create",
  10079. "type": "string",
  10080. "x-go-name": "Readme"
  10081. }
  10082. },
  10083. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10084. },
  10085. "CreateStatusOption": {
  10086. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  10087. "type": "object",
  10088. "properties": {
  10089. "context": {
  10090. "type": "string",
  10091. "x-go-name": "Context"
  10092. },
  10093. "description": {
  10094. "type": "string",
  10095. "x-go-name": "Description"
  10096. },
  10097. "state": {
  10098. "$ref": "#/definitions/StatusState"
  10099. },
  10100. "target_url": {
  10101. "type": "string",
  10102. "x-go-name": "TargetURL"
  10103. }
  10104. },
  10105. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10106. },
  10107. "CreateTeamOption": {
  10108. "description": "CreateTeamOption options for creating a team",
  10109. "type": "object",
  10110. "required": [
  10111. "name"
  10112. ],
  10113. "properties": {
  10114. "can_create_org_repo": {
  10115. "type": "boolean",
  10116. "x-go-name": "CanCreateOrgRepo"
  10117. },
  10118. "description": {
  10119. "type": "string",
  10120. "x-go-name": "Description"
  10121. },
  10122. "includes_all_repositories": {
  10123. "type": "boolean",
  10124. "x-go-name": "IncludesAllRepositories"
  10125. },
  10126. "name": {
  10127. "type": "string",
  10128. "x-go-name": "Name"
  10129. },
  10130. "permission": {
  10131. "type": "string",
  10132. "enum": [
  10133. "read",
  10134. "write",
  10135. "admin"
  10136. ],
  10137. "x-go-name": "Permission"
  10138. },
  10139. "units": {
  10140. "type": "array",
  10141. "items": {
  10142. "type": "string"
  10143. },
  10144. "x-go-name": "Units",
  10145. "example": [
  10146. "repo.code",
  10147. "repo.issues",
  10148. "repo.ext_issues",
  10149. "repo.wiki",
  10150. "repo.pulls",
  10151. "repo.releases",
  10152. "repo.ext_wiki"
  10153. ]
  10154. }
  10155. },
  10156. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10157. },
  10158. "CreateUserOption": {
  10159. "description": "CreateUserOption create user options",
  10160. "type": "object",
  10161. "required": [
  10162. "username",
  10163. "email",
  10164. "password"
  10165. ],
  10166. "properties": {
  10167. "email": {
  10168. "type": "string",
  10169. "format": "email",
  10170. "x-go-name": "Email"
  10171. },
  10172. "full_name": {
  10173. "type": "string",
  10174. "x-go-name": "FullName"
  10175. },
  10176. "login_name": {
  10177. "type": "string",
  10178. "x-go-name": "LoginName"
  10179. },
  10180. "must_change_password": {
  10181. "type": "boolean",
  10182. "x-go-name": "MustChangePassword"
  10183. },
  10184. "password": {
  10185. "type": "string",
  10186. "x-go-name": "Password"
  10187. },
  10188. "send_notify": {
  10189. "type": "boolean",
  10190. "x-go-name": "SendNotify"
  10191. },
  10192. "source_id": {
  10193. "type": "integer",
  10194. "format": "int64",
  10195. "x-go-name": "SourceID"
  10196. },
  10197. "username": {
  10198. "type": "string",
  10199. "x-go-name": "Username"
  10200. }
  10201. },
  10202. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10203. },
  10204. "DeleteEmailOption": {
  10205. "description": "DeleteEmailOption options when deleting email addresses",
  10206. "type": "object",
  10207. "properties": {
  10208. "emails": {
  10209. "description": "email addresses to delete",
  10210. "type": "array",
  10211. "items": {
  10212. "type": "string"
  10213. },
  10214. "x-go-name": "Emails"
  10215. }
  10216. },
  10217. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10218. },
  10219. "DeleteFileOptions": {
  10220. "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)",
  10221. "type": "object",
  10222. "required": [
  10223. "sha"
  10224. ],
  10225. "properties": {
  10226. "author": {
  10227. "$ref": "#/definitions/Identity"
  10228. },
  10229. "branch": {
  10230. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10231. "type": "string",
  10232. "x-go-name": "BranchName"
  10233. },
  10234. "committer": {
  10235. "$ref": "#/definitions/Identity"
  10236. },
  10237. "dates": {
  10238. "$ref": "#/definitions/CommitDateOptions"
  10239. },
  10240. "message": {
  10241. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10242. "type": "string",
  10243. "x-go-name": "Message"
  10244. },
  10245. "new_branch": {
  10246. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10247. "type": "string",
  10248. "x-go-name": "NewBranchName"
  10249. },
  10250. "sha": {
  10251. "description": "sha is the SHA for the file that already exists",
  10252. "type": "string",
  10253. "x-go-name": "SHA"
  10254. }
  10255. },
  10256. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10257. },
  10258. "DeployKey": {
  10259. "description": "DeployKey a deploy key",
  10260. "type": "object",
  10261. "properties": {
  10262. "created_at": {
  10263. "type": "string",
  10264. "format": "date-time",
  10265. "x-go-name": "Created"
  10266. },
  10267. "fingerprint": {
  10268. "type": "string",
  10269. "x-go-name": "Fingerprint"
  10270. },
  10271. "id": {
  10272. "type": "integer",
  10273. "format": "int64",
  10274. "x-go-name": "ID"
  10275. },
  10276. "key": {
  10277. "type": "string",
  10278. "x-go-name": "Key"
  10279. },
  10280. "key_id": {
  10281. "type": "integer",
  10282. "format": "int64",
  10283. "x-go-name": "KeyID"
  10284. },
  10285. "read_only": {
  10286. "type": "boolean",
  10287. "x-go-name": "ReadOnly"
  10288. },
  10289. "repository": {
  10290. "$ref": "#/definitions/Repository"
  10291. },
  10292. "title": {
  10293. "type": "string",
  10294. "x-go-name": "Title"
  10295. },
  10296. "url": {
  10297. "type": "string",
  10298. "x-go-name": "URL"
  10299. }
  10300. },
  10301. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10302. },
  10303. "EditAttachmentOptions": {
  10304. "description": "EditAttachmentOptions options for editing attachments",
  10305. "type": "object",
  10306. "properties": {
  10307. "name": {
  10308. "type": "string",
  10309. "x-go-name": "Name"
  10310. }
  10311. },
  10312. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10313. },
  10314. "EditDeadlineOption": {
  10315. "description": "EditDeadlineOption options for creating a deadline",
  10316. "type": "object",
  10317. "required": [
  10318. "due_date"
  10319. ],
  10320. "properties": {
  10321. "due_date": {
  10322. "type": "string",
  10323. "format": "date-time",
  10324. "x-go-name": "Deadline"
  10325. }
  10326. },
  10327. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10328. },
  10329. "EditGitHookOption": {
  10330. "description": "EditGitHookOption options when modifying one Git hook",
  10331. "type": "object",
  10332. "properties": {
  10333. "content": {
  10334. "type": "string",
  10335. "x-go-name": "Content"
  10336. }
  10337. },
  10338. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10339. },
  10340. "EditHookOption": {
  10341. "description": "EditHookOption options when modify one hook",
  10342. "type": "object",
  10343. "properties": {
  10344. "active": {
  10345. "type": "boolean",
  10346. "x-go-name": "Active"
  10347. },
  10348. "branch_filter": {
  10349. "type": "string",
  10350. "x-go-name": "BranchFilter"
  10351. },
  10352. "config": {
  10353. "type": "object",
  10354. "additionalProperties": {
  10355. "type": "string"
  10356. },
  10357. "x-go-name": "Config"
  10358. },
  10359. "events": {
  10360. "type": "array",
  10361. "items": {
  10362. "type": "string"
  10363. },
  10364. "x-go-name": "Events"
  10365. }
  10366. },
  10367. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10368. },
  10369. "EditIssueCommentOption": {
  10370. "description": "EditIssueCommentOption options for editing a comment",
  10371. "type": "object",
  10372. "required": [
  10373. "body"
  10374. ],
  10375. "properties": {
  10376. "body": {
  10377. "type": "string",
  10378. "x-go-name": "Body"
  10379. }
  10380. },
  10381. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10382. },
  10383. "EditIssueOption": {
  10384. "description": "EditIssueOption options for editing an issue",
  10385. "type": "object",
  10386. "properties": {
  10387. "assignee": {
  10388. "type": "string",
  10389. "x-go-name": "Assignee"
  10390. },
  10391. "assignees": {
  10392. "type": "array",
  10393. "items": {
  10394. "type": "string"
  10395. },
  10396. "x-go-name": "Assignees"
  10397. },
  10398. "body": {
  10399. "type": "string",
  10400. "x-go-name": "Body"
  10401. },
  10402. "due_date": {
  10403. "type": "string",
  10404. "format": "date-time",
  10405. "x-go-name": "Deadline"
  10406. },
  10407. "milestone": {
  10408. "type": "integer",
  10409. "format": "int64",
  10410. "x-go-name": "Milestone"
  10411. },
  10412. "state": {
  10413. "type": "string",
  10414. "x-go-name": "State"
  10415. },
  10416. "title": {
  10417. "type": "string",
  10418. "x-go-name": "Title"
  10419. },
  10420. "unset_due_date": {
  10421. "type": "boolean",
  10422. "x-go-name": "RemoveDeadline"
  10423. }
  10424. },
  10425. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10426. },
  10427. "EditLabelOption": {
  10428. "description": "EditLabelOption options for editing a label",
  10429. "type": "object",
  10430. "properties": {
  10431. "color": {
  10432. "type": "string",
  10433. "x-go-name": "Color"
  10434. },
  10435. "description": {
  10436. "type": "string",
  10437. "x-go-name": "Description"
  10438. },
  10439. "name": {
  10440. "type": "string",
  10441. "x-go-name": "Name"
  10442. }
  10443. },
  10444. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10445. },
  10446. "EditMilestoneOption": {
  10447. "description": "EditMilestoneOption options for editing a milestone",
  10448. "type": "object",
  10449. "properties": {
  10450. "description": {
  10451. "type": "string",
  10452. "x-go-name": "Description"
  10453. },
  10454. "due_on": {
  10455. "type": "string",
  10456. "format": "date-time",
  10457. "x-go-name": "Deadline"
  10458. },
  10459. "state": {
  10460. "type": "string",
  10461. "x-go-name": "State"
  10462. },
  10463. "title": {
  10464. "type": "string",
  10465. "x-go-name": "Title"
  10466. }
  10467. },
  10468. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10469. },
  10470. "EditOrgOption": {
  10471. "description": "EditOrgOption options for editing an organization",
  10472. "type": "object",
  10473. "properties": {
  10474. "description": {
  10475. "type": "string",
  10476. "x-go-name": "Description"
  10477. },
  10478. "full_name": {
  10479. "type": "string",
  10480. "x-go-name": "FullName"
  10481. },
  10482. "location": {
  10483. "type": "string",
  10484. "x-go-name": "Location"
  10485. },
  10486. "repo_admin_change_team_access": {
  10487. "type": "boolean",
  10488. "x-go-name": "RepoAdminChangeTeamAccess"
  10489. },
  10490. "visibility": {
  10491. "description": "possible values are `public`, `limited` or `private`",
  10492. "type": "string",
  10493. "enum": [
  10494. "public",
  10495. "limited",
  10496. "private"
  10497. ],
  10498. "x-go-name": "Visibility"
  10499. },
  10500. "website": {
  10501. "type": "string",
  10502. "x-go-name": "Website"
  10503. }
  10504. },
  10505. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10506. },
  10507. "EditPullRequestOption": {
  10508. "description": "EditPullRequestOption options when modify pull request",
  10509. "type": "object",
  10510. "properties": {
  10511. "assignee": {
  10512. "type": "string",
  10513. "x-go-name": "Assignee"
  10514. },
  10515. "assignees": {
  10516. "type": "array",
  10517. "items": {
  10518. "type": "string"
  10519. },
  10520. "x-go-name": "Assignees"
  10521. },
  10522. "body": {
  10523. "type": "string",
  10524. "x-go-name": "Body"
  10525. },
  10526. "due_date": {
  10527. "type": "string",
  10528. "format": "date-time",
  10529. "x-go-name": "Deadline"
  10530. },
  10531. "labels": {
  10532. "type": "array",
  10533. "items": {
  10534. "type": "integer",
  10535. "format": "int64"
  10536. },
  10537. "x-go-name": "Labels"
  10538. },
  10539. "milestone": {
  10540. "type": "integer",
  10541. "format": "int64",
  10542. "x-go-name": "Milestone"
  10543. },
  10544. "state": {
  10545. "type": "string",
  10546. "x-go-name": "State"
  10547. },
  10548. "title": {
  10549. "type": "string",
  10550. "x-go-name": "Title"
  10551. },
  10552. "unset_due_date": {
  10553. "type": "boolean",
  10554. "x-go-name": "RemoveDeadline"
  10555. }
  10556. },
  10557. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10558. },
  10559. "EditReactionOption": {
  10560. "description": "EditReactionOption contain the reaction type",
  10561. "type": "object",
  10562. "properties": {
  10563. "content": {
  10564. "type": "string",
  10565. "x-go-name": "Reaction"
  10566. }
  10567. },
  10568. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10569. },
  10570. "EditReleaseOption": {
  10571. "description": "EditReleaseOption options when editing a release",
  10572. "type": "object",
  10573. "properties": {
  10574. "body": {
  10575. "type": "string",
  10576. "x-go-name": "Note"
  10577. },
  10578. "draft": {
  10579. "type": "boolean",
  10580. "x-go-name": "IsDraft"
  10581. },
  10582. "name": {
  10583. "type": "string",
  10584. "x-go-name": "Title"
  10585. },
  10586. "prerelease": {
  10587. "type": "boolean",
  10588. "x-go-name": "IsPrerelease"
  10589. },
  10590. "tag_name": {
  10591. "type": "string",
  10592. "x-go-name": "TagName"
  10593. },
  10594. "target_commitish": {
  10595. "type": "string",
  10596. "x-go-name": "Target"
  10597. }
  10598. },
  10599. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10600. },
  10601. "EditRepoOption": {
  10602. "description": "EditRepoOption options when editing a repository's properties",
  10603. "type": "object",
  10604. "properties": {
  10605. "allow_merge_commits": {
  10606. "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`.",
  10607. "type": "boolean",
  10608. "x-go-name": "AllowMerge"
  10609. },
  10610. "allow_rebase": {
  10611. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  10612. "type": "boolean",
  10613. "x-go-name": "AllowRebase"
  10614. },
  10615. "allow_rebase_explicit": {
  10616. "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`.",
  10617. "type": "boolean",
  10618. "x-go-name": "AllowRebaseMerge"
  10619. },
  10620. "allow_squash_merge": {
  10621. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  10622. "type": "boolean",
  10623. "x-go-name": "AllowSquash"
  10624. },
  10625. "archived": {
  10626. "description": "set to `true` to archive this repository.",
  10627. "type": "boolean",
  10628. "x-go-name": "Archived"
  10629. },
  10630. "default_branch": {
  10631. "description": "sets the default branch for this repository.",
  10632. "type": "string",
  10633. "x-go-name": "DefaultBranch"
  10634. },
  10635. "description": {
  10636. "description": "a short description of the repository.",
  10637. "type": "string",
  10638. "x-go-name": "Description"
  10639. },
  10640. "external_tracker": {
  10641. "$ref": "#/definitions/ExternalTracker"
  10642. },
  10643. "external_wiki": {
  10644. "$ref": "#/definitions/ExternalWiki"
  10645. },
  10646. "has_issues": {
  10647. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  10648. "type": "boolean",
  10649. "x-go-name": "HasIssues"
  10650. },
  10651. "has_pull_requests": {
  10652. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  10653. "type": "boolean",
  10654. "x-go-name": "HasPullRequests"
  10655. },
  10656. "has_wiki": {
  10657. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  10658. "type": "boolean",
  10659. "x-go-name": "HasWiki"
  10660. },
  10661. "ignore_whitespace_conflicts": {
  10662. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  10663. "type": "boolean",
  10664. "x-go-name": "IgnoreWhitespaceConflicts"
  10665. },
  10666. "internal_tracker": {
  10667. "$ref": "#/definitions/InternalTracker"
  10668. },
  10669. "name": {
  10670. "description": "name of the repository",
  10671. "type": "string",
  10672. "uniqueItems": true,
  10673. "x-go-name": "Name"
  10674. },
  10675. "private": {
  10676. "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.",
  10677. "type": "boolean",
  10678. "x-go-name": "Private"
  10679. },
  10680. "template": {
  10681. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  10682. "type": "boolean",
  10683. "x-go-name": "Template"
  10684. },
  10685. "website": {
  10686. "description": "a URL with more information about the repository.",
  10687. "type": "string",
  10688. "x-go-name": "Website"
  10689. }
  10690. },
  10691. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10692. },
  10693. "EditTeamOption": {
  10694. "description": "EditTeamOption options for editing a team",
  10695. "type": "object",
  10696. "required": [
  10697. "name"
  10698. ],
  10699. "properties": {
  10700. "can_create_org_repo": {
  10701. "type": "boolean",
  10702. "x-go-name": "CanCreateOrgRepo"
  10703. },
  10704. "description": {
  10705. "type": "string",
  10706. "x-go-name": "Description"
  10707. },
  10708. "includes_all_repositories": {
  10709. "type": "boolean",
  10710. "x-go-name": "IncludesAllRepositories"
  10711. },
  10712. "name": {
  10713. "type": "string",
  10714. "x-go-name": "Name"
  10715. },
  10716. "permission": {
  10717. "type": "string",
  10718. "enum": [
  10719. "read",
  10720. "write",
  10721. "admin"
  10722. ],
  10723. "x-go-name": "Permission"
  10724. },
  10725. "units": {
  10726. "type": "array",
  10727. "items": {
  10728. "type": "string"
  10729. },
  10730. "x-go-name": "Units",
  10731. "example": [
  10732. "repo.code",
  10733. "repo.issues",
  10734. "repo.ext_issues",
  10735. "repo.wiki",
  10736. "repo.pulls",
  10737. "repo.releases",
  10738. "repo.ext_wiki"
  10739. ]
  10740. }
  10741. },
  10742. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10743. },
  10744. "EditUserOption": {
  10745. "description": "EditUserOption edit user options",
  10746. "type": "object",
  10747. "required": [
  10748. "email"
  10749. ],
  10750. "properties": {
  10751. "active": {
  10752. "type": "boolean",
  10753. "x-go-name": "Active"
  10754. },
  10755. "admin": {
  10756. "type": "boolean",
  10757. "x-go-name": "Admin"
  10758. },
  10759. "allow_create_organization": {
  10760. "type": "boolean",
  10761. "x-go-name": "AllowCreateOrganization"
  10762. },
  10763. "allow_git_hook": {
  10764. "type": "boolean",
  10765. "x-go-name": "AllowGitHook"
  10766. },
  10767. "allow_import_local": {
  10768. "type": "boolean",
  10769. "x-go-name": "AllowImportLocal"
  10770. },
  10771. "email": {
  10772. "type": "string",
  10773. "format": "email",
  10774. "x-go-name": "Email"
  10775. },
  10776. "full_name": {
  10777. "type": "string",
  10778. "x-go-name": "FullName"
  10779. },
  10780. "location": {
  10781. "type": "string",
  10782. "x-go-name": "Location"
  10783. },
  10784. "login_name": {
  10785. "type": "string",
  10786. "x-go-name": "LoginName"
  10787. },
  10788. "max_repo_creation": {
  10789. "type": "integer",
  10790. "format": "int64",
  10791. "x-go-name": "MaxRepoCreation"
  10792. },
  10793. "must_change_password": {
  10794. "type": "boolean",
  10795. "x-go-name": "MustChangePassword"
  10796. },
  10797. "password": {
  10798. "type": "string",
  10799. "x-go-name": "Password"
  10800. },
  10801. "prohibit_login": {
  10802. "type": "boolean",
  10803. "x-go-name": "ProhibitLogin"
  10804. },
  10805. "source_id": {
  10806. "type": "integer",
  10807. "format": "int64",
  10808. "x-go-name": "SourceID"
  10809. },
  10810. "website": {
  10811. "type": "string",
  10812. "x-go-name": "Website"
  10813. }
  10814. },
  10815. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10816. },
  10817. "Email": {
  10818. "description": "Email an email address belonging to a user",
  10819. "type": "object",
  10820. "properties": {
  10821. "email": {
  10822. "type": "string",
  10823. "format": "email",
  10824. "x-go-name": "Email"
  10825. },
  10826. "primary": {
  10827. "type": "boolean",
  10828. "x-go-name": "Primary"
  10829. },
  10830. "verified": {
  10831. "type": "boolean",
  10832. "x-go-name": "Verified"
  10833. }
  10834. },
  10835. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10836. },
  10837. "ExternalTracker": {
  10838. "description": "ExternalTracker represents settings for external tracker",
  10839. "type": "object",
  10840. "properties": {
  10841. "external_tracker_format": {
  10842. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  10843. "type": "string",
  10844. "x-go-name": "ExternalTrackerFormat"
  10845. },
  10846. "external_tracker_style": {
  10847. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  10848. "type": "string",
  10849. "x-go-name": "ExternalTrackerStyle"
  10850. },
  10851. "external_tracker_url": {
  10852. "description": "URL of external issue tracker.",
  10853. "type": "string",
  10854. "x-go-name": "ExternalTrackerURL"
  10855. }
  10856. },
  10857. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10858. },
  10859. "ExternalWiki": {
  10860. "description": "ExternalWiki represents setting for external wiki",
  10861. "type": "object",
  10862. "properties": {
  10863. "external_wiki_url": {
  10864. "description": "URL of external wiki.",
  10865. "type": "string",
  10866. "x-go-name": "ExternalWikiURL"
  10867. }
  10868. },
  10869. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10870. },
  10871. "FileCommitResponse": {
  10872. "type": "object",
  10873. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  10874. "properties": {
  10875. "author": {
  10876. "$ref": "#/definitions/CommitUser"
  10877. },
  10878. "committer": {
  10879. "$ref": "#/definitions/CommitUser"
  10880. },
  10881. "html_url": {
  10882. "type": "string",
  10883. "x-go-name": "HTMLURL"
  10884. },
  10885. "message": {
  10886. "type": "string",
  10887. "x-go-name": "Message"
  10888. },
  10889. "parents": {
  10890. "type": "array",
  10891. "items": {
  10892. "$ref": "#/definitions/CommitMeta"
  10893. },
  10894. "x-go-name": "Parents"
  10895. },
  10896. "sha": {
  10897. "type": "string",
  10898. "x-go-name": "SHA"
  10899. },
  10900. "tree": {
  10901. "$ref": "#/definitions/CommitMeta"
  10902. },
  10903. "url": {
  10904. "type": "string",
  10905. "x-go-name": "URL"
  10906. }
  10907. },
  10908. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10909. },
  10910. "FileDeleteResponse": {
  10911. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  10912. "type": "object",
  10913. "properties": {
  10914. "commit": {
  10915. "$ref": "#/definitions/FileCommitResponse"
  10916. },
  10917. "content": {
  10918. "type": "object",
  10919. "x-go-name": "Content"
  10920. },
  10921. "verification": {
  10922. "$ref": "#/definitions/PayloadCommitVerification"
  10923. }
  10924. },
  10925. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10926. },
  10927. "FileLinksResponse": {
  10928. "description": "FileLinksResponse contains the links for a repo's file",
  10929. "type": "object",
  10930. "properties": {
  10931. "git": {
  10932. "type": "string",
  10933. "x-go-name": "GitURL"
  10934. },
  10935. "html": {
  10936. "type": "string",
  10937. "x-go-name": "HTMLURL"
  10938. },
  10939. "self": {
  10940. "type": "string",
  10941. "x-go-name": "Self"
  10942. }
  10943. },
  10944. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10945. },
  10946. "FileResponse": {
  10947. "description": "FileResponse contains information about a repo's file",
  10948. "type": "object",
  10949. "properties": {
  10950. "commit": {
  10951. "$ref": "#/definitions/FileCommitResponse"
  10952. },
  10953. "content": {
  10954. "$ref": "#/definitions/ContentsResponse"
  10955. },
  10956. "verification": {
  10957. "$ref": "#/definitions/PayloadCommitVerification"
  10958. }
  10959. },
  10960. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10961. },
  10962. "GPGKey": {
  10963. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  10964. "type": "object",
  10965. "properties": {
  10966. "can_certify": {
  10967. "type": "boolean",
  10968. "x-go-name": "CanCertify"
  10969. },
  10970. "can_encrypt_comms": {
  10971. "type": "boolean",
  10972. "x-go-name": "CanEncryptComms"
  10973. },
  10974. "can_encrypt_storage": {
  10975. "type": "boolean",
  10976. "x-go-name": "CanEncryptStorage"
  10977. },
  10978. "can_sign": {
  10979. "type": "boolean",
  10980. "x-go-name": "CanSign"
  10981. },
  10982. "created_at": {
  10983. "type": "string",
  10984. "format": "date-time",
  10985. "x-go-name": "Created"
  10986. },
  10987. "emails": {
  10988. "type": "array",
  10989. "items": {
  10990. "$ref": "#/definitions/GPGKeyEmail"
  10991. },
  10992. "x-go-name": "Emails"
  10993. },
  10994. "expires_at": {
  10995. "type": "string",
  10996. "format": "date-time",
  10997. "x-go-name": "Expires"
  10998. },
  10999. "id": {
  11000. "type": "integer",
  11001. "format": "int64",
  11002. "x-go-name": "ID"
  11003. },
  11004. "key_id": {
  11005. "type": "string",
  11006. "x-go-name": "KeyID"
  11007. },
  11008. "primary_key_id": {
  11009. "type": "string",
  11010. "x-go-name": "PrimaryKeyID"
  11011. },
  11012. "public_key": {
  11013. "type": "string",
  11014. "x-go-name": "PublicKey"
  11015. },
  11016. "subkeys": {
  11017. "type": "array",
  11018. "items": {
  11019. "$ref": "#/definitions/GPGKey"
  11020. },
  11021. "x-go-name": "SubsKey"
  11022. }
  11023. },
  11024. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11025. },
  11026. "GPGKeyEmail": {
  11027. "description": "GPGKeyEmail an email attached to a GPGKey",
  11028. "type": "object",
  11029. "properties": {
  11030. "email": {
  11031. "type": "string",
  11032. "x-go-name": "Email"
  11033. },
  11034. "verified": {
  11035. "type": "boolean",
  11036. "x-go-name": "Verified"
  11037. }
  11038. },
  11039. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11040. },
  11041. "GitBlobResponse": {
  11042. "description": "GitBlobResponse represents a git blob",
  11043. "type": "object",
  11044. "properties": {
  11045. "content": {
  11046. "type": "string",
  11047. "x-go-name": "Content"
  11048. },
  11049. "encoding": {
  11050. "type": "string",
  11051. "x-go-name": "Encoding"
  11052. },
  11053. "sha": {
  11054. "type": "string",
  11055. "x-go-name": "SHA"
  11056. },
  11057. "size": {
  11058. "type": "integer",
  11059. "format": "int64",
  11060. "x-go-name": "Size"
  11061. },
  11062. "url": {
  11063. "type": "string",
  11064. "x-go-name": "URL"
  11065. }
  11066. },
  11067. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11068. },
  11069. "GitEntry": {
  11070. "description": "GitEntry represents a git tree",
  11071. "type": "object",
  11072. "properties": {
  11073. "mode": {
  11074. "type": "string",
  11075. "x-go-name": "Mode"
  11076. },
  11077. "path": {
  11078. "type": "string",
  11079. "x-go-name": "Path"
  11080. },
  11081. "sha": {
  11082. "type": "string",
  11083. "x-go-name": "SHA"
  11084. },
  11085. "size": {
  11086. "type": "integer",
  11087. "format": "int64",
  11088. "x-go-name": "Size"
  11089. },
  11090. "type": {
  11091. "type": "string",
  11092. "x-go-name": "Type"
  11093. },
  11094. "url": {
  11095. "type": "string",
  11096. "x-go-name": "URL"
  11097. }
  11098. },
  11099. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11100. },
  11101. "GitHook": {
  11102. "description": "GitHook represents a Git repository hook",
  11103. "type": "object",
  11104. "properties": {
  11105. "content": {
  11106. "type": "string",
  11107. "x-go-name": "Content"
  11108. },
  11109. "is_active": {
  11110. "type": "boolean",
  11111. "x-go-name": "IsActive"
  11112. },
  11113. "name": {
  11114. "type": "string",
  11115. "x-go-name": "Name"
  11116. }
  11117. },
  11118. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11119. },
  11120. "GitObject": {
  11121. "type": "object",
  11122. "title": "GitObject represents a Git object.",
  11123. "properties": {
  11124. "sha": {
  11125. "type": "string",
  11126. "x-go-name": "SHA"
  11127. },
  11128. "type": {
  11129. "type": "string",
  11130. "x-go-name": "Type"
  11131. },
  11132. "url": {
  11133. "type": "string",
  11134. "x-go-name": "URL"
  11135. }
  11136. },
  11137. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11138. },
  11139. "GitTreeResponse": {
  11140. "description": "GitTreeResponse returns a git tree",
  11141. "type": "object",
  11142. "properties": {
  11143. "page": {
  11144. "type": "integer",
  11145. "format": "int64",
  11146. "x-go-name": "Page"
  11147. },
  11148. "sha": {
  11149. "type": "string",
  11150. "x-go-name": "SHA"
  11151. },
  11152. "total_count": {
  11153. "type": "integer",
  11154. "format": "int64",
  11155. "x-go-name": "TotalCount"
  11156. },
  11157. "tree": {
  11158. "type": "array",
  11159. "items": {
  11160. "$ref": "#/definitions/GitEntry"
  11161. },
  11162. "x-go-name": "Entries"
  11163. },
  11164. "truncated": {
  11165. "type": "boolean",
  11166. "x-go-name": "Truncated"
  11167. },
  11168. "url": {
  11169. "type": "string",
  11170. "x-go-name": "URL"
  11171. }
  11172. },
  11173. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11174. },
  11175. "Hook": {
  11176. "description": "Hook a hook is a web hook when one repository changed",
  11177. "type": "object",
  11178. "properties": {
  11179. "active": {
  11180. "type": "boolean",
  11181. "x-go-name": "Active"
  11182. },
  11183. "config": {
  11184. "type": "object",
  11185. "additionalProperties": {
  11186. "type": "string"
  11187. },
  11188. "x-go-name": "Config"
  11189. },
  11190. "created_at": {
  11191. "type": "string",
  11192. "format": "date-time",
  11193. "x-go-name": "Created"
  11194. },
  11195. "events": {
  11196. "type": "array",
  11197. "items": {
  11198. "type": "string"
  11199. },
  11200. "x-go-name": "Events"
  11201. },
  11202. "id": {
  11203. "type": "integer",
  11204. "format": "int64",
  11205. "x-go-name": "ID"
  11206. },
  11207. "type": {
  11208. "type": "string",
  11209. "x-go-name": "Type"
  11210. },
  11211. "updated_at": {
  11212. "type": "string",
  11213. "format": "date-time",
  11214. "x-go-name": "Updated"
  11215. }
  11216. },
  11217. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11218. },
  11219. "Identity": {
  11220. "description": "Identity for a person's identity like an author or committer",
  11221. "type": "object",
  11222. "properties": {
  11223. "email": {
  11224. "type": "string",
  11225. "format": "email",
  11226. "x-go-name": "Email"
  11227. },
  11228. "name": {
  11229. "type": "string",
  11230. "x-go-name": "Name"
  11231. }
  11232. },
  11233. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11234. },
  11235. "InternalTracker": {
  11236. "description": "InternalTracker represents settings for internal tracker",
  11237. "type": "object",
  11238. "properties": {
  11239. "allow_only_contributors_to_track_time": {
  11240. "description": "Let only contributors track time (Built-in issue tracker)",
  11241. "type": "boolean",
  11242. "x-go-name": "AllowOnlyContributorsToTrackTime"
  11243. },
  11244. "enable_issue_dependencies": {
  11245. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  11246. "type": "boolean",
  11247. "x-go-name": "EnableIssueDependencies"
  11248. },
  11249. "enable_time_tracker": {
  11250. "description": "Enable time tracking (Built-in issue tracker)",
  11251. "type": "boolean",
  11252. "x-go-name": "EnableTimeTracker"
  11253. }
  11254. },
  11255. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11256. },
  11257. "Issue": {
  11258. "description": "Issue represents an issue in a repository",
  11259. "type": "object",
  11260. "properties": {
  11261. "assignee": {
  11262. "$ref": "#/definitions/User"
  11263. },
  11264. "assignees": {
  11265. "type": "array",
  11266. "items": {
  11267. "$ref": "#/definitions/User"
  11268. },
  11269. "x-go-name": "Assignees"
  11270. },
  11271. "body": {
  11272. "type": "string",
  11273. "x-go-name": "Body"
  11274. },
  11275. "closed_at": {
  11276. "type": "string",
  11277. "format": "date-time",
  11278. "x-go-name": "Closed"
  11279. },
  11280. "comments": {
  11281. "type": "integer",
  11282. "format": "int64",
  11283. "x-go-name": "Comments"
  11284. },
  11285. "created_at": {
  11286. "type": "string",
  11287. "format": "date-time",
  11288. "x-go-name": "Created"
  11289. },
  11290. "due_date": {
  11291. "type": "string",
  11292. "format": "date-time",
  11293. "x-go-name": "Deadline"
  11294. },
  11295. "html_url": {
  11296. "type": "string",
  11297. "x-go-name": "HTMLURL"
  11298. },
  11299. "id": {
  11300. "type": "integer",
  11301. "format": "int64",
  11302. "x-go-name": "ID"
  11303. },
  11304. "labels": {
  11305. "type": "array",
  11306. "items": {
  11307. "$ref": "#/definitions/Label"
  11308. },
  11309. "x-go-name": "Labels"
  11310. },
  11311. "milestone": {
  11312. "$ref": "#/definitions/Milestone"
  11313. },
  11314. "number": {
  11315. "type": "integer",
  11316. "format": "int64",
  11317. "x-go-name": "Index"
  11318. },
  11319. "original_author": {
  11320. "type": "string",
  11321. "x-go-name": "OriginalAuthor"
  11322. },
  11323. "original_author_id": {
  11324. "type": "integer",
  11325. "format": "int64",
  11326. "x-go-name": "OriginalAuthorID"
  11327. },
  11328. "pull_request": {
  11329. "$ref": "#/definitions/PullRequestMeta"
  11330. },
  11331. "repository": {
  11332. "$ref": "#/definitions/RepositoryMeta"
  11333. },
  11334. "state": {
  11335. "$ref": "#/definitions/StateType"
  11336. },
  11337. "title": {
  11338. "type": "string",
  11339. "x-go-name": "Title"
  11340. },
  11341. "updated_at": {
  11342. "type": "string",
  11343. "format": "date-time",
  11344. "x-go-name": "Updated"
  11345. },
  11346. "url": {
  11347. "type": "string",
  11348. "x-go-name": "URL"
  11349. },
  11350. "user": {
  11351. "$ref": "#/definitions/User"
  11352. }
  11353. },
  11354. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11355. },
  11356. "IssueDeadline": {
  11357. "description": "IssueDeadline represents an issue deadline",
  11358. "type": "object",
  11359. "properties": {
  11360. "due_date": {
  11361. "type": "string",
  11362. "format": "date-time",
  11363. "x-go-name": "Deadline"
  11364. }
  11365. },
  11366. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11367. },
  11368. "IssueLabelsOption": {
  11369. "description": "IssueLabelsOption a collection of labels",
  11370. "type": "object",
  11371. "properties": {
  11372. "labels": {
  11373. "description": "list of label IDs",
  11374. "type": "array",
  11375. "items": {
  11376. "type": "integer",
  11377. "format": "int64"
  11378. },
  11379. "x-go-name": "Labels"
  11380. }
  11381. },
  11382. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11383. },
  11384. "Label": {
  11385. "description": "Label a label to an issue or a pr",
  11386. "type": "object",
  11387. "properties": {
  11388. "color": {
  11389. "type": "string",
  11390. "x-go-name": "Color",
  11391. "example": "00aabb"
  11392. },
  11393. "description": {
  11394. "type": "string",
  11395. "x-go-name": "Description"
  11396. },
  11397. "id": {
  11398. "type": "integer",
  11399. "format": "int64",
  11400. "x-go-name": "ID"
  11401. },
  11402. "name": {
  11403. "type": "string",
  11404. "x-go-name": "Name"
  11405. },
  11406. "url": {
  11407. "type": "string",
  11408. "x-go-name": "URL"
  11409. }
  11410. },
  11411. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11412. },
  11413. "MarkdownOption": {
  11414. "description": "MarkdownOption markdown options",
  11415. "type": "object",
  11416. "properties": {
  11417. "Context": {
  11418. "description": "Context to render\n\nin: body",
  11419. "type": "string"
  11420. },
  11421. "Mode": {
  11422. "description": "Mode to render\n\nin: body",
  11423. "type": "string"
  11424. },
  11425. "Text": {
  11426. "description": "Text markdown to render\n\nin: body",
  11427. "type": "string"
  11428. },
  11429. "Wiki": {
  11430. "description": "Is it a wiki page ?\n\nin: body",
  11431. "type": "boolean"
  11432. }
  11433. },
  11434. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11435. },
  11436. "MergePullRequestOption": {
  11437. "description": "MergePullRequestForm form for merging Pull Request",
  11438. "type": "object",
  11439. "required": [
  11440. "Do"
  11441. ],
  11442. "properties": {
  11443. "Do": {
  11444. "type": "string",
  11445. "enum": [
  11446. "merge",
  11447. "rebase",
  11448. "rebase-merge",
  11449. "squash"
  11450. ]
  11451. },
  11452. "MergeMessageField": {
  11453. "type": "string"
  11454. },
  11455. "MergeTitleField": {
  11456. "type": "string"
  11457. },
  11458. "force_merge": {
  11459. "type": "boolean",
  11460. "x-go-name": "ForceMerge"
  11461. }
  11462. },
  11463. "x-go-name": "MergePullRequestForm",
  11464. "x-go-package": "code.gitea.io/gitea/modules/auth"
  11465. },
  11466. "MigrateRepoForm": {
  11467. "description": "MigrateRepoForm form for migrating repository",
  11468. "type": "object",
  11469. "required": [
  11470. "clone_addr",
  11471. "uid",
  11472. "repo_name"
  11473. ],
  11474. "properties": {
  11475. "auth_password": {
  11476. "type": "string",
  11477. "x-go-name": "AuthPassword"
  11478. },
  11479. "auth_username": {
  11480. "type": "string",
  11481. "x-go-name": "AuthUsername"
  11482. },
  11483. "clone_addr": {
  11484. "type": "string",
  11485. "x-go-name": "CloneAddr"
  11486. },
  11487. "description": {
  11488. "type": "string",
  11489. "x-go-name": "Description"
  11490. },
  11491. "issues": {
  11492. "type": "boolean",
  11493. "x-go-name": "Issues"
  11494. },
  11495. "labels": {
  11496. "type": "boolean",
  11497. "x-go-name": "Labels"
  11498. },
  11499. "milestones": {
  11500. "type": "boolean",
  11501. "x-go-name": "Milestones"
  11502. },
  11503. "mirror": {
  11504. "type": "boolean",
  11505. "x-go-name": "Mirror"
  11506. },
  11507. "private": {
  11508. "type": "boolean",
  11509. "x-go-name": "Private"
  11510. },
  11511. "pull_requests": {
  11512. "type": "boolean",
  11513. "x-go-name": "PullRequests"
  11514. },
  11515. "releases": {
  11516. "type": "boolean",
  11517. "x-go-name": "Releases"
  11518. },
  11519. "repo_name": {
  11520. "type": "string",
  11521. "x-go-name": "RepoName"
  11522. },
  11523. "uid": {
  11524. "type": "integer",
  11525. "format": "int64",
  11526. "x-go-name": "UID"
  11527. },
  11528. "wiki": {
  11529. "type": "boolean",
  11530. "x-go-name": "Wiki"
  11531. }
  11532. },
  11533. "x-go-package": "code.gitea.io/gitea/modules/auth"
  11534. },
  11535. "Milestone": {
  11536. "description": "Milestone milestone is a collection of issues on one repository",
  11537. "type": "object",
  11538. "properties": {
  11539. "closed_at": {
  11540. "type": "string",
  11541. "format": "date-time",
  11542. "x-go-name": "Closed"
  11543. },
  11544. "closed_issues": {
  11545. "type": "integer",
  11546. "format": "int64",
  11547. "x-go-name": "ClosedIssues"
  11548. },
  11549. "description": {
  11550. "type": "string",
  11551. "x-go-name": "Description"
  11552. },
  11553. "due_on": {
  11554. "type": "string",
  11555. "format": "date-time",
  11556. "x-go-name": "Deadline"
  11557. },
  11558. "id": {
  11559. "type": "integer",
  11560. "format": "int64",
  11561. "x-go-name": "ID"
  11562. },
  11563. "open_issues": {
  11564. "type": "integer",
  11565. "format": "int64",
  11566. "x-go-name": "OpenIssues"
  11567. },
  11568. "state": {
  11569. "$ref": "#/definitions/StateType"
  11570. },
  11571. "title": {
  11572. "type": "string",
  11573. "x-go-name": "Title"
  11574. }
  11575. },
  11576. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11577. },
  11578. "NotificationCount": {
  11579. "description": "NotificationCount number of unread notifications",
  11580. "type": "object",
  11581. "properties": {
  11582. "new": {
  11583. "type": "integer",
  11584. "format": "int64",
  11585. "x-go-name": "New"
  11586. }
  11587. },
  11588. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11589. },
  11590. "NotificationSubject": {
  11591. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  11592. "type": "object",
  11593. "properties": {
  11594. "latest_comment_url": {
  11595. "type": "string",
  11596. "x-go-name": "LatestCommentURL"
  11597. },
  11598. "title": {
  11599. "type": "string",
  11600. "x-go-name": "Title"
  11601. },
  11602. "type": {
  11603. "type": "string",
  11604. "x-go-name": "Type"
  11605. },
  11606. "url": {
  11607. "type": "string",
  11608. "x-go-name": "URL"
  11609. }
  11610. },
  11611. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11612. },
  11613. "NotificationThread": {
  11614. "description": "NotificationThread expose Notification on API",
  11615. "type": "object",
  11616. "properties": {
  11617. "id": {
  11618. "type": "integer",
  11619. "format": "int64",
  11620. "x-go-name": "ID"
  11621. },
  11622. "pinned": {
  11623. "type": "boolean",
  11624. "x-go-name": "Pinned"
  11625. },
  11626. "repository": {
  11627. "$ref": "#/definitions/Repository"
  11628. },
  11629. "subject": {
  11630. "$ref": "#/definitions/NotificationSubject"
  11631. },
  11632. "unread": {
  11633. "type": "boolean",
  11634. "x-go-name": "Unread"
  11635. },
  11636. "updated_at": {
  11637. "type": "string",
  11638. "format": "date-time",
  11639. "x-go-name": "UpdatedAt"
  11640. },
  11641. "url": {
  11642. "type": "string",
  11643. "x-go-name": "URL"
  11644. }
  11645. },
  11646. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11647. },
  11648. "Organization": {
  11649. "description": "Organization represents an organization",
  11650. "type": "object",
  11651. "properties": {
  11652. "avatar_url": {
  11653. "type": "string",
  11654. "x-go-name": "AvatarURL"
  11655. },
  11656. "description": {
  11657. "type": "string",
  11658. "x-go-name": "Description"
  11659. },
  11660. "full_name": {
  11661. "type": "string",
  11662. "x-go-name": "FullName"
  11663. },
  11664. "id": {
  11665. "type": "integer",
  11666. "format": "int64",
  11667. "x-go-name": "ID"
  11668. },
  11669. "location": {
  11670. "type": "string",
  11671. "x-go-name": "Location"
  11672. },
  11673. "repo_admin_change_team_access": {
  11674. "type": "boolean",
  11675. "x-go-name": "RepoAdminChangeTeamAccess"
  11676. },
  11677. "username": {
  11678. "type": "string",
  11679. "x-go-name": "UserName"
  11680. },
  11681. "visibility": {
  11682. "type": "string",
  11683. "x-go-name": "Visibility"
  11684. },
  11685. "website": {
  11686. "type": "string",
  11687. "x-go-name": "Website"
  11688. }
  11689. },
  11690. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11691. },
  11692. "PRBranchInfo": {
  11693. "description": "PRBranchInfo information about a branch",
  11694. "type": "object",
  11695. "properties": {
  11696. "label": {
  11697. "type": "string",
  11698. "x-go-name": "Name"
  11699. },
  11700. "ref": {
  11701. "type": "string",
  11702. "x-go-name": "Ref"
  11703. },
  11704. "repo": {
  11705. "$ref": "#/definitions/Repository"
  11706. },
  11707. "repo_id": {
  11708. "type": "integer",
  11709. "format": "int64",
  11710. "x-go-name": "RepoID"
  11711. },
  11712. "sha": {
  11713. "type": "string",
  11714. "x-go-name": "Sha"
  11715. }
  11716. },
  11717. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11718. },
  11719. "PayloadCommit": {
  11720. "description": "PayloadCommit represents a commit",
  11721. "type": "object",
  11722. "properties": {
  11723. "added": {
  11724. "type": "array",
  11725. "items": {
  11726. "type": "string"
  11727. },
  11728. "x-go-name": "Added"
  11729. },
  11730. "author": {
  11731. "$ref": "#/definitions/PayloadUser"
  11732. },
  11733. "committer": {
  11734. "$ref": "#/definitions/PayloadUser"
  11735. },
  11736. "id": {
  11737. "description": "sha1 hash of the commit",
  11738. "type": "string",
  11739. "x-go-name": "ID"
  11740. },
  11741. "message": {
  11742. "type": "string",
  11743. "x-go-name": "Message"
  11744. },
  11745. "modified": {
  11746. "type": "array",
  11747. "items": {
  11748. "type": "string"
  11749. },
  11750. "x-go-name": "Modified"
  11751. },
  11752. "removed": {
  11753. "type": "array",
  11754. "items": {
  11755. "type": "string"
  11756. },
  11757. "x-go-name": "Removed"
  11758. },
  11759. "timestamp": {
  11760. "type": "string",
  11761. "format": "date-time",
  11762. "x-go-name": "Timestamp"
  11763. },
  11764. "url": {
  11765. "type": "string",
  11766. "x-go-name": "URL"
  11767. },
  11768. "verification": {
  11769. "$ref": "#/definitions/PayloadCommitVerification"
  11770. }
  11771. },
  11772. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11773. },
  11774. "PayloadCommitVerification": {
  11775. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  11776. "type": "object",
  11777. "properties": {
  11778. "payload": {
  11779. "type": "string",
  11780. "x-go-name": "Payload"
  11781. },
  11782. "reason": {
  11783. "type": "string",
  11784. "x-go-name": "Reason"
  11785. },
  11786. "signature": {
  11787. "type": "string",
  11788. "x-go-name": "Signature"
  11789. },
  11790. "signer": {
  11791. "$ref": "#/definitions/PayloadUser"
  11792. },
  11793. "verified": {
  11794. "type": "boolean",
  11795. "x-go-name": "Verified"
  11796. }
  11797. },
  11798. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11799. },
  11800. "PayloadUser": {
  11801. "description": "PayloadUser represents the author or committer of a commit",
  11802. "type": "object",
  11803. "properties": {
  11804. "email": {
  11805. "type": "string",
  11806. "format": "email",
  11807. "x-go-name": "Email"
  11808. },
  11809. "name": {
  11810. "description": "Full name of the commit author",
  11811. "type": "string",
  11812. "x-go-name": "Name"
  11813. },
  11814. "username": {
  11815. "type": "string",
  11816. "x-go-name": "UserName"
  11817. }
  11818. },
  11819. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11820. },
  11821. "Permission": {
  11822. "description": "Permission represents a set of permissions",
  11823. "type": "object",
  11824. "properties": {
  11825. "admin": {
  11826. "type": "boolean",
  11827. "x-go-name": "Admin"
  11828. },
  11829. "pull": {
  11830. "type": "boolean",
  11831. "x-go-name": "Pull"
  11832. },
  11833. "push": {
  11834. "type": "boolean",
  11835. "x-go-name": "Push"
  11836. }
  11837. },
  11838. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11839. },
  11840. "PublicKey": {
  11841. "description": "PublicKey publickey is a user key to push code to repository",
  11842. "type": "object",
  11843. "properties": {
  11844. "created_at": {
  11845. "type": "string",
  11846. "format": "date-time",
  11847. "x-go-name": "Created"
  11848. },
  11849. "fingerprint": {
  11850. "type": "string",
  11851. "x-go-name": "Fingerprint"
  11852. },
  11853. "id": {
  11854. "type": "integer",
  11855. "format": "int64",
  11856. "x-go-name": "ID"
  11857. },
  11858. "key": {
  11859. "type": "string",
  11860. "x-go-name": "Key"
  11861. },
  11862. "key_type": {
  11863. "type": "string",
  11864. "x-go-name": "KeyType"
  11865. },
  11866. "read_only": {
  11867. "type": "boolean",
  11868. "x-go-name": "ReadOnly"
  11869. },
  11870. "title": {
  11871. "type": "string",
  11872. "x-go-name": "Title"
  11873. },
  11874. "url": {
  11875. "type": "string",
  11876. "x-go-name": "URL"
  11877. },
  11878. "user": {
  11879. "$ref": "#/definitions/User"
  11880. }
  11881. },
  11882. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11883. },
  11884. "PullRequest": {
  11885. "description": "PullRequest represents a pull request",
  11886. "type": "object",
  11887. "properties": {
  11888. "assignee": {
  11889. "$ref": "#/definitions/User"
  11890. },
  11891. "assignees": {
  11892. "type": "array",
  11893. "items": {
  11894. "$ref": "#/definitions/User"
  11895. },
  11896. "x-go-name": "Assignees"
  11897. },
  11898. "base": {
  11899. "$ref": "#/definitions/PRBranchInfo"
  11900. },
  11901. "body": {
  11902. "type": "string",
  11903. "x-go-name": "Body"
  11904. },
  11905. "closed_at": {
  11906. "type": "string",
  11907. "format": "date-time",
  11908. "x-go-name": "Closed"
  11909. },
  11910. "comments": {
  11911. "type": "integer",
  11912. "format": "int64",
  11913. "x-go-name": "Comments"
  11914. },
  11915. "created_at": {
  11916. "type": "string",
  11917. "format": "date-time",
  11918. "x-go-name": "Created"
  11919. },
  11920. "diff_url": {
  11921. "type": "string",
  11922. "x-go-name": "DiffURL"
  11923. },
  11924. "due_date": {
  11925. "type": "string",
  11926. "format": "date-time",
  11927. "x-go-name": "Deadline"
  11928. },
  11929. "head": {
  11930. "$ref": "#/definitions/PRBranchInfo"
  11931. },
  11932. "html_url": {
  11933. "type": "string",
  11934. "x-go-name": "HTMLURL"
  11935. },
  11936. "id": {
  11937. "type": "integer",
  11938. "format": "int64",
  11939. "x-go-name": "ID"
  11940. },
  11941. "labels": {
  11942. "type": "array",
  11943. "items": {
  11944. "$ref": "#/definitions/Label"
  11945. },
  11946. "x-go-name": "Labels"
  11947. },
  11948. "merge_base": {
  11949. "type": "string",
  11950. "x-go-name": "MergeBase"
  11951. },
  11952. "merge_commit_sha": {
  11953. "type": "string",
  11954. "x-go-name": "MergedCommitID"
  11955. },
  11956. "mergeable": {
  11957. "type": "boolean",
  11958. "x-go-name": "Mergeable"
  11959. },
  11960. "merged": {
  11961. "type": "boolean",
  11962. "x-go-name": "HasMerged"
  11963. },
  11964. "merged_at": {
  11965. "type": "string",
  11966. "format": "date-time",
  11967. "x-go-name": "Merged"
  11968. },
  11969. "merged_by": {
  11970. "$ref": "#/definitions/User"
  11971. },
  11972. "milestone": {
  11973. "$ref": "#/definitions/Milestone"
  11974. },
  11975. "number": {
  11976. "type": "integer",
  11977. "format": "int64",
  11978. "x-go-name": "Index"
  11979. },
  11980. "patch_url": {
  11981. "type": "string",
  11982. "x-go-name": "PatchURL"
  11983. },
  11984. "state": {
  11985. "$ref": "#/definitions/StateType"
  11986. },
  11987. "title": {
  11988. "type": "string",
  11989. "x-go-name": "Title"
  11990. },
  11991. "updated_at": {
  11992. "type": "string",
  11993. "format": "date-time",
  11994. "x-go-name": "Updated"
  11995. },
  11996. "url": {
  11997. "type": "string",
  11998. "x-go-name": "URL"
  11999. },
  12000. "user": {
  12001. "$ref": "#/definitions/User"
  12002. }
  12003. },
  12004. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12005. },
  12006. "PullRequestMeta": {
  12007. "description": "PullRequestMeta PR info if an issue is a PR",
  12008. "type": "object",
  12009. "properties": {
  12010. "merged": {
  12011. "type": "boolean",
  12012. "x-go-name": "HasMerged"
  12013. },
  12014. "merged_at": {
  12015. "type": "string",
  12016. "format": "date-time",
  12017. "x-go-name": "Merged"
  12018. }
  12019. },
  12020. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12021. },
  12022. "Reaction": {
  12023. "description": "Reaction contain one reaction",
  12024. "type": "object",
  12025. "properties": {
  12026. "content": {
  12027. "type": "string",
  12028. "x-go-name": "Reaction"
  12029. },
  12030. "created_at": {
  12031. "type": "string",
  12032. "format": "date-time",
  12033. "x-go-name": "Created"
  12034. },
  12035. "user": {
  12036. "$ref": "#/definitions/User"
  12037. }
  12038. },
  12039. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12040. },
  12041. "Reference": {
  12042. "type": "object",
  12043. "title": "Reference represents a Git reference.",
  12044. "properties": {
  12045. "object": {
  12046. "$ref": "#/definitions/GitObject"
  12047. },
  12048. "ref": {
  12049. "type": "string",
  12050. "x-go-name": "Ref"
  12051. },
  12052. "url": {
  12053. "type": "string",
  12054. "x-go-name": "URL"
  12055. }
  12056. },
  12057. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12058. },
  12059. "Release": {
  12060. "description": "Release represents a repository release",
  12061. "type": "object",
  12062. "properties": {
  12063. "assets": {
  12064. "type": "array",
  12065. "items": {
  12066. "$ref": "#/definitions/Attachment"
  12067. },
  12068. "x-go-name": "Attachments"
  12069. },
  12070. "author": {
  12071. "$ref": "#/definitions/User"
  12072. },
  12073. "body": {
  12074. "type": "string",
  12075. "x-go-name": "Note"
  12076. },
  12077. "created_at": {
  12078. "type": "string",
  12079. "format": "date-time",
  12080. "x-go-name": "CreatedAt"
  12081. },
  12082. "draft": {
  12083. "type": "boolean",
  12084. "x-go-name": "IsDraft"
  12085. },
  12086. "id": {
  12087. "type": "integer",
  12088. "format": "int64",
  12089. "x-go-name": "ID"
  12090. },
  12091. "name": {
  12092. "type": "string",
  12093. "x-go-name": "Title"
  12094. },
  12095. "prerelease": {
  12096. "type": "boolean",
  12097. "x-go-name": "IsPrerelease"
  12098. },
  12099. "published_at": {
  12100. "type": "string",
  12101. "format": "date-time",
  12102. "x-go-name": "PublishedAt"
  12103. },
  12104. "tag_name": {
  12105. "type": "string",
  12106. "x-go-name": "TagName"
  12107. },
  12108. "tarball_url": {
  12109. "type": "string",
  12110. "x-go-name": "TarURL"
  12111. },
  12112. "target_commitish": {
  12113. "type": "string",
  12114. "x-go-name": "Target"
  12115. },
  12116. "url": {
  12117. "type": "string",
  12118. "x-go-name": "URL"
  12119. },
  12120. "zipball_url": {
  12121. "type": "string",
  12122. "x-go-name": "ZipURL"
  12123. }
  12124. },
  12125. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12126. },
  12127. "RepoCommit": {
  12128. "type": "object",
  12129. "title": "RepoCommit contains information of a commit in the context of a repository.",
  12130. "properties": {
  12131. "author": {
  12132. "$ref": "#/definitions/CommitUser"
  12133. },
  12134. "committer": {
  12135. "$ref": "#/definitions/CommitUser"
  12136. },
  12137. "message": {
  12138. "type": "string",
  12139. "x-go-name": "Message"
  12140. },
  12141. "tree": {
  12142. "$ref": "#/definitions/CommitMeta"
  12143. },
  12144. "url": {
  12145. "type": "string",
  12146. "x-go-name": "URL"
  12147. }
  12148. },
  12149. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12150. },
  12151. "RepoTopicOptions": {
  12152. "description": "RepoTopicOptions a collection of repo topic names",
  12153. "type": "object",
  12154. "properties": {
  12155. "topics": {
  12156. "description": "list of topic names",
  12157. "type": "array",
  12158. "items": {
  12159. "type": "string"
  12160. },
  12161. "x-go-name": "Topics"
  12162. }
  12163. },
  12164. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12165. },
  12166. "Repository": {
  12167. "description": "Repository represents a repository",
  12168. "type": "object",
  12169. "properties": {
  12170. "allow_merge_commits": {
  12171. "type": "boolean",
  12172. "x-go-name": "AllowMerge"
  12173. },
  12174. "allow_rebase": {
  12175. "type": "boolean",
  12176. "x-go-name": "AllowRebase"
  12177. },
  12178. "allow_rebase_explicit": {
  12179. "type": "boolean",
  12180. "x-go-name": "AllowRebaseMerge"
  12181. },
  12182. "allow_squash_merge": {
  12183. "type": "boolean",
  12184. "x-go-name": "AllowSquash"
  12185. },
  12186. "archived": {
  12187. "type": "boolean",
  12188. "x-go-name": "Archived"
  12189. },
  12190. "avatar_url": {
  12191. "type": "string",
  12192. "x-go-name": "AvatarURL"
  12193. },
  12194. "clone_url": {
  12195. "type": "string",
  12196. "x-go-name": "CloneURL"
  12197. },
  12198. "created_at": {
  12199. "type": "string",
  12200. "format": "date-time",
  12201. "x-go-name": "Created"
  12202. },
  12203. "default_branch": {
  12204. "type": "string",
  12205. "x-go-name": "DefaultBranch"
  12206. },
  12207. "description": {
  12208. "type": "string",
  12209. "x-go-name": "Description"
  12210. },
  12211. "empty": {
  12212. "type": "boolean",
  12213. "x-go-name": "Empty"
  12214. },
  12215. "external_tracker": {
  12216. "$ref": "#/definitions/ExternalTracker"
  12217. },
  12218. "external_wiki": {
  12219. "$ref": "#/definitions/ExternalWiki"
  12220. },
  12221. "fork": {
  12222. "type": "boolean",
  12223. "x-go-name": "Fork"
  12224. },
  12225. "forks_count": {
  12226. "type": "integer",
  12227. "format": "int64",
  12228. "x-go-name": "Forks"
  12229. },
  12230. "full_name": {
  12231. "type": "string",
  12232. "x-go-name": "FullName"
  12233. },
  12234. "has_issues": {
  12235. "type": "boolean",
  12236. "x-go-name": "HasIssues"
  12237. },
  12238. "has_pull_requests": {
  12239. "type": "boolean",
  12240. "x-go-name": "HasPullRequests"
  12241. },
  12242. "has_wiki": {
  12243. "type": "boolean",
  12244. "x-go-name": "HasWiki"
  12245. },
  12246. "html_url": {
  12247. "type": "string",
  12248. "x-go-name": "HTMLURL"
  12249. },
  12250. "id": {
  12251. "type": "integer",
  12252. "format": "int64",
  12253. "x-go-name": "ID"
  12254. },
  12255. "ignore_whitespace_conflicts": {
  12256. "type": "boolean",
  12257. "x-go-name": "IgnoreWhitespaceConflicts"
  12258. },
  12259. "internal_tracker": {
  12260. "$ref": "#/definitions/InternalTracker"
  12261. },
  12262. "mirror": {
  12263. "type": "boolean",
  12264. "x-go-name": "Mirror"
  12265. },
  12266. "name": {
  12267. "type": "string",
  12268. "x-go-name": "Name"
  12269. },
  12270. "open_issues_count": {
  12271. "type": "integer",
  12272. "format": "int64",
  12273. "x-go-name": "OpenIssues"
  12274. },
  12275. "open_pr_counter": {
  12276. "type": "integer",
  12277. "format": "int64",
  12278. "x-go-name": "OpenPulls"
  12279. },
  12280. "original_url": {
  12281. "type": "string",
  12282. "x-go-name": "OriginalURL"
  12283. },
  12284. "owner": {
  12285. "$ref": "#/definitions/User"
  12286. },
  12287. "parent": {
  12288. "$ref": "#/definitions/Repository"
  12289. },
  12290. "permissions": {
  12291. "$ref": "#/definitions/Permission"
  12292. },
  12293. "private": {
  12294. "type": "boolean",
  12295. "x-go-name": "Private"
  12296. },
  12297. "release_counter": {
  12298. "type": "integer",
  12299. "format": "int64",
  12300. "x-go-name": "Releases"
  12301. },
  12302. "size": {
  12303. "type": "integer",
  12304. "format": "int64",
  12305. "x-go-name": "Size"
  12306. },
  12307. "ssh_url": {
  12308. "type": "string",
  12309. "x-go-name": "SSHURL"
  12310. },
  12311. "stars_count": {
  12312. "type": "integer",
  12313. "format": "int64",
  12314. "x-go-name": "Stars"
  12315. },
  12316. "template": {
  12317. "type": "boolean",
  12318. "x-go-name": "Template"
  12319. },
  12320. "updated_at": {
  12321. "type": "string",
  12322. "format": "date-time",
  12323. "x-go-name": "Updated"
  12324. },
  12325. "watchers_count": {
  12326. "type": "integer",
  12327. "format": "int64",
  12328. "x-go-name": "Watchers"
  12329. },
  12330. "website": {
  12331. "type": "string",
  12332. "x-go-name": "Website"
  12333. }
  12334. },
  12335. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12336. },
  12337. "RepositoryMeta": {
  12338. "description": "RepositoryMeta basic repository information",
  12339. "type": "object",
  12340. "properties": {
  12341. "full_name": {
  12342. "type": "string",
  12343. "x-go-name": "FullName"
  12344. },
  12345. "id": {
  12346. "type": "integer",
  12347. "format": "int64",
  12348. "x-go-name": "ID"
  12349. },
  12350. "name": {
  12351. "type": "string",
  12352. "x-go-name": "Name"
  12353. }
  12354. },
  12355. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12356. },
  12357. "SearchResults": {
  12358. "description": "SearchResults results of a successful search",
  12359. "type": "object",
  12360. "properties": {
  12361. "data": {
  12362. "type": "array",
  12363. "items": {
  12364. "$ref": "#/definitions/Repository"
  12365. },
  12366. "x-go-name": "Data"
  12367. },
  12368. "ok": {
  12369. "type": "boolean",
  12370. "x-go-name": "OK"
  12371. }
  12372. },
  12373. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12374. },
  12375. "ServerVersion": {
  12376. "description": "ServerVersion wraps the version of the server",
  12377. "type": "object",
  12378. "properties": {
  12379. "version": {
  12380. "type": "string",
  12381. "x-go-name": "Version"
  12382. }
  12383. },
  12384. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12385. },
  12386. "StateType": {
  12387. "description": "StateType issue state type",
  12388. "type": "string",
  12389. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12390. },
  12391. "Status": {
  12392. "description": "Status holds a single Status of a single Commit",
  12393. "type": "object",
  12394. "properties": {
  12395. "context": {
  12396. "type": "string",
  12397. "x-go-name": "Context"
  12398. },
  12399. "created_at": {
  12400. "type": "string",
  12401. "format": "date-time",
  12402. "x-go-name": "Created"
  12403. },
  12404. "creator": {
  12405. "$ref": "#/definitions/User"
  12406. },
  12407. "description": {
  12408. "type": "string",
  12409. "x-go-name": "Description"
  12410. },
  12411. "id": {
  12412. "type": "integer",
  12413. "format": "int64",
  12414. "x-go-name": "ID"
  12415. },
  12416. "status": {
  12417. "$ref": "#/definitions/StatusState"
  12418. },
  12419. "target_url": {
  12420. "type": "string",
  12421. "x-go-name": "TargetURL"
  12422. },
  12423. "updated_at": {
  12424. "type": "string",
  12425. "format": "date-time",
  12426. "x-go-name": "Updated"
  12427. },
  12428. "url": {
  12429. "type": "string",
  12430. "x-go-name": "URL"
  12431. }
  12432. },
  12433. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12434. },
  12435. "StatusState": {
  12436. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  12437. "type": "string",
  12438. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12439. },
  12440. "StopWatch": {
  12441. "description": "StopWatch represent a running stopwatch",
  12442. "type": "object",
  12443. "properties": {
  12444. "created": {
  12445. "type": "string",
  12446. "format": "date-time",
  12447. "x-go-name": "Created"
  12448. },
  12449. "issue_index": {
  12450. "type": "integer",
  12451. "format": "int64",
  12452. "x-go-name": "IssueIndex"
  12453. }
  12454. },
  12455. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12456. },
  12457. "Tag": {
  12458. "description": "Tag represents a repository tag",
  12459. "type": "object",
  12460. "properties": {
  12461. "commit": {
  12462. "$ref": "#/definitions/CommitMeta"
  12463. },
  12464. "id": {
  12465. "type": "string",
  12466. "x-go-name": "ID"
  12467. },
  12468. "name": {
  12469. "type": "string",
  12470. "x-go-name": "Name"
  12471. },
  12472. "tarball_url": {
  12473. "type": "string",
  12474. "x-go-name": "TarballURL"
  12475. },
  12476. "zipball_url": {
  12477. "type": "string",
  12478. "x-go-name": "ZipballURL"
  12479. }
  12480. },
  12481. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12482. },
  12483. "Team": {
  12484. "description": "Team represents a team in an organization",
  12485. "type": "object",
  12486. "properties": {
  12487. "can_create_org_repo": {
  12488. "type": "boolean",
  12489. "x-go-name": "CanCreateOrgRepo"
  12490. },
  12491. "description": {
  12492. "type": "string",
  12493. "x-go-name": "Description"
  12494. },
  12495. "id": {
  12496. "type": "integer",
  12497. "format": "int64",
  12498. "x-go-name": "ID"
  12499. },
  12500. "includes_all_repositories": {
  12501. "type": "boolean",
  12502. "x-go-name": "IncludesAllRepositories"
  12503. },
  12504. "name": {
  12505. "type": "string",
  12506. "x-go-name": "Name"
  12507. },
  12508. "organization": {
  12509. "$ref": "#/definitions/Organization"
  12510. },
  12511. "permission": {
  12512. "type": "string",
  12513. "enum": [
  12514. "none",
  12515. "read",
  12516. "write",
  12517. "admin",
  12518. "owner"
  12519. ],
  12520. "x-go-name": "Permission"
  12521. },
  12522. "units": {
  12523. "type": "array",
  12524. "items": {
  12525. "type": "string"
  12526. },
  12527. "x-go-name": "Units",
  12528. "example": [
  12529. "repo.code",
  12530. "repo.issues",
  12531. "repo.ext_issues",
  12532. "repo.wiki",
  12533. "repo.pulls",
  12534. "repo.releases",
  12535. "repo.ext_wiki"
  12536. ]
  12537. }
  12538. },
  12539. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12540. },
  12541. "TimeStamp": {
  12542. "description": "TimeStamp defines a timestamp",
  12543. "type": "integer",
  12544. "format": "int64",
  12545. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  12546. },
  12547. "TopicName": {
  12548. "description": "TopicName a list of repo topic names",
  12549. "type": "object",
  12550. "properties": {
  12551. "topics": {
  12552. "type": "array",
  12553. "items": {
  12554. "type": "string"
  12555. },
  12556. "x-go-name": "TopicNames"
  12557. }
  12558. },
  12559. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12560. },
  12561. "TopicResponse": {
  12562. "description": "TopicResponse for returning topics",
  12563. "type": "object",
  12564. "properties": {
  12565. "created": {
  12566. "type": "string",
  12567. "format": "date-time",
  12568. "x-go-name": "Created"
  12569. },
  12570. "id": {
  12571. "type": "integer",
  12572. "format": "int64",
  12573. "x-go-name": "ID"
  12574. },
  12575. "repo_count": {
  12576. "type": "integer",
  12577. "format": "int64",
  12578. "x-go-name": "RepoCount"
  12579. },
  12580. "topic_name": {
  12581. "type": "string",
  12582. "x-go-name": "Name"
  12583. },
  12584. "updated": {
  12585. "type": "string",
  12586. "format": "date-time",
  12587. "x-go-name": "Updated"
  12588. }
  12589. },
  12590. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12591. },
  12592. "TrackedTime": {
  12593. "description": "TrackedTime worked time for an issue / pr",
  12594. "type": "object",
  12595. "properties": {
  12596. "created": {
  12597. "type": "string",
  12598. "format": "date-time",
  12599. "x-go-name": "Created"
  12600. },
  12601. "id": {
  12602. "type": "integer",
  12603. "format": "int64",
  12604. "x-go-name": "ID"
  12605. },
  12606. "issue": {
  12607. "$ref": "#/definitions/Issue"
  12608. },
  12609. "issue_id": {
  12610. "description": "deprecated (only for backwards compatibility)",
  12611. "type": "integer",
  12612. "format": "int64",
  12613. "x-go-name": "IssueID"
  12614. },
  12615. "time": {
  12616. "description": "Time in seconds",
  12617. "type": "integer",
  12618. "format": "int64",
  12619. "x-go-name": "Time"
  12620. },
  12621. "user_id": {
  12622. "description": "deprecated (only for backwards compatibility)",
  12623. "type": "integer",
  12624. "format": "int64",
  12625. "x-go-name": "UserID"
  12626. },
  12627. "user_name": {
  12628. "type": "string",
  12629. "x-go-name": "UserName"
  12630. }
  12631. },
  12632. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12633. },
  12634. "TransferRepoOption": {
  12635. "description": "TransferRepoOption options when transfer a repository's ownership",
  12636. "type": "object",
  12637. "required": [
  12638. "new_owner"
  12639. ],
  12640. "properties": {
  12641. "new_owner": {
  12642. "type": "string",
  12643. "x-go-name": "NewOwner"
  12644. },
  12645. "team_ids": {
  12646. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  12647. "type": "array",
  12648. "items": {
  12649. "type": "integer",
  12650. "format": "int64"
  12651. },
  12652. "x-go-name": "TeamIDs"
  12653. }
  12654. },
  12655. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12656. },
  12657. "UpdateFileOptions": {
  12658. "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)",
  12659. "type": "object",
  12660. "required": [
  12661. "sha",
  12662. "content"
  12663. ],
  12664. "properties": {
  12665. "author": {
  12666. "$ref": "#/definitions/Identity"
  12667. },
  12668. "branch": {
  12669. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  12670. "type": "string",
  12671. "x-go-name": "BranchName"
  12672. },
  12673. "committer": {
  12674. "$ref": "#/definitions/Identity"
  12675. },
  12676. "content": {
  12677. "description": "content must be base64 encoded",
  12678. "type": "string",
  12679. "x-go-name": "Content"
  12680. },
  12681. "dates": {
  12682. "$ref": "#/definitions/CommitDateOptions"
  12683. },
  12684. "from_path": {
  12685. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  12686. "type": "string",
  12687. "x-go-name": "FromPath"
  12688. },
  12689. "message": {
  12690. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  12691. "type": "string",
  12692. "x-go-name": "Message"
  12693. },
  12694. "new_branch": {
  12695. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  12696. "type": "string",
  12697. "x-go-name": "NewBranchName"
  12698. },
  12699. "sha": {
  12700. "description": "sha is the SHA for the file that already exists",
  12701. "type": "string",
  12702. "x-go-name": "SHA"
  12703. }
  12704. },
  12705. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12706. },
  12707. "User": {
  12708. "description": "User represents a user",
  12709. "type": "object",
  12710. "properties": {
  12711. "avatar_url": {
  12712. "description": "URL to the user's avatar",
  12713. "type": "string",
  12714. "x-go-name": "AvatarURL"
  12715. },
  12716. "created": {
  12717. "type": "string",
  12718. "format": "date-time",
  12719. "x-go-name": "Created"
  12720. },
  12721. "email": {
  12722. "type": "string",
  12723. "format": "email",
  12724. "x-go-name": "Email"
  12725. },
  12726. "full_name": {
  12727. "description": "the user's full name",
  12728. "type": "string",
  12729. "x-go-name": "FullName"
  12730. },
  12731. "id": {
  12732. "description": "the user's id",
  12733. "type": "integer",
  12734. "format": "int64",
  12735. "x-go-name": "ID"
  12736. },
  12737. "is_admin": {
  12738. "description": "Is the user an administrator",
  12739. "type": "boolean",
  12740. "x-go-name": "IsAdmin"
  12741. },
  12742. "language": {
  12743. "description": "User locale",
  12744. "type": "string",
  12745. "x-go-name": "Language"
  12746. },
  12747. "last_login": {
  12748. "type": "string",
  12749. "format": "date-time",
  12750. "x-go-name": "LastLogin"
  12751. },
  12752. "login": {
  12753. "description": "the user's username",
  12754. "type": "string",
  12755. "x-go-name": "UserName"
  12756. }
  12757. },
  12758. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12759. },
  12760. "UserHeatmapData": {
  12761. "description": "UserHeatmapData represents the data needed to create a heatmap",
  12762. "type": "object",
  12763. "properties": {
  12764. "contributions": {
  12765. "type": "integer",
  12766. "format": "int64",
  12767. "x-go-name": "Contributions"
  12768. },
  12769. "timestamp": {
  12770. "$ref": "#/definitions/TimeStamp"
  12771. }
  12772. },
  12773. "x-go-package": "code.gitea.io/gitea/models"
  12774. },
  12775. "WatchInfo": {
  12776. "description": "WatchInfo represents an API watch status of one repository",
  12777. "type": "object",
  12778. "properties": {
  12779. "created_at": {
  12780. "type": "string",
  12781. "format": "date-time",
  12782. "x-go-name": "CreatedAt"
  12783. },
  12784. "ignored": {
  12785. "type": "boolean",
  12786. "x-go-name": "Ignored"
  12787. },
  12788. "reason": {
  12789. "type": "object",
  12790. "x-go-name": "Reason"
  12791. },
  12792. "repository_url": {
  12793. "type": "string",
  12794. "x-go-name": "RepositoryURL"
  12795. },
  12796. "subscribed": {
  12797. "type": "boolean",
  12798. "x-go-name": "Subscribed"
  12799. },
  12800. "url": {
  12801. "type": "string",
  12802. "x-go-name": "URL"
  12803. }
  12804. },
  12805. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12806. }
  12807. },
  12808. "responses": {
  12809. "AccessToken": {
  12810. "description": "AccessToken represents an API access token.",
  12811. "headers": {
  12812. "id": {
  12813. "type": "integer",
  12814. "format": "int64"
  12815. },
  12816. "name": {
  12817. "type": "string"
  12818. },
  12819. "sha1": {
  12820. "type": "string"
  12821. },
  12822. "token_last_eight": {
  12823. "type": "string"
  12824. }
  12825. }
  12826. },
  12827. "AccessTokenList": {
  12828. "description": "AccessTokenList represents a list of API access token.",
  12829. "schema": {
  12830. "type": "array",
  12831. "items": {
  12832. "$ref": "#/definitions/AccessToken"
  12833. }
  12834. }
  12835. },
  12836. "AnnotatedTag": {
  12837. "description": "AnnotatedTag",
  12838. "schema": {
  12839. "$ref": "#/definitions/AnnotatedTag"
  12840. }
  12841. },
  12842. "Attachment": {
  12843. "description": "Attachment",
  12844. "schema": {
  12845. "$ref": "#/definitions/Attachment"
  12846. }
  12847. },
  12848. "AttachmentList": {
  12849. "description": "AttachmentList",
  12850. "schema": {
  12851. "type": "array",
  12852. "items": {
  12853. "$ref": "#/definitions/Attachment"
  12854. }
  12855. }
  12856. },
  12857. "Branch": {
  12858. "description": "Branch",
  12859. "schema": {
  12860. "$ref": "#/definitions/Branch"
  12861. }
  12862. },
  12863. "BranchList": {
  12864. "description": "BranchList",
  12865. "schema": {
  12866. "type": "array",
  12867. "items": {
  12868. "$ref": "#/definitions/Branch"
  12869. }
  12870. }
  12871. },
  12872. "Comment": {
  12873. "description": "Comment",
  12874. "schema": {
  12875. "$ref": "#/definitions/Comment"
  12876. }
  12877. },
  12878. "CommentList": {
  12879. "description": "CommentList",
  12880. "schema": {
  12881. "type": "array",
  12882. "items": {
  12883. "$ref": "#/definitions/Comment"
  12884. }
  12885. }
  12886. },
  12887. "Commit": {
  12888. "description": "Commit",
  12889. "schema": {
  12890. "$ref": "#/definitions/Commit"
  12891. }
  12892. },
  12893. "CommitList": {
  12894. "description": "CommitList",
  12895. "schema": {
  12896. "type": "array",
  12897. "items": {
  12898. "$ref": "#/definitions/Commit"
  12899. }
  12900. },
  12901. "headers": {
  12902. "X-HasMore": {
  12903. "type": "boolean",
  12904. "description": "True if there is another page"
  12905. },
  12906. "X-Page": {
  12907. "type": "integer",
  12908. "format": "int64",
  12909. "description": "The current page"
  12910. },
  12911. "X-PageCount": {
  12912. "type": "integer",
  12913. "format": "int64",
  12914. "description": "Total number of pages"
  12915. },
  12916. "X-PerPage": {
  12917. "type": "integer",
  12918. "format": "int64",
  12919. "description": "Commits per page"
  12920. },
  12921. "X-Total": {
  12922. "type": "integer",
  12923. "format": "int64",
  12924. "description": "Total commit count"
  12925. }
  12926. }
  12927. },
  12928. "ContentsListResponse": {
  12929. "description": "ContentsListResponse",
  12930. "schema": {
  12931. "type": "array",
  12932. "items": {
  12933. "$ref": "#/definitions/ContentsResponse"
  12934. }
  12935. }
  12936. },
  12937. "ContentsResponse": {
  12938. "description": "ContentsResponse",
  12939. "schema": {
  12940. "$ref": "#/definitions/ContentsResponse"
  12941. }
  12942. },
  12943. "DeployKey": {
  12944. "description": "DeployKey",
  12945. "schema": {
  12946. "$ref": "#/definitions/DeployKey"
  12947. }
  12948. },
  12949. "DeployKeyList": {
  12950. "description": "DeployKeyList",
  12951. "schema": {
  12952. "type": "array",
  12953. "items": {
  12954. "$ref": "#/definitions/DeployKey"
  12955. }
  12956. }
  12957. },
  12958. "EmailList": {
  12959. "description": "EmailList",
  12960. "schema": {
  12961. "type": "array",
  12962. "items": {
  12963. "$ref": "#/definitions/Email"
  12964. }
  12965. }
  12966. },
  12967. "EmptyRepository": {
  12968. "description": "EmptyRepository",
  12969. "schema": {
  12970. "$ref": "#/definitions/APIError"
  12971. }
  12972. },
  12973. "FileDeleteResponse": {
  12974. "description": "FileDeleteResponse",
  12975. "schema": {
  12976. "$ref": "#/definitions/FileDeleteResponse"
  12977. }
  12978. },
  12979. "FileResponse": {
  12980. "description": "FileResponse",
  12981. "schema": {
  12982. "$ref": "#/definitions/FileResponse"
  12983. }
  12984. },
  12985. "GPGKey": {
  12986. "description": "GPGKey",
  12987. "schema": {
  12988. "$ref": "#/definitions/GPGKey"
  12989. }
  12990. },
  12991. "GPGKeyList": {
  12992. "description": "GPGKeyList",
  12993. "schema": {
  12994. "type": "array",
  12995. "items": {
  12996. "$ref": "#/definitions/GPGKey"
  12997. }
  12998. }
  12999. },
  13000. "GitBlobResponse": {
  13001. "description": "GitBlobResponse",
  13002. "schema": {
  13003. "$ref": "#/definitions/GitBlobResponse"
  13004. }
  13005. },
  13006. "GitHook": {
  13007. "description": "GitHook",
  13008. "schema": {
  13009. "$ref": "#/definitions/GitHook"
  13010. }
  13011. },
  13012. "GitHookList": {
  13013. "description": "GitHookList",
  13014. "schema": {
  13015. "type": "array",
  13016. "items": {
  13017. "$ref": "#/definitions/GitHook"
  13018. }
  13019. }
  13020. },
  13021. "GitTreeResponse": {
  13022. "description": "GitTreeResponse",
  13023. "schema": {
  13024. "$ref": "#/definitions/GitTreeResponse"
  13025. }
  13026. },
  13027. "Hook": {
  13028. "description": "Hook",
  13029. "schema": {
  13030. "$ref": "#/definitions/Hook"
  13031. }
  13032. },
  13033. "HookList": {
  13034. "description": "HookList",
  13035. "schema": {
  13036. "type": "array",
  13037. "items": {
  13038. "$ref": "#/definitions/Hook"
  13039. }
  13040. }
  13041. },
  13042. "Issue": {
  13043. "description": "Issue",
  13044. "schema": {
  13045. "$ref": "#/definitions/Issue"
  13046. }
  13047. },
  13048. "IssueDeadline": {
  13049. "description": "IssueDeadline",
  13050. "schema": {
  13051. "$ref": "#/definitions/IssueDeadline"
  13052. }
  13053. },
  13054. "IssueList": {
  13055. "description": "IssueList",
  13056. "schema": {
  13057. "type": "array",
  13058. "items": {
  13059. "$ref": "#/definitions/Issue"
  13060. }
  13061. }
  13062. },
  13063. "Label": {
  13064. "description": "Label",
  13065. "schema": {
  13066. "$ref": "#/definitions/Label"
  13067. }
  13068. },
  13069. "LabelList": {
  13070. "description": "LabelList",
  13071. "schema": {
  13072. "type": "array",
  13073. "items": {
  13074. "$ref": "#/definitions/Label"
  13075. }
  13076. }
  13077. },
  13078. "MarkdownRender": {
  13079. "description": "MarkdownRender is a rendered markdown document",
  13080. "schema": {
  13081. "type": "string"
  13082. }
  13083. },
  13084. "Milestone": {
  13085. "description": "Milestone",
  13086. "schema": {
  13087. "$ref": "#/definitions/Milestone"
  13088. }
  13089. },
  13090. "MilestoneList": {
  13091. "description": "MilestoneList",
  13092. "schema": {
  13093. "type": "array",
  13094. "items": {
  13095. "$ref": "#/definitions/Milestone"
  13096. }
  13097. }
  13098. },
  13099. "NotificationCount": {
  13100. "description": "Number of unread notifications",
  13101. "schema": {
  13102. "$ref": "#/definitions/NotificationCount"
  13103. }
  13104. },
  13105. "NotificationThread": {
  13106. "description": "NotificationThread",
  13107. "schema": {
  13108. "$ref": "#/definitions/NotificationThread"
  13109. }
  13110. },
  13111. "NotificationThreadList": {
  13112. "description": "NotificationThreadList",
  13113. "schema": {
  13114. "type": "array",
  13115. "items": {
  13116. "$ref": "#/definitions/NotificationThread"
  13117. }
  13118. }
  13119. },
  13120. "Organization": {
  13121. "description": "Organization",
  13122. "schema": {
  13123. "$ref": "#/definitions/Organization"
  13124. }
  13125. },
  13126. "OrganizationList": {
  13127. "description": "OrganizationList",
  13128. "schema": {
  13129. "type": "array",
  13130. "items": {
  13131. "$ref": "#/definitions/Organization"
  13132. }
  13133. }
  13134. },
  13135. "PublicKey": {
  13136. "description": "PublicKey",
  13137. "schema": {
  13138. "$ref": "#/definitions/PublicKey"
  13139. }
  13140. },
  13141. "PublicKeyList": {
  13142. "description": "PublicKeyList",
  13143. "schema": {
  13144. "type": "array",
  13145. "items": {
  13146. "$ref": "#/definitions/PublicKey"
  13147. }
  13148. }
  13149. },
  13150. "PullRequest": {
  13151. "description": "PullRequest",
  13152. "schema": {
  13153. "$ref": "#/definitions/PullRequest"
  13154. }
  13155. },
  13156. "PullRequestList": {
  13157. "description": "PullRequestList",
  13158. "schema": {
  13159. "type": "array",
  13160. "items": {
  13161. "$ref": "#/definitions/PullRequest"
  13162. }
  13163. }
  13164. },
  13165. "Reaction": {
  13166. "description": "Reaction",
  13167. "schema": {
  13168. "$ref": "#/definitions/Reaction"
  13169. }
  13170. },
  13171. "ReactionList": {
  13172. "description": "ReactionList",
  13173. "schema": {
  13174. "type": "array",
  13175. "items": {
  13176. "$ref": "#/definitions/Reaction"
  13177. }
  13178. }
  13179. },
  13180. "Reference": {
  13181. "description": "Reference",
  13182. "schema": {
  13183. "$ref": "#/definitions/Reference"
  13184. }
  13185. },
  13186. "ReferenceList": {
  13187. "description": "ReferenceList",
  13188. "schema": {
  13189. "type": "array",
  13190. "items": {
  13191. "$ref": "#/definitions/Reference"
  13192. }
  13193. }
  13194. },
  13195. "Release": {
  13196. "description": "Release",
  13197. "schema": {
  13198. "$ref": "#/definitions/Release"
  13199. }
  13200. },
  13201. "ReleaseList": {
  13202. "description": "ReleaseList",
  13203. "schema": {
  13204. "type": "array",
  13205. "items": {
  13206. "$ref": "#/definitions/Release"
  13207. }
  13208. }
  13209. },
  13210. "Repository": {
  13211. "description": "Repository",
  13212. "schema": {
  13213. "$ref": "#/definitions/Repository"
  13214. }
  13215. },
  13216. "RepositoryList": {
  13217. "description": "RepositoryList",
  13218. "schema": {
  13219. "type": "array",
  13220. "items": {
  13221. "$ref": "#/definitions/Repository"
  13222. }
  13223. }
  13224. },
  13225. "SearchResults": {
  13226. "description": "SearchResults",
  13227. "schema": {
  13228. "$ref": "#/definitions/SearchResults"
  13229. }
  13230. },
  13231. "ServerVersion": {
  13232. "description": "ServerVersion",
  13233. "schema": {
  13234. "$ref": "#/definitions/ServerVersion"
  13235. }
  13236. },
  13237. "Status": {
  13238. "description": "Status",
  13239. "schema": {
  13240. "$ref": "#/definitions/Status"
  13241. }
  13242. },
  13243. "StatusList": {
  13244. "description": "StatusList",
  13245. "schema": {
  13246. "type": "array",
  13247. "items": {
  13248. "$ref": "#/definitions/Status"
  13249. }
  13250. }
  13251. },
  13252. "StopWatch": {
  13253. "description": "StopWatch",
  13254. "schema": {
  13255. "$ref": "#/definitions/StopWatch"
  13256. }
  13257. },
  13258. "StopWatchList": {
  13259. "description": "StopWatchList",
  13260. "schema": {
  13261. "type": "array",
  13262. "items": {
  13263. "$ref": "#/definitions/StopWatch"
  13264. }
  13265. }
  13266. },
  13267. "Tag": {
  13268. "description": "Tag",
  13269. "schema": {
  13270. "$ref": "#/definitions/Tag"
  13271. }
  13272. },
  13273. "TagList": {
  13274. "description": "TagList",
  13275. "schema": {
  13276. "type": "array",
  13277. "items": {
  13278. "$ref": "#/definitions/Tag"
  13279. }
  13280. }
  13281. },
  13282. "Team": {
  13283. "description": "Team",
  13284. "schema": {
  13285. "$ref": "#/definitions/Team"
  13286. }
  13287. },
  13288. "TeamList": {
  13289. "description": "TeamList",
  13290. "schema": {
  13291. "type": "array",
  13292. "items": {
  13293. "$ref": "#/definitions/Team"
  13294. }
  13295. }
  13296. },
  13297. "TopicListResponse": {
  13298. "description": "TopicListResponse",
  13299. "schema": {
  13300. "type": "array",
  13301. "items": {
  13302. "$ref": "#/definitions/TopicResponse"
  13303. }
  13304. }
  13305. },
  13306. "TopicNames": {
  13307. "description": "TopicNames",
  13308. "schema": {
  13309. "$ref": "#/definitions/TopicName"
  13310. }
  13311. },
  13312. "TrackedTime": {
  13313. "description": "TrackedTime",
  13314. "schema": {
  13315. "$ref": "#/definitions/TrackedTime"
  13316. }
  13317. },
  13318. "TrackedTimeList": {
  13319. "description": "TrackedTimeList",
  13320. "schema": {
  13321. "type": "array",
  13322. "items": {
  13323. "$ref": "#/definitions/TrackedTime"
  13324. }
  13325. }
  13326. },
  13327. "User": {
  13328. "description": "User",
  13329. "schema": {
  13330. "$ref": "#/definitions/User"
  13331. }
  13332. },
  13333. "UserHeatmapData": {
  13334. "description": "UserHeatmapData",
  13335. "schema": {
  13336. "type": "array",
  13337. "items": {
  13338. "$ref": "#/definitions/UserHeatmapData"
  13339. }
  13340. }
  13341. },
  13342. "UserList": {
  13343. "description": "UserList",
  13344. "schema": {
  13345. "type": "array",
  13346. "items": {
  13347. "$ref": "#/definitions/User"
  13348. }
  13349. }
  13350. },
  13351. "WatchInfo": {
  13352. "description": "WatchInfo",
  13353. "schema": {
  13354. "$ref": "#/definitions/WatchInfo"
  13355. }
  13356. },
  13357. "empty": {
  13358. "description": "APIEmpty is an empty response"
  13359. },
  13360. "error": {
  13361. "description": "APIError is error format response",
  13362. "headers": {
  13363. "message": {
  13364. "type": "string"
  13365. },
  13366. "url": {
  13367. "type": "string"
  13368. }
  13369. }
  13370. },
  13371. "forbidden": {
  13372. "description": "APIForbiddenError is a forbidden error response",
  13373. "headers": {
  13374. "message": {
  13375. "type": "string"
  13376. },
  13377. "url": {
  13378. "type": "string"
  13379. }
  13380. }
  13381. },
  13382. "invalidTopicsError": {
  13383. "description": "APIInvalidTopicsError is error format response to invalid topics",
  13384. "headers": {
  13385. "invalidTopics": {
  13386. "type": "array",
  13387. "items": {
  13388. "type": "string"
  13389. }
  13390. },
  13391. "message": {
  13392. "type": "string"
  13393. }
  13394. }
  13395. },
  13396. "notFound": {
  13397. "description": "APINotFound is a not found empty response"
  13398. },
  13399. "parameterBodies": {
  13400. "description": "parameterBodies",
  13401. "schema": {
  13402. "$ref": "#/definitions/EditReactionOption"
  13403. }
  13404. },
  13405. "redirect": {
  13406. "description": "APIRedirect is a redirect response"
  13407. },
  13408. "validationError": {
  13409. "description": "APIValidationError is error format response related to input validation",
  13410. "headers": {
  13411. "message": {
  13412. "type": "string"
  13413. },
  13414. "url": {
  13415. "type": "string"
  13416. }
  13417. }
  13418. }
  13419. },
  13420. "securityDefinitions": {
  13421. "AccessToken": {
  13422. "type": "apiKey",
  13423. "name": "access_token",
  13424. "in": "query"
  13425. },
  13426. "AuthorizationHeaderToken": {
  13427. "description": "API tokens must be prepended with \"token\" followed by a space.",
  13428. "type": "apiKey",
  13429. "name": "Authorization",
  13430. "in": "header"
  13431. },
  13432. "BasicAuth": {
  13433. "type": "basic"
  13434. },
  13435. "SudoHeader": {
  13436. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  13437. "type": "apiKey",
  13438. "name": "Sudo",
  13439. "in": "header"
  13440. },
  13441. "SudoParam": {
  13442. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  13443. "type": "apiKey",
  13444. "name": "sudo",
  13445. "in": "query"
  13446. },
  13447. "Token": {
  13448. "type": "apiKey",
  13449. "name": "token",
  13450. "in": "query"
  13451. }
  13452. },
  13453. "security": [
  13454. {
  13455. "BasicAuth": []
  13456. },
  13457. {
  13458. "Token": []
  13459. },
  13460. {
  13461. "AccessToken": []
  13462. },
  13463. {
  13464. "AuthorizationHeaderToken": []
  13465. },
  13466. {
  13467. "SudoParam": []
  13468. },
  13469. {
  13470. "SudoHeader": []
  13471. }
  13472. ]
  13473. }