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.

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574
  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",
  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",
  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": "array",
  464. "items": {
  465. "type": "string"
  466. },
  467. "collectionFormat": "multi",
  468. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned.",
  469. "name": "status-types",
  470. "in": "query"
  471. },
  472. {
  473. "type": "string",
  474. "format": "date-time",
  475. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  476. "name": "since",
  477. "in": "query"
  478. },
  479. {
  480. "type": "string",
  481. "format": "date-time",
  482. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  483. "name": "before",
  484. "in": "query"
  485. },
  486. {
  487. "type": "integer",
  488. "description": "page number of results to return (1-based)",
  489. "name": "page",
  490. "in": "query"
  491. },
  492. {
  493. "type": "integer",
  494. "description": "page size of results",
  495. "name": "limit",
  496. "in": "query"
  497. }
  498. ],
  499. "responses": {
  500. "200": {
  501. "$ref": "#/responses/NotificationThreadList"
  502. }
  503. }
  504. },
  505. "put": {
  506. "consumes": [
  507. "application/json"
  508. ],
  509. "produces": [
  510. "application/json"
  511. ],
  512. "tags": [
  513. "notification"
  514. ],
  515. "summary": "Mark notification threads as read, pinned or unread",
  516. "operationId": "notifyReadList",
  517. "parameters": [
  518. {
  519. "type": "string",
  520. "format": "date-time",
  521. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  522. "name": "last_read_at",
  523. "in": "query"
  524. },
  525. {
  526. "type": "string",
  527. "description": "If true, mark all notifications on this repo. Default value is false",
  528. "name": "all",
  529. "in": "query"
  530. },
  531. {
  532. "type": "array",
  533. "items": {
  534. "type": "string"
  535. },
  536. "collectionFormat": "multi",
  537. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  538. "name": "status-types",
  539. "in": "query"
  540. },
  541. {
  542. "type": "string",
  543. "description": "Status to mark notifications as, Defaults to read.",
  544. "name": "to-status",
  545. "in": "query"
  546. }
  547. ],
  548. "responses": {
  549. "205": {
  550. "$ref": "#/responses/empty"
  551. }
  552. }
  553. }
  554. },
  555. "/notifications/new": {
  556. "get": {
  557. "tags": [
  558. "notification"
  559. ],
  560. "summary": "Check if unread notifications exist",
  561. "operationId": "notifyNewAvailable",
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/NotificationCount"
  565. }
  566. }
  567. }
  568. },
  569. "/notifications/threads/{id}": {
  570. "get": {
  571. "consumes": [
  572. "application/json"
  573. ],
  574. "produces": [
  575. "application/json"
  576. ],
  577. "tags": [
  578. "notification"
  579. ],
  580. "summary": "Get notification thread by ID",
  581. "operationId": "notifyGetThread",
  582. "parameters": [
  583. {
  584. "type": "string",
  585. "description": "id of notification thread",
  586. "name": "id",
  587. "in": "path",
  588. "required": true
  589. }
  590. ],
  591. "responses": {
  592. "200": {
  593. "$ref": "#/responses/NotificationThread"
  594. },
  595. "403": {
  596. "$ref": "#/responses/forbidden"
  597. },
  598. "404": {
  599. "$ref": "#/responses/notFound"
  600. }
  601. }
  602. },
  603. "patch": {
  604. "consumes": [
  605. "application/json"
  606. ],
  607. "produces": [
  608. "application/json"
  609. ],
  610. "tags": [
  611. "notification"
  612. ],
  613. "summary": "Mark notification thread as read by ID",
  614. "operationId": "notifyReadThread",
  615. "parameters": [
  616. {
  617. "type": "string",
  618. "description": "id of notification thread",
  619. "name": "id",
  620. "in": "path",
  621. "required": true
  622. },
  623. {
  624. "type": "string",
  625. "default": "read",
  626. "description": "Status to mark notifications as",
  627. "name": "to-status",
  628. "in": "query"
  629. }
  630. ],
  631. "responses": {
  632. "205": {
  633. "$ref": "#/responses/empty"
  634. },
  635. "403": {
  636. "$ref": "#/responses/forbidden"
  637. },
  638. "404": {
  639. "$ref": "#/responses/notFound"
  640. }
  641. }
  642. }
  643. },
  644. "/org/{org}/repos": {
  645. "post": {
  646. "consumes": [
  647. "application/json"
  648. ],
  649. "produces": [
  650. "application/json"
  651. ],
  652. "tags": [
  653. "organization"
  654. ],
  655. "summary": "Create a repository in an organization",
  656. "operationId": "createOrgRepoDeprecated",
  657. "deprecated": true,
  658. "parameters": [
  659. {
  660. "type": "string",
  661. "description": "name of organization",
  662. "name": "org",
  663. "in": "path",
  664. "required": true
  665. },
  666. {
  667. "name": "body",
  668. "in": "body",
  669. "schema": {
  670. "$ref": "#/definitions/CreateRepoOption"
  671. }
  672. }
  673. ],
  674. "responses": {
  675. "201": {
  676. "$ref": "#/responses/Repository"
  677. },
  678. "403": {
  679. "$ref": "#/responses/forbidden"
  680. },
  681. "422": {
  682. "$ref": "#/responses/validationError"
  683. }
  684. }
  685. }
  686. },
  687. "/orgs": {
  688. "get": {
  689. "produces": [
  690. "application/json"
  691. ],
  692. "tags": [
  693. "organization"
  694. ],
  695. "summary": "Get list of organizations",
  696. "operationId": "orgGetAll",
  697. "parameters": [
  698. {
  699. "type": "integer",
  700. "description": "page number of results to return (1-based)",
  701. "name": "page",
  702. "in": "query"
  703. },
  704. {
  705. "type": "integer",
  706. "description": "page size of results",
  707. "name": "limit",
  708. "in": "query"
  709. }
  710. ],
  711. "responses": {
  712. "200": {
  713. "$ref": "#/responses/OrganizationList"
  714. }
  715. }
  716. },
  717. "post": {
  718. "consumes": [
  719. "application/json"
  720. ],
  721. "produces": [
  722. "application/json"
  723. ],
  724. "tags": [
  725. "organization"
  726. ],
  727. "summary": "Create an organization",
  728. "operationId": "orgCreate",
  729. "parameters": [
  730. {
  731. "name": "organization",
  732. "in": "body",
  733. "required": true,
  734. "schema": {
  735. "$ref": "#/definitions/CreateOrgOption"
  736. }
  737. }
  738. ],
  739. "responses": {
  740. "201": {
  741. "$ref": "#/responses/Organization"
  742. },
  743. "403": {
  744. "$ref": "#/responses/forbidden"
  745. },
  746. "422": {
  747. "$ref": "#/responses/validationError"
  748. }
  749. }
  750. }
  751. },
  752. "/orgs/{org}": {
  753. "get": {
  754. "produces": [
  755. "application/json"
  756. ],
  757. "tags": [
  758. "organization"
  759. ],
  760. "summary": "Get an organization",
  761. "operationId": "orgGet",
  762. "parameters": [
  763. {
  764. "type": "string",
  765. "description": "name of the organization to get",
  766. "name": "org",
  767. "in": "path",
  768. "required": true
  769. }
  770. ],
  771. "responses": {
  772. "200": {
  773. "$ref": "#/responses/Organization"
  774. }
  775. }
  776. },
  777. "delete": {
  778. "produces": [
  779. "application/json"
  780. ],
  781. "tags": [
  782. "organization"
  783. ],
  784. "summary": "Delete an organization",
  785. "operationId": "orgDelete",
  786. "parameters": [
  787. {
  788. "type": "string",
  789. "description": "organization that is to be deleted",
  790. "name": "org",
  791. "in": "path",
  792. "required": true
  793. }
  794. ],
  795. "responses": {
  796. "204": {
  797. "$ref": "#/responses/empty"
  798. }
  799. }
  800. },
  801. "patch": {
  802. "consumes": [
  803. "application/json"
  804. ],
  805. "produces": [
  806. "application/json"
  807. ],
  808. "tags": [
  809. "organization"
  810. ],
  811. "summary": "Edit an organization",
  812. "operationId": "orgEdit",
  813. "parameters": [
  814. {
  815. "type": "string",
  816. "description": "name of the organization to edit",
  817. "name": "org",
  818. "in": "path",
  819. "required": true
  820. },
  821. {
  822. "name": "body",
  823. "in": "body",
  824. "required": true,
  825. "schema": {
  826. "$ref": "#/definitions/EditOrgOption"
  827. }
  828. }
  829. ],
  830. "responses": {
  831. "200": {
  832. "$ref": "#/responses/Organization"
  833. }
  834. }
  835. }
  836. },
  837. "/orgs/{org}/hooks": {
  838. "get": {
  839. "produces": [
  840. "application/json"
  841. ],
  842. "tags": [
  843. "organization"
  844. ],
  845. "summary": "List an organization's webhooks",
  846. "operationId": "orgListHooks",
  847. "parameters": [
  848. {
  849. "type": "string",
  850. "description": "name of the organization",
  851. "name": "org",
  852. "in": "path",
  853. "required": true
  854. },
  855. {
  856. "type": "integer",
  857. "description": "page number of results to return (1-based)",
  858. "name": "page",
  859. "in": "query"
  860. },
  861. {
  862. "type": "integer",
  863. "description": "page size of results",
  864. "name": "limit",
  865. "in": "query"
  866. }
  867. ],
  868. "responses": {
  869. "200": {
  870. "$ref": "#/responses/HookList"
  871. }
  872. }
  873. }
  874. },
  875. "/orgs/{org}/hooks/": {
  876. "post": {
  877. "consumes": [
  878. "application/json"
  879. ],
  880. "produces": [
  881. "application/json"
  882. ],
  883. "tags": [
  884. "organization"
  885. ],
  886. "summary": "Create a hook",
  887. "operationId": "orgCreateHook",
  888. "parameters": [
  889. {
  890. "type": "string",
  891. "description": "name of the organization",
  892. "name": "org",
  893. "in": "path",
  894. "required": true
  895. },
  896. {
  897. "name": "body",
  898. "in": "body",
  899. "required": true,
  900. "schema": {
  901. "$ref": "#/definitions/CreateHookOption"
  902. }
  903. }
  904. ],
  905. "responses": {
  906. "201": {
  907. "$ref": "#/responses/Hook"
  908. }
  909. }
  910. }
  911. },
  912. "/orgs/{org}/hooks/{id}": {
  913. "get": {
  914. "produces": [
  915. "application/json"
  916. ],
  917. "tags": [
  918. "organization"
  919. ],
  920. "summary": "Get a hook",
  921. "operationId": "orgGetHook",
  922. "parameters": [
  923. {
  924. "type": "string",
  925. "description": "name of the organization",
  926. "name": "org",
  927. "in": "path",
  928. "required": true
  929. },
  930. {
  931. "type": "integer",
  932. "format": "int64",
  933. "description": "id of the hook to get",
  934. "name": "id",
  935. "in": "path",
  936. "required": true
  937. }
  938. ],
  939. "responses": {
  940. "200": {
  941. "$ref": "#/responses/Hook"
  942. }
  943. }
  944. },
  945. "delete": {
  946. "produces": [
  947. "application/json"
  948. ],
  949. "tags": [
  950. "organization"
  951. ],
  952. "summary": "Delete a hook",
  953. "operationId": "orgDeleteHook",
  954. "parameters": [
  955. {
  956. "type": "string",
  957. "description": "name of the organization",
  958. "name": "org",
  959. "in": "path",
  960. "required": true
  961. },
  962. {
  963. "type": "integer",
  964. "format": "int64",
  965. "description": "id of the hook to delete",
  966. "name": "id",
  967. "in": "path",
  968. "required": true
  969. }
  970. ],
  971. "responses": {
  972. "204": {
  973. "$ref": "#/responses/empty"
  974. }
  975. }
  976. },
  977. "patch": {
  978. "consumes": [
  979. "application/json"
  980. ],
  981. "produces": [
  982. "application/json"
  983. ],
  984. "tags": [
  985. "organization"
  986. ],
  987. "summary": "Update a hook",
  988. "operationId": "orgEditHook",
  989. "parameters": [
  990. {
  991. "type": "string",
  992. "description": "name of the organization",
  993. "name": "org",
  994. "in": "path",
  995. "required": true
  996. },
  997. {
  998. "type": "integer",
  999. "format": "int64",
  1000. "description": "id of the hook to update",
  1001. "name": "id",
  1002. "in": "path",
  1003. "required": true
  1004. },
  1005. {
  1006. "name": "body",
  1007. "in": "body",
  1008. "schema": {
  1009. "$ref": "#/definitions/EditHookOption"
  1010. }
  1011. }
  1012. ],
  1013. "responses": {
  1014. "200": {
  1015. "$ref": "#/responses/Hook"
  1016. }
  1017. }
  1018. }
  1019. },
  1020. "/orgs/{org}/labels": {
  1021. "get": {
  1022. "produces": [
  1023. "application/json"
  1024. ],
  1025. "tags": [
  1026. "organization"
  1027. ],
  1028. "summary": "List an organization's labels",
  1029. "operationId": "orgListLabels",
  1030. "parameters": [
  1031. {
  1032. "type": "string",
  1033. "description": "name of the organization",
  1034. "name": "org",
  1035. "in": "path",
  1036. "required": true
  1037. },
  1038. {
  1039. "type": "integer",
  1040. "description": "page number of results to return (1-based)",
  1041. "name": "page",
  1042. "in": "query"
  1043. },
  1044. {
  1045. "type": "integer",
  1046. "description": "page size of results",
  1047. "name": "limit",
  1048. "in": "query"
  1049. }
  1050. ],
  1051. "responses": {
  1052. "200": {
  1053. "$ref": "#/responses/LabelList"
  1054. }
  1055. }
  1056. },
  1057. "post": {
  1058. "consumes": [
  1059. "application/json"
  1060. ],
  1061. "produces": [
  1062. "application/json"
  1063. ],
  1064. "tags": [
  1065. "organization"
  1066. ],
  1067. "summary": "Create a label for an organization",
  1068. "operationId": "orgCreateLabel",
  1069. "parameters": [
  1070. {
  1071. "type": "string",
  1072. "description": "name of the organization",
  1073. "name": "org",
  1074. "in": "path",
  1075. "required": true
  1076. },
  1077. {
  1078. "name": "body",
  1079. "in": "body",
  1080. "schema": {
  1081. "$ref": "#/definitions/CreateLabelOption"
  1082. }
  1083. }
  1084. ],
  1085. "responses": {
  1086. "201": {
  1087. "$ref": "#/responses/Label"
  1088. },
  1089. "422": {
  1090. "$ref": "#/responses/validationError"
  1091. }
  1092. }
  1093. }
  1094. },
  1095. "/orgs/{org}/labels/{id}": {
  1096. "get": {
  1097. "produces": [
  1098. "application/json"
  1099. ],
  1100. "tags": [
  1101. "organization"
  1102. ],
  1103. "summary": "Get a single label",
  1104. "operationId": "orgGetLabel",
  1105. "parameters": [
  1106. {
  1107. "type": "string",
  1108. "description": "name of the organization",
  1109. "name": "org",
  1110. "in": "path",
  1111. "required": true
  1112. },
  1113. {
  1114. "type": "integer",
  1115. "format": "int64",
  1116. "description": "id of the label to get",
  1117. "name": "id",
  1118. "in": "path",
  1119. "required": true
  1120. }
  1121. ],
  1122. "responses": {
  1123. "200": {
  1124. "$ref": "#/responses/Label"
  1125. }
  1126. }
  1127. },
  1128. "delete": {
  1129. "tags": [
  1130. "organization"
  1131. ],
  1132. "summary": "Delete a label",
  1133. "operationId": "orgDeleteLabel",
  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": "integer",
  1144. "format": "int64",
  1145. "description": "id of the label to delete",
  1146. "name": "id",
  1147. "in": "path",
  1148. "required": true
  1149. }
  1150. ],
  1151. "responses": {
  1152. "204": {
  1153. "$ref": "#/responses/empty"
  1154. }
  1155. }
  1156. },
  1157. "patch": {
  1158. "consumes": [
  1159. "application/json"
  1160. ],
  1161. "produces": [
  1162. "application/json"
  1163. ],
  1164. "tags": [
  1165. "organization"
  1166. ],
  1167. "summary": "Update a label",
  1168. "operationId": "orgEditLabel",
  1169. "parameters": [
  1170. {
  1171. "type": "string",
  1172. "description": "name of the organization",
  1173. "name": "org",
  1174. "in": "path",
  1175. "required": true
  1176. },
  1177. {
  1178. "type": "integer",
  1179. "format": "int64",
  1180. "description": "id of the label to edit",
  1181. "name": "id",
  1182. "in": "path",
  1183. "required": true
  1184. },
  1185. {
  1186. "name": "body",
  1187. "in": "body",
  1188. "schema": {
  1189. "$ref": "#/definitions/EditLabelOption"
  1190. }
  1191. }
  1192. ],
  1193. "responses": {
  1194. "200": {
  1195. "$ref": "#/responses/Label"
  1196. },
  1197. "422": {
  1198. "$ref": "#/responses/validationError"
  1199. }
  1200. }
  1201. }
  1202. },
  1203. "/orgs/{org}/members": {
  1204. "get": {
  1205. "produces": [
  1206. "application/json"
  1207. ],
  1208. "tags": [
  1209. "organization"
  1210. ],
  1211. "summary": "List an organization's members",
  1212. "operationId": "orgListMembers",
  1213. "parameters": [
  1214. {
  1215. "type": "string",
  1216. "description": "name of the organization",
  1217. "name": "org",
  1218. "in": "path",
  1219. "required": true
  1220. },
  1221. {
  1222. "type": "integer",
  1223. "description": "page number of results to return (1-based)",
  1224. "name": "page",
  1225. "in": "query"
  1226. },
  1227. {
  1228. "type": "integer",
  1229. "description": "page size of results",
  1230. "name": "limit",
  1231. "in": "query"
  1232. }
  1233. ],
  1234. "responses": {
  1235. "200": {
  1236. "$ref": "#/responses/UserList"
  1237. }
  1238. }
  1239. }
  1240. },
  1241. "/orgs/{org}/members/{username}": {
  1242. "get": {
  1243. "tags": [
  1244. "organization"
  1245. ],
  1246. "summary": "Check if a user is a member of an organization",
  1247. "operationId": "orgIsMember",
  1248. "parameters": [
  1249. {
  1250. "type": "string",
  1251. "description": "name of the organization",
  1252. "name": "org",
  1253. "in": "path",
  1254. "required": true
  1255. },
  1256. {
  1257. "type": "string",
  1258. "description": "username of the user",
  1259. "name": "username",
  1260. "in": "path",
  1261. "required": true
  1262. }
  1263. ],
  1264. "responses": {
  1265. "204": {
  1266. "description": "user is a member"
  1267. },
  1268. "302": {
  1269. "description": "redirection to /orgs/{org}/public_members/{username}"
  1270. },
  1271. "404": {
  1272. "description": "user is not a member"
  1273. }
  1274. }
  1275. },
  1276. "delete": {
  1277. "produces": [
  1278. "application/json"
  1279. ],
  1280. "tags": [
  1281. "organization"
  1282. ],
  1283. "summary": "Remove a member from an organization",
  1284. "operationId": "orgDeleteMember",
  1285. "parameters": [
  1286. {
  1287. "type": "string",
  1288. "description": "name of the organization",
  1289. "name": "org",
  1290. "in": "path",
  1291. "required": true
  1292. },
  1293. {
  1294. "type": "string",
  1295. "description": "username of the user",
  1296. "name": "username",
  1297. "in": "path",
  1298. "required": true
  1299. }
  1300. ],
  1301. "responses": {
  1302. "204": {
  1303. "description": "member removed"
  1304. }
  1305. }
  1306. }
  1307. },
  1308. "/orgs/{org}/public_members": {
  1309. "get": {
  1310. "produces": [
  1311. "application/json"
  1312. ],
  1313. "tags": [
  1314. "organization"
  1315. ],
  1316. "summary": "List an organization's public members",
  1317. "operationId": "orgListPublicMembers",
  1318. "parameters": [
  1319. {
  1320. "type": "string",
  1321. "description": "name of the organization",
  1322. "name": "org",
  1323. "in": "path",
  1324. "required": true
  1325. },
  1326. {
  1327. "type": "integer",
  1328. "description": "page number of results to return (1-based)",
  1329. "name": "page",
  1330. "in": "query"
  1331. },
  1332. {
  1333. "type": "integer",
  1334. "description": "page size of results",
  1335. "name": "limit",
  1336. "in": "query"
  1337. }
  1338. ],
  1339. "responses": {
  1340. "200": {
  1341. "$ref": "#/responses/UserList"
  1342. }
  1343. }
  1344. }
  1345. },
  1346. "/orgs/{org}/public_members/{username}": {
  1347. "get": {
  1348. "tags": [
  1349. "organization"
  1350. ],
  1351. "summary": "Check if a user is a public member of an organization",
  1352. "operationId": "orgIsPublicMember",
  1353. "parameters": [
  1354. {
  1355. "type": "string",
  1356. "description": "name of the organization",
  1357. "name": "org",
  1358. "in": "path",
  1359. "required": true
  1360. },
  1361. {
  1362. "type": "string",
  1363. "description": "username of the user",
  1364. "name": "username",
  1365. "in": "path",
  1366. "required": true
  1367. }
  1368. ],
  1369. "responses": {
  1370. "204": {
  1371. "description": "user is a public member"
  1372. },
  1373. "404": {
  1374. "description": "user is not a public member"
  1375. }
  1376. }
  1377. },
  1378. "put": {
  1379. "produces": [
  1380. "application/json"
  1381. ],
  1382. "tags": [
  1383. "organization"
  1384. ],
  1385. "summary": "Publicize a user's membership",
  1386. "operationId": "orgPublicizeMember",
  1387. "parameters": [
  1388. {
  1389. "type": "string",
  1390. "description": "name of the organization",
  1391. "name": "org",
  1392. "in": "path",
  1393. "required": true
  1394. },
  1395. {
  1396. "type": "string",
  1397. "description": "username of the user",
  1398. "name": "username",
  1399. "in": "path",
  1400. "required": true
  1401. }
  1402. ],
  1403. "responses": {
  1404. "204": {
  1405. "description": "membership publicized"
  1406. },
  1407. "403": {
  1408. "$ref": "#/responses/forbidden"
  1409. }
  1410. }
  1411. },
  1412. "delete": {
  1413. "produces": [
  1414. "application/json"
  1415. ],
  1416. "tags": [
  1417. "organization"
  1418. ],
  1419. "summary": "Conceal a user's membership",
  1420. "operationId": "orgConcealMember",
  1421. "parameters": [
  1422. {
  1423. "type": "string",
  1424. "description": "name of the organization",
  1425. "name": "org",
  1426. "in": "path",
  1427. "required": true
  1428. },
  1429. {
  1430. "type": "string",
  1431. "description": "username of the user",
  1432. "name": "username",
  1433. "in": "path",
  1434. "required": true
  1435. }
  1436. ],
  1437. "responses": {
  1438. "204": {
  1439. "$ref": "#/responses/empty"
  1440. },
  1441. "403": {
  1442. "$ref": "#/responses/forbidden"
  1443. }
  1444. }
  1445. }
  1446. },
  1447. "/orgs/{org}/repos": {
  1448. "get": {
  1449. "produces": [
  1450. "application/json"
  1451. ],
  1452. "tags": [
  1453. "organization"
  1454. ],
  1455. "summary": "List an organization's repos",
  1456. "operationId": "orgListRepos",
  1457. "parameters": [
  1458. {
  1459. "type": "string",
  1460. "description": "name of the organization",
  1461. "name": "org",
  1462. "in": "path",
  1463. "required": true
  1464. },
  1465. {
  1466. "type": "integer",
  1467. "description": "page number of results to return (1-based)",
  1468. "name": "page",
  1469. "in": "query"
  1470. },
  1471. {
  1472. "type": "integer",
  1473. "description": "page size of results",
  1474. "name": "limit",
  1475. "in": "query"
  1476. }
  1477. ],
  1478. "responses": {
  1479. "200": {
  1480. "$ref": "#/responses/RepositoryList"
  1481. }
  1482. }
  1483. },
  1484. "post": {
  1485. "consumes": [
  1486. "application/json"
  1487. ],
  1488. "produces": [
  1489. "application/json"
  1490. ],
  1491. "tags": [
  1492. "organization"
  1493. ],
  1494. "summary": "Create a repository in an organization",
  1495. "operationId": "createOrgRepo",
  1496. "parameters": [
  1497. {
  1498. "type": "string",
  1499. "description": "name of organization",
  1500. "name": "org",
  1501. "in": "path",
  1502. "required": true
  1503. },
  1504. {
  1505. "name": "body",
  1506. "in": "body",
  1507. "schema": {
  1508. "$ref": "#/definitions/CreateRepoOption"
  1509. }
  1510. }
  1511. ],
  1512. "responses": {
  1513. "201": {
  1514. "$ref": "#/responses/Repository"
  1515. },
  1516. "403": {
  1517. "$ref": "#/responses/forbidden"
  1518. },
  1519. "404": {
  1520. "$ref": "#/responses/notFound"
  1521. }
  1522. }
  1523. }
  1524. },
  1525. "/orgs/{org}/teams": {
  1526. "get": {
  1527. "produces": [
  1528. "application/json"
  1529. ],
  1530. "tags": [
  1531. "organization"
  1532. ],
  1533. "summary": "List an organization's teams",
  1534. "operationId": "orgListTeams",
  1535. "parameters": [
  1536. {
  1537. "type": "string",
  1538. "description": "name of the organization",
  1539. "name": "org",
  1540. "in": "path",
  1541. "required": true
  1542. },
  1543. {
  1544. "type": "integer",
  1545. "description": "page number of results to return (1-based)",
  1546. "name": "page",
  1547. "in": "query"
  1548. },
  1549. {
  1550. "type": "integer",
  1551. "description": "page size of results",
  1552. "name": "limit",
  1553. "in": "query"
  1554. }
  1555. ],
  1556. "responses": {
  1557. "200": {
  1558. "$ref": "#/responses/TeamList"
  1559. }
  1560. }
  1561. },
  1562. "post": {
  1563. "consumes": [
  1564. "application/json"
  1565. ],
  1566. "produces": [
  1567. "application/json"
  1568. ],
  1569. "tags": [
  1570. "organization"
  1571. ],
  1572. "summary": "Create a team",
  1573. "operationId": "orgCreateTeam",
  1574. "parameters": [
  1575. {
  1576. "type": "string",
  1577. "description": "name of the organization",
  1578. "name": "org",
  1579. "in": "path",
  1580. "required": true
  1581. },
  1582. {
  1583. "name": "body",
  1584. "in": "body",
  1585. "schema": {
  1586. "$ref": "#/definitions/CreateTeamOption"
  1587. }
  1588. }
  1589. ],
  1590. "responses": {
  1591. "201": {
  1592. "$ref": "#/responses/Team"
  1593. },
  1594. "422": {
  1595. "$ref": "#/responses/validationError"
  1596. }
  1597. }
  1598. }
  1599. },
  1600. "/orgs/{org}/teams/search": {
  1601. "get": {
  1602. "produces": [
  1603. "application/json"
  1604. ],
  1605. "tags": [
  1606. "organization"
  1607. ],
  1608. "summary": "Search for teams within an organization",
  1609. "operationId": "teamSearch",
  1610. "parameters": [
  1611. {
  1612. "type": "string",
  1613. "description": "name of the organization",
  1614. "name": "org",
  1615. "in": "path",
  1616. "required": true
  1617. },
  1618. {
  1619. "type": "string",
  1620. "description": "keywords to search",
  1621. "name": "q",
  1622. "in": "query"
  1623. },
  1624. {
  1625. "type": "boolean",
  1626. "description": "include search within team description (defaults to true)",
  1627. "name": "include_desc",
  1628. "in": "query"
  1629. },
  1630. {
  1631. "type": "integer",
  1632. "description": "page number of results to return (1-based)",
  1633. "name": "page",
  1634. "in": "query"
  1635. },
  1636. {
  1637. "type": "integer",
  1638. "description": "page size of results",
  1639. "name": "limit",
  1640. "in": "query"
  1641. }
  1642. ],
  1643. "responses": {
  1644. "200": {
  1645. "description": "SearchResults of a successful search",
  1646. "schema": {
  1647. "type": "object",
  1648. "properties": {
  1649. "data": {
  1650. "type": "array",
  1651. "items": {
  1652. "$ref": "#/definitions/Team"
  1653. }
  1654. },
  1655. "ok": {
  1656. "type": "boolean"
  1657. }
  1658. }
  1659. }
  1660. }
  1661. }
  1662. }
  1663. },
  1664. "/repos/issues/search": {
  1665. "get": {
  1666. "produces": [
  1667. "application/json"
  1668. ],
  1669. "tags": [
  1670. "issue"
  1671. ],
  1672. "summary": "Search for issues across the repositories that the user has access to",
  1673. "operationId": "issueSearchIssues",
  1674. "parameters": [
  1675. {
  1676. "type": "string",
  1677. "description": "whether issue is open or closed",
  1678. "name": "state",
  1679. "in": "query"
  1680. },
  1681. {
  1682. "type": "string",
  1683. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1684. "name": "labels",
  1685. "in": "query"
  1686. },
  1687. {
  1688. "type": "string",
  1689. "description": "search string",
  1690. "name": "q",
  1691. "in": "query"
  1692. },
  1693. {
  1694. "type": "integer",
  1695. "format": "int64",
  1696. "description": "repository to prioritize in the results",
  1697. "name": "priority_repo_id",
  1698. "in": "query"
  1699. },
  1700. {
  1701. "type": "string",
  1702. "description": "filter by type (issues / pulls) if set",
  1703. "name": "type",
  1704. "in": "query"
  1705. },
  1706. {
  1707. "type": "integer",
  1708. "description": "page number of requested issues",
  1709. "name": "page",
  1710. "in": "query"
  1711. }
  1712. ],
  1713. "responses": {
  1714. "200": {
  1715. "$ref": "#/responses/IssueList"
  1716. }
  1717. }
  1718. }
  1719. },
  1720. "/repos/migrate": {
  1721. "post": {
  1722. "consumes": [
  1723. "application/json"
  1724. ],
  1725. "produces": [
  1726. "application/json"
  1727. ],
  1728. "tags": [
  1729. "repository"
  1730. ],
  1731. "summary": "Migrate a remote git repository",
  1732. "operationId": "repoMigrate",
  1733. "parameters": [
  1734. {
  1735. "name": "body",
  1736. "in": "body",
  1737. "schema": {
  1738. "$ref": "#/definitions/MigrateRepoForm"
  1739. }
  1740. }
  1741. ],
  1742. "responses": {
  1743. "201": {
  1744. "$ref": "#/responses/Repository"
  1745. },
  1746. "403": {
  1747. "$ref": "#/responses/forbidden"
  1748. },
  1749. "422": {
  1750. "$ref": "#/responses/validationError"
  1751. }
  1752. }
  1753. }
  1754. },
  1755. "/repos/search": {
  1756. "get": {
  1757. "produces": [
  1758. "application/json"
  1759. ],
  1760. "tags": [
  1761. "repository"
  1762. ],
  1763. "summary": "Search for repositories",
  1764. "operationId": "repoSearch",
  1765. "parameters": [
  1766. {
  1767. "type": "string",
  1768. "description": "keyword",
  1769. "name": "q",
  1770. "in": "query"
  1771. },
  1772. {
  1773. "type": "boolean",
  1774. "description": "Limit search to repositories with keyword as topic",
  1775. "name": "topic",
  1776. "in": "query"
  1777. },
  1778. {
  1779. "type": "boolean",
  1780. "description": "include search of keyword within repository description",
  1781. "name": "includeDesc",
  1782. "in": "query"
  1783. },
  1784. {
  1785. "type": "integer",
  1786. "format": "int64",
  1787. "description": "search only for repos that the user with the given id owns or contributes to",
  1788. "name": "uid",
  1789. "in": "query"
  1790. },
  1791. {
  1792. "type": "integer",
  1793. "format": "int64",
  1794. "description": "repo owner to prioritize in the results",
  1795. "name": "priority_owner_id",
  1796. "in": "query"
  1797. },
  1798. {
  1799. "type": "integer",
  1800. "format": "int64",
  1801. "description": "search only for repos that the user with the given id has starred",
  1802. "name": "starredBy",
  1803. "in": "query"
  1804. },
  1805. {
  1806. "type": "boolean",
  1807. "description": "include private repositories this user has access to (defaults to true)",
  1808. "name": "private",
  1809. "in": "query"
  1810. },
  1811. {
  1812. "type": "boolean",
  1813. "description": "show only pubic, private or all repositories (defaults to all)",
  1814. "name": "is_private",
  1815. "in": "query"
  1816. },
  1817. {
  1818. "type": "boolean",
  1819. "description": "include template repositories this user has access to (defaults to true)",
  1820. "name": "template",
  1821. "in": "query"
  1822. },
  1823. {
  1824. "type": "boolean",
  1825. "description": "show only archived, non-archived or all repositories (defaults to all)",
  1826. "name": "archived",
  1827. "in": "query"
  1828. },
  1829. {
  1830. "type": "string",
  1831. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1832. "name": "mode",
  1833. "in": "query"
  1834. },
  1835. {
  1836. "type": "boolean",
  1837. "description": "if `uid` is given, search only for repos that the user owns",
  1838. "name": "exclusive",
  1839. "in": "query"
  1840. },
  1841. {
  1842. "type": "string",
  1843. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1844. "name": "sort",
  1845. "in": "query"
  1846. },
  1847. {
  1848. "type": "string",
  1849. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1850. "name": "order",
  1851. "in": "query"
  1852. },
  1853. {
  1854. "type": "integer",
  1855. "description": "page number of results to return (1-based)",
  1856. "name": "page",
  1857. "in": "query"
  1858. },
  1859. {
  1860. "type": "integer",
  1861. "description": "page size of results",
  1862. "name": "limit",
  1863. "in": "query"
  1864. }
  1865. ],
  1866. "responses": {
  1867. "200": {
  1868. "$ref": "#/responses/SearchResults"
  1869. },
  1870. "422": {
  1871. "$ref": "#/responses/validationError"
  1872. }
  1873. }
  1874. }
  1875. },
  1876. "/repos/{owner}/{repo}": {
  1877. "get": {
  1878. "produces": [
  1879. "application/json"
  1880. ],
  1881. "tags": [
  1882. "repository"
  1883. ],
  1884. "summary": "Get a repository",
  1885. "operationId": "repoGet",
  1886. "parameters": [
  1887. {
  1888. "type": "string",
  1889. "description": "owner of the repo",
  1890. "name": "owner",
  1891. "in": "path",
  1892. "required": true
  1893. },
  1894. {
  1895. "type": "string",
  1896. "description": "name of the repo",
  1897. "name": "repo",
  1898. "in": "path",
  1899. "required": true
  1900. }
  1901. ],
  1902. "responses": {
  1903. "200": {
  1904. "$ref": "#/responses/Repository"
  1905. }
  1906. }
  1907. },
  1908. "delete": {
  1909. "produces": [
  1910. "application/json"
  1911. ],
  1912. "tags": [
  1913. "repository"
  1914. ],
  1915. "summary": "Delete a repository",
  1916. "operationId": "repoDelete",
  1917. "parameters": [
  1918. {
  1919. "type": "string",
  1920. "description": "owner of the repo to delete",
  1921. "name": "owner",
  1922. "in": "path",
  1923. "required": true
  1924. },
  1925. {
  1926. "type": "string",
  1927. "description": "name of the repo to delete",
  1928. "name": "repo",
  1929. "in": "path",
  1930. "required": true
  1931. }
  1932. ],
  1933. "responses": {
  1934. "204": {
  1935. "$ref": "#/responses/empty"
  1936. },
  1937. "403": {
  1938. "$ref": "#/responses/forbidden"
  1939. }
  1940. }
  1941. },
  1942. "patch": {
  1943. "produces": [
  1944. "application/json"
  1945. ],
  1946. "tags": [
  1947. "repository"
  1948. ],
  1949. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1950. "operationId": "repoEdit",
  1951. "parameters": [
  1952. {
  1953. "type": "string",
  1954. "description": "owner of the repo to edit",
  1955. "name": "owner",
  1956. "in": "path",
  1957. "required": true
  1958. },
  1959. {
  1960. "type": "string",
  1961. "description": "name of the repo to edit",
  1962. "name": "repo",
  1963. "in": "path",
  1964. "required": true
  1965. },
  1966. {
  1967. "description": "Properties of a repo that you can edit",
  1968. "name": "body",
  1969. "in": "body",
  1970. "schema": {
  1971. "$ref": "#/definitions/EditRepoOption"
  1972. }
  1973. }
  1974. ],
  1975. "responses": {
  1976. "200": {
  1977. "$ref": "#/responses/Repository"
  1978. },
  1979. "403": {
  1980. "$ref": "#/responses/forbidden"
  1981. },
  1982. "422": {
  1983. "$ref": "#/responses/validationError"
  1984. }
  1985. }
  1986. }
  1987. },
  1988. "/repos/{owner}/{repo}/archive/{archive}": {
  1989. "get": {
  1990. "produces": [
  1991. "application/json"
  1992. ],
  1993. "tags": [
  1994. "repository"
  1995. ],
  1996. "summary": "Get an archive of a repository",
  1997. "operationId": "repoGetArchive",
  1998. "parameters": [
  1999. {
  2000. "type": "string",
  2001. "description": "owner of the repo",
  2002. "name": "owner",
  2003. "in": "path",
  2004. "required": true
  2005. },
  2006. {
  2007. "type": "string",
  2008. "description": "name of the repo",
  2009. "name": "repo",
  2010. "in": "path",
  2011. "required": true
  2012. },
  2013. {
  2014. "type": "string",
  2015. "description": "archive to download, consisting of a git reference and archive",
  2016. "name": "archive",
  2017. "in": "path",
  2018. "required": true
  2019. }
  2020. ],
  2021. "responses": {
  2022. "200": {
  2023. "description": "success"
  2024. },
  2025. "404": {
  2026. "$ref": "#/responses/notFound"
  2027. }
  2028. }
  2029. }
  2030. },
  2031. "/repos/{owner}/{repo}/branch_protections": {
  2032. "get": {
  2033. "produces": [
  2034. "application/json"
  2035. ],
  2036. "tags": [
  2037. "repository"
  2038. ],
  2039. "summary": "List branch protections for a repository",
  2040. "operationId": "repoListBranchProtection",
  2041. "parameters": [
  2042. {
  2043. "type": "string",
  2044. "description": "owner of the repo",
  2045. "name": "owner",
  2046. "in": "path",
  2047. "required": true
  2048. },
  2049. {
  2050. "type": "string",
  2051. "description": "name of the repo",
  2052. "name": "repo",
  2053. "in": "path",
  2054. "required": true
  2055. }
  2056. ],
  2057. "responses": {
  2058. "200": {
  2059. "$ref": "#/responses/BranchProtectionList"
  2060. }
  2061. }
  2062. },
  2063. "post": {
  2064. "consumes": [
  2065. "application/json"
  2066. ],
  2067. "produces": [
  2068. "application/json"
  2069. ],
  2070. "tags": [
  2071. "repository"
  2072. ],
  2073. "summary": "Create a branch protections for a repository",
  2074. "operationId": "repoCreateBranchProtection",
  2075. "parameters": [
  2076. {
  2077. "type": "string",
  2078. "description": "owner of the repo",
  2079. "name": "owner",
  2080. "in": "path",
  2081. "required": true
  2082. },
  2083. {
  2084. "type": "string",
  2085. "description": "name of the repo",
  2086. "name": "repo",
  2087. "in": "path",
  2088. "required": true
  2089. },
  2090. {
  2091. "name": "body",
  2092. "in": "body",
  2093. "schema": {
  2094. "$ref": "#/definitions/CreateBranchProtectionOption"
  2095. }
  2096. }
  2097. ],
  2098. "responses": {
  2099. "201": {
  2100. "$ref": "#/responses/BranchProtection"
  2101. },
  2102. "403": {
  2103. "$ref": "#/responses/forbidden"
  2104. },
  2105. "404": {
  2106. "$ref": "#/responses/notFound"
  2107. },
  2108. "422": {
  2109. "$ref": "#/responses/validationError"
  2110. }
  2111. }
  2112. }
  2113. },
  2114. "/repos/{owner}/{repo}/branch_protections/{name}": {
  2115. "get": {
  2116. "produces": [
  2117. "application/json"
  2118. ],
  2119. "tags": [
  2120. "repository"
  2121. ],
  2122. "summary": "Get a specific branch protection for the repository",
  2123. "operationId": "repoGetBranchProtection",
  2124. "parameters": [
  2125. {
  2126. "type": "string",
  2127. "description": "owner of the repo",
  2128. "name": "owner",
  2129. "in": "path",
  2130. "required": true
  2131. },
  2132. {
  2133. "type": "string",
  2134. "description": "name of the repo",
  2135. "name": "repo",
  2136. "in": "path",
  2137. "required": true
  2138. },
  2139. {
  2140. "type": "string",
  2141. "description": "name of protected branch",
  2142. "name": "name",
  2143. "in": "path",
  2144. "required": true
  2145. }
  2146. ],
  2147. "responses": {
  2148. "200": {
  2149. "$ref": "#/responses/BranchProtection"
  2150. },
  2151. "404": {
  2152. "$ref": "#/responses/notFound"
  2153. }
  2154. }
  2155. },
  2156. "delete": {
  2157. "produces": [
  2158. "application/json"
  2159. ],
  2160. "tags": [
  2161. "repository"
  2162. ],
  2163. "summary": "Delete a specific branch protection for the repository",
  2164. "operationId": "repoDeleteBranchProtection",
  2165. "parameters": [
  2166. {
  2167. "type": "string",
  2168. "description": "owner of the repo",
  2169. "name": "owner",
  2170. "in": "path",
  2171. "required": true
  2172. },
  2173. {
  2174. "type": "string",
  2175. "description": "name of the repo",
  2176. "name": "repo",
  2177. "in": "path",
  2178. "required": true
  2179. },
  2180. {
  2181. "type": "string",
  2182. "description": "name of protected branch",
  2183. "name": "name",
  2184. "in": "path",
  2185. "required": true
  2186. }
  2187. ],
  2188. "responses": {
  2189. "204": {
  2190. "$ref": "#/responses/empty"
  2191. },
  2192. "404": {
  2193. "$ref": "#/responses/notFound"
  2194. }
  2195. }
  2196. },
  2197. "patch": {
  2198. "consumes": [
  2199. "application/json"
  2200. ],
  2201. "produces": [
  2202. "application/json"
  2203. ],
  2204. "tags": [
  2205. "repository"
  2206. ],
  2207. "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
  2208. "operationId": "repoEditBranchProtection",
  2209. "parameters": [
  2210. {
  2211. "type": "string",
  2212. "description": "owner of the repo",
  2213. "name": "owner",
  2214. "in": "path",
  2215. "required": true
  2216. },
  2217. {
  2218. "type": "string",
  2219. "description": "name of the repo",
  2220. "name": "repo",
  2221. "in": "path",
  2222. "required": true
  2223. },
  2224. {
  2225. "type": "string",
  2226. "description": "name of protected branch",
  2227. "name": "name",
  2228. "in": "path",
  2229. "required": true
  2230. },
  2231. {
  2232. "name": "body",
  2233. "in": "body",
  2234. "schema": {
  2235. "$ref": "#/definitions/EditBranchProtectionOption"
  2236. }
  2237. }
  2238. ],
  2239. "responses": {
  2240. "200": {
  2241. "$ref": "#/responses/BranchProtection"
  2242. },
  2243. "404": {
  2244. "$ref": "#/responses/notFound"
  2245. },
  2246. "422": {
  2247. "$ref": "#/responses/validationError"
  2248. }
  2249. }
  2250. }
  2251. },
  2252. "/repos/{owner}/{repo}/branches": {
  2253. "get": {
  2254. "produces": [
  2255. "application/json"
  2256. ],
  2257. "tags": [
  2258. "repository"
  2259. ],
  2260. "summary": "List a repository's branches",
  2261. "operationId": "repoListBranches",
  2262. "parameters": [
  2263. {
  2264. "type": "string",
  2265. "description": "owner of the repo",
  2266. "name": "owner",
  2267. "in": "path",
  2268. "required": true
  2269. },
  2270. {
  2271. "type": "string",
  2272. "description": "name of the repo",
  2273. "name": "repo",
  2274. "in": "path",
  2275. "required": true
  2276. }
  2277. ],
  2278. "responses": {
  2279. "200": {
  2280. "$ref": "#/responses/BranchList"
  2281. }
  2282. }
  2283. },
  2284. "post": {
  2285. "consumes": [
  2286. "application/json"
  2287. ],
  2288. "produces": [
  2289. "application/json"
  2290. ],
  2291. "tags": [
  2292. "repository"
  2293. ],
  2294. "summary": "Create a branch",
  2295. "operationId": "repoCreateBranch",
  2296. "parameters": [
  2297. {
  2298. "type": "string",
  2299. "description": "owner of the repo",
  2300. "name": "owner",
  2301. "in": "path",
  2302. "required": true
  2303. },
  2304. {
  2305. "type": "string",
  2306. "description": "name of the repo",
  2307. "name": "repo",
  2308. "in": "path",
  2309. "required": true
  2310. },
  2311. {
  2312. "name": "body",
  2313. "in": "body",
  2314. "schema": {
  2315. "$ref": "#/definitions/CreateBranchRepoOption"
  2316. }
  2317. }
  2318. ],
  2319. "responses": {
  2320. "201": {
  2321. "$ref": "#/responses/Branch"
  2322. },
  2323. "404": {
  2324. "description": "The old branch does not exist."
  2325. },
  2326. "409": {
  2327. "description": "The branch with the same name already exists."
  2328. }
  2329. }
  2330. }
  2331. },
  2332. "/repos/{owner}/{repo}/branches/{branch}": {
  2333. "get": {
  2334. "produces": [
  2335. "application/json"
  2336. ],
  2337. "tags": [
  2338. "repository"
  2339. ],
  2340. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  2341. "operationId": "repoGetBranch",
  2342. "parameters": [
  2343. {
  2344. "type": "string",
  2345. "description": "owner of the repo",
  2346. "name": "owner",
  2347. "in": "path",
  2348. "required": true
  2349. },
  2350. {
  2351. "type": "string",
  2352. "description": "name of the repo",
  2353. "name": "repo",
  2354. "in": "path",
  2355. "required": true
  2356. },
  2357. {
  2358. "type": "string",
  2359. "description": "branch to get",
  2360. "name": "branch",
  2361. "in": "path",
  2362. "required": true
  2363. }
  2364. ],
  2365. "responses": {
  2366. "200": {
  2367. "$ref": "#/responses/Branch"
  2368. }
  2369. }
  2370. },
  2371. "delete": {
  2372. "produces": [
  2373. "application/json"
  2374. ],
  2375. "tags": [
  2376. "repository"
  2377. ],
  2378. "summary": "Delete a specific branch from a repository",
  2379. "operationId": "repoDeleteBranch",
  2380. "parameters": [
  2381. {
  2382. "type": "string",
  2383. "description": "owner of the repo",
  2384. "name": "owner",
  2385. "in": "path",
  2386. "required": true
  2387. },
  2388. {
  2389. "type": "string",
  2390. "description": "name of the repo",
  2391. "name": "repo",
  2392. "in": "path",
  2393. "required": true
  2394. },
  2395. {
  2396. "type": "string",
  2397. "description": "branch to delete",
  2398. "name": "branch",
  2399. "in": "path",
  2400. "required": true
  2401. }
  2402. ],
  2403. "responses": {
  2404. "204": {
  2405. "$ref": "#/responses/empty"
  2406. },
  2407. "403": {
  2408. "$ref": "#/responses/error"
  2409. }
  2410. }
  2411. }
  2412. },
  2413. "/repos/{owner}/{repo}/collaborators": {
  2414. "get": {
  2415. "produces": [
  2416. "application/json"
  2417. ],
  2418. "tags": [
  2419. "repository"
  2420. ],
  2421. "summary": "List a repository's collaborators",
  2422. "operationId": "repoListCollaborators",
  2423. "parameters": [
  2424. {
  2425. "type": "string",
  2426. "description": "owner of the repo",
  2427. "name": "owner",
  2428. "in": "path",
  2429. "required": true
  2430. },
  2431. {
  2432. "type": "string",
  2433. "description": "name of the repo",
  2434. "name": "repo",
  2435. "in": "path",
  2436. "required": true
  2437. },
  2438. {
  2439. "type": "integer",
  2440. "description": "page number of results to return (1-based)",
  2441. "name": "page",
  2442. "in": "query"
  2443. },
  2444. {
  2445. "type": "integer",
  2446. "description": "page size of results",
  2447. "name": "limit",
  2448. "in": "query"
  2449. }
  2450. ],
  2451. "responses": {
  2452. "200": {
  2453. "$ref": "#/responses/UserList"
  2454. }
  2455. }
  2456. }
  2457. },
  2458. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  2459. "get": {
  2460. "produces": [
  2461. "application/json"
  2462. ],
  2463. "tags": [
  2464. "repository"
  2465. ],
  2466. "summary": "Check if a user is a collaborator of a repository",
  2467. "operationId": "repoCheckCollaborator",
  2468. "parameters": [
  2469. {
  2470. "type": "string",
  2471. "description": "owner of the repo",
  2472. "name": "owner",
  2473. "in": "path",
  2474. "required": true
  2475. },
  2476. {
  2477. "type": "string",
  2478. "description": "name of the repo",
  2479. "name": "repo",
  2480. "in": "path",
  2481. "required": true
  2482. },
  2483. {
  2484. "type": "string",
  2485. "description": "username of the collaborator",
  2486. "name": "collaborator",
  2487. "in": "path",
  2488. "required": true
  2489. }
  2490. ],
  2491. "responses": {
  2492. "204": {
  2493. "$ref": "#/responses/empty"
  2494. },
  2495. "404": {
  2496. "$ref": "#/responses/notFound"
  2497. },
  2498. "422": {
  2499. "$ref": "#/responses/validationError"
  2500. }
  2501. }
  2502. },
  2503. "put": {
  2504. "produces": [
  2505. "application/json"
  2506. ],
  2507. "tags": [
  2508. "repository"
  2509. ],
  2510. "summary": "Add a collaborator to a repository",
  2511. "operationId": "repoAddCollaborator",
  2512. "parameters": [
  2513. {
  2514. "type": "string",
  2515. "description": "owner of the repo",
  2516. "name": "owner",
  2517. "in": "path",
  2518. "required": true
  2519. },
  2520. {
  2521. "type": "string",
  2522. "description": "name of the repo",
  2523. "name": "repo",
  2524. "in": "path",
  2525. "required": true
  2526. },
  2527. {
  2528. "type": "string",
  2529. "description": "username of the collaborator to add",
  2530. "name": "collaborator",
  2531. "in": "path",
  2532. "required": true
  2533. },
  2534. {
  2535. "name": "body",
  2536. "in": "body",
  2537. "schema": {
  2538. "$ref": "#/definitions/AddCollaboratorOption"
  2539. }
  2540. }
  2541. ],
  2542. "responses": {
  2543. "204": {
  2544. "$ref": "#/responses/empty"
  2545. },
  2546. "422": {
  2547. "$ref": "#/responses/validationError"
  2548. }
  2549. }
  2550. },
  2551. "delete": {
  2552. "produces": [
  2553. "application/json"
  2554. ],
  2555. "tags": [
  2556. "repository"
  2557. ],
  2558. "summary": "Delete a collaborator from a repository",
  2559. "operationId": "repoDeleteCollaborator",
  2560. "parameters": [
  2561. {
  2562. "type": "string",
  2563. "description": "owner of the repo",
  2564. "name": "owner",
  2565. "in": "path",
  2566. "required": true
  2567. },
  2568. {
  2569. "type": "string",
  2570. "description": "name of the repo",
  2571. "name": "repo",
  2572. "in": "path",
  2573. "required": true
  2574. },
  2575. {
  2576. "type": "string",
  2577. "description": "username of the collaborator to delete",
  2578. "name": "collaborator",
  2579. "in": "path",
  2580. "required": true
  2581. }
  2582. ],
  2583. "responses": {
  2584. "204": {
  2585. "$ref": "#/responses/empty"
  2586. },
  2587. "422": {
  2588. "$ref": "#/responses/validationError"
  2589. }
  2590. }
  2591. }
  2592. },
  2593. "/repos/{owner}/{repo}/commits": {
  2594. "get": {
  2595. "produces": [
  2596. "application/json"
  2597. ],
  2598. "tags": [
  2599. "repository"
  2600. ],
  2601. "summary": "Get a list of all commits from a repository",
  2602. "operationId": "repoGetAllCommits",
  2603. "parameters": [
  2604. {
  2605. "type": "string",
  2606. "description": "owner of the repo",
  2607. "name": "owner",
  2608. "in": "path",
  2609. "required": true
  2610. },
  2611. {
  2612. "type": "string",
  2613. "description": "name of the repo",
  2614. "name": "repo",
  2615. "in": "path",
  2616. "required": true
  2617. },
  2618. {
  2619. "type": "string",
  2620. "description": "SHA or branch to start listing commits from (usually 'master')",
  2621. "name": "sha",
  2622. "in": "query"
  2623. },
  2624. {
  2625. "type": "integer",
  2626. "description": "page number of results to return (1-based)",
  2627. "name": "page",
  2628. "in": "query"
  2629. },
  2630. {
  2631. "type": "integer",
  2632. "description": "page size of results",
  2633. "name": "limit",
  2634. "in": "query"
  2635. }
  2636. ],
  2637. "responses": {
  2638. "200": {
  2639. "$ref": "#/responses/CommitList"
  2640. },
  2641. "404": {
  2642. "$ref": "#/responses/notFound"
  2643. },
  2644. "409": {
  2645. "$ref": "#/responses/EmptyRepository"
  2646. }
  2647. }
  2648. }
  2649. },
  2650. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2651. "get": {
  2652. "produces": [
  2653. "application/json"
  2654. ],
  2655. "tags": [
  2656. "repository"
  2657. ],
  2658. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2659. "operationId": "repoGetCombinedStatusByRef",
  2660. "parameters": [
  2661. {
  2662. "type": "string",
  2663. "description": "owner of the repo",
  2664. "name": "owner",
  2665. "in": "path",
  2666. "required": true
  2667. },
  2668. {
  2669. "type": "string",
  2670. "description": "name of the repo",
  2671. "name": "repo",
  2672. "in": "path",
  2673. "required": true
  2674. },
  2675. {
  2676. "type": "string",
  2677. "description": "name of branch/tag/commit",
  2678. "name": "ref",
  2679. "in": "path",
  2680. "required": true
  2681. },
  2682. {
  2683. "type": "integer",
  2684. "description": "page number of results",
  2685. "name": "page",
  2686. "in": "query"
  2687. }
  2688. ],
  2689. "responses": {
  2690. "200": {
  2691. "$ref": "#/responses/Status"
  2692. },
  2693. "400": {
  2694. "$ref": "#/responses/error"
  2695. }
  2696. }
  2697. }
  2698. },
  2699. "/repos/{owner}/{repo}/contents": {
  2700. "get": {
  2701. "produces": [
  2702. "application/json"
  2703. ],
  2704. "tags": [
  2705. "repository"
  2706. ],
  2707. "summary": "Gets the metadata of all the entries of the root dir",
  2708. "operationId": "repoGetContentsList",
  2709. "parameters": [
  2710. {
  2711. "type": "string",
  2712. "description": "owner of the repo",
  2713. "name": "owner",
  2714. "in": "path",
  2715. "required": true
  2716. },
  2717. {
  2718. "type": "string",
  2719. "description": "name of the repo",
  2720. "name": "repo",
  2721. "in": "path",
  2722. "required": true
  2723. },
  2724. {
  2725. "type": "string",
  2726. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2727. "name": "ref",
  2728. "in": "query"
  2729. }
  2730. ],
  2731. "responses": {
  2732. "200": {
  2733. "$ref": "#/responses/ContentsListResponse"
  2734. },
  2735. "404": {
  2736. "$ref": "#/responses/notFound"
  2737. }
  2738. }
  2739. }
  2740. },
  2741. "/repos/{owner}/{repo}/contents/{filepath}": {
  2742. "get": {
  2743. "produces": [
  2744. "application/json"
  2745. ],
  2746. "tags": [
  2747. "repository"
  2748. ],
  2749. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2750. "operationId": "repoGetContents",
  2751. "parameters": [
  2752. {
  2753. "type": "string",
  2754. "description": "owner of the repo",
  2755. "name": "owner",
  2756. "in": "path",
  2757. "required": true
  2758. },
  2759. {
  2760. "type": "string",
  2761. "description": "name of the repo",
  2762. "name": "repo",
  2763. "in": "path",
  2764. "required": true
  2765. },
  2766. {
  2767. "type": "string",
  2768. "description": "path of the dir, file, symlink or submodule in the repo",
  2769. "name": "filepath",
  2770. "in": "path",
  2771. "required": true
  2772. },
  2773. {
  2774. "type": "string",
  2775. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2776. "name": "ref",
  2777. "in": "query"
  2778. }
  2779. ],
  2780. "responses": {
  2781. "200": {
  2782. "$ref": "#/responses/ContentsResponse"
  2783. },
  2784. "404": {
  2785. "$ref": "#/responses/notFound"
  2786. }
  2787. }
  2788. },
  2789. "put": {
  2790. "consumes": [
  2791. "application/json"
  2792. ],
  2793. "produces": [
  2794. "application/json"
  2795. ],
  2796. "tags": [
  2797. "repository"
  2798. ],
  2799. "summary": "Update a file in a repository",
  2800. "operationId": "repoUpdateFile",
  2801. "parameters": [
  2802. {
  2803. "type": "string",
  2804. "description": "owner of the repo",
  2805. "name": "owner",
  2806. "in": "path",
  2807. "required": true
  2808. },
  2809. {
  2810. "type": "string",
  2811. "description": "name of the repo",
  2812. "name": "repo",
  2813. "in": "path",
  2814. "required": true
  2815. },
  2816. {
  2817. "type": "string",
  2818. "description": "path of the file to update",
  2819. "name": "filepath",
  2820. "in": "path",
  2821. "required": true
  2822. },
  2823. {
  2824. "name": "body",
  2825. "in": "body",
  2826. "required": true,
  2827. "schema": {
  2828. "$ref": "#/definitions/UpdateFileOptions"
  2829. }
  2830. }
  2831. ],
  2832. "responses": {
  2833. "200": {
  2834. "$ref": "#/responses/FileResponse"
  2835. },
  2836. "403": {
  2837. "$ref": "#/responses/error"
  2838. },
  2839. "404": {
  2840. "$ref": "#/responses/notFound"
  2841. },
  2842. "422": {
  2843. "$ref": "#/responses/error"
  2844. }
  2845. }
  2846. },
  2847. "post": {
  2848. "consumes": [
  2849. "application/json"
  2850. ],
  2851. "produces": [
  2852. "application/json"
  2853. ],
  2854. "tags": [
  2855. "repository"
  2856. ],
  2857. "summary": "Create a file in a repository",
  2858. "operationId": "repoCreateFile",
  2859. "parameters": [
  2860. {
  2861. "type": "string",
  2862. "description": "owner of the repo",
  2863. "name": "owner",
  2864. "in": "path",
  2865. "required": true
  2866. },
  2867. {
  2868. "type": "string",
  2869. "description": "name of the repo",
  2870. "name": "repo",
  2871. "in": "path",
  2872. "required": true
  2873. },
  2874. {
  2875. "type": "string",
  2876. "description": "path of the file to create",
  2877. "name": "filepath",
  2878. "in": "path",
  2879. "required": true
  2880. },
  2881. {
  2882. "name": "body",
  2883. "in": "body",
  2884. "required": true,
  2885. "schema": {
  2886. "$ref": "#/definitions/CreateFileOptions"
  2887. }
  2888. }
  2889. ],
  2890. "responses": {
  2891. "201": {
  2892. "$ref": "#/responses/FileResponse"
  2893. },
  2894. "403": {
  2895. "$ref": "#/responses/error"
  2896. },
  2897. "404": {
  2898. "$ref": "#/responses/notFound"
  2899. },
  2900. "422": {
  2901. "$ref": "#/responses/error"
  2902. }
  2903. }
  2904. },
  2905. "delete": {
  2906. "consumes": [
  2907. "application/json"
  2908. ],
  2909. "produces": [
  2910. "application/json"
  2911. ],
  2912. "tags": [
  2913. "repository"
  2914. ],
  2915. "summary": "Delete a file in a repository",
  2916. "operationId": "repoDeleteFile",
  2917. "parameters": [
  2918. {
  2919. "type": "string",
  2920. "description": "owner of the repo",
  2921. "name": "owner",
  2922. "in": "path",
  2923. "required": true
  2924. },
  2925. {
  2926. "type": "string",
  2927. "description": "name of the repo",
  2928. "name": "repo",
  2929. "in": "path",
  2930. "required": true
  2931. },
  2932. {
  2933. "type": "string",
  2934. "description": "path of the file to delete",
  2935. "name": "filepath",
  2936. "in": "path",
  2937. "required": true
  2938. },
  2939. {
  2940. "name": "body",
  2941. "in": "body",
  2942. "required": true,
  2943. "schema": {
  2944. "$ref": "#/definitions/DeleteFileOptions"
  2945. }
  2946. }
  2947. ],
  2948. "responses": {
  2949. "200": {
  2950. "$ref": "#/responses/FileDeleteResponse"
  2951. },
  2952. "400": {
  2953. "$ref": "#/responses/error"
  2954. },
  2955. "403": {
  2956. "$ref": "#/responses/error"
  2957. },
  2958. "404": {
  2959. "$ref": "#/responses/error"
  2960. }
  2961. }
  2962. }
  2963. },
  2964. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2965. "get": {
  2966. "produces": [
  2967. "application/json"
  2968. ],
  2969. "tags": [
  2970. "repository"
  2971. ],
  2972. "summary": "Get the EditorConfig definitions of a file in a repository",
  2973. "operationId": "repoGetEditorConfig",
  2974. "parameters": [
  2975. {
  2976. "type": "string",
  2977. "description": "owner of the repo",
  2978. "name": "owner",
  2979. "in": "path",
  2980. "required": true
  2981. },
  2982. {
  2983. "type": "string",
  2984. "description": "name of the repo",
  2985. "name": "repo",
  2986. "in": "path",
  2987. "required": true
  2988. },
  2989. {
  2990. "type": "string",
  2991. "description": "filepath of file to get",
  2992. "name": "filepath",
  2993. "in": "path",
  2994. "required": true
  2995. }
  2996. ],
  2997. "responses": {
  2998. "200": {
  2999. "description": "success"
  3000. },
  3001. "404": {
  3002. "$ref": "#/responses/notFound"
  3003. }
  3004. }
  3005. }
  3006. },
  3007. "/repos/{owner}/{repo}/forks": {
  3008. "get": {
  3009. "produces": [
  3010. "application/json"
  3011. ],
  3012. "tags": [
  3013. "repository"
  3014. ],
  3015. "summary": "List a repository's forks",
  3016. "operationId": "listForks",
  3017. "parameters": [
  3018. {
  3019. "type": "string",
  3020. "description": "owner of the repo",
  3021. "name": "owner",
  3022. "in": "path",
  3023. "required": true
  3024. },
  3025. {
  3026. "type": "string",
  3027. "description": "name of the repo",
  3028. "name": "repo",
  3029. "in": "path",
  3030. "required": true
  3031. },
  3032. {
  3033. "type": "integer",
  3034. "description": "page number of results to return (1-based)",
  3035. "name": "page",
  3036. "in": "query"
  3037. },
  3038. {
  3039. "type": "integer",
  3040. "description": "page size of results",
  3041. "name": "limit",
  3042. "in": "query"
  3043. }
  3044. ],
  3045. "responses": {
  3046. "200": {
  3047. "$ref": "#/responses/RepositoryList"
  3048. }
  3049. }
  3050. },
  3051. "post": {
  3052. "produces": [
  3053. "application/json"
  3054. ],
  3055. "tags": [
  3056. "repository"
  3057. ],
  3058. "summary": "Fork a repository",
  3059. "operationId": "createFork",
  3060. "parameters": [
  3061. {
  3062. "type": "string",
  3063. "description": "owner of the repo to fork",
  3064. "name": "owner",
  3065. "in": "path",
  3066. "required": true
  3067. },
  3068. {
  3069. "type": "string",
  3070. "description": "name of the repo to fork",
  3071. "name": "repo",
  3072. "in": "path",
  3073. "required": true
  3074. },
  3075. {
  3076. "name": "body",
  3077. "in": "body",
  3078. "schema": {
  3079. "$ref": "#/definitions/CreateForkOption"
  3080. }
  3081. }
  3082. ],
  3083. "responses": {
  3084. "202": {
  3085. "$ref": "#/responses/Repository"
  3086. },
  3087. "403": {
  3088. "$ref": "#/responses/forbidden"
  3089. },
  3090. "422": {
  3091. "$ref": "#/responses/validationError"
  3092. }
  3093. }
  3094. }
  3095. },
  3096. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  3097. "get": {
  3098. "produces": [
  3099. "application/json"
  3100. ],
  3101. "tags": [
  3102. "repository"
  3103. ],
  3104. "summary": "Gets the blob of a repository.",
  3105. "operationId": "GetBlob",
  3106. "parameters": [
  3107. {
  3108. "type": "string",
  3109. "description": "owner of the repo",
  3110. "name": "owner",
  3111. "in": "path",
  3112. "required": true
  3113. },
  3114. {
  3115. "type": "string",
  3116. "description": "name of the repo",
  3117. "name": "repo",
  3118. "in": "path",
  3119. "required": true
  3120. },
  3121. {
  3122. "type": "string",
  3123. "description": "sha of the commit",
  3124. "name": "sha",
  3125. "in": "path",
  3126. "required": true
  3127. }
  3128. ],
  3129. "responses": {
  3130. "200": {
  3131. "$ref": "#/responses/GitBlobResponse"
  3132. },
  3133. "400": {
  3134. "$ref": "#/responses/error"
  3135. }
  3136. }
  3137. }
  3138. },
  3139. "/repos/{owner}/{repo}/git/commits/{sha}": {
  3140. "get": {
  3141. "produces": [
  3142. "application/json"
  3143. ],
  3144. "tags": [
  3145. "repository"
  3146. ],
  3147. "summary": "Get a single commit from a repository",
  3148. "operationId": "repoGetSingleCommit",
  3149. "parameters": [
  3150. {
  3151. "type": "string",
  3152. "description": "owner of the repo",
  3153. "name": "owner",
  3154. "in": "path",
  3155. "required": true
  3156. },
  3157. {
  3158. "type": "string",
  3159. "description": "name of the repo",
  3160. "name": "repo",
  3161. "in": "path",
  3162. "required": true
  3163. },
  3164. {
  3165. "type": "string",
  3166. "description": "a git ref or commit sha",
  3167. "name": "sha",
  3168. "in": "path",
  3169. "required": true
  3170. }
  3171. ],
  3172. "responses": {
  3173. "200": {
  3174. "$ref": "#/responses/Commit"
  3175. },
  3176. "404": {
  3177. "$ref": "#/responses/notFound"
  3178. },
  3179. "422": {
  3180. "$ref": "#/responses/validationError"
  3181. }
  3182. }
  3183. }
  3184. },
  3185. "/repos/{owner}/{repo}/git/refs": {
  3186. "get": {
  3187. "produces": [
  3188. "application/json"
  3189. ],
  3190. "tags": [
  3191. "repository"
  3192. ],
  3193. "summary": "Get specified ref or filtered repository's refs",
  3194. "operationId": "repoListAllGitRefs",
  3195. "parameters": [
  3196. {
  3197. "type": "string",
  3198. "description": "owner of the repo",
  3199. "name": "owner",
  3200. "in": "path",
  3201. "required": true
  3202. },
  3203. {
  3204. "type": "string",
  3205. "description": "name of the repo",
  3206. "name": "repo",
  3207. "in": "path",
  3208. "required": true
  3209. }
  3210. ],
  3211. "responses": {
  3212. "200": {
  3213. "$ref": "#/responses/ReferenceList"
  3214. },
  3215. "404": {
  3216. "$ref": "#/responses/notFound"
  3217. }
  3218. }
  3219. }
  3220. },
  3221. "/repos/{owner}/{repo}/git/refs/{ref}": {
  3222. "get": {
  3223. "produces": [
  3224. "application/json"
  3225. ],
  3226. "tags": [
  3227. "repository"
  3228. ],
  3229. "summary": "Get specified ref or filtered repository's refs",
  3230. "operationId": "repoListGitRefs",
  3231. "parameters": [
  3232. {
  3233. "type": "string",
  3234. "description": "owner of the repo",
  3235. "name": "owner",
  3236. "in": "path",
  3237. "required": true
  3238. },
  3239. {
  3240. "type": "string",
  3241. "description": "name of the repo",
  3242. "name": "repo",
  3243. "in": "path",
  3244. "required": true
  3245. },
  3246. {
  3247. "type": "string",
  3248. "description": "part or full name of the ref",
  3249. "name": "ref",
  3250. "in": "path",
  3251. "required": true
  3252. }
  3253. ],
  3254. "responses": {
  3255. "200": {
  3256. "$ref": "#/responses/ReferenceList"
  3257. },
  3258. "404": {
  3259. "$ref": "#/responses/notFound"
  3260. }
  3261. }
  3262. }
  3263. },
  3264. "/repos/{owner}/{repo}/git/tags/{sha}": {
  3265. "get": {
  3266. "produces": [
  3267. "application/json"
  3268. ],
  3269. "tags": [
  3270. "repository"
  3271. ],
  3272. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  3273. "operationId": "GetTag",
  3274. "parameters": [
  3275. {
  3276. "type": "string",
  3277. "description": "owner of the repo",
  3278. "name": "owner",
  3279. "in": "path",
  3280. "required": true
  3281. },
  3282. {
  3283. "type": "string",
  3284. "description": "name of the repo",
  3285. "name": "repo",
  3286. "in": "path",
  3287. "required": true
  3288. },
  3289. {
  3290. "type": "string",
  3291. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  3292. "name": "sha",
  3293. "in": "path",
  3294. "required": true
  3295. }
  3296. ],
  3297. "responses": {
  3298. "200": {
  3299. "$ref": "#/responses/AnnotatedTag"
  3300. },
  3301. "400": {
  3302. "$ref": "#/responses/error"
  3303. }
  3304. }
  3305. }
  3306. },
  3307. "/repos/{owner}/{repo}/git/trees/{sha}": {
  3308. "get": {
  3309. "produces": [
  3310. "application/json"
  3311. ],
  3312. "tags": [
  3313. "repository"
  3314. ],
  3315. "summary": "Gets the tree of a repository.",
  3316. "operationId": "GetTree",
  3317. "parameters": [
  3318. {
  3319. "type": "string",
  3320. "description": "owner of the repo",
  3321. "name": "owner",
  3322. "in": "path",
  3323. "required": true
  3324. },
  3325. {
  3326. "type": "string",
  3327. "description": "name of the repo",
  3328. "name": "repo",
  3329. "in": "path",
  3330. "required": true
  3331. },
  3332. {
  3333. "type": "string",
  3334. "description": "sha of the commit",
  3335. "name": "sha",
  3336. "in": "path",
  3337. "required": true
  3338. },
  3339. {
  3340. "type": "boolean",
  3341. "description": "show all directories and files",
  3342. "name": "recursive",
  3343. "in": "query"
  3344. },
  3345. {
  3346. "type": "integer",
  3347. "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",
  3348. "name": "page",
  3349. "in": "query"
  3350. },
  3351. {
  3352. "type": "integer",
  3353. "description": "number of items per page",
  3354. "name": "per_page",
  3355. "in": "query"
  3356. }
  3357. ],
  3358. "responses": {
  3359. "200": {
  3360. "$ref": "#/responses/GitTreeResponse"
  3361. },
  3362. "400": {
  3363. "$ref": "#/responses/error"
  3364. }
  3365. }
  3366. }
  3367. },
  3368. "/repos/{owner}/{repo}/hooks": {
  3369. "get": {
  3370. "produces": [
  3371. "application/json"
  3372. ],
  3373. "tags": [
  3374. "repository"
  3375. ],
  3376. "summary": "List the hooks in a repository",
  3377. "operationId": "repoListHooks",
  3378. "parameters": [
  3379. {
  3380. "type": "string",
  3381. "description": "owner of the repo",
  3382. "name": "owner",
  3383. "in": "path",
  3384. "required": true
  3385. },
  3386. {
  3387. "type": "string",
  3388. "description": "name of the repo",
  3389. "name": "repo",
  3390. "in": "path",
  3391. "required": true
  3392. },
  3393. {
  3394. "type": "integer",
  3395. "description": "page number of results to return (1-based)",
  3396. "name": "page",
  3397. "in": "query"
  3398. },
  3399. {
  3400. "type": "integer",
  3401. "description": "page size of results",
  3402. "name": "limit",
  3403. "in": "query"
  3404. }
  3405. ],
  3406. "responses": {
  3407. "200": {
  3408. "$ref": "#/responses/HookList"
  3409. }
  3410. }
  3411. },
  3412. "post": {
  3413. "consumes": [
  3414. "application/json"
  3415. ],
  3416. "produces": [
  3417. "application/json"
  3418. ],
  3419. "tags": [
  3420. "repository"
  3421. ],
  3422. "summary": "Create a hook",
  3423. "operationId": "repoCreateHook",
  3424. "parameters": [
  3425. {
  3426. "type": "string",
  3427. "description": "owner of the repo",
  3428. "name": "owner",
  3429. "in": "path",
  3430. "required": true
  3431. },
  3432. {
  3433. "type": "string",
  3434. "description": "name of the repo",
  3435. "name": "repo",
  3436. "in": "path",
  3437. "required": true
  3438. },
  3439. {
  3440. "name": "body",
  3441. "in": "body",
  3442. "schema": {
  3443. "$ref": "#/definitions/CreateHookOption"
  3444. }
  3445. }
  3446. ],
  3447. "responses": {
  3448. "201": {
  3449. "$ref": "#/responses/Hook"
  3450. }
  3451. }
  3452. }
  3453. },
  3454. "/repos/{owner}/{repo}/hooks/git": {
  3455. "get": {
  3456. "produces": [
  3457. "application/json"
  3458. ],
  3459. "tags": [
  3460. "repository"
  3461. ],
  3462. "summary": "List the Git hooks in a repository",
  3463. "operationId": "repoListGitHooks",
  3464. "parameters": [
  3465. {
  3466. "type": "string",
  3467. "description": "owner of the repo",
  3468. "name": "owner",
  3469. "in": "path",
  3470. "required": true
  3471. },
  3472. {
  3473. "type": "string",
  3474. "description": "name of the repo",
  3475. "name": "repo",
  3476. "in": "path",
  3477. "required": true
  3478. }
  3479. ],
  3480. "responses": {
  3481. "200": {
  3482. "$ref": "#/responses/GitHookList"
  3483. }
  3484. }
  3485. }
  3486. },
  3487. "/repos/{owner}/{repo}/hooks/git/{id}": {
  3488. "get": {
  3489. "produces": [
  3490. "application/json"
  3491. ],
  3492. "tags": [
  3493. "repository"
  3494. ],
  3495. "summary": "Get a Git hook",
  3496. "operationId": "repoGetGitHook",
  3497. "parameters": [
  3498. {
  3499. "type": "string",
  3500. "description": "owner of the repo",
  3501. "name": "owner",
  3502. "in": "path",
  3503. "required": true
  3504. },
  3505. {
  3506. "type": "string",
  3507. "description": "name of the repo",
  3508. "name": "repo",
  3509. "in": "path",
  3510. "required": true
  3511. },
  3512. {
  3513. "type": "string",
  3514. "description": "id of the hook to get",
  3515. "name": "id",
  3516. "in": "path",
  3517. "required": true
  3518. }
  3519. ],
  3520. "responses": {
  3521. "200": {
  3522. "$ref": "#/responses/GitHook"
  3523. },
  3524. "404": {
  3525. "$ref": "#/responses/notFound"
  3526. }
  3527. }
  3528. },
  3529. "delete": {
  3530. "produces": [
  3531. "application/json"
  3532. ],
  3533. "tags": [
  3534. "repository"
  3535. ],
  3536. "summary": "Delete a Git hook in a repository",
  3537. "operationId": "repoDeleteGitHook",
  3538. "parameters": [
  3539. {
  3540. "type": "string",
  3541. "description": "owner of the repo",
  3542. "name": "owner",
  3543. "in": "path",
  3544. "required": true
  3545. },
  3546. {
  3547. "type": "string",
  3548. "description": "name of the repo",
  3549. "name": "repo",
  3550. "in": "path",
  3551. "required": true
  3552. },
  3553. {
  3554. "type": "string",
  3555. "description": "id of the hook to get",
  3556. "name": "id",
  3557. "in": "path",
  3558. "required": true
  3559. }
  3560. ],
  3561. "responses": {
  3562. "204": {
  3563. "$ref": "#/responses/empty"
  3564. },
  3565. "404": {
  3566. "$ref": "#/responses/notFound"
  3567. }
  3568. }
  3569. },
  3570. "patch": {
  3571. "produces": [
  3572. "application/json"
  3573. ],
  3574. "tags": [
  3575. "repository"
  3576. ],
  3577. "summary": "Edit a Git hook in a repository",
  3578. "operationId": "repoEditGitHook",
  3579. "parameters": [
  3580. {
  3581. "type": "string",
  3582. "description": "owner of the repo",
  3583. "name": "owner",
  3584. "in": "path",
  3585. "required": true
  3586. },
  3587. {
  3588. "type": "string",
  3589. "description": "name of the repo",
  3590. "name": "repo",
  3591. "in": "path",
  3592. "required": true
  3593. },
  3594. {
  3595. "type": "string",
  3596. "description": "id of the hook to get",
  3597. "name": "id",
  3598. "in": "path",
  3599. "required": true
  3600. },
  3601. {
  3602. "name": "body",
  3603. "in": "body",
  3604. "schema": {
  3605. "$ref": "#/definitions/EditGitHookOption"
  3606. }
  3607. }
  3608. ],
  3609. "responses": {
  3610. "200": {
  3611. "$ref": "#/responses/GitHook"
  3612. },
  3613. "404": {
  3614. "$ref": "#/responses/notFound"
  3615. }
  3616. }
  3617. }
  3618. },
  3619. "/repos/{owner}/{repo}/hooks/{id}": {
  3620. "get": {
  3621. "produces": [
  3622. "application/json"
  3623. ],
  3624. "tags": [
  3625. "repository"
  3626. ],
  3627. "summary": "Get a hook",
  3628. "operationId": "repoGetHook",
  3629. "parameters": [
  3630. {
  3631. "type": "string",
  3632. "description": "owner of the repo",
  3633. "name": "owner",
  3634. "in": "path",
  3635. "required": true
  3636. },
  3637. {
  3638. "type": "string",
  3639. "description": "name of the repo",
  3640. "name": "repo",
  3641. "in": "path",
  3642. "required": true
  3643. },
  3644. {
  3645. "type": "integer",
  3646. "format": "int64",
  3647. "description": "id of the hook to get",
  3648. "name": "id",
  3649. "in": "path",
  3650. "required": true
  3651. }
  3652. ],
  3653. "responses": {
  3654. "200": {
  3655. "$ref": "#/responses/Hook"
  3656. },
  3657. "404": {
  3658. "$ref": "#/responses/notFound"
  3659. }
  3660. }
  3661. },
  3662. "delete": {
  3663. "produces": [
  3664. "application/json"
  3665. ],
  3666. "tags": [
  3667. "repository"
  3668. ],
  3669. "summary": "Delete a hook in a repository",
  3670. "operationId": "repoDeleteHook",
  3671. "parameters": [
  3672. {
  3673. "type": "string",
  3674. "description": "owner of the repo",
  3675. "name": "owner",
  3676. "in": "path",
  3677. "required": true
  3678. },
  3679. {
  3680. "type": "string",
  3681. "description": "name of the repo",
  3682. "name": "repo",
  3683. "in": "path",
  3684. "required": true
  3685. },
  3686. {
  3687. "type": "integer",
  3688. "format": "int64",
  3689. "description": "id of the hook to delete",
  3690. "name": "id",
  3691. "in": "path",
  3692. "required": true
  3693. }
  3694. ],
  3695. "responses": {
  3696. "204": {
  3697. "$ref": "#/responses/empty"
  3698. },
  3699. "404": {
  3700. "$ref": "#/responses/notFound"
  3701. }
  3702. }
  3703. },
  3704. "patch": {
  3705. "produces": [
  3706. "application/json"
  3707. ],
  3708. "tags": [
  3709. "repository"
  3710. ],
  3711. "summary": "Edit a hook in a repository",
  3712. "operationId": "repoEditHook",
  3713. "parameters": [
  3714. {
  3715. "type": "string",
  3716. "description": "owner of the repo",
  3717. "name": "owner",
  3718. "in": "path",
  3719. "required": true
  3720. },
  3721. {
  3722. "type": "string",
  3723. "description": "name of the repo",
  3724. "name": "repo",
  3725. "in": "path",
  3726. "required": true
  3727. },
  3728. {
  3729. "type": "integer",
  3730. "format": "int64",
  3731. "description": "index of the hook",
  3732. "name": "id",
  3733. "in": "path",
  3734. "required": true
  3735. },
  3736. {
  3737. "name": "body",
  3738. "in": "body",
  3739. "schema": {
  3740. "$ref": "#/definitions/EditHookOption"
  3741. }
  3742. }
  3743. ],
  3744. "responses": {
  3745. "200": {
  3746. "$ref": "#/responses/Hook"
  3747. }
  3748. }
  3749. }
  3750. },
  3751. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3752. "post": {
  3753. "produces": [
  3754. "application/json"
  3755. ],
  3756. "tags": [
  3757. "repository"
  3758. ],
  3759. "summary": "Test a push webhook",
  3760. "operationId": "repoTestHook",
  3761. "parameters": [
  3762. {
  3763. "type": "string",
  3764. "description": "owner of the repo",
  3765. "name": "owner",
  3766. "in": "path",
  3767. "required": true
  3768. },
  3769. {
  3770. "type": "string",
  3771. "description": "name of the repo",
  3772. "name": "repo",
  3773. "in": "path",
  3774. "required": true
  3775. },
  3776. {
  3777. "type": "integer",
  3778. "format": "int64",
  3779. "description": "id of the hook to test",
  3780. "name": "id",
  3781. "in": "path",
  3782. "required": true
  3783. }
  3784. ],
  3785. "responses": {
  3786. "204": {
  3787. "$ref": "#/responses/empty"
  3788. }
  3789. }
  3790. }
  3791. },
  3792. "/repos/{owner}/{repo}/issues": {
  3793. "get": {
  3794. "produces": [
  3795. "application/json"
  3796. ],
  3797. "tags": [
  3798. "issue"
  3799. ],
  3800. "summary": "List a repository's issues",
  3801. "operationId": "issueListIssues",
  3802. "parameters": [
  3803. {
  3804. "type": "string",
  3805. "description": "owner of the repo",
  3806. "name": "owner",
  3807. "in": "path",
  3808. "required": true
  3809. },
  3810. {
  3811. "type": "string",
  3812. "description": "name of the repo",
  3813. "name": "repo",
  3814. "in": "path",
  3815. "required": true
  3816. },
  3817. {
  3818. "enum": [
  3819. "closed",
  3820. "open",
  3821. "all"
  3822. ],
  3823. "type": "string",
  3824. "description": "whether issue is open or closed",
  3825. "name": "state",
  3826. "in": "query"
  3827. },
  3828. {
  3829. "type": "string",
  3830. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3831. "name": "labels",
  3832. "in": "query"
  3833. },
  3834. {
  3835. "type": "string",
  3836. "description": "search string",
  3837. "name": "q",
  3838. "in": "query"
  3839. },
  3840. {
  3841. "enum": [
  3842. "issues",
  3843. "pulls"
  3844. ],
  3845. "type": "string",
  3846. "description": "filter by type (issues / pulls) if set",
  3847. "name": "type",
  3848. "in": "query"
  3849. },
  3850. {
  3851. "type": "string",
  3852. "description": "comma separated list of milestone names or ids. It uses names and fall back to ids. Fetch only issues that have any of this milestones. Non existent milestones are discarded",
  3853. "name": "milestones",
  3854. "in": "query"
  3855. },
  3856. {
  3857. "type": "integer",
  3858. "description": "page number of results to return (1-based)",
  3859. "name": "page",
  3860. "in": "query"
  3861. },
  3862. {
  3863. "type": "integer",
  3864. "description": "page size of results",
  3865. "name": "limit",
  3866. "in": "query"
  3867. }
  3868. ],
  3869. "responses": {
  3870. "200": {
  3871. "$ref": "#/responses/IssueList"
  3872. }
  3873. }
  3874. },
  3875. "post": {
  3876. "consumes": [
  3877. "application/json"
  3878. ],
  3879. "produces": [
  3880. "application/json"
  3881. ],
  3882. "tags": [
  3883. "issue"
  3884. ],
  3885. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3886. "operationId": "issueCreateIssue",
  3887. "parameters": [
  3888. {
  3889. "type": "string",
  3890. "description": "owner of the repo",
  3891. "name": "owner",
  3892. "in": "path",
  3893. "required": true
  3894. },
  3895. {
  3896. "type": "string",
  3897. "description": "name of the repo",
  3898. "name": "repo",
  3899. "in": "path",
  3900. "required": true
  3901. },
  3902. {
  3903. "name": "body",
  3904. "in": "body",
  3905. "schema": {
  3906. "$ref": "#/definitions/CreateIssueOption"
  3907. }
  3908. }
  3909. ],
  3910. "responses": {
  3911. "201": {
  3912. "$ref": "#/responses/Issue"
  3913. },
  3914. "403": {
  3915. "$ref": "#/responses/forbidden"
  3916. },
  3917. "412": {
  3918. "$ref": "#/responses/error"
  3919. },
  3920. "422": {
  3921. "$ref": "#/responses/validationError"
  3922. }
  3923. }
  3924. }
  3925. },
  3926. "/repos/{owner}/{repo}/issues/comments": {
  3927. "get": {
  3928. "produces": [
  3929. "application/json"
  3930. ],
  3931. "tags": [
  3932. "issue"
  3933. ],
  3934. "summary": "List all comments in a repository",
  3935. "operationId": "issueGetRepoComments",
  3936. "parameters": [
  3937. {
  3938. "type": "string",
  3939. "description": "owner of the repo",
  3940. "name": "owner",
  3941. "in": "path",
  3942. "required": true
  3943. },
  3944. {
  3945. "type": "string",
  3946. "description": "name of the repo",
  3947. "name": "repo",
  3948. "in": "path",
  3949. "required": true
  3950. },
  3951. {
  3952. "type": "string",
  3953. "format": "date-time",
  3954. "description": "if provided, only comments updated since the provided time are returned.",
  3955. "name": "since",
  3956. "in": "query"
  3957. },
  3958. {
  3959. "type": "string",
  3960. "format": "date-time",
  3961. "description": "if provided, only comments updated before the provided time are returned.",
  3962. "name": "before",
  3963. "in": "query"
  3964. },
  3965. {
  3966. "type": "integer",
  3967. "description": "page number of results to return (1-based)",
  3968. "name": "page",
  3969. "in": "query"
  3970. },
  3971. {
  3972. "type": "integer",
  3973. "description": "page size of results",
  3974. "name": "limit",
  3975. "in": "query"
  3976. }
  3977. ],
  3978. "responses": {
  3979. "200": {
  3980. "$ref": "#/responses/CommentList"
  3981. }
  3982. }
  3983. }
  3984. },
  3985. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3986. "get": {
  3987. "consumes": [
  3988. "application/json"
  3989. ],
  3990. "produces": [
  3991. "application/json"
  3992. ],
  3993. "tags": [
  3994. "issue"
  3995. ],
  3996. "summary": "Get a comment",
  3997. "operationId": "issueGetComment",
  3998. "parameters": [
  3999. {
  4000. "type": "string",
  4001. "description": "owner of the repo",
  4002. "name": "owner",
  4003. "in": "path",
  4004. "required": true
  4005. },
  4006. {
  4007. "type": "string",
  4008. "description": "name of the repo",
  4009. "name": "repo",
  4010. "in": "path",
  4011. "required": true
  4012. },
  4013. {
  4014. "type": "integer",
  4015. "format": "int64",
  4016. "description": "id of the comment",
  4017. "name": "id",
  4018. "in": "path",
  4019. "required": true
  4020. }
  4021. ],
  4022. "responses": {
  4023. "200": {
  4024. "$ref": "#/responses/Comment"
  4025. },
  4026. "204": {
  4027. "$ref": "#/responses/empty"
  4028. },
  4029. "403": {
  4030. "$ref": "#/responses/forbidden"
  4031. },
  4032. "404": {
  4033. "$ref": "#/responses/notFound"
  4034. }
  4035. }
  4036. },
  4037. "delete": {
  4038. "tags": [
  4039. "issue"
  4040. ],
  4041. "summary": "Delete a comment",
  4042. "operationId": "issueDeleteComment",
  4043. "parameters": [
  4044. {
  4045. "type": "string",
  4046. "description": "owner of the repo",
  4047. "name": "owner",
  4048. "in": "path",
  4049. "required": true
  4050. },
  4051. {
  4052. "type": "string",
  4053. "description": "name of the repo",
  4054. "name": "repo",
  4055. "in": "path",
  4056. "required": true
  4057. },
  4058. {
  4059. "type": "integer",
  4060. "format": "int64",
  4061. "description": "id of comment to delete",
  4062. "name": "id",
  4063. "in": "path",
  4064. "required": true
  4065. }
  4066. ],
  4067. "responses": {
  4068. "204": {
  4069. "$ref": "#/responses/empty"
  4070. },
  4071. "403": {
  4072. "$ref": "#/responses/forbidden"
  4073. },
  4074. "404": {
  4075. "$ref": "#/responses/notFound"
  4076. }
  4077. }
  4078. },
  4079. "patch": {
  4080. "consumes": [
  4081. "application/json"
  4082. ],
  4083. "produces": [
  4084. "application/json"
  4085. ],
  4086. "tags": [
  4087. "issue"
  4088. ],
  4089. "summary": "Edit a comment",
  4090. "operationId": "issueEditComment",
  4091. "parameters": [
  4092. {
  4093. "type": "string",
  4094. "description": "owner of the repo",
  4095. "name": "owner",
  4096. "in": "path",
  4097. "required": true
  4098. },
  4099. {
  4100. "type": "string",
  4101. "description": "name of the repo",
  4102. "name": "repo",
  4103. "in": "path",
  4104. "required": true
  4105. },
  4106. {
  4107. "type": "integer",
  4108. "format": "int64",
  4109. "description": "id of the comment to edit",
  4110. "name": "id",
  4111. "in": "path",
  4112. "required": true
  4113. },
  4114. {
  4115. "name": "body",
  4116. "in": "body",
  4117. "schema": {
  4118. "$ref": "#/definitions/EditIssueCommentOption"
  4119. }
  4120. }
  4121. ],
  4122. "responses": {
  4123. "200": {
  4124. "$ref": "#/responses/Comment"
  4125. },
  4126. "204": {
  4127. "$ref": "#/responses/empty"
  4128. },
  4129. "403": {
  4130. "$ref": "#/responses/forbidden"
  4131. },
  4132. "404": {
  4133. "$ref": "#/responses/notFound"
  4134. }
  4135. }
  4136. }
  4137. },
  4138. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  4139. "get": {
  4140. "consumes": [
  4141. "application/json"
  4142. ],
  4143. "produces": [
  4144. "application/json"
  4145. ],
  4146. "tags": [
  4147. "issue"
  4148. ],
  4149. "summary": "Get a list of reactions from a comment of an issue",
  4150. "operationId": "issueGetCommentReactions",
  4151. "parameters": [
  4152. {
  4153. "type": "string",
  4154. "description": "owner of the repo",
  4155. "name": "owner",
  4156. "in": "path",
  4157. "required": true
  4158. },
  4159. {
  4160. "type": "string",
  4161. "description": "name of the repo",
  4162. "name": "repo",
  4163. "in": "path",
  4164. "required": true
  4165. },
  4166. {
  4167. "type": "integer",
  4168. "format": "int64",
  4169. "description": "id of the comment to edit",
  4170. "name": "id",
  4171. "in": "path",
  4172. "required": true
  4173. }
  4174. ],
  4175. "responses": {
  4176. "200": {
  4177. "$ref": "#/responses/ReactionList"
  4178. },
  4179. "403": {
  4180. "$ref": "#/responses/forbidden"
  4181. }
  4182. }
  4183. },
  4184. "post": {
  4185. "consumes": [
  4186. "application/json"
  4187. ],
  4188. "produces": [
  4189. "application/json"
  4190. ],
  4191. "tags": [
  4192. "issue"
  4193. ],
  4194. "summary": "Add a reaction to a comment of an issue",
  4195. "operationId": "issuePostCommentReaction",
  4196. "parameters": [
  4197. {
  4198. "type": "string",
  4199. "description": "owner of the repo",
  4200. "name": "owner",
  4201. "in": "path",
  4202. "required": true
  4203. },
  4204. {
  4205. "type": "string",
  4206. "description": "name of the repo",
  4207. "name": "repo",
  4208. "in": "path",
  4209. "required": true
  4210. },
  4211. {
  4212. "type": "integer",
  4213. "format": "int64",
  4214. "description": "id of the comment to edit",
  4215. "name": "id",
  4216. "in": "path",
  4217. "required": true
  4218. },
  4219. {
  4220. "name": "content",
  4221. "in": "body",
  4222. "schema": {
  4223. "$ref": "#/definitions/EditReactionOption"
  4224. }
  4225. }
  4226. ],
  4227. "responses": {
  4228. "200": {
  4229. "$ref": "#/responses/Reaction"
  4230. },
  4231. "201": {
  4232. "$ref": "#/responses/Reaction"
  4233. },
  4234. "403": {
  4235. "$ref": "#/responses/forbidden"
  4236. }
  4237. }
  4238. },
  4239. "delete": {
  4240. "consumes": [
  4241. "application/json"
  4242. ],
  4243. "produces": [
  4244. "application/json"
  4245. ],
  4246. "tags": [
  4247. "issue"
  4248. ],
  4249. "summary": "Remove a reaction from a comment of an issue",
  4250. "operationId": "issueDeleteCommentReaction",
  4251. "parameters": [
  4252. {
  4253. "type": "string",
  4254. "description": "owner of the repo",
  4255. "name": "owner",
  4256. "in": "path",
  4257. "required": true
  4258. },
  4259. {
  4260. "type": "string",
  4261. "description": "name of the repo",
  4262. "name": "repo",
  4263. "in": "path",
  4264. "required": true
  4265. },
  4266. {
  4267. "type": "integer",
  4268. "format": "int64",
  4269. "description": "id of the comment to edit",
  4270. "name": "id",
  4271. "in": "path",
  4272. "required": true
  4273. },
  4274. {
  4275. "name": "content",
  4276. "in": "body",
  4277. "schema": {
  4278. "$ref": "#/definitions/EditReactionOption"
  4279. }
  4280. }
  4281. ],
  4282. "responses": {
  4283. "200": {
  4284. "$ref": "#/responses/empty"
  4285. },
  4286. "403": {
  4287. "$ref": "#/responses/forbidden"
  4288. }
  4289. }
  4290. }
  4291. },
  4292. "/repos/{owner}/{repo}/issues/{index}": {
  4293. "get": {
  4294. "produces": [
  4295. "application/json"
  4296. ],
  4297. "tags": [
  4298. "issue"
  4299. ],
  4300. "summary": "Get an issue",
  4301. "operationId": "issueGetIssue",
  4302. "parameters": [
  4303. {
  4304. "type": "string",
  4305. "description": "owner of the repo",
  4306. "name": "owner",
  4307. "in": "path",
  4308. "required": true
  4309. },
  4310. {
  4311. "type": "string",
  4312. "description": "name of the repo",
  4313. "name": "repo",
  4314. "in": "path",
  4315. "required": true
  4316. },
  4317. {
  4318. "type": "integer",
  4319. "format": "int64",
  4320. "description": "index of the issue to get",
  4321. "name": "index",
  4322. "in": "path",
  4323. "required": true
  4324. }
  4325. ],
  4326. "responses": {
  4327. "200": {
  4328. "$ref": "#/responses/Issue"
  4329. },
  4330. "404": {
  4331. "$ref": "#/responses/notFound"
  4332. }
  4333. }
  4334. },
  4335. "patch": {
  4336. "consumes": [
  4337. "application/json"
  4338. ],
  4339. "produces": [
  4340. "application/json"
  4341. ],
  4342. "tags": [
  4343. "issue"
  4344. ],
  4345. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  4346. "operationId": "issueEditIssue",
  4347. "parameters": [
  4348. {
  4349. "type": "string",
  4350. "description": "owner of the repo",
  4351. "name": "owner",
  4352. "in": "path",
  4353. "required": true
  4354. },
  4355. {
  4356. "type": "string",
  4357. "description": "name of the repo",
  4358. "name": "repo",
  4359. "in": "path",
  4360. "required": true
  4361. },
  4362. {
  4363. "type": "integer",
  4364. "format": "int64",
  4365. "description": "index of the issue to edit",
  4366. "name": "index",
  4367. "in": "path",
  4368. "required": true
  4369. },
  4370. {
  4371. "name": "body",
  4372. "in": "body",
  4373. "schema": {
  4374. "$ref": "#/definitions/EditIssueOption"
  4375. }
  4376. }
  4377. ],
  4378. "responses": {
  4379. "201": {
  4380. "$ref": "#/responses/Issue"
  4381. },
  4382. "403": {
  4383. "$ref": "#/responses/forbidden"
  4384. },
  4385. "404": {
  4386. "$ref": "#/responses/notFound"
  4387. },
  4388. "412": {
  4389. "$ref": "#/responses/error"
  4390. }
  4391. }
  4392. }
  4393. },
  4394. "/repos/{owner}/{repo}/issues/{index}/comments": {
  4395. "get": {
  4396. "produces": [
  4397. "application/json"
  4398. ],
  4399. "tags": [
  4400. "issue"
  4401. ],
  4402. "summary": "List all comments on an issue",
  4403. "operationId": "issueGetComments",
  4404. "parameters": [
  4405. {
  4406. "type": "string",
  4407. "description": "owner of the repo",
  4408. "name": "owner",
  4409. "in": "path",
  4410. "required": true
  4411. },
  4412. {
  4413. "type": "string",
  4414. "description": "name of the repo",
  4415. "name": "repo",
  4416. "in": "path",
  4417. "required": true
  4418. },
  4419. {
  4420. "type": "integer",
  4421. "format": "int64",
  4422. "description": "index of the issue",
  4423. "name": "index",
  4424. "in": "path",
  4425. "required": true
  4426. },
  4427. {
  4428. "type": "string",
  4429. "format": "date-time",
  4430. "description": "if provided, only comments updated since the specified time are returned.",
  4431. "name": "since",
  4432. "in": "query"
  4433. },
  4434. {
  4435. "type": "string",
  4436. "format": "date-time",
  4437. "description": "if provided, only comments updated before the provided time are returned.",
  4438. "name": "before",
  4439. "in": "query"
  4440. }
  4441. ],
  4442. "responses": {
  4443. "200": {
  4444. "$ref": "#/responses/CommentList"
  4445. }
  4446. }
  4447. },
  4448. "post": {
  4449. "consumes": [
  4450. "application/json"
  4451. ],
  4452. "produces": [
  4453. "application/json"
  4454. ],
  4455. "tags": [
  4456. "issue"
  4457. ],
  4458. "summary": "Add a comment to an issue",
  4459. "operationId": "issueCreateComment",
  4460. "parameters": [
  4461. {
  4462. "type": "string",
  4463. "description": "owner of the repo",
  4464. "name": "owner",
  4465. "in": "path",
  4466. "required": true
  4467. },
  4468. {
  4469. "type": "string",
  4470. "description": "name of the repo",
  4471. "name": "repo",
  4472. "in": "path",
  4473. "required": true
  4474. },
  4475. {
  4476. "type": "integer",
  4477. "format": "int64",
  4478. "description": "index of the issue",
  4479. "name": "index",
  4480. "in": "path",
  4481. "required": true
  4482. },
  4483. {
  4484. "name": "body",
  4485. "in": "body",
  4486. "schema": {
  4487. "$ref": "#/definitions/CreateIssueCommentOption"
  4488. }
  4489. }
  4490. ],
  4491. "responses": {
  4492. "201": {
  4493. "$ref": "#/responses/Comment"
  4494. },
  4495. "403": {
  4496. "$ref": "#/responses/forbidden"
  4497. }
  4498. }
  4499. }
  4500. },
  4501. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  4502. "delete": {
  4503. "tags": [
  4504. "issue"
  4505. ],
  4506. "summary": "Delete a comment",
  4507. "operationId": "issueDeleteCommentDeprecated",
  4508. "deprecated": true,
  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. "description": "this parameter is ignored",
  4527. "name": "index",
  4528. "in": "path",
  4529. "required": true
  4530. },
  4531. {
  4532. "type": "integer",
  4533. "format": "int64",
  4534. "description": "id of comment to delete",
  4535. "name": "id",
  4536. "in": "path",
  4537. "required": true
  4538. }
  4539. ],
  4540. "responses": {
  4541. "204": {
  4542. "$ref": "#/responses/empty"
  4543. },
  4544. "403": {
  4545. "$ref": "#/responses/forbidden"
  4546. },
  4547. "404": {
  4548. "$ref": "#/responses/notFound"
  4549. }
  4550. }
  4551. },
  4552. "patch": {
  4553. "consumes": [
  4554. "application/json"
  4555. ],
  4556. "produces": [
  4557. "application/json"
  4558. ],
  4559. "tags": [
  4560. "issue"
  4561. ],
  4562. "summary": "Edit a comment",
  4563. "operationId": "issueEditCommentDeprecated",
  4564. "deprecated": true,
  4565. "parameters": [
  4566. {
  4567. "type": "string",
  4568. "description": "owner of the repo",
  4569. "name": "owner",
  4570. "in": "path",
  4571. "required": true
  4572. },
  4573. {
  4574. "type": "string",
  4575. "description": "name of the repo",
  4576. "name": "repo",
  4577. "in": "path",
  4578. "required": true
  4579. },
  4580. {
  4581. "type": "integer",
  4582. "description": "this parameter is ignored",
  4583. "name": "index",
  4584. "in": "path",
  4585. "required": true
  4586. },
  4587. {
  4588. "type": "integer",
  4589. "format": "int64",
  4590. "description": "id of the comment to edit",
  4591. "name": "id",
  4592. "in": "path",
  4593. "required": true
  4594. },
  4595. {
  4596. "name": "body",
  4597. "in": "body",
  4598. "schema": {
  4599. "$ref": "#/definitions/EditIssueCommentOption"
  4600. }
  4601. }
  4602. ],
  4603. "responses": {
  4604. "200": {
  4605. "$ref": "#/responses/Comment"
  4606. },
  4607. "204": {
  4608. "$ref": "#/responses/empty"
  4609. },
  4610. "403": {
  4611. "$ref": "#/responses/forbidden"
  4612. },
  4613. "404": {
  4614. "$ref": "#/responses/notFound"
  4615. }
  4616. }
  4617. }
  4618. },
  4619. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4620. "post": {
  4621. "consumes": [
  4622. "application/json"
  4623. ],
  4624. "produces": [
  4625. "application/json"
  4626. ],
  4627. "tags": [
  4628. "issue"
  4629. ],
  4630. "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.",
  4631. "operationId": "issueEditIssueDeadline",
  4632. "parameters": [
  4633. {
  4634. "type": "string",
  4635. "description": "owner of the repo",
  4636. "name": "owner",
  4637. "in": "path",
  4638. "required": true
  4639. },
  4640. {
  4641. "type": "string",
  4642. "description": "name of the repo",
  4643. "name": "repo",
  4644. "in": "path",
  4645. "required": true
  4646. },
  4647. {
  4648. "type": "integer",
  4649. "format": "int64",
  4650. "description": "index of the issue to create or update a deadline on",
  4651. "name": "index",
  4652. "in": "path",
  4653. "required": true
  4654. },
  4655. {
  4656. "name": "body",
  4657. "in": "body",
  4658. "schema": {
  4659. "$ref": "#/definitions/EditDeadlineOption"
  4660. }
  4661. }
  4662. ],
  4663. "responses": {
  4664. "201": {
  4665. "$ref": "#/responses/IssueDeadline"
  4666. },
  4667. "403": {
  4668. "$ref": "#/responses/forbidden"
  4669. },
  4670. "404": {
  4671. "$ref": "#/responses/notFound"
  4672. }
  4673. }
  4674. }
  4675. },
  4676. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4677. "get": {
  4678. "produces": [
  4679. "application/json"
  4680. ],
  4681. "tags": [
  4682. "issue"
  4683. ],
  4684. "summary": "Get an issue's labels",
  4685. "operationId": "issueGetLabels",
  4686. "parameters": [
  4687. {
  4688. "type": "string",
  4689. "description": "owner of the repo",
  4690. "name": "owner",
  4691. "in": "path",
  4692. "required": true
  4693. },
  4694. {
  4695. "type": "string",
  4696. "description": "name of the repo",
  4697. "name": "repo",
  4698. "in": "path",
  4699. "required": true
  4700. },
  4701. {
  4702. "type": "integer",
  4703. "format": "int64",
  4704. "description": "index of the issue",
  4705. "name": "index",
  4706. "in": "path",
  4707. "required": true
  4708. }
  4709. ],
  4710. "responses": {
  4711. "200": {
  4712. "$ref": "#/responses/LabelList"
  4713. },
  4714. "404": {
  4715. "$ref": "#/responses/notFound"
  4716. }
  4717. }
  4718. },
  4719. "put": {
  4720. "consumes": [
  4721. "application/json"
  4722. ],
  4723. "produces": [
  4724. "application/json"
  4725. ],
  4726. "tags": [
  4727. "issue"
  4728. ],
  4729. "summary": "Replace an issue's labels",
  4730. "operationId": "issueReplaceLabels",
  4731. "parameters": [
  4732. {
  4733. "type": "string",
  4734. "description": "owner of the repo",
  4735. "name": "owner",
  4736. "in": "path",
  4737. "required": true
  4738. },
  4739. {
  4740. "type": "string",
  4741. "description": "name of the repo",
  4742. "name": "repo",
  4743. "in": "path",
  4744. "required": true
  4745. },
  4746. {
  4747. "type": "integer",
  4748. "format": "int64",
  4749. "description": "index of the issue",
  4750. "name": "index",
  4751. "in": "path",
  4752. "required": true
  4753. },
  4754. {
  4755. "name": "body",
  4756. "in": "body",
  4757. "schema": {
  4758. "$ref": "#/definitions/IssueLabelsOption"
  4759. }
  4760. }
  4761. ],
  4762. "responses": {
  4763. "200": {
  4764. "$ref": "#/responses/LabelList"
  4765. },
  4766. "403": {
  4767. "$ref": "#/responses/forbidden"
  4768. }
  4769. }
  4770. },
  4771. "post": {
  4772. "consumes": [
  4773. "application/json"
  4774. ],
  4775. "produces": [
  4776. "application/json"
  4777. ],
  4778. "tags": [
  4779. "issue"
  4780. ],
  4781. "summary": "Add a label to an issue",
  4782. "operationId": "issueAddLabel",
  4783. "parameters": [
  4784. {
  4785. "type": "string",
  4786. "description": "owner of the repo",
  4787. "name": "owner",
  4788. "in": "path",
  4789. "required": true
  4790. },
  4791. {
  4792. "type": "string",
  4793. "description": "name of the repo",
  4794. "name": "repo",
  4795. "in": "path",
  4796. "required": true
  4797. },
  4798. {
  4799. "type": "integer",
  4800. "format": "int64",
  4801. "description": "index of the issue",
  4802. "name": "index",
  4803. "in": "path",
  4804. "required": true
  4805. },
  4806. {
  4807. "name": "body",
  4808. "in": "body",
  4809. "schema": {
  4810. "$ref": "#/definitions/IssueLabelsOption"
  4811. }
  4812. }
  4813. ],
  4814. "responses": {
  4815. "200": {
  4816. "$ref": "#/responses/LabelList"
  4817. },
  4818. "403": {
  4819. "$ref": "#/responses/forbidden"
  4820. }
  4821. }
  4822. },
  4823. "delete": {
  4824. "produces": [
  4825. "application/json"
  4826. ],
  4827. "tags": [
  4828. "issue"
  4829. ],
  4830. "summary": "Remove all labels from an issue",
  4831. "operationId": "issueClearLabels",
  4832. "parameters": [
  4833. {
  4834. "type": "string",
  4835. "description": "owner of the repo",
  4836. "name": "owner",
  4837. "in": "path",
  4838. "required": true
  4839. },
  4840. {
  4841. "type": "string",
  4842. "description": "name of the repo",
  4843. "name": "repo",
  4844. "in": "path",
  4845. "required": true
  4846. },
  4847. {
  4848. "type": "integer",
  4849. "format": "int64",
  4850. "description": "index of the issue",
  4851. "name": "index",
  4852. "in": "path",
  4853. "required": true
  4854. }
  4855. ],
  4856. "responses": {
  4857. "204": {
  4858. "$ref": "#/responses/empty"
  4859. },
  4860. "403": {
  4861. "$ref": "#/responses/forbidden"
  4862. }
  4863. }
  4864. }
  4865. },
  4866. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4867. "delete": {
  4868. "produces": [
  4869. "application/json"
  4870. ],
  4871. "tags": [
  4872. "issue"
  4873. ],
  4874. "summary": "Remove a label from an issue",
  4875. "operationId": "issueRemoveLabel",
  4876. "parameters": [
  4877. {
  4878. "type": "string",
  4879. "description": "owner of the repo",
  4880. "name": "owner",
  4881. "in": "path",
  4882. "required": true
  4883. },
  4884. {
  4885. "type": "string",
  4886. "description": "name of the repo",
  4887. "name": "repo",
  4888. "in": "path",
  4889. "required": true
  4890. },
  4891. {
  4892. "type": "integer",
  4893. "format": "int64",
  4894. "description": "index of the issue",
  4895. "name": "index",
  4896. "in": "path",
  4897. "required": true
  4898. },
  4899. {
  4900. "type": "integer",
  4901. "format": "int64",
  4902. "description": "id of the label to remove",
  4903. "name": "id",
  4904. "in": "path",
  4905. "required": true
  4906. }
  4907. ],
  4908. "responses": {
  4909. "204": {
  4910. "$ref": "#/responses/empty"
  4911. },
  4912. "403": {
  4913. "$ref": "#/responses/forbidden"
  4914. },
  4915. "422": {
  4916. "$ref": "#/responses/validationError"
  4917. }
  4918. }
  4919. }
  4920. },
  4921. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4922. "get": {
  4923. "consumes": [
  4924. "application/json"
  4925. ],
  4926. "produces": [
  4927. "application/json"
  4928. ],
  4929. "tags": [
  4930. "issue"
  4931. ],
  4932. "summary": "Get a list reactions of an issue",
  4933. "operationId": "issueGetIssueReactions",
  4934. "parameters": [
  4935. {
  4936. "type": "string",
  4937. "description": "owner of the repo",
  4938. "name": "owner",
  4939. "in": "path",
  4940. "required": true
  4941. },
  4942. {
  4943. "type": "string",
  4944. "description": "name of the repo",
  4945. "name": "repo",
  4946. "in": "path",
  4947. "required": true
  4948. },
  4949. {
  4950. "type": "integer",
  4951. "format": "int64",
  4952. "description": "index of the issue",
  4953. "name": "index",
  4954. "in": "path",
  4955. "required": true
  4956. },
  4957. {
  4958. "type": "integer",
  4959. "description": "page number of results to return (1-based)",
  4960. "name": "page",
  4961. "in": "query"
  4962. },
  4963. {
  4964. "type": "integer",
  4965. "description": "page size of results",
  4966. "name": "limit",
  4967. "in": "query"
  4968. }
  4969. ],
  4970. "responses": {
  4971. "200": {
  4972. "$ref": "#/responses/ReactionList"
  4973. },
  4974. "403": {
  4975. "$ref": "#/responses/forbidden"
  4976. }
  4977. }
  4978. },
  4979. "post": {
  4980. "consumes": [
  4981. "application/json"
  4982. ],
  4983. "produces": [
  4984. "application/json"
  4985. ],
  4986. "tags": [
  4987. "issue"
  4988. ],
  4989. "summary": "Add a reaction to an issue",
  4990. "operationId": "issuePostIssueReaction",
  4991. "parameters": [
  4992. {
  4993. "type": "string",
  4994. "description": "owner of the repo",
  4995. "name": "owner",
  4996. "in": "path",
  4997. "required": true
  4998. },
  4999. {
  5000. "type": "string",
  5001. "description": "name of the repo",
  5002. "name": "repo",
  5003. "in": "path",
  5004. "required": true
  5005. },
  5006. {
  5007. "type": "integer",
  5008. "format": "int64",
  5009. "description": "index of the issue",
  5010. "name": "index",
  5011. "in": "path",
  5012. "required": true
  5013. },
  5014. {
  5015. "name": "content",
  5016. "in": "body",
  5017. "schema": {
  5018. "$ref": "#/definitions/EditReactionOption"
  5019. }
  5020. }
  5021. ],
  5022. "responses": {
  5023. "200": {
  5024. "$ref": "#/responses/Reaction"
  5025. },
  5026. "201": {
  5027. "$ref": "#/responses/Reaction"
  5028. },
  5029. "403": {
  5030. "$ref": "#/responses/forbidden"
  5031. }
  5032. }
  5033. },
  5034. "delete": {
  5035. "consumes": [
  5036. "application/json"
  5037. ],
  5038. "produces": [
  5039. "application/json"
  5040. ],
  5041. "tags": [
  5042. "issue"
  5043. ],
  5044. "summary": "Remove a reaction from an issue",
  5045. "operationId": "issueDeleteIssueReaction",
  5046. "parameters": [
  5047. {
  5048. "type": "string",
  5049. "description": "owner of the repo",
  5050. "name": "owner",
  5051. "in": "path",
  5052. "required": true
  5053. },
  5054. {
  5055. "type": "string",
  5056. "description": "name of the repo",
  5057. "name": "repo",
  5058. "in": "path",
  5059. "required": true
  5060. },
  5061. {
  5062. "type": "integer",
  5063. "format": "int64",
  5064. "description": "index of the issue",
  5065. "name": "index",
  5066. "in": "path",
  5067. "required": true
  5068. },
  5069. {
  5070. "name": "content",
  5071. "in": "body",
  5072. "schema": {
  5073. "$ref": "#/definitions/EditReactionOption"
  5074. }
  5075. }
  5076. ],
  5077. "responses": {
  5078. "200": {
  5079. "$ref": "#/responses/empty"
  5080. },
  5081. "403": {
  5082. "$ref": "#/responses/forbidden"
  5083. }
  5084. }
  5085. }
  5086. },
  5087. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  5088. "delete": {
  5089. "consumes": [
  5090. "application/json"
  5091. ],
  5092. "produces": [
  5093. "application/json"
  5094. ],
  5095. "tags": [
  5096. "issue"
  5097. ],
  5098. "summary": "Delete an issue's existing stopwatch.",
  5099. "operationId": "issueDeleteStopWatch",
  5100. "parameters": [
  5101. {
  5102. "type": "string",
  5103. "description": "owner of the repo",
  5104. "name": "owner",
  5105. "in": "path",
  5106. "required": true
  5107. },
  5108. {
  5109. "type": "string",
  5110. "description": "name of the repo",
  5111. "name": "repo",
  5112. "in": "path",
  5113. "required": true
  5114. },
  5115. {
  5116. "type": "integer",
  5117. "format": "int64",
  5118. "description": "index of the issue to stop the stopwatch on",
  5119. "name": "index",
  5120. "in": "path",
  5121. "required": true
  5122. }
  5123. ],
  5124. "responses": {
  5125. "204": {
  5126. "$ref": "#/responses/empty"
  5127. },
  5128. "403": {
  5129. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5130. },
  5131. "404": {
  5132. "$ref": "#/responses/notFound"
  5133. },
  5134. "409": {
  5135. "description": "Cannot cancel a non existent stopwatch"
  5136. }
  5137. }
  5138. }
  5139. },
  5140. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  5141. "post": {
  5142. "consumes": [
  5143. "application/json"
  5144. ],
  5145. "produces": [
  5146. "application/json"
  5147. ],
  5148. "tags": [
  5149. "issue"
  5150. ],
  5151. "summary": "Start stopwatch on an issue.",
  5152. "operationId": "issueStartStopWatch",
  5153. "parameters": [
  5154. {
  5155. "type": "string",
  5156. "description": "owner of the repo",
  5157. "name": "owner",
  5158. "in": "path",
  5159. "required": true
  5160. },
  5161. {
  5162. "type": "string",
  5163. "description": "name of the repo",
  5164. "name": "repo",
  5165. "in": "path",
  5166. "required": true
  5167. },
  5168. {
  5169. "type": "integer",
  5170. "format": "int64",
  5171. "description": "index of the issue to create the stopwatch on",
  5172. "name": "index",
  5173. "in": "path",
  5174. "required": true
  5175. }
  5176. ],
  5177. "responses": {
  5178. "201": {
  5179. "$ref": "#/responses/empty"
  5180. },
  5181. "403": {
  5182. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5183. },
  5184. "404": {
  5185. "$ref": "#/responses/notFound"
  5186. },
  5187. "409": {
  5188. "description": "Cannot start a stopwatch again if it already exists"
  5189. }
  5190. }
  5191. }
  5192. },
  5193. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  5194. "post": {
  5195. "consumes": [
  5196. "application/json"
  5197. ],
  5198. "produces": [
  5199. "application/json"
  5200. ],
  5201. "tags": [
  5202. "issue"
  5203. ],
  5204. "summary": "Stop an issue's existing stopwatch.",
  5205. "operationId": "issueStopStopWatch",
  5206. "parameters": [
  5207. {
  5208. "type": "string",
  5209. "description": "owner of the repo",
  5210. "name": "owner",
  5211. "in": "path",
  5212. "required": true
  5213. },
  5214. {
  5215. "type": "string",
  5216. "description": "name of the repo",
  5217. "name": "repo",
  5218. "in": "path",
  5219. "required": true
  5220. },
  5221. {
  5222. "type": "integer",
  5223. "format": "int64",
  5224. "description": "index of the issue to stop the stopwatch on",
  5225. "name": "index",
  5226. "in": "path",
  5227. "required": true
  5228. }
  5229. ],
  5230. "responses": {
  5231. "201": {
  5232. "$ref": "#/responses/empty"
  5233. },
  5234. "403": {
  5235. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  5236. },
  5237. "404": {
  5238. "$ref": "#/responses/notFound"
  5239. },
  5240. "409": {
  5241. "description": "Cannot stop a non existent stopwatch"
  5242. }
  5243. }
  5244. }
  5245. },
  5246. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  5247. "get": {
  5248. "consumes": [
  5249. "application/json"
  5250. ],
  5251. "produces": [
  5252. "application/json"
  5253. ],
  5254. "tags": [
  5255. "issue"
  5256. ],
  5257. "summary": "Get users who subscribed on an issue.",
  5258. "operationId": "issueSubscriptions",
  5259. "parameters": [
  5260. {
  5261. "type": "string",
  5262. "description": "owner of the repo",
  5263. "name": "owner",
  5264. "in": "path",
  5265. "required": true
  5266. },
  5267. {
  5268. "type": "string",
  5269. "description": "name of the repo",
  5270. "name": "repo",
  5271. "in": "path",
  5272. "required": true
  5273. },
  5274. {
  5275. "type": "integer",
  5276. "format": "int64",
  5277. "description": "index of the issue",
  5278. "name": "index",
  5279. "in": "path",
  5280. "required": true
  5281. },
  5282. {
  5283. "type": "integer",
  5284. "description": "page number of results to return (1-based)",
  5285. "name": "page",
  5286. "in": "query"
  5287. },
  5288. {
  5289. "type": "integer",
  5290. "description": "page size of results",
  5291. "name": "limit",
  5292. "in": "query"
  5293. }
  5294. ],
  5295. "responses": {
  5296. "200": {
  5297. "$ref": "#/responses/UserList"
  5298. },
  5299. "404": {
  5300. "$ref": "#/responses/notFound"
  5301. }
  5302. }
  5303. }
  5304. },
  5305. "/repos/{owner}/{repo}/issues/{index}/subscriptions/check": {
  5306. "get": {
  5307. "consumes": [
  5308. "application/json"
  5309. ],
  5310. "produces": [
  5311. "application/json"
  5312. ],
  5313. "tags": [
  5314. "issue"
  5315. ],
  5316. "summary": "Check if user is subscribed to an issue",
  5317. "operationId": "issueCheckSubscription",
  5318. "parameters": [
  5319. {
  5320. "type": "string",
  5321. "description": "owner of the repo",
  5322. "name": "owner",
  5323. "in": "path",
  5324. "required": true
  5325. },
  5326. {
  5327. "type": "string",
  5328. "description": "name of the repo",
  5329. "name": "repo",
  5330. "in": "path",
  5331. "required": true
  5332. },
  5333. {
  5334. "type": "integer",
  5335. "format": "int64",
  5336. "description": "index of the issue",
  5337. "name": "index",
  5338. "in": "path",
  5339. "required": true
  5340. }
  5341. ],
  5342. "responses": {
  5343. "200": {
  5344. "$ref": "#/responses/WatchInfo"
  5345. },
  5346. "404": {
  5347. "$ref": "#/responses/notFound"
  5348. }
  5349. }
  5350. }
  5351. },
  5352. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  5353. "put": {
  5354. "consumes": [
  5355. "application/json"
  5356. ],
  5357. "produces": [
  5358. "application/json"
  5359. ],
  5360. "tags": [
  5361. "issue"
  5362. ],
  5363. "summary": "Subscribe user to issue",
  5364. "operationId": "issueAddSubscription",
  5365. "parameters": [
  5366. {
  5367. "type": "string",
  5368. "description": "owner of the repo",
  5369. "name": "owner",
  5370. "in": "path",
  5371. "required": true
  5372. },
  5373. {
  5374. "type": "string",
  5375. "description": "name of the repo",
  5376. "name": "repo",
  5377. "in": "path",
  5378. "required": true
  5379. },
  5380. {
  5381. "type": "integer",
  5382. "format": "int64",
  5383. "description": "index of the issue",
  5384. "name": "index",
  5385. "in": "path",
  5386. "required": true
  5387. },
  5388. {
  5389. "type": "string",
  5390. "description": "user to subscribe",
  5391. "name": "user",
  5392. "in": "path",
  5393. "required": true
  5394. }
  5395. ],
  5396. "responses": {
  5397. "200": {
  5398. "description": "Already subscribed"
  5399. },
  5400. "201": {
  5401. "description": "Successfully Subscribed"
  5402. },
  5403. "304": {
  5404. "description": "User can only subscribe itself if he is no admin"
  5405. },
  5406. "404": {
  5407. "$ref": "#/responses/notFound"
  5408. }
  5409. }
  5410. },
  5411. "delete": {
  5412. "consumes": [
  5413. "application/json"
  5414. ],
  5415. "produces": [
  5416. "application/json"
  5417. ],
  5418. "tags": [
  5419. "issue"
  5420. ],
  5421. "summary": "Unsubscribe user from issue",
  5422. "operationId": "issueDeleteSubscription",
  5423. "parameters": [
  5424. {
  5425. "type": "string",
  5426. "description": "owner of the repo",
  5427. "name": "owner",
  5428. "in": "path",
  5429. "required": true
  5430. },
  5431. {
  5432. "type": "string",
  5433. "description": "name of the repo",
  5434. "name": "repo",
  5435. "in": "path",
  5436. "required": true
  5437. },
  5438. {
  5439. "type": "integer",
  5440. "format": "int64",
  5441. "description": "index of the issue",
  5442. "name": "index",
  5443. "in": "path",
  5444. "required": true
  5445. },
  5446. {
  5447. "type": "string",
  5448. "description": "user witch unsubscribe",
  5449. "name": "user",
  5450. "in": "path",
  5451. "required": true
  5452. }
  5453. ],
  5454. "responses": {
  5455. "200": {
  5456. "description": "Already unsubscribed"
  5457. },
  5458. "201": {
  5459. "description": "Successfully Unsubscribed"
  5460. },
  5461. "304": {
  5462. "description": "User can only subscribe itself if he is no admin"
  5463. },
  5464. "404": {
  5465. "$ref": "#/responses/notFound"
  5466. }
  5467. }
  5468. }
  5469. },
  5470. "/repos/{owner}/{repo}/issues/{index}/times": {
  5471. "get": {
  5472. "produces": [
  5473. "application/json"
  5474. ],
  5475. "tags": [
  5476. "issue"
  5477. ],
  5478. "summary": "List an issue's tracked times",
  5479. "operationId": "issueTrackedTimes",
  5480. "parameters": [
  5481. {
  5482. "type": "string",
  5483. "description": "owner of the repo",
  5484. "name": "owner",
  5485. "in": "path",
  5486. "required": true
  5487. },
  5488. {
  5489. "type": "string",
  5490. "description": "name of the repo",
  5491. "name": "repo",
  5492. "in": "path",
  5493. "required": true
  5494. },
  5495. {
  5496. "type": "integer",
  5497. "format": "int64",
  5498. "description": "index of the issue",
  5499. "name": "index",
  5500. "in": "path",
  5501. "required": true
  5502. },
  5503. {
  5504. "type": "string",
  5505. "format": "date-time",
  5506. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  5507. "name": "since",
  5508. "in": "query"
  5509. },
  5510. {
  5511. "type": "string",
  5512. "format": "date-time",
  5513. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  5514. "name": "before",
  5515. "in": "query"
  5516. },
  5517. {
  5518. "type": "integer",
  5519. "description": "page number of results to return (1-based)",
  5520. "name": "page",
  5521. "in": "query"
  5522. },
  5523. {
  5524. "type": "integer",
  5525. "description": "page size of results",
  5526. "name": "limit",
  5527. "in": "query"
  5528. }
  5529. ],
  5530. "responses": {
  5531. "200": {
  5532. "$ref": "#/responses/TrackedTimeList"
  5533. },
  5534. "404": {
  5535. "$ref": "#/responses/notFound"
  5536. }
  5537. }
  5538. },
  5539. "post": {
  5540. "consumes": [
  5541. "application/json"
  5542. ],
  5543. "produces": [
  5544. "application/json"
  5545. ],
  5546. "tags": [
  5547. "issue"
  5548. ],
  5549. "summary": "Add tracked time to a issue",
  5550. "operationId": "issueAddTime",
  5551. "parameters": [
  5552. {
  5553. "type": "string",
  5554. "description": "owner of the repo",
  5555. "name": "owner",
  5556. "in": "path",
  5557. "required": true
  5558. },
  5559. {
  5560. "type": "string",
  5561. "description": "name of the repo",
  5562. "name": "repo",
  5563. "in": "path",
  5564. "required": true
  5565. },
  5566. {
  5567. "type": "integer",
  5568. "format": "int64",
  5569. "description": "index of the issue",
  5570. "name": "index",
  5571. "in": "path",
  5572. "required": true
  5573. },
  5574. {
  5575. "name": "body",
  5576. "in": "body",
  5577. "schema": {
  5578. "$ref": "#/definitions/AddTimeOption"
  5579. }
  5580. }
  5581. ],
  5582. "responses": {
  5583. "200": {
  5584. "$ref": "#/responses/TrackedTime"
  5585. },
  5586. "400": {
  5587. "$ref": "#/responses/error"
  5588. },
  5589. "403": {
  5590. "$ref": "#/responses/forbidden"
  5591. }
  5592. }
  5593. },
  5594. "delete": {
  5595. "consumes": [
  5596. "application/json"
  5597. ],
  5598. "produces": [
  5599. "application/json"
  5600. ],
  5601. "tags": [
  5602. "issue"
  5603. ],
  5604. "summary": "Reset a tracked time of an issue",
  5605. "operationId": "issueResetTime",
  5606. "parameters": [
  5607. {
  5608. "type": "string",
  5609. "description": "owner of the repo",
  5610. "name": "owner",
  5611. "in": "path",
  5612. "required": true
  5613. },
  5614. {
  5615. "type": "string",
  5616. "description": "name of the repo",
  5617. "name": "repo",
  5618. "in": "path",
  5619. "required": true
  5620. },
  5621. {
  5622. "type": "integer",
  5623. "format": "int64",
  5624. "description": "index of the issue to add tracked time to",
  5625. "name": "index",
  5626. "in": "path",
  5627. "required": true
  5628. }
  5629. ],
  5630. "responses": {
  5631. "204": {
  5632. "$ref": "#/responses/empty"
  5633. },
  5634. "400": {
  5635. "$ref": "#/responses/error"
  5636. },
  5637. "403": {
  5638. "$ref": "#/responses/forbidden"
  5639. }
  5640. }
  5641. }
  5642. },
  5643. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5644. "delete": {
  5645. "consumes": [
  5646. "application/json"
  5647. ],
  5648. "produces": [
  5649. "application/json"
  5650. ],
  5651. "tags": [
  5652. "issue"
  5653. ],
  5654. "summary": "Delete specific tracked time",
  5655. "operationId": "issueDeleteTime",
  5656. "parameters": [
  5657. {
  5658. "type": "string",
  5659. "description": "owner of the repo",
  5660. "name": "owner",
  5661. "in": "path",
  5662. "required": true
  5663. },
  5664. {
  5665. "type": "string",
  5666. "description": "name of the repo",
  5667. "name": "repo",
  5668. "in": "path",
  5669. "required": true
  5670. },
  5671. {
  5672. "type": "integer",
  5673. "format": "int64",
  5674. "description": "index of the issue",
  5675. "name": "index",
  5676. "in": "path",
  5677. "required": true
  5678. },
  5679. {
  5680. "type": "integer",
  5681. "format": "int64",
  5682. "description": "id of time to delete",
  5683. "name": "id",
  5684. "in": "path",
  5685. "required": true
  5686. }
  5687. ],
  5688. "responses": {
  5689. "204": {
  5690. "$ref": "#/responses/empty"
  5691. },
  5692. "400": {
  5693. "$ref": "#/responses/error"
  5694. },
  5695. "403": {
  5696. "$ref": "#/responses/forbidden"
  5697. }
  5698. }
  5699. }
  5700. },
  5701. "/repos/{owner}/{repo}/keys": {
  5702. "get": {
  5703. "produces": [
  5704. "application/json"
  5705. ],
  5706. "tags": [
  5707. "repository"
  5708. ],
  5709. "summary": "List a repository's keys",
  5710. "operationId": "repoListKeys",
  5711. "parameters": [
  5712. {
  5713. "type": "string",
  5714. "description": "owner of the repo",
  5715. "name": "owner",
  5716. "in": "path",
  5717. "required": true
  5718. },
  5719. {
  5720. "type": "string",
  5721. "description": "name of the repo",
  5722. "name": "repo",
  5723. "in": "path",
  5724. "required": true
  5725. },
  5726. {
  5727. "type": "integer",
  5728. "description": "the key_id to search for",
  5729. "name": "key_id",
  5730. "in": "query"
  5731. },
  5732. {
  5733. "type": "string",
  5734. "description": "fingerprint of the key",
  5735. "name": "fingerprint",
  5736. "in": "query"
  5737. },
  5738. {
  5739. "type": "integer",
  5740. "description": "page number of results to return (1-based)",
  5741. "name": "page",
  5742. "in": "query"
  5743. },
  5744. {
  5745. "type": "integer",
  5746. "description": "page size of results",
  5747. "name": "limit",
  5748. "in": "query"
  5749. }
  5750. ],
  5751. "responses": {
  5752. "200": {
  5753. "$ref": "#/responses/DeployKeyList"
  5754. }
  5755. }
  5756. },
  5757. "post": {
  5758. "consumes": [
  5759. "application/json"
  5760. ],
  5761. "produces": [
  5762. "application/json"
  5763. ],
  5764. "tags": [
  5765. "repository"
  5766. ],
  5767. "summary": "Add a key to a repository",
  5768. "operationId": "repoCreateKey",
  5769. "parameters": [
  5770. {
  5771. "type": "string",
  5772. "description": "owner of the repo",
  5773. "name": "owner",
  5774. "in": "path",
  5775. "required": true
  5776. },
  5777. {
  5778. "type": "string",
  5779. "description": "name of the repo",
  5780. "name": "repo",
  5781. "in": "path",
  5782. "required": true
  5783. },
  5784. {
  5785. "name": "body",
  5786. "in": "body",
  5787. "schema": {
  5788. "$ref": "#/definitions/CreateKeyOption"
  5789. }
  5790. }
  5791. ],
  5792. "responses": {
  5793. "201": {
  5794. "$ref": "#/responses/DeployKey"
  5795. },
  5796. "422": {
  5797. "$ref": "#/responses/validationError"
  5798. }
  5799. }
  5800. }
  5801. },
  5802. "/repos/{owner}/{repo}/keys/{id}": {
  5803. "get": {
  5804. "produces": [
  5805. "application/json"
  5806. ],
  5807. "tags": [
  5808. "repository"
  5809. ],
  5810. "summary": "Get a repository's key by id",
  5811. "operationId": "repoGetKey",
  5812. "parameters": [
  5813. {
  5814. "type": "string",
  5815. "description": "owner of the repo",
  5816. "name": "owner",
  5817. "in": "path",
  5818. "required": true
  5819. },
  5820. {
  5821. "type": "string",
  5822. "description": "name of the repo",
  5823. "name": "repo",
  5824. "in": "path",
  5825. "required": true
  5826. },
  5827. {
  5828. "type": "integer",
  5829. "format": "int64",
  5830. "description": "id of the key to get",
  5831. "name": "id",
  5832. "in": "path",
  5833. "required": true
  5834. }
  5835. ],
  5836. "responses": {
  5837. "200": {
  5838. "$ref": "#/responses/DeployKey"
  5839. }
  5840. }
  5841. },
  5842. "delete": {
  5843. "tags": [
  5844. "repository"
  5845. ],
  5846. "summary": "Delete a key from a repository",
  5847. "operationId": "repoDeleteKey",
  5848. "parameters": [
  5849. {
  5850. "type": "string",
  5851. "description": "owner of the repo",
  5852. "name": "owner",
  5853. "in": "path",
  5854. "required": true
  5855. },
  5856. {
  5857. "type": "string",
  5858. "description": "name of the repo",
  5859. "name": "repo",
  5860. "in": "path",
  5861. "required": true
  5862. },
  5863. {
  5864. "type": "integer",
  5865. "format": "int64",
  5866. "description": "id of the key to delete",
  5867. "name": "id",
  5868. "in": "path",
  5869. "required": true
  5870. }
  5871. ],
  5872. "responses": {
  5873. "204": {
  5874. "$ref": "#/responses/empty"
  5875. },
  5876. "403": {
  5877. "$ref": "#/responses/forbidden"
  5878. }
  5879. }
  5880. }
  5881. },
  5882. "/repos/{owner}/{repo}/labels": {
  5883. "get": {
  5884. "produces": [
  5885. "application/json"
  5886. ],
  5887. "tags": [
  5888. "issue"
  5889. ],
  5890. "summary": "Get all of a repository's labels",
  5891. "operationId": "issueListLabels",
  5892. "parameters": [
  5893. {
  5894. "type": "string",
  5895. "description": "owner of the repo",
  5896. "name": "owner",
  5897. "in": "path",
  5898. "required": true
  5899. },
  5900. {
  5901. "type": "string",
  5902. "description": "name of the repo",
  5903. "name": "repo",
  5904. "in": "path",
  5905. "required": true
  5906. },
  5907. {
  5908. "type": "integer",
  5909. "description": "page number of results to return (1-based)",
  5910. "name": "page",
  5911. "in": "query"
  5912. },
  5913. {
  5914. "type": "integer",
  5915. "description": "page size of results",
  5916. "name": "limit",
  5917. "in": "query"
  5918. }
  5919. ],
  5920. "responses": {
  5921. "200": {
  5922. "$ref": "#/responses/LabelList"
  5923. }
  5924. }
  5925. },
  5926. "post": {
  5927. "consumes": [
  5928. "application/json"
  5929. ],
  5930. "produces": [
  5931. "application/json"
  5932. ],
  5933. "tags": [
  5934. "issue"
  5935. ],
  5936. "summary": "Create a label",
  5937. "operationId": "issueCreateLabel",
  5938. "parameters": [
  5939. {
  5940. "type": "string",
  5941. "description": "owner of the repo",
  5942. "name": "owner",
  5943. "in": "path",
  5944. "required": true
  5945. },
  5946. {
  5947. "type": "string",
  5948. "description": "name of the repo",
  5949. "name": "repo",
  5950. "in": "path",
  5951. "required": true
  5952. },
  5953. {
  5954. "name": "body",
  5955. "in": "body",
  5956. "schema": {
  5957. "$ref": "#/definitions/CreateLabelOption"
  5958. }
  5959. }
  5960. ],
  5961. "responses": {
  5962. "201": {
  5963. "$ref": "#/responses/Label"
  5964. },
  5965. "422": {
  5966. "$ref": "#/responses/validationError"
  5967. }
  5968. }
  5969. }
  5970. },
  5971. "/repos/{owner}/{repo}/labels/{id}": {
  5972. "get": {
  5973. "produces": [
  5974. "application/json"
  5975. ],
  5976. "tags": [
  5977. "issue"
  5978. ],
  5979. "summary": "Get a single label",
  5980. "operationId": "issueGetLabel",
  5981. "parameters": [
  5982. {
  5983. "type": "string",
  5984. "description": "owner of the repo",
  5985. "name": "owner",
  5986. "in": "path",
  5987. "required": true
  5988. },
  5989. {
  5990. "type": "string",
  5991. "description": "name of the repo",
  5992. "name": "repo",
  5993. "in": "path",
  5994. "required": true
  5995. },
  5996. {
  5997. "type": "integer",
  5998. "format": "int64",
  5999. "description": "id of the label to get",
  6000. "name": "id",
  6001. "in": "path",
  6002. "required": true
  6003. }
  6004. ],
  6005. "responses": {
  6006. "200": {
  6007. "$ref": "#/responses/Label"
  6008. }
  6009. }
  6010. },
  6011. "delete": {
  6012. "tags": [
  6013. "issue"
  6014. ],
  6015. "summary": "Delete a label",
  6016. "operationId": "issueDeleteLabel",
  6017. "parameters": [
  6018. {
  6019. "type": "string",
  6020. "description": "owner of the repo",
  6021. "name": "owner",
  6022. "in": "path",
  6023. "required": true
  6024. },
  6025. {
  6026. "type": "string",
  6027. "description": "name of the repo",
  6028. "name": "repo",
  6029. "in": "path",
  6030. "required": true
  6031. },
  6032. {
  6033. "type": "integer",
  6034. "format": "int64",
  6035. "description": "id of the label to delete",
  6036. "name": "id",
  6037. "in": "path",
  6038. "required": true
  6039. }
  6040. ],
  6041. "responses": {
  6042. "204": {
  6043. "$ref": "#/responses/empty"
  6044. }
  6045. }
  6046. },
  6047. "patch": {
  6048. "consumes": [
  6049. "application/json"
  6050. ],
  6051. "produces": [
  6052. "application/json"
  6053. ],
  6054. "tags": [
  6055. "issue"
  6056. ],
  6057. "summary": "Update a label",
  6058. "operationId": "issueEditLabel",
  6059. "parameters": [
  6060. {
  6061. "type": "string",
  6062. "description": "owner of the repo",
  6063. "name": "owner",
  6064. "in": "path",
  6065. "required": true
  6066. },
  6067. {
  6068. "type": "string",
  6069. "description": "name of the repo",
  6070. "name": "repo",
  6071. "in": "path",
  6072. "required": true
  6073. },
  6074. {
  6075. "type": "integer",
  6076. "format": "int64",
  6077. "description": "id of the label to edit",
  6078. "name": "id",
  6079. "in": "path",
  6080. "required": true
  6081. },
  6082. {
  6083. "name": "body",
  6084. "in": "body",
  6085. "schema": {
  6086. "$ref": "#/definitions/EditLabelOption"
  6087. }
  6088. }
  6089. ],
  6090. "responses": {
  6091. "200": {
  6092. "$ref": "#/responses/Label"
  6093. },
  6094. "422": {
  6095. "$ref": "#/responses/validationError"
  6096. }
  6097. }
  6098. }
  6099. },
  6100. "/repos/{owner}/{repo}/languages": {
  6101. "get": {
  6102. "produces": [
  6103. "application/json"
  6104. ],
  6105. "tags": [
  6106. "repository"
  6107. ],
  6108. "summary": "Get languages and number of bytes of code written",
  6109. "operationId": "repoGetLanguages",
  6110. "parameters": [
  6111. {
  6112. "type": "string",
  6113. "description": "owner of the repo",
  6114. "name": "owner",
  6115. "in": "path",
  6116. "required": true
  6117. },
  6118. {
  6119. "type": "string",
  6120. "description": "name of the repo",
  6121. "name": "repo",
  6122. "in": "path",
  6123. "required": true
  6124. }
  6125. ],
  6126. "responses": {
  6127. "200": {
  6128. "$ref": "#/responses/LanguageStatistics"
  6129. },
  6130. "404": {
  6131. "$ref": "#/responses/notFound"
  6132. }
  6133. }
  6134. }
  6135. },
  6136. "/repos/{owner}/{repo}/milestones": {
  6137. "get": {
  6138. "produces": [
  6139. "application/json"
  6140. ],
  6141. "tags": [
  6142. "issue"
  6143. ],
  6144. "summary": "Get all of a repository's opened milestones",
  6145. "operationId": "issueGetMilestonesList",
  6146. "parameters": [
  6147. {
  6148. "type": "string",
  6149. "description": "owner of the repo",
  6150. "name": "owner",
  6151. "in": "path",
  6152. "required": true
  6153. },
  6154. {
  6155. "type": "string",
  6156. "description": "name of the repo",
  6157. "name": "repo",
  6158. "in": "path",
  6159. "required": true
  6160. },
  6161. {
  6162. "type": "string",
  6163. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  6164. "name": "state",
  6165. "in": "query"
  6166. },
  6167. {
  6168. "type": "integer",
  6169. "description": "page number of results to return (1-based)",
  6170. "name": "page",
  6171. "in": "query"
  6172. },
  6173. {
  6174. "type": "integer",
  6175. "description": "page size of results",
  6176. "name": "limit",
  6177. "in": "query"
  6178. }
  6179. ],
  6180. "responses": {
  6181. "200": {
  6182. "$ref": "#/responses/MilestoneList"
  6183. }
  6184. }
  6185. },
  6186. "post": {
  6187. "consumes": [
  6188. "application/json"
  6189. ],
  6190. "produces": [
  6191. "application/json"
  6192. ],
  6193. "tags": [
  6194. "issue"
  6195. ],
  6196. "summary": "Create a milestone",
  6197. "operationId": "issueCreateMilestone",
  6198. "parameters": [
  6199. {
  6200. "type": "string",
  6201. "description": "owner of the repo",
  6202. "name": "owner",
  6203. "in": "path",
  6204. "required": true
  6205. },
  6206. {
  6207. "type": "string",
  6208. "description": "name of the repo",
  6209. "name": "repo",
  6210. "in": "path",
  6211. "required": true
  6212. },
  6213. {
  6214. "name": "body",
  6215. "in": "body",
  6216. "schema": {
  6217. "$ref": "#/definitions/CreateMilestoneOption"
  6218. }
  6219. }
  6220. ],
  6221. "responses": {
  6222. "201": {
  6223. "$ref": "#/responses/Milestone"
  6224. }
  6225. }
  6226. }
  6227. },
  6228. "/repos/{owner}/{repo}/milestones/{id}": {
  6229. "get": {
  6230. "produces": [
  6231. "application/json"
  6232. ],
  6233. "tags": [
  6234. "issue"
  6235. ],
  6236. "summary": "Get a milestone",
  6237. "operationId": "issueGetMilestone",
  6238. "parameters": [
  6239. {
  6240. "type": "string",
  6241. "description": "owner of the repo",
  6242. "name": "owner",
  6243. "in": "path",
  6244. "required": true
  6245. },
  6246. {
  6247. "type": "string",
  6248. "description": "name of the repo",
  6249. "name": "repo",
  6250. "in": "path",
  6251. "required": true
  6252. },
  6253. {
  6254. "type": "integer",
  6255. "format": "int64",
  6256. "description": "id of the milestone",
  6257. "name": "id",
  6258. "in": "path",
  6259. "required": true
  6260. }
  6261. ],
  6262. "responses": {
  6263. "200": {
  6264. "$ref": "#/responses/Milestone"
  6265. }
  6266. }
  6267. },
  6268. "delete": {
  6269. "tags": [
  6270. "issue"
  6271. ],
  6272. "summary": "Delete a milestone",
  6273. "operationId": "issueDeleteMilestone",
  6274. "parameters": [
  6275. {
  6276. "type": "string",
  6277. "description": "owner of the repo",
  6278. "name": "owner",
  6279. "in": "path",
  6280. "required": true
  6281. },
  6282. {
  6283. "type": "string",
  6284. "description": "name of the repo",
  6285. "name": "repo",
  6286. "in": "path",
  6287. "required": true
  6288. },
  6289. {
  6290. "type": "integer",
  6291. "format": "int64",
  6292. "description": "id of the milestone to delete",
  6293. "name": "id",
  6294. "in": "path",
  6295. "required": true
  6296. }
  6297. ],
  6298. "responses": {
  6299. "204": {
  6300. "$ref": "#/responses/empty"
  6301. }
  6302. }
  6303. },
  6304. "patch": {
  6305. "consumes": [
  6306. "application/json"
  6307. ],
  6308. "produces": [
  6309. "application/json"
  6310. ],
  6311. "tags": [
  6312. "issue"
  6313. ],
  6314. "summary": "Update a milestone",
  6315. "operationId": "issueEditMilestone",
  6316. "parameters": [
  6317. {
  6318. "type": "string",
  6319. "description": "owner of the repo",
  6320. "name": "owner",
  6321. "in": "path",
  6322. "required": true
  6323. },
  6324. {
  6325. "type": "string",
  6326. "description": "name of the repo",
  6327. "name": "repo",
  6328. "in": "path",
  6329. "required": true
  6330. },
  6331. {
  6332. "type": "integer",
  6333. "format": "int64",
  6334. "description": "id of the milestone",
  6335. "name": "id",
  6336. "in": "path",
  6337. "required": true
  6338. },
  6339. {
  6340. "name": "body",
  6341. "in": "body",
  6342. "schema": {
  6343. "$ref": "#/definitions/EditMilestoneOption"
  6344. }
  6345. }
  6346. ],
  6347. "responses": {
  6348. "200": {
  6349. "$ref": "#/responses/Milestone"
  6350. }
  6351. }
  6352. }
  6353. },
  6354. "/repos/{owner}/{repo}/mirror-sync": {
  6355. "post": {
  6356. "produces": [
  6357. "application/json"
  6358. ],
  6359. "tags": [
  6360. "repository"
  6361. ],
  6362. "summary": "Sync a mirrored repository",
  6363. "operationId": "repoMirrorSync",
  6364. "parameters": [
  6365. {
  6366. "type": "string",
  6367. "description": "owner of the repo to sync",
  6368. "name": "owner",
  6369. "in": "path",
  6370. "required": true
  6371. },
  6372. {
  6373. "type": "string",
  6374. "description": "name of the repo to sync",
  6375. "name": "repo",
  6376. "in": "path",
  6377. "required": true
  6378. }
  6379. ],
  6380. "responses": {
  6381. "200": {
  6382. "$ref": "#/responses/empty"
  6383. },
  6384. "403": {
  6385. "$ref": "#/responses/forbidden"
  6386. }
  6387. }
  6388. }
  6389. },
  6390. "/repos/{owner}/{repo}/notifications": {
  6391. "get": {
  6392. "consumes": [
  6393. "application/json"
  6394. ],
  6395. "produces": [
  6396. "application/json"
  6397. ],
  6398. "tags": [
  6399. "notification"
  6400. ],
  6401. "summary": "List users's notification threads on a specific repo",
  6402. "operationId": "notifyGetRepoList",
  6403. "parameters": [
  6404. {
  6405. "type": "string",
  6406. "description": "owner of the repo",
  6407. "name": "owner",
  6408. "in": "path",
  6409. "required": true
  6410. },
  6411. {
  6412. "type": "string",
  6413. "description": "name of the repo",
  6414. "name": "repo",
  6415. "in": "path",
  6416. "required": true
  6417. },
  6418. {
  6419. "type": "string",
  6420. "description": "If true, show notifications marked as read. Default value is false",
  6421. "name": "all",
  6422. "in": "query"
  6423. },
  6424. {
  6425. "type": "array",
  6426. "items": {
  6427. "type": "string"
  6428. },
  6429. "collectionFormat": "multi",
  6430. "description": "Show notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread \u0026 pinned",
  6431. "name": "status-types",
  6432. "in": "query"
  6433. },
  6434. {
  6435. "type": "string",
  6436. "format": "date-time",
  6437. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  6438. "name": "since",
  6439. "in": "query"
  6440. },
  6441. {
  6442. "type": "string",
  6443. "format": "date-time",
  6444. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  6445. "name": "before",
  6446. "in": "query"
  6447. },
  6448. {
  6449. "type": "integer",
  6450. "description": "page number of results to return (1-based)",
  6451. "name": "page",
  6452. "in": "query"
  6453. },
  6454. {
  6455. "type": "integer",
  6456. "description": "page size of results",
  6457. "name": "limit",
  6458. "in": "query"
  6459. }
  6460. ],
  6461. "responses": {
  6462. "200": {
  6463. "$ref": "#/responses/NotificationThreadList"
  6464. }
  6465. }
  6466. },
  6467. "put": {
  6468. "consumes": [
  6469. "application/json"
  6470. ],
  6471. "produces": [
  6472. "application/json"
  6473. ],
  6474. "tags": [
  6475. "notification"
  6476. ],
  6477. "summary": "Mark notification threads as read, pinned or unread on a specific repo",
  6478. "operationId": "notifyReadRepoList",
  6479. "parameters": [
  6480. {
  6481. "type": "string",
  6482. "description": "owner of the repo",
  6483. "name": "owner",
  6484. "in": "path",
  6485. "required": true
  6486. },
  6487. {
  6488. "type": "string",
  6489. "description": "name of the repo",
  6490. "name": "repo",
  6491. "in": "path",
  6492. "required": true
  6493. },
  6494. {
  6495. "type": "string",
  6496. "description": "If true, mark all notifications on this repo. Default value is false",
  6497. "name": "all",
  6498. "in": "query"
  6499. },
  6500. {
  6501. "type": "array",
  6502. "items": {
  6503. "type": "string"
  6504. },
  6505. "collectionFormat": "multi",
  6506. "description": "Mark notifications with the provided status types. Options are: unread, read and/or pinned. Defaults to unread.",
  6507. "name": "status-types",
  6508. "in": "query"
  6509. },
  6510. {
  6511. "type": "string",
  6512. "description": "Status to mark notifications as. Defaults to read.",
  6513. "name": "to-status",
  6514. "in": "query"
  6515. },
  6516. {
  6517. "type": "string",
  6518. "format": "date-time",
  6519. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  6520. "name": "last_read_at",
  6521. "in": "query"
  6522. }
  6523. ],
  6524. "responses": {
  6525. "205": {
  6526. "$ref": "#/responses/empty"
  6527. }
  6528. }
  6529. }
  6530. },
  6531. "/repos/{owner}/{repo}/pulls": {
  6532. "get": {
  6533. "produces": [
  6534. "application/json"
  6535. ],
  6536. "tags": [
  6537. "repository"
  6538. ],
  6539. "summary": "List a repo's pull requests",
  6540. "operationId": "repoListPullRequests",
  6541. "parameters": [
  6542. {
  6543. "type": "string",
  6544. "description": "owner of the repo",
  6545. "name": "owner",
  6546. "in": "path",
  6547. "required": true
  6548. },
  6549. {
  6550. "type": "string",
  6551. "description": "name of the repo",
  6552. "name": "repo",
  6553. "in": "path",
  6554. "required": true
  6555. },
  6556. {
  6557. "enum": [
  6558. "closed",
  6559. "open",
  6560. "all"
  6561. ],
  6562. "type": "string",
  6563. "description": "State of pull request: open or closed (optional)",
  6564. "name": "state",
  6565. "in": "query"
  6566. },
  6567. {
  6568. "enum": [
  6569. "oldest",
  6570. "recentupdate",
  6571. "leastupdate",
  6572. "mostcomment",
  6573. "leastcomment",
  6574. "priority"
  6575. ],
  6576. "type": "string",
  6577. "description": "Type of sort",
  6578. "name": "sort",
  6579. "in": "query"
  6580. },
  6581. {
  6582. "type": "integer",
  6583. "format": "int64",
  6584. "description": "ID of the milestone",
  6585. "name": "milestone",
  6586. "in": "query"
  6587. },
  6588. {
  6589. "type": "array",
  6590. "items": {
  6591. "type": "integer",
  6592. "format": "int64"
  6593. },
  6594. "collectionFormat": "multi",
  6595. "description": "Label IDs",
  6596. "name": "labels",
  6597. "in": "query"
  6598. },
  6599. {
  6600. "type": "integer",
  6601. "description": "page number of results to return (1-based)",
  6602. "name": "page",
  6603. "in": "query"
  6604. },
  6605. {
  6606. "type": "integer",
  6607. "description": "page size of results",
  6608. "name": "limit",
  6609. "in": "query"
  6610. }
  6611. ],
  6612. "responses": {
  6613. "200": {
  6614. "$ref": "#/responses/PullRequestList"
  6615. }
  6616. }
  6617. },
  6618. "post": {
  6619. "consumes": [
  6620. "application/json"
  6621. ],
  6622. "produces": [
  6623. "application/json"
  6624. ],
  6625. "tags": [
  6626. "repository"
  6627. ],
  6628. "summary": "Create a pull request",
  6629. "operationId": "repoCreatePullRequest",
  6630. "parameters": [
  6631. {
  6632. "type": "string",
  6633. "description": "owner of the repo",
  6634. "name": "owner",
  6635. "in": "path",
  6636. "required": true
  6637. },
  6638. {
  6639. "type": "string",
  6640. "description": "name of the repo",
  6641. "name": "repo",
  6642. "in": "path",
  6643. "required": true
  6644. },
  6645. {
  6646. "name": "body",
  6647. "in": "body",
  6648. "schema": {
  6649. "$ref": "#/definitions/CreatePullRequestOption"
  6650. }
  6651. }
  6652. ],
  6653. "responses": {
  6654. "201": {
  6655. "$ref": "#/responses/PullRequest"
  6656. },
  6657. "409": {
  6658. "$ref": "#/responses/error"
  6659. },
  6660. "422": {
  6661. "$ref": "#/responses/validationError"
  6662. }
  6663. }
  6664. }
  6665. },
  6666. "/repos/{owner}/{repo}/pulls/{index}": {
  6667. "get": {
  6668. "produces": [
  6669. "application/json"
  6670. ],
  6671. "tags": [
  6672. "repository"
  6673. ],
  6674. "summary": "Get a pull request",
  6675. "operationId": "repoGetPullRequest",
  6676. "parameters": [
  6677. {
  6678. "type": "string",
  6679. "description": "owner of the repo",
  6680. "name": "owner",
  6681. "in": "path",
  6682. "required": true
  6683. },
  6684. {
  6685. "type": "string",
  6686. "description": "name of the repo",
  6687. "name": "repo",
  6688. "in": "path",
  6689. "required": true
  6690. },
  6691. {
  6692. "type": "integer",
  6693. "format": "int64",
  6694. "description": "index of the pull request to get",
  6695. "name": "index",
  6696. "in": "path",
  6697. "required": true
  6698. }
  6699. ],
  6700. "responses": {
  6701. "200": {
  6702. "$ref": "#/responses/PullRequest"
  6703. },
  6704. "404": {
  6705. "$ref": "#/responses/notFound"
  6706. }
  6707. }
  6708. },
  6709. "patch": {
  6710. "consumes": [
  6711. "application/json"
  6712. ],
  6713. "produces": [
  6714. "application/json"
  6715. ],
  6716. "tags": [
  6717. "repository"
  6718. ],
  6719. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6720. "operationId": "repoEditPullRequest",
  6721. "parameters": [
  6722. {
  6723. "type": "string",
  6724. "description": "owner of the repo",
  6725. "name": "owner",
  6726. "in": "path",
  6727. "required": true
  6728. },
  6729. {
  6730. "type": "string",
  6731. "description": "name of the repo",
  6732. "name": "repo",
  6733. "in": "path",
  6734. "required": true
  6735. },
  6736. {
  6737. "type": "integer",
  6738. "format": "int64",
  6739. "description": "index of the pull request to edit",
  6740. "name": "index",
  6741. "in": "path",
  6742. "required": true
  6743. },
  6744. {
  6745. "name": "body",
  6746. "in": "body",
  6747. "schema": {
  6748. "$ref": "#/definitions/EditPullRequestOption"
  6749. }
  6750. }
  6751. ],
  6752. "responses": {
  6753. "201": {
  6754. "$ref": "#/responses/PullRequest"
  6755. },
  6756. "403": {
  6757. "$ref": "#/responses/forbidden"
  6758. },
  6759. "409": {
  6760. "$ref": "#/responses/error"
  6761. },
  6762. "412": {
  6763. "$ref": "#/responses/error"
  6764. },
  6765. "422": {
  6766. "$ref": "#/responses/validationError"
  6767. }
  6768. }
  6769. }
  6770. },
  6771. "/repos/{owner}/{repo}/pulls/{index}.diff": {
  6772. "get": {
  6773. "produces": [
  6774. "text/plain"
  6775. ],
  6776. "tags": [
  6777. "repository"
  6778. ],
  6779. "summary": "Get a pull request diff",
  6780. "operationId": "repoDownloadPullDiff",
  6781. "parameters": [
  6782. {
  6783. "type": "string",
  6784. "description": "owner of the repo",
  6785. "name": "owner",
  6786. "in": "path",
  6787. "required": true
  6788. },
  6789. {
  6790. "type": "string",
  6791. "description": "name of the repo",
  6792. "name": "repo",
  6793. "in": "path",
  6794. "required": true
  6795. },
  6796. {
  6797. "type": "integer",
  6798. "format": "int64",
  6799. "description": "index of the pull request to get",
  6800. "name": "index",
  6801. "in": "path",
  6802. "required": true
  6803. }
  6804. ],
  6805. "responses": {
  6806. "200": {
  6807. "$ref": "#/responses/string"
  6808. },
  6809. "404": {
  6810. "$ref": "#/responses/notFound"
  6811. }
  6812. }
  6813. }
  6814. },
  6815. "/repos/{owner}/{repo}/pulls/{index}.patch": {
  6816. "get": {
  6817. "produces": [
  6818. "text/plain"
  6819. ],
  6820. "tags": [
  6821. "repository"
  6822. ],
  6823. "summary": "Get a pull request patch file",
  6824. "operationId": "repoDownloadPullPatch",
  6825. "parameters": [
  6826. {
  6827. "type": "string",
  6828. "description": "owner of the repo",
  6829. "name": "owner",
  6830. "in": "path",
  6831. "required": true
  6832. },
  6833. {
  6834. "type": "string",
  6835. "description": "name of the repo",
  6836. "name": "repo",
  6837. "in": "path",
  6838. "required": true
  6839. },
  6840. {
  6841. "type": "integer",
  6842. "format": "int64",
  6843. "description": "index of the pull request to get",
  6844. "name": "index",
  6845. "in": "path",
  6846. "required": true
  6847. }
  6848. ],
  6849. "responses": {
  6850. "200": {
  6851. "$ref": "#/responses/string"
  6852. },
  6853. "404": {
  6854. "$ref": "#/responses/notFound"
  6855. }
  6856. }
  6857. }
  6858. },
  6859. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6860. "get": {
  6861. "produces": [
  6862. "application/json"
  6863. ],
  6864. "tags": [
  6865. "repository"
  6866. ],
  6867. "summary": "Check if a pull request has been merged",
  6868. "operationId": "repoPullRequestIsMerged",
  6869. "parameters": [
  6870. {
  6871. "type": "string",
  6872. "description": "owner of the repo",
  6873. "name": "owner",
  6874. "in": "path",
  6875. "required": true
  6876. },
  6877. {
  6878. "type": "string",
  6879. "description": "name of the repo",
  6880. "name": "repo",
  6881. "in": "path",
  6882. "required": true
  6883. },
  6884. {
  6885. "type": "integer",
  6886. "format": "int64",
  6887. "description": "index of the pull request",
  6888. "name": "index",
  6889. "in": "path",
  6890. "required": true
  6891. }
  6892. ],
  6893. "responses": {
  6894. "204": {
  6895. "description": "pull request has been merged"
  6896. },
  6897. "404": {
  6898. "description": "pull request has not been merged"
  6899. }
  6900. }
  6901. },
  6902. "post": {
  6903. "produces": [
  6904. "application/json"
  6905. ],
  6906. "tags": [
  6907. "repository"
  6908. ],
  6909. "summary": "Merge a pull request",
  6910. "operationId": "repoMergePullRequest",
  6911. "parameters": [
  6912. {
  6913. "type": "string",
  6914. "description": "owner of the repo",
  6915. "name": "owner",
  6916. "in": "path",
  6917. "required": true
  6918. },
  6919. {
  6920. "type": "string",
  6921. "description": "name of the repo",
  6922. "name": "repo",
  6923. "in": "path",
  6924. "required": true
  6925. },
  6926. {
  6927. "type": "integer",
  6928. "format": "int64",
  6929. "description": "index of the pull request to merge",
  6930. "name": "index",
  6931. "in": "path",
  6932. "required": true
  6933. },
  6934. {
  6935. "name": "body",
  6936. "in": "body",
  6937. "schema": {
  6938. "$ref": "#/definitions/MergePullRequestOption"
  6939. }
  6940. }
  6941. ],
  6942. "responses": {
  6943. "200": {
  6944. "$ref": "#/responses/empty"
  6945. },
  6946. "405": {
  6947. "$ref": "#/responses/empty"
  6948. },
  6949. "409": {
  6950. "$ref": "#/responses/error"
  6951. }
  6952. }
  6953. }
  6954. },
  6955. "/repos/{owner}/{repo}/pulls/{index}/reviews": {
  6956. "get": {
  6957. "produces": [
  6958. "application/json"
  6959. ],
  6960. "tags": [
  6961. "repository"
  6962. ],
  6963. "summary": "List all reviews for a pull request",
  6964. "operationId": "repoListPullReviews",
  6965. "parameters": [
  6966. {
  6967. "type": "string",
  6968. "description": "owner of the repo",
  6969. "name": "owner",
  6970. "in": "path",
  6971. "required": true
  6972. },
  6973. {
  6974. "type": "string",
  6975. "description": "name of the repo",
  6976. "name": "repo",
  6977. "in": "path",
  6978. "required": true
  6979. },
  6980. {
  6981. "type": "integer",
  6982. "format": "int64",
  6983. "description": "index of the pull request",
  6984. "name": "index",
  6985. "in": "path",
  6986. "required": true
  6987. },
  6988. {
  6989. "type": "integer",
  6990. "description": "page number of results to return (1-based)",
  6991. "name": "page",
  6992. "in": "query"
  6993. },
  6994. {
  6995. "type": "integer",
  6996. "description": "page size of results",
  6997. "name": "limit",
  6998. "in": "query"
  6999. }
  7000. ],
  7001. "responses": {
  7002. "200": {
  7003. "$ref": "#/responses/PullReviewList"
  7004. },
  7005. "404": {
  7006. "$ref": "#/responses/notFound"
  7007. }
  7008. }
  7009. },
  7010. "post": {
  7011. "produces": [
  7012. "application/json"
  7013. ],
  7014. "tags": [
  7015. "repository"
  7016. ],
  7017. "summary": "Create a review to an pull request",
  7018. "operationId": "repoCreatePullReview",
  7019. "parameters": [
  7020. {
  7021. "type": "string",
  7022. "description": "owner of the repo",
  7023. "name": "owner",
  7024. "in": "path",
  7025. "required": true
  7026. },
  7027. {
  7028. "type": "string",
  7029. "description": "name of the repo",
  7030. "name": "repo",
  7031. "in": "path",
  7032. "required": true
  7033. },
  7034. {
  7035. "type": "integer",
  7036. "format": "int64",
  7037. "description": "index of the pull request",
  7038. "name": "index",
  7039. "in": "path",
  7040. "required": true
  7041. },
  7042. {
  7043. "name": "body",
  7044. "in": "body",
  7045. "required": true,
  7046. "schema": {
  7047. "$ref": "#/definitions/CreatePullReviewOptions"
  7048. }
  7049. }
  7050. ],
  7051. "responses": {
  7052. "200": {
  7053. "$ref": "#/responses/PullReview"
  7054. },
  7055. "404": {
  7056. "$ref": "#/responses/notFound"
  7057. },
  7058. "422": {
  7059. "$ref": "#/responses/validationError"
  7060. }
  7061. }
  7062. }
  7063. },
  7064. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}": {
  7065. "get": {
  7066. "produces": [
  7067. "application/json"
  7068. ],
  7069. "tags": [
  7070. "repository"
  7071. ],
  7072. "summary": "Get a specific review for a pull request",
  7073. "operationId": "repoGetPullReview",
  7074. "parameters": [
  7075. {
  7076. "type": "string",
  7077. "description": "owner of the repo",
  7078. "name": "owner",
  7079. "in": "path",
  7080. "required": true
  7081. },
  7082. {
  7083. "type": "string",
  7084. "description": "name of the repo",
  7085. "name": "repo",
  7086. "in": "path",
  7087. "required": true
  7088. },
  7089. {
  7090. "type": "integer",
  7091. "format": "int64",
  7092. "description": "index of the pull request",
  7093. "name": "index",
  7094. "in": "path",
  7095. "required": true
  7096. },
  7097. {
  7098. "type": "integer",
  7099. "format": "int64",
  7100. "description": "id of the review",
  7101. "name": "id",
  7102. "in": "path",
  7103. "required": true
  7104. }
  7105. ],
  7106. "responses": {
  7107. "200": {
  7108. "$ref": "#/responses/PullReview"
  7109. },
  7110. "404": {
  7111. "$ref": "#/responses/notFound"
  7112. }
  7113. }
  7114. },
  7115. "post": {
  7116. "produces": [
  7117. "application/json"
  7118. ],
  7119. "tags": [
  7120. "repository"
  7121. ],
  7122. "summary": "Submit a pending review to an pull request",
  7123. "operationId": "repoSubmitPullReview",
  7124. "parameters": [
  7125. {
  7126. "type": "string",
  7127. "description": "owner of the repo",
  7128. "name": "owner",
  7129. "in": "path",
  7130. "required": true
  7131. },
  7132. {
  7133. "type": "string",
  7134. "description": "name of the repo",
  7135. "name": "repo",
  7136. "in": "path",
  7137. "required": true
  7138. },
  7139. {
  7140. "type": "integer",
  7141. "format": "int64",
  7142. "description": "index of the pull request",
  7143. "name": "index",
  7144. "in": "path",
  7145. "required": true
  7146. },
  7147. {
  7148. "type": "integer",
  7149. "format": "int64",
  7150. "description": "id of the review",
  7151. "name": "id",
  7152. "in": "path",
  7153. "required": true
  7154. },
  7155. {
  7156. "name": "body",
  7157. "in": "body",
  7158. "required": true,
  7159. "schema": {
  7160. "$ref": "#/definitions/SubmitPullReviewOptions"
  7161. }
  7162. }
  7163. ],
  7164. "responses": {
  7165. "200": {
  7166. "$ref": "#/responses/PullReview"
  7167. },
  7168. "404": {
  7169. "$ref": "#/responses/notFound"
  7170. },
  7171. "422": {
  7172. "$ref": "#/responses/validationError"
  7173. }
  7174. }
  7175. },
  7176. "delete": {
  7177. "produces": [
  7178. "application/json"
  7179. ],
  7180. "tags": [
  7181. "repository"
  7182. ],
  7183. "summary": "Delete a specific review from a pull request",
  7184. "operationId": "repoDeletePullReview",
  7185. "parameters": [
  7186. {
  7187. "type": "string",
  7188. "description": "owner of the repo",
  7189. "name": "owner",
  7190. "in": "path",
  7191. "required": true
  7192. },
  7193. {
  7194. "type": "string",
  7195. "description": "name of the repo",
  7196. "name": "repo",
  7197. "in": "path",
  7198. "required": true
  7199. },
  7200. {
  7201. "type": "integer",
  7202. "format": "int64",
  7203. "description": "index of the pull request",
  7204. "name": "index",
  7205. "in": "path",
  7206. "required": true
  7207. },
  7208. {
  7209. "type": "integer",
  7210. "format": "int64",
  7211. "description": "id of the review",
  7212. "name": "id",
  7213. "in": "path",
  7214. "required": true
  7215. }
  7216. ],
  7217. "responses": {
  7218. "204": {
  7219. "$ref": "#/responses/empty"
  7220. },
  7221. "403": {
  7222. "$ref": "#/responses/forbidden"
  7223. },
  7224. "404": {
  7225. "$ref": "#/responses/notFound"
  7226. }
  7227. }
  7228. }
  7229. },
  7230. "/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments": {
  7231. "get": {
  7232. "produces": [
  7233. "application/json"
  7234. ],
  7235. "tags": [
  7236. "repository"
  7237. ],
  7238. "summary": "Get a specific review for a pull request",
  7239. "operationId": "repoGetPullReviewComments",
  7240. "parameters": [
  7241. {
  7242. "type": "string",
  7243. "description": "owner of the repo",
  7244. "name": "owner",
  7245. "in": "path",
  7246. "required": true
  7247. },
  7248. {
  7249. "type": "string",
  7250. "description": "name of the repo",
  7251. "name": "repo",
  7252. "in": "path",
  7253. "required": true
  7254. },
  7255. {
  7256. "type": "integer",
  7257. "format": "int64",
  7258. "description": "index of the pull request",
  7259. "name": "index",
  7260. "in": "path",
  7261. "required": true
  7262. },
  7263. {
  7264. "type": "integer",
  7265. "format": "int64",
  7266. "description": "id of the review",
  7267. "name": "id",
  7268. "in": "path",
  7269. "required": true
  7270. }
  7271. ],
  7272. "responses": {
  7273. "200": {
  7274. "$ref": "#/responses/PullReviewCommentList"
  7275. },
  7276. "404": {
  7277. "$ref": "#/responses/notFound"
  7278. }
  7279. }
  7280. }
  7281. },
  7282. "/repos/{owner}/{repo}/raw/{filepath}": {
  7283. "get": {
  7284. "produces": [
  7285. "application/json"
  7286. ],
  7287. "tags": [
  7288. "repository"
  7289. ],
  7290. "summary": "Get a file from a repository",
  7291. "operationId": "repoGetRawFile",
  7292. "parameters": [
  7293. {
  7294. "type": "string",
  7295. "description": "owner of the repo",
  7296. "name": "owner",
  7297. "in": "path",
  7298. "required": true
  7299. },
  7300. {
  7301. "type": "string",
  7302. "description": "name of the repo",
  7303. "name": "repo",
  7304. "in": "path",
  7305. "required": true
  7306. },
  7307. {
  7308. "type": "string",
  7309. "description": "filepath of the file to get",
  7310. "name": "filepath",
  7311. "in": "path",
  7312. "required": true
  7313. }
  7314. ],
  7315. "responses": {
  7316. "200": {
  7317. "description": "success"
  7318. },
  7319. "404": {
  7320. "$ref": "#/responses/notFound"
  7321. }
  7322. }
  7323. }
  7324. },
  7325. "/repos/{owner}/{repo}/releases": {
  7326. "get": {
  7327. "produces": [
  7328. "application/json"
  7329. ],
  7330. "tags": [
  7331. "repository"
  7332. ],
  7333. "summary": "List a repo's releases",
  7334. "operationId": "repoListReleases",
  7335. "parameters": [
  7336. {
  7337. "type": "string",
  7338. "description": "owner of the repo",
  7339. "name": "owner",
  7340. "in": "path",
  7341. "required": true
  7342. },
  7343. {
  7344. "type": "string",
  7345. "description": "name of the repo",
  7346. "name": "repo",
  7347. "in": "path",
  7348. "required": true
  7349. },
  7350. {
  7351. "type": "integer",
  7352. "description": "page size of results, deprecated - use limit",
  7353. "name": "per_page",
  7354. "in": "query"
  7355. },
  7356. {
  7357. "type": "integer",
  7358. "description": "page number of results to return (1-based)",
  7359. "name": "page",
  7360. "in": "query"
  7361. },
  7362. {
  7363. "type": "integer",
  7364. "description": "page size of results",
  7365. "name": "limit",
  7366. "in": "query"
  7367. }
  7368. ],
  7369. "responses": {
  7370. "200": {
  7371. "$ref": "#/responses/ReleaseList"
  7372. }
  7373. }
  7374. },
  7375. "post": {
  7376. "consumes": [
  7377. "application/json"
  7378. ],
  7379. "produces": [
  7380. "application/json"
  7381. ],
  7382. "tags": [
  7383. "repository"
  7384. ],
  7385. "summary": "Create a release",
  7386. "operationId": "repoCreateRelease",
  7387. "parameters": [
  7388. {
  7389. "type": "string",
  7390. "description": "owner of the repo",
  7391. "name": "owner",
  7392. "in": "path",
  7393. "required": true
  7394. },
  7395. {
  7396. "type": "string",
  7397. "description": "name of the repo",
  7398. "name": "repo",
  7399. "in": "path",
  7400. "required": true
  7401. },
  7402. {
  7403. "name": "body",
  7404. "in": "body",
  7405. "schema": {
  7406. "$ref": "#/definitions/CreateReleaseOption"
  7407. }
  7408. }
  7409. ],
  7410. "responses": {
  7411. "201": {
  7412. "$ref": "#/responses/Release"
  7413. },
  7414. "409": {
  7415. "$ref": "#/responses/error"
  7416. }
  7417. }
  7418. }
  7419. },
  7420. "/repos/{owner}/{repo}/releases/{id}": {
  7421. "get": {
  7422. "produces": [
  7423. "application/json"
  7424. ],
  7425. "tags": [
  7426. "repository"
  7427. ],
  7428. "summary": "Get a release",
  7429. "operationId": "repoGetRelease",
  7430. "parameters": [
  7431. {
  7432. "type": "string",
  7433. "description": "owner of the repo",
  7434. "name": "owner",
  7435. "in": "path",
  7436. "required": true
  7437. },
  7438. {
  7439. "type": "string",
  7440. "description": "name of the repo",
  7441. "name": "repo",
  7442. "in": "path",
  7443. "required": true
  7444. },
  7445. {
  7446. "type": "integer",
  7447. "format": "int64",
  7448. "description": "id of the release to get",
  7449. "name": "id",
  7450. "in": "path",
  7451. "required": true
  7452. }
  7453. ],
  7454. "responses": {
  7455. "200": {
  7456. "$ref": "#/responses/Release"
  7457. }
  7458. }
  7459. },
  7460. "delete": {
  7461. "tags": [
  7462. "repository"
  7463. ],
  7464. "summary": "Delete a release",
  7465. "operationId": "repoDeleteRelease",
  7466. "parameters": [
  7467. {
  7468. "type": "string",
  7469. "description": "owner of the repo",
  7470. "name": "owner",
  7471. "in": "path",
  7472. "required": true
  7473. },
  7474. {
  7475. "type": "string",
  7476. "description": "name of the repo",
  7477. "name": "repo",
  7478. "in": "path",
  7479. "required": true
  7480. },
  7481. {
  7482. "type": "integer",
  7483. "format": "int64",
  7484. "description": "id of the release to delete",
  7485. "name": "id",
  7486. "in": "path",
  7487. "required": true
  7488. }
  7489. ],
  7490. "responses": {
  7491. "204": {
  7492. "$ref": "#/responses/empty"
  7493. }
  7494. }
  7495. },
  7496. "patch": {
  7497. "consumes": [
  7498. "application/json"
  7499. ],
  7500. "produces": [
  7501. "application/json"
  7502. ],
  7503. "tags": [
  7504. "repository"
  7505. ],
  7506. "summary": "Update a release",
  7507. "operationId": "repoEditRelease",
  7508. "parameters": [
  7509. {
  7510. "type": "string",
  7511. "description": "owner of the repo",
  7512. "name": "owner",
  7513. "in": "path",
  7514. "required": true
  7515. },
  7516. {
  7517. "type": "string",
  7518. "description": "name of the repo",
  7519. "name": "repo",
  7520. "in": "path",
  7521. "required": true
  7522. },
  7523. {
  7524. "type": "integer",
  7525. "format": "int64",
  7526. "description": "id of the release to edit",
  7527. "name": "id",
  7528. "in": "path",
  7529. "required": true
  7530. },
  7531. {
  7532. "name": "body",
  7533. "in": "body",
  7534. "schema": {
  7535. "$ref": "#/definitions/EditReleaseOption"
  7536. }
  7537. }
  7538. ],
  7539. "responses": {
  7540. "200": {
  7541. "$ref": "#/responses/Release"
  7542. }
  7543. }
  7544. }
  7545. },
  7546. "/repos/{owner}/{repo}/releases/{id}/assets": {
  7547. "get": {
  7548. "produces": [
  7549. "application/json"
  7550. ],
  7551. "tags": [
  7552. "repository"
  7553. ],
  7554. "summary": "List release's attachments",
  7555. "operationId": "repoListReleaseAttachments",
  7556. "parameters": [
  7557. {
  7558. "type": "string",
  7559. "description": "owner of the repo",
  7560. "name": "owner",
  7561. "in": "path",
  7562. "required": true
  7563. },
  7564. {
  7565. "type": "string",
  7566. "description": "name of the repo",
  7567. "name": "repo",
  7568. "in": "path",
  7569. "required": true
  7570. },
  7571. {
  7572. "type": "integer",
  7573. "format": "int64",
  7574. "description": "id of the release",
  7575. "name": "id",
  7576. "in": "path",
  7577. "required": true
  7578. }
  7579. ],
  7580. "responses": {
  7581. "200": {
  7582. "$ref": "#/responses/AttachmentList"
  7583. }
  7584. }
  7585. },
  7586. "post": {
  7587. "consumes": [
  7588. "multipart/form-data"
  7589. ],
  7590. "produces": [
  7591. "application/json"
  7592. ],
  7593. "tags": [
  7594. "repository"
  7595. ],
  7596. "summary": "Create a release attachment",
  7597. "operationId": "repoCreateReleaseAttachment",
  7598. "parameters": [
  7599. {
  7600. "type": "string",
  7601. "description": "owner of the repo",
  7602. "name": "owner",
  7603. "in": "path",
  7604. "required": true
  7605. },
  7606. {
  7607. "type": "string",
  7608. "description": "name of the repo",
  7609. "name": "repo",
  7610. "in": "path",
  7611. "required": true
  7612. },
  7613. {
  7614. "type": "integer",
  7615. "format": "int64",
  7616. "description": "id of the release",
  7617. "name": "id",
  7618. "in": "path",
  7619. "required": true
  7620. },
  7621. {
  7622. "type": "string",
  7623. "description": "name of the attachment",
  7624. "name": "name",
  7625. "in": "query"
  7626. },
  7627. {
  7628. "type": "file",
  7629. "description": "attachment to upload",
  7630. "name": "attachment",
  7631. "in": "formData",
  7632. "required": true
  7633. }
  7634. ],
  7635. "responses": {
  7636. "201": {
  7637. "$ref": "#/responses/Attachment"
  7638. },
  7639. "400": {
  7640. "$ref": "#/responses/error"
  7641. }
  7642. }
  7643. }
  7644. },
  7645. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  7646. "get": {
  7647. "produces": [
  7648. "application/json"
  7649. ],
  7650. "tags": [
  7651. "repository"
  7652. ],
  7653. "summary": "Get a release attachment",
  7654. "operationId": "repoGetReleaseAttachment",
  7655. "parameters": [
  7656. {
  7657. "type": "string",
  7658. "description": "owner of the repo",
  7659. "name": "owner",
  7660. "in": "path",
  7661. "required": true
  7662. },
  7663. {
  7664. "type": "string",
  7665. "description": "name of the repo",
  7666. "name": "repo",
  7667. "in": "path",
  7668. "required": true
  7669. },
  7670. {
  7671. "type": "integer",
  7672. "format": "int64",
  7673. "description": "id of the release",
  7674. "name": "id",
  7675. "in": "path",
  7676. "required": true
  7677. },
  7678. {
  7679. "type": "integer",
  7680. "format": "int64",
  7681. "description": "id of the attachment to get",
  7682. "name": "attachment_id",
  7683. "in": "path",
  7684. "required": true
  7685. }
  7686. ],
  7687. "responses": {
  7688. "200": {
  7689. "$ref": "#/responses/Attachment"
  7690. }
  7691. }
  7692. },
  7693. "delete": {
  7694. "produces": [
  7695. "application/json"
  7696. ],
  7697. "tags": [
  7698. "repository"
  7699. ],
  7700. "summary": "Delete a release attachment",
  7701. "operationId": "repoDeleteReleaseAttachment",
  7702. "parameters": [
  7703. {
  7704. "type": "string",
  7705. "description": "owner of the repo",
  7706. "name": "owner",
  7707. "in": "path",
  7708. "required": true
  7709. },
  7710. {
  7711. "type": "string",
  7712. "description": "name of the repo",
  7713. "name": "repo",
  7714. "in": "path",
  7715. "required": true
  7716. },
  7717. {
  7718. "type": "integer",
  7719. "format": "int64",
  7720. "description": "id of the release",
  7721. "name": "id",
  7722. "in": "path",
  7723. "required": true
  7724. },
  7725. {
  7726. "type": "integer",
  7727. "format": "int64",
  7728. "description": "id of the attachment to delete",
  7729. "name": "attachment_id",
  7730. "in": "path",
  7731. "required": true
  7732. }
  7733. ],
  7734. "responses": {
  7735. "204": {
  7736. "$ref": "#/responses/empty"
  7737. }
  7738. }
  7739. },
  7740. "patch": {
  7741. "consumes": [
  7742. "application/json"
  7743. ],
  7744. "produces": [
  7745. "application/json"
  7746. ],
  7747. "tags": [
  7748. "repository"
  7749. ],
  7750. "summary": "Edit a release attachment",
  7751. "operationId": "repoEditReleaseAttachment",
  7752. "parameters": [
  7753. {
  7754. "type": "string",
  7755. "description": "owner of the repo",
  7756. "name": "owner",
  7757. "in": "path",
  7758. "required": true
  7759. },
  7760. {
  7761. "type": "string",
  7762. "description": "name of the repo",
  7763. "name": "repo",
  7764. "in": "path",
  7765. "required": true
  7766. },
  7767. {
  7768. "type": "integer",
  7769. "format": "int64",
  7770. "description": "id of the release",
  7771. "name": "id",
  7772. "in": "path",
  7773. "required": true
  7774. },
  7775. {
  7776. "type": "integer",
  7777. "format": "int64",
  7778. "description": "id of the attachment to edit",
  7779. "name": "attachment_id",
  7780. "in": "path",
  7781. "required": true
  7782. },
  7783. {
  7784. "name": "body",
  7785. "in": "body",
  7786. "schema": {
  7787. "$ref": "#/definitions/EditAttachmentOptions"
  7788. }
  7789. }
  7790. ],
  7791. "responses": {
  7792. "201": {
  7793. "$ref": "#/responses/Attachment"
  7794. }
  7795. }
  7796. }
  7797. },
  7798. "/repos/{owner}/{repo}/signing-key.gpg": {
  7799. "get": {
  7800. "produces": [
  7801. "text/plain"
  7802. ],
  7803. "tags": [
  7804. "repository"
  7805. ],
  7806. "summary": "Get signing-key.gpg for given repository",
  7807. "operationId": "repoSigningKey",
  7808. "parameters": [
  7809. {
  7810. "type": "string",
  7811. "description": "owner of the repo",
  7812. "name": "owner",
  7813. "in": "path",
  7814. "required": true
  7815. },
  7816. {
  7817. "type": "string",
  7818. "description": "name of the repo",
  7819. "name": "repo",
  7820. "in": "path",
  7821. "required": true
  7822. }
  7823. ],
  7824. "responses": {
  7825. "200": {
  7826. "description": "GPG armored public key",
  7827. "schema": {
  7828. "type": "string"
  7829. }
  7830. }
  7831. }
  7832. }
  7833. },
  7834. "/repos/{owner}/{repo}/stargazers": {
  7835. "get": {
  7836. "produces": [
  7837. "application/json"
  7838. ],
  7839. "tags": [
  7840. "repository"
  7841. ],
  7842. "summary": "List a repo's stargazers",
  7843. "operationId": "repoListStargazers",
  7844. "parameters": [
  7845. {
  7846. "type": "string",
  7847. "description": "owner of the repo",
  7848. "name": "owner",
  7849. "in": "path",
  7850. "required": true
  7851. },
  7852. {
  7853. "type": "string",
  7854. "description": "name of the repo",
  7855. "name": "repo",
  7856. "in": "path",
  7857. "required": true
  7858. },
  7859. {
  7860. "type": "integer",
  7861. "description": "page number of results to return (1-based)",
  7862. "name": "page",
  7863. "in": "query"
  7864. },
  7865. {
  7866. "type": "integer",
  7867. "description": "page size of results",
  7868. "name": "limit",
  7869. "in": "query"
  7870. }
  7871. ],
  7872. "responses": {
  7873. "200": {
  7874. "$ref": "#/responses/UserList"
  7875. }
  7876. }
  7877. }
  7878. },
  7879. "/repos/{owner}/{repo}/statuses/{sha}": {
  7880. "get": {
  7881. "produces": [
  7882. "application/json"
  7883. ],
  7884. "tags": [
  7885. "repository"
  7886. ],
  7887. "summary": "Get a commit's statuses",
  7888. "operationId": "repoListStatuses",
  7889. "parameters": [
  7890. {
  7891. "type": "string",
  7892. "description": "owner of the repo",
  7893. "name": "owner",
  7894. "in": "path",
  7895. "required": true
  7896. },
  7897. {
  7898. "type": "string",
  7899. "description": "name of the repo",
  7900. "name": "repo",
  7901. "in": "path",
  7902. "required": true
  7903. },
  7904. {
  7905. "type": "string",
  7906. "description": "sha of the commit",
  7907. "name": "sha",
  7908. "in": "path",
  7909. "required": true
  7910. },
  7911. {
  7912. "enum": [
  7913. "oldest",
  7914. "recentupdate",
  7915. "leastupdate",
  7916. "leastindex",
  7917. "highestindex"
  7918. ],
  7919. "type": "string",
  7920. "description": "type of sort",
  7921. "name": "sort",
  7922. "in": "query"
  7923. },
  7924. {
  7925. "enum": [
  7926. "pending",
  7927. "success",
  7928. "error",
  7929. "failure",
  7930. "warning"
  7931. ],
  7932. "type": "string",
  7933. "description": "type of state",
  7934. "name": "state",
  7935. "in": "query"
  7936. },
  7937. {
  7938. "type": "integer",
  7939. "description": "page number of results to return (1-based)",
  7940. "name": "page",
  7941. "in": "query"
  7942. },
  7943. {
  7944. "type": "integer",
  7945. "description": "page size of results",
  7946. "name": "limit",
  7947. "in": "query"
  7948. }
  7949. ],
  7950. "responses": {
  7951. "200": {
  7952. "$ref": "#/responses/StatusList"
  7953. },
  7954. "400": {
  7955. "$ref": "#/responses/error"
  7956. }
  7957. }
  7958. },
  7959. "post": {
  7960. "produces": [
  7961. "application/json"
  7962. ],
  7963. "tags": [
  7964. "repository"
  7965. ],
  7966. "summary": "Create a commit status",
  7967. "operationId": "repoCreateStatus",
  7968. "parameters": [
  7969. {
  7970. "type": "string",
  7971. "description": "owner of the repo",
  7972. "name": "owner",
  7973. "in": "path",
  7974. "required": true
  7975. },
  7976. {
  7977. "type": "string",
  7978. "description": "name of the repo",
  7979. "name": "repo",
  7980. "in": "path",
  7981. "required": true
  7982. },
  7983. {
  7984. "type": "string",
  7985. "description": "sha of the commit",
  7986. "name": "sha",
  7987. "in": "path",
  7988. "required": true
  7989. },
  7990. {
  7991. "name": "body",
  7992. "in": "body",
  7993. "schema": {
  7994. "$ref": "#/definitions/CreateStatusOption"
  7995. }
  7996. }
  7997. ],
  7998. "responses": {
  7999. "201": {
  8000. "$ref": "#/responses/Status"
  8001. },
  8002. "400": {
  8003. "$ref": "#/responses/error"
  8004. }
  8005. }
  8006. }
  8007. },
  8008. "/repos/{owner}/{repo}/subscribers": {
  8009. "get": {
  8010. "produces": [
  8011. "application/json"
  8012. ],
  8013. "tags": [
  8014. "repository"
  8015. ],
  8016. "summary": "List a repo's watchers",
  8017. "operationId": "repoListSubscribers",
  8018. "parameters": [
  8019. {
  8020. "type": "string",
  8021. "description": "owner of the repo",
  8022. "name": "owner",
  8023. "in": "path",
  8024. "required": true
  8025. },
  8026. {
  8027. "type": "string",
  8028. "description": "name of the repo",
  8029. "name": "repo",
  8030. "in": "path",
  8031. "required": true
  8032. },
  8033. {
  8034. "type": "integer",
  8035. "description": "page number of results to return (1-based)",
  8036. "name": "page",
  8037. "in": "query"
  8038. },
  8039. {
  8040. "type": "integer",
  8041. "description": "page size of results",
  8042. "name": "limit",
  8043. "in": "query"
  8044. }
  8045. ],
  8046. "responses": {
  8047. "200": {
  8048. "$ref": "#/responses/UserList"
  8049. }
  8050. }
  8051. }
  8052. },
  8053. "/repos/{owner}/{repo}/subscription": {
  8054. "get": {
  8055. "tags": [
  8056. "repository"
  8057. ],
  8058. "summary": "Check if the current user is watching a repo",
  8059. "operationId": "userCurrentCheckSubscription",
  8060. "parameters": [
  8061. {
  8062. "type": "string",
  8063. "description": "owner of the repo",
  8064. "name": "owner",
  8065. "in": "path",
  8066. "required": true
  8067. },
  8068. {
  8069. "type": "string",
  8070. "description": "name of the repo",
  8071. "name": "repo",
  8072. "in": "path",
  8073. "required": true
  8074. }
  8075. ],
  8076. "responses": {
  8077. "200": {
  8078. "$ref": "#/responses/WatchInfo"
  8079. },
  8080. "404": {
  8081. "description": "User is not watching this repo or repo do not exist"
  8082. }
  8083. }
  8084. },
  8085. "put": {
  8086. "tags": [
  8087. "repository"
  8088. ],
  8089. "summary": "Watch a repo",
  8090. "operationId": "userCurrentPutSubscription",
  8091. "parameters": [
  8092. {
  8093. "type": "string",
  8094. "description": "owner of the repo",
  8095. "name": "owner",
  8096. "in": "path",
  8097. "required": true
  8098. },
  8099. {
  8100. "type": "string",
  8101. "description": "name of the repo",
  8102. "name": "repo",
  8103. "in": "path",
  8104. "required": true
  8105. }
  8106. ],
  8107. "responses": {
  8108. "200": {
  8109. "$ref": "#/responses/WatchInfo"
  8110. }
  8111. }
  8112. },
  8113. "delete": {
  8114. "tags": [
  8115. "repository"
  8116. ],
  8117. "summary": "Unwatch a repo",
  8118. "operationId": "userCurrentDeleteSubscription",
  8119. "parameters": [
  8120. {
  8121. "type": "string",
  8122. "description": "owner of the repo",
  8123. "name": "owner",
  8124. "in": "path",
  8125. "required": true
  8126. },
  8127. {
  8128. "type": "string",
  8129. "description": "name of the repo",
  8130. "name": "repo",
  8131. "in": "path",
  8132. "required": true
  8133. }
  8134. ],
  8135. "responses": {
  8136. "204": {
  8137. "$ref": "#/responses/empty"
  8138. }
  8139. }
  8140. }
  8141. },
  8142. "/repos/{owner}/{repo}/tags": {
  8143. "get": {
  8144. "produces": [
  8145. "application/json"
  8146. ],
  8147. "tags": [
  8148. "repository"
  8149. ],
  8150. "summary": "List a repository's tags",
  8151. "operationId": "repoListTags",
  8152. "parameters": [
  8153. {
  8154. "type": "string",
  8155. "description": "owner of the repo",
  8156. "name": "owner",
  8157. "in": "path",
  8158. "required": true
  8159. },
  8160. {
  8161. "type": "string",
  8162. "description": "name of the repo",
  8163. "name": "repo",
  8164. "in": "path",
  8165. "required": true
  8166. },
  8167. {
  8168. "type": "integer",
  8169. "description": "page number of results to return (1-based)",
  8170. "name": "page",
  8171. "in": "query"
  8172. },
  8173. {
  8174. "type": "integer",
  8175. "description": "page size of results, default maximum page size is 50",
  8176. "name": "limit",
  8177. "in": "query"
  8178. }
  8179. ],
  8180. "responses": {
  8181. "200": {
  8182. "$ref": "#/responses/TagList"
  8183. }
  8184. }
  8185. }
  8186. },
  8187. "/repos/{owner}/{repo}/times": {
  8188. "get": {
  8189. "produces": [
  8190. "application/json"
  8191. ],
  8192. "tags": [
  8193. "repository"
  8194. ],
  8195. "summary": "List a repo's tracked times",
  8196. "operationId": "repoTrackedTimes",
  8197. "parameters": [
  8198. {
  8199. "type": "string",
  8200. "description": "owner of the repo",
  8201. "name": "owner",
  8202. "in": "path",
  8203. "required": true
  8204. },
  8205. {
  8206. "type": "string",
  8207. "description": "name of the repo",
  8208. "name": "repo",
  8209. "in": "path",
  8210. "required": true
  8211. },
  8212. {
  8213. "type": "string",
  8214. "description": "optional filter by user",
  8215. "name": "user",
  8216. "in": "query"
  8217. },
  8218. {
  8219. "type": "string",
  8220. "format": "date-time",
  8221. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8222. "name": "since",
  8223. "in": "query"
  8224. },
  8225. {
  8226. "type": "string",
  8227. "format": "date-time",
  8228. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8229. "name": "before",
  8230. "in": "query"
  8231. },
  8232. {
  8233. "type": "integer",
  8234. "description": "page number of results to return (1-based)",
  8235. "name": "page",
  8236. "in": "query"
  8237. },
  8238. {
  8239. "type": "integer",
  8240. "description": "page size of results",
  8241. "name": "limit",
  8242. "in": "query"
  8243. }
  8244. ],
  8245. "responses": {
  8246. "200": {
  8247. "$ref": "#/responses/TrackedTimeList"
  8248. },
  8249. "400": {
  8250. "$ref": "#/responses/error"
  8251. },
  8252. "403": {
  8253. "$ref": "#/responses/forbidden"
  8254. }
  8255. }
  8256. }
  8257. },
  8258. "/repos/{owner}/{repo}/times/{user}": {
  8259. "get": {
  8260. "produces": [
  8261. "application/json"
  8262. ],
  8263. "tags": [
  8264. "repository"
  8265. ],
  8266. "summary": "List a user's tracked times in a repo",
  8267. "operationId": "userTrackedTimes",
  8268. "deprecated": true,
  8269. "parameters": [
  8270. {
  8271. "type": "string",
  8272. "description": "owner of the repo",
  8273. "name": "owner",
  8274. "in": "path",
  8275. "required": true
  8276. },
  8277. {
  8278. "type": "string",
  8279. "description": "name of the repo",
  8280. "name": "repo",
  8281. "in": "path",
  8282. "required": true
  8283. },
  8284. {
  8285. "type": "string",
  8286. "description": "username of user",
  8287. "name": "user",
  8288. "in": "path",
  8289. "required": true
  8290. }
  8291. ],
  8292. "responses": {
  8293. "200": {
  8294. "$ref": "#/responses/TrackedTimeList"
  8295. },
  8296. "400": {
  8297. "$ref": "#/responses/error"
  8298. },
  8299. "403": {
  8300. "$ref": "#/responses/forbidden"
  8301. }
  8302. }
  8303. }
  8304. },
  8305. "/repos/{owner}/{repo}/topics": {
  8306. "get": {
  8307. "produces": [
  8308. "application/json"
  8309. ],
  8310. "tags": [
  8311. "repository"
  8312. ],
  8313. "summary": "Get list of topics that a repository has",
  8314. "operationId": "repoListTopics",
  8315. "parameters": [
  8316. {
  8317. "type": "string",
  8318. "description": "owner of the repo",
  8319. "name": "owner",
  8320. "in": "path",
  8321. "required": true
  8322. },
  8323. {
  8324. "type": "string",
  8325. "description": "name of the repo",
  8326. "name": "repo",
  8327. "in": "path",
  8328. "required": true
  8329. },
  8330. {
  8331. "type": "integer",
  8332. "description": "page number of results to return (1-based)",
  8333. "name": "page",
  8334. "in": "query"
  8335. },
  8336. {
  8337. "type": "integer",
  8338. "description": "page size of results",
  8339. "name": "limit",
  8340. "in": "query"
  8341. }
  8342. ],
  8343. "responses": {
  8344. "200": {
  8345. "$ref": "#/responses/TopicNames"
  8346. }
  8347. }
  8348. },
  8349. "put": {
  8350. "produces": [
  8351. "application/json"
  8352. ],
  8353. "tags": [
  8354. "repository"
  8355. ],
  8356. "summary": "Replace list of topics for a repository",
  8357. "operationId": "repoUpdateTopics",
  8358. "parameters": [
  8359. {
  8360. "type": "string",
  8361. "description": "owner of the repo",
  8362. "name": "owner",
  8363. "in": "path",
  8364. "required": true
  8365. },
  8366. {
  8367. "type": "string",
  8368. "description": "name of the repo",
  8369. "name": "repo",
  8370. "in": "path",
  8371. "required": true
  8372. },
  8373. {
  8374. "name": "body",
  8375. "in": "body",
  8376. "schema": {
  8377. "$ref": "#/definitions/RepoTopicOptions"
  8378. }
  8379. }
  8380. ],
  8381. "responses": {
  8382. "204": {
  8383. "$ref": "#/responses/empty"
  8384. },
  8385. "422": {
  8386. "$ref": "#/responses/invalidTopicsError"
  8387. }
  8388. }
  8389. }
  8390. },
  8391. "/repos/{owner}/{repo}/topics/{topic}": {
  8392. "put": {
  8393. "produces": [
  8394. "application/json"
  8395. ],
  8396. "tags": [
  8397. "repository"
  8398. ],
  8399. "summary": "Add a topic to a repository",
  8400. "operationId": "repoAddTopíc",
  8401. "parameters": [
  8402. {
  8403. "type": "string",
  8404. "description": "owner of the repo",
  8405. "name": "owner",
  8406. "in": "path",
  8407. "required": true
  8408. },
  8409. {
  8410. "type": "string",
  8411. "description": "name of the repo",
  8412. "name": "repo",
  8413. "in": "path",
  8414. "required": true
  8415. },
  8416. {
  8417. "type": "string",
  8418. "description": "name of the topic to add",
  8419. "name": "topic",
  8420. "in": "path",
  8421. "required": true
  8422. }
  8423. ],
  8424. "responses": {
  8425. "204": {
  8426. "$ref": "#/responses/empty"
  8427. },
  8428. "422": {
  8429. "$ref": "#/responses/invalidTopicsError"
  8430. }
  8431. }
  8432. },
  8433. "delete": {
  8434. "produces": [
  8435. "application/json"
  8436. ],
  8437. "tags": [
  8438. "repository"
  8439. ],
  8440. "summary": "Delete a topic from a repository",
  8441. "operationId": "repoDeleteTopic",
  8442. "parameters": [
  8443. {
  8444. "type": "string",
  8445. "description": "owner of the repo",
  8446. "name": "owner",
  8447. "in": "path",
  8448. "required": true
  8449. },
  8450. {
  8451. "type": "string",
  8452. "description": "name of the repo",
  8453. "name": "repo",
  8454. "in": "path",
  8455. "required": true
  8456. },
  8457. {
  8458. "type": "string",
  8459. "description": "name of the topic to delete",
  8460. "name": "topic",
  8461. "in": "path",
  8462. "required": true
  8463. }
  8464. ],
  8465. "responses": {
  8466. "204": {
  8467. "$ref": "#/responses/empty"
  8468. },
  8469. "422": {
  8470. "$ref": "#/responses/invalidTopicsError"
  8471. }
  8472. }
  8473. }
  8474. },
  8475. "/repos/{owner}/{repo}/transfer": {
  8476. "post": {
  8477. "produces": [
  8478. "application/json"
  8479. ],
  8480. "tags": [
  8481. "repository"
  8482. ],
  8483. "summary": "Transfer a repo ownership",
  8484. "operationId": "repoTransfer",
  8485. "parameters": [
  8486. {
  8487. "type": "string",
  8488. "description": "owner of the repo to transfer",
  8489. "name": "owner",
  8490. "in": "path",
  8491. "required": true
  8492. },
  8493. {
  8494. "type": "string",
  8495. "description": "name of the repo to transfer",
  8496. "name": "repo",
  8497. "in": "path",
  8498. "required": true
  8499. },
  8500. {
  8501. "description": "Transfer Options",
  8502. "name": "body",
  8503. "in": "body",
  8504. "required": true,
  8505. "schema": {
  8506. "$ref": "#/definitions/TransferRepoOption"
  8507. }
  8508. }
  8509. ],
  8510. "responses": {
  8511. "202": {
  8512. "$ref": "#/responses/Repository"
  8513. },
  8514. "403": {
  8515. "$ref": "#/responses/forbidden"
  8516. },
  8517. "404": {
  8518. "$ref": "#/responses/notFound"
  8519. },
  8520. "422": {
  8521. "$ref": "#/responses/validationError"
  8522. }
  8523. }
  8524. }
  8525. },
  8526. "/repositories/{id}": {
  8527. "get": {
  8528. "produces": [
  8529. "application/json"
  8530. ],
  8531. "tags": [
  8532. "repository"
  8533. ],
  8534. "summary": "Get a repository by id",
  8535. "operationId": "repoGetByID",
  8536. "parameters": [
  8537. {
  8538. "type": "integer",
  8539. "format": "int64",
  8540. "description": "id of the repo to get",
  8541. "name": "id",
  8542. "in": "path",
  8543. "required": true
  8544. }
  8545. ],
  8546. "responses": {
  8547. "200": {
  8548. "$ref": "#/responses/Repository"
  8549. }
  8550. }
  8551. }
  8552. },
  8553. "/settings/repository": {
  8554. "get": {
  8555. "produces": [
  8556. "application/json"
  8557. ],
  8558. "tags": [
  8559. "settings"
  8560. ],
  8561. "summary": "Get instance's global settings for repositories",
  8562. "operationId": "getGeneralRepositorySettings",
  8563. "responses": {
  8564. "200": {
  8565. "$ref": "#/responses/GeneralRepoSettings"
  8566. }
  8567. }
  8568. }
  8569. },
  8570. "/settings/ui": {
  8571. "get": {
  8572. "produces": [
  8573. "application/json"
  8574. ],
  8575. "tags": [
  8576. "settings"
  8577. ],
  8578. "summary": "Get instance's global settings for ui",
  8579. "operationId": "getGeneralUISettings",
  8580. "responses": {
  8581. "200": {
  8582. "$ref": "#/responses/GeneralUISettings"
  8583. }
  8584. }
  8585. }
  8586. },
  8587. "/signing-key.gpg": {
  8588. "get": {
  8589. "produces": [
  8590. "text/plain"
  8591. ],
  8592. "tags": [
  8593. "miscellaneous"
  8594. ],
  8595. "summary": "Get default signing-key.gpg",
  8596. "operationId": "getSigningKey",
  8597. "responses": {
  8598. "200": {
  8599. "description": "GPG armored public key",
  8600. "schema": {
  8601. "type": "string"
  8602. }
  8603. }
  8604. }
  8605. }
  8606. },
  8607. "/teams/{id}": {
  8608. "get": {
  8609. "produces": [
  8610. "application/json"
  8611. ],
  8612. "tags": [
  8613. "organization"
  8614. ],
  8615. "summary": "Get a team",
  8616. "operationId": "orgGetTeam",
  8617. "parameters": [
  8618. {
  8619. "type": "integer",
  8620. "format": "int64",
  8621. "description": "id of the team to get",
  8622. "name": "id",
  8623. "in": "path",
  8624. "required": true
  8625. }
  8626. ],
  8627. "responses": {
  8628. "200": {
  8629. "$ref": "#/responses/Team"
  8630. }
  8631. }
  8632. },
  8633. "delete": {
  8634. "tags": [
  8635. "organization"
  8636. ],
  8637. "summary": "Delete a team",
  8638. "operationId": "orgDeleteTeam",
  8639. "parameters": [
  8640. {
  8641. "type": "integer",
  8642. "format": "int64",
  8643. "description": "id of the team to delete",
  8644. "name": "id",
  8645. "in": "path",
  8646. "required": true
  8647. }
  8648. ],
  8649. "responses": {
  8650. "204": {
  8651. "description": "team deleted"
  8652. }
  8653. }
  8654. },
  8655. "patch": {
  8656. "consumes": [
  8657. "application/json"
  8658. ],
  8659. "produces": [
  8660. "application/json"
  8661. ],
  8662. "tags": [
  8663. "organization"
  8664. ],
  8665. "summary": "Edit a team",
  8666. "operationId": "orgEditTeam",
  8667. "parameters": [
  8668. {
  8669. "type": "integer",
  8670. "description": "id of the team to edit",
  8671. "name": "id",
  8672. "in": "path",
  8673. "required": true
  8674. },
  8675. {
  8676. "name": "body",
  8677. "in": "body",
  8678. "schema": {
  8679. "$ref": "#/definitions/EditTeamOption"
  8680. }
  8681. }
  8682. ],
  8683. "responses": {
  8684. "200": {
  8685. "$ref": "#/responses/Team"
  8686. }
  8687. }
  8688. }
  8689. },
  8690. "/teams/{id}/members": {
  8691. "get": {
  8692. "produces": [
  8693. "application/json"
  8694. ],
  8695. "tags": [
  8696. "organization"
  8697. ],
  8698. "summary": "List a team's members",
  8699. "operationId": "orgListTeamMembers",
  8700. "parameters": [
  8701. {
  8702. "type": "integer",
  8703. "format": "int64",
  8704. "description": "id of the team",
  8705. "name": "id",
  8706. "in": "path",
  8707. "required": true
  8708. },
  8709. {
  8710. "type": "integer",
  8711. "description": "page number of results to return (1-based)",
  8712. "name": "page",
  8713. "in": "query"
  8714. },
  8715. {
  8716. "type": "integer",
  8717. "description": "page size of results",
  8718. "name": "limit",
  8719. "in": "query"
  8720. }
  8721. ],
  8722. "responses": {
  8723. "200": {
  8724. "$ref": "#/responses/UserList"
  8725. }
  8726. }
  8727. }
  8728. },
  8729. "/teams/{id}/members/{username}": {
  8730. "get": {
  8731. "produces": [
  8732. "application/json"
  8733. ],
  8734. "tags": [
  8735. "organization"
  8736. ],
  8737. "summary": "List a particular member of team",
  8738. "operationId": "orgListTeamMember",
  8739. "parameters": [
  8740. {
  8741. "type": "integer",
  8742. "format": "int64",
  8743. "description": "id of the team",
  8744. "name": "id",
  8745. "in": "path",
  8746. "required": true
  8747. },
  8748. {
  8749. "type": "string",
  8750. "description": "username of the member to list",
  8751. "name": "username",
  8752. "in": "path",
  8753. "required": true
  8754. }
  8755. ],
  8756. "responses": {
  8757. "200": {
  8758. "$ref": "#/responses/User"
  8759. },
  8760. "404": {
  8761. "$ref": "#/responses/notFound"
  8762. }
  8763. }
  8764. },
  8765. "put": {
  8766. "produces": [
  8767. "application/json"
  8768. ],
  8769. "tags": [
  8770. "organization"
  8771. ],
  8772. "summary": "Add a team member",
  8773. "operationId": "orgAddTeamMember",
  8774. "parameters": [
  8775. {
  8776. "type": "integer",
  8777. "format": "int64",
  8778. "description": "id of the team",
  8779. "name": "id",
  8780. "in": "path",
  8781. "required": true
  8782. },
  8783. {
  8784. "type": "string",
  8785. "description": "username of the user to add",
  8786. "name": "username",
  8787. "in": "path",
  8788. "required": true
  8789. }
  8790. ],
  8791. "responses": {
  8792. "204": {
  8793. "$ref": "#/responses/empty"
  8794. },
  8795. "404": {
  8796. "$ref": "#/responses/notFound"
  8797. }
  8798. }
  8799. },
  8800. "delete": {
  8801. "produces": [
  8802. "application/json"
  8803. ],
  8804. "tags": [
  8805. "organization"
  8806. ],
  8807. "summary": "Remove a team member",
  8808. "operationId": "orgRemoveTeamMember",
  8809. "parameters": [
  8810. {
  8811. "type": "integer",
  8812. "format": "int64",
  8813. "description": "id of the team",
  8814. "name": "id",
  8815. "in": "path",
  8816. "required": true
  8817. },
  8818. {
  8819. "type": "string",
  8820. "description": "username of the user to remove",
  8821. "name": "username",
  8822. "in": "path",
  8823. "required": true
  8824. }
  8825. ],
  8826. "responses": {
  8827. "204": {
  8828. "$ref": "#/responses/empty"
  8829. },
  8830. "404": {
  8831. "$ref": "#/responses/notFound"
  8832. }
  8833. }
  8834. }
  8835. },
  8836. "/teams/{id}/repos": {
  8837. "get": {
  8838. "produces": [
  8839. "application/json"
  8840. ],
  8841. "tags": [
  8842. "organization"
  8843. ],
  8844. "summary": "List a team's repos",
  8845. "operationId": "orgListTeamRepos",
  8846. "parameters": [
  8847. {
  8848. "type": "integer",
  8849. "format": "int64",
  8850. "description": "id of the team",
  8851. "name": "id",
  8852. "in": "path",
  8853. "required": true
  8854. },
  8855. {
  8856. "type": "integer",
  8857. "description": "page number of results to return (1-based)",
  8858. "name": "page",
  8859. "in": "query"
  8860. },
  8861. {
  8862. "type": "integer",
  8863. "description": "page size of results",
  8864. "name": "limit",
  8865. "in": "query"
  8866. }
  8867. ],
  8868. "responses": {
  8869. "200": {
  8870. "$ref": "#/responses/RepositoryList"
  8871. }
  8872. }
  8873. }
  8874. },
  8875. "/teams/{id}/repos/{org}/{repo}": {
  8876. "put": {
  8877. "produces": [
  8878. "application/json"
  8879. ],
  8880. "tags": [
  8881. "organization"
  8882. ],
  8883. "summary": "Add a repository to a team",
  8884. "operationId": "orgAddTeamRepository",
  8885. "parameters": [
  8886. {
  8887. "type": "integer",
  8888. "format": "int64",
  8889. "description": "id of the team",
  8890. "name": "id",
  8891. "in": "path",
  8892. "required": true
  8893. },
  8894. {
  8895. "type": "string",
  8896. "description": "organization that owns the repo to add",
  8897. "name": "org",
  8898. "in": "path",
  8899. "required": true
  8900. },
  8901. {
  8902. "type": "string",
  8903. "description": "name of the repo to add",
  8904. "name": "repo",
  8905. "in": "path",
  8906. "required": true
  8907. }
  8908. ],
  8909. "responses": {
  8910. "204": {
  8911. "$ref": "#/responses/empty"
  8912. },
  8913. "403": {
  8914. "$ref": "#/responses/forbidden"
  8915. }
  8916. }
  8917. },
  8918. "delete": {
  8919. "description": "This does not delete the repository, it only removes the repository from the team.",
  8920. "produces": [
  8921. "application/json"
  8922. ],
  8923. "tags": [
  8924. "organization"
  8925. ],
  8926. "summary": "Remove a repository from a team",
  8927. "operationId": "orgRemoveTeamRepository",
  8928. "parameters": [
  8929. {
  8930. "type": "integer",
  8931. "format": "int64",
  8932. "description": "id of the team",
  8933. "name": "id",
  8934. "in": "path",
  8935. "required": true
  8936. },
  8937. {
  8938. "type": "string",
  8939. "description": "organization that owns the repo to remove",
  8940. "name": "org",
  8941. "in": "path",
  8942. "required": true
  8943. },
  8944. {
  8945. "type": "string",
  8946. "description": "name of the repo to remove",
  8947. "name": "repo",
  8948. "in": "path",
  8949. "required": true
  8950. }
  8951. ],
  8952. "responses": {
  8953. "204": {
  8954. "$ref": "#/responses/empty"
  8955. },
  8956. "403": {
  8957. "$ref": "#/responses/forbidden"
  8958. }
  8959. }
  8960. }
  8961. },
  8962. "/topics/search": {
  8963. "get": {
  8964. "produces": [
  8965. "application/json"
  8966. ],
  8967. "tags": [
  8968. "repository"
  8969. ],
  8970. "summary": "search topics via keyword",
  8971. "operationId": "topicSearch",
  8972. "parameters": [
  8973. {
  8974. "type": "string",
  8975. "description": "keywords to search",
  8976. "name": "q",
  8977. "in": "query",
  8978. "required": true
  8979. },
  8980. {
  8981. "type": "integer",
  8982. "description": "page number of results to return (1-based)",
  8983. "name": "page",
  8984. "in": "query"
  8985. },
  8986. {
  8987. "type": "integer",
  8988. "description": "page size of results",
  8989. "name": "limit",
  8990. "in": "query"
  8991. }
  8992. ],
  8993. "responses": {
  8994. "200": {
  8995. "$ref": "#/responses/TopicListResponse"
  8996. },
  8997. "403": {
  8998. "$ref": "#/responses/forbidden"
  8999. }
  9000. }
  9001. }
  9002. },
  9003. "/user": {
  9004. "get": {
  9005. "produces": [
  9006. "application/json"
  9007. ],
  9008. "tags": [
  9009. "user"
  9010. ],
  9011. "summary": "Get the authenticated user",
  9012. "operationId": "userGetCurrent",
  9013. "responses": {
  9014. "200": {
  9015. "$ref": "#/responses/User"
  9016. }
  9017. }
  9018. }
  9019. },
  9020. "/user/applications/oauth2": {
  9021. "get": {
  9022. "produces": [
  9023. "application/json"
  9024. ],
  9025. "tags": [
  9026. "user"
  9027. ],
  9028. "summary": "List the authenticated user's oauth2 applications",
  9029. "operationId": "userGetOauth2Application",
  9030. "parameters": [
  9031. {
  9032. "type": "integer",
  9033. "description": "page number of results to return (1-based)",
  9034. "name": "page",
  9035. "in": "query"
  9036. },
  9037. {
  9038. "type": "integer",
  9039. "description": "page size of results",
  9040. "name": "limit",
  9041. "in": "query"
  9042. }
  9043. ],
  9044. "responses": {
  9045. "200": {
  9046. "$ref": "#/responses/OAuth2ApplicationList"
  9047. }
  9048. }
  9049. },
  9050. "post": {
  9051. "produces": [
  9052. "application/json"
  9053. ],
  9054. "tags": [
  9055. "user"
  9056. ],
  9057. "summary": "creates a new OAuth2 application",
  9058. "operationId": "userCreateOAuth2Application",
  9059. "parameters": [
  9060. {
  9061. "name": "body",
  9062. "in": "body",
  9063. "required": true,
  9064. "schema": {
  9065. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  9066. }
  9067. }
  9068. ],
  9069. "responses": {
  9070. "201": {
  9071. "$ref": "#/responses/OAuth2Application"
  9072. }
  9073. }
  9074. }
  9075. },
  9076. "/user/applications/oauth2/{id}": {
  9077. "get": {
  9078. "produces": [
  9079. "application/json"
  9080. ],
  9081. "tags": [
  9082. "user"
  9083. ],
  9084. "summary": "get an OAuth2 Application",
  9085. "operationId": "userGetOAuth2Application",
  9086. "parameters": [
  9087. {
  9088. "type": "integer",
  9089. "format": "int64",
  9090. "description": "Application ID to be found",
  9091. "name": "id",
  9092. "in": "path",
  9093. "required": true
  9094. }
  9095. ],
  9096. "responses": {
  9097. "200": {
  9098. "$ref": "#/responses/OAuth2Application"
  9099. }
  9100. }
  9101. },
  9102. "delete": {
  9103. "produces": [
  9104. "application/json"
  9105. ],
  9106. "tags": [
  9107. "user"
  9108. ],
  9109. "summary": "delete an OAuth2 Application",
  9110. "operationId": "userDeleteOAuth2Application",
  9111. "parameters": [
  9112. {
  9113. "type": "integer",
  9114. "format": "int64",
  9115. "description": "token to be deleted",
  9116. "name": "id",
  9117. "in": "path",
  9118. "required": true
  9119. }
  9120. ],
  9121. "responses": {
  9122. "204": {
  9123. "$ref": "#/responses/empty"
  9124. }
  9125. }
  9126. },
  9127. "patch": {
  9128. "produces": [
  9129. "application/json"
  9130. ],
  9131. "tags": [
  9132. "user"
  9133. ],
  9134. "summary": "update an OAuth2 Application, this includes regenerating the client secret",
  9135. "operationId": "userUpdateOAuth2Application",
  9136. "parameters": [
  9137. {
  9138. "type": "integer",
  9139. "format": "int64",
  9140. "description": "application to be updated",
  9141. "name": "id",
  9142. "in": "path",
  9143. "required": true
  9144. },
  9145. {
  9146. "name": "body",
  9147. "in": "body",
  9148. "required": true,
  9149. "schema": {
  9150. "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
  9151. }
  9152. }
  9153. ],
  9154. "responses": {
  9155. "200": {
  9156. "$ref": "#/responses/OAuth2Application"
  9157. }
  9158. }
  9159. }
  9160. },
  9161. "/user/emails": {
  9162. "get": {
  9163. "produces": [
  9164. "application/json"
  9165. ],
  9166. "tags": [
  9167. "user"
  9168. ],
  9169. "summary": "List the authenticated user's email addresses",
  9170. "operationId": "userListEmails",
  9171. "responses": {
  9172. "200": {
  9173. "$ref": "#/responses/EmailList"
  9174. }
  9175. }
  9176. },
  9177. "post": {
  9178. "produces": [
  9179. "application/json"
  9180. ],
  9181. "tags": [
  9182. "user"
  9183. ],
  9184. "summary": "Add email addresses",
  9185. "operationId": "userAddEmail",
  9186. "parameters": [
  9187. {
  9188. "name": "body",
  9189. "in": "body",
  9190. "schema": {
  9191. "$ref": "#/definitions/CreateEmailOption"
  9192. }
  9193. }
  9194. ],
  9195. "responses": {
  9196. "201": {
  9197. "$ref": "#/responses/EmailList"
  9198. },
  9199. "422": {
  9200. "$ref": "#/responses/validationError"
  9201. }
  9202. }
  9203. },
  9204. "delete": {
  9205. "produces": [
  9206. "application/json"
  9207. ],
  9208. "tags": [
  9209. "user"
  9210. ],
  9211. "summary": "Delete email addresses",
  9212. "operationId": "userDeleteEmail",
  9213. "parameters": [
  9214. {
  9215. "name": "body",
  9216. "in": "body",
  9217. "schema": {
  9218. "$ref": "#/definitions/DeleteEmailOption"
  9219. }
  9220. }
  9221. ],
  9222. "responses": {
  9223. "204": {
  9224. "$ref": "#/responses/empty"
  9225. }
  9226. }
  9227. }
  9228. },
  9229. "/user/followers": {
  9230. "get": {
  9231. "produces": [
  9232. "application/json"
  9233. ],
  9234. "tags": [
  9235. "user"
  9236. ],
  9237. "summary": "List the authenticated user's followers",
  9238. "operationId": "userCurrentListFollowers",
  9239. "parameters": [
  9240. {
  9241. "type": "integer",
  9242. "description": "page number of results to return (1-based)",
  9243. "name": "page",
  9244. "in": "query"
  9245. },
  9246. {
  9247. "type": "integer",
  9248. "description": "page size of results",
  9249. "name": "limit",
  9250. "in": "query"
  9251. }
  9252. ],
  9253. "responses": {
  9254. "200": {
  9255. "$ref": "#/responses/UserList"
  9256. }
  9257. }
  9258. }
  9259. },
  9260. "/user/following": {
  9261. "get": {
  9262. "produces": [
  9263. "application/json"
  9264. ],
  9265. "tags": [
  9266. "user"
  9267. ],
  9268. "summary": "List the users that the authenticated user is following",
  9269. "operationId": "userCurrentListFollowing",
  9270. "parameters": [
  9271. {
  9272. "type": "integer",
  9273. "description": "page number of results to return (1-based)",
  9274. "name": "page",
  9275. "in": "query"
  9276. },
  9277. {
  9278. "type": "integer",
  9279. "description": "page size of results",
  9280. "name": "limit",
  9281. "in": "query"
  9282. }
  9283. ],
  9284. "responses": {
  9285. "200": {
  9286. "$ref": "#/responses/UserList"
  9287. }
  9288. }
  9289. }
  9290. },
  9291. "/user/following/{username}": {
  9292. "get": {
  9293. "tags": [
  9294. "user"
  9295. ],
  9296. "summary": "Check whether a user is followed by the authenticated user",
  9297. "operationId": "userCurrentCheckFollowing",
  9298. "parameters": [
  9299. {
  9300. "type": "string",
  9301. "description": "username of followed user",
  9302. "name": "username",
  9303. "in": "path",
  9304. "required": true
  9305. }
  9306. ],
  9307. "responses": {
  9308. "204": {
  9309. "$ref": "#/responses/empty"
  9310. },
  9311. "404": {
  9312. "$ref": "#/responses/notFound"
  9313. }
  9314. }
  9315. },
  9316. "put": {
  9317. "tags": [
  9318. "user"
  9319. ],
  9320. "summary": "Follow a user",
  9321. "operationId": "userCurrentPutFollow",
  9322. "parameters": [
  9323. {
  9324. "type": "string",
  9325. "description": "username of user to follow",
  9326. "name": "username",
  9327. "in": "path",
  9328. "required": true
  9329. }
  9330. ],
  9331. "responses": {
  9332. "204": {
  9333. "$ref": "#/responses/empty"
  9334. }
  9335. }
  9336. },
  9337. "delete": {
  9338. "tags": [
  9339. "user"
  9340. ],
  9341. "summary": "Unfollow a user",
  9342. "operationId": "userCurrentDeleteFollow",
  9343. "parameters": [
  9344. {
  9345. "type": "string",
  9346. "description": "username of user to unfollow",
  9347. "name": "username",
  9348. "in": "path",
  9349. "required": true
  9350. }
  9351. ],
  9352. "responses": {
  9353. "204": {
  9354. "$ref": "#/responses/empty"
  9355. }
  9356. }
  9357. }
  9358. },
  9359. "/user/gpg_keys": {
  9360. "get": {
  9361. "produces": [
  9362. "application/json"
  9363. ],
  9364. "tags": [
  9365. "user"
  9366. ],
  9367. "summary": "List the authenticated user's GPG keys",
  9368. "operationId": "userCurrentListGPGKeys",
  9369. "parameters": [
  9370. {
  9371. "type": "integer",
  9372. "description": "page number of results to return (1-based)",
  9373. "name": "page",
  9374. "in": "query"
  9375. },
  9376. {
  9377. "type": "integer",
  9378. "description": "page size of results",
  9379. "name": "limit",
  9380. "in": "query"
  9381. }
  9382. ],
  9383. "responses": {
  9384. "200": {
  9385. "$ref": "#/responses/GPGKeyList"
  9386. }
  9387. }
  9388. },
  9389. "post": {
  9390. "consumes": [
  9391. "application/json"
  9392. ],
  9393. "produces": [
  9394. "application/json"
  9395. ],
  9396. "tags": [
  9397. "user"
  9398. ],
  9399. "summary": "Create a GPG key",
  9400. "operationId": "userCurrentPostGPGKey",
  9401. "parameters": [
  9402. {
  9403. "name": "Form",
  9404. "in": "body",
  9405. "schema": {
  9406. "$ref": "#/definitions/CreateGPGKeyOption"
  9407. }
  9408. }
  9409. ],
  9410. "responses": {
  9411. "201": {
  9412. "$ref": "#/responses/GPGKey"
  9413. },
  9414. "404": {
  9415. "$ref": "#/responses/notFound"
  9416. },
  9417. "422": {
  9418. "$ref": "#/responses/validationError"
  9419. }
  9420. }
  9421. }
  9422. },
  9423. "/user/gpg_keys/{id}": {
  9424. "get": {
  9425. "produces": [
  9426. "application/json"
  9427. ],
  9428. "tags": [
  9429. "user"
  9430. ],
  9431. "summary": "Get a GPG key",
  9432. "operationId": "userCurrentGetGPGKey",
  9433. "parameters": [
  9434. {
  9435. "type": "integer",
  9436. "format": "int64",
  9437. "description": "id of key to get",
  9438. "name": "id",
  9439. "in": "path",
  9440. "required": true
  9441. }
  9442. ],
  9443. "responses": {
  9444. "200": {
  9445. "$ref": "#/responses/GPGKey"
  9446. },
  9447. "404": {
  9448. "$ref": "#/responses/notFound"
  9449. }
  9450. }
  9451. },
  9452. "delete": {
  9453. "produces": [
  9454. "application/json"
  9455. ],
  9456. "tags": [
  9457. "user"
  9458. ],
  9459. "summary": "Remove a GPG key",
  9460. "operationId": "userCurrentDeleteGPGKey",
  9461. "parameters": [
  9462. {
  9463. "type": "integer",
  9464. "format": "int64",
  9465. "description": "id of key to delete",
  9466. "name": "id",
  9467. "in": "path",
  9468. "required": true
  9469. }
  9470. ],
  9471. "responses": {
  9472. "204": {
  9473. "$ref": "#/responses/empty"
  9474. },
  9475. "403": {
  9476. "$ref": "#/responses/forbidden"
  9477. },
  9478. "404": {
  9479. "$ref": "#/responses/notFound"
  9480. }
  9481. }
  9482. }
  9483. },
  9484. "/user/keys": {
  9485. "get": {
  9486. "produces": [
  9487. "application/json"
  9488. ],
  9489. "tags": [
  9490. "user"
  9491. ],
  9492. "summary": "List the authenticated user's public keys",
  9493. "operationId": "userCurrentListKeys",
  9494. "parameters": [
  9495. {
  9496. "type": "string",
  9497. "description": "fingerprint of the key",
  9498. "name": "fingerprint",
  9499. "in": "query"
  9500. },
  9501. {
  9502. "type": "integer",
  9503. "description": "page number of results to return (1-based)",
  9504. "name": "page",
  9505. "in": "query"
  9506. },
  9507. {
  9508. "type": "integer",
  9509. "description": "page size of results",
  9510. "name": "limit",
  9511. "in": "query"
  9512. }
  9513. ],
  9514. "responses": {
  9515. "200": {
  9516. "$ref": "#/responses/PublicKeyList"
  9517. }
  9518. }
  9519. },
  9520. "post": {
  9521. "consumes": [
  9522. "application/json"
  9523. ],
  9524. "produces": [
  9525. "application/json"
  9526. ],
  9527. "tags": [
  9528. "user"
  9529. ],
  9530. "summary": "Create a public key",
  9531. "operationId": "userCurrentPostKey",
  9532. "parameters": [
  9533. {
  9534. "name": "body",
  9535. "in": "body",
  9536. "schema": {
  9537. "$ref": "#/definitions/CreateKeyOption"
  9538. }
  9539. }
  9540. ],
  9541. "responses": {
  9542. "201": {
  9543. "$ref": "#/responses/PublicKey"
  9544. },
  9545. "422": {
  9546. "$ref": "#/responses/validationError"
  9547. }
  9548. }
  9549. }
  9550. },
  9551. "/user/keys/{id}": {
  9552. "get": {
  9553. "produces": [
  9554. "application/json"
  9555. ],
  9556. "tags": [
  9557. "user"
  9558. ],
  9559. "summary": "Get a public key",
  9560. "operationId": "userCurrentGetKey",
  9561. "parameters": [
  9562. {
  9563. "type": "integer",
  9564. "format": "int64",
  9565. "description": "id of key to get",
  9566. "name": "id",
  9567. "in": "path",
  9568. "required": true
  9569. }
  9570. ],
  9571. "responses": {
  9572. "200": {
  9573. "$ref": "#/responses/PublicKey"
  9574. },
  9575. "404": {
  9576. "$ref": "#/responses/notFound"
  9577. }
  9578. }
  9579. },
  9580. "delete": {
  9581. "produces": [
  9582. "application/json"
  9583. ],
  9584. "tags": [
  9585. "user"
  9586. ],
  9587. "summary": "Delete a public key",
  9588. "operationId": "userCurrentDeleteKey",
  9589. "parameters": [
  9590. {
  9591. "type": "integer",
  9592. "format": "int64",
  9593. "description": "id of key to delete",
  9594. "name": "id",
  9595. "in": "path",
  9596. "required": true
  9597. }
  9598. ],
  9599. "responses": {
  9600. "204": {
  9601. "$ref": "#/responses/empty"
  9602. },
  9603. "403": {
  9604. "$ref": "#/responses/forbidden"
  9605. },
  9606. "404": {
  9607. "$ref": "#/responses/notFound"
  9608. }
  9609. }
  9610. }
  9611. },
  9612. "/user/orgs": {
  9613. "get": {
  9614. "produces": [
  9615. "application/json"
  9616. ],
  9617. "tags": [
  9618. "organization"
  9619. ],
  9620. "summary": "List the current user's organizations",
  9621. "operationId": "orgListCurrentUserOrgs",
  9622. "parameters": [
  9623. {
  9624. "type": "integer",
  9625. "description": "page number of results to return (1-based)",
  9626. "name": "page",
  9627. "in": "query"
  9628. },
  9629. {
  9630. "type": "integer",
  9631. "description": "page size of results",
  9632. "name": "limit",
  9633. "in": "query"
  9634. }
  9635. ],
  9636. "responses": {
  9637. "200": {
  9638. "$ref": "#/responses/OrganizationList"
  9639. }
  9640. }
  9641. }
  9642. },
  9643. "/user/repos": {
  9644. "get": {
  9645. "produces": [
  9646. "application/json"
  9647. ],
  9648. "tags": [
  9649. "user"
  9650. ],
  9651. "summary": "List the repos that the authenticated user owns or has access to",
  9652. "operationId": "userCurrentListRepos",
  9653. "parameters": [
  9654. {
  9655. "type": "integer",
  9656. "description": "page number of results to return (1-based)",
  9657. "name": "page",
  9658. "in": "query"
  9659. },
  9660. {
  9661. "type": "integer",
  9662. "description": "page size of results",
  9663. "name": "limit",
  9664. "in": "query"
  9665. }
  9666. ],
  9667. "responses": {
  9668. "200": {
  9669. "$ref": "#/responses/RepositoryList"
  9670. }
  9671. }
  9672. },
  9673. "post": {
  9674. "consumes": [
  9675. "application/json"
  9676. ],
  9677. "produces": [
  9678. "application/json"
  9679. ],
  9680. "tags": [
  9681. "repository",
  9682. "user"
  9683. ],
  9684. "summary": "Create a repository",
  9685. "operationId": "createCurrentUserRepo",
  9686. "parameters": [
  9687. {
  9688. "name": "body",
  9689. "in": "body",
  9690. "schema": {
  9691. "$ref": "#/definitions/CreateRepoOption"
  9692. }
  9693. }
  9694. ],
  9695. "responses": {
  9696. "201": {
  9697. "$ref": "#/responses/Repository"
  9698. },
  9699. "409": {
  9700. "description": "The repository with the same name already exists."
  9701. },
  9702. "422": {
  9703. "$ref": "#/responses/validationError"
  9704. }
  9705. }
  9706. }
  9707. },
  9708. "/user/starred": {
  9709. "get": {
  9710. "produces": [
  9711. "application/json"
  9712. ],
  9713. "tags": [
  9714. "user"
  9715. ],
  9716. "summary": "The repos that the authenticated user has starred",
  9717. "operationId": "userCurrentListStarred",
  9718. "parameters": [
  9719. {
  9720. "type": "integer",
  9721. "description": "page number of results to return (1-based)",
  9722. "name": "page",
  9723. "in": "query"
  9724. },
  9725. {
  9726. "type": "integer",
  9727. "description": "page size of results",
  9728. "name": "limit",
  9729. "in": "query"
  9730. }
  9731. ],
  9732. "responses": {
  9733. "200": {
  9734. "$ref": "#/responses/RepositoryList"
  9735. }
  9736. }
  9737. }
  9738. },
  9739. "/user/starred/{owner}/{repo}": {
  9740. "get": {
  9741. "tags": [
  9742. "user"
  9743. ],
  9744. "summary": "Whether the authenticated is starring the repo",
  9745. "operationId": "userCurrentCheckStarring",
  9746. "parameters": [
  9747. {
  9748. "type": "string",
  9749. "description": "owner of the repo",
  9750. "name": "owner",
  9751. "in": "path",
  9752. "required": true
  9753. },
  9754. {
  9755. "type": "string",
  9756. "description": "name of the repo",
  9757. "name": "repo",
  9758. "in": "path",
  9759. "required": true
  9760. }
  9761. ],
  9762. "responses": {
  9763. "204": {
  9764. "$ref": "#/responses/empty"
  9765. },
  9766. "404": {
  9767. "$ref": "#/responses/notFound"
  9768. }
  9769. }
  9770. },
  9771. "put": {
  9772. "tags": [
  9773. "user"
  9774. ],
  9775. "summary": "Star the given repo",
  9776. "operationId": "userCurrentPutStar",
  9777. "parameters": [
  9778. {
  9779. "type": "string",
  9780. "description": "owner of the repo to star",
  9781. "name": "owner",
  9782. "in": "path",
  9783. "required": true
  9784. },
  9785. {
  9786. "type": "string",
  9787. "description": "name of the repo to star",
  9788. "name": "repo",
  9789. "in": "path",
  9790. "required": true
  9791. }
  9792. ],
  9793. "responses": {
  9794. "204": {
  9795. "$ref": "#/responses/empty"
  9796. }
  9797. }
  9798. },
  9799. "delete": {
  9800. "tags": [
  9801. "user"
  9802. ],
  9803. "summary": "Unstar the given repo",
  9804. "operationId": "userCurrentDeleteStar",
  9805. "parameters": [
  9806. {
  9807. "type": "string",
  9808. "description": "owner of the repo to unstar",
  9809. "name": "owner",
  9810. "in": "path",
  9811. "required": true
  9812. },
  9813. {
  9814. "type": "string",
  9815. "description": "name of the repo to unstar",
  9816. "name": "repo",
  9817. "in": "path",
  9818. "required": true
  9819. }
  9820. ],
  9821. "responses": {
  9822. "204": {
  9823. "$ref": "#/responses/empty"
  9824. }
  9825. }
  9826. }
  9827. },
  9828. "/user/stopwatches": {
  9829. "get": {
  9830. "consumes": [
  9831. "application/json"
  9832. ],
  9833. "produces": [
  9834. "application/json"
  9835. ],
  9836. "tags": [
  9837. "user"
  9838. ],
  9839. "summary": "Get list of all existing stopwatches",
  9840. "operationId": "userGetStopWatches",
  9841. "parameters": [
  9842. {
  9843. "type": "integer",
  9844. "description": "page number of results to return (1-based)",
  9845. "name": "page",
  9846. "in": "query"
  9847. },
  9848. {
  9849. "type": "integer",
  9850. "description": "page size of results",
  9851. "name": "limit",
  9852. "in": "query"
  9853. }
  9854. ],
  9855. "responses": {
  9856. "200": {
  9857. "$ref": "#/responses/StopWatchList"
  9858. }
  9859. }
  9860. }
  9861. },
  9862. "/user/subscriptions": {
  9863. "get": {
  9864. "produces": [
  9865. "application/json"
  9866. ],
  9867. "tags": [
  9868. "user"
  9869. ],
  9870. "summary": "List repositories watched by the authenticated user",
  9871. "operationId": "userCurrentListSubscriptions",
  9872. "parameters": [
  9873. {
  9874. "type": "integer",
  9875. "description": "page number of results to return (1-based)",
  9876. "name": "page",
  9877. "in": "query"
  9878. },
  9879. {
  9880. "type": "integer",
  9881. "description": "page size of results",
  9882. "name": "limit",
  9883. "in": "query"
  9884. }
  9885. ],
  9886. "responses": {
  9887. "200": {
  9888. "$ref": "#/responses/RepositoryList"
  9889. }
  9890. }
  9891. }
  9892. },
  9893. "/user/teams": {
  9894. "get": {
  9895. "produces": [
  9896. "application/json"
  9897. ],
  9898. "tags": [
  9899. "user"
  9900. ],
  9901. "summary": "List all the teams a user belongs to",
  9902. "operationId": "userListTeams",
  9903. "parameters": [
  9904. {
  9905. "type": "integer",
  9906. "description": "page number of results to return (1-based)",
  9907. "name": "page",
  9908. "in": "query"
  9909. },
  9910. {
  9911. "type": "integer",
  9912. "description": "page size of results",
  9913. "name": "limit",
  9914. "in": "query"
  9915. }
  9916. ],
  9917. "responses": {
  9918. "200": {
  9919. "$ref": "#/responses/TeamList"
  9920. }
  9921. }
  9922. }
  9923. },
  9924. "/user/times": {
  9925. "get": {
  9926. "produces": [
  9927. "application/json"
  9928. ],
  9929. "tags": [
  9930. "user"
  9931. ],
  9932. "summary": "List the current user's tracked times",
  9933. "operationId": "userCurrentTrackedTimes",
  9934. "parameters": [
  9935. {
  9936. "type": "string",
  9937. "format": "date-time",
  9938. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  9939. "name": "since",
  9940. "in": "query"
  9941. },
  9942. {
  9943. "type": "string",
  9944. "format": "date-time",
  9945. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  9946. "name": "before",
  9947. "in": "query"
  9948. }
  9949. ],
  9950. "responses": {
  9951. "200": {
  9952. "$ref": "#/responses/TrackedTimeList"
  9953. }
  9954. }
  9955. }
  9956. },
  9957. "/users/search": {
  9958. "get": {
  9959. "produces": [
  9960. "application/json"
  9961. ],
  9962. "tags": [
  9963. "user"
  9964. ],
  9965. "summary": "Search for users",
  9966. "operationId": "userSearch",
  9967. "parameters": [
  9968. {
  9969. "type": "string",
  9970. "description": "keyword",
  9971. "name": "q",
  9972. "in": "query"
  9973. },
  9974. {
  9975. "type": "integer",
  9976. "format": "int64",
  9977. "description": "ID of the user to search for",
  9978. "name": "uid",
  9979. "in": "query"
  9980. },
  9981. {
  9982. "type": "integer",
  9983. "description": "page number of results to return (1-based)",
  9984. "name": "page",
  9985. "in": "query"
  9986. },
  9987. {
  9988. "type": "integer",
  9989. "description": "page size of results",
  9990. "name": "limit",
  9991. "in": "query"
  9992. }
  9993. ],
  9994. "responses": {
  9995. "200": {
  9996. "description": "SearchResults of a successful search",
  9997. "schema": {
  9998. "type": "object",
  9999. "properties": {
  10000. "data": {
  10001. "type": "array",
  10002. "items": {
  10003. "$ref": "#/definitions/User"
  10004. }
  10005. },
  10006. "ok": {
  10007. "type": "boolean"
  10008. }
  10009. }
  10010. }
  10011. }
  10012. }
  10013. }
  10014. },
  10015. "/users/{follower}/following/{followee}": {
  10016. "get": {
  10017. "tags": [
  10018. "user"
  10019. ],
  10020. "summary": "Check if one user is following another user",
  10021. "operationId": "userCheckFollowing",
  10022. "parameters": [
  10023. {
  10024. "type": "string",
  10025. "description": "username of following user",
  10026. "name": "follower",
  10027. "in": "path",
  10028. "required": true
  10029. },
  10030. {
  10031. "type": "string",
  10032. "description": "username of followed user",
  10033. "name": "followee",
  10034. "in": "path",
  10035. "required": true
  10036. }
  10037. ],
  10038. "responses": {
  10039. "204": {
  10040. "$ref": "#/responses/empty"
  10041. },
  10042. "404": {
  10043. "$ref": "#/responses/notFound"
  10044. }
  10045. }
  10046. }
  10047. },
  10048. "/users/{username}": {
  10049. "get": {
  10050. "produces": [
  10051. "application/json"
  10052. ],
  10053. "tags": [
  10054. "user"
  10055. ],
  10056. "summary": "Get a user",
  10057. "operationId": "userGet",
  10058. "parameters": [
  10059. {
  10060. "type": "string",
  10061. "description": "username of user to get",
  10062. "name": "username",
  10063. "in": "path",
  10064. "required": true
  10065. }
  10066. ],
  10067. "responses": {
  10068. "200": {
  10069. "$ref": "#/responses/User"
  10070. },
  10071. "404": {
  10072. "$ref": "#/responses/notFound"
  10073. }
  10074. }
  10075. }
  10076. },
  10077. "/users/{username}/followers": {
  10078. "get": {
  10079. "produces": [
  10080. "application/json"
  10081. ],
  10082. "tags": [
  10083. "user"
  10084. ],
  10085. "summary": "List the given user's followers",
  10086. "operationId": "userListFollowers",
  10087. "parameters": [
  10088. {
  10089. "type": "string",
  10090. "description": "username of user",
  10091. "name": "username",
  10092. "in": "path",
  10093. "required": true
  10094. },
  10095. {
  10096. "type": "integer",
  10097. "description": "page number of results to return (1-based)",
  10098. "name": "page",
  10099. "in": "query"
  10100. },
  10101. {
  10102. "type": "integer",
  10103. "description": "page size of results",
  10104. "name": "limit",
  10105. "in": "query"
  10106. }
  10107. ],
  10108. "responses": {
  10109. "200": {
  10110. "$ref": "#/responses/UserList"
  10111. }
  10112. }
  10113. }
  10114. },
  10115. "/users/{username}/following": {
  10116. "get": {
  10117. "produces": [
  10118. "application/json"
  10119. ],
  10120. "tags": [
  10121. "user"
  10122. ],
  10123. "summary": "List the users that the given user is following",
  10124. "operationId": "userListFollowing",
  10125. "parameters": [
  10126. {
  10127. "type": "string",
  10128. "description": "username of user",
  10129. "name": "username",
  10130. "in": "path",
  10131. "required": true
  10132. },
  10133. {
  10134. "type": "integer",
  10135. "description": "page number of results to return (1-based)",
  10136. "name": "page",
  10137. "in": "query"
  10138. },
  10139. {
  10140. "type": "integer",
  10141. "description": "page size of results",
  10142. "name": "limit",
  10143. "in": "query"
  10144. }
  10145. ],
  10146. "responses": {
  10147. "200": {
  10148. "$ref": "#/responses/UserList"
  10149. }
  10150. }
  10151. }
  10152. },
  10153. "/users/{username}/gpg_keys": {
  10154. "get": {
  10155. "produces": [
  10156. "application/json"
  10157. ],
  10158. "tags": [
  10159. "user"
  10160. ],
  10161. "summary": "List the given user's GPG keys",
  10162. "operationId": "userListGPGKeys",
  10163. "parameters": [
  10164. {
  10165. "type": "string",
  10166. "description": "username of user",
  10167. "name": "username",
  10168. "in": "path",
  10169. "required": true
  10170. },
  10171. {
  10172. "type": "integer",
  10173. "description": "page number of results to return (1-based)",
  10174. "name": "page",
  10175. "in": "query"
  10176. },
  10177. {
  10178. "type": "integer",
  10179. "description": "page size of results",
  10180. "name": "limit",
  10181. "in": "query"
  10182. }
  10183. ],
  10184. "responses": {
  10185. "200": {
  10186. "$ref": "#/responses/GPGKeyList"
  10187. }
  10188. }
  10189. }
  10190. },
  10191. "/users/{username}/heatmap": {
  10192. "get": {
  10193. "produces": [
  10194. "application/json"
  10195. ],
  10196. "tags": [
  10197. "user"
  10198. ],
  10199. "summary": "Get a user's heatmap",
  10200. "operationId": "userGetHeatmapData",
  10201. "parameters": [
  10202. {
  10203. "type": "string",
  10204. "description": "username of user to get",
  10205. "name": "username",
  10206. "in": "path",
  10207. "required": true
  10208. }
  10209. ],
  10210. "responses": {
  10211. "200": {
  10212. "$ref": "#/responses/UserHeatmapData"
  10213. },
  10214. "404": {
  10215. "$ref": "#/responses/notFound"
  10216. }
  10217. }
  10218. }
  10219. },
  10220. "/users/{username}/keys": {
  10221. "get": {
  10222. "produces": [
  10223. "application/json"
  10224. ],
  10225. "tags": [
  10226. "user"
  10227. ],
  10228. "summary": "List the given user's public keys",
  10229. "operationId": "userListKeys",
  10230. "parameters": [
  10231. {
  10232. "type": "string",
  10233. "description": "username of user",
  10234. "name": "username",
  10235. "in": "path",
  10236. "required": true
  10237. },
  10238. {
  10239. "type": "string",
  10240. "description": "fingerprint of the key",
  10241. "name": "fingerprint",
  10242. "in": "query"
  10243. },
  10244. {
  10245. "type": "integer",
  10246. "description": "page number of results to return (1-based)",
  10247. "name": "page",
  10248. "in": "query"
  10249. },
  10250. {
  10251. "type": "integer",
  10252. "description": "page size of results",
  10253. "name": "limit",
  10254. "in": "query"
  10255. }
  10256. ],
  10257. "responses": {
  10258. "200": {
  10259. "$ref": "#/responses/PublicKeyList"
  10260. }
  10261. }
  10262. }
  10263. },
  10264. "/users/{username}/orgs": {
  10265. "get": {
  10266. "produces": [
  10267. "application/json"
  10268. ],
  10269. "tags": [
  10270. "organization"
  10271. ],
  10272. "summary": "List a user's organizations",
  10273. "operationId": "orgListUserOrgs",
  10274. "parameters": [
  10275. {
  10276. "type": "string",
  10277. "description": "username of user",
  10278. "name": "username",
  10279. "in": "path",
  10280. "required": true
  10281. },
  10282. {
  10283. "type": "integer",
  10284. "description": "page number of results to return (1-based)",
  10285. "name": "page",
  10286. "in": "query"
  10287. },
  10288. {
  10289. "type": "integer",
  10290. "description": "page size of results",
  10291. "name": "limit",
  10292. "in": "query"
  10293. }
  10294. ],
  10295. "responses": {
  10296. "200": {
  10297. "$ref": "#/responses/OrganizationList"
  10298. }
  10299. }
  10300. }
  10301. },
  10302. "/users/{username}/repos": {
  10303. "get": {
  10304. "produces": [
  10305. "application/json"
  10306. ],
  10307. "tags": [
  10308. "user"
  10309. ],
  10310. "summary": "List the repos owned by the given user",
  10311. "operationId": "userListRepos",
  10312. "parameters": [
  10313. {
  10314. "type": "string",
  10315. "description": "username of user",
  10316. "name": "username",
  10317. "in": "path",
  10318. "required": true
  10319. },
  10320. {
  10321. "type": "integer",
  10322. "description": "page number of results to return (1-based)",
  10323. "name": "page",
  10324. "in": "query"
  10325. },
  10326. {
  10327. "type": "integer",
  10328. "description": "page size of results",
  10329. "name": "limit",
  10330. "in": "query"
  10331. }
  10332. ],
  10333. "responses": {
  10334. "200": {
  10335. "$ref": "#/responses/RepositoryList"
  10336. }
  10337. }
  10338. }
  10339. },
  10340. "/users/{username}/starred": {
  10341. "get": {
  10342. "produces": [
  10343. "application/json"
  10344. ],
  10345. "tags": [
  10346. "user"
  10347. ],
  10348. "summary": "The repos that the given user has starred",
  10349. "operationId": "userListStarred",
  10350. "parameters": [
  10351. {
  10352. "type": "string",
  10353. "description": "username of user",
  10354. "name": "username",
  10355. "in": "path",
  10356. "required": true
  10357. },
  10358. {
  10359. "type": "integer",
  10360. "description": "page number of results to return (1-based)",
  10361. "name": "page",
  10362. "in": "query"
  10363. },
  10364. {
  10365. "type": "integer",
  10366. "description": "page size of results",
  10367. "name": "limit",
  10368. "in": "query"
  10369. }
  10370. ],
  10371. "responses": {
  10372. "200": {
  10373. "$ref": "#/responses/RepositoryList"
  10374. }
  10375. }
  10376. }
  10377. },
  10378. "/users/{username}/subscriptions": {
  10379. "get": {
  10380. "produces": [
  10381. "application/json"
  10382. ],
  10383. "tags": [
  10384. "user"
  10385. ],
  10386. "summary": "List the repositories watched by a user",
  10387. "operationId": "userListSubscriptions",
  10388. "parameters": [
  10389. {
  10390. "type": "string",
  10391. "description": "username of the user",
  10392. "name": "username",
  10393. "in": "path",
  10394. "required": true
  10395. },
  10396. {
  10397. "type": "integer",
  10398. "description": "page number of results to return (1-based)",
  10399. "name": "page",
  10400. "in": "query"
  10401. },
  10402. {
  10403. "type": "integer",
  10404. "description": "page size of results",
  10405. "name": "limit",
  10406. "in": "query"
  10407. }
  10408. ],
  10409. "responses": {
  10410. "200": {
  10411. "$ref": "#/responses/RepositoryList"
  10412. }
  10413. }
  10414. }
  10415. },
  10416. "/users/{username}/tokens": {
  10417. "get": {
  10418. "produces": [
  10419. "application/json"
  10420. ],
  10421. "tags": [
  10422. "user"
  10423. ],
  10424. "summary": "List the authenticated user's access tokens",
  10425. "operationId": "userGetTokens",
  10426. "parameters": [
  10427. {
  10428. "type": "string",
  10429. "description": "username of user",
  10430. "name": "username",
  10431. "in": "path",
  10432. "required": true
  10433. },
  10434. {
  10435. "type": "integer",
  10436. "description": "page number of results to return (1-based)",
  10437. "name": "page",
  10438. "in": "query"
  10439. },
  10440. {
  10441. "type": "integer",
  10442. "description": "page size of results",
  10443. "name": "limit",
  10444. "in": "query"
  10445. }
  10446. ],
  10447. "responses": {
  10448. "200": {
  10449. "$ref": "#/responses/AccessTokenList"
  10450. }
  10451. }
  10452. },
  10453. "post": {
  10454. "consumes": [
  10455. "application/json"
  10456. ],
  10457. "produces": [
  10458. "application/json"
  10459. ],
  10460. "tags": [
  10461. "user"
  10462. ],
  10463. "summary": "Create an access token",
  10464. "operationId": "userCreateToken",
  10465. "parameters": [
  10466. {
  10467. "type": "string",
  10468. "x-go-name": "Name",
  10469. "description": "username of user",
  10470. "name": "username",
  10471. "in": "path",
  10472. "required": true
  10473. },
  10474. {
  10475. "name": "accessToken",
  10476. "in": "body",
  10477. "schema": {
  10478. "type": "object",
  10479. "required": [
  10480. "name"
  10481. ],
  10482. "properties": {
  10483. "name": {
  10484. "type": "string"
  10485. }
  10486. }
  10487. }
  10488. }
  10489. ],
  10490. "responses": {
  10491. "200": {
  10492. "$ref": "#/responses/AccessToken"
  10493. }
  10494. }
  10495. }
  10496. },
  10497. "/users/{username}/tokens/{token}": {
  10498. "delete": {
  10499. "produces": [
  10500. "application/json"
  10501. ],
  10502. "tags": [
  10503. "user"
  10504. ],
  10505. "summary": "delete an access token",
  10506. "operationId": "userDeleteAccessToken",
  10507. "parameters": [
  10508. {
  10509. "type": "string",
  10510. "description": "username of user",
  10511. "name": "username",
  10512. "in": "path",
  10513. "required": true
  10514. },
  10515. {
  10516. "type": "integer",
  10517. "format": "int64",
  10518. "description": "token to be deleted",
  10519. "name": "token",
  10520. "in": "path",
  10521. "required": true
  10522. }
  10523. ],
  10524. "responses": {
  10525. "204": {
  10526. "$ref": "#/responses/empty"
  10527. }
  10528. }
  10529. }
  10530. },
  10531. "/version": {
  10532. "get": {
  10533. "produces": [
  10534. "application/json"
  10535. ],
  10536. "tags": [
  10537. "miscellaneous"
  10538. ],
  10539. "summary": "Returns the version of the Gitea application",
  10540. "operationId": "getVersion",
  10541. "responses": {
  10542. "200": {
  10543. "$ref": "#/responses/ServerVersion"
  10544. }
  10545. }
  10546. }
  10547. }
  10548. },
  10549. "definitions": {
  10550. "APIError": {
  10551. "description": "APIError is an api error with a message",
  10552. "type": "object",
  10553. "properties": {
  10554. "message": {
  10555. "type": "string",
  10556. "x-go-name": "Message"
  10557. },
  10558. "url": {
  10559. "type": "string",
  10560. "x-go-name": "URL"
  10561. }
  10562. },
  10563. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10564. },
  10565. "AccessToken": {
  10566. "type": "object",
  10567. "title": "AccessToken represents an API access token.",
  10568. "properties": {
  10569. "id": {
  10570. "type": "integer",
  10571. "format": "int64",
  10572. "x-go-name": "ID"
  10573. },
  10574. "name": {
  10575. "type": "string",
  10576. "x-go-name": "Name"
  10577. },
  10578. "sha1": {
  10579. "type": "string",
  10580. "x-go-name": "Token"
  10581. },
  10582. "token_last_eight": {
  10583. "type": "string",
  10584. "x-go-name": "TokenLastEight"
  10585. }
  10586. },
  10587. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10588. },
  10589. "AddCollaboratorOption": {
  10590. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  10591. "type": "object",
  10592. "properties": {
  10593. "permission": {
  10594. "type": "string",
  10595. "x-go-name": "Permission"
  10596. }
  10597. },
  10598. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10599. },
  10600. "AddTimeOption": {
  10601. "description": "AddTimeOption options for adding time to an issue",
  10602. "type": "object",
  10603. "required": [
  10604. "time"
  10605. ],
  10606. "properties": {
  10607. "created": {
  10608. "type": "string",
  10609. "format": "date-time",
  10610. "x-go-name": "Created"
  10611. },
  10612. "time": {
  10613. "description": "time in seconds",
  10614. "type": "integer",
  10615. "format": "int64",
  10616. "x-go-name": "Time"
  10617. },
  10618. "user_name": {
  10619. "description": "User who spent the time (optional)",
  10620. "type": "string",
  10621. "x-go-name": "User"
  10622. }
  10623. },
  10624. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10625. },
  10626. "AnnotatedTag": {
  10627. "description": "AnnotatedTag represents an annotated tag",
  10628. "type": "object",
  10629. "properties": {
  10630. "message": {
  10631. "type": "string",
  10632. "x-go-name": "Message"
  10633. },
  10634. "object": {
  10635. "$ref": "#/definitions/AnnotatedTagObject"
  10636. },
  10637. "sha": {
  10638. "type": "string",
  10639. "x-go-name": "SHA"
  10640. },
  10641. "tag": {
  10642. "type": "string",
  10643. "x-go-name": "Tag"
  10644. },
  10645. "tagger": {
  10646. "$ref": "#/definitions/CommitUser"
  10647. },
  10648. "url": {
  10649. "type": "string",
  10650. "x-go-name": "URL"
  10651. },
  10652. "verification": {
  10653. "$ref": "#/definitions/PayloadCommitVerification"
  10654. }
  10655. },
  10656. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10657. },
  10658. "AnnotatedTagObject": {
  10659. "description": "AnnotatedTagObject contains meta information of the tag object",
  10660. "type": "object",
  10661. "properties": {
  10662. "sha": {
  10663. "type": "string",
  10664. "x-go-name": "SHA"
  10665. },
  10666. "type": {
  10667. "type": "string",
  10668. "x-go-name": "Type"
  10669. },
  10670. "url": {
  10671. "type": "string",
  10672. "x-go-name": "URL"
  10673. }
  10674. },
  10675. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10676. },
  10677. "Attachment": {
  10678. "description": "Attachment a generic attachment",
  10679. "type": "object",
  10680. "properties": {
  10681. "browser_download_url": {
  10682. "type": "string",
  10683. "x-go-name": "DownloadURL"
  10684. },
  10685. "created_at": {
  10686. "type": "string",
  10687. "format": "date-time",
  10688. "x-go-name": "Created"
  10689. },
  10690. "download_count": {
  10691. "type": "integer",
  10692. "format": "int64",
  10693. "x-go-name": "DownloadCount"
  10694. },
  10695. "id": {
  10696. "type": "integer",
  10697. "format": "int64",
  10698. "x-go-name": "ID"
  10699. },
  10700. "name": {
  10701. "type": "string",
  10702. "x-go-name": "Name"
  10703. },
  10704. "size": {
  10705. "type": "integer",
  10706. "format": "int64",
  10707. "x-go-name": "Size"
  10708. },
  10709. "uuid": {
  10710. "type": "string",
  10711. "x-go-name": "UUID"
  10712. }
  10713. },
  10714. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10715. },
  10716. "Branch": {
  10717. "description": "Branch represents a repository branch",
  10718. "type": "object",
  10719. "properties": {
  10720. "commit": {
  10721. "$ref": "#/definitions/PayloadCommit"
  10722. },
  10723. "effective_branch_protection_name": {
  10724. "type": "string",
  10725. "x-go-name": "EffectiveBranchProtectionName"
  10726. },
  10727. "enable_status_check": {
  10728. "type": "boolean",
  10729. "x-go-name": "EnableStatusCheck"
  10730. },
  10731. "name": {
  10732. "type": "string",
  10733. "x-go-name": "Name"
  10734. },
  10735. "protected": {
  10736. "type": "boolean",
  10737. "x-go-name": "Protected"
  10738. },
  10739. "required_approvals": {
  10740. "type": "integer",
  10741. "format": "int64",
  10742. "x-go-name": "RequiredApprovals"
  10743. },
  10744. "status_check_contexts": {
  10745. "type": "array",
  10746. "items": {
  10747. "type": "string"
  10748. },
  10749. "x-go-name": "StatusCheckContexts"
  10750. },
  10751. "user_can_merge": {
  10752. "type": "boolean",
  10753. "x-go-name": "UserCanMerge"
  10754. },
  10755. "user_can_push": {
  10756. "type": "boolean",
  10757. "x-go-name": "UserCanPush"
  10758. }
  10759. },
  10760. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10761. },
  10762. "BranchProtection": {
  10763. "description": "BranchProtection represents a branch protection for a repository",
  10764. "type": "object",
  10765. "properties": {
  10766. "approvals_whitelist_teams": {
  10767. "type": "array",
  10768. "items": {
  10769. "type": "string"
  10770. },
  10771. "x-go-name": "ApprovalsWhitelistTeams"
  10772. },
  10773. "approvals_whitelist_username": {
  10774. "type": "array",
  10775. "items": {
  10776. "type": "string"
  10777. },
  10778. "x-go-name": "ApprovalsWhitelistUsernames"
  10779. },
  10780. "block_on_outdated_branch": {
  10781. "type": "boolean",
  10782. "x-go-name": "BlockOnOutdatedBranch"
  10783. },
  10784. "block_on_rejected_reviews": {
  10785. "type": "boolean",
  10786. "x-go-name": "BlockOnRejectedReviews"
  10787. },
  10788. "branch_name": {
  10789. "type": "string",
  10790. "x-go-name": "BranchName"
  10791. },
  10792. "created_at": {
  10793. "type": "string",
  10794. "format": "date-time",
  10795. "x-go-name": "Created"
  10796. },
  10797. "dismiss_stale_approvals": {
  10798. "type": "boolean",
  10799. "x-go-name": "DismissStaleApprovals"
  10800. },
  10801. "enable_approvals_whitelist": {
  10802. "type": "boolean",
  10803. "x-go-name": "EnableApprovalsWhitelist"
  10804. },
  10805. "enable_merge_whitelist": {
  10806. "type": "boolean",
  10807. "x-go-name": "EnableMergeWhitelist"
  10808. },
  10809. "enable_push": {
  10810. "type": "boolean",
  10811. "x-go-name": "EnablePush"
  10812. },
  10813. "enable_push_whitelist": {
  10814. "type": "boolean",
  10815. "x-go-name": "EnablePushWhitelist"
  10816. },
  10817. "enable_status_check": {
  10818. "type": "boolean",
  10819. "x-go-name": "EnableStatusCheck"
  10820. },
  10821. "merge_whitelist_teams": {
  10822. "type": "array",
  10823. "items": {
  10824. "type": "string"
  10825. },
  10826. "x-go-name": "MergeWhitelistTeams"
  10827. },
  10828. "merge_whitelist_usernames": {
  10829. "type": "array",
  10830. "items": {
  10831. "type": "string"
  10832. },
  10833. "x-go-name": "MergeWhitelistUsernames"
  10834. },
  10835. "protected_file_patterns": {
  10836. "type": "string",
  10837. "x-go-name": "ProtectedFilePatterns"
  10838. },
  10839. "push_whitelist_deploy_keys": {
  10840. "type": "boolean",
  10841. "x-go-name": "PushWhitelistDeployKeys"
  10842. },
  10843. "push_whitelist_teams": {
  10844. "type": "array",
  10845. "items": {
  10846. "type": "string"
  10847. },
  10848. "x-go-name": "PushWhitelistTeams"
  10849. },
  10850. "push_whitelist_usernames": {
  10851. "type": "array",
  10852. "items": {
  10853. "type": "string"
  10854. },
  10855. "x-go-name": "PushWhitelistUsernames"
  10856. },
  10857. "require_signed_commits": {
  10858. "type": "boolean",
  10859. "x-go-name": "RequireSignedCommits"
  10860. },
  10861. "required_approvals": {
  10862. "type": "integer",
  10863. "format": "int64",
  10864. "x-go-name": "RequiredApprovals"
  10865. },
  10866. "status_check_contexts": {
  10867. "type": "array",
  10868. "items": {
  10869. "type": "string"
  10870. },
  10871. "x-go-name": "StatusCheckContexts"
  10872. },
  10873. "updated_at": {
  10874. "type": "string",
  10875. "format": "date-time",
  10876. "x-go-name": "Updated"
  10877. }
  10878. },
  10879. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10880. },
  10881. "Comment": {
  10882. "description": "Comment represents a comment on a commit or issue",
  10883. "type": "object",
  10884. "properties": {
  10885. "body": {
  10886. "type": "string",
  10887. "x-go-name": "Body"
  10888. },
  10889. "created_at": {
  10890. "type": "string",
  10891. "format": "date-time",
  10892. "x-go-name": "Created"
  10893. },
  10894. "html_url": {
  10895. "type": "string",
  10896. "x-go-name": "HTMLURL"
  10897. },
  10898. "id": {
  10899. "type": "integer",
  10900. "format": "int64",
  10901. "x-go-name": "ID"
  10902. },
  10903. "issue_url": {
  10904. "type": "string",
  10905. "x-go-name": "IssueURL"
  10906. },
  10907. "original_author": {
  10908. "type": "string",
  10909. "x-go-name": "OriginalAuthor"
  10910. },
  10911. "original_author_id": {
  10912. "type": "integer",
  10913. "format": "int64",
  10914. "x-go-name": "OriginalAuthorID"
  10915. },
  10916. "pull_request_url": {
  10917. "type": "string",
  10918. "x-go-name": "PRURL"
  10919. },
  10920. "updated_at": {
  10921. "type": "string",
  10922. "format": "date-time",
  10923. "x-go-name": "Updated"
  10924. },
  10925. "user": {
  10926. "$ref": "#/definitions/User"
  10927. }
  10928. },
  10929. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10930. },
  10931. "Commit": {
  10932. "type": "object",
  10933. "title": "Commit contains information generated from a Git commit.",
  10934. "properties": {
  10935. "author": {
  10936. "$ref": "#/definitions/User"
  10937. },
  10938. "commit": {
  10939. "$ref": "#/definitions/RepoCommit"
  10940. },
  10941. "committer": {
  10942. "$ref": "#/definitions/User"
  10943. },
  10944. "html_url": {
  10945. "type": "string",
  10946. "x-go-name": "HTMLURL"
  10947. },
  10948. "parents": {
  10949. "type": "array",
  10950. "items": {
  10951. "$ref": "#/definitions/CommitMeta"
  10952. },
  10953. "x-go-name": "Parents"
  10954. },
  10955. "sha": {
  10956. "type": "string",
  10957. "x-go-name": "SHA"
  10958. },
  10959. "url": {
  10960. "type": "string",
  10961. "x-go-name": "URL"
  10962. }
  10963. },
  10964. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10965. },
  10966. "CommitDateOptions": {
  10967. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  10968. "type": "object",
  10969. "properties": {
  10970. "author": {
  10971. "type": "string",
  10972. "format": "date-time",
  10973. "x-go-name": "Author"
  10974. },
  10975. "committer": {
  10976. "type": "string",
  10977. "format": "date-time",
  10978. "x-go-name": "Committer"
  10979. }
  10980. },
  10981. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10982. },
  10983. "CommitMeta": {
  10984. "type": "object",
  10985. "title": "CommitMeta contains meta information of a commit in terms of API.",
  10986. "properties": {
  10987. "sha": {
  10988. "type": "string",
  10989. "x-go-name": "SHA"
  10990. },
  10991. "url": {
  10992. "type": "string",
  10993. "x-go-name": "URL"
  10994. }
  10995. },
  10996. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10997. },
  10998. "CommitUser": {
  10999. "type": "object",
  11000. "title": "CommitUser contains information of a user in the context of a commit.",
  11001. "properties": {
  11002. "date": {
  11003. "type": "string",
  11004. "x-go-name": "Date"
  11005. },
  11006. "email": {
  11007. "type": "string",
  11008. "format": "email",
  11009. "x-go-name": "Email"
  11010. },
  11011. "name": {
  11012. "type": "string",
  11013. "x-go-name": "Name"
  11014. }
  11015. },
  11016. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11017. },
  11018. "ContentsResponse": {
  11019. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  11020. "type": "object",
  11021. "properties": {
  11022. "_links": {
  11023. "$ref": "#/definitions/FileLinksResponse"
  11024. },
  11025. "content": {
  11026. "description": "`content` is populated when `type` is `file`, otherwise null",
  11027. "type": "string",
  11028. "x-go-name": "Content"
  11029. },
  11030. "download_url": {
  11031. "type": "string",
  11032. "x-go-name": "DownloadURL"
  11033. },
  11034. "encoding": {
  11035. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  11036. "type": "string",
  11037. "x-go-name": "Encoding"
  11038. },
  11039. "git_url": {
  11040. "type": "string",
  11041. "x-go-name": "GitURL"
  11042. },
  11043. "html_url": {
  11044. "type": "string",
  11045. "x-go-name": "HTMLURL"
  11046. },
  11047. "name": {
  11048. "type": "string",
  11049. "x-go-name": "Name"
  11050. },
  11051. "path": {
  11052. "type": "string",
  11053. "x-go-name": "Path"
  11054. },
  11055. "sha": {
  11056. "type": "string",
  11057. "x-go-name": "SHA"
  11058. },
  11059. "size": {
  11060. "type": "integer",
  11061. "format": "int64",
  11062. "x-go-name": "Size"
  11063. },
  11064. "submodule_git_url": {
  11065. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  11066. "type": "string",
  11067. "x-go-name": "SubmoduleGitURL"
  11068. },
  11069. "target": {
  11070. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  11071. "type": "string",
  11072. "x-go-name": "Target"
  11073. },
  11074. "type": {
  11075. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  11076. "type": "string",
  11077. "x-go-name": "Type"
  11078. },
  11079. "url": {
  11080. "type": "string",
  11081. "x-go-name": "URL"
  11082. }
  11083. },
  11084. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11085. },
  11086. "CreateBranchProtectionOption": {
  11087. "description": "CreateBranchProtectionOption options for creating a branch protection",
  11088. "type": "object",
  11089. "properties": {
  11090. "approvals_whitelist_teams": {
  11091. "type": "array",
  11092. "items": {
  11093. "type": "string"
  11094. },
  11095. "x-go-name": "ApprovalsWhitelistTeams"
  11096. },
  11097. "approvals_whitelist_username": {
  11098. "type": "array",
  11099. "items": {
  11100. "type": "string"
  11101. },
  11102. "x-go-name": "ApprovalsWhitelistUsernames"
  11103. },
  11104. "block_on_outdated_branch": {
  11105. "type": "boolean",
  11106. "x-go-name": "BlockOnOutdatedBranch"
  11107. },
  11108. "block_on_rejected_reviews": {
  11109. "type": "boolean",
  11110. "x-go-name": "BlockOnRejectedReviews"
  11111. },
  11112. "branch_name": {
  11113. "type": "string",
  11114. "x-go-name": "BranchName"
  11115. },
  11116. "dismiss_stale_approvals": {
  11117. "type": "boolean",
  11118. "x-go-name": "DismissStaleApprovals"
  11119. },
  11120. "enable_approvals_whitelist": {
  11121. "type": "boolean",
  11122. "x-go-name": "EnableApprovalsWhitelist"
  11123. },
  11124. "enable_merge_whitelist": {
  11125. "type": "boolean",
  11126. "x-go-name": "EnableMergeWhitelist"
  11127. },
  11128. "enable_push": {
  11129. "type": "boolean",
  11130. "x-go-name": "EnablePush"
  11131. },
  11132. "enable_push_whitelist": {
  11133. "type": "boolean",
  11134. "x-go-name": "EnablePushWhitelist"
  11135. },
  11136. "enable_status_check": {
  11137. "type": "boolean",
  11138. "x-go-name": "EnableStatusCheck"
  11139. },
  11140. "merge_whitelist_teams": {
  11141. "type": "array",
  11142. "items": {
  11143. "type": "string"
  11144. },
  11145. "x-go-name": "MergeWhitelistTeams"
  11146. },
  11147. "merge_whitelist_usernames": {
  11148. "type": "array",
  11149. "items": {
  11150. "type": "string"
  11151. },
  11152. "x-go-name": "MergeWhitelistUsernames"
  11153. },
  11154. "protected_file_patterns": {
  11155. "type": "string",
  11156. "x-go-name": "ProtectedFilePatterns"
  11157. },
  11158. "push_whitelist_deploy_keys": {
  11159. "type": "boolean",
  11160. "x-go-name": "PushWhitelistDeployKeys"
  11161. },
  11162. "push_whitelist_teams": {
  11163. "type": "array",
  11164. "items": {
  11165. "type": "string"
  11166. },
  11167. "x-go-name": "PushWhitelistTeams"
  11168. },
  11169. "push_whitelist_usernames": {
  11170. "type": "array",
  11171. "items": {
  11172. "type": "string"
  11173. },
  11174. "x-go-name": "PushWhitelistUsernames"
  11175. },
  11176. "require_signed_commits": {
  11177. "type": "boolean",
  11178. "x-go-name": "RequireSignedCommits"
  11179. },
  11180. "required_approvals": {
  11181. "type": "integer",
  11182. "format": "int64",
  11183. "x-go-name": "RequiredApprovals"
  11184. },
  11185. "status_check_contexts": {
  11186. "type": "array",
  11187. "items": {
  11188. "type": "string"
  11189. },
  11190. "x-go-name": "StatusCheckContexts"
  11191. }
  11192. },
  11193. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11194. },
  11195. "CreateBranchRepoOption": {
  11196. "description": "CreateBranchRepoOption options when creating a branch in a repository",
  11197. "type": "object",
  11198. "required": [
  11199. "new_branch_name"
  11200. ],
  11201. "properties": {
  11202. "new_branch_name": {
  11203. "description": "Name of the branch to create",
  11204. "type": "string",
  11205. "uniqueItems": true,
  11206. "x-go-name": "BranchName"
  11207. },
  11208. "old_branch_name": {
  11209. "description": "Name of the old branch to create from",
  11210. "type": "string",
  11211. "uniqueItems": true,
  11212. "x-go-name": "OldBranchName"
  11213. }
  11214. },
  11215. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11216. },
  11217. "CreateEmailOption": {
  11218. "description": "CreateEmailOption options when creating email addresses",
  11219. "type": "object",
  11220. "properties": {
  11221. "emails": {
  11222. "description": "email addresses to add",
  11223. "type": "array",
  11224. "items": {
  11225. "type": "string"
  11226. },
  11227. "x-go-name": "Emails"
  11228. }
  11229. },
  11230. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11231. },
  11232. "CreateFileOptions": {
  11233. "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)",
  11234. "type": "object",
  11235. "required": [
  11236. "content"
  11237. ],
  11238. "properties": {
  11239. "author": {
  11240. "$ref": "#/definitions/Identity"
  11241. },
  11242. "branch": {
  11243. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  11244. "type": "string",
  11245. "x-go-name": "BranchName"
  11246. },
  11247. "committer": {
  11248. "$ref": "#/definitions/Identity"
  11249. },
  11250. "content": {
  11251. "description": "content must be base64 encoded",
  11252. "type": "string",
  11253. "x-go-name": "Content"
  11254. },
  11255. "dates": {
  11256. "$ref": "#/definitions/CommitDateOptions"
  11257. },
  11258. "message": {
  11259. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  11260. "type": "string",
  11261. "x-go-name": "Message"
  11262. },
  11263. "new_branch": {
  11264. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  11265. "type": "string",
  11266. "x-go-name": "NewBranchName"
  11267. }
  11268. },
  11269. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11270. },
  11271. "CreateForkOption": {
  11272. "description": "CreateForkOption options for creating a fork",
  11273. "type": "object",
  11274. "properties": {
  11275. "organization": {
  11276. "description": "organization name, if forking into an organization",
  11277. "type": "string",
  11278. "x-go-name": "Organization"
  11279. }
  11280. },
  11281. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11282. },
  11283. "CreateGPGKeyOption": {
  11284. "description": "CreateGPGKeyOption options create user GPG key",
  11285. "type": "object",
  11286. "required": [
  11287. "armored_public_key"
  11288. ],
  11289. "properties": {
  11290. "armored_public_key": {
  11291. "description": "An armored GPG key to add",
  11292. "type": "string",
  11293. "uniqueItems": true,
  11294. "x-go-name": "ArmoredKey"
  11295. }
  11296. },
  11297. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11298. },
  11299. "CreateHookOption": {
  11300. "description": "CreateHookOption options when create a hook",
  11301. "type": "object",
  11302. "required": [
  11303. "type",
  11304. "config"
  11305. ],
  11306. "properties": {
  11307. "active": {
  11308. "type": "boolean",
  11309. "default": false,
  11310. "x-go-name": "Active"
  11311. },
  11312. "branch_filter": {
  11313. "type": "string",
  11314. "x-go-name": "BranchFilter"
  11315. },
  11316. "config": {
  11317. "$ref": "#/definitions/CreateHookOptionConfig"
  11318. },
  11319. "events": {
  11320. "type": "array",
  11321. "items": {
  11322. "type": "string"
  11323. },
  11324. "x-go-name": "Events"
  11325. },
  11326. "type": {
  11327. "type": "string",
  11328. "enum": [
  11329. "dingtalk",
  11330. "discord",
  11331. "gitea",
  11332. "gogs",
  11333. "msteams",
  11334. "slack",
  11335. "telegram",
  11336. "feishu"
  11337. ],
  11338. "x-go-name": "Type"
  11339. }
  11340. },
  11341. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11342. },
  11343. "CreateHookOptionConfig": {
  11344. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  11345. "type": "object",
  11346. "additionalProperties": {
  11347. "type": "string"
  11348. },
  11349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11350. },
  11351. "CreateIssueCommentOption": {
  11352. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  11353. "type": "object",
  11354. "required": [
  11355. "body"
  11356. ],
  11357. "properties": {
  11358. "body": {
  11359. "type": "string",
  11360. "x-go-name": "Body"
  11361. }
  11362. },
  11363. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11364. },
  11365. "CreateIssueOption": {
  11366. "description": "CreateIssueOption options to create one issue",
  11367. "type": "object",
  11368. "required": [
  11369. "title"
  11370. ],
  11371. "properties": {
  11372. "assignee": {
  11373. "description": "username of assignee",
  11374. "type": "string",
  11375. "x-go-name": "Assignee"
  11376. },
  11377. "assignees": {
  11378. "type": "array",
  11379. "items": {
  11380. "type": "string"
  11381. },
  11382. "x-go-name": "Assignees"
  11383. },
  11384. "body": {
  11385. "type": "string",
  11386. "x-go-name": "Body"
  11387. },
  11388. "closed": {
  11389. "type": "boolean",
  11390. "x-go-name": "Closed"
  11391. },
  11392. "due_date": {
  11393. "type": "string",
  11394. "format": "date-time",
  11395. "x-go-name": "Deadline"
  11396. },
  11397. "labels": {
  11398. "description": "list of label ids",
  11399. "type": "array",
  11400. "items": {
  11401. "type": "integer",
  11402. "format": "int64"
  11403. },
  11404. "x-go-name": "Labels"
  11405. },
  11406. "milestone": {
  11407. "description": "milestone id",
  11408. "type": "integer",
  11409. "format": "int64",
  11410. "x-go-name": "Milestone"
  11411. },
  11412. "title": {
  11413. "type": "string",
  11414. "x-go-name": "Title"
  11415. }
  11416. },
  11417. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11418. },
  11419. "CreateKeyOption": {
  11420. "description": "CreateKeyOption options when creating a key",
  11421. "type": "object",
  11422. "required": [
  11423. "title",
  11424. "key"
  11425. ],
  11426. "properties": {
  11427. "key": {
  11428. "description": "An armored SSH key to add",
  11429. "type": "string",
  11430. "uniqueItems": true,
  11431. "x-go-name": "Key"
  11432. },
  11433. "read_only": {
  11434. "description": "Describe if the key has only read access or read/write",
  11435. "type": "boolean",
  11436. "x-go-name": "ReadOnly"
  11437. },
  11438. "title": {
  11439. "description": "Title of the key to add",
  11440. "type": "string",
  11441. "uniqueItems": true,
  11442. "x-go-name": "Title"
  11443. }
  11444. },
  11445. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11446. },
  11447. "CreateLabelOption": {
  11448. "description": "CreateLabelOption options for creating a label",
  11449. "type": "object",
  11450. "required": [
  11451. "name",
  11452. "color"
  11453. ],
  11454. "properties": {
  11455. "color": {
  11456. "type": "string",
  11457. "x-go-name": "Color",
  11458. "example": "#00aabb"
  11459. },
  11460. "description": {
  11461. "type": "string",
  11462. "x-go-name": "Description"
  11463. },
  11464. "name": {
  11465. "type": "string",
  11466. "x-go-name": "Name"
  11467. }
  11468. },
  11469. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11470. },
  11471. "CreateMilestoneOption": {
  11472. "description": "CreateMilestoneOption options for creating a milestone",
  11473. "type": "object",
  11474. "properties": {
  11475. "description": {
  11476. "type": "string",
  11477. "x-go-name": "Description"
  11478. },
  11479. "due_on": {
  11480. "type": "string",
  11481. "format": "date-time",
  11482. "x-go-name": "Deadline"
  11483. },
  11484. "state": {
  11485. "type": "string",
  11486. "enum": [
  11487. "open",
  11488. "closed"
  11489. ],
  11490. "x-go-name": "State"
  11491. },
  11492. "title": {
  11493. "type": "string",
  11494. "x-go-name": "Title"
  11495. }
  11496. },
  11497. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11498. },
  11499. "CreateOAuth2ApplicationOptions": {
  11500. "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
  11501. "type": "object",
  11502. "properties": {
  11503. "name": {
  11504. "type": "string",
  11505. "x-go-name": "Name"
  11506. },
  11507. "redirect_uris": {
  11508. "type": "array",
  11509. "items": {
  11510. "type": "string"
  11511. },
  11512. "x-go-name": "RedirectURIs"
  11513. }
  11514. },
  11515. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11516. },
  11517. "CreateOrgOption": {
  11518. "description": "CreateOrgOption options for creating an organization",
  11519. "type": "object",
  11520. "required": [
  11521. "username"
  11522. ],
  11523. "properties": {
  11524. "description": {
  11525. "type": "string",
  11526. "x-go-name": "Description"
  11527. },
  11528. "full_name": {
  11529. "type": "string",
  11530. "x-go-name": "FullName"
  11531. },
  11532. "location": {
  11533. "type": "string",
  11534. "x-go-name": "Location"
  11535. },
  11536. "repo_admin_change_team_access": {
  11537. "type": "boolean",
  11538. "x-go-name": "RepoAdminChangeTeamAccess"
  11539. },
  11540. "username": {
  11541. "type": "string",
  11542. "x-go-name": "UserName"
  11543. },
  11544. "visibility": {
  11545. "description": "possible values are `public` (default), `limited` or `private`",
  11546. "type": "string",
  11547. "enum": [
  11548. "public",
  11549. "limited",
  11550. "private"
  11551. ],
  11552. "x-go-name": "Visibility"
  11553. },
  11554. "website": {
  11555. "type": "string",
  11556. "x-go-name": "Website"
  11557. }
  11558. },
  11559. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11560. },
  11561. "CreatePullRequestOption": {
  11562. "description": "CreatePullRequestOption options when creating a pull request",
  11563. "type": "object",
  11564. "properties": {
  11565. "assignee": {
  11566. "type": "string",
  11567. "x-go-name": "Assignee"
  11568. },
  11569. "assignees": {
  11570. "type": "array",
  11571. "items": {
  11572. "type": "string"
  11573. },
  11574. "x-go-name": "Assignees"
  11575. },
  11576. "base": {
  11577. "type": "string",
  11578. "x-go-name": "Base"
  11579. },
  11580. "body": {
  11581. "type": "string",
  11582. "x-go-name": "Body"
  11583. },
  11584. "due_date": {
  11585. "type": "string",
  11586. "format": "date-time",
  11587. "x-go-name": "Deadline"
  11588. },
  11589. "head": {
  11590. "type": "string",
  11591. "x-go-name": "Head"
  11592. },
  11593. "labels": {
  11594. "type": "array",
  11595. "items": {
  11596. "type": "integer",
  11597. "format": "int64"
  11598. },
  11599. "x-go-name": "Labels"
  11600. },
  11601. "milestone": {
  11602. "type": "integer",
  11603. "format": "int64",
  11604. "x-go-name": "Milestone"
  11605. },
  11606. "title": {
  11607. "type": "string",
  11608. "x-go-name": "Title"
  11609. }
  11610. },
  11611. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11612. },
  11613. "CreatePullReviewComment": {
  11614. "description": "CreatePullReviewComment represent a review comment for creation api",
  11615. "type": "object",
  11616. "properties": {
  11617. "body": {
  11618. "type": "string",
  11619. "x-go-name": "Body"
  11620. },
  11621. "new_position": {
  11622. "description": "if comment to new file line or 0",
  11623. "type": "integer",
  11624. "format": "int64",
  11625. "x-go-name": "NewLineNum"
  11626. },
  11627. "old_position": {
  11628. "description": "if comment to old file line or 0",
  11629. "type": "integer",
  11630. "format": "int64",
  11631. "x-go-name": "OldLineNum"
  11632. },
  11633. "path": {
  11634. "description": "the tree path",
  11635. "type": "string",
  11636. "x-go-name": "Path"
  11637. }
  11638. },
  11639. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11640. },
  11641. "CreatePullReviewOptions": {
  11642. "description": "CreatePullReviewOptions are options to create a pull review",
  11643. "type": "object",
  11644. "properties": {
  11645. "body": {
  11646. "type": "string",
  11647. "x-go-name": "Body"
  11648. },
  11649. "comments": {
  11650. "type": "array",
  11651. "items": {
  11652. "$ref": "#/definitions/CreatePullReviewComment"
  11653. },
  11654. "x-go-name": "Comments"
  11655. },
  11656. "commit_id": {
  11657. "type": "string",
  11658. "x-go-name": "CommitID"
  11659. },
  11660. "event": {
  11661. "$ref": "#/definitions/ReviewStateType"
  11662. }
  11663. },
  11664. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11665. },
  11666. "CreateReleaseOption": {
  11667. "description": "CreateReleaseOption options when creating a release",
  11668. "type": "object",
  11669. "required": [
  11670. "tag_name"
  11671. ],
  11672. "properties": {
  11673. "body": {
  11674. "type": "string",
  11675. "x-go-name": "Note"
  11676. },
  11677. "draft": {
  11678. "type": "boolean",
  11679. "x-go-name": "IsDraft"
  11680. },
  11681. "name": {
  11682. "type": "string",
  11683. "x-go-name": "Title"
  11684. },
  11685. "prerelease": {
  11686. "type": "boolean",
  11687. "x-go-name": "IsPrerelease"
  11688. },
  11689. "tag_name": {
  11690. "type": "string",
  11691. "x-go-name": "TagName"
  11692. },
  11693. "target_commitish": {
  11694. "type": "string",
  11695. "x-go-name": "Target"
  11696. }
  11697. },
  11698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11699. },
  11700. "CreateRepoOption": {
  11701. "description": "CreateRepoOption options when creating repository",
  11702. "type": "object",
  11703. "required": [
  11704. "name"
  11705. ],
  11706. "properties": {
  11707. "auto_init": {
  11708. "description": "Whether the repository should be auto-intialized?",
  11709. "type": "boolean",
  11710. "x-go-name": "AutoInit"
  11711. },
  11712. "default_branch": {
  11713. "description": "DefaultBranch of the repository (used when initializes and in template)",
  11714. "type": "string",
  11715. "x-go-name": "DefaultBranch"
  11716. },
  11717. "description": {
  11718. "description": "Description of the repository to create",
  11719. "type": "string",
  11720. "x-go-name": "Description"
  11721. },
  11722. "gitignores": {
  11723. "description": "Gitignores to use",
  11724. "type": "string",
  11725. "x-go-name": "Gitignores"
  11726. },
  11727. "issue_labels": {
  11728. "description": "Issue Label set to use",
  11729. "type": "string",
  11730. "x-go-name": "IssueLabels"
  11731. },
  11732. "license": {
  11733. "description": "License to use",
  11734. "type": "string",
  11735. "x-go-name": "License"
  11736. },
  11737. "name": {
  11738. "description": "Name of the repository to create",
  11739. "type": "string",
  11740. "uniqueItems": true,
  11741. "x-go-name": "Name"
  11742. },
  11743. "private": {
  11744. "description": "Whether the repository is private",
  11745. "type": "boolean",
  11746. "x-go-name": "Private"
  11747. },
  11748. "readme": {
  11749. "description": "Readme of the repository to create",
  11750. "type": "string",
  11751. "x-go-name": "Readme"
  11752. }
  11753. },
  11754. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11755. },
  11756. "CreateStatusOption": {
  11757. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  11758. "type": "object",
  11759. "properties": {
  11760. "context": {
  11761. "type": "string",
  11762. "x-go-name": "Context"
  11763. },
  11764. "description": {
  11765. "type": "string",
  11766. "x-go-name": "Description"
  11767. },
  11768. "state": {
  11769. "$ref": "#/definitions/StatusState"
  11770. },
  11771. "target_url": {
  11772. "type": "string",
  11773. "x-go-name": "TargetURL"
  11774. }
  11775. },
  11776. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11777. },
  11778. "CreateTeamOption": {
  11779. "description": "CreateTeamOption options for creating a team",
  11780. "type": "object",
  11781. "required": [
  11782. "name"
  11783. ],
  11784. "properties": {
  11785. "can_create_org_repo": {
  11786. "type": "boolean",
  11787. "x-go-name": "CanCreateOrgRepo"
  11788. },
  11789. "description": {
  11790. "type": "string",
  11791. "x-go-name": "Description"
  11792. },
  11793. "includes_all_repositories": {
  11794. "type": "boolean",
  11795. "x-go-name": "IncludesAllRepositories"
  11796. },
  11797. "name": {
  11798. "type": "string",
  11799. "x-go-name": "Name"
  11800. },
  11801. "permission": {
  11802. "type": "string",
  11803. "enum": [
  11804. "read",
  11805. "write",
  11806. "admin"
  11807. ],
  11808. "x-go-name": "Permission"
  11809. },
  11810. "units": {
  11811. "type": "array",
  11812. "items": {
  11813. "type": "string"
  11814. },
  11815. "x-go-name": "Units",
  11816. "example": [
  11817. "repo.code",
  11818. "repo.issues",
  11819. "repo.ext_issues",
  11820. "repo.wiki",
  11821. "repo.pulls",
  11822. "repo.releases",
  11823. "repo.ext_wiki"
  11824. ]
  11825. }
  11826. },
  11827. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11828. },
  11829. "CreateUserOption": {
  11830. "description": "CreateUserOption create user options",
  11831. "type": "object",
  11832. "required": [
  11833. "username",
  11834. "email",
  11835. "password"
  11836. ],
  11837. "properties": {
  11838. "email": {
  11839. "type": "string",
  11840. "format": "email",
  11841. "x-go-name": "Email"
  11842. },
  11843. "full_name": {
  11844. "type": "string",
  11845. "x-go-name": "FullName"
  11846. },
  11847. "login_name": {
  11848. "type": "string",
  11849. "x-go-name": "LoginName"
  11850. },
  11851. "must_change_password": {
  11852. "type": "boolean",
  11853. "x-go-name": "MustChangePassword"
  11854. },
  11855. "password": {
  11856. "type": "string",
  11857. "x-go-name": "Password"
  11858. },
  11859. "send_notify": {
  11860. "type": "boolean",
  11861. "x-go-name": "SendNotify"
  11862. },
  11863. "source_id": {
  11864. "type": "integer",
  11865. "format": "int64",
  11866. "x-go-name": "SourceID"
  11867. },
  11868. "username": {
  11869. "type": "string",
  11870. "x-go-name": "Username"
  11871. }
  11872. },
  11873. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11874. },
  11875. "DeleteEmailOption": {
  11876. "description": "DeleteEmailOption options when deleting email addresses",
  11877. "type": "object",
  11878. "properties": {
  11879. "emails": {
  11880. "description": "email addresses to delete",
  11881. "type": "array",
  11882. "items": {
  11883. "type": "string"
  11884. },
  11885. "x-go-name": "Emails"
  11886. }
  11887. },
  11888. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11889. },
  11890. "DeleteFileOptions": {
  11891. "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)",
  11892. "type": "object",
  11893. "required": [
  11894. "sha"
  11895. ],
  11896. "properties": {
  11897. "author": {
  11898. "$ref": "#/definitions/Identity"
  11899. },
  11900. "branch": {
  11901. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  11902. "type": "string",
  11903. "x-go-name": "BranchName"
  11904. },
  11905. "committer": {
  11906. "$ref": "#/definitions/Identity"
  11907. },
  11908. "dates": {
  11909. "$ref": "#/definitions/CommitDateOptions"
  11910. },
  11911. "message": {
  11912. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  11913. "type": "string",
  11914. "x-go-name": "Message"
  11915. },
  11916. "new_branch": {
  11917. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  11918. "type": "string",
  11919. "x-go-name": "NewBranchName"
  11920. },
  11921. "sha": {
  11922. "description": "sha is the SHA for the file that already exists",
  11923. "type": "string",
  11924. "x-go-name": "SHA"
  11925. }
  11926. },
  11927. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11928. },
  11929. "DeployKey": {
  11930. "description": "DeployKey a deploy key",
  11931. "type": "object",
  11932. "properties": {
  11933. "created_at": {
  11934. "type": "string",
  11935. "format": "date-time",
  11936. "x-go-name": "Created"
  11937. },
  11938. "fingerprint": {
  11939. "type": "string",
  11940. "x-go-name": "Fingerprint"
  11941. },
  11942. "id": {
  11943. "type": "integer",
  11944. "format": "int64",
  11945. "x-go-name": "ID"
  11946. },
  11947. "key": {
  11948. "type": "string",
  11949. "x-go-name": "Key"
  11950. },
  11951. "key_id": {
  11952. "type": "integer",
  11953. "format": "int64",
  11954. "x-go-name": "KeyID"
  11955. },
  11956. "read_only": {
  11957. "type": "boolean",
  11958. "x-go-name": "ReadOnly"
  11959. },
  11960. "repository": {
  11961. "$ref": "#/definitions/Repository"
  11962. },
  11963. "title": {
  11964. "type": "string",
  11965. "x-go-name": "Title"
  11966. },
  11967. "url": {
  11968. "type": "string",
  11969. "x-go-name": "URL"
  11970. }
  11971. },
  11972. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11973. },
  11974. "EditAttachmentOptions": {
  11975. "description": "EditAttachmentOptions options for editing attachments",
  11976. "type": "object",
  11977. "properties": {
  11978. "name": {
  11979. "type": "string",
  11980. "x-go-name": "Name"
  11981. }
  11982. },
  11983. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11984. },
  11985. "EditBranchProtectionOption": {
  11986. "description": "EditBranchProtectionOption options for editing a branch protection",
  11987. "type": "object",
  11988. "properties": {
  11989. "approvals_whitelist_teams": {
  11990. "type": "array",
  11991. "items": {
  11992. "type": "string"
  11993. },
  11994. "x-go-name": "ApprovalsWhitelistTeams"
  11995. },
  11996. "approvals_whitelist_username": {
  11997. "type": "array",
  11998. "items": {
  11999. "type": "string"
  12000. },
  12001. "x-go-name": "ApprovalsWhitelistUsernames"
  12002. },
  12003. "block_on_outdated_branch": {
  12004. "type": "boolean",
  12005. "x-go-name": "BlockOnOutdatedBranch"
  12006. },
  12007. "block_on_rejected_reviews": {
  12008. "type": "boolean",
  12009. "x-go-name": "BlockOnRejectedReviews"
  12010. },
  12011. "dismiss_stale_approvals": {
  12012. "type": "boolean",
  12013. "x-go-name": "DismissStaleApprovals"
  12014. },
  12015. "enable_approvals_whitelist": {
  12016. "type": "boolean",
  12017. "x-go-name": "EnableApprovalsWhitelist"
  12018. },
  12019. "enable_merge_whitelist": {
  12020. "type": "boolean",
  12021. "x-go-name": "EnableMergeWhitelist"
  12022. },
  12023. "enable_push": {
  12024. "type": "boolean",
  12025. "x-go-name": "EnablePush"
  12026. },
  12027. "enable_push_whitelist": {
  12028. "type": "boolean",
  12029. "x-go-name": "EnablePushWhitelist"
  12030. },
  12031. "enable_status_check": {
  12032. "type": "boolean",
  12033. "x-go-name": "EnableStatusCheck"
  12034. },
  12035. "merge_whitelist_teams": {
  12036. "type": "array",
  12037. "items": {
  12038. "type": "string"
  12039. },
  12040. "x-go-name": "MergeWhitelistTeams"
  12041. },
  12042. "merge_whitelist_usernames": {
  12043. "type": "array",
  12044. "items": {
  12045. "type": "string"
  12046. },
  12047. "x-go-name": "MergeWhitelistUsernames"
  12048. },
  12049. "protected_file_patterns": {
  12050. "type": "string",
  12051. "x-go-name": "ProtectedFilePatterns"
  12052. },
  12053. "push_whitelist_deploy_keys": {
  12054. "type": "boolean",
  12055. "x-go-name": "PushWhitelistDeployKeys"
  12056. },
  12057. "push_whitelist_teams": {
  12058. "type": "array",
  12059. "items": {
  12060. "type": "string"
  12061. },
  12062. "x-go-name": "PushWhitelistTeams"
  12063. },
  12064. "push_whitelist_usernames": {
  12065. "type": "array",
  12066. "items": {
  12067. "type": "string"
  12068. },
  12069. "x-go-name": "PushWhitelistUsernames"
  12070. },
  12071. "require_signed_commits": {
  12072. "type": "boolean",
  12073. "x-go-name": "RequireSignedCommits"
  12074. },
  12075. "required_approvals": {
  12076. "type": "integer",
  12077. "format": "int64",
  12078. "x-go-name": "RequiredApprovals"
  12079. },
  12080. "status_check_contexts": {
  12081. "type": "array",
  12082. "items": {
  12083. "type": "string"
  12084. },
  12085. "x-go-name": "StatusCheckContexts"
  12086. }
  12087. },
  12088. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12089. },
  12090. "EditDeadlineOption": {
  12091. "description": "EditDeadlineOption options for creating a deadline",
  12092. "type": "object",
  12093. "required": [
  12094. "due_date"
  12095. ],
  12096. "properties": {
  12097. "due_date": {
  12098. "type": "string",
  12099. "format": "date-time",
  12100. "x-go-name": "Deadline"
  12101. }
  12102. },
  12103. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12104. },
  12105. "EditGitHookOption": {
  12106. "description": "EditGitHookOption options when modifying one Git hook",
  12107. "type": "object",
  12108. "properties": {
  12109. "content": {
  12110. "type": "string",
  12111. "x-go-name": "Content"
  12112. }
  12113. },
  12114. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12115. },
  12116. "EditHookOption": {
  12117. "description": "EditHookOption options when modify one hook",
  12118. "type": "object",
  12119. "properties": {
  12120. "active": {
  12121. "type": "boolean",
  12122. "x-go-name": "Active"
  12123. },
  12124. "branch_filter": {
  12125. "type": "string",
  12126. "x-go-name": "BranchFilter"
  12127. },
  12128. "config": {
  12129. "type": "object",
  12130. "additionalProperties": {
  12131. "type": "string"
  12132. },
  12133. "x-go-name": "Config"
  12134. },
  12135. "events": {
  12136. "type": "array",
  12137. "items": {
  12138. "type": "string"
  12139. },
  12140. "x-go-name": "Events"
  12141. }
  12142. },
  12143. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12144. },
  12145. "EditIssueCommentOption": {
  12146. "description": "EditIssueCommentOption options for editing a comment",
  12147. "type": "object",
  12148. "required": [
  12149. "body"
  12150. ],
  12151. "properties": {
  12152. "body": {
  12153. "type": "string",
  12154. "x-go-name": "Body"
  12155. }
  12156. },
  12157. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12158. },
  12159. "EditIssueOption": {
  12160. "description": "EditIssueOption options for editing an issue",
  12161. "type": "object",
  12162. "properties": {
  12163. "assignee": {
  12164. "type": "string",
  12165. "x-go-name": "Assignee"
  12166. },
  12167. "assignees": {
  12168. "type": "array",
  12169. "items": {
  12170. "type": "string"
  12171. },
  12172. "x-go-name": "Assignees"
  12173. },
  12174. "body": {
  12175. "type": "string",
  12176. "x-go-name": "Body"
  12177. },
  12178. "due_date": {
  12179. "type": "string",
  12180. "format": "date-time",
  12181. "x-go-name": "Deadline"
  12182. },
  12183. "milestone": {
  12184. "type": "integer",
  12185. "format": "int64",
  12186. "x-go-name": "Milestone"
  12187. },
  12188. "state": {
  12189. "type": "string",
  12190. "x-go-name": "State"
  12191. },
  12192. "title": {
  12193. "type": "string",
  12194. "x-go-name": "Title"
  12195. },
  12196. "unset_due_date": {
  12197. "type": "boolean",
  12198. "x-go-name": "RemoveDeadline"
  12199. }
  12200. },
  12201. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12202. },
  12203. "EditLabelOption": {
  12204. "description": "EditLabelOption options for editing a label",
  12205. "type": "object",
  12206. "properties": {
  12207. "color": {
  12208. "type": "string",
  12209. "x-go-name": "Color"
  12210. },
  12211. "description": {
  12212. "type": "string",
  12213. "x-go-name": "Description"
  12214. },
  12215. "name": {
  12216. "type": "string",
  12217. "x-go-name": "Name"
  12218. }
  12219. },
  12220. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12221. },
  12222. "EditMilestoneOption": {
  12223. "description": "EditMilestoneOption options for editing a milestone",
  12224. "type": "object",
  12225. "properties": {
  12226. "description": {
  12227. "type": "string",
  12228. "x-go-name": "Description"
  12229. },
  12230. "due_on": {
  12231. "type": "string",
  12232. "format": "date-time",
  12233. "x-go-name": "Deadline"
  12234. },
  12235. "state": {
  12236. "type": "string",
  12237. "x-go-name": "State"
  12238. },
  12239. "title": {
  12240. "type": "string",
  12241. "x-go-name": "Title"
  12242. }
  12243. },
  12244. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12245. },
  12246. "EditOrgOption": {
  12247. "description": "EditOrgOption options for editing an organization",
  12248. "type": "object",
  12249. "properties": {
  12250. "description": {
  12251. "type": "string",
  12252. "x-go-name": "Description"
  12253. },
  12254. "full_name": {
  12255. "type": "string",
  12256. "x-go-name": "FullName"
  12257. },
  12258. "location": {
  12259. "type": "string",
  12260. "x-go-name": "Location"
  12261. },
  12262. "repo_admin_change_team_access": {
  12263. "type": "boolean",
  12264. "x-go-name": "RepoAdminChangeTeamAccess"
  12265. },
  12266. "visibility": {
  12267. "description": "possible values are `public`, `limited` or `private`",
  12268. "type": "string",
  12269. "enum": [
  12270. "public",
  12271. "limited",
  12272. "private"
  12273. ],
  12274. "x-go-name": "Visibility"
  12275. },
  12276. "website": {
  12277. "type": "string",
  12278. "x-go-name": "Website"
  12279. }
  12280. },
  12281. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12282. },
  12283. "EditPullRequestOption": {
  12284. "description": "EditPullRequestOption options when modify pull request",
  12285. "type": "object",
  12286. "properties": {
  12287. "assignee": {
  12288. "type": "string",
  12289. "x-go-name": "Assignee"
  12290. },
  12291. "assignees": {
  12292. "type": "array",
  12293. "items": {
  12294. "type": "string"
  12295. },
  12296. "x-go-name": "Assignees"
  12297. },
  12298. "base": {
  12299. "type": "string",
  12300. "x-go-name": "Base"
  12301. },
  12302. "body": {
  12303. "type": "string",
  12304. "x-go-name": "Body"
  12305. },
  12306. "due_date": {
  12307. "type": "string",
  12308. "format": "date-time",
  12309. "x-go-name": "Deadline"
  12310. },
  12311. "labels": {
  12312. "type": "array",
  12313. "items": {
  12314. "type": "integer",
  12315. "format": "int64"
  12316. },
  12317. "x-go-name": "Labels"
  12318. },
  12319. "milestone": {
  12320. "type": "integer",
  12321. "format": "int64",
  12322. "x-go-name": "Milestone"
  12323. },
  12324. "state": {
  12325. "type": "string",
  12326. "x-go-name": "State"
  12327. },
  12328. "title": {
  12329. "type": "string",
  12330. "x-go-name": "Title"
  12331. },
  12332. "unset_due_date": {
  12333. "type": "boolean",
  12334. "x-go-name": "RemoveDeadline"
  12335. }
  12336. },
  12337. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12338. },
  12339. "EditReactionOption": {
  12340. "description": "EditReactionOption contain the reaction type",
  12341. "type": "object",
  12342. "properties": {
  12343. "content": {
  12344. "type": "string",
  12345. "x-go-name": "Reaction"
  12346. }
  12347. },
  12348. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12349. },
  12350. "EditReleaseOption": {
  12351. "description": "EditReleaseOption options when editing a release",
  12352. "type": "object",
  12353. "properties": {
  12354. "body": {
  12355. "type": "string",
  12356. "x-go-name": "Note"
  12357. },
  12358. "draft": {
  12359. "type": "boolean",
  12360. "x-go-name": "IsDraft"
  12361. },
  12362. "name": {
  12363. "type": "string",
  12364. "x-go-name": "Title"
  12365. },
  12366. "prerelease": {
  12367. "type": "boolean",
  12368. "x-go-name": "IsPrerelease"
  12369. },
  12370. "tag_name": {
  12371. "type": "string",
  12372. "x-go-name": "TagName"
  12373. },
  12374. "target_commitish": {
  12375. "type": "string",
  12376. "x-go-name": "Target"
  12377. }
  12378. },
  12379. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12380. },
  12381. "EditRepoOption": {
  12382. "description": "EditRepoOption options when editing a repository's properties",
  12383. "type": "object",
  12384. "properties": {
  12385. "allow_merge_commits": {
  12386. "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`.",
  12387. "type": "boolean",
  12388. "x-go-name": "AllowMerge"
  12389. },
  12390. "allow_rebase": {
  12391. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  12392. "type": "boolean",
  12393. "x-go-name": "AllowRebase"
  12394. },
  12395. "allow_rebase_explicit": {
  12396. "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`.",
  12397. "type": "boolean",
  12398. "x-go-name": "AllowRebaseMerge"
  12399. },
  12400. "allow_squash_merge": {
  12401. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  12402. "type": "boolean",
  12403. "x-go-name": "AllowSquash"
  12404. },
  12405. "archived": {
  12406. "description": "set to `true` to archive this repository.",
  12407. "type": "boolean",
  12408. "x-go-name": "Archived"
  12409. },
  12410. "default_branch": {
  12411. "description": "sets the default branch for this repository.",
  12412. "type": "string",
  12413. "x-go-name": "DefaultBranch"
  12414. },
  12415. "description": {
  12416. "description": "a short description of the repository.",
  12417. "type": "string",
  12418. "x-go-name": "Description"
  12419. },
  12420. "external_tracker": {
  12421. "$ref": "#/definitions/ExternalTracker"
  12422. },
  12423. "external_wiki": {
  12424. "$ref": "#/definitions/ExternalWiki"
  12425. },
  12426. "has_issues": {
  12427. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  12428. "type": "boolean",
  12429. "x-go-name": "HasIssues"
  12430. },
  12431. "has_pull_requests": {
  12432. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  12433. "type": "boolean",
  12434. "x-go-name": "HasPullRequests"
  12435. },
  12436. "has_wiki": {
  12437. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  12438. "type": "boolean",
  12439. "x-go-name": "HasWiki"
  12440. },
  12441. "ignore_whitespace_conflicts": {
  12442. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  12443. "type": "boolean",
  12444. "x-go-name": "IgnoreWhitespaceConflicts"
  12445. },
  12446. "internal_tracker": {
  12447. "$ref": "#/definitions/InternalTracker"
  12448. },
  12449. "name": {
  12450. "description": "name of the repository",
  12451. "type": "string",
  12452. "uniqueItems": true,
  12453. "x-go-name": "Name"
  12454. },
  12455. "private": {
  12456. "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.",
  12457. "type": "boolean",
  12458. "x-go-name": "Private"
  12459. },
  12460. "template": {
  12461. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  12462. "type": "boolean",
  12463. "x-go-name": "Template"
  12464. },
  12465. "website": {
  12466. "description": "a URL with more information about the repository.",
  12467. "type": "string",
  12468. "x-go-name": "Website"
  12469. }
  12470. },
  12471. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12472. },
  12473. "EditTeamOption": {
  12474. "description": "EditTeamOption options for editing a team",
  12475. "type": "object",
  12476. "required": [
  12477. "name"
  12478. ],
  12479. "properties": {
  12480. "can_create_org_repo": {
  12481. "type": "boolean",
  12482. "x-go-name": "CanCreateOrgRepo"
  12483. },
  12484. "description": {
  12485. "type": "string",
  12486. "x-go-name": "Description"
  12487. },
  12488. "includes_all_repositories": {
  12489. "type": "boolean",
  12490. "x-go-name": "IncludesAllRepositories"
  12491. },
  12492. "name": {
  12493. "type": "string",
  12494. "x-go-name": "Name"
  12495. },
  12496. "permission": {
  12497. "type": "string",
  12498. "enum": [
  12499. "read",
  12500. "write",
  12501. "admin"
  12502. ],
  12503. "x-go-name": "Permission"
  12504. },
  12505. "units": {
  12506. "type": "array",
  12507. "items": {
  12508. "type": "string"
  12509. },
  12510. "x-go-name": "Units",
  12511. "example": [
  12512. "repo.code",
  12513. "repo.issues",
  12514. "repo.ext_issues",
  12515. "repo.wiki",
  12516. "repo.pulls",
  12517. "repo.releases",
  12518. "repo.ext_wiki"
  12519. ]
  12520. }
  12521. },
  12522. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12523. },
  12524. "EditUserOption": {
  12525. "description": "EditUserOption edit user options",
  12526. "type": "object",
  12527. "required": [
  12528. "email"
  12529. ],
  12530. "properties": {
  12531. "active": {
  12532. "type": "boolean",
  12533. "x-go-name": "Active"
  12534. },
  12535. "admin": {
  12536. "type": "boolean",
  12537. "x-go-name": "Admin"
  12538. },
  12539. "allow_create_organization": {
  12540. "type": "boolean",
  12541. "x-go-name": "AllowCreateOrganization"
  12542. },
  12543. "allow_git_hook": {
  12544. "type": "boolean",
  12545. "x-go-name": "AllowGitHook"
  12546. },
  12547. "allow_import_local": {
  12548. "type": "boolean",
  12549. "x-go-name": "AllowImportLocal"
  12550. },
  12551. "email": {
  12552. "type": "string",
  12553. "format": "email",
  12554. "x-go-name": "Email"
  12555. },
  12556. "full_name": {
  12557. "type": "string",
  12558. "x-go-name": "FullName"
  12559. },
  12560. "location": {
  12561. "type": "string",
  12562. "x-go-name": "Location"
  12563. },
  12564. "login_name": {
  12565. "type": "string",
  12566. "x-go-name": "LoginName"
  12567. },
  12568. "max_repo_creation": {
  12569. "type": "integer",
  12570. "format": "int64",
  12571. "x-go-name": "MaxRepoCreation"
  12572. },
  12573. "must_change_password": {
  12574. "type": "boolean",
  12575. "x-go-name": "MustChangePassword"
  12576. },
  12577. "password": {
  12578. "type": "string",
  12579. "x-go-name": "Password"
  12580. },
  12581. "prohibit_login": {
  12582. "type": "boolean",
  12583. "x-go-name": "ProhibitLogin"
  12584. },
  12585. "source_id": {
  12586. "type": "integer",
  12587. "format": "int64",
  12588. "x-go-name": "SourceID"
  12589. },
  12590. "website": {
  12591. "type": "string",
  12592. "x-go-name": "Website"
  12593. }
  12594. },
  12595. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12596. },
  12597. "Email": {
  12598. "description": "Email an email address belonging to a user",
  12599. "type": "object",
  12600. "properties": {
  12601. "email": {
  12602. "type": "string",
  12603. "format": "email",
  12604. "x-go-name": "Email"
  12605. },
  12606. "primary": {
  12607. "type": "boolean",
  12608. "x-go-name": "Primary"
  12609. },
  12610. "verified": {
  12611. "type": "boolean",
  12612. "x-go-name": "Verified"
  12613. }
  12614. },
  12615. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12616. },
  12617. "ExternalTracker": {
  12618. "description": "ExternalTracker represents settings for external tracker",
  12619. "type": "object",
  12620. "properties": {
  12621. "external_tracker_format": {
  12622. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  12623. "type": "string",
  12624. "x-go-name": "ExternalTrackerFormat"
  12625. },
  12626. "external_tracker_style": {
  12627. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  12628. "type": "string",
  12629. "x-go-name": "ExternalTrackerStyle"
  12630. },
  12631. "external_tracker_url": {
  12632. "description": "URL of external issue tracker.",
  12633. "type": "string",
  12634. "x-go-name": "ExternalTrackerURL"
  12635. }
  12636. },
  12637. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12638. },
  12639. "ExternalWiki": {
  12640. "description": "ExternalWiki represents setting for external wiki",
  12641. "type": "object",
  12642. "properties": {
  12643. "external_wiki_url": {
  12644. "description": "URL of external wiki.",
  12645. "type": "string",
  12646. "x-go-name": "ExternalWikiURL"
  12647. }
  12648. },
  12649. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12650. },
  12651. "FileCommitResponse": {
  12652. "type": "object",
  12653. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  12654. "properties": {
  12655. "author": {
  12656. "$ref": "#/definitions/CommitUser"
  12657. },
  12658. "committer": {
  12659. "$ref": "#/definitions/CommitUser"
  12660. },
  12661. "html_url": {
  12662. "type": "string",
  12663. "x-go-name": "HTMLURL"
  12664. },
  12665. "message": {
  12666. "type": "string",
  12667. "x-go-name": "Message"
  12668. },
  12669. "parents": {
  12670. "type": "array",
  12671. "items": {
  12672. "$ref": "#/definitions/CommitMeta"
  12673. },
  12674. "x-go-name": "Parents"
  12675. },
  12676. "sha": {
  12677. "type": "string",
  12678. "x-go-name": "SHA"
  12679. },
  12680. "tree": {
  12681. "$ref": "#/definitions/CommitMeta"
  12682. },
  12683. "url": {
  12684. "type": "string",
  12685. "x-go-name": "URL"
  12686. }
  12687. },
  12688. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12689. },
  12690. "FileDeleteResponse": {
  12691. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  12692. "type": "object",
  12693. "properties": {
  12694. "commit": {
  12695. "$ref": "#/definitions/FileCommitResponse"
  12696. },
  12697. "content": {
  12698. "type": "object",
  12699. "x-go-name": "Content"
  12700. },
  12701. "verification": {
  12702. "$ref": "#/definitions/PayloadCommitVerification"
  12703. }
  12704. },
  12705. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12706. },
  12707. "FileLinksResponse": {
  12708. "description": "FileLinksResponse contains the links for a repo's file",
  12709. "type": "object",
  12710. "properties": {
  12711. "git": {
  12712. "type": "string",
  12713. "x-go-name": "GitURL"
  12714. },
  12715. "html": {
  12716. "type": "string",
  12717. "x-go-name": "HTMLURL"
  12718. },
  12719. "self": {
  12720. "type": "string",
  12721. "x-go-name": "Self"
  12722. }
  12723. },
  12724. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12725. },
  12726. "FileResponse": {
  12727. "description": "FileResponse contains information about a repo's file",
  12728. "type": "object",
  12729. "properties": {
  12730. "commit": {
  12731. "$ref": "#/definitions/FileCommitResponse"
  12732. },
  12733. "content": {
  12734. "$ref": "#/definitions/ContentsResponse"
  12735. },
  12736. "verification": {
  12737. "$ref": "#/definitions/PayloadCommitVerification"
  12738. }
  12739. },
  12740. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12741. },
  12742. "GPGKey": {
  12743. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  12744. "type": "object",
  12745. "properties": {
  12746. "can_certify": {
  12747. "type": "boolean",
  12748. "x-go-name": "CanCertify"
  12749. },
  12750. "can_encrypt_comms": {
  12751. "type": "boolean",
  12752. "x-go-name": "CanEncryptComms"
  12753. },
  12754. "can_encrypt_storage": {
  12755. "type": "boolean",
  12756. "x-go-name": "CanEncryptStorage"
  12757. },
  12758. "can_sign": {
  12759. "type": "boolean",
  12760. "x-go-name": "CanSign"
  12761. },
  12762. "created_at": {
  12763. "type": "string",
  12764. "format": "date-time",
  12765. "x-go-name": "Created"
  12766. },
  12767. "emails": {
  12768. "type": "array",
  12769. "items": {
  12770. "$ref": "#/definitions/GPGKeyEmail"
  12771. },
  12772. "x-go-name": "Emails"
  12773. },
  12774. "expires_at": {
  12775. "type": "string",
  12776. "format": "date-time",
  12777. "x-go-name": "Expires"
  12778. },
  12779. "id": {
  12780. "type": "integer",
  12781. "format": "int64",
  12782. "x-go-name": "ID"
  12783. },
  12784. "key_id": {
  12785. "type": "string",
  12786. "x-go-name": "KeyID"
  12787. },
  12788. "primary_key_id": {
  12789. "type": "string",
  12790. "x-go-name": "PrimaryKeyID"
  12791. },
  12792. "public_key": {
  12793. "type": "string",
  12794. "x-go-name": "PublicKey"
  12795. },
  12796. "subkeys": {
  12797. "type": "array",
  12798. "items": {
  12799. "$ref": "#/definitions/GPGKey"
  12800. },
  12801. "x-go-name": "SubsKey"
  12802. }
  12803. },
  12804. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12805. },
  12806. "GPGKeyEmail": {
  12807. "description": "GPGKeyEmail an email attached to a GPGKey",
  12808. "type": "object",
  12809. "properties": {
  12810. "email": {
  12811. "type": "string",
  12812. "x-go-name": "Email"
  12813. },
  12814. "verified": {
  12815. "type": "boolean",
  12816. "x-go-name": "Verified"
  12817. }
  12818. },
  12819. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12820. },
  12821. "GeneralRepoSettings": {
  12822. "description": "GeneralRepoSettings contains global repository settings exposed by API",
  12823. "type": "object",
  12824. "properties": {
  12825. "http_git_disabled": {
  12826. "type": "boolean",
  12827. "x-go-name": "HTTPGitDisabled"
  12828. },
  12829. "mirrors_disabled": {
  12830. "type": "boolean",
  12831. "x-go-name": "MirrorsDisabled"
  12832. }
  12833. },
  12834. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12835. },
  12836. "GeneralUISettings": {
  12837. "description": "GeneralUISettings contains global ui settings exposed by API",
  12838. "type": "object",
  12839. "properties": {
  12840. "allowed_reactions": {
  12841. "type": "array",
  12842. "items": {
  12843. "type": "string"
  12844. },
  12845. "x-go-name": "AllowedReactions"
  12846. }
  12847. },
  12848. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12849. },
  12850. "GitBlobResponse": {
  12851. "description": "GitBlobResponse represents a git blob",
  12852. "type": "object",
  12853. "properties": {
  12854. "content": {
  12855. "type": "string",
  12856. "x-go-name": "Content"
  12857. },
  12858. "encoding": {
  12859. "type": "string",
  12860. "x-go-name": "Encoding"
  12861. },
  12862. "sha": {
  12863. "type": "string",
  12864. "x-go-name": "SHA"
  12865. },
  12866. "size": {
  12867. "type": "integer",
  12868. "format": "int64",
  12869. "x-go-name": "Size"
  12870. },
  12871. "url": {
  12872. "type": "string",
  12873. "x-go-name": "URL"
  12874. }
  12875. },
  12876. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12877. },
  12878. "GitEntry": {
  12879. "description": "GitEntry represents a git tree",
  12880. "type": "object",
  12881. "properties": {
  12882. "mode": {
  12883. "type": "string",
  12884. "x-go-name": "Mode"
  12885. },
  12886. "path": {
  12887. "type": "string",
  12888. "x-go-name": "Path"
  12889. },
  12890. "sha": {
  12891. "type": "string",
  12892. "x-go-name": "SHA"
  12893. },
  12894. "size": {
  12895. "type": "integer",
  12896. "format": "int64",
  12897. "x-go-name": "Size"
  12898. },
  12899. "type": {
  12900. "type": "string",
  12901. "x-go-name": "Type"
  12902. },
  12903. "url": {
  12904. "type": "string",
  12905. "x-go-name": "URL"
  12906. }
  12907. },
  12908. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12909. },
  12910. "GitHook": {
  12911. "description": "GitHook represents a Git repository hook",
  12912. "type": "object",
  12913. "properties": {
  12914. "content": {
  12915. "type": "string",
  12916. "x-go-name": "Content"
  12917. },
  12918. "is_active": {
  12919. "type": "boolean",
  12920. "x-go-name": "IsActive"
  12921. },
  12922. "name": {
  12923. "type": "string",
  12924. "x-go-name": "Name"
  12925. }
  12926. },
  12927. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12928. },
  12929. "GitObject": {
  12930. "type": "object",
  12931. "title": "GitObject represents a Git object.",
  12932. "properties": {
  12933. "sha": {
  12934. "type": "string",
  12935. "x-go-name": "SHA"
  12936. },
  12937. "type": {
  12938. "type": "string",
  12939. "x-go-name": "Type"
  12940. },
  12941. "url": {
  12942. "type": "string",
  12943. "x-go-name": "URL"
  12944. }
  12945. },
  12946. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12947. },
  12948. "GitTreeResponse": {
  12949. "description": "GitTreeResponse returns a git tree",
  12950. "type": "object",
  12951. "properties": {
  12952. "page": {
  12953. "type": "integer",
  12954. "format": "int64",
  12955. "x-go-name": "Page"
  12956. },
  12957. "sha": {
  12958. "type": "string",
  12959. "x-go-name": "SHA"
  12960. },
  12961. "total_count": {
  12962. "type": "integer",
  12963. "format": "int64",
  12964. "x-go-name": "TotalCount"
  12965. },
  12966. "tree": {
  12967. "type": "array",
  12968. "items": {
  12969. "$ref": "#/definitions/GitEntry"
  12970. },
  12971. "x-go-name": "Entries"
  12972. },
  12973. "truncated": {
  12974. "type": "boolean",
  12975. "x-go-name": "Truncated"
  12976. },
  12977. "url": {
  12978. "type": "string",
  12979. "x-go-name": "URL"
  12980. }
  12981. },
  12982. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12983. },
  12984. "Hook": {
  12985. "description": "Hook a hook is a web hook when one repository changed",
  12986. "type": "object",
  12987. "properties": {
  12988. "active": {
  12989. "type": "boolean",
  12990. "x-go-name": "Active"
  12991. },
  12992. "config": {
  12993. "type": "object",
  12994. "additionalProperties": {
  12995. "type": "string"
  12996. },
  12997. "x-go-name": "Config"
  12998. },
  12999. "created_at": {
  13000. "type": "string",
  13001. "format": "date-time",
  13002. "x-go-name": "Created"
  13003. },
  13004. "events": {
  13005. "type": "array",
  13006. "items": {
  13007. "type": "string"
  13008. },
  13009. "x-go-name": "Events"
  13010. },
  13011. "id": {
  13012. "type": "integer",
  13013. "format": "int64",
  13014. "x-go-name": "ID"
  13015. },
  13016. "type": {
  13017. "type": "string",
  13018. "x-go-name": "Type"
  13019. },
  13020. "updated_at": {
  13021. "type": "string",
  13022. "format": "date-time",
  13023. "x-go-name": "Updated"
  13024. }
  13025. },
  13026. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13027. },
  13028. "Identity": {
  13029. "description": "Identity for a person's identity like an author or committer",
  13030. "type": "object",
  13031. "properties": {
  13032. "email": {
  13033. "type": "string",
  13034. "format": "email",
  13035. "x-go-name": "Email"
  13036. },
  13037. "name": {
  13038. "type": "string",
  13039. "x-go-name": "Name"
  13040. }
  13041. },
  13042. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13043. },
  13044. "InternalTracker": {
  13045. "description": "InternalTracker represents settings for internal tracker",
  13046. "type": "object",
  13047. "properties": {
  13048. "allow_only_contributors_to_track_time": {
  13049. "description": "Let only contributors track time (Built-in issue tracker)",
  13050. "type": "boolean",
  13051. "x-go-name": "AllowOnlyContributorsToTrackTime"
  13052. },
  13053. "enable_issue_dependencies": {
  13054. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  13055. "type": "boolean",
  13056. "x-go-name": "EnableIssueDependencies"
  13057. },
  13058. "enable_time_tracker": {
  13059. "description": "Enable time tracking (Built-in issue tracker)",
  13060. "type": "boolean",
  13061. "x-go-name": "EnableTimeTracker"
  13062. }
  13063. },
  13064. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13065. },
  13066. "Issue": {
  13067. "description": "Issue represents an issue in a repository",
  13068. "type": "object",
  13069. "properties": {
  13070. "assignee": {
  13071. "$ref": "#/definitions/User"
  13072. },
  13073. "assignees": {
  13074. "type": "array",
  13075. "items": {
  13076. "$ref": "#/definitions/User"
  13077. },
  13078. "x-go-name": "Assignees"
  13079. },
  13080. "body": {
  13081. "type": "string",
  13082. "x-go-name": "Body"
  13083. },
  13084. "closed_at": {
  13085. "type": "string",
  13086. "format": "date-time",
  13087. "x-go-name": "Closed"
  13088. },
  13089. "comments": {
  13090. "type": "integer",
  13091. "format": "int64",
  13092. "x-go-name": "Comments"
  13093. },
  13094. "created_at": {
  13095. "type": "string",
  13096. "format": "date-time",
  13097. "x-go-name": "Created"
  13098. },
  13099. "due_date": {
  13100. "type": "string",
  13101. "format": "date-time",
  13102. "x-go-name": "Deadline"
  13103. },
  13104. "html_url": {
  13105. "type": "string",
  13106. "x-go-name": "HTMLURL"
  13107. },
  13108. "id": {
  13109. "type": "integer",
  13110. "format": "int64",
  13111. "x-go-name": "ID"
  13112. },
  13113. "is_locked": {
  13114. "type": "boolean",
  13115. "x-go-name": "IsLocked"
  13116. },
  13117. "labels": {
  13118. "type": "array",
  13119. "items": {
  13120. "$ref": "#/definitions/Label"
  13121. },
  13122. "x-go-name": "Labels"
  13123. },
  13124. "milestone": {
  13125. "$ref": "#/definitions/Milestone"
  13126. },
  13127. "number": {
  13128. "type": "integer",
  13129. "format": "int64",
  13130. "x-go-name": "Index"
  13131. },
  13132. "original_author": {
  13133. "type": "string",
  13134. "x-go-name": "OriginalAuthor"
  13135. },
  13136. "original_author_id": {
  13137. "type": "integer",
  13138. "format": "int64",
  13139. "x-go-name": "OriginalAuthorID"
  13140. },
  13141. "pull_request": {
  13142. "$ref": "#/definitions/PullRequestMeta"
  13143. },
  13144. "repository": {
  13145. "$ref": "#/definitions/RepositoryMeta"
  13146. },
  13147. "state": {
  13148. "$ref": "#/definitions/StateType"
  13149. },
  13150. "title": {
  13151. "type": "string",
  13152. "x-go-name": "Title"
  13153. },
  13154. "updated_at": {
  13155. "type": "string",
  13156. "format": "date-time",
  13157. "x-go-name": "Updated"
  13158. },
  13159. "url": {
  13160. "type": "string",
  13161. "x-go-name": "URL"
  13162. },
  13163. "user": {
  13164. "$ref": "#/definitions/User"
  13165. }
  13166. },
  13167. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13168. },
  13169. "IssueDeadline": {
  13170. "description": "IssueDeadline represents an issue deadline",
  13171. "type": "object",
  13172. "properties": {
  13173. "due_date": {
  13174. "type": "string",
  13175. "format": "date-time",
  13176. "x-go-name": "Deadline"
  13177. }
  13178. },
  13179. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13180. },
  13181. "IssueLabelsOption": {
  13182. "description": "IssueLabelsOption a collection of labels",
  13183. "type": "object",
  13184. "properties": {
  13185. "labels": {
  13186. "description": "list of label IDs",
  13187. "type": "array",
  13188. "items": {
  13189. "type": "integer",
  13190. "format": "int64"
  13191. },
  13192. "x-go-name": "Labels"
  13193. }
  13194. },
  13195. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13196. },
  13197. "Label": {
  13198. "description": "Label a label to an issue or a pr",
  13199. "type": "object",
  13200. "properties": {
  13201. "color": {
  13202. "type": "string",
  13203. "x-go-name": "Color",
  13204. "example": "00aabb"
  13205. },
  13206. "description": {
  13207. "type": "string",
  13208. "x-go-name": "Description"
  13209. },
  13210. "id": {
  13211. "type": "integer",
  13212. "format": "int64",
  13213. "x-go-name": "ID"
  13214. },
  13215. "name": {
  13216. "type": "string",
  13217. "x-go-name": "Name"
  13218. },
  13219. "url": {
  13220. "type": "string",
  13221. "x-go-name": "URL"
  13222. }
  13223. },
  13224. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13225. },
  13226. "MarkdownOption": {
  13227. "description": "MarkdownOption markdown options",
  13228. "type": "object",
  13229. "properties": {
  13230. "Context": {
  13231. "description": "Context to render\n\nin: body",
  13232. "type": "string"
  13233. },
  13234. "Mode": {
  13235. "description": "Mode to render\n\nin: body",
  13236. "type": "string"
  13237. },
  13238. "Text": {
  13239. "description": "Text markdown to render\n\nin: body",
  13240. "type": "string"
  13241. },
  13242. "Wiki": {
  13243. "description": "Is it a wiki page ?\n\nin: body",
  13244. "type": "boolean"
  13245. }
  13246. },
  13247. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13248. },
  13249. "MergePullRequestOption": {
  13250. "description": "MergePullRequestForm form for merging Pull Request",
  13251. "type": "object",
  13252. "required": [
  13253. "Do"
  13254. ],
  13255. "properties": {
  13256. "Do": {
  13257. "type": "string",
  13258. "enum": [
  13259. "merge",
  13260. "rebase",
  13261. "rebase-merge",
  13262. "squash"
  13263. ]
  13264. },
  13265. "MergeMessageField": {
  13266. "type": "string"
  13267. },
  13268. "MergeTitleField": {
  13269. "type": "string"
  13270. },
  13271. "force_merge": {
  13272. "type": "boolean",
  13273. "x-go-name": "ForceMerge"
  13274. }
  13275. },
  13276. "x-go-name": "MergePullRequestForm",
  13277. "x-go-package": "code.gitea.io/gitea/modules/auth"
  13278. },
  13279. "MigrateRepoForm": {
  13280. "description": "MigrateRepoForm form for migrating repository",
  13281. "type": "object",
  13282. "required": [
  13283. "clone_addr",
  13284. "uid",
  13285. "repo_name"
  13286. ],
  13287. "properties": {
  13288. "auth_password": {
  13289. "type": "string",
  13290. "x-go-name": "AuthPassword"
  13291. },
  13292. "auth_username": {
  13293. "type": "string",
  13294. "x-go-name": "AuthUsername"
  13295. },
  13296. "clone_addr": {
  13297. "type": "string",
  13298. "x-go-name": "CloneAddr"
  13299. },
  13300. "description": {
  13301. "type": "string",
  13302. "x-go-name": "Description"
  13303. },
  13304. "issues": {
  13305. "type": "boolean",
  13306. "x-go-name": "Issues"
  13307. },
  13308. "labels": {
  13309. "type": "boolean",
  13310. "x-go-name": "Labels"
  13311. },
  13312. "milestones": {
  13313. "type": "boolean",
  13314. "x-go-name": "Milestones"
  13315. },
  13316. "mirror": {
  13317. "type": "boolean",
  13318. "x-go-name": "Mirror"
  13319. },
  13320. "private": {
  13321. "type": "boolean",
  13322. "x-go-name": "Private"
  13323. },
  13324. "pull_requests": {
  13325. "type": "boolean",
  13326. "x-go-name": "PullRequests"
  13327. },
  13328. "releases": {
  13329. "type": "boolean",
  13330. "x-go-name": "Releases"
  13331. },
  13332. "repo_name": {
  13333. "type": "string",
  13334. "x-go-name": "RepoName"
  13335. },
  13336. "uid": {
  13337. "type": "integer",
  13338. "format": "int64",
  13339. "x-go-name": "UID"
  13340. },
  13341. "wiki": {
  13342. "type": "boolean",
  13343. "x-go-name": "Wiki"
  13344. }
  13345. },
  13346. "x-go-package": "code.gitea.io/gitea/modules/auth"
  13347. },
  13348. "Milestone": {
  13349. "description": "Milestone milestone is a collection of issues on one repository",
  13350. "type": "object",
  13351. "properties": {
  13352. "closed_at": {
  13353. "type": "string",
  13354. "format": "date-time",
  13355. "x-go-name": "Closed"
  13356. },
  13357. "closed_issues": {
  13358. "type": "integer",
  13359. "format": "int64",
  13360. "x-go-name": "ClosedIssues"
  13361. },
  13362. "description": {
  13363. "type": "string",
  13364. "x-go-name": "Description"
  13365. },
  13366. "due_on": {
  13367. "type": "string",
  13368. "format": "date-time",
  13369. "x-go-name": "Deadline"
  13370. },
  13371. "id": {
  13372. "type": "integer",
  13373. "format": "int64",
  13374. "x-go-name": "ID"
  13375. },
  13376. "open_issues": {
  13377. "type": "integer",
  13378. "format": "int64",
  13379. "x-go-name": "OpenIssues"
  13380. },
  13381. "state": {
  13382. "$ref": "#/definitions/StateType"
  13383. },
  13384. "title": {
  13385. "type": "string",
  13386. "x-go-name": "Title"
  13387. }
  13388. },
  13389. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13390. },
  13391. "NotificationCount": {
  13392. "description": "NotificationCount number of unread notifications",
  13393. "type": "object",
  13394. "properties": {
  13395. "new": {
  13396. "type": "integer",
  13397. "format": "int64",
  13398. "x-go-name": "New"
  13399. }
  13400. },
  13401. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13402. },
  13403. "NotificationSubject": {
  13404. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  13405. "type": "object",
  13406. "properties": {
  13407. "latest_comment_url": {
  13408. "type": "string",
  13409. "x-go-name": "LatestCommentURL"
  13410. },
  13411. "title": {
  13412. "type": "string",
  13413. "x-go-name": "Title"
  13414. },
  13415. "type": {
  13416. "type": "string",
  13417. "x-go-name": "Type"
  13418. },
  13419. "url": {
  13420. "type": "string",
  13421. "x-go-name": "URL"
  13422. }
  13423. },
  13424. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13425. },
  13426. "NotificationThread": {
  13427. "description": "NotificationThread expose Notification on API",
  13428. "type": "object",
  13429. "properties": {
  13430. "id": {
  13431. "type": "integer",
  13432. "format": "int64",
  13433. "x-go-name": "ID"
  13434. },
  13435. "pinned": {
  13436. "type": "boolean",
  13437. "x-go-name": "Pinned"
  13438. },
  13439. "repository": {
  13440. "$ref": "#/definitions/Repository"
  13441. },
  13442. "subject": {
  13443. "$ref": "#/definitions/NotificationSubject"
  13444. },
  13445. "unread": {
  13446. "type": "boolean",
  13447. "x-go-name": "Unread"
  13448. },
  13449. "updated_at": {
  13450. "type": "string",
  13451. "format": "date-time",
  13452. "x-go-name": "UpdatedAt"
  13453. },
  13454. "url": {
  13455. "type": "string",
  13456. "x-go-name": "URL"
  13457. }
  13458. },
  13459. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13460. },
  13461. "OAuth2Application": {
  13462. "type": "object",
  13463. "title": "OAuth2Application represents an OAuth2 application.",
  13464. "properties": {
  13465. "client_id": {
  13466. "type": "string",
  13467. "x-go-name": "ClientID"
  13468. },
  13469. "client_secret": {
  13470. "type": "string",
  13471. "x-go-name": "ClientSecret"
  13472. },
  13473. "created": {
  13474. "type": "string",
  13475. "format": "date-time",
  13476. "x-go-name": "Created"
  13477. },
  13478. "id": {
  13479. "type": "integer",
  13480. "format": "int64",
  13481. "x-go-name": "ID"
  13482. },
  13483. "name": {
  13484. "type": "string",
  13485. "x-go-name": "Name"
  13486. },
  13487. "redirect_uris": {
  13488. "type": "array",
  13489. "items": {
  13490. "type": "string"
  13491. },
  13492. "x-go-name": "RedirectURIs"
  13493. }
  13494. },
  13495. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13496. },
  13497. "Organization": {
  13498. "description": "Organization represents an organization",
  13499. "type": "object",
  13500. "properties": {
  13501. "avatar_url": {
  13502. "type": "string",
  13503. "x-go-name": "AvatarURL"
  13504. },
  13505. "description": {
  13506. "type": "string",
  13507. "x-go-name": "Description"
  13508. },
  13509. "full_name": {
  13510. "type": "string",
  13511. "x-go-name": "FullName"
  13512. },
  13513. "id": {
  13514. "type": "integer",
  13515. "format": "int64",
  13516. "x-go-name": "ID"
  13517. },
  13518. "location": {
  13519. "type": "string",
  13520. "x-go-name": "Location"
  13521. },
  13522. "repo_admin_change_team_access": {
  13523. "type": "boolean",
  13524. "x-go-name": "RepoAdminChangeTeamAccess"
  13525. },
  13526. "username": {
  13527. "type": "string",
  13528. "x-go-name": "UserName"
  13529. },
  13530. "visibility": {
  13531. "type": "string",
  13532. "x-go-name": "Visibility"
  13533. },
  13534. "website": {
  13535. "type": "string",
  13536. "x-go-name": "Website"
  13537. }
  13538. },
  13539. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13540. },
  13541. "PRBranchInfo": {
  13542. "description": "PRBranchInfo information about a branch",
  13543. "type": "object",
  13544. "properties": {
  13545. "label": {
  13546. "type": "string",
  13547. "x-go-name": "Name"
  13548. },
  13549. "ref": {
  13550. "type": "string",
  13551. "x-go-name": "Ref"
  13552. },
  13553. "repo": {
  13554. "$ref": "#/definitions/Repository"
  13555. },
  13556. "repo_id": {
  13557. "type": "integer",
  13558. "format": "int64",
  13559. "x-go-name": "RepoID"
  13560. },
  13561. "sha": {
  13562. "type": "string",
  13563. "x-go-name": "Sha"
  13564. }
  13565. },
  13566. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13567. },
  13568. "PayloadCommit": {
  13569. "description": "PayloadCommit represents a commit",
  13570. "type": "object",
  13571. "properties": {
  13572. "added": {
  13573. "type": "array",
  13574. "items": {
  13575. "type": "string"
  13576. },
  13577. "x-go-name": "Added"
  13578. },
  13579. "author": {
  13580. "$ref": "#/definitions/PayloadUser"
  13581. },
  13582. "committer": {
  13583. "$ref": "#/definitions/PayloadUser"
  13584. },
  13585. "id": {
  13586. "description": "sha1 hash of the commit",
  13587. "type": "string",
  13588. "x-go-name": "ID"
  13589. },
  13590. "message": {
  13591. "type": "string",
  13592. "x-go-name": "Message"
  13593. },
  13594. "modified": {
  13595. "type": "array",
  13596. "items": {
  13597. "type": "string"
  13598. },
  13599. "x-go-name": "Modified"
  13600. },
  13601. "removed": {
  13602. "type": "array",
  13603. "items": {
  13604. "type": "string"
  13605. },
  13606. "x-go-name": "Removed"
  13607. },
  13608. "timestamp": {
  13609. "type": "string",
  13610. "format": "date-time",
  13611. "x-go-name": "Timestamp"
  13612. },
  13613. "url": {
  13614. "type": "string",
  13615. "x-go-name": "URL"
  13616. },
  13617. "verification": {
  13618. "$ref": "#/definitions/PayloadCommitVerification"
  13619. }
  13620. },
  13621. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13622. },
  13623. "PayloadCommitVerification": {
  13624. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  13625. "type": "object",
  13626. "properties": {
  13627. "payload": {
  13628. "type": "string",
  13629. "x-go-name": "Payload"
  13630. },
  13631. "reason": {
  13632. "type": "string",
  13633. "x-go-name": "Reason"
  13634. },
  13635. "signature": {
  13636. "type": "string",
  13637. "x-go-name": "Signature"
  13638. },
  13639. "signer": {
  13640. "$ref": "#/definitions/PayloadUser"
  13641. },
  13642. "verified": {
  13643. "type": "boolean",
  13644. "x-go-name": "Verified"
  13645. }
  13646. },
  13647. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13648. },
  13649. "PayloadUser": {
  13650. "description": "PayloadUser represents the author or committer of a commit",
  13651. "type": "object",
  13652. "properties": {
  13653. "email": {
  13654. "type": "string",
  13655. "format": "email",
  13656. "x-go-name": "Email"
  13657. },
  13658. "name": {
  13659. "description": "Full name of the commit author",
  13660. "type": "string",
  13661. "x-go-name": "Name"
  13662. },
  13663. "username": {
  13664. "type": "string",
  13665. "x-go-name": "UserName"
  13666. }
  13667. },
  13668. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13669. },
  13670. "Permission": {
  13671. "description": "Permission represents a set of permissions",
  13672. "type": "object",
  13673. "properties": {
  13674. "admin": {
  13675. "type": "boolean",
  13676. "x-go-name": "Admin"
  13677. },
  13678. "pull": {
  13679. "type": "boolean",
  13680. "x-go-name": "Pull"
  13681. },
  13682. "push": {
  13683. "type": "boolean",
  13684. "x-go-name": "Push"
  13685. }
  13686. },
  13687. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13688. },
  13689. "PublicKey": {
  13690. "description": "PublicKey publickey is a user key to push code to repository",
  13691. "type": "object",
  13692. "properties": {
  13693. "created_at": {
  13694. "type": "string",
  13695. "format": "date-time",
  13696. "x-go-name": "Created"
  13697. },
  13698. "fingerprint": {
  13699. "type": "string",
  13700. "x-go-name": "Fingerprint"
  13701. },
  13702. "id": {
  13703. "type": "integer",
  13704. "format": "int64",
  13705. "x-go-name": "ID"
  13706. },
  13707. "key": {
  13708. "type": "string",
  13709. "x-go-name": "Key"
  13710. },
  13711. "key_type": {
  13712. "type": "string",
  13713. "x-go-name": "KeyType"
  13714. },
  13715. "read_only": {
  13716. "type": "boolean",
  13717. "x-go-name": "ReadOnly"
  13718. },
  13719. "title": {
  13720. "type": "string",
  13721. "x-go-name": "Title"
  13722. },
  13723. "url": {
  13724. "type": "string",
  13725. "x-go-name": "URL"
  13726. },
  13727. "user": {
  13728. "$ref": "#/definitions/User"
  13729. }
  13730. },
  13731. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13732. },
  13733. "PullRequest": {
  13734. "description": "PullRequest represents a pull request",
  13735. "type": "object",
  13736. "properties": {
  13737. "assignee": {
  13738. "$ref": "#/definitions/User"
  13739. },
  13740. "assignees": {
  13741. "type": "array",
  13742. "items": {
  13743. "$ref": "#/definitions/User"
  13744. },
  13745. "x-go-name": "Assignees"
  13746. },
  13747. "base": {
  13748. "$ref": "#/definitions/PRBranchInfo"
  13749. },
  13750. "body": {
  13751. "type": "string",
  13752. "x-go-name": "Body"
  13753. },
  13754. "closed_at": {
  13755. "type": "string",
  13756. "format": "date-time",
  13757. "x-go-name": "Closed"
  13758. },
  13759. "comments": {
  13760. "type": "integer",
  13761. "format": "int64",
  13762. "x-go-name": "Comments"
  13763. },
  13764. "created_at": {
  13765. "type": "string",
  13766. "format": "date-time",
  13767. "x-go-name": "Created"
  13768. },
  13769. "diff_url": {
  13770. "type": "string",
  13771. "x-go-name": "DiffURL"
  13772. },
  13773. "due_date": {
  13774. "type": "string",
  13775. "format": "date-time",
  13776. "x-go-name": "Deadline"
  13777. },
  13778. "head": {
  13779. "$ref": "#/definitions/PRBranchInfo"
  13780. },
  13781. "html_url": {
  13782. "type": "string",
  13783. "x-go-name": "HTMLURL"
  13784. },
  13785. "id": {
  13786. "type": "integer",
  13787. "format": "int64",
  13788. "x-go-name": "ID"
  13789. },
  13790. "is_locked": {
  13791. "type": "boolean",
  13792. "x-go-name": "IsLocked"
  13793. },
  13794. "labels": {
  13795. "type": "array",
  13796. "items": {
  13797. "$ref": "#/definitions/Label"
  13798. },
  13799. "x-go-name": "Labels"
  13800. },
  13801. "merge_base": {
  13802. "type": "string",
  13803. "x-go-name": "MergeBase"
  13804. },
  13805. "merge_commit_sha": {
  13806. "type": "string",
  13807. "x-go-name": "MergedCommitID"
  13808. },
  13809. "mergeable": {
  13810. "type": "boolean",
  13811. "x-go-name": "Mergeable"
  13812. },
  13813. "merged": {
  13814. "type": "boolean",
  13815. "x-go-name": "HasMerged"
  13816. },
  13817. "merged_at": {
  13818. "type": "string",
  13819. "format": "date-time",
  13820. "x-go-name": "Merged"
  13821. },
  13822. "merged_by": {
  13823. "$ref": "#/definitions/User"
  13824. },
  13825. "milestone": {
  13826. "$ref": "#/definitions/Milestone"
  13827. },
  13828. "number": {
  13829. "type": "integer",
  13830. "format": "int64",
  13831. "x-go-name": "Index"
  13832. },
  13833. "patch_url": {
  13834. "type": "string",
  13835. "x-go-name": "PatchURL"
  13836. },
  13837. "state": {
  13838. "$ref": "#/definitions/StateType"
  13839. },
  13840. "title": {
  13841. "type": "string",
  13842. "x-go-name": "Title"
  13843. },
  13844. "updated_at": {
  13845. "type": "string",
  13846. "format": "date-time",
  13847. "x-go-name": "Updated"
  13848. },
  13849. "url": {
  13850. "type": "string",
  13851. "x-go-name": "URL"
  13852. },
  13853. "user": {
  13854. "$ref": "#/definitions/User"
  13855. }
  13856. },
  13857. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13858. },
  13859. "PullRequestMeta": {
  13860. "description": "PullRequestMeta PR info if an issue is a PR",
  13861. "type": "object",
  13862. "properties": {
  13863. "merged": {
  13864. "type": "boolean",
  13865. "x-go-name": "HasMerged"
  13866. },
  13867. "merged_at": {
  13868. "type": "string",
  13869. "format": "date-time",
  13870. "x-go-name": "Merged"
  13871. }
  13872. },
  13873. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13874. },
  13875. "PullReview": {
  13876. "description": "PullReview represents a pull request review",
  13877. "type": "object",
  13878. "properties": {
  13879. "body": {
  13880. "type": "string",
  13881. "x-go-name": "Body"
  13882. },
  13883. "comments_count": {
  13884. "type": "integer",
  13885. "format": "int64",
  13886. "x-go-name": "CodeCommentsCount"
  13887. },
  13888. "commit_id": {
  13889. "type": "string",
  13890. "x-go-name": "CommitID"
  13891. },
  13892. "html_url": {
  13893. "type": "string",
  13894. "x-go-name": "HTMLURL"
  13895. },
  13896. "id": {
  13897. "type": "integer",
  13898. "format": "int64",
  13899. "x-go-name": "ID"
  13900. },
  13901. "official": {
  13902. "type": "boolean",
  13903. "x-go-name": "Official"
  13904. },
  13905. "pull_request_url": {
  13906. "type": "string",
  13907. "x-go-name": "HTMLPullURL"
  13908. },
  13909. "stale": {
  13910. "type": "boolean",
  13911. "x-go-name": "Stale"
  13912. },
  13913. "state": {
  13914. "$ref": "#/definitions/ReviewStateType"
  13915. },
  13916. "submitted_at": {
  13917. "type": "string",
  13918. "format": "date-time",
  13919. "x-go-name": "Submitted"
  13920. },
  13921. "user": {
  13922. "$ref": "#/definitions/User"
  13923. }
  13924. },
  13925. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13926. },
  13927. "PullReviewComment": {
  13928. "description": "PullReviewComment represents a comment on a pull request review",
  13929. "type": "object",
  13930. "properties": {
  13931. "body": {
  13932. "type": "string",
  13933. "x-go-name": "Body"
  13934. },
  13935. "commit_id": {
  13936. "type": "string",
  13937. "x-go-name": "CommitID"
  13938. },
  13939. "created_at": {
  13940. "type": "string",
  13941. "format": "date-time",
  13942. "x-go-name": "Created"
  13943. },
  13944. "diff_hunk": {
  13945. "type": "string",
  13946. "x-go-name": "DiffHunk"
  13947. },
  13948. "html_url": {
  13949. "type": "string",
  13950. "x-go-name": "HTMLURL"
  13951. },
  13952. "id": {
  13953. "type": "integer",
  13954. "format": "int64",
  13955. "x-go-name": "ID"
  13956. },
  13957. "original_commit_id": {
  13958. "type": "string",
  13959. "x-go-name": "OrigCommitID"
  13960. },
  13961. "original_position": {
  13962. "type": "integer",
  13963. "format": "uint64",
  13964. "x-go-name": "OldLineNum"
  13965. },
  13966. "path": {
  13967. "type": "string",
  13968. "x-go-name": "Path"
  13969. },
  13970. "position": {
  13971. "type": "integer",
  13972. "format": "uint64",
  13973. "x-go-name": "LineNum"
  13974. },
  13975. "pull_request_review_id": {
  13976. "type": "integer",
  13977. "format": "int64",
  13978. "x-go-name": "ReviewID"
  13979. },
  13980. "pull_request_url": {
  13981. "type": "string",
  13982. "x-go-name": "HTMLPullURL"
  13983. },
  13984. "updated_at": {
  13985. "type": "string",
  13986. "format": "date-time",
  13987. "x-go-name": "Updated"
  13988. },
  13989. "user": {
  13990. "$ref": "#/definitions/User"
  13991. }
  13992. },
  13993. "x-go-package": "code.gitea.io/gitea/modules/structs"
  13994. },
  13995. "Reaction": {
  13996. "description": "Reaction contain one reaction",
  13997. "type": "object",
  13998. "properties": {
  13999. "content": {
  14000. "type": "string",
  14001. "x-go-name": "Reaction"
  14002. },
  14003. "created_at": {
  14004. "type": "string",
  14005. "format": "date-time",
  14006. "x-go-name": "Created"
  14007. },
  14008. "user": {
  14009. "$ref": "#/definitions/User"
  14010. }
  14011. },
  14012. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14013. },
  14014. "Reference": {
  14015. "type": "object",
  14016. "title": "Reference represents a Git reference.",
  14017. "properties": {
  14018. "object": {
  14019. "$ref": "#/definitions/GitObject"
  14020. },
  14021. "ref": {
  14022. "type": "string",
  14023. "x-go-name": "Ref"
  14024. },
  14025. "url": {
  14026. "type": "string",
  14027. "x-go-name": "URL"
  14028. }
  14029. },
  14030. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14031. },
  14032. "Release": {
  14033. "description": "Release represents a repository release",
  14034. "type": "object",
  14035. "properties": {
  14036. "assets": {
  14037. "type": "array",
  14038. "items": {
  14039. "$ref": "#/definitions/Attachment"
  14040. },
  14041. "x-go-name": "Attachments"
  14042. },
  14043. "author": {
  14044. "$ref": "#/definitions/User"
  14045. },
  14046. "body": {
  14047. "type": "string",
  14048. "x-go-name": "Note"
  14049. },
  14050. "created_at": {
  14051. "type": "string",
  14052. "format": "date-time",
  14053. "x-go-name": "CreatedAt"
  14054. },
  14055. "draft": {
  14056. "type": "boolean",
  14057. "x-go-name": "IsDraft"
  14058. },
  14059. "html_url": {
  14060. "type": "string",
  14061. "x-go-name": "HTMLURL"
  14062. },
  14063. "id": {
  14064. "type": "integer",
  14065. "format": "int64",
  14066. "x-go-name": "ID"
  14067. },
  14068. "name": {
  14069. "type": "string",
  14070. "x-go-name": "Title"
  14071. },
  14072. "prerelease": {
  14073. "type": "boolean",
  14074. "x-go-name": "IsPrerelease"
  14075. },
  14076. "published_at": {
  14077. "type": "string",
  14078. "format": "date-time",
  14079. "x-go-name": "PublishedAt"
  14080. },
  14081. "tag_name": {
  14082. "type": "string",
  14083. "x-go-name": "TagName"
  14084. },
  14085. "tarball_url": {
  14086. "type": "string",
  14087. "x-go-name": "TarURL"
  14088. },
  14089. "target_commitish": {
  14090. "type": "string",
  14091. "x-go-name": "Target"
  14092. },
  14093. "url": {
  14094. "type": "string",
  14095. "x-go-name": "URL"
  14096. },
  14097. "zipball_url": {
  14098. "type": "string",
  14099. "x-go-name": "ZipURL"
  14100. }
  14101. },
  14102. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14103. },
  14104. "RepoCommit": {
  14105. "type": "object",
  14106. "title": "RepoCommit contains information of a commit in the context of a repository.",
  14107. "properties": {
  14108. "author": {
  14109. "$ref": "#/definitions/CommitUser"
  14110. },
  14111. "committer": {
  14112. "$ref": "#/definitions/CommitUser"
  14113. },
  14114. "message": {
  14115. "type": "string",
  14116. "x-go-name": "Message"
  14117. },
  14118. "tree": {
  14119. "$ref": "#/definitions/CommitMeta"
  14120. },
  14121. "url": {
  14122. "type": "string",
  14123. "x-go-name": "URL"
  14124. }
  14125. },
  14126. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14127. },
  14128. "RepoTopicOptions": {
  14129. "description": "RepoTopicOptions a collection of repo topic names",
  14130. "type": "object",
  14131. "properties": {
  14132. "topics": {
  14133. "description": "list of topic names",
  14134. "type": "array",
  14135. "items": {
  14136. "type": "string"
  14137. },
  14138. "x-go-name": "Topics"
  14139. }
  14140. },
  14141. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14142. },
  14143. "Repository": {
  14144. "description": "Repository represents a repository",
  14145. "type": "object",
  14146. "properties": {
  14147. "allow_merge_commits": {
  14148. "type": "boolean",
  14149. "x-go-name": "AllowMerge"
  14150. },
  14151. "allow_rebase": {
  14152. "type": "boolean",
  14153. "x-go-name": "AllowRebase"
  14154. },
  14155. "allow_rebase_explicit": {
  14156. "type": "boolean",
  14157. "x-go-name": "AllowRebaseMerge"
  14158. },
  14159. "allow_squash_merge": {
  14160. "type": "boolean",
  14161. "x-go-name": "AllowSquash"
  14162. },
  14163. "archived": {
  14164. "type": "boolean",
  14165. "x-go-name": "Archived"
  14166. },
  14167. "avatar_url": {
  14168. "type": "string",
  14169. "x-go-name": "AvatarURL"
  14170. },
  14171. "clone_url": {
  14172. "type": "string",
  14173. "x-go-name": "CloneURL"
  14174. },
  14175. "created_at": {
  14176. "type": "string",
  14177. "format": "date-time",
  14178. "x-go-name": "Created"
  14179. },
  14180. "default_branch": {
  14181. "type": "string",
  14182. "x-go-name": "DefaultBranch"
  14183. },
  14184. "description": {
  14185. "type": "string",
  14186. "x-go-name": "Description"
  14187. },
  14188. "empty": {
  14189. "type": "boolean",
  14190. "x-go-name": "Empty"
  14191. },
  14192. "external_tracker": {
  14193. "$ref": "#/definitions/ExternalTracker"
  14194. },
  14195. "external_wiki": {
  14196. "$ref": "#/definitions/ExternalWiki"
  14197. },
  14198. "fork": {
  14199. "type": "boolean",
  14200. "x-go-name": "Fork"
  14201. },
  14202. "forks_count": {
  14203. "type": "integer",
  14204. "format": "int64",
  14205. "x-go-name": "Forks"
  14206. },
  14207. "full_name": {
  14208. "type": "string",
  14209. "x-go-name": "FullName"
  14210. },
  14211. "has_issues": {
  14212. "type": "boolean",
  14213. "x-go-name": "HasIssues"
  14214. },
  14215. "has_pull_requests": {
  14216. "type": "boolean",
  14217. "x-go-name": "HasPullRequests"
  14218. },
  14219. "has_wiki": {
  14220. "type": "boolean",
  14221. "x-go-name": "HasWiki"
  14222. },
  14223. "html_url": {
  14224. "type": "string",
  14225. "x-go-name": "HTMLURL"
  14226. },
  14227. "id": {
  14228. "type": "integer",
  14229. "format": "int64",
  14230. "x-go-name": "ID"
  14231. },
  14232. "ignore_whitespace_conflicts": {
  14233. "type": "boolean",
  14234. "x-go-name": "IgnoreWhitespaceConflicts"
  14235. },
  14236. "internal": {
  14237. "type": "boolean",
  14238. "x-go-name": "Internal"
  14239. },
  14240. "internal_tracker": {
  14241. "$ref": "#/definitions/InternalTracker"
  14242. },
  14243. "mirror": {
  14244. "type": "boolean",
  14245. "x-go-name": "Mirror"
  14246. },
  14247. "name": {
  14248. "type": "string",
  14249. "x-go-name": "Name"
  14250. },
  14251. "open_issues_count": {
  14252. "type": "integer",
  14253. "format": "int64",
  14254. "x-go-name": "OpenIssues"
  14255. },
  14256. "open_pr_counter": {
  14257. "type": "integer",
  14258. "format": "int64",
  14259. "x-go-name": "OpenPulls"
  14260. },
  14261. "original_url": {
  14262. "type": "string",
  14263. "x-go-name": "OriginalURL"
  14264. },
  14265. "owner": {
  14266. "$ref": "#/definitions/User"
  14267. },
  14268. "parent": {
  14269. "$ref": "#/definitions/Repository"
  14270. },
  14271. "permissions": {
  14272. "$ref": "#/definitions/Permission"
  14273. },
  14274. "private": {
  14275. "type": "boolean",
  14276. "x-go-name": "Private"
  14277. },
  14278. "release_counter": {
  14279. "type": "integer",
  14280. "format": "int64",
  14281. "x-go-name": "Releases"
  14282. },
  14283. "size": {
  14284. "type": "integer",
  14285. "format": "int64",
  14286. "x-go-name": "Size"
  14287. },
  14288. "ssh_url": {
  14289. "type": "string",
  14290. "x-go-name": "SSHURL"
  14291. },
  14292. "stars_count": {
  14293. "type": "integer",
  14294. "format": "int64",
  14295. "x-go-name": "Stars"
  14296. },
  14297. "template": {
  14298. "type": "boolean",
  14299. "x-go-name": "Template"
  14300. },
  14301. "updated_at": {
  14302. "type": "string",
  14303. "format": "date-time",
  14304. "x-go-name": "Updated"
  14305. },
  14306. "watchers_count": {
  14307. "type": "integer",
  14308. "format": "int64",
  14309. "x-go-name": "Watchers"
  14310. },
  14311. "website": {
  14312. "type": "string",
  14313. "x-go-name": "Website"
  14314. }
  14315. },
  14316. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14317. },
  14318. "RepositoryMeta": {
  14319. "description": "RepositoryMeta basic repository information",
  14320. "type": "object",
  14321. "properties": {
  14322. "full_name": {
  14323. "type": "string",
  14324. "x-go-name": "FullName"
  14325. },
  14326. "id": {
  14327. "type": "integer",
  14328. "format": "int64",
  14329. "x-go-name": "ID"
  14330. },
  14331. "name": {
  14332. "type": "string",
  14333. "x-go-name": "Name"
  14334. },
  14335. "owner": {
  14336. "type": "string",
  14337. "x-go-name": "Owner"
  14338. }
  14339. },
  14340. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14341. },
  14342. "ReviewStateType": {
  14343. "description": "ReviewStateType review state type",
  14344. "type": "string",
  14345. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14346. },
  14347. "SearchResults": {
  14348. "description": "SearchResults results of a successful search",
  14349. "type": "object",
  14350. "properties": {
  14351. "data": {
  14352. "type": "array",
  14353. "items": {
  14354. "$ref": "#/definitions/Repository"
  14355. },
  14356. "x-go-name": "Data"
  14357. },
  14358. "ok": {
  14359. "type": "boolean",
  14360. "x-go-name": "OK"
  14361. }
  14362. },
  14363. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14364. },
  14365. "ServerVersion": {
  14366. "description": "ServerVersion wraps the version of the server",
  14367. "type": "object",
  14368. "properties": {
  14369. "version": {
  14370. "type": "string",
  14371. "x-go-name": "Version"
  14372. }
  14373. },
  14374. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14375. },
  14376. "StateType": {
  14377. "description": "StateType issue state type",
  14378. "type": "string",
  14379. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14380. },
  14381. "Status": {
  14382. "description": "Status holds a single Status of a single Commit",
  14383. "type": "object",
  14384. "properties": {
  14385. "context": {
  14386. "type": "string",
  14387. "x-go-name": "Context"
  14388. },
  14389. "created_at": {
  14390. "type": "string",
  14391. "format": "date-time",
  14392. "x-go-name": "Created"
  14393. },
  14394. "creator": {
  14395. "$ref": "#/definitions/User"
  14396. },
  14397. "description": {
  14398. "type": "string",
  14399. "x-go-name": "Description"
  14400. },
  14401. "id": {
  14402. "type": "integer",
  14403. "format": "int64",
  14404. "x-go-name": "ID"
  14405. },
  14406. "status": {
  14407. "$ref": "#/definitions/StatusState"
  14408. },
  14409. "target_url": {
  14410. "type": "string",
  14411. "x-go-name": "TargetURL"
  14412. },
  14413. "updated_at": {
  14414. "type": "string",
  14415. "format": "date-time",
  14416. "x-go-name": "Updated"
  14417. },
  14418. "url": {
  14419. "type": "string",
  14420. "x-go-name": "URL"
  14421. }
  14422. },
  14423. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14424. },
  14425. "StatusState": {
  14426. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  14427. "type": "string",
  14428. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14429. },
  14430. "StopWatch": {
  14431. "description": "StopWatch represent a running stopwatch",
  14432. "type": "object",
  14433. "properties": {
  14434. "created": {
  14435. "type": "string",
  14436. "format": "date-time",
  14437. "x-go-name": "Created"
  14438. },
  14439. "issue_index": {
  14440. "type": "integer",
  14441. "format": "int64",
  14442. "x-go-name": "IssueIndex"
  14443. }
  14444. },
  14445. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14446. },
  14447. "SubmitPullReviewOptions": {
  14448. "description": "SubmitPullReviewOptions are options to submit a pending pull review",
  14449. "type": "object",
  14450. "properties": {
  14451. "body": {
  14452. "type": "string",
  14453. "x-go-name": "Body"
  14454. },
  14455. "event": {
  14456. "$ref": "#/definitions/ReviewStateType"
  14457. }
  14458. },
  14459. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14460. },
  14461. "Tag": {
  14462. "description": "Tag represents a repository tag",
  14463. "type": "object",
  14464. "properties": {
  14465. "commit": {
  14466. "$ref": "#/definitions/CommitMeta"
  14467. },
  14468. "id": {
  14469. "type": "string",
  14470. "x-go-name": "ID"
  14471. },
  14472. "name": {
  14473. "type": "string",
  14474. "x-go-name": "Name"
  14475. },
  14476. "tarball_url": {
  14477. "type": "string",
  14478. "x-go-name": "TarballURL"
  14479. },
  14480. "zipball_url": {
  14481. "type": "string",
  14482. "x-go-name": "ZipballURL"
  14483. }
  14484. },
  14485. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14486. },
  14487. "Team": {
  14488. "description": "Team represents a team in an organization",
  14489. "type": "object",
  14490. "properties": {
  14491. "can_create_org_repo": {
  14492. "type": "boolean",
  14493. "x-go-name": "CanCreateOrgRepo"
  14494. },
  14495. "description": {
  14496. "type": "string",
  14497. "x-go-name": "Description"
  14498. },
  14499. "id": {
  14500. "type": "integer",
  14501. "format": "int64",
  14502. "x-go-name": "ID"
  14503. },
  14504. "includes_all_repositories": {
  14505. "type": "boolean",
  14506. "x-go-name": "IncludesAllRepositories"
  14507. },
  14508. "name": {
  14509. "type": "string",
  14510. "x-go-name": "Name"
  14511. },
  14512. "organization": {
  14513. "$ref": "#/definitions/Organization"
  14514. },
  14515. "permission": {
  14516. "type": "string",
  14517. "enum": [
  14518. "none",
  14519. "read",
  14520. "write",
  14521. "admin",
  14522. "owner"
  14523. ],
  14524. "x-go-name": "Permission"
  14525. },
  14526. "units": {
  14527. "type": "array",
  14528. "items": {
  14529. "type": "string"
  14530. },
  14531. "x-go-name": "Units",
  14532. "example": [
  14533. "repo.code",
  14534. "repo.issues",
  14535. "repo.ext_issues",
  14536. "repo.wiki",
  14537. "repo.pulls",
  14538. "repo.releases",
  14539. "repo.ext_wiki"
  14540. ]
  14541. }
  14542. },
  14543. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14544. },
  14545. "TimeStamp": {
  14546. "description": "TimeStamp defines a timestamp",
  14547. "type": "integer",
  14548. "format": "int64",
  14549. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  14550. },
  14551. "TopicName": {
  14552. "description": "TopicName a list of repo topic names",
  14553. "type": "object",
  14554. "properties": {
  14555. "topics": {
  14556. "type": "array",
  14557. "items": {
  14558. "type": "string"
  14559. },
  14560. "x-go-name": "TopicNames"
  14561. }
  14562. },
  14563. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14564. },
  14565. "TopicResponse": {
  14566. "description": "TopicResponse for returning topics",
  14567. "type": "object",
  14568. "properties": {
  14569. "created": {
  14570. "type": "string",
  14571. "format": "date-time",
  14572. "x-go-name": "Created"
  14573. },
  14574. "id": {
  14575. "type": "integer",
  14576. "format": "int64",
  14577. "x-go-name": "ID"
  14578. },
  14579. "repo_count": {
  14580. "type": "integer",
  14581. "format": "int64",
  14582. "x-go-name": "RepoCount"
  14583. },
  14584. "topic_name": {
  14585. "type": "string",
  14586. "x-go-name": "Name"
  14587. },
  14588. "updated": {
  14589. "type": "string",
  14590. "format": "date-time",
  14591. "x-go-name": "Updated"
  14592. }
  14593. },
  14594. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14595. },
  14596. "TrackedTime": {
  14597. "description": "TrackedTime worked time for an issue / pr",
  14598. "type": "object",
  14599. "properties": {
  14600. "created": {
  14601. "type": "string",
  14602. "format": "date-time",
  14603. "x-go-name": "Created"
  14604. },
  14605. "id": {
  14606. "type": "integer",
  14607. "format": "int64",
  14608. "x-go-name": "ID"
  14609. },
  14610. "issue": {
  14611. "$ref": "#/definitions/Issue"
  14612. },
  14613. "issue_id": {
  14614. "description": "deprecated (only for backwards compatibility)",
  14615. "type": "integer",
  14616. "format": "int64",
  14617. "x-go-name": "IssueID"
  14618. },
  14619. "time": {
  14620. "description": "Time in seconds",
  14621. "type": "integer",
  14622. "format": "int64",
  14623. "x-go-name": "Time"
  14624. },
  14625. "user_id": {
  14626. "description": "deprecated (only for backwards compatibility)",
  14627. "type": "integer",
  14628. "format": "int64",
  14629. "x-go-name": "UserID"
  14630. },
  14631. "user_name": {
  14632. "type": "string",
  14633. "x-go-name": "UserName"
  14634. }
  14635. },
  14636. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14637. },
  14638. "TransferRepoOption": {
  14639. "description": "TransferRepoOption options when transfer a repository's ownership",
  14640. "type": "object",
  14641. "required": [
  14642. "new_owner"
  14643. ],
  14644. "properties": {
  14645. "new_owner": {
  14646. "type": "string",
  14647. "x-go-name": "NewOwner"
  14648. },
  14649. "team_ids": {
  14650. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  14651. "type": "array",
  14652. "items": {
  14653. "type": "integer",
  14654. "format": "int64"
  14655. },
  14656. "x-go-name": "TeamIDs"
  14657. }
  14658. },
  14659. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14660. },
  14661. "UpdateFileOptions": {
  14662. "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)",
  14663. "type": "object",
  14664. "required": [
  14665. "sha",
  14666. "content"
  14667. ],
  14668. "properties": {
  14669. "author": {
  14670. "$ref": "#/definitions/Identity"
  14671. },
  14672. "branch": {
  14673. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  14674. "type": "string",
  14675. "x-go-name": "BranchName"
  14676. },
  14677. "committer": {
  14678. "$ref": "#/definitions/Identity"
  14679. },
  14680. "content": {
  14681. "description": "content must be base64 encoded",
  14682. "type": "string",
  14683. "x-go-name": "Content"
  14684. },
  14685. "dates": {
  14686. "$ref": "#/definitions/CommitDateOptions"
  14687. },
  14688. "from_path": {
  14689. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  14690. "type": "string",
  14691. "x-go-name": "FromPath"
  14692. },
  14693. "message": {
  14694. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  14695. "type": "string",
  14696. "x-go-name": "Message"
  14697. },
  14698. "new_branch": {
  14699. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  14700. "type": "string",
  14701. "x-go-name": "NewBranchName"
  14702. },
  14703. "sha": {
  14704. "description": "sha is the SHA for the file that already exists",
  14705. "type": "string",
  14706. "x-go-name": "SHA"
  14707. }
  14708. },
  14709. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14710. },
  14711. "User": {
  14712. "description": "User represents a user",
  14713. "type": "object",
  14714. "properties": {
  14715. "avatar_url": {
  14716. "description": "URL to the user's avatar",
  14717. "type": "string",
  14718. "x-go-name": "AvatarURL"
  14719. },
  14720. "created": {
  14721. "type": "string",
  14722. "format": "date-time",
  14723. "x-go-name": "Created"
  14724. },
  14725. "email": {
  14726. "type": "string",
  14727. "format": "email",
  14728. "x-go-name": "Email"
  14729. },
  14730. "full_name": {
  14731. "description": "the user's full name",
  14732. "type": "string",
  14733. "x-go-name": "FullName"
  14734. },
  14735. "id": {
  14736. "description": "the user's id",
  14737. "type": "integer",
  14738. "format": "int64",
  14739. "x-go-name": "ID"
  14740. },
  14741. "is_admin": {
  14742. "description": "Is the user an administrator",
  14743. "type": "boolean",
  14744. "x-go-name": "IsAdmin"
  14745. },
  14746. "language": {
  14747. "description": "User locale",
  14748. "type": "string",
  14749. "x-go-name": "Language"
  14750. },
  14751. "last_login": {
  14752. "type": "string",
  14753. "format": "date-time",
  14754. "x-go-name": "LastLogin"
  14755. },
  14756. "login": {
  14757. "description": "the user's username",
  14758. "type": "string",
  14759. "x-go-name": "UserName"
  14760. }
  14761. },
  14762. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14763. },
  14764. "UserHeatmapData": {
  14765. "description": "UserHeatmapData represents the data needed to create a heatmap",
  14766. "type": "object",
  14767. "properties": {
  14768. "contributions": {
  14769. "type": "integer",
  14770. "format": "int64",
  14771. "x-go-name": "Contributions"
  14772. },
  14773. "timestamp": {
  14774. "$ref": "#/definitions/TimeStamp"
  14775. }
  14776. },
  14777. "x-go-package": "code.gitea.io/gitea/models"
  14778. },
  14779. "WatchInfo": {
  14780. "description": "WatchInfo represents an API watch status of one repository",
  14781. "type": "object",
  14782. "properties": {
  14783. "created_at": {
  14784. "type": "string",
  14785. "format": "date-time",
  14786. "x-go-name": "CreatedAt"
  14787. },
  14788. "ignored": {
  14789. "type": "boolean",
  14790. "x-go-name": "Ignored"
  14791. },
  14792. "reason": {
  14793. "type": "object",
  14794. "x-go-name": "Reason"
  14795. },
  14796. "repository_url": {
  14797. "type": "string",
  14798. "x-go-name": "RepositoryURL"
  14799. },
  14800. "subscribed": {
  14801. "type": "boolean",
  14802. "x-go-name": "Subscribed"
  14803. },
  14804. "url": {
  14805. "type": "string",
  14806. "x-go-name": "URL"
  14807. }
  14808. },
  14809. "x-go-package": "code.gitea.io/gitea/modules/structs"
  14810. }
  14811. },
  14812. "responses": {
  14813. "AccessToken": {
  14814. "description": "AccessToken represents an API access token.",
  14815. "headers": {
  14816. "id": {
  14817. "type": "integer",
  14818. "format": "int64"
  14819. },
  14820. "name": {
  14821. "type": "string"
  14822. },
  14823. "sha1": {
  14824. "type": "string"
  14825. },
  14826. "token_last_eight": {
  14827. "type": "string"
  14828. }
  14829. }
  14830. },
  14831. "AccessTokenList": {
  14832. "description": "AccessTokenList represents a list of API access token.",
  14833. "schema": {
  14834. "type": "array",
  14835. "items": {
  14836. "$ref": "#/definitions/AccessToken"
  14837. }
  14838. }
  14839. },
  14840. "AnnotatedTag": {
  14841. "description": "AnnotatedTag",
  14842. "schema": {
  14843. "$ref": "#/definitions/AnnotatedTag"
  14844. }
  14845. },
  14846. "Attachment": {
  14847. "description": "Attachment",
  14848. "schema": {
  14849. "$ref": "#/definitions/Attachment"
  14850. }
  14851. },
  14852. "AttachmentList": {
  14853. "description": "AttachmentList",
  14854. "schema": {
  14855. "type": "array",
  14856. "items": {
  14857. "$ref": "#/definitions/Attachment"
  14858. }
  14859. }
  14860. },
  14861. "Branch": {
  14862. "description": "Branch",
  14863. "schema": {
  14864. "$ref": "#/definitions/Branch"
  14865. }
  14866. },
  14867. "BranchList": {
  14868. "description": "BranchList",
  14869. "schema": {
  14870. "type": "array",
  14871. "items": {
  14872. "$ref": "#/definitions/Branch"
  14873. }
  14874. }
  14875. },
  14876. "BranchProtection": {
  14877. "description": "BranchProtection",
  14878. "schema": {
  14879. "$ref": "#/definitions/BranchProtection"
  14880. }
  14881. },
  14882. "BranchProtectionList": {
  14883. "description": "BranchProtectionList",
  14884. "schema": {
  14885. "type": "array",
  14886. "items": {
  14887. "$ref": "#/definitions/BranchProtection"
  14888. }
  14889. }
  14890. },
  14891. "Comment": {
  14892. "description": "Comment",
  14893. "schema": {
  14894. "$ref": "#/definitions/Comment"
  14895. }
  14896. },
  14897. "CommentList": {
  14898. "description": "CommentList",
  14899. "schema": {
  14900. "type": "array",
  14901. "items": {
  14902. "$ref": "#/definitions/Comment"
  14903. }
  14904. }
  14905. },
  14906. "Commit": {
  14907. "description": "Commit",
  14908. "schema": {
  14909. "$ref": "#/definitions/Commit"
  14910. }
  14911. },
  14912. "CommitList": {
  14913. "description": "CommitList",
  14914. "schema": {
  14915. "type": "array",
  14916. "items": {
  14917. "$ref": "#/definitions/Commit"
  14918. }
  14919. },
  14920. "headers": {
  14921. "X-HasMore": {
  14922. "type": "boolean",
  14923. "description": "True if there is another page"
  14924. },
  14925. "X-Page": {
  14926. "type": "integer",
  14927. "format": "int64",
  14928. "description": "The current page"
  14929. },
  14930. "X-PageCount": {
  14931. "type": "integer",
  14932. "format": "int64",
  14933. "description": "Total number of pages"
  14934. },
  14935. "X-PerPage": {
  14936. "type": "integer",
  14937. "format": "int64",
  14938. "description": "Commits per page"
  14939. },
  14940. "X-Total": {
  14941. "type": "integer",
  14942. "format": "int64",
  14943. "description": "Total commit count"
  14944. }
  14945. }
  14946. },
  14947. "ContentsListResponse": {
  14948. "description": "ContentsListResponse",
  14949. "schema": {
  14950. "type": "array",
  14951. "items": {
  14952. "$ref": "#/definitions/ContentsResponse"
  14953. }
  14954. }
  14955. },
  14956. "ContentsResponse": {
  14957. "description": "ContentsResponse",
  14958. "schema": {
  14959. "$ref": "#/definitions/ContentsResponse"
  14960. }
  14961. },
  14962. "DeployKey": {
  14963. "description": "DeployKey",
  14964. "schema": {
  14965. "$ref": "#/definitions/DeployKey"
  14966. }
  14967. },
  14968. "DeployKeyList": {
  14969. "description": "DeployKeyList",
  14970. "schema": {
  14971. "type": "array",
  14972. "items": {
  14973. "$ref": "#/definitions/DeployKey"
  14974. }
  14975. }
  14976. },
  14977. "EmailList": {
  14978. "description": "EmailList",
  14979. "schema": {
  14980. "type": "array",
  14981. "items": {
  14982. "$ref": "#/definitions/Email"
  14983. }
  14984. }
  14985. },
  14986. "EmptyRepository": {
  14987. "description": "EmptyRepository",
  14988. "schema": {
  14989. "$ref": "#/definitions/APIError"
  14990. }
  14991. },
  14992. "FileDeleteResponse": {
  14993. "description": "FileDeleteResponse",
  14994. "schema": {
  14995. "$ref": "#/definitions/FileDeleteResponse"
  14996. }
  14997. },
  14998. "FileResponse": {
  14999. "description": "FileResponse",
  15000. "schema": {
  15001. "$ref": "#/definitions/FileResponse"
  15002. }
  15003. },
  15004. "GPGKey": {
  15005. "description": "GPGKey",
  15006. "schema": {
  15007. "$ref": "#/definitions/GPGKey"
  15008. }
  15009. },
  15010. "GPGKeyList": {
  15011. "description": "GPGKeyList",
  15012. "schema": {
  15013. "type": "array",
  15014. "items": {
  15015. "$ref": "#/definitions/GPGKey"
  15016. }
  15017. }
  15018. },
  15019. "GeneralRepoSettings": {
  15020. "description": "GeneralRepoSettings",
  15021. "schema": {
  15022. "$ref": "#/definitions/GeneralRepoSettings"
  15023. }
  15024. },
  15025. "GeneralUISettings": {
  15026. "description": "GeneralUISettings",
  15027. "schema": {
  15028. "$ref": "#/definitions/GeneralUISettings"
  15029. }
  15030. },
  15031. "GitBlobResponse": {
  15032. "description": "GitBlobResponse",
  15033. "schema": {
  15034. "$ref": "#/definitions/GitBlobResponse"
  15035. }
  15036. },
  15037. "GitHook": {
  15038. "description": "GitHook",
  15039. "schema": {
  15040. "$ref": "#/definitions/GitHook"
  15041. }
  15042. },
  15043. "GitHookList": {
  15044. "description": "GitHookList",
  15045. "schema": {
  15046. "type": "array",
  15047. "items": {
  15048. "$ref": "#/definitions/GitHook"
  15049. }
  15050. }
  15051. },
  15052. "GitTreeResponse": {
  15053. "description": "GitTreeResponse",
  15054. "schema": {
  15055. "$ref": "#/definitions/GitTreeResponse"
  15056. }
  15057. },
  15058. "Hook": {
  15059. "description": "Hook",
  15060. "schema": {
  15061. "$ref": "#/definitions/Hook"
  15062. }
  15063. },
  15064. "HookList": {
  15065. "description": "HookList",
  15066. "schema": {
  15067. "type": "array",
  15068. "items": {
  15069. "$ref": "#/definitions/Hook"
  15070. }
  15071. }
  15072. },
  15073. "Issue": {
  15074. "description": "Issue",
  15075. "schema": {
  15076. "$ref": "#/definitions/Issue"
  15077. }
  15078. },
  15079. "IssueDeadline": {
  15080. "description": "IssueDeadline",
  15081. "schema": {
  15082. "$ref": "#/definitions/IssueDeadline"
  15083. }
  15084. },
  15085. "IssueList": {
  15086. "description": "IssueList",
  15087. "schema": {
  15088. "type": "array",
  15089. "items": {
  15090. "$ref": "#/definitions/Issue"
  15091. }
  15092. }
  15093. },
  15094. "Label": {
  15095. "description": "Label",
  15096. "schema": {
  15097. "$ref": "#/definitions/Label"
  15098. }
  15099. },
  15100. "LabelList": {
  15101. "description": "LabelList",
  15102. "schema": {
  15103. "type": "array",
  15104. "items": {
  15105. "$ref": "#/definitions/Label"
  15106. }
  15107. }
  15108. },
  15109. "LanguageStatistics": {
  15110. "description": "LanguageStatistics",
  15111. "schema": {
  15112. "type": "object",
  15113. "additionalProperties": {
  15114. "type": "integer",
  15115. "format": "int64"
  15116. }
  15117. }
  15118. },
  15119. "MarkdownRender": {
  15120. "description": "MarkdownRender is a rendered markdown document",
  15121. "schema": {
  15122. "type": "string"
  15123. }
  15124. },
  15125. "Milestone": {
  15126. "description": "Milestone",
  15127. "schema": {
  15128. "$ref": "#/definitions/Milestone"
  15129. }
  15130. },
  15131. "MilestoneList": {
  15132. "description": "MilestoneList",
  15133. "schema": {
  15134. "type": "array",
  15135. "items": {
  15136. "$ref": "#/definitions/Milestone"
  15137. }
  15138. }
  15139. },
  15140. "NotificationCount": {
  15141. "description": "Number of unread notifications",
  15142. "schema": {
  15143. "$ref": "#/definitions/NotificationCount"
  15144. }
  15145. },
  15146. "NotificationThread": {
  15147. "description": "NotificationThread",
  15148. "schema": {
  15149. "$ref": "#/definitions/NotificationThread"
  15150. }
  15151. },
  15152. "NotificationThreadList": {
  15153. "description": "NotificationThreadList",
  15154. "schema": {
  15155. "type": "array",
  15156. "items": {
  15157. "$ref": "#/definitions/NotificationThread"
  15158. }
  15159. }
  15160. },
  15161. "OAuth2Application": {
  15162. "description": "OAuth2Application",
  15163. "schema": {
  15164. "$ref": "#/definitions/OAuth2Application"
  15165. }
  15166. },
  15167. "OAuth2ApplicationList": {
  15168. "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
  15169. "schema": {
  15170. "type": "array",
  15171. "items": {
  15172. "$ref": "#/definitions/OAuth2Application"
  15173. }
  15174. }
  15175. },
  15176. "Organization": {
  15177. "description": "Organization",
  15178. "schema": {
  15179. "$ref": "#/definitions/Organization"
  15180. }
  15181. },
  15182. "OrganizationList": {
  15183. "description": "OrganizationList",
  15184. "schema": {
  15185. "type": "array",
  15186. "items": {
  15187. "$ref": "#/definitions/Organization"
  15188. }
  15189. }
  15190. },
  15191. "PublicKey": {
  15192. "description": "PublicKey",
  15193. "schema": {
  15194. "$ref": "#/definitions/PublicKey"
  15195. }
  15196. },
  15197. "PublicKeyList": {
  15198. "description": "PublicKeyList",
  15199. "schema": {
  15200. "type": "array",
  15201. "items": {
  15202. "$ref": "#/definitions/PublicKey"
  15203. }
  15204. }
  15205. },
  15206. "PullRequest": {
  15207. "description": "PullRequest",
  15208. "schema": {
  15209. "$ref": "#/definitions/PullRequest"
  15210. }
  15211. },
  15212. "PullRequestList": {
  15213. "description": "PullRequestList",
  15214. "schema": {
  15215. "type": "array",
  15216. "items": {
  15217. "$ref": "#/definitions/PullRequest"
  15218. }
  15219. }
  15220. },
  15221. "PullReview": {
  15222. "description": "PullReview",
  15223. "schema": {
  15224. "$ref": "#/definitions/PullReview"
  15225. }
  15226. },
  15227. "PullReviewComment": {
  15228. "description": "PullComment",
  15229. "schema": {
  15230. "$ref": "#/definitions/PullReviewComment"
  15231. }
  15232. },
  15233. "PullReviewCommentList": {
  15234. "description": "PullCommentList",
  15235. "schema": {
  15236. "type": "array",
  15237. "items": {
  15238. "$ref": "#/definitions/PullReviewComment"
  15239. }
  15240. }
  15241. },
  15242. "PullReviewList": {
  15243. "description": "PullReviewList",
  15244. "schema": {
  15245. "type": "array",
  15246. "items": {
  15247. "$ref": "#/definitions/PullReview"
  15248. }
  15249. }
  15250. },
  15251. "Reaction": {
  15252. "description": "Reaction",
  15253. "schema": {
  15254. "$ref": "#/definitions/Reaction"
  15255. }
  15256. },
  15257. "ReactionList": {
  15258. "description": "ReactionList",
  15259. "schema": {
  15260. "type": "array",
  15261. "items": {
  15262. "$ref": "#/definitions/Reaction"
  15263. }
  15264. }
  15265. },
  15266. "Reference": {
  15267. "description": "Reference",
  15268. "schema": {
  15269. "$ref": "#/definitions/Reference"
  15270. }
  15271. },
  15272. "ReferenceList": {
  15273. "description": "ReferenceList",
  15274. "schema": {
  15275. "type": "array",
  15276. "items": {
  15277. "$ref": "#/definitions/Reference"
  15278. }
  15279. }
  15280. },
  15281. "Release": {
  15282. "description": "Release",
  15283. "schema": {
  15284. "$ref": "#/definitions/Release"
  15285. }
  15286. },
  15287. "ReleaseList": {
  15288. "description": "ReleaseList",
  15289. "schema": {
  15290. "type": "array",
  15291. "items": {
  15292. "$ref": "#/definitions/Release"
  15293. }
  15294. }
  15295. },
  15296. "Repository": {
  15297. "description": "Repository",
  15298. "schema": {
  15299. "$ref": "#/definitions/Repository"
  15300. }
  15301. },
  15302. "RepositoryList": {
  15303. "description": "RepositoryList",
  15304. "schema": {
  15305. "type": "array",
  15306. "items": {
  15307. "$ref": "#/definitions/Repository"
  15308. }
  15309. }
  15310. },
  15311. "SearchResults": {
  15312. "description": "SearchResults",
  15313. "schema": {
  15314. "$ref": "#/definitions/SearchResults"
  15315. }
  15316. },
  15317. "ServerVersion": {
  15318. "description": "ServerVersion",
  15319. "schema": {
  15320. "$ref": "#/definitions/ServerVersion"
  15321. }
  15322. },
  15323. "Status": {
  15324. "description": "Status",
  15325. "schema": {
  15326. "$ref": "#/definitions/Status"
  15327. }
  15328. },
  15329. "StatusList": {
  15330. "description": "StatusList",
  15331. "schema": {
  15332. "type": "array",
  15333. "items": {
  15334. "$ref": "#/definitions/Status"
  15335. }
  15336. }
  15337. },
  15338. "StopWatch": {
  15339. "description": "StopWatch",
  15340. "schema": {
  15341. "$ref": "#/definitions/StopWatch"
  15342. }
  15343. },
  15344. "StopWatchList": {
  15345. "description": "StopWatchList",
  15346. "schema": {
  15347. "type": "array",
  15348. "items": {
  15349. "$ref": "#/definitions/StopWatch"
  15350. }
  15351. }
  15352. },
  15353. "StringSlice": {
  15354. "description": "StringSlice",
  15355. "schema": {
  15356. "type": "array",
  15357. "items": {
  15358. "type": "string"
  15359. }
  15360. }
  15361. },
  15362. "Tag": {
  15363. "description": "Tag",
  15364. "schema": {
  15365. "$ref": "#/definitions/Tag"
  15366. }
  15367. },
  15368. "TagList": {
  15369. "description": "TagList",
  15370. "schema": {
  15371. "type": "array",
  15372. "items": {
  15373. "$ref": "#/definitions/Tag"
  15374. }
  15375. }
  15376. },
  15377. "Team": {
  15378. "description": "Team",
  15379. "schema": {
  15380. "$ref": "#/definitions/Team"
  15381. }
  15382. },
  15383. "TeamList": {
  15384. "description": "TeamList",
  15385. "schema": {
  15386. "type": "array",
  15387. "items": {
  15388. "$ref": "#/definitions/Team"
  15389. }
  15390. }
  15391. },
  15392. "TopicListResponse": {
  15393. "description": "TopicListResponse",
  15394. "schema": {
  15395. "type": "array",
  15396. "items": {
  15397. "$ref": "#/definitions/TopicResponse"
  15398. }
  15399. }
  15400. },
  15401. "TopicNames": {
  15402. "description": "TopicNames",
  15403. "schema": {
  15404. "$ref": "#/definitions/TopicName"
  15405. }
  15406. },
  15407. "TrackedTime": {
  15408. "description": "TrackedTime",
  15409. "schema": {
  15410. "$ref": "#/definitions/TrackedTime"
  15411. }
  15412. },
  15413. "TrackedTimeList": {
  15414. "description": "TrackedTimeList",
  15415. "schema": {
  15416. "type": "array",
  15417. "items": {
  15418. "$ref": "#/definitions/TrackedTime"
  15419. }
  15420. }
  15421. },
  15422. "User": {
  15423. "description": "User",
  15424. "schema": {
  15425. "$ref": "#/definitions/User"
  15426. }
  15427. },
  15428. "UserHeatmapData": {
  15429. "description": "UserHeatmapData",
  15430. "schema": {
  15431. "type": "array",
  15432. "items": {
  15433. "$ref": "#/definitions/UserHeatmapData"
  15434. }
  15435. }
  15436. },
  15437. "UserList": {
  15438. "description": "UserList",
  15439. "schema": {
  15440. "type": "array",
  15441. "items": {
  15442. "$ref": "#/definitions/User"
  15443. }
  15444. }
  15445. },
  15446. "WatchInfo": {
  15447. "description": "WatchInfo",
  15448. "schema": {
  15449. "$ref": "#/definitions/WatchInfo"
  15450. }
  15451. },
  15452. "empty": {
  15453. "description": "APIEmpty is an empty response"
  15454. },
  15455. "error": {
  15456. "description": "APIError is error format response",
  15457. "headers": {
  15458. "message": {
  15459. "type": "string"
  15460. },
  15461. "url": {
  15462. "type": "string"
  15463. }
  15464. }
  15465. },
  15466. "forbidden": {
  15467. "description": "APIForbiddenError is a forbidden error response",
  15468. "headers": {
  15469. "message": {
  15470. "type": "string"
  15471. },
  15472. "url": {
  15473. "type": "string"
  15474. }
  15475. }
  15476. },
  15477. "invalidTopicsError": {
  15478. "description": "APIInvalidTopicsError is error format response to invalid topics",
  15479. "headers": {
  15480. "invalidTopics": {
  15481. "type": "array",
  15482. "items": {
  15483. "type": "string"
  15484. }
  15485. },
  15486. "message": {
  15487. "type": "string"
  15488. }
  15489. }
  15490. },
  15491. "notFound": {
  15492. "description": "APINotFound is a not found empty response"
  15493. },
  15494. "parameterBodies": {
  15495. "description": "parameterBodies",
  15496. "schema": {
  15497. "$ref": "#/definitions/SubmitPullReviewOptions"
  15498. }
  15499. },
  15500. "redirect": {
  15501. "description": "APIRedirect is a redirect response"
  15502. },
  15503. "string": {
  15504. "description": "APIString is a string response",
  15505. "schema": {
  15506. "type": "string"
  15507. }
  15508. },
  15509. "validationError": {
  15510. "description": "APIValidationError is error format response related to input validation",
  15511. "headers": {
  15512. "message": {
  15513. "type": "string"
  15514. },
  15515. "url": {
  15516. "type": "string"
  15517. }
  15518. }
  15519. }
  15520. },
  15521. "securityDefinitions": {
  15522. "AccessToken": {
  15523. "type": "apiKey",
  15524. "name": "access_token",
  15525. "in": "query"
  15526. },
  15527. "AuthorizationHeaderToken": {
  15528. "description": "API tokens must be prepended with \"token\" followed by a space.",
  15529. "type": "apiKey",
  15530. "name": "Authorization",
  15531. "in": "header"
  15532. },
  15533. "BasicAuth": {
  15534. "type": "basic"
  15535. },
  15536. "SudoHeader": {
  15537. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  15538. "type": "apiKey",
  15539. "name": "Sudo",
  15540. "in": "header"
  15541. },
  15542. "SudoParam": {
  15543. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  15544. "type": "apiKey",
  15545. "name": "sudo",
  15546. "in": "query"
  15547. },
  15548. "Token": {
  15549. "type": "apiKey",
  15550. "name": "token",
  15551. "in": "query"
  15552. }
  15553. },
  15554. "security": [
  15555. {
  15556. "BasicAuth": []
  15557. },
  15558. {
  15559. "Token": []
  15560. },
  15561. {
  15562. "AccessToken": []
  15563. },
  15564. {
  15565. "AuthorizationHeaderToken": []
  15566. },
  15567. {
  15568. "SudoParam": []
  15569. },
  15570. {
  15571. "SudoHeader": []
  15572. }
  15573. ]
  15574. }