You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

v1_json.tmpl 242KB

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