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

v1_json.tmpl 256KB

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