123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491 |
- {
- "consumes": [
- "application/json",
- "text/plain"
- ],
- "produces": [
- "application/json",
- "text/html"
- ],
- "schemes": [
- "http",
- "https"
- ],
- "swagger": "2.0",
- "info": {
- "description": "This documentation describes the Gitea API.",
- "title": "Gitea API.",
- "license": {
- "name": "MIT",
- "url": "http://opensource.org/licenses/MIT"
- },
- "version": "1.1.1"
- },
- "basePath": "{{AppSubUrl}}/api/v1",
- "paths": {
- "/admin/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List all organizations",
- "operationId": "adminGetAllOrgs",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/users": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List all users",
- "operationId": "adminGetAllUsers",
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a user",
- "operationId": "adminCreateUser",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateUserOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/User"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a user",
- "operationId": "adminDeleteUser",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to delete",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Edit an existing user",
- "operationId": "adminEditUser",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to edit",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditUserOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/keys": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Add a public key on behalf of a user",
- "operationId": "adminCreatePublicKey",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "key",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PublicKey"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/keys/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a user's public key",
- "operationId": "adminDeleteUserPublicKey",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/admin/users/{username}/orgs": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create an organization",
- "operationId": "adminCreateOrg",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user that will own the created organization",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "organization",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOrgOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Organization"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/repos": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a repository on behalf a user",
- "operationId": "adminCreateRepo",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user. This user will own the created repository",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "repository",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/markdown": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render a markdown document as HTML",
- "operationId": "renderMarkdown",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MarkdownOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkdownRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/markdown/raw": {
- "post": {
- "consumes": [
- "text/plain"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render raw markdown as HTML",
- "operationId": "renderMarkdownRaw",
- "parameters": [
- {
- "description": "Request body to render",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkdownRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/org/{org}/repos": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a repository in an organization",
- "operationId": "createOrgRepo",
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create an organization",
- "operationId": "orgCreate",
- "parameters": [
- {
- "name": "organization",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOrgOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Organization"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get an organization",
- "operationId": "orgGet",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization to get",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Organization"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete an organization",
- "operationId": "orgDelete",
- "parameters": [
- {
- "type": "string",
- "description": "organization that is to be deleted",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Edit an organization",
- "operationId": "orgEdit",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization to edit",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/EditOrgOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Organization"
- }
- }
- }
- },
- "/orgs/{org}/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's webhooks",
- "operationId": "orgListHooks",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- }
- }
- }
- },
- "/orgs/{org}/hooks/": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a hook",
- "operationId": "orgCreateHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/orgs/{org}/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a hook",
- "operationId": "orgGetHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete a hook",
- "operationId": "orgDeleteHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Update a hook",
- "operationId": "orgEditHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to update",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/orgs/{org}/members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's members",
- "operationId": "orgListMembers",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/orgs/{org}/members/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is a member of an organization",
- "operationId": "orgIsMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "user is a member"
- },
- "404": {
- "description": "user is not a member"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a member from an organization",
- "operationId": "orgDeleteMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "member removed"
- }
- }
- }
- },
- "/orgs/{org}/public_members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's public members",
- "operationId": "orgListPublicMembers",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/orgs/{org}/public_members/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is a public member of an organization",
- "operationId": "orgIsPublicMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "user is a public member"
- },
- "404": {
- "description": "user is not a public member"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Publicize a user's membership",
- "operationId": "orgPublicizeMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "membership publicized"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Conceal a user's membership",
- "operationId": "orgConcealMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/orgs/{org}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's repos",
- "operationId": "orgListRepos",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/orgs/{org}/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's teams",
- "operationId": "orgListTeams",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a team",
- "operationId": "orgCreateTeam",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateTeamOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Team"
- }
- }
- }
- },
- "/repos/migrate": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Migrate a remote git repository",
- "operationId": "repoMigrate",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MigrateRepoForm"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- }
- }
- }
- },
- "/repos/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Search for repositories",
- "operationId": "repoSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that the user with the given id owns or contributes to",
- "name": "uid",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that the user with the given id has starred",
- "name": "starredBy",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include private repositories this user has access to (defaults to true)",
- "name": "private",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- },
- {
- "type": "string",
- "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
- "name": "mode",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "if `uid` is given, search only for repos that the user owns",
- "name": "exclusive",
- "in": "query"
- },
- {
- "type": "string",
- "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
- "name": "sort",
- "in": "query"
- },
- {
- "type": "string",
- "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
- "name": "order",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/SearchResults"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository",
- "operationId": "repoGet",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a repository",
- "operationId": "repoDelete",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to delete",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to delete",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a repository's properties. Only fields that are set will be changed.",
- "operationId": "repoEdit",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to edit",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to edit",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "description": "Properties of a repo that you can edit",
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditRepoOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/archive/{archive}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get an archive of a repository",
- "operationId": "repoGetArchive",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "archive to download, consisting of a git reference and archive",
- "name": "archive",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branches": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's branches",
- "operationId": "repoListBranches",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branches/{branch}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Retrieve a specific branch from a repository",
- "operationId": "repoGetBranch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "branch to get",
- "name": "branch",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Branch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's collaborators",
- "operationId": "repoListCollaborators",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators/{collaborator}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a user is a collaborator of a repository",
- "operationId": "repoCheckCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a collaborator to a repository",
- "operationId": "repoAddCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator to add",
- "name": "collaborator",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddCollaboratorOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a collaborator from a repository",
- "operationId": "repoDeleteCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator to delete",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits/{ref}/statuses": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's combined status, by branch/tag/commit reference",
- "operationId": "repoGetCombinedStatusByRef",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of branch/tag/commit",
- "name": "ref",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results",
- "name": "page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Status"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/contents": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the metadata of all the entries of the root dir",
- "operationId": "repoGetContentsList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ContentsListResponse"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/contents/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
- "operationId": "repoGetContents",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the dir, file, symlink or submodule in the repo",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ContentsResponse"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a file in a repository",
- "operationId": "repoUpdateFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to update",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UpdateFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileResponse"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a file in a repository",
- "operationId": "repoCreateFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to create",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateFileOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/FileResponse"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a file in a repository",
- "operationId": "repoDeleteFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to delete",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeleteFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileDeleteResponse"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/editorconfig/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get the EditorConfig definitions of a file in a repository",
- "operationId": "repoGetEditorConfig",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/forks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's forks",
- "operationId": "listForks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Fork a repository",
- "operationId": "createFork",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to fork",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to fork",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateForkOption"
- }
- }
- ],
- "responses": {
- "202": {
- "$ref": "#/responses/Repository"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/blobs/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the blob of a repository.",
- "operationId": "GetBlob",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitBlobResponse"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/commits/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a single commit from a repository",
- "operationId": "repoGetSingleCommit",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "the commit hash",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Commit"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/refs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get specified ref or filtered repository's refs",
- "operationId": "repoListAllGitRefs",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReferenceList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/refs/{ref}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get specified ref or filtered repository's refs",
- "operationId": "repoListGitRefs",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "part or full name of the ref",
- "name": "ref",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReferenceList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/tags/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the tag of a repository.",
- "operationId": "GetTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the tag",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AnnotatedTag"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/trees/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the tree of a repository.",
- "operationId": "GetTree",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "show all directories and files",
- "name": "recursive",
- "in": "query"
- },
- {
- "type": "integer",
- "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",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
- "name": "per_page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitTreeResponse"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List the hooks in a repository",
- "operationId": "repoListHooks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a hook",
- "operationId": "repoCreateHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/git": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List the Git hooks in a repository",
- "operationId": "repoListGitHooks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHookList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/git/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a Git hook",
- "operationId": "repoGetGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a Git hook in a repository",
- "operationId": "repoDeleteGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a Git hook in a repository",
- "operationId": "repoEditGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditGitHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a hook",
- "operationId": "repoGetHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a hook in a repository",
- "operationId": "repoDeleteHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a hook in a repository",
- "operationId": "repoEditHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the hook",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}/tests": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Test a push webhook",
- "operationId": "repoTestHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to test",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List a repository's issues",
- "operationId": "issueListIssues",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "whether issue is open or closed",
- "name": "state",
- "in": "query"
- },
- {
- "type": "string",
- "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of requested issues",
- "name": "page",
- "in": "query"
- },
- {
- "type": "string",
- "description": "search string",
- "name": "q",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueCreateIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateIssueOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments in a repository",
- "operationId": "issueGetRepoComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "if provided, only comments updated since the provided time are returned.",
- "name": "since",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommentList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}": {
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment",
- "operationId": "issueDeleteComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of comment to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment",
- "operationId": "issueEditComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueCommentOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{id}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List an issue's tracked times",
- "operationId": "issueTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a tracked time to a issue",
- "operationId": "issueAddTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to add tracked time to",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddTimeOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTime"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue",
- "operationId": "issueGetIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to get",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Issue"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueEditIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to edit",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments on an issue",
- "operationId": "issueGetComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "if provided, only comments updated since the specified time are returned.",
- "name": "since",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommentList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a comment to an issue",
- "operationId": "issueCreateComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateIssueCommentOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Comment"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment",
- "operationId": "issueDeleteCommentDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "this parameter is ignored",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of comment to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment",
- "operationId": "issueEditCommentDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "this parameter is ignored",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueCommentOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/deadline": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "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.",
- "operationId": "issueEditIssueDeadline",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to create or update a deadline on",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditDeadlineOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/IssueDeadline"
- },
- "403": {
- "description": "Not repo writer"
- },
- "404": {
- "description": "Issue not found"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue's labels",
- "operationId": "issueGetLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Replace an issue's labels",
- "operationId": "issueReplaceLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueLabelsOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a label to an issue",
- "operationId": "issueAddLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueLabelsOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove all labels from an issue",
- "operationId": "issueClearLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a label from an issue",
- "operationId": "issueRemoveLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to remove",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Start stopwatch on an issue.",
- "operationId": "issueStartStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to create the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "description": "Issue not found"
- },
- "409": {
- "description": "Cannot start a stopwatch again if it already exists"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Stop an issue's existing stopwatch.",
- "operationId": "issueStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to stop the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "description": "Issue not found"
- },
- "409": {
- "description": "Cannot stop a non existent stopwatch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's keys",
- "operationId": "repoListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "the key_id to search for",
- "name": "key_id",
- "in": "query"
- },
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/DeployKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a key to a repository",
- "operationId": "repoCreateKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/DeployKey"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository's key by id",
- "operationId": "repoGetKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/DeployKey"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a key from a repository",
- "operationId": "repoDeleteKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get all of a repository's labels",
- "operationId": "issueListLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a label",
- "operationId": "issueCreateLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateLabelOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Label"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a single label",
- "operationId": "issueGetLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a label",
- "operationId": "issueDeleteLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Update a label",
- "operationId": "issueEditLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditLabelOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get all of a repository's opened milestones",
- "operationId": "issueGetMilestonesList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
- "name": "state",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MilestoneList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a milestone",
- "operationId": "issueCreateMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateMilestoneOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Milestone"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a milestone",
- "operationId": "issueGetMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the milestone",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Milestone"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a milestone",
- "operationId": "issueDeleteMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the milestone to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Update a milestone",
- "operationId": "issueEditMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the milestone",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditMilestoneOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Milestone"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/mirror-sync": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Sync a mirrored repository",
- "operationId": "repoMirrorSync",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to sync",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to sync",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's pull requests",
- "operationId": "repoListPullRequests",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "Page number",
- "name": "page",
- "in": "query"
- },
- {
- "enum": [
- "closed",
- "open",
- "all"
- ],
- "type": "string",
- "description": "State of pull request: open or closed (optional)",
- "name": "state",
- "in": "query"
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "mostcomment",
- "leastcomment",
- "priority"
- ],
- "type": "string",
- "description": "Type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the milestone",
- "name": "milestone",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "collectionFormat": "multi",
- "description": "Label IDs",
- "name": "labels",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequestList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a pull request",
- "operationId": "repoCreatePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreatePullRequestOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullRequest"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a pull request",
- "operationId": "repoGetPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequest"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a pull request",
- "operationId": "repoEditPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to edit",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditPullRequestOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullRequest"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/merge": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a pull request has been merged",
- "operationId": "repoPullRequestIsMerged",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "pull request has been merged"
- },
- "404": {
- "description": "pull request has not been merged"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Merge a pull request",
- "operationId": "repoMergePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to merge",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MergePullRequestOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "405": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/raw/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a file from a repository",
- "operationId": "repoGetRawFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of the file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's releases",
- "operationId": "repoListReleases",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page wants to load",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "items count every page wants to load",
- "name": "per_page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReleaseList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a release",
- "operationId": "repoCreateRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateReleaseOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Release"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release",
- "operationId": "repoGetRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a release",
- "operationId": "repoDeleteRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a release",
- "operationId": "repoEditRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReleaseOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}/assets": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List release's attachments",
- "operationId": "repoListReleaseAttachments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AttachmentList"
- }
- }
- },
- "post": {
- "consumes": [
- "multipart/form-data"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a release attachment",
- "operationId": "repoCreateReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the attachment",
- "name": "name",
- "in": "query"
- },
- {
- "type": "file",
- "description": "attachment to upload",
- "name": "attachment",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release attachment",
- "operationId": "repoGetReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to get",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Attachment"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a release attachment",
- "operationId": "repoDeleteReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to delete",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a release attachment",
- "operationId": "repoEditReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to edit",
- "name": "attachment_id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditAttachmentOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/stargazers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's stargazers",
- "operationId": "repoListStargazers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/statuses/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's statuses",
- "operationId": "repoListStatuses",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results",
- "name": "page",
- "in": "query"
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "leastindex",
- "highestindex"
- ],
- "type": "string",
- "description": "type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "enum": [
- "pending",
- "success",
- "error",
- "failure",
- "warning"
- ],
- "type": "string",
- "description": "type of state",
- "name": "state",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/StatusList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a commit status",
- "operationId": "repoCreateStatus",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateStatusOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/StatusList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/subscribers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's watchers",
- "operationId": "repoListSubscribers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/subscription": {
- "get": {
- "tags": [
- "repository"
- ],
- "summary": "Check if the current user is watching a repo",
- "operationId": "userCurrentCheckSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- }
- }
- },
- "put": {
- "tags": [
- "repository"
- ],
- "summary": "Watch a repo",
- "operationId": "userCurrentPutSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Unwatch a repo",
- "operationId": "userCurrentDeleteSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/tags": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's tags",
- "operationId": "repoListTags",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TagList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's tracked times",
- "operationId": "repoTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/times/{user}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List a user's tracked times in a repo",
- "operationId": "userTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of user",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- }
- },
- "/repositories/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository by id",
- "operationId": "repoGetByID",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the repo to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- }
- }
- }
- },
- "/teams/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a team",
- "operationId": "orgGetTeam",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- }
- }
- },
- "delete": {
- "tags": [
- "organization"
- ],
- "summary": "Delete a team",
- "operationId": "orgDeleteTeam",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "team deleted"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Edit a team",
- "operationId": "orgEditTeam",
- "parameters": [
- {
- "type": "integer",
- "description": "id of the team to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditTeamOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- }
- }
- }
- },
- "/teams/{id}/members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's members",
- "operationId": "orgListTeamMembers",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/teams/{id}/members/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a particular member of team",
- "operationId": "orgListTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the member to list",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Add a team member",
- "operationId": "orgAddTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user to add",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a team member",
- "operationId": "orgRemoveTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user to remove",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/teams/{id}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's repos",
- "operationId": "orgListTeamRepos",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/teams/{id}/repos/{org}/{repo}": {
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Add a repository to a team",
- "operationId": "orgAddTeamRepository",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to add",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to add",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "description": "This does not delete the repository, it only removes the repository from the team.",
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a repository from a team",
- "operationId": "orgRemoveTeamRepository",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to remove",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to remove",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/topics/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "search topics via keyword",
- "operationId": "topicSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keywords to search",
- "name": "q",
- "in": "query",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- }
- }
- }
- },
- "/user": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get the authenticated user",
- "operationId": "userGetCurrent",
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- }
- }
- }
- },
- "/user/emails": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's email addresses",
- "operationId": "userListEmails",
- "responses": {
- "200": {
- "$ref": "#/responses/EmailList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Add email addresses",
- "operationId": "userAddEmail",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateEmailOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/EmailList"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete email addresses",
- "operationId": "userDeleteEmail",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/DeleteEmailOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/followers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's followers",
- "operationId": "userCurrentListFollowers",
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/following": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the users that the authenticated user is following",
- "operationId": "userCurrentListFollowing",
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/following/{username}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check whether a user is followed by the authenticated user",
- "operationId": "userCurrentCheckFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of followed user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Follow a user",
- "operationId": "userCurrentPutFollow",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to follow",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unfollow a user",
- "operationId": "userCurrentDeleteFollow",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to unfollow",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/gpg_keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's GPG keys",
- "operationId": "userCurrentListGPGKeys",
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a GPG key",
- "operationId": "userCurrentPostGPGKey",
- "parameters": [
- {
- "name": "Form",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateGPGKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/GPGKey"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/gpg_keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a GPG key",
- "operationId": "userCurrentGetGPGKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Remove a GPG key",
- "operationId": "userCurrentDeleteGPGKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/user/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's public keys",
- "operationId": "userCurrentListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a public key",
- "operationId": "userCurrentPostKey",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PublicKey"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a public key",
- "operationId": "userCurrentGetKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete a public key",
- "operationId": "userCurrentDeleteKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List the current user's organizations",
- "operationId": "orgListCurrentUserOrgs",
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- }
- }
- }
- },
- "/user/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repos that the authenticated user owns or has access to",
- "operationId": "userCurrentListRepos",
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository",
- "user"
- ],
- "summary": "Create a repository",
- "operationId": "createCurrentUserRepo",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "409": {
- "description": "The repository with the same name already exists."
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/starred": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "The repos that the authenticated user has starred",
- "operationId": "userCurrentListStarred",
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/user/starred/{owner}/{repo}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Whether the authenticated is starring the repo",
- "operationId": "userCurrentCheckStarring",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Star the given repo",
- "operationId": "userCurrentPutStar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to star",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to star",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unstar the given repo",
- "operationId": "userCurrentDeleteStar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to unstar",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to unstar",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/subscriptions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List repositories watched by the authenticated user",
- "operationId": "userCurrentListSubscriptions",
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/user/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List all the teams a user belongs to",
- "operationId": "userListTeams",
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- }
- }
- }
- },
- "/user/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the current user's tracked times",
- "operationId": "userCurrentTrackedTimes",
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- }
- },
- "/users/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Search for users",
- "operationId": "userSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the user to search for",
- "name": "uid",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "maximum number of users to return",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "SearchResults of a successful search",
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "/users/{follower}/following/{followee}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check if one user is following another user",
- "operationId": "userCheckFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of following user",
- "name": "follower",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of followed user",
- "name": "followee",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a user",
- "operationId": "userGet",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to get",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/followers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's followers",
- "operationId": "userListFollowers",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/users/{username}/following": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the users that the given user is following",
- "operationId": "userListFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/users/{username}/gpg_keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's GPG keys",
- "operationId": "userListGPGKeys",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKeyList"
- }
- }
- }
- },
- "/users/{username}/heatmap": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a user's heatmap",
- "operationId": "userGetHeatmapData",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to get",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserHeatmapData"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's public keys",
- "operationId": "userListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKeyList"
- }
- }
- }
- },
- "/users/{username}/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a user's organizations",
- "operationId": "orgListUserOrgs",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- }
- }
- }
- },
- "/users/{username}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repos owned by the given user",
- "operationId": "userListRepos",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/users/{username}/starred": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "The repos that the given user has starred",
- "operationId": "userListStarred",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/users/{username}/subscriptions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repositories watched by a user",
- "operationId": "userListSubscriptions",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/users/{username}/tokens": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's access tokens",
- "operationId": "userGetTokens",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AccessTokenList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create an access token",
- "operationId": "userCreateToken",
- "parameters": [
- {
- "type": "string",
- "x-go-name": "Name",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "accessToken",
- "in": "body",
- "schema": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "type": "string"
- }
- }
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AccessToken"
- }
- }
- }
- },
- "/users/{username}/tokens/{token}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "delete an access token",
- "operationId": "userDeleteAccessToken",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "token to be deleted",
- "name": "token",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/version": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns the version of the Gitea application",
- "operationId": "getVersion",
- "responses": {
- "200": {
- "$ref": "#/responses/ServerVersion"
- }
- }
- }
- }
- },
- "definitions": {
- "AddCollaboratorOption": {
- "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "x-go-name": "Permission"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AddTimeOption": {
- "description": "AddTimeOption options for adding time to an issue",
- "type": "object",
- "required": [
- "time"
- ],
- "properties": {
- "time": {
- "description": "time in seconds",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Time"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AnnotatedTag": {
- "description": "AnnotatedTag represents an annotated tag",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "object": {
- "$ref": "#/definitions/AnnotatedTagObject"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "tag": {
- "type": "string",
- "x-go-name": "Tag"
- },
- "tagger": {
- "$ref": "#/definitions/CommitUser"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AnnotatedTagObject": {
- "description": "AnnotatedTagObject contains meta information of the tag object",
- "type": "object",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Attachment": {
- "description": "Attachment a generic attachment",
- "type": "object",
- "properties": {
- "browser_download_url": {
- "type": "string",
- "x-go-name": "DownloadURL"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "download_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "DownloadCount"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "uuid": {
- "type": "string",
- "x-go-name": "UUID"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Branch": {
- "description": "Branch represents a repository branch",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/PayloadCommit"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Comment": {
- "description": "Comment represents a comment on a commit or issue",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue_url": {
- "type": "string",
- "x-go-name": "IssueURL"
- },
- "original_author": {
- "type": "string",
- "x-go-name": "OriginalAuthor"
- },
- "original_author_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OriginalAuthorID"
- },
- "pull_request_url": {
- "type": "string",
- "x-go-name": "PRURL"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Commit": {
- "type": "object",
- "title": "Commit contains information generated from a Git commit.",
- "properties": {
- "author": {
- "$ref": "#/definitions/User"
- },
- "commit": {
- "$ref": "#/definitions/RepoCommit"
- },
- "committer": {
- "$ref": "#/definitions/User"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "parents": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitMeta"
- },
- "x-go-name": "Parents"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitMeta": {
- "type": "object",
- "title": "CommitMeta contains meta information of a commit in terms of API.",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitUser": {
- "type": "object",
- "title": "CommitUser contains information of a user in the context of a commit.",
- "properties": {
- "date": {
- "type": "string",
- "x-go-name": "Date"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ContentsResponse": {
- "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
- "type": "object",
- "properties": {
- "_links": {
- "$ref": "#/definitions/FileLinksResponse"
- },
- "content": {
- "description": "`content` is populated when `type` is `file`, otherwise null",
- "type": "string",
- "x-go-name": "Content"
- },
- "download_url": {
- "type": "string",
- "x-go-name": "DownloadURL"
- },
- "encoding": {
- "description": "`encoding` is populated when `type` is `file`, otherwise null",
- "type": "string",
- "x-go-name": "Encoding"
- },
- "git_url": {
- "type": "string",
- "x-go-name": "GitURL"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "submodule_git_url": {
- "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
- "type": "string",
- "x-go-name": "SubmoduleGitURL"
- },
- "target": {
- "description": "`target` is populated when `type` is `symlink`, otherwise null",
- "type": "string",
- "x-go-name": "Target"
- },
- "type": {
- "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateEmailOption": {
- "description": "CreateEmailOption options when creating email addresses",
- "type": "object",
- "properties": {
- "emails": {
- "description": "email addresses to add",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Emails"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateFileOptions": {
- "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)",
- "type": "object",
- "required": [
- "content"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "content": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "Content"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateForkOption": {
- "description": "CreateForkOption options for creating a fork",
- "type": "object",
- "properties": {
- "organization": {
- "description": "organization name, if forking into an organization",
- "type": "string",
- "x-go-name": "Organization"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateGPGKeyOption": {
- "description": "CreateGPGKeyOption options create user GPG key",
- "type": "object",
- "required": [
- "armored_public_key"
- ],
- "properties": {
- "armored_public_key": {
- "description": "An armored GPG key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "ArmoredKey"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateHookOption": {
- "description": "CreateHookOption options when create a hook",
- "type": "object",
- "required": [
- "type",
- "config"
- ],
- "properties": {
- "active": {
- "type": "boolean",
- "default": false,
- "x-go-name": "Active"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- },
- "type": {
- "type": "string",
- "enum": [
- "gitea",
- "gogs",
- "slack",
- "discord"
- ],
- "x-go-name": "Type"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateIssueCommentOption": {
- "description": "CreateIssueCommentOption options for creating a comment on an issue",
- "type": "object",
- "required": [
- "body"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateIssueOption": {
- "description": "CreateIssueOption options to create one issue",
- "type": "object",
- "required": [
- "title"
- ],
- "properties": {
- "assignee": {
- "description": "username of assignee",
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed": {
- "type": "boolean",
- "x-go-name": "Closed"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "labels": {
- "description": "list of label ids",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "description": "milestone id",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateKeyOption": {
- "description": "CreateKeyOption options when creating a key",
- "type": "object",
- "required": [
- "title",
- "key"
- ],
- "properties": {
- "key": {
- "description": "An armored SSH key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Key"
- },
- "read_only": {
- "description": "Describe if the key has only read access or read/write",
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "title": {
- "description": "Title of the key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateLabelOption": {
- "description": "CreateLabelOption options for creating a label",
- "type": "object",
- "required": [
- "name",
- "color"
- ],
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "#00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateMilestoneOption": {
- "description": "CreateMilestoneOption options for creating a milestone",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateOrgOption": {
- "description": "CreateOrgOption options for creating an organization",
- "type": "object",
- "required": [
- "username"
- ],
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- },
- "visibility": {
- "description": "possible values are `public` (default), `limited` or `private`",
- "type": "string",
- "enum": [
- "public",
- "limited",
- "private"
- ],
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreatePullRequestOption": {
- "description": "CreatePullRequestOption options when creating a pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "type": "string",
- "x-go-name": "Base"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "head": {
- "type": "string",
- "x-go-name": "Head"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateReleaseOption": {
- "description": "CreateReleaseOption options when creating a release",
- "type": "object",
- "required": [
- "tag_name"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateRepoOption": {
- "description": "CreateRepoOption options when creating repository",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "auto_init": {
- "description": "Whether the repository should be auto-intialized?",
- "type": "boolean",
- "x-go-name": "AutoInit"
- },
- "description": {
- "description": "Description of the repository to create",
- "type": "string",
- "x-go-name": "Description"
- },
- "gitignores": {
- "description": "Gitignores to use",
- "type": "string",
- "x-go-name": "Gitignores"
- },
- "license": {
- "description": "License to use",
- "type": "string",
- "x-go-name": "License"
- },
- "name": {
- "description": "Name of the repository to create",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "private": {
- "description": "Whether the repository is private",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "readme": {
- "description": "Readme of the repository to create",
- "type": "string",
- "x-go-name": "Readme"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateStatusOption": {
- "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
- "type": "object",
- "properties": {
- "context": {
- "type": "string",
- "x-go-name": "Context"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "state": {
- "$ref": "#/definitions/StatusState"
- },
- "target_url": {
- "type": "string",
- "x-go-name": "TargetURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateTeamOption": {
- "description": "CreateTeamOption options for creating a team",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "enum": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.ext_wiki"
- ],
- "items": {
- "type": "string"
- },
- "x-go-name": "Units"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateUserOption": {
- "description": "CreateUserOption create user options",
- "type": "object",
- "required": [
- "username",
- "email",
- "password"
- ],
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "login_name": {
- "type": "string",
- "x-go-name": "LoginName"
- },
- "must_change_password": {
- "type": "boolean",
- "x-go-name": "MustChangePassword"
- },
- "password": {
- "type": "string",
- "x-go-name": "Password"
- },
- "send_notify": {
- "type": "boolean",
- "x-go-name": "SendNotify"
- },
- "source_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "SourceID"
- },
- "username": {
- "type": "string",
- "x-go-name": "Username"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeleteEmailOption": {
- "description": "DeleteEmailOption options when deleting email addresses",
- "type": "object",
- "properties": {
- "emails": {
- "description": "email addresses to delete",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Emails"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeleteFileOptions": {
- "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)",
- "type": "object",
- "required": [
- "sha"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists",
- "type": "string",
- "x-go-name": "SHA"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeployKey": {
- "description": "DeployKey a deploy key",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "fingerprint": {
- "type": "string",
- "x-go-name": "Fingerprint"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "key_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "KeyID"
- },
- "read_only": {
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditAttachmentOptions": {
- "description": "EditAttachmentOptions options for editing attachments",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditDeadlineOption": {
- "description": "EditDeadlineOption options for creating a deadline",
- "type": "object",
- "required": [
- "due_date"
- ],
- "properties": {
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditGitHookOption": {
- "description": "EditGitHookOption options when modifying one Git hook",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditHookOption": {
- "description": "EditHookOption options when modify one hook",
- "type": "object",
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditIssueCommentOption": {
- "description": "EditIssueCommentOption options for editing a comment",
- "type": "object",
- "required": [
- "body"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditIssueOption": {
- "description": "EditIssueOption options for editing an issue",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditLabelOption": {
- "description": "EditLabelOption options for editing a label",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditMilestoneOption": {
- "description": "EditMilestoneOption options for editing a milestone",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditOrgOption": {
- "description": "EditOrgOption options for editing an organization",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "visibility": {
- "description": "possible values are `public`, `limited` or `private`",
- "type": "string",
- "enum": [
- "public",
- "limited",
- "private"
- ],
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditPullRequestOption": {
- "description": "EditPullRequestOption options when modify pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditReleaseOption": {
- "description": "EditReleaseOption options when editing a release",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditRepoOption": {
- "description": "EditRepoOption options when editing a repository's properties",
- "type": "object",
- "properties": {
- "allow_merge_commits": {
- "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`.",
- "type": "boolean",
- "x-go-name": "AllowMerge"
- },
- "allow_rebase": {
- "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "AllowRebase"
- },
- "allow_rebase_explicit": {
- "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`.",
- "type": "boolean",
- "x-go-name": "AllowRebaseMerge"
- },
- "allow_squash_merge": {
- "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "AllowSquash"
- },
- "archived": {
- "description": "set to `true` to archive this repository.",
- "type": "boolean",
- "x-go-name": "Archived"
- },
- "default_branch": {
- "description": "sets the default branch for this repository.",
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "description": "a short description of the repository.",
- "type": "string",
- "x-go-name": "Description"
- },
- "has_issues": {
- "description": "either `true` to enable issues for this repository or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasIssues"
- },
- "has_pull_requests": {
- "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
- "type": "boolean",
- "x-go-name": "HasPullRequests"
- },
- "has_wiki": {
- "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
- "type": "boolean",
- "x-go-name": "HasWiki"
- },
- "ignore_whitespace_conflicts": {
- "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "IgnoreWhitespaceConflicts"
- },
- "name": {
- "description": "name of the repository",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "private": {
- "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.",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "website": {
- "description": "a URL with more information about the repository.",
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditTeamOption": {
- "description": "EditTeamOption options for editing a team",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "enum": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.ext_wiki"
- ],
- "items": {
- "type": "string"
- },
- "x-go-name": "Units"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditUserOption": {
- "description": "EditUserOption edit user options",
- "type": "object",
- "required": [
- "email"
- ],
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "admin": {
- "type": "boolean",
- "x-go-name": "Admin"
- },
- "allow_create_organization": {
- "type": "boolean",
- "x-go-name": "AllowCreateOrganization"
- },
- "allow_git_hook": {
- "type": "boolean",
- "x-go-name": "AllowGitHook"
- },
- "allow_import_local": {
- "type": "boolean",
- "x-go-name": "AllowImportLocal"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "login_name": {
- "type": "string",
- "x-go-name": "LoginName"
- },
- "max_repo_creation": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "MaxRepoCreation"
- },
- "must_change_password": {
- "type": "boolean",
- "x-go-name": "MustChangePassword"
- },
- "password": {
- "type": "string",
- "x-go-name": "Password"
- },
- "prohibit_login": {
- "type": "boolean",
- "x-go-name": "ProhibitLogin"
- },
- "source_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "SourceID"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Email": {
- "description": "Email an email address belonging to a user",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "primary": {
- "type": "boolean",
- "x-go-name": "Primary"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileCommitResponse": {
- "type": "object",
- "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "committer": {
- "$ref": "#/definitions/CommitUser"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "parents": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitMeta"
- },
- "x-go-name": "Parents"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "tree": {
- "$ref": "#/definitions/CommitMeta"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileDeleteResponse": {
- "description": "FileDeleteResponse contains information about a repo's file that was deleted",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "content": {
- "type": "object",
- "x-go-name": "Content"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileLinksResponse": {
- "description": "FileLinksResponse contains the links for a repo's file",
- "type": "object",
- "properties": {
- "git": {
- "type": "string",
- "x-go-name": "GitURL"
- },
- "html": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "self": {
- "type": "string",
- "x-go-name": "Self"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileResponse": {
- "description": "FileResponse contains information about a repo's file",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "content": {
- "$ref": "#/definitions/ContentsResponse"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GPGKey": {
- "description": "GPGKey a user GPG key to sign commit and tag in repository",
- "type": "object",
- "properties": {
- "can_certify": {
- "type": "boolean",
- "x-go-name": "CanCertify"
- },
- "can_encrypt_comms": {
- "type": "boolean",
- "x-go-name": "CanEncryptComms"
- },
- "can_encrypt_storage": {
- "type": "boolean",
- "x-go-name": "CanEncryptStorage"
- },
- "can_sign": {
- "type": "boolean",
- "x-go-name": "CanSign"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKeyEmail"
- },
- "x-go-name": "Emails"
- },
- "expires_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Expires"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key_id": {
- "type": "string",
- "x-go-name": "KeyID"
- },
- "primary_key_id": {
- "type": "string",
- "x-go-name": "PrimaryKeyID"
- },
- "public_key": {
- "type": "string",
- "x-go-name": "PublicKey"
- },
- "subkeys": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKey"
- },
- "x-go-name": "SubsKey"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GPGKeyEmail": {
- "description": "GPGKeyEmail an email attached to a GPGKey",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "x-go-name": "Email"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitBlobResponse": {
- "description": "GitBlobResponse represents a git blob",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "encoding": {
- "type": "string",
- "x-go-name": "Encoding"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitEntry": {
- "description": "GitEntry represents a git tree",
- "type": "object",
- "properties": {
- "mode": {
- "type": "string",
- "x-go-name": "Mode"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitHook": {
- "description": "GitHook represents a Git repository hook",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "is_active": {
- "type": "boolean",
- "x-go-name": "IsActive"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitObject": {
- "type": "object",
- "title": "GitObject represents a Git object.",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitTreeResponse": {
- "description": "GitTreeResponse returns a git tree",
- "type": "object",
- "properties": {
- "page": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Page"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "total_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "TotalCount"
- },
- "tree": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GitEntry"
- },
- "x-go-name": "Entries"
- },
- "truncated": {
- "type": "boolean",
- "x-go-name": "Truncated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Hook": {
- "description": "Hook a hook is a web hook when one repository changed",
- "type": "object",
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Identity": {
- "description": "Identity for a person's identity like an author or committer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Issue": {
- "description": "Issue represents an issue in a repository",
- "type": "object",
- "properties": {
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignees": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "comments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "number": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "original_author": {
- "type": "string",
- "x-go-name": "OriginalAuthor"
- },
- "original_author_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OriginalAuthorID"
- },
- "pull_request": {
- "$ref": "#/definitions/PullRequestMeta"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueDeadline": {
- "description": "IssueDeadline represents an issue deadline",
- "type": "object",
- "properties": {
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueLabelsOption": {
- "description": "IssueLabelsOption a collection of labels",
- "type": "object",
- "properties": {
- "labels": {
- "description": "list of label IDs",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Label": {
- "description": "Label a label to an issue or a pr",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MarkdownOption": {
- "description": "MarkdownOption markdown options",
- "type": "object",
- "properties": {
- "Context": {
- "description": "Context to render\n\nin: body",
- "type": "string"
- },
- "Mode": {
- "description": "Mode to render\n\nin: body",
- "type": "string"
- },
- "Text": {
- "description": "Text markdown to render\n\nin: body",
- "type": "string"
- },
- "Wiki": {
- "description": "Is it a wiki page ?\n\nin: body",
- "type": "boolean"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MergePullRequestOption": {
- "description": "MergePullRequestForm form for merging Pull Request",
- "type": "object",
- "required": [
- "Do"
- ],
- "properties": {
- "Do": {
- "type": "string",
- "enum": [
- "merge",
- "rebase",
- "rebase-merge",
- "squash"
- ]
- },
- "MergeMessageField": {
- "type": "string"
- },
- "MergeTitleField": {
- "type": "string"
- }
- },
- "x-go-name": "MergePullRequestForm",
- "x-go-package": "code.gitea.io/gitea/modules/auth"
- },
- "MigrateRepoForm": {
- "description": "MigrateRepoForm form for migrating repository",
- "type": "object",
- "required": [
- "clone_addr",
- "uid",
- "repo_name"
- ],
- "properties": {
- "auth_password": {
- "type": "string",
- "x-go-name": "AuthPassword"
- },
- "auth_username": {
- "type": "string",
- "x-go-name": "AuthUsername"
- },
- "clone_addr": {
- "type": "string",
- "x-go-name": "CloneAddr"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "issues": {
- "type": "boolean",
- "x-go-name": "Issues"
- },
- "labels": {
- "type": "boolean",
- "x-go-name": "Labels"
- },
- "milestones": {
- "type": "boolean",
- "x-go-name": "Milestones"
- },
- "mirror": {
- "type": "boolean",
- "x-go-name": "Mirror"
- },
- "private": {
- "type": "boolean",
- "x-go-name": "Private"
- },
- "pull_requests": {
- "type": "boolean",
- "x-go-name": "PullRequests"
- },
- "releases": {
- "type": "boolean",
- "x-go-name": "Releases"
- },
- "repo_name": {
- "type": "string",
- "x-go-name": "RepoName"
- },
- "uid": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "UID"
- },
- "wiki": {
- "type": "boolean",
- "x-go-name": "Wiki"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/auth"
- },
- "Milestone": {
- "description": "Milestone milestone is a collection of issues on one repository",
- "type": "object",
- "properties": {
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "closed_issues": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ClosedIssues"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "open_issues": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenIssues"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Organization": {
- "description": "Organization represents an organization",
- "type": "object",
- "properties": {
- "avatar_url": {
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- },
- "visibility": {
- "type": "string",
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PRBranchInfo": {
- "description": "PRBranchInfo information about a branch",
- "type": "object",
- "properties": {
- "label": {
- "type": "string",
- "x-go-name": "Name"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "repo": {
- "$ref": "#/definitions/Repository"
- },
- "repo_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoID"
- },
- "sha": {
- "type": "string",
- "x-go-name": "Sha"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadCommit": {
- "description": "PayloadCommit represents a commit",
- "type": "object",
- "properties": {
- "added": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Added"
- },
- "author": {
- "$ref": "#/definitions/PayloadUser"
- },
- "committer": {
- "$ref": "#/definitions/PayloadUser"
- },
- "id": {
- "description": "sha1 hash of the commit",
- "type": "string",
- "x-go-name": "ID"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "modified": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Modified"
- },
- "removed": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Removed"
- },
- "timestamp": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Timestamp"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadCommitVerification": {
- "description": "PayloadCommitVerification represents the GPG verification of a commit",
- "type": "object",
- "properties": {
- "payload": {
- "type": "string",
- "x-go-name": "Payload"
- },
- "reason": {
- "type": "string",
- "x-go-name": "Reason"
- },
- "signature": {
- "type": "string",
- "x-go-name": "Signature"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadUser": {
- "description": "PayloadUser represents the author or committer of a commit",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "description": "Full name of the commit author",
- "type": "string",
- "x-go-name": "Name"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Permission": {
- "description": "Permission represents a set of permissions",
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean",
- "x-go-name": "Admin"
- },
- "pull": {
- "type": "boolean",
- "x-go-name": "Pull"
- },
- "push": {
- "type": "boolean",
- "x-go-name": "Push"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PublicKey": {
- "description": "PublicKey publickey is a user key to push code to repository",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "fingerprint": {
- "type": "string",
- "x-go-name": "Fingerprint"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "key_type": {
- "type": "string",
- "x-go-name": "KeyType"
- },
- "read_only": {
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullRequest": {
- "description": "PullRequest represents a pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignees": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "$ref": "#/definitions/PRBranchInfo"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "comments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "diff_url": {
- "type": "string",
- "x-go-name": "DiffURL"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "head": {
- "$ref": "#/definitions/PRBranchInfo"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- },
- "x-go-name": "Labels"
- },
- "merge_base": {
- "type": "string",
- "x-go-name": "MergeBase"
- },
- "merge_commit_sha": {
- "type": "string",
- "x-go-name": "MergedCommitID"
- },
- "mergeable": {
- "type": "boolean",
- "x-go-name": "Mergeable"
- },
- "merged": {
- "type": "boolean",
- "x-go-name": "HasMerged"
- },
- "merged_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Merged"
- },
- "merged_by": {
- "$ref": "#/definitions/User"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "number": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "patch_url": {
- "type": "string",
- "x-go-name": "PatchURL"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullRequestMeta": {
- "description": "PullRequestMeta PR info if an issue is a PR",
- "type": "object",
- "properties": {
- "merged": {
- "type": "boolean",
- "x-go-name": "HasMerged"
- },
- "merged_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Merged"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Reference": {
- "type": "object",
- "title": "Reference represents a Git reference.",
- "properties": {
- "object": {
- "$ref": "#/definitions/GitObject"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Release": {
- "description": "Release represents a repository release",
- "type": "object",
- "properties": {
- "assets": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- },
- "x-go-name": "Attachments"
- },
- "author": {
- "$ref": "#/definitions/User"
- },
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "published_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "PublishedAt"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "tarball_url": {
- "type": "string",
- "x-go-name": "TarURL"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "zipball_url": {
- "type": "string",
- "x-go-name": "ZipURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoCommit": {
- "type": "object",
- "title": "RepoCommit contains information of a commit in the context of a repository.",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "committer": {
- "$ref": "#/definitions/CommitUser"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "tree": {
- "$ref": "#/definitions/CommitMeta"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Repository": {
- "description": "Repository represents a repository",
- "type": "object",
- "properties": {
- "allow_merge_commits": {
- "type": "boolean",
- "x-go-name": "AllowMerge"
- },
- "allow_rebase": {
- "type": "boolean",
- "x-go-name": "AllowRebase"
- },
- "allow_rebase_explicit": {
- "type": "boolean",
- "x-go-name": "AllowRebaseMerge"
- },
- "allow_squash_merge": {
- "type": "boolean",
- "x-go-name": "AllowSquash"
- },
- "archived": {
- "type": "boolean",
- "x-go-name": "Archived"
- },
- "avatar_url": {
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "clone_url": {
- "type": "string",
- "x-go-name": "CloneURL"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "default_branch": {
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "empty": {
- "type": "boolean",
- "x-go-name": "Empty"
- },
- "fork": {
- "type": "boolean",
- "x-go-name": "Fork"
- },
- "forks_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Forks"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "has_issues": {
- "type": "boolean",
- "x-go-name": "HasIssues"
- },
- "has_pull_requests": {
- "type": "boolean",
- "x-go-name": "HasPullRequests"
- },
- "has_wiki": {
- "type": "boolean",
- "x-go-name": "HasWiki"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "ignore_whitespace_conflicts": {
- "type": "boolean",
- "x-go-name": "IgnoreWhitespaceConflicts"
- },
- "mirror": {
- "type": "boolean",
- "x-go-name": "Mirror"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "open_issues_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenIssues"
- },
- "original_url": {
- "type": "string",
- "x-go-name": "OriginalURL"
- },
- "owner": {
- "$ref": "#/definitions/User"
- },
- "parent": {
- "$ref": "#/definitions/Repository"
- },
- "permissions": {
- "$ref": "#/definitions/Permission"
- },
- "private": {
- "type": "boolean",
- "x-go-name": "Private"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "ssh_url": {
- "type": "string",
- "x-go-name": "SSHURL"
- },
- "stars_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Stars"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "watchers_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Watchers"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "SearchResults": {
- "description": "SearchResults results of a successful search",
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Repository"
- },
- "x-go-name": "Data"
- },
- "ok": {
- "type": "boolean",
- "x-go-name": "OK"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ServerVersion": {
- "description": "ServerVersion wraps the version of the server",
- "type": "object",
- "properties": {
- "version": {
- "type": "string",
- "x-go-name": "Version"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StateType": {
- "description": "StateType issue state type",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Status": {
- "description": "Status holds a single Status of a single Commit",
- "type": "object",
- "properties": {
- "context": {
- "type": "string",
- "x-go-name": "Context"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "creator": {
- "$ref": "#/definitions/User"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "status": {
- "$ref": "#/definitions/StatusState"
- },
- "target_url": {
- "type": "string",
- "x-go-name": "TargetURL"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StatusState": {
- "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Tag": {
- "description": "Tag represents a repository tag",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/CommitMeta"
- },
- "id": {
- "type": "string",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "tarball_url": {
- "type": "string",
- "x-go-name": "TarballURL"
- },
- "zipball_url": {
- "type": "string",
- "x-go-name": "ZipballURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Team": {
- "description": "Team represents a team in an organization",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "organization": {
- "$ref": "#/definitions/Organization"
- },
- "permission": {
- "type": "string",
- "enum": [
- "none",
- "read",
- "write",
- "admin",
- "owner"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "enum": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.ext_wiki"
- ],
- "items": {
- "type": "string"
- },
- "x-go-name": "Units"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TimeStamp": {
- "description": "TimeStamp defines a timestamp",
- "type": "integer",
- "format": "int64",
- "x-go-package": "code.gitea.io/gitea/modules/timeutil"
- },
- "TrackedTime": {
- "description": "TrackedTime worked time for an issue / pr",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "IssueID"
- },
- "time": {
- "description": "Time in seconds",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Time"
- },
- "user_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "UserID"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UpdateFileOptions": {
- "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)",
- "type": "object",
- "required": [
- "sha",
- "content"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "content": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "Content"
- },
- "from_path": {
- "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
- "type": "string",
- "x-go-name": "FromPath"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists",
- "type": "string",
- "x-go-name": "SHA"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "User": {
- "description": "User represents a user",
- "type": "object",
- "properties": {
- "avatar_url": {
- "description": "URL to the user's avatar",
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "description": "the user's full name",
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "description": "the user's id",
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_admin": {
- "description": "Is the user an administrator",
- "type": "boolean",
- "x-go-name": "IsAdmin"
- },
- "language": {
- "description": "User locale",
- "type": "string",
- "x-go-name": "Language"
- },
- "last_login": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "LastLogin"
- },
- "login": {
- "description": "the user's username",
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UserHeatmapData": {
- "description": "UserHeatmapData represents the data needed to create a heatmap",
- "type": "object",
- "properties": {
- "contributions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Contributions"
- },
- "timestamp": {
- "$ref": "#/definitions/TimeStamp"
- }
- },
- "x-go-package": "code.gitea.io/gitea/models"
- },
- "WatchInfo": {
- "description": "WatchInfo represents an API watch status of one repository",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "ignored": {
- "type": "boolean",
- "x-go-name": "Ignored"
- },
- "reason": {
- "type": "object",
- "x-go-name": "Reason"
- },
- "repository_url": {
- "type": "string",
- "x-go-name": "RepositoryURL"
- },
- "subscribed": {
- "type": "boolean",
- "x-go-name": "Subscribed"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- }
- },
- "responses": {
- "AccessToken": {
- "description": "AccessToken represents an API access token.",
- "headers": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "sha1": {
- "type": "string"
- },
- "token_last_eight": {
- "type": "string"
- }
- }
- },
- "AccessTokenList": {
- "description": "AccessTokenList represents a list of API access token."
- },
- "AnnotatedTag": {
- "description": "AnnotatedTag",
- "schema": {
- "$ref": "#/definitions/AnnotatedTag"
- }
- },
- "Attachment": {
- "description": "Attachment",
- "schema": {
- "$ref": "#/definitions/Attachment"
- }
- },
- "AttachmentList": {
- "description": "AttachmentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- }
- }
- },
- "Branch": {
- "description": "Branch",
- "schema": {
- "$ref": "#/definitions/Branch"
- }
- },
- "BranchList": {
- "description": "BranchList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Branch"
- }
- }
- },
- "Comment": {
- "description": "Comment",
- "schema": {
- "$ref": "#/definitions/Comment"
- }
- },
- "CommentList": {
- "description": "CommentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Comment"
- }
- }
- },
- "Commit": {
- "description": "Commit",
- "schema": {
- "$ref": "#/definitions/Commit"
- }
- },
- "ContentsListResponse": {
- "description": "ContentsListResponse",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ContentsResponse"
- }
- }
- },
- "ContentsResponse": {
- "description": "ContentsResponse",
- "schema": {
- "$ref": "#/definitions/ContentsResponse"
- }
- },
- "DeployKey": {
- "description": "DeployKey",
- "schema": {
- "$ref": "#/definitions/DeployKey"
- }
- },
- "DeployKeyList": {
- "description": "DeployKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/DeployKey"
- }
- }
- },
- "EmailList": {
- "description": "EmailList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Email"
- }
- }
- },
- "FileDeleteResponse": {
- "description": "FileDeleteResponse",
- "schema": {
- "$ref": "#/definitions/FileDeleteResponse"
- }
- },
- "FileResponse": {
- "description": "FileResponse",
- "schema": {
- "$ref": "#/definitions/FileResponse"
- }
- },
- "GPGKey": {
- "description": "GPGKey",
- "schema": {
- "$ref": "#/definitions/GPGKey"
- }
- },
- "GPGKeyList": {
- "description": "GPGKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKey"
- }
- }
- },
- "GitBlobResponse": {
- "description": "GitBlobResponse",
- "schema": {
- "$ref": "#/definitions/GitBlobResponse"
- }
- },
- "GitHook": {
- "description": "GitHook",
- "schema": {
- "$ref": "#/definitions/GitHook"
- }
- },
- "GitHookList": {
- "description": "GitHookList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GitHook"
- }
- }
- },
- "GitTreeResponse": {
- "description": "GitTreeResponse",
- "schema": {
- "$ref": "#/definitions/GitTreeResponse"
- }
- },
- "Hook": {
- "description": "Hook",
- "schema": {
- "$ref": "#/definitions/Hook"
- }
- },
- "HookList": {
- "description": "HookList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Hook"
- }
- }
- },
- "Issue": {
- "description": "Issue",
- "schema": {
- "$ref": "#/definitions/Issue"
- }
- },
- "IssueDeadline": {
- "description": "IssueDeadline",
- "schema": {
- "$ref": "#/definitions/IssueDeadline"
- }
- },
- "IssueList": {
- "description": "IssueList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Issue"
- }
- }
- },
- "Label": {
- "description": "Label",
- "schema": {
- "$ref": "#/definitions/Label"
- }
- },
- "LabelList": {
- "description": "LabelList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- }
- }
- },
- "MarkdownRender": {
- "description": "MarkdownRender is a rendered markdown document"
- },
- "Milestone": {
- "description": "Milestone",
- "schema": {
- "$ref": "#/definitions/Milestone"
- }
- },
- "MilestoneList": {
- "description": "MilestoneList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Milestone"
- }
- }
- },
- "Organization": {
- "description": "Organization",
- "schema": {
- "$ref": "#/definitions/Organization"
- }
- },
- "OrganizationList": {
- "description": "OrganizationList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Organization"
- }
- }
- },
- "PublicKey": {
- "description": "PublicKey",
- "schema": {
- "$ref": "#/definitions/PublicKey"
- }
- },
- "PublicKeyList": {
- "description": "PublicKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PublicKey"
- }
- }
- },
- "PullRequest": {
- "description": "PullRequest",
- "schema": {
- "$ref": "#/definitions/PullRequest"
- }
- },
- "PullRequestList": {
- "description": "PullRequestList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PullRequest"
- }
- }
- },
- "Reference": {
- "description": "Reference",
- "schema": {
- "$ref": "#/definitions/Reference"
- }
- },
- "ReferenceList": {
- "description": "ReferenceList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Reference"
- }
- }
- },
- "Release": {
- "description": "Release",
- "schema": {
- "$ref": "#/definitions/Release"
- }
- },
- "ReleaseList": {
- "description": "ReleaseList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Release"
- }
- }
- },
- "Repository": {
- "description": "Repository",
- "schema": {
- "$ref": "#/definitions/Repository"
- }
- },
- "RepositoryList": {
- "description": "RepositoryList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Repository"
- }
- }
- },
- "SearchResults": {
- "description": "SearchResults",
- "schema": {
- "$ref": "#/definitions/SearchResults"
- }
- },
- "ServerVersion": {
- "description": "ServerVersion",
- "schema": {
- "$ref": "#/definitions/ServerVersion"
- }
- },
- "Status": {
- "description": "Status",
- "schema": {
- "$ref": "#/definitions/Status"
- }
- },
- "StatusList": {
- "description": "StatusList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Status"
- }
- }
- },
- "Tag": {
- "description": "Tag",
- "schema": {
- "$ref": "#/definitions/Tag"
- }
- },
- "TagList": {
- "description": "TagList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tag"
- }
- }
- },
- "Team": {
- "description": "Team",
- "schema": {
- "$ref": "#/definitions/Team"
- }
- },
- "TeamList": {
- "description": "TeamList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Team"
- }
- }
- },
- "TrackedTime": {
- "description": "TrackedTime",
- "schema": {
- "$ref": "#/definitions/TrackedTime"
- }
- },
- "TrackedTimeList": {
- "description": "TrackedTimeList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TrackedTime"
- }
- }
- },
- "User": {
- "description": "User",
- "schema": {
- "$ref": "#/definitions/User"
- }
- },
- "UserHeatmapData": {
- "description": "UserHeatmapData",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/UserHeatmapData"
- }
- }
- },
- "UserList": {
- "description": "UserList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- }
- }
- },
- "WatchInfo": {
- "description": "WatchInfo",
- "schema": {
- "$ref": "#/definitions/WatchInfo"
- }
- },
- "empty": {
- "description": "APIEmpty is an empty response"
- },
- "error": {
- "description": "APIError is error format response",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "forbidden": {
- "description": "APIForbiddenError is a forbidden error response",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "notFound": {
- "description": "APINotFound is a not found empty response"
- },
- "parameterBodies": {
- "description": "parameterBodies",
- "schema": {
- "$ref": "#/definitions/DeleteFileOptions"
- }
- },
- "redirect": {
- "description": "APIRedirect is a redirect response"
- },
- "validationError": {
- "description": "APIValidationError is error format response related to input validation",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- },
- "securityDefinitions": {
- "AccessToken": {
- "type": "apiKey",
- "name": "access_token",
- "in": "query"
- },
- "AuthorizationHeaderToken": {
- "description": "API tokens must be prepended with \"token\" followed by a space.",
- "type": "apiKey",
- "name": "Authorization",
- "in": "header"
- },
- "BasicAuth": {
- "type": "basic"
- },
- "SudoHeader": {
- "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
- "type": "apiKey",
- "name": "Sudo",
- "in": "header"
- },
- "SudoParam": {
- "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
- "type": "apiKey",
- "name": "sudo",
- "in": "query"
- },
- "Token": {
- "type": "apiKey",
- "name": "token",
- "in": "query"
- }
- },
- "security": [
- {
- "BasicAuth": []
- },
- {
- "Token": []
- },
- {
- "AccessToken": []
- },
- {
- "AuthorizationHeaderToken": []
- },
- {
- "SudoParam": []
- },
- {
- "SudoHeader": []
- }
- ]
- }
|