12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446 |
- {
- "consumes": [
- "application/json",
- "text/plain"
- ],
- "produces": [
- "application/json",
- "text/html"
- ],
- "schemes": [
- "http",
- "https"
- ],
- "swagger": "2.0",
- "info": {
- "description": "This documentation describes the Gitea API.",
- "title": "Gitea API.",
- "license": {
- "name": "MIT",
- "url": "http://opensource.org/licenses/MIT"
- },
- "version": "1.1.1"
- },
- "basePath": "{{AppSubUrl}}/api/v1",
- "paths": {
- "/admin/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List all organizations",
- "operationId": "adminGetAllOrgs",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/admin/users": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "List all users",
- "operationId": "adminGetAllUsers",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a user",
- "operationId": "adminCreateUser",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateUserOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/User"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a user",
- "operationId": "adminDeleteUser",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to delete",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Edit an existing user",
- "operationId": "adminEditUser",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to edit",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditUserOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/keys": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Add a public key on behalf of a user",
- "operationId": "adminCreatePublicKey",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "key",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PublicKey"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/keys/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Delete a user's public key",
- "operationId": "adminDeleteUserPublicKey",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/admin/users/{username}/orgs": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create an organization",
- "operationId": "adminCreateOrg",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user that will own the created organization",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "organization",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOrgOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Organization"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/admin/users/{username}/repos": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "admin"
- ],
- "summary": "Create a repository on behalf of a user",
- "operationId": "adminCreateRepo",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user. This user will own the created repository",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "repository",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/markdown": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render a markdown document as HTML",
- "operationId": "renderMarkdown",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MarkdownOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkdownRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/markdown/raw": {
- "post": {
- "consumes": [
- "text/plain"
- ],
- "produces": [
- "text/html"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Render raw markdown as HTML",
- "operationId": "renderMarkdownRaw",
- "parameters": [
- {
- "description": "Request body to render",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "type": "string"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MarkdownRender"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/notifications": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "List users's notification threads",
- "operationId": "notifyGetList",
- "parameters": [
- {
- "type": "string",
- "description": "If true, show notifications marked as read. Default value is false",
- "name": "all",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationThreadList"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Mark notification threads as read",
- "operationId": "notifyReadList",
- "parameters": [
- {
- "type": "string",
- "format": "date-time",
- "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
- "name": "last_read_at",
- "in": "query"
- }
- ],
- "responses": {
- "205": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/notifications/new": {
- "get": {
- "tags": [
- "notification"
- ],
- "summary": "Check if unread notifications exist",
- "operationId": "notifyNewAvailable",
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationCount"
- },
- "204": {
- "description": "No unread notification"
- }
- }
- }
- },
- "/notifications/threads/{id}": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Get notification thread by ID",
- "operationId": "notifyGetThread",
- "parameters": [
- {
- "type": "string",
- "description": "id of notification thread",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationThread"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Mark notification thread as read by ID",
- "operationId": "notifyReadThread",
- "parameters": [
- {
- "type": "string",
- "description": "id of notification thread",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "205": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/org/{org}/repos": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a repository in an organization",
- "operationId": "createOrgRepoDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get list of organizations",
- "operationId": "orgGetAll",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create an organization",
- "operationId": "orgCreate",
- "parameters": [
- {
- "name": "organization",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOrgOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Organization"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get an organization",
- "operationId": "orgGet",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization to get",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Organization"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete an organization",
- "operationId": "orgDelete",
- "parameters": [
- {
- "type": "string",
- "description": "organization that is to be deleted",
- "name": "org",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Edit an organization",
- "operationId": "orgEdit",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization to edit",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/EditOrgOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Organization"
- }
- }
- }
- },
- "/orgs/{org}/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's webhooks",
- "operationId": "orgListHooks",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- }
- }
- }
- },
- "/orgs/{org}/hooks/": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a hook",
- "operationId": "orgCreateHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/orgs/{org}/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a hook",
- "operationId": "orgGetHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Delete a hook",
- "operationId": "orgDeleteHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Update a hook",
- "operationId": "orgEditHook",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to update",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/orgs/{org}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's labels",
- "operationId": "orgListLabels",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a label for an organization",
- "operationId": "orgCreateLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateLabelOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Label"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/labels/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a single label",
- "operationId": "orgGetLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- }
- }
- },
- "delete": {
- "tags": [
- "organization"
- ],
- "summary": "Delete a label",
- "operationId": "orgDeleteLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Update a label",
- "operationId": "orgEditLabel",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditLabelOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's members",
- "operationId": "orgListMembers",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/orgs/{org}/members/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is a member of an organization",
- "operationId": "orgIsMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "user is a member"
- },
- "302": {
- "description": "redirection to /orgs/{org}/public_members/{username}"
- },
- "404": {
- "description": "user is not a member"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a member from an organization",
- "operationId": "orgDeleteMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "member removed"
- }
- }
- }
- },
- "/orgs/{org}/public_members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's public members",
- "operationId": "orgListPublicMembers",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/orgs/{org}/public_members/{username}": {
- "get": {
- "tags": [
- "organization"
- ],
- "summary": "Check if a user is a public member of an organization",
- "operationId": "orgIsPublicMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "user is a public member"
- },
- "404": {
- "description": "user is not a public member"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Publicize a user's membership",
- "operationId": "orgPublicizeMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "membership publicized"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Conceal a user's membership",
- "operationId": "orgConcealMember",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/orgs/{org}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's repos",
- "operationId": "orgListRepos",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a repository in an organization",
- "operationId": "createOrgRepo",
- "parameters": [
- {
- "type": "string",
- "description": "name of organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/orgs/{org}/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List an organization's teams",
- "operationId": "orgListTeams",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Create a team",
- "operationId": "orgCreateTeam",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateTeamOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Team"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/orgs/{org}/teams/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Search for teams within an organization",
- "operationId": "teamSearch",
- "parameters": [
- {
- "type": "string",
- "description": "name of the organization",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "keywords to search",
- "name": "q",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include search within team description (defaults to true)",
- "name": "include_desc",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "SearchResults of a successful search",
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Team"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "/repos/issues/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Search for issues across the repositories that the user has access to",
- "operationId": "issueSearchIssues",
- "parameters": [
- {
- "type": "string",
- "description": "whether issue is open or closed",
- "name": "state",
- "in": "query"
- },
- {
- "type": "string",
- "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "string",
- "description": "search string",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "repository to prioritize in the results",
- "name": "priority_repo_id",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter by type (issues / pulls) if set",
- "name": "type",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of requested issues",
- "name": "page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- }
- }
- }
- },
- "/repos/migrate": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Migrate a remote git repository",
- "operationId": "repoMigrate",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MigrateRepoForm"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Search for repositories",
- "operationId": "repoSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "Limit search to repositories with keyword as topic",
- "name": "topic",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include search of keyword within repository description",
- "name": "includeDesc",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that the user with the given id owns or contributes to",
- "name": "uid",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "repo owner to prioritize in the results",
- "name": "priority_owner_id",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "search only for repos that the user with the given id has starred",
- "name": "starredBy",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include private repositories this user has access to (defaults to true)",
- "name": "private",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "include template repositories this user has access to (defaults to true)",
- "name": "template",
- "in": "query"
- },
- {
- "type": "string",
- "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
- "name": "mode",
- "in": "query"
- },
- {
- "type": "boolean",
- "description": "if `uid` is given, search only for repos that the user owns",
- "name": "exclusive",
- "in": "query"
- },
- {
- "type": "string",
- "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
- "name": "sort",
- "in": "query"
- },
- {
- "type": "string",
- "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
- "name": "order",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/SearchResults"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository",
- "operationId": "repoGet",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a repository",
- "operationId": "repoDelete",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to delete",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to delete",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a repository's properties. Only fields that are set will be changed.",
- "operationId": "repoEdit",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to edit",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to edit",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "description": "Properties of a repo that you can edit",
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditRepoOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/archive/{archive}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get an archive of a repository",
- "operationId": "repoGetArchive",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "archive to download, consisting of a git reference and archive",
- "name": "archive",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branch_protections": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List branch protections for a repository",
- "operationId": "repoListBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchProtectionList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a branch protections for a repository",
- "operationId": "repoCreateBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateBranchProtectionOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/BranchProtection"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branch_protections/{name}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a specific branch protection for the repository",
- "operationId": "repoGetBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of protected branch",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchProtection"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a specific branch protection for the repository",
- "operationId": "repoDeleteBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of protected branch",
- "name": "name",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a branch protections for a repository. Only fields that are set will be changed",
- "operationId": "repoEditBranchProtection",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of protected branch",
- "name": "name",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditBranchProtectionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchProtection"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branches": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's branches",
- "operationId": "repoListBranches",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/BranchList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/branches/{branch}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
- "operationId": "repoGetBranch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "branch to get",
- "name": "branch",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Branch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's collaborators",
- "operationId": "repoListCollaborators",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators/{collaborator}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a user is a collaborator of a repository",
- "operationId": "repoCheckCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a collaborator to a repository",
- "operationId": "repoAddCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator to add",
- "name": "collaborator",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddCollaboratorOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a collaborator from a repository",
- "operationId": "repoDeleteCollaborator",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the collaborator to delete",
- "name": "collaborator",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a list of all commits from a repository",
- "operationId": "repoGetAllCommits",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "SHA or branch to start listing commits from (usually 'master')",
- "name": "sha",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommitList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "$ref": "#/responses/EmptyRepository"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits/{ref}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a single commit from a repository",
- "operationId": "repoGetSingleCommitByRef",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "a git ref",
- "name": "ref",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Commit"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits/{ref}/statuses": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's combined status, by branch/tag/commit reference",
- "operationId": "repoGetCombinedStatusByRef",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of branch/tag/commit",
- "name": "ref",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results",
- "name": "page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Status"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/contents": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the metadata of all the entries of the root dir",
- "operationId": "repoGetContentsList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ContentsListResponse"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/contents/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
- "operationId": "repoGetContents",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the dir, file, symlink or submodule in the repo",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
- "name": "ref",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ContentsResponse"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a file in a repository",
- "operationId": "repoUpdateFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to update",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/UpdateFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileResponse"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a file in a repository",
- "operationId": "repoCreateFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to create",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateFileOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/FileResponse"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a file in a repository",
- "operationId": "repoDeleteFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "path of the file to delete",
- "name": "filepath",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/DeleteFileOptions"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/FileDeleteResponse"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/editorconfig/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get the EditorConfig definitions of a file in a repository",
- "operationId": "repoGetEditorConfig",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/forks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's forks",
- "operationId": "listForks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Fork a repository",
- "operationId": "createFork",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to fork",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to fork",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateForkOption"
- }
- }
- ],
- "responses": {
- "202": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/blobs/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the blob of a repository.",
- "operationId": "GetBlob",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitBlobResponse"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/commits/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a single commit from a repository",
- "operationId": "repoGetSingleCommitBySHA",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "the commit hash",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Commit"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/refs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get specified ref or filtered repository's refs",
- "operationId": "repoListAllGitRefs",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReferenceList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/refs/{ref}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get specified ref or filtered repository's refs",
- "operationId": "repoListGitRefs",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "part or full name of the ref",
- "name": "ref",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReferenceList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/tags/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
- "operationId": "GetTag",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
- "name": "sha",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AnnotatedTag"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/trees/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Gets the tree of a repository.",
- "operationId": "GetTree",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "type": "boolean",
- "description": "show all directories and files",
- "name": "recursive",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number; the 'truncated' field in the response will be true if there are still more items after this page, false if the last page",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
- "name": "per_page",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitTreeResponse"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List the hooks in a repository",
- "operationId": "repoListHooks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/HookList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a hook",
- "operationId": "repoCreateHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateHookOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/git": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List the Git hooks in a repository",
- "operationId": "repoListGitHooks",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHookList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/git/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a Git hook",
- "operationId": "repoGetGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a Git hook in a repository",
- "operationId": "repoDeleteGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a Git hook in a repository",
- "operationId": "repoEditGitHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditGitHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GitHook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a hook",
- "operationId": "repoGetHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a hook in a repository",
- "operationId": "repoDeleteHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a hook in a repository",
- "operationId": "repoEditHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the hook",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditHookOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Hook"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}/tests": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Test a push webhook",
- "operationId": "repoTestHook",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the hook to test",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List a repository's issues",
- "operationId": "issueListIssues",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "whether issue is open or closed",
- "name": "state",
- "in": "query"
- },
- {
- "type": "string",
- "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "string",
- "description": "search string",
- "name": "q",
- "in": "query"
- },
- {
- "type": "string",
- "description": "filter by type (issues / pulls) if set",
- "name": "type",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/IssueList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueCreateIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateIssueOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "412": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments in a repository",
- "operationId": "issueGetRepoComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated since the provided time are returned.",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated before the provided time are returned.",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommentList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a comment",
- "operationId": "issueGetComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- },
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment",
- "operationId": "issueDeleteComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of comment to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment",
- "operationId": "issueEditComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueCommentOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- },
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a list of reactions from a comment of an issue",
- "operationId": "issueGetCommentReactions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReactionList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a reaction to a comment of an issue",
- "operationId": "issuePostCommentReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Reaction"
- },
- "201": {
- "$ref": "#/responses/Reaction"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a reaction from a comment of an issue",
- "operationId": "issueDeleteCommentReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue",
- "operationId": "issueGetIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to get",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Issue"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueEditIssue",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to edit",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Issue"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "412": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List all comments on an issue",
- "operationId": "issueGetComments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated since the specified time are returned.",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "if provided, only comments updated before the provided time are returned.",
- "name": "before",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/CommentList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a comment to an issue",
- "operationId": "issueCreateComment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateIssueCommentOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Comment"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a comment",
- "operationId": "issueDeleteCommentDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "this parameter is ignored",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of comment to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Edit a comment",
- "operationId": "issueEditCommentDeprecated",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "this parameter is ignored",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the comment to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditIssueCommentOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Comment"
- },
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/deadline": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Set an issue deadline. If set to null, the deadline is deleted. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "issueEditIssueDeadline",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to create or update a deadline on",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditDeadlineOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/IssueDeadline"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get an issue's labels",
- "operationId": "issueGetLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Replace an issue's labels",
- "operationId": "issueReplaceLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueLabelsOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a label to an issue",
- "operationId": "issueAddLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/IssueLabelsOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove all labels from an issue",
- "operationId": "issueClearLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a label from an issue",
- "operationId": "issueRemoveLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to remove",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/reactions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a list reactions of an issue",
- "operationId": "issueGetIssueReactions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReactionList"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add a reaction to an issue",
- "operationId": "issuePostIssueReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Reaction"
- },
- "201": {
- "$ref": "#/responses/Reaction"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Remove a reaction from an issue",
- "operationId": "issueDeleteIssueReaction",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "content",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReactionOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Delete an issue's existing stopwatch.",
- "operationId": "issueDeleteStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to stop the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "Cannot cancel a non existent stopwatch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Start stopwatch on an issue.",
- "operationId": "issueStartStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to create the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "Cannot start a stopwatch again if it already exists"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Stop an issue's existing stopwatch.",
- "operationId": "issueStopStopWatch",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to stop the stopwatch on",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "description": "Not repo writer, user does not have rights to toggle stopwatch"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "409": {
- "description": "Cannot stop a non existent stopwatch"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get users who subscribed on an issue.",
- "operationId": "issueSubscriptions",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Subscribe user to issue",
- "operationId": "issueAddSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user to subscribe",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "304": {
- "description": "User can only subscribe itself if he is no admin"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Unsubscribe user from issue",
- "operationId": "issueDeleteSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "user witch unsubscribe",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/empty"
- },
- "304": {
- "description": "User can only subscribe itself if he is no admin"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "List an issue's tracked times",
- "operationId": "issueTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Add tracked time to a issue",
- "operationId": "issueAddTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/AddTimeOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTime"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Reset a tracked time of an issue",
- "operationId": "issueResetTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue to add tracked time to",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
- "delete": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Delete specific tracked time",
- "operationId": "issueDeleteTime",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the issue",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of time to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's keys",
- "operationId": "repoListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "the key_id to search for",
- "name": "key_id",
- "in": "query"
- },
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/DeployKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a key to a repository",
- "operationId": "repoCreateKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/DeployKey"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository's key by id",
- "operationId": "repoGetKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/DeployKey"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a key from a repository",
- "operationId": "repoDeleteKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get all of a repository's labels",
- "operationId": "issueListLabels",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/LabelList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a label",
- "operationId": "issueCreateLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateLabelOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Label"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a single label",
- "operationId": "issueGetLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a label",
- "operationId": "issueDeleteLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Update a label",
- "operationId": "issueEditLabel",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the label to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditLabelOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Label"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get all of a repository's opened milestones",
- "operationId": "issueGetMilestonesList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
- "name": "state",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/MilestoneList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Create a milestone",
- "operationId": "issueCreateMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateMilestoneOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Milestone"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Get a milestone",
- "operationId": "issueGetMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the milestone",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Milestone"
- }
- }
- },
- "delete": {
- "tags": [
- "issue"
- ],
- "summary": "Delete a milestone",
- "operationId": "issueDeleteMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the milestone to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "issue"
- ],
- "summary": "Update a milestone",
- "operationId": "issueEditMilestone",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the milestone",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditMilestoneOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Milestone"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/mirror-sync": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Sync a mirrored repository",
- "operationId": "repoMirrorSync",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to sync",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to sync",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/notifications": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "List users's notification threads on a specific repo",
- "operationId": "notifyGetRepoList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "If true, show notifications marked as read. Default value is false",
- "name": "all",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/NotificationThreadList"
- }
- }
- },
- "put": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "notification"
- ],
- "summary": "Mark notification threads as read on a specific repo",
- "operationId": "notifyReadRepoList",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
- "name": "last_read_at",
- "in": "query"
- }
- ],
- "responses": {
- "205": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's pull requests",
- "operationId": "repoListPullRequests",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "closed",
- "open",
- "all"
- ],
- "type": "string",
- "description": "State of pull request: open or closed (optional)",
- "name": "state",
- "in": "query"
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "mostcomment",
- "leastcomment",
- "priority"
- ],
- "type": "string",
- "description": "Type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the milestone",
- "name": "milestone",
- "in": "query"
- },
- {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "collectionFormat": "multi",
- "description": "Label IDs",
- "name": "labels",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequestList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a pull request",
- "operationId": "repoCreatePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreatePullRequestOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullRequest"
- },
- "409": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a pull request",
- "operationId": "repoGetPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to get",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PullRequest"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
- "operationId": "repoEditPullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to edit",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditPullRequestOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PullRequest"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "412": {
- "$ref": "#/responses/error"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/pulls/{index}/merge": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Check if a pull request has been merged",
- "operationId": "repoPullRequestIsMerged",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request",
- "name": "index",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "pull request has been merged"
- },
- "404": {
- "description": "pull request has not been merged"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Merge a pull request",
- "operationId": "repoMergePullRequest",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "index of the pull request to merge",
- "name": "index",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/MergePullRequestOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/empty"
- },
- "405": {
- "$ref": "#/responses/empty"
- },
- "409": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/raw/{filepath}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a file from a repository",
- "operationId": "repoGetRawFile",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "filepath of the file to get",
- "name": "filepath",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "success"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's releases",
- "operationId": "repoListReleases",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "items count every page wants to load",
- "name": "per_page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/ReleaseList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a release",
- "operationId": "repoCreateRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateReleaseOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Release"
- },
- "409": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release",
- "operationId": "repoGetRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Delete a release",
- "operationId": "repoDeleteRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Update a release",
- "operationId": "repoEditRelease",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditReleaseOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Release"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}/assets": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List release's attachments",
- "operationId": "repoListReleaseAttachments",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AttachmentList"
- }
- }
- },
- "post": {
- "consumes": [
- "multipart/form-data"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a release attachment",
- "operationId": "repoCreateReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the attachment",
- "name": "name",
- "in": "query"
- },
- {
- "type": "file",
- "description": "attachment to upload",
- "name": "attachment",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a release attachment",
- "operationId": "repoGetReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to get",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Attachment"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a release attachment",
- "operationId": "repoDeleteReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to delete",
- "name": "attachment_id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Edit a release attachment",
- "operationId": "repoEditReleaseAttachment",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the release",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the attachment to edit",
- "name": "attachment_id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditAttachmentOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Attachment"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/signing-key.gpg": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get signing-key.gpg for given repository",
- "operationId": "repoSigningKey",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "GPG armored public key",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/stargazers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's stargazers",
- "operationId": "repoListStargazers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/statuses/{sha}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a commit's statuses",
- "operationId": "repoListStatuses",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "enum": [
- "oldest",
- "recentupdate",
- "leastupdate",
- "leastindex",
- "highestindex"
- ],
- "type": "string",
- "description": "type of sort",
- "name": "sort",
- "in": "query"
- },
- {
- "enum": [
- "pending",
- "success",
- "error",
- "failure",
- "warning"
- ],
- "type": "string",
- "description": "type of state",
- "name": "state",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/StatusList"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Create a commit status",
- "operationId": "repoCreateStatus",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "sha of the commit",
- "name": "sha",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateStatusOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Status"
- },
- "400": {
- "$ref": "#/responses/error"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/subscribers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's watchers",
- "operationId": "repoListSubscribers",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/subscription": {
- "get": {
- "tags": [
- "repository"
- ],
- "summary": "Check if the current user is watching a repo",
- "operationId": "userCurrentCheckSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- }
- }
- },
- "put": {
- "tags": [
- "repository"
- ],
- "summary": "Watch a repo",
- "operationId": "userCurrentPutSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/WatchInfo"
- }
- }
- },
- "delete": {
- "tags": [
- "repository"
- ],
- "summary": "Unwatch a repo",
- "operationId": "userCurrentDeleteSubscription",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/tags": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repository's tags",
- "operationId": "repoListTags",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, default maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TagList"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a repo's tracked times",
- "operationId": "repoTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "optional filter by user",
- "name": "user",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/times/{user}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "List a user's tracked times in a repo",
- "operationId": "userTrackedTimes",
- "deprecated": true,
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of user",
- "name": "user",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- },
- "400": {
- "$ref": "#/responses/error"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/topics": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get list of topics that a repository has",
- "operationId": "repoListTopics",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TopicNames"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Replace list of topics for a repository",
- "operationId": "repoUpdateTopics",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/RepoTopicOptions"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "422": {
- "$ref": "#/responses/invalidTopicsError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/topics/{topic}": {
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Add a topic to a repository",
- "operationId": "repoAddTopíc",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the topic to add",
- "name": "topic",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "422": {
- "$ref": "#/responses/invalidTopicsError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Delete a topic from a repository",
- "operationId": "repoDeleteTopic",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the topic to delete",
- "name": "topic",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "422": {
- "$ref": "#/responses/invalidTopicsError"
- }
- }
- }
- },
- "/repos/{owner}/{repo}/transfer": {
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Transfer a repo ownership",
- "operationId": "repoTransfer",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to transfer",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to transfer",
- "name": "repo",
- "in": "path",
- "required": true
- },
- {
- "description": "Transfer Options",
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/TransferRepoOption"
- }
- }
- ],
- "responses": {
- "202": {
- "$ref": "#/responses/Repository"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/repositories/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "Get a repository by id",
- "operationId": "repoGetByID",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the repo to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Repository"
- }
- }
- }
- },
- "/signing-key.gpg": {
- "get": {
- "produces": [
- "text/plain"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Get default signing-key.gpg",
- "operationId": "getSigningKey",
- "responses": {
- "200": {
- "description": "GPG armored public key",
- "schema": {
- "type": "string"
- }
- }
- }
- }
- },
- "/teams/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Get a team",
- "operationId": "orgGetTeam",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- }
- }
- },
- "delete": {
- "tags": [
- "organization"
- ],
- "summary": "Delete a team",
- "operationId": "orgDeleteTeam",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "description": "team deleted"
- }
- }
- },
- "patch": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Edit a team",
- "operationId": "orgEditTeam",
- "parameters": [
- {
- "type": "integer",
- "description": "id of the team to edit",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/EditTeamOption"
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/Team"
- }
- }
- }
- },
- "/teams/{id}/members": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's members",
- "operationId": "orgListTeamMembers",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/teams/{id}/members/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a particular member of team",
- "operationId": "orgListTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the member to list",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Add a team member",
- "operationId": "orgAddTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user to add",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a team member",
- "operationId": "orgRemoveTeamMember",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of the user to remove",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/teams/{id}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a team's repos",
- "operationId": "orgListTeamRepos",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/teams/{id}/repos/{org}/{repo}": {
- "put": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Add a repository to a team",
- "operationId": "orgAddTeamRepository",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to add",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to add",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- },
- "delete": {
- "description": "This does not delete the repository, it only removes the repository from the team.",
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "Remove a repository from a team",
- "operationId": "orgRemoveTeamRepository",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of the team",
- "name": "id",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "organization that owns the repo to remove",
- "name": "org",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to remove",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/topics/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository"
- ],
- "summary": "search topics via keyword",
- "operationId": "topicSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keywords to search",
- "name": "q",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TopicListResponse"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/user": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get the authenticated user",
- "operationId": "userGetCurrent",
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- }
- }
- }
- },
- "/user/applications/oauth2": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's oauth2 applications",
- "operationId": "userGetOauth2Application",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OAuth2ApplicationList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "creates a new OAuth2 application",
- "operationId": "userCreateOAuth2Application",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/OAuth2Application"
- }
- }
- }
- },
- "/user/applications/oauth2/{id}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "delete an OAuth2 Application",
- "operationId": "userDeleteOAuth2Application",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "token to be deleted",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/emails": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's email addresses",
- "operationId": "userListEmails",
- "responses": {
- "200": {
- "$ref": "#/responses/EmailList"
- }
- }
- },
- "post": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Add email addresses",
- "operationId": "userAddEmail",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateEmailOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/EmailList"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete email addresses",
- "operationId": "userDeleteEmail",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/DeleteEmailOption"
- }
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/followers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's followers",
- "operationId": "userCurrentListFollowers",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/following": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the users that the authenticated user is following",
- "operationId": "userCurrentListFollowing",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/user/following/{username}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check whether a user is followed by the authenticated user",
- "operationId": "userCurrentCheckFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of followed user",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Follow a user",
- "operationId": "userCurrentPutFollow",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to follow",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unfollow a user",
- "operationId": "userCurrentDeleteFollow",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to unfollow",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/gpg_keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's GPG keys",
- "operationId": "userCurrentListGPGKeys",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a GPG key",
- "operationId": "userCurrentPostGPGKey",
- "parameters": [
- {
- "name": "Form",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateGPGKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/GPGKey"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/gpg_keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a GPG key",
- "operationId": "userCurrentGetGPGKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Remove a GPG key",
- "operationId": "userCurrentDeleteGPGKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- }
- }
- }
- },
- "/user/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's public keys",
- "operationId": "userCurrentListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKeyList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create a public key",
- "operationId": "userCurrentPostKey",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateKeyOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/PublicKey"
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/keys/{id}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a public key",
- "operationId": "userCurrentGetKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to get",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKey"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Delete a public key",
- "operationId": "userCurrentDeleteKey",
- "parameters": [
- {
- "type": "integer",
- "format": "int64",
- "description": "id of key to delete",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "403": {
- "$ref": "#/responses/forbidden"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/user/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List the current user's organizations",
- "operationId": "orgListCurrentUserOrgs",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- }
- }
- }
- },
- "/user/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repos that the authenticated user owns or has access to",
- "operationId": "userCurrentListRepos",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "repository",
- "user"
- ],
- "summary": "Create a repository",
- "operationId": "createCurrentUserRepo",
- "parameters": [
- {
- "name": "body",
- "in": "body",
- "schema": {
- "$ref": "#/definitions/CreateRepoOption"
- }
- }
- ],
- "responses": {
- "201": {
- "$ref": "#/responses/Repository"
- },
- "409": {
- "description": "The repository with the same name already exists."
- },
- "422": {
- "$ref": "#/responses/validationError"
- }
- }
- }
- },
- "/user/starred": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "The repos that the authenticated user has starred",
- "operationId": "userCurrentListStarred",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/user/starred/{owner}/{repo}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Whether the authenticated is starring the repo",
- "operationId": "userCurrentCheckStarring",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- },
- "put": {
- "tags": [
- "user"
- ],
- "summary": "Star the given repo",
- "operationId": "userCurrentPutStar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to star",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to star",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- },
- "delete": {
- "tags": [
- "user"
- ],
- "summary": "Unstar the given repo",
- "operationId": "userCurrentDeleteStar",
- "parameters": [
- {
- "type": "string",
- "description": "owner of the repo to unstar",
- "name": "owner",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "name of the repo to unstar",
- "name": "repo",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/user/stopwatches": {
- "get": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get list of all existing stopwatches",
- "operationId": "userGetStopWatches",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/StopWatchList"
- }
- }
- }
- },
- "/user/subscriptions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List repositories watched by the authenticated user",
- "operationId": "userCurrentListSubscriptions",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/user/teams": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List all the teams a user belongs to",
- "operationId": "userListTeams",
- "parameters": [
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TeamList"
- }
- }
- }
- },
- "/user/times": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the current user's tracked times",
- "operationId": "userCurrentTrackedTimes",
- "parameters": [
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
- "name": "since",
- "in": "query"
- },
- {
- "type": "string",
- "format": "date-time",
- "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
- "name": "before",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/TrackedTimeList"
- }
- }
- }
- },
- "/users/search": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Search for users",
- "operationId": "userSearch",
- "parameters": [
- {
- "type": "string",
- "description": "keyword",
- "name": "q",
- "in": "query"
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "ID of the user to search for",
- "name": "uid",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "SearchResults of a successful search",
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "/users/{follower}/following/{followee}": {
- "get": {
- "tags": [
- "user"
- ],
- "summary": "Check if one user is following another user",
- "operationId": "userCheckFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of following user",
- "name": "follower",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "username of followed user",
- "name": "followee",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a user",
- "operationId": "userGet",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to get",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/User"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/followers": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's followers",
- "operationId": "userListFollowers",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/users/{username}/following": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the users that the given user is following",
- "operationId": "userListFollowing",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserList"
- }
- }
- }
- },
- "/users/{username}/gpg_keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's GPG keys",
- "operationId": "userListGPGKeys",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/GPGKeyList"
- }
- }
- }
- },
- "/users/{username}/heatmap": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Get a user's heatmap",
- "operationId": "userGetHeatmapData",
- "parameters": [
- {
- "type": "string",
- "description": "username of user to get",
- "name": "username",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/UserHeatmapData"
- },
- "404": {
- "$ref": "#/responses/notFound"
- }
- }
- }
- },
- "/users/{username}/keys": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the given user's public keys",
- "operationId": "userListKeys",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "string",
- "description": "fingerprint of the key",
- "name": "fingerprint",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/PublicKeyList"
- }
- }
- }
- },
- "/users/{username}/orgs": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "organization"
- ],
- "summary": "List a user's organizations",
- "operationId": "orgListUserOrgs",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/OrganizationList"
- }
- }
- }
- },
- "/users/{username}/repos": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repos owned by the given user",
- "operationId": "userListRepos",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/users/{username}/starred": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "The repos that the given user has starred",
- "operationId": "userListStarred",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/users/{username}/subscriptions": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the repositories watched by a user",
- "operationId": "userListSubscriptions",
- "parameters": [
- {
- "type": "string",
- "description": "username of the user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/RepositoryList"
- }
- }
- }
- },
- "/users/{username}/tokens": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "List the authenticated user's access tokens",
- "operationId": "userGetTokens",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "description": "page number of results to return (1-based)",
- "name": "page",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "page size of results, maximum page size is 50",
- "name": "limit",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AccessTokenList"
- }
- }
- },
- "post": {
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "Create an access token",
- "operationId": "userCreateToken",
- "parameters": [
- {
- "type": "string",
- "x-go-name": "Name",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "name": "accessToken",
- "in": "body",
- "schema": {
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "type": "string"
- }
- }
- }
- }
- ],
- "responses": {
- "200": {
- "$ref": "#/responses/AccessToken"
- }
- }
- }
- },
- "/users/{username}/tokens/{token}": {
- "delete": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "user"
- ],
- "summary": "delete an access token",
- "operationId": "userDeleteAccessToken",
- "parameters": [
- {
- "type": "string",
- "description": "username of user",
- "name": "username",
- "in": "path",
- "required": true
- },
- {
- "type": "integer",
- "format": "int64",
- "description": "token to be deleted",
- "name": "token",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "204": {
- "$ref": "#/responses/empty"
- }
- }
- }
- },
- "/version": {
- "get": {
- "produces": [
- "application/json"
- ],
- "tags": [
- "miscellaneous"
- ],
- "summary": "Returns the version of the Gitea application",
- "operationId": "getVersion",
- "responses": {
- "200": {
- "$ref": "#/responses/ServerVersion"
- }
- }
- }
- }
- },
- "definitions": {
- "APIError": {
- "description": "APIError is an api error with a message",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AccessToken": {
- "type": "object",
- "title": "AccessToken represents an API access token.",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "sha1": {
- "type": "string",
- "x-go-name": "Token"
- },
- "token_last_eight": {
- "type": "string",
- "x-go-name": "TokenLastEight"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AddCollaboratorOption": {
- "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "x-go-name": "Permission"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AddTimeOption": {
- "description": "AddTimeOption options for adding time to an issue",
- "type": "object",
- "required": [
- "time"
- ],
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "time": {
- "description": "time in seconds",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Time"
- },
- "user_name": {
- "description": "User who spent the time (optional)",
- "type": "string",
- "x-go-name": "User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AnnotatedTag": {
- "description": "AnnotatedTag represents an annotated tag",
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "object": {
- "$ref": "#/definitions/AnnotatedTagObject"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "tag": {
- "type": "string",
- "x-go-name": "Tag"
- },
- "tagger": {
- "$ref": "#/definitions/CommitUser"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "AnnotatedTagObject": {
- "description": "AnnotatedTagObject contains meta information of the tag object",
- "type": "object",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Attachment": {
- "description": "Attachment a generic attachment",
- "type": "object",
- "properties": {
- "browser_download_url": {
- "type": "string",
- "x-go-name": "DownloadURL"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "download_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "DownloadCount"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "uuid": {
- "type": "string",
- "x-go-name": "UUID"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Branch": {
- "description": "Branch represents a repository branch",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/PayloadCommit"
- },
- "effective_branch_protection_name": {
- "type": "string",
- "x-go-name": "EffectiveBranchProtectionName"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "protected": {
- "type": "boolean",
- "x-go-name": "Protected"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- },
- "user_can_merge": {
- "type": "boolean",
- "x-go-name": "UserCanMerge"
- },
- "user_can_push": {
- "type": "boolean",
- "x-go-name": "UserCanPush"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "BranchProtection": {
- "description": "BranchProtection represents a branch protection for a repository",
- "type": "object",
- "properties": {
- "approvals_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistTeams"
- },
- "approvals_whitelist_username": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistUsernames"
- },
- "block_on_rejected_reviews": {
- "type": "boolean",
- "x-go-name": "BlockOnRejectedReviews"
- },
- "branch_name": {
- "type": "string",
- "x-go-name": "BranchName"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "dismiss_stale_approvals": {
- "type": "boolean",
- "x-go-name": "DismissStaleApprovals"
- },
- "enable_approvals_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableApprovalsWhitelist"
- },
- "enable_merge_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableMergeWhitelist"
- },
- "enable_push": {
- "type": "boolean",
- "x-go-name": "EnablePush"
- },
- "enable_push_whitelist": {
- "type": "boolean",
- "x-go-name": "EnablePushWhitelist"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "merge_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistTeams"
- },
- "merge_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistUsernames"
- },
- "protected_file_patterns": {
- "type": "string",
- "x-go-name": "ProtectedFilePatterns"
- },
- "push_whitelist_deploy_keys": {
- "type": "boolean",
- "x-go-name": "PushWhitelistDeployKeys"
- },
- "push_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistTeams"
- },
- "push_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistUsernames"
- },
- "require_signed_commits": {
- "type": "boolean",
- "x-go-name": "RequireSignedCommits"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Comment": {
- "description": "Comment represents a comment on a commit or issue",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue_url": {
- "type": "string",
- "x-go-name": "IssueURL"
- },
- "original_author": {
- "type": "string",
- "x-go-name": "OriginalAuthor"
- },
- "original_author_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OriginalAuthorID"
- },
- "pull_request_url": {
- "type": "string",
- "x-go-name": "PRURL"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Commit": {
- "type": "object",
- "title": "Commit contains information generated from a Git commit.",
- "properties": {
- "author": {
- "$ref": "#/definitions/User"
- },
- "commit": {
- "$ref": "#/definitions/RepoCommit"
- },
- "committer": {
- "$ref": "#/definitions/User"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "parents": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitMeta"
- },
- "x-go-name": "Parents"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitDateOptions": {
- "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
- "type": "object",
- "properties": {
- "author": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Author"
- },
- "committer": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Committer"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitMeta": {
- "type": "object",
- "title": "CommitMeta contains meta information of a commit in terms of API.",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CommitUser": {
- "type": "object",
- "title": "CommitUser contains information of a user in the context of a commit.",
- "properties": {
- "date": {
- "type": "string",
- "x-go-name": "Date"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ContentsResponse": {
- "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
- "type": "object",
- "properties": {
- "_links": {
- "$ref": "#/definitions/FileLinksResponse"
- },
- "content": {
- "description": "`content` is populated when `type` is `file`, otherwise null",
- "type": "string",
- "x-go-name": "Content"
- },
- "download_url": {
- "type": "string",
- "x-go-name": "DownloadURL"
- },
- "encoding": {
- "description": "`encoding` is populated when `type` is `file`, otherwise null",
- "type": "string",
- "x-go-name": "Encoding"
- },
- "git_url": {
- "type": "string",
- "x-go-name": "GitURL"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "submodule_git_url": {
- "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
- "type": "string",
- "x-go-name": "SubmoduleGitURL"
- },
- "target": {
- "description": "`target` is populated when `type` is `symlink`, otherwise null",
- "type": "string",
- "x-go-name": "Target"
- },
- "type": {
- "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateBranchProtectionOption": {
- "description": "CreateBranchProtectionOption options for creating a branch protection",
- "type": "object",
- "properties": {
- "approvals_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistTeams"
- },
- "approvals_whitelist_username": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistUsernames"
- },
- "block_on_rejected_reviews": {
- "type": "boolean",
- "x-go-name": "BlockOnRejectedReviews"
- },
- "branch_name": {
- "type": "string",
- "x-go-name": "BranchName"
- },
- "dismiss_stale_approvals": {
- "type": "boolean",
- "x-go-name": "DismissStaleApprovals"
- },
- "enable_approvals_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableApprovalsWhitelist"
- },
- "enable_merge_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableMergeWhitelist"
- },
- "enable_push": {
- "type": "boolean",
- "x-go-name": "EnablePush"
- },
- "enable_push_whitelist": {
- "type": "boolean",
- "x-go-name": "EnablePushWhitelist"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "merge_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistTeams"
- },
- "merge_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistUsernames"
- },
- "protected_file_patterns": {
- "type": "string",
- "x-go-name": "ProtectedFilePatterns"
- },
- "push_whitelist_deploy_keys": {
- "type": "boolean",
- "x-go-name": "PushWhitelistDeployKeys"
- },
- "push_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistTeams"
- },
- "push_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistUsernames"
- },
- "require_signed_commits": {
- "type": "boolean",
- "x-go-name": "RequireSignedCommits"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateEmailOption": {
- "description": "CreateEmailOption options when creating email addresses",
- "type": "object",
- "properties": {
- "emails": {
- "description": "email addresses to add",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Emails"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateFileOptions": {
- "description": "CreateFileOptions options for creating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
- "type": "object",
- "required": [
- "content"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "content": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "Content"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateForkOption": {
- "description": "CreateForkOption options for creating a fork",
- "type": "object",
- "properties": {
- "organization": {
- "description": "organization name, if forking into an organization",
- "type": "string",
- "x-go-name": "Organization"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateGPGKeyOption": {
- "description": "CreateGPGKeyOption options create user GPG key",
- "type": "object",
- "required": [
- "armored_public_key"
- ],
- "properties": {
- "armored_public_key": {
- "description": "An armored GPG key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "ArmoredKey"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateHookOption": {
- "description": "CreateHookOption options when create a hook",
- "type": "object",
- "required": [
- "type",
- "config"
- ],
- "properties": {
- "active": {
- "type": "boolean",
- "default": false,
- "x-go-name": "Active"
- },
- "branch_filter": {
- "type": "string",
- "x-go-name": "BranchFilter"
- },
- "config": {
- "$ref": "#/definitions/CreateHookOptionConfig"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- },
- "type": {
- "type": "string",
- "enum": [
- "dingtalk",
- "discord",
- "gitea",
- "gogs",
- "msteams",
- "slack",
- "telegram",
- "feishu"
- ],
- "x-go-name": "Type"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateHookOptionConfig": {
- "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateIssueCommentOption": {
- "description": "CreateIssueCommentOption options for creating a comment on an issue",
- "type": "object",
- "required": [
- "body"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateIssueOption": {
- "description": "CreateIssueOption options to create one issue",
- "type": "object",
- "required": [
- "title"
- ],
- "properties": {
- "assignee": {
- "description": "username of assignee",
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed": {
- "type": "boolean",
- "x-go-name": "Closed"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "labels": {
- "description": "list of label ids",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "description": "milestone id",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateKeyOption": {
- "description": "CreateKeyOption options when creating a key",
- "type": "object",
- "required": [
- "title",
- "key"
- ],
- "properties": {
- "key": {
- "description": "An armored SSH key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Key"
- },
- "read_only": {
- "description": "Describe if the key has only read access or read/write",
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "title": {
- "description": "Title of the key to add",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateLabelOption": {
- "description": "CreateLabelOption options for creating a label",
- "type": "object",
- "required": [
- "name",
- "color"
- ],
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "#00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateMilestoneOption": {
- "description": "CreateMilestoneOption options for creating a milestone",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateOAuth2ApplicationOptions": {
- "description": "CreateOAuth2ApplicationOptions holds options to create an oauth2 application",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "redirect_uris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "RedirectURIs"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateOrgOption": {
- "description": "CreateOrgOption options for creating an organization",
- "type": "object",
- "required": [
- "username"
- ],
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "repo_admin_change_team_access": {
- "type": "boolean",
- "x-go-name": "RepoAdminChangeTeamAccess"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- },
- "visibility": {
- "description": "possible values are `public` (default), `limited` or `private`",
- "type": "string",
- "enum": [
- "public",
- "limited",
- "private"
- ],
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreatePullRequestOption": {
- "description": "CreatePullRequestOption options when creating a pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "type": "string",
- "x-go-name": "Base"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "head": {
- "type": "string",
- "x-go-name": "Head"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateReleaseOption": {
- "description": "CreateReleaseOption options when creating a release",
- "type": "object",
- "required": [
- "tag_name"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateRepoOption": {
- "description": "CreateRepoOption options when creating repository",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "auto_init": {
- "description": "Whether the repository should be auto-intialized?",
- "type": "boolean",
- "x-go-name": "AutoInit"
- },
- "default_branch": {
- "description": "DefaultBranch of the repository (used when initializes and in template)",
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "description": "Description of the repository to create",
- "type": "string",
- "x-go-name": "Description"
- },
- "gitignores": {
- "description": "Gitignores to use",
- "type": "string",
- "x-go-name": "Gitignores"
- },
- "issue_labels": {
- "description": "Issue Label set to use",
- "type": "string",
- "x-go-name": "IssueLabels"
- },
- "license": {
- "description": "License to use",
- "type": "string",
- "x-go-name": "License"
- },
- "name": {
- "description": "Name of the repository to create",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "private": {
- "description": "Whether the repository is private",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "readme": {
- "description": "Readme of the repository to create",
- "type": "string",
- "x-go-name": "Readme"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateStatusOption": {
- "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
- "type": "object",
- "properties": {
- "context": {
- "type": "string",
- "x-go-name": "Context"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "state": {
- "$ref": "#/definitions/StatusState"
- },
- "target_url": {
- "type": "string",
- "x-go-name": "TargetURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateTeamOption": {
- "description": "CreateTeamOption options for creating a team",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "can_create_org_repo": {
- "type": "boolean",
- "x-go-name": "CanCreateOrgRepo"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "includes_all_repositories": {
- "type": "boolean",
- "x-go-name": "IncludesAllRepositories"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Units",
- "example": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.ext_wiki"
- ]
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "CreateUserOption": {
- "description": "CreateUserOption create user options",
- "type": "object",
- "required": [
- "username",
- "email",
- "password"
- ],
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "login_name": {
- "type": "string",
- "x-go-name": "LoginName"
- },
- "must_change_password": {
- "type": "boolean",
- "x-go-name": "MustChangePassword"
- },
- "password": {
- "type": "string",
- "x-go-name": "Password"
- },
- "send_notify": {
- "type": "boolean",
- "x-go-name": "SendNotify"
- },
- "source_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "SourceID"
- },
- "username": {
- "type": "string",
- "x-go-name": "Username"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeleteEmailOption": {
- "description": "DeleteEmailOption options when deleting email addresses",
- "type": "object",
- "properties": {
- "emails": {
- "description": "email addresses to delete",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Emails"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeleteFileOptions": {
- "description": "DeleteFileOptions options for deleting files (used for other File structs below)\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
- "type": "object",
- "required": [
- "sha"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists",
- "type": "string",
- "x-go-name": "SHA"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "DeployKey": {
- "description": "DeployKey a deploy key",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "fingerprint": {
- "type": "string",
- "x-go-name": "Fingerprint"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "key_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "KeyID"
- },
- "read_only": {
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditAttachmentOptions": {
- "description": "EditAttachmentOptions options for editing attachments",
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditBranchProtectionOption": {
- "description": "EditBranchProtectionOption options for editing a branch protection",
- "type": "object",
- "properties": {
- "approvals_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistTeams"
- },
- "approvals_whitelist_username": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "ApprovalsWhitelistUsernames"
- },
- "block_on_rejected_reviews": {
- "type": "boolean",
- "x-go-name": "BlockOnRejectedReviews"
- },
- "dismiss_stale_approvals": {
- "type": "boolean",
- "x-go-name": "DismissStaleApprovals"
- },
- "enable_approvals_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableApprovalsWhitelist"
- },
- "enable_merge_whitelist": {
- "type": "boolean",
- "x-go-name": "EnableMergeWhitelist"
- },
- "enable_push": {
- "type": "boolean",
- "x-go-name": "EnablePush"
- },
- "enable_push_whitelist": {
- "type": "boolean",
- "x-go-name": "EnablePushWhitelist"
- },
- "enable_status_check": {
- "type": "boolean",
- "x-go-name": "EnableStatusCheck"
- },
- "merge_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistTeams"
- },
- "merge_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "MergeWhitelistUsernames"
- },
- "protected_file_patterns": {
- "type": "string",
- "x-go-name": "ProtectedFilePatterns"
- },
- "push_whitelist_deploy_keys": {
- "type": "boolean",
- "x-go-name": "PushWhitelistDeployKeys"
- },
- "push_whitelist_teams": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistTeams"
- },
- "push_whitelist_usernames": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "PushWhitelistUsernames"
- },
- "require_signed_commits": {
- "type": "boolean",
- "x-go-name": "RequireSignedCommits"
- },
- "required_approvals": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RequiredApprovals"
- },
- "status_check_contexts": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "StatusCheckContexts"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditDeadlineOption": {
- "description": "EditDeadlineOption options for creating a deadline",
- "type": "object",
- "required": [
- "due_date"
- ],
- "properties": {
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditGitHookOption": {
- "description": "EditGitHookOption options when modifying one Git hook",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditHookOption": {
- "description": "EditHookOption options when modify one hook",
- "type": "object",
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "branch_filter": {
- "type": "string",
- "x-go-name": "BranchFilter"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditIssueCommentOption": {
- "description": "EditIssueCommentOption options for editing a comment",
- "type": "object",
- "required": [
- "body"
- ],
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Body"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditIssueOption": {
- "description": "EditIssueOption options for editing an issue",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "unset_due_date": {
- "type": "boolean",
- "x-go-name": "RemoveDeadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditLabelOption": {
- "description": "EditLabelOption options for editing a label",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditMilestoneOption": {
- "description": "EditMilestoneOption options for editing a milestone",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditOrgOption": {
- "description": "EditOrgOption options for editing an organization",
- "type": "object",
- "properties": {
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "repo_admin_change_team_access": {
- "type": "boolean",
- "x-go-name": "RepoAdminChangeTeamAccess"
- },
- "visibility": {
- "description": "possible values are `public`, `limited` or `private`",
- "type": "string",
- "enum": [
- "public",
- "limited",
- "private"
- ],
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditPullRequestOption": {
- "description": "EditPullRequestOption options when modify pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "type": "string",
- "x-go-name": "Assignee"
- },
- "assignees": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Milestone"
- },
- "state": {
- "type": "string",
- "x-go-name": "State"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "unset_due_date": {
- "type": "boolean",
- "x-go-name": "RemoveDeadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditReactionOption": {
- "description": "EditReactionOption contain the reaction type",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Reaction"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditReleaseOption": {
- "description": "EditReleaseOption options when editing a release",
- "type": "object",
- "properties": {
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditRepoOption": {
- "description": "EditRepoOption options when editing a repository's properties",
- "type": "object",
- "properties": {
- "allow_merge_commits": {
- "description": "either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "AllowMerge"
- },
- "allow_rebase": {
- "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "AllowRebase"
- },
- "allow_rebase_explicit": {
- "description": "either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "AllowRebaseMerge"
- },
- "allow_squash_merge": {
- "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "AllowSquash"
- },
- "archived": {
- "description": "set to `true` to archive this repository.",
- "type": "boolean",
- "x-go-name": "Archived"
- },
- "default_branch": {
- "description": "sets the default branch for this repository.",
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "description": "a short description of the repository.",
- "type": "string",
- "x-go-name": "Description"
- },
- "external_tracker": {
- "$ref": "#/definitions/ExternalTracker"
- },
- "external_wiki": {
- "$ref": "#/definitions/ExternalWiki"
- },
- "has_issues": {
- "description": "either `true` to enable issues for this repository or `false` to disable them.",
- "type": "boolean",
- "x-go-name": "HasIssues"
- },
- "has_pull_requests": {
- "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
- "type": "boolean",
- "x-go-name": "HasPullRequests"
- },
- "has_wiki": {
- "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
- "type": "boolean",
- "x-go-name": "HasWiki"
- },
- "ignore_whitespace_conflicts": {
- "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
- "type": "boolean",
- "x-go-name": "IgnoreWhitespaceConflicts"
- },
- "internal_tracker": {
- "$ref": "#/definitions/InternalTracker"
- },
- "name": {
- "description": "name of the repository",
- "type": "string",
- "uniqueItems": true,
- "x-go-name": "Name"
- },
- "private": {
- "description": "either `true` to make the repository private or `false` to make it public.\nNote: you will get a 422 error if the organization restricts changing repository visibility to organization\nowners and a non-owner tries to change the value of private.",
- "type": "boolean",
- "x-go-name": "Private"
- },
- "template": {
- "description": "either `true` to make this repository a template or `false` to make it a normal repository",
- "type": "boolean",
- "x-go-name": "Template"
- },
- "website": {
- "description": "a URL with more information about the repository.",
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditTeamOption": {
- "description": "EditTeamOption options for editing a team",
- "type": "object",
- "required": [
- "name"
- ],
- "properties": {
- "can_create_org_repo": {
- "type": "boolean",
- "x-go-name": "CanCreateOrgRepo"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "includes_all_repositories": {
- "type": "boolean",
- "x-go-name": "IncludesAllRepositories"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Units",
- "example": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.ext_wiki"
- ]
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "EditUserOption": {
- "description": "EditUserOption edit user options",
- "type": "object",
- "required": [
- "email"
- ],
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "admin": {
- "type": "boolean",
- "x-go-name": "Admin"
- },
- "allow_create_organization": {
- "type": "boolean",
- "x-go-name": "AllowCreateOrganization"
- },
- "allow_git_hook": {
- "type": "boolean",
- "x-go-name": "AllowGitHook"
- },
- "allow_import_local": {
- "type": "boolean",
- "x-go-name": "AllowImportLocal"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "login_name": {
- "type": "string",
- "x-go-name": "LoginName"
- },
- "max_repo_creation": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "MaxRepoCreation"
- },
- "must_change_password": {
- "type": "boolean",
- "x-go-name": "MustChangePassword"
- },
- "password": {
- "type": "string",
- "x-go-name": "Password"
- },
- "prohibit_login": {
- "type": "boolean",
- "x-go-name": "ProhibitLogin"
- },
- "source_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "SourceID"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Email": {
- "description": "Email an email address belonging to a user",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "primary": {
- "type": "boolean",
- "x-go-name": "Primary"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ExternalTracker": {
- "description": "ExternalTracker represents settings for external tracker",
- "type": "object",
- "properties": {
- "external_tracker_format": {
- "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
- "type": "string",
- "x-go-name": "ExternalTrackerFormat"
- },
- "external_tracker_style": {
- "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
- "type": "string",
- "x-go-name": "ExternalTrackerStyle"
- },
- "external_tracker_url": {
- "description": "URL of external issue tracker.",
- "type": "string",
- "x-go-name": "ExternalTrackerURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ExternalWiki": {
- "description": "ExternalWiki represents setting for external wiki",
- "type": "object",
- "properties": {
- "external_wiki_url": {
- "description": "URL of external wiki.",
- "type": "string",
- "x-go-name": "ExternalWikiURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileCommitResponse": {
- "type": "object",
- "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "committer": {
- "$ref": "#/definitions/CommitUser"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "parents": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/CommitMeta"
- },
- "x-go-name": "Parents"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "tree": {
- "$ref": "#/definitions/CommitMeta"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileDeleteResponse": {
- "description": "FileDeleteResponse contains information about a repo's file that was deleted",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "content": {
- "type": "object",
- "x-go-name": "Content"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileLinksResponse": {
- "description": "FileLinksResponse contains the links for a repo's file",
- "type": "object",
- "properties": {
- "git": {
- "type": "string",
- "x-go-name": "GitURL"
- },
- "html": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "self": {
- "type": "string",
- "x-go-name": "Self"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "FileResponse": {
- "description": "FileResponse contains information about a repo's file",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/FileCommitResponse"
- },
- "content": {
- "$ref": "#/definitions/ContentsResponse"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GPGKey": {
- "description": "GPGKey a user GPG key to sign commit and tag in repository",
- "type": "object",
- "properties": {
- "can_certify": {
- "type": "boolean",
- "x-go-name": "CanCertify"
- },
- "can_encrypt_comms": {
- "type": "boolean",
- "x-go-name": "CanEncryptComms"
- },
- "can_encrypt_storage": {
- "type": "boolean",
- "x-go-name": "CanEncryptStorage"
- },
- "can_sign": {
- "type": "boolean",
- "x-go-name": "CanSign"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "emails": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKeyEmail"
- },
- "x-go-name": "Emails"
- },
- "expires_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Expires"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key_id": {
- "type": "string",
- "x-go-name": "KeyID"
- },
- "primary_key_id": {
- "type": "string",
- "x-go-name": "PrimaryKeyID"
- },
- "public_key": {
- "type": "string",
- "x-go-name": "PublicKey"
- },
- "subkeys": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKey"
- },
- "x-go-name": "SubsKey"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GPGKeyEmail": {
- "description": "GPGKeyEmail an email attached to a GPGKey",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "x-go-name": "Email"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitBlobResponse": {
- "description": "GitBlobResponse represents a git blob",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "encoding": {
- "type": "string",
- "x-go-name": "Encoding"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitEntry": {
- "description": "GitEntry represents a git tree",
- "type": "object",
- "properties": {
- "mode": {
- "type": "string",
- "x-go-name": "Mode"
- },
- "path": {
- "type": "string",
- "x-go-name": "Path"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitHook": {
- "description": "GitHook represents a Git repository hook",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Content"
- },
- "is_active": {
- "type": "boolean",
- "x-go-name": "IsActive"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitObject": {
- "type": "object",
- "title": "GitObject represents a Git object.",
- "properties": {
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "GitTreeResponse": {
- "description": "GitTreeResponse returns a git tree",
- "type": "object",
- "properties": {
- "page": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Page"
- },
- "sha": {
- "type": "string",
- "x-go-name": "SHA"
- },
- "total_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "TotalCount"
- },
- "tree": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GitEntry"
- },
- "x-go-name": "Entries"
- },
- "truncated": {
- "type": "boolean",
- "x-go-name": "Truncated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Hook": {
- "description": "Hook a hook is a web hook when one repository changed",
- "type": "object",
- "properties": {
- "active": {
- "type": "boolean",
- "x-go-name": "Active"
- },
- "config": {
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "x-go-name": "Config"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Events"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Identity": {
- "description": "Identity for a person's identity like an author or committer",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "InternalTracker": {
- "description": "InternalTracker represents settings for internal tracker",
- "type": "object",
- "properties": {
- "allow_only_contributors_to_track_time": {
- "description": "Let only contributors track time (Built-in issue tracker)",
- "type": "boolean",
- "x-go-name": "AllowOnlyContributorsToTrackTime"
- },
- "enable_issue_dependencies": {
- "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
- "type": "boolean",
- "x-go-name": "EnableIssueDependencies"
- },
- "enable_time_tracker": {
- "description": "Enable time tracking (Built-in issue tracker)",
- "type": "boolean",
- "x-go-name": "EnableTimeTracker"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Issue": {
- "description": "Issue represents an issue in a repository",
- "type": "object",
- "properties": {
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignees": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "Assignees"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "comments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- },
- "x-go-name": "Labels"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "number": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "original_author": {
- "type": "string",
- "x-go-name": "OriginalAuthor"
- },
- "original_author_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OriginalAuthorID"
- },
- "pull_request": {
- "$ref": "#/definitions/PullRequestMeta"
- },
- "repository": {
- "$ref": "#/definitions/RepositoryMeta"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueDeadline": {
- "description": "IssueDeadline represents an issue deadline",
- "type": "object",
- "properties": {
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "IssueLabelsOption": {
- "description": "IssueLabelsOption a collection of labels",
- "type": "object",
- "properties": {
- "labels": {
- "description": "list of label IDs",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "Labels"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Label": {
- "description": "Label a label to an issue or a pr",
- "type": "object",
- "properties": {
- "color": {
- "type": "string",
- "x-go-name": "Color",
- "example": "00aabb"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MarkdownOption": {
- "description": "MarkdownOption markdown options",
- "type": "object",
- "properties": {
- "Context": {
- "description": "Context to render\n\nin: body",
- "type": "string"
- },
- "Mode": {
- "description": "Mode to render\n\nin: body",
- "type": "string"
- },
- "Text": {
- "description": "Text markdown to render\n\nin: body",
- "type": "string"
- },
- "Wiki": {
- "description": "Is it a wiki page ?\n\nin: body",
- "type": "boolean"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "MergePullRequestOption": {
- "description": "MergePullRequestForm form for merging Pull Request",
- "type": "object",
- "required": [
- "Do"
- ],
- "properties": {
- "Do": {
- "type": "string",
- "enum": [
- "merge",
- "rebase",
- "rebase-merge",
- "squash"
- ]
- },
- "MergeMessageField": {
- "type": "string"
- },
- "MergeTitleField": {
- "type": "string"
- },
- "force_merge": {
- "type": "boolean",
- "x-go-name": "ForceMerge"
- }
- },
- "x-go-name": "MergePullRequestForm",
- "x-go-package": "code.gitea.io/gitea/modules/auth"
- },
- "MigrateRepoForm": {
- "description": "MigrateRepoForm form for migrating repository",
- "type": "object",
- "required": [
- "clone_addr",
- "uid",
- "repo_name"
- ],
- "properties": {
- "auth_password": {
- "type": "string",
- "x-go-name": "AuthPassword"
- },
- "auth_username": {
- "type": "string",
- "x-go-name": "AuthUsername"
- },
- "clone_addr": {
- "type": "string",
- "x-go-name": "CloneAddr"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "issues": {
- "type": "boolean",
- "x-go-name": "Issues"
- },
- "labels": {
- "type": "boolean",
- "x-go-name": "Labels"
- },
- "milestones": {
- "type": "boolean",
- "x-go-name": "Milestones"
- },
- "mirror": {
- "type": "boolean",
- "x-go-name": "Mirror"
- },
- "private": {
- "type": "boolean",
- "x-go-name": "Private"
- },
- "pull_requests": {
- "type": "boolean",
- "x-go-name": "PullRequests"
- },
- "releases": {
- "type": "boolean",
- "x-go-name": "Releases"
- },
- "repo_name": {
- "type": "string",
- "x-go-name": "RepoName"
- },
- "uid": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "UID"
- },
- "wiki": {
- "type": "boolean",
- "x-go-name": "Wiki"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/auth"
- },
- "Milestone": {
- "description": "Milestone milestone is a collection of issues on one repository",
- "type": "object",
- "properties": {
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "closed_issues": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ClosedIssues"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "open_issues": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenIssues"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotificationCount": {
- "description": "NotificationCount number of unread notifications",
- "type": "object",
- "properties": {
- "new": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "New"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotificationSubject": {
- "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
- "type": "object",
- "properties": {
- "latest_comment_url": {
- "type": "string",
- "x-go-name": "LatestCommentURL"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "type": {
- "type": "string",
- "x-go-name": "Type"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "NotificationThread": {
- "description": "NotificationThread expose Notification on API",
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "pinned": {
- "type": "boolean",
- "x-go-name": "Pinned"
- },
- "repository": {
- "$ref": "#/definitions/Repository"
- },
- "subject": {
- "$ref": "#/definitions/NotificationSubject"
- },
- "unread": {
- "type": "boolean",
- "x-go-name": "Unread"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "UpdatedAt"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "OAuth2Application": {
- "type": "object",
- "title": "OAuth2Application represents an OAuth2 application.",
- "properties": {
- "client_id": {
- "type": "string",
- "x-go-name": "ClientID"
- },
- "client_secret": {
- "type": "string",
- "x-go-name": "ClientSecret"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "redirect_uris": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "RedirectURIs"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Organization": {
- "description": "Organization represents an organization",
- "type": "object",
- "properties": {
- "avatar_url": {
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "location": {
- "type": "string",
- "x-go-name": "Location"
- },
- "repo_admin_change_team_access": {
- "type": "boolean",
- "x-go-name": "RepoAdminChangeTeamAccess"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- },
- "visibility": {
- "type": "string",
- "x-go-name": "Visibility"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PRBranchInfo": {
- "description": "PRBranchInfo information about a branch",
- "type": "object",
- "properties": {
- "label": {
- "type": "string",
- "x-go-name": "Name"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "repo": {
- "$ref": "#/definitions/Repository"
- },
- "repo_id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoID"
- },
- "sha": {
- "type": "string",
- "x-go-name": "Sha"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadCommit": {
- "description": "PayloadCommit represents a commit",
- "type": "object",
- "properties": {
- "added": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Added"
- },
- "author": {
- "$ref": "#/definitions/PayloadUser"
- },
- "committer": {
- "$ref": "#/definitions/PayloadUser"
- },
- "id": {
- "description": "sha1 hash of the commit",
- "type": "string",
- "x-go-name": "ID"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "modified": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Modified"
- },
- "removed": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Removed"
- },
- "timestamp": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Timestamp"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "verification": {
- "$ref": "#/definitions/PayloadCommitVerification"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadCommitVerification": {
- "description": "PayloadCommitVerification represents the GPG verification of a commit",
- "type": "object",
- "properties": {
- "payload": {
- "type": "string",
- "x-go-name": "Payload"
- },
- "reason": {
- "type": "string",
- "x-go-name": "Reason"
- },
- "signature": {
- "type": "string",
- "x-go-name": "Signature"
- },
- "signer": {
- "$ref": "#/definitions/PayloadUser"
- },
- "verified": {
- "type": "boolean",
- "x-go-name": "Verified"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PayloadUser": {
- "description": "PayloadUser represents the author or committer of a commit",
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "name": {
- "description": "Full name of the commit author",
- "type": "string",
- "x-go-name": "Name"
- },
- "username": {
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Permission": {
- "description": "Permission represents a set of permissions",
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean",
- "x-go-name": "Admin"
- },
- "pull": {
- "type": "boolean",
- "x-go-name": "Pull"
- },
- "push": {
- "type": "boolean",
- "x-go-name": "Push"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PublicKey": {
- "description": "PublicKey publickey is a user key to push code to repository",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "fingerprint": {
- "type": "string",
- "x-go-name": "Fingerprint"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "key": {
- "type": "string",
- "x-go-name": "Key"
- },
- "key_type": {
- "type": "string",
- "x-go-name": "KeyType"
- },
- "read_only": {
- "type": "boolean",
- "x-go-name": "ReadOnly"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullRequest": {
- "description": "PullRequest represents a pull request",
- "type": "object",
- "properties": {
- "assignee": {
- "$ref": "#/definitions/User"
- },
- "assignees": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- },
- "x-go-name": "Assignees"
- },
- "base": {
- "$ref": "#/definitions/PRBranchInfo"
- },
- "body": {
- "type": "string",
- "x-go-name": "Body"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Closed"
- },
- "comments": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Comments"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "diff_url": {
- "type": "string",
- "x-go-name": "DiffURL"
- },
- "due_date": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Deadline"
- },
- "head": {
- "$ref": "#/definitions/PRBranchInfo"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- },
- "x-go-name": "Labels"
- },
- "merge_base": {
- "type": "string",
- "x-go-name": "MergeBase"
- },
- "merge_commit_sha": {
- "type": "string",
- "x-go-name": "MergedCommitID"
- },
- "mergeable": {
- "type": "boolean",
- "x-go-name": "Mergeable"
- },
- "merged": {
- "type": "boolean",
- "x-go-name": "HasMerged"
- },
- "merged_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Merged"
- },
- "merged_by": {
- "$ref": "#/definitions/User"
- },
- "milestone": {
- "$ref": "#/definitions/Milestone"
- },
- "number": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Index"
- },
- "patch_url": {
- "type": "string",
- "x-go-name": "PatchURL"
- },
- "state": {
- "$ref": "#/definitions/StateType"
- },
- "title": {
- "type": "string",
- "x-go-name": "Title"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "PullRequestMeta": {
- "description": "PullRequestMeta PR info if an issue is a PR",
- "type": "object",
- "properties": {
- "merged": {
- "type": "boolean",
- "x-go-name": "HasMerged"
- },
- "merged_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Merged"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Reaction": {
- "description": "Reaction contain one reaction",
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "x-go-name": "Reaction"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "user": {
- "$ref": "#/definitions/User"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Reference": {
- "type": "object",
- "title": "Reference represents a Git reference.",
- "properties": {
- "object": {
- "$ref": "#/definitions/GitObject"
- },
- "ref": {
- "type": "string",
- "x-go-name": "Ref"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Release": {
- "description": "Release represents a repository release",
- "type": "object",
- "properties": {
- "assets": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- },
- "x-go-name": "Attachments"
- },
- "author": {
- "$ref": "#/definitions/User"
- },
- "body": {
- "type": "string",
- "x-go-name": "Note"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "draft": {
- "type": "boolean",
- "x-go-name": "IsDraft"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Title"
- },
- "prerelease": {
- "type": "boolean",
- "x-go-name": "IsPrerelease"
- },
- "published_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "PublishedAt"
- },
- "tag_name": {
- "type": "string",
- "x-go-name": "TagName"
- },
- "tarball_url": {
- "type": "string",
- "x-go-name": "TarURL"
- },
- "target_commitish": {
- "type": "string",
- "x-go-name": "Target"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- },
- "zipball_url": {
- "type": "string",
- "x-go-name": "ZipURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoCommit": {
- "type": "object",
- "title": "RepoCommit contains information of a commit in the context of a repository.",
- "properties": {
- "author": {
- "$ref": "#/definitions/CommitUser"
- },
- "committer": {
- "$ref": "#/definitions/CommitUser"
- },
- "message": {
- "type": "string",
- "x-go-name": "Message"
- },
- "tree": {
- "$ref": "#/definitions/CommitMeta"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepoTopicOptions": {
- "description": "RepoTopicOptions a collection of repo topic names",
- "type": "object",
- "properties": {
- "topics": {
- "description": "list of topic names",
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Topics"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Repository": {
- "description": "Repository represents a repository",
- "type": "object",
- "properties": {
- "allow_merge_commits": {
- "type": "boolean",
- "x-go-name": "AllowMerge"
- },
- "allow_rebase": {
- "type": "boolean",
- "x-go-name": "AllowRebase"
- },
- "allow_rebase_explicit": {
- "type": "boolean",
- "x-go-name": "AllowRebaseMerge"
- },
- "allow_squash_merge": {
- "type": "boolean",
- "x-go-name": "AllowSquash"
- },
- "archived": {
- "type": "boolean",
- "x-go-name": "Archived"
- },
- "avatar_url": {
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "clone_url": {
- "type": "string",
- "x-go-name": "CloneURL"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "default_branch": {
- "type": "string",
- "x-go-name": "DefaultBranch"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "empty": {
- "type": "boolean",
- "x-go-name": "Empty"
- },
- "external_tracker": {
- "$ref": "#/definitions/ExternalTracker"
- },
- "external_wiki": {
- "$ref": "#/definitions/ExternalWiki"
- },
- "fork": {
- "type": "boolean",
- "x-go-name": "Fork"
- },
- "forks_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Forks"
- },
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "has_issues": {
- "type": "boolean",
- "x-go-name": "HasIssues"
- },
- "has_pull_requests": {
- "type": "boolean",
- "x-go-name": "HasPullRequests"
- },
- "has_wiki": {
- "type": "boolean",
- "x-go-name": "HasWiki"
- },
- "html_url": {
- "type": "string",
- "x-go-name": "HTMLURL"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "ignore_whitespace_conflicts": {
- "type": "boolean",
- "x-go-name": "IgnoreWhitespaceConflicts"
- },
- "internal_tracker": {
- "$ref": "#/definitions/InternalTracker"
- },
- "mirror": {
- "type": "boolean",
- "x-go-name": "Mirror"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "open_issues_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenIssues"
- },
- "open_pr_counter": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "OpenPulls"
- },
- "original_url": {
- "type": "string",
- "x-go-name": "OriginalURL"
- },
- "owner": {
- "$ref": "#/definitions/User"
- },
- "parent": {
- "$ref": "#/definitions/Repository"
- },
- "permissions": {
- "$ref": "#/definitions/Permission"
- },
- "private": {
- "type": "boolean",
- "x-go-name": "Private"
- },
- "release_counter": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Releases"
- },
- "size": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Size"
- },
- "ssh_url": {
- "type": "string",
- "x-go-name": "SSHURL"
- },
- "stars_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Stars"
- },
- "template": {
- "type": "boolean",
- "x-go-name": "Template"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "watchers_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Watchers"
- },
- "website": {
- "type": "string",
- "x-go-name": "Website"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "RepositoryMeta": {
- "description": "RepositoryMeta basic repository information",
- "type": "object",
- "properties": {
- "full_name": {
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "owner": {
- "type": "string",
- "x-go-name": "Owner"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "SearchResults": {
- "description": "SearchResults results of a successful search",
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Repository"
- },
- "x-go-name": "Data"
- },
- "ok": {
- "type": "boolean",
- "x-go-name": "OK"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "ServerVersion": {
- "description": "ServerVersion wraps the version of the server",
- "type": "object",
- "properties": {
- "version": {
- "type": "string",
- "x-go-name": "Version"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StateType": {
- "description": "StateType issue state type",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Status": {
- "description": "Status holds a single Status of a single Commit",
- "type": "object",
- "properties": {
- "context": {
- "type": "string",
- "x-go-name": "Context"
- },
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "creator": {
- "$ref": "#/definitions/User"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "status": {
- "$ref": "#/definitions/StatusState"
- },
- "target_url": {
- "type": "string",
- "x-go-name": "TargetURL"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StatusState": {
- "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
- "type": "string",
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "StopWatch": {
- "description": "StopWatch represent a running stopwatch",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "issue_index": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "IssueIndex"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Tag": {
- "description": "Tag represents a repository tag",
- "type": "object",
- "properties": {
- "commit": {
- "$ref": "#/definitions/CommitMeta"
- },
- "id": {
- "type": "string",
- "x-go-name": "ID"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "tarball_url": {
- "type": "string",
- "x-go-name": "TarballURL"
- },
- "zipball_url": {
- "type": "string",
- "x-go-name": "ZipballURL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "Team": {
- "description": "Team represents a team in an organization",
- "type": "object",
- "properties": {
- "can_create_org_repo": {
- "type": "boolean",
- "x-go-name": "CanCreateOrgRepo"
- },
- "description": {
- "type": "string",
- "x-go-name": "Description"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "includes_all_repositories": {
- "type": "boolean",
- "x-go-name": "IncludesAllRepositories"
- },
- "name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "organization": {
- "$ref": "#/definitions/Organization"
- },
- "permission": {
- "type": "string",
- "enum": [
- "none",
- "read",
- "write",
- "admin",
- "owner"
- ],
- "x-go-name": "Permission"
- },
- "units": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "Units",
- "example": [
- "repo.code",
- "repo.issues",
- "repo.ext_issues",
- "repo.wiki",
- "repo.pulls",
- "repo.releases",
- "repo.ext_wiki"
- ]
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TimeStamp": {
- "description": "TimeStamp defines a timestamp",
- "type": "integer",
- "format": "int64",
- "x-go-package": "code.gitea.io/gitea/modules/timeutil"
- },
- "TopicName": {
- "description": "TopicName a list of repo topic names",
- "type": "object",
- "properties": {
- "topics": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "x-go-name": "TopicNames"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TopicResponse": {
- "description": "TopicResponse for returning topics",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "repo_count": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "RepoCount"
- },
- "topic_name": {
- "type": "string",
- "x-go-name": "Name"
- },
- "updated": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Updated"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TrackedTime": {
- "description": "TrackedTime worked time for an issue / pr",
- "type": "object",
- "properties": {
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "id": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "issue": {
- "$ref": "#/definitions/Issue"
- },
- "issue_id": {
- "description": "deprecated (only for backwards compatibility)",
- "type": "integer",
- "format": "int64",
- "x-go-name": "IssueID"
- },
- "time": {
- "description": "Time in seconds",
- "type": "integer",
- "format": "int64",
- "x-go-name": "Time"
- },
- "user_id": {
- "description": "deprecated (only for backwards compatibility)",
- "type": "integer",
- "format": "int64",
- "x-go-name": "UserID"
- },
- "user_name": {
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "TransferRepoOption": {
- "description": "TransferRepoOption options when transfer a repository's ownership",
- "type": "object",
- "required": [
- "new_owner"
- ],
- "properties": {
- "new_owner": {
- "type": "string",
- "x-go-name": "NewOwner"
- },
- "team_ids": {
- "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
- "type": "array",
- "items": {
- "type": "integer",
- "format": "int64"
- },
- "x-go-name": "TeamIDs"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UpdateFileOptions": {
- "description": "UpdateFileOptions options for updating files\nNote: `author` and `committer` are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)",
- "type": "object",
- "required": [
- "sha",
- "content"
- ],
- "properties": {
- "author": {
- "$ref": "#/definitions/Identity"
- },
- "branch": {
- "description": "branch (optional) to base this file from. if not given, the default branch is used",
- "type": "string",
- "x-go-name": "BranchName"
- },
- "committer": {
- "$ref": "#/definitions/Identity"
- },
- "content": {
- "description": "content must be base64 encoded",
- "type": "string",
- "x-go-name": "Content"
- },
- "dates": {
- "$ref": "#/definitions/CommitDateOptions"
- },
- "from_path": {
- "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
- "type": "string",
- "x-go-name": "FromPath"
- },
- "message": {
- "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
- "type": "string",
- "x-go-name": "Message"
- },
- "new_branch": {
- "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
- "type": "string",
- "x-go-name": "NewBranchName"
- },
- "sha": {
- "description": "sha is the SHA for the file that already exists",
- "type": "string",
- "x-go-name": "SHA"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "User": {
- "description": "User represents a user",
- "type": "object",
- "properties": {
- "avatar_url": {
- "description": "URL to the user's avatar",
- "type": "string",
- "x-go-name": "AvatarURL"
- },
- "created": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "Created"
- },
- "email": {
- "type": "string",
- "format": "email",
- "x-go-name": "Email"
- },
- "full_name": {
- "description": "the user's full name",
- "type": "string",
- "x-go-name": "FullName"
- },
- "id": {
- "description": "the user's id",
- "type": "integer",
- "format": "int64",
- "x-go-name": "ID"
- },
- "is_admin": {
- "description": "Is the user an administrator",
- "type": "boolean",
- "x-go-name": "IsAdmin"
- },
- "language": {
- "description": "User locale",
- "type": "string",
- "x-go-name": "Language"
- },
- "last_login": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "LastLogin"
- },
- "login": {
- "description": "the user's username",
- "type": "string",
- "x-go-name": "UserName"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- },
- "UserHeatmapData": {
- "description": "UserHeatmapData represents the data needed to create a heatmap",
- "type": "object",
- "properties": {
- "contributions": {
- "type": "integer",
- "format": "int64",
- "x-go-name": "Contributions"
- },
- "timestamp": {
- "$ref": "#/definitions/TimeStamp"
- }
- },
- "x-go-package": "code.gitea.io/gitea/models"
- },
- "WatchInfo": {
- "description": "WatchInfo represents an API watch status of one repository",
- "type": "object",
- "properties": {
- "created_at": {
- "type": "string",
- "format": "date-time",
- "x-go-name": "CreatedAt"
- },
- "ignored": {
- "type": "boolean",
- "x-go-name": "Ignored"
- },
- "reason": {
- "type": "object",
- "x-go-name": "Reason"
- },
- "repository_url": {
- "type": "string",
- "x-go-name": "RepositoryURL"
- },
- "subscribed": {
- "type": "boolean",
- "x-go-name": "Subscribed"
- },
- "url": {
- "type": "string",
- "x-go-name": "URL"
- }
- },
- "x-go-package": "code.gitea.io/gitea/modules/structs"
- }
- },
- "responses": {
- "AccessToken": {
- "description": "AccessToken represents an API access token.",
- "headers": {
- "id": {
- "type": "integer",
- "format": "int64"
- },
- "name": {
- "type": "string"
- },
- "sha1": {
- "type": "string"
- },
- "token_last_eight": {
- "type": "string"
- }
- }
- },
- "AccessTokenList": {
- "description": "AccessTokenList represents a list of API access token.",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/AccessToken"
- }
- }
- },
- "AnnotatedTag": {
- "description": "AnnotatedTag",
- "schema": {
- "$ref": "#/definitions/AnnotatedTag"
- }
- },
- "Attachment": {
- "description": "Attachment",
- "schema": {
- "$ref": "#/definitions/Attachment"
- }
- },
- "AttachmentList": {
- "description": "AttachmentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Attachment"
- }
- }
- },
- "Branch": {
- "description": "Branch",
- "schema": {
- "$ref": "#/definitions/Branch"
- }
- },
- "BranchList": {
- "description": "BranchList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Branch"
- }
- }
- },
- "BranchProtection": {
- "description": "BranchProtection",
- "schema": {
- "$ref": "#/definitions/BranchProtection"
- }
- },
- "BranchProtectionList": {
- "description": "BranchProtectionList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/BranchProtection"
- }
- }
- },
- "Comment": {
- "description": "Comment",
- "schema": {
- "$ref": "#/definitions/Comment"
- }
- },
- "CommentList": {
- "description": "CommentList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Comment"
- }
- }
- },
- "Commit": {
- "description": "Commit",
- "schema": {
- "$ref": "#/definitions/Commit"
- }
- },
- "CommitList": {
- "description": "CommitList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Commit"
- }
- },
- "headers": {
- "X-HasMore": {
- "type": "boolean",
- "description": "True if there is another page"
- },
- "X-Page": {
- "type": "integer",
- "format": "int64",
- "description": "The current page"
- },
- "X-PageCount": {
- "type": "integer",
- "format": "int64",
- "description": "Total number of pages"
- },
- "X-PerPage": {
- "type": "integer",
- "format": "int64",
- "description": "Commits per page"
- },
- "X-Total": {
- "type": "integer",
- "format": "int64",
- "description": "Total commit count"
- }
- }
- },
- "ContentsListResponse": {
- "description": "ContentsListResponse",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/ContentsResponse"
- }
- }
- },
- "ContentsResponse": {
- "description": "ContentsResponse",
- "schema": {
- "$ref": "#/definitions/ContentsResponse"
- }
- },
- "DeployKey": {
- "description": "DeployKey",
- "schema": {
- "$ref": "#/definitions/DeployKey"
- }
- },
- "DeployKeyList": {
- "description": "DeployKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/DeployKey"
- }
- }
- },
- "EmailList": {
- "description": "EmailList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Email"
- }
- }
- },
- "EmptyRepository": {
- "description": "EmptyRepository",
- "schema": {
- "$ref": "#/definitions/APIError"
- }
- },
- "FileDeleteResponse": {
- "description": "FileDeleteResponse",
- "schema": {
- "$ref": "#/definitions/FileDeleteResponse"
- }
- },
- "FileResponse": {
- "description": "FileResponse",
- "schema": {
- "$ref": "#/definitions/FileResponse"
- }
- },
- "GPGKey": {
- "description": "GPGKey",
- "schema": {
- "$ref": "#/definitions/GPGKey"
- }
- },
- "GPGKeyList": {
- "description": "GPGKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GPGKey"
- }
- }
- },
- "GitBlobResponse": {
- "description": "GitBlobResponse",
- "schema": {
- "$ref": "#/definitions/GitBlobResponse"
- }
- },
- "GitHook": {
- "description": "GitHook",
- "schema": {
- "$ref": "#/definitions/GitHook"
- }
- },
- "GitHookList": {
- "description": "GitHookList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/GitHook"
- }
- }
- },
- "GitTreeResponse": {
- "description": "GitTreeResponse",
- "schema": {
- "$ref": "#/definitions/GitTreeResponse"
- }
- },
- "Hook": {
- "description": "Hook",
- "schema": {
- "$ref": "#/definitions/Hook"
- }
- },
- "HookList": {
- "description": "HookList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Hook"
- }
- }
- },
- "Issue": {
- "description": "Issue",
- "schema": {
- "$ref": "#/definitions/Issue"
- }
- },
- "IssueDeadline": {
- "description": "IssueDeadline",
- "schema": {
- "$ref": "#/definitions/IssueDeadline"
- }
- },
- "IssueList": {
- "description": "IssueList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Issue"
- }
- }
- },
- "Label": {
- "description": "Label",
- "schema": {
- "$ref": "#/definitions/Label"
- }
- },
- "LabelList": {
- "description": "LabelList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Label"
- }
- }
- },
- "MarkdownRender": {
- "description": "MarkdownRender is a rendered markdown document",
- "schema": {
- "type": "string"
- }
- },
- "Milestone": {
- "description": "Milestone",
- "schema": {
- "$ref": "#/definitions/Milestone"
- }
- },
- "MilestoneList": {
- "description": "MilestoneList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Milestone"
- }
- }
- },
- "NotificationCount": {
- "description": "Number of unread notifications",
- "schema": {
- "$ref": "#/definitions/NotificationCount"
- }
- },
- "NotificationThread": {
- "description": "NotificationThread",
- "schema": {
- "$ref": "#/definitions/NotificationThread"
- }
- },
- "NotificationThreadList": {
- "description": "NotificationThreadList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/NotificationThread"
- }
- }
- },
- "OAuth2Application": {
- "description": "OAuth2Application",
- "schema": {
- "$ref": "#/definitions/OAuth2Application"
- }
- },
- "OAuth2ApplicationList": {
- "description": "OAuth2ApplicationList represents a list of OAuth2 applications.",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/OAuth2Application"
- }
- }
- },
- "Organization": {
- "description": "Organization",
- "schema": {
- "$ref": "#/definitions/Organization"
- }
- },
- "OrganizationList": {
- "description": "OrganizationList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Organization"
- }
- }
- },
- "PublicKey": {
- "description": "PublicKey",
- "schema": {
- "$ref": "#/definitions/PublicKey"
- }
- },
- "PublicKeyList": {
- "description": "PublicKeyList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PublicKey"
- }
- }
- },
- "PullRequest": {
- "description": "PullRequest",
- "schema": {
- "$ref": "#/definitions/PullRequest"
- }
- },
- "PullRequestList": {
- "description": "PullRequestList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/PullRequest"
- }
- }
- },
- "Reaction": {
- "description": "Reaction",
- "schema": {
- "$ref": "#/definitions/Reaction"
- }
- },
- "ReactionList": {
- "description": "ReactionList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Reaction"
- }
- }
- },
- "Reference": {
- "description": "Reference",
- "schema": {
- "$ref": "#/definitions/Reference"
- }
- },
- "ReferenceList": {
- "description": "ReferenceList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Reference"
- }
- }
- },
- "Release": {
- "description": "Release",
- "schema": {
- "$ref": "#/definitions/Release"
- }
- },
- "ReleaseList": {
- "description": "ReleaseList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Release"
- }
- }
- },
- "Repository": {
- "description": "Repository",
- "schema": {
- "$ref": "#/definitions/Repository"
- }
- },
- "RepositoryList": {
- "description": "RepositoryList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Repository"
- }
- }
- },
- "SearchResults": {
- "description": "SearchResults",
- "schema": {
- "$ref": "#/definitions/SearchResults"
- }
- },
- "ServerVersion": {
- "description": "ServerVersion",
- "schema": {
- "$ref": "#/definitions/ServerVersion"
- }
- },
- "Status": {
- "description": "Status",
- "schema": {
- "$ref": "#/definitions/Status"
- }
- },
- "StatusList": {
- "description": "StatusList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Status"
- }
- }
- },
- "StopWatch": {
- "description": "StopWatch",
- "schema": {
- "$ref": "#/definitions/StopWatch"
- }
- },
- "StopWatchList": {
- "description": "StopWatchList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/StopWatch"
- }
- }
- },
- "Tag": {
- "description": "Tag",
- "schema": {
- "$ref": "#/definitions/Tag"
- }
- },
- "TagList": {
- "description": "TagList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Tag"
- }
- }
- },
- "Team": {
- "description": "Team",
- "schema": {
- "$ref": "#/definitions/Team"
- }
- },
- "TeamList": {
- "description": "TeamList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/Team"
- }
- }
- },
- "TopicListResponse": {
- "description": "TopicListResponse",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TopicResponse"
- }
- }
- },
- "TopicNames": {
- "description": "TopicNames",
- "schema": {
- "$ref": "#/definitions/TopicName"
- }
- },
- "TrackedTime": {
- "description": "TrackedTime",
- "schema": {
- "$ref": "#/definitions/TrackedTime"
- }
- },
- "TrackedTimeList": {
- "description": "TrackedTimeList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/TrackedTime"
- }
- }
- },
- "User": {
- "description": "User",
- "schema": {
- "$ref": "#/definitions/User"
- }
- },
- "UserHeatmapData": {
- "description": "UserHeatmapData",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/UserHeatmapData"
- }
- }
- },
- "UserList": {
- "description": "UserList",
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/User"
- }
- }
- },
- "WatchInfo": {
- "description": "WatchInfo",
- "schema": {
- "$ref": "#/definitions/WatchInfo"
- }
- },
- "empty": {
- "description": "APIEmpty is an empty response"
- },
- "error": {
- "description": "APIError is error format response",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "forbidden": {
- "description": "APIForbiddenError is a forbidden error response",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "invalidTopicsError": {
- "description": "APIInvalidTopicsError is error format response to invalid topics",
- "headers": {
- "invalidTopics": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "message": {
- "type": "string"
- }
- }
- },
- "notFound": {
- "description": "APINotFound is a not found empty response"
- },
- "parameterBodies": {
- "description": "parameterBodies",
- "schema": {
- "$ref": "#/definitions/CreateOAuth2ApplicationOptions"
- }
- },
- "redirect": {
- "description": "APIRedirect is a redirect response"
- },
- "validationError": {
- "description": "APIValidationError is error format response related to input validation",
- "headers": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- },
- "securityDefinitions": {
- "AccessToken": {
- "type": "apiKey",
- "name": "access_token",
- "in": "query"
- },
- "AuthorizationHeaderToken": {
- "description": "API tokens must be prepended with \"token\" followed by a space.",
- "type": "apiKey",
- "name": "Authorization",
- "in": "header"
- },
- "BasicAuth": {
- "type": "basic"
- },
- "SudoHeader": {
- "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
- "type": "apiKey",
- "name": "Sudo",
- "in": "header"
- },
- "SudoParam": {
- "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
- "type": "apiKey",
- "name": "sudo",
- "in": "query"
- },
- "Token": {
- "type": "apiKey",
- "name": "token",
- "in": "query"
- }
- },
- "security": [
- {
- "BasicAuth": []
- },
- {
- "Token": []
- },
- {
- "AccessToken": []
- },
- {
- "AuthorizationHeaderToken": []
- },
- {
- "SudoParam": []
- },
- {
- "SudoHeader": []
- }
- ]
- }
|