Fork to maintain patches against the official gitea for https://code.ceondo.com https://github.com/go-gitea/gitea

swagger.v1.json 171KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186
  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": "/api/v1",
  25. "paths": {
  26. "/admin/users": {
  27. "post": {
  28. "consumes": [
  29. "application/json"
  30. ],
  31. "produces": [
  32. "application/json"
  33. ],
  34. "tags": [
  35. "admin"
  36. ],
  37. "summary": "Create a user",
  38. "operationId": "adminCreateUser",
  39. "parameters": [
  40. {
  41. "name": "body",
  42. "in": "body",
  43. "schema": {
  44. "$ref": "#/definitions/CreateUserOption"
  45. }
  46. }
  47. ],
  48. "responses": {
  49. "201": {
  50. "$ref": "#/responses/User"
  51. },
  52. "403": {
  53. "$ref": "#/responses/forbidden"
  54. },
  55. "422": {
  56. "$ref": "#/responses/validationError"
  57. }
  58. }
  59. }
  60. },
  61. "/admin/users/{username}": {
  62. "delete": {
  63. "produces": [
  64. "application/json"
  65. ],
  66. "tags": [
  67. "admin"
  68. ],
  69. "summary": "Delete a user",
  70. "operationId": "adminDeleteUser",
  71. "parameters": [
  72. {
  73. "type": "string",
  74. "description": "username of user to delete",
  75. "name": "username",
  76. "in": "path",
  77. "required": true
  78. }
  79. ],
  80. "responses": {
  81. "204": {
  82. "$ref": "#/responses/empty"
  83. },
  84. "403": {
  85. "$ref": "#/responses/forbidden"
  86. },
  87. "422": {
  88. "$ref": "#/responses/validationError"
  89. }
  90. }
  91. },
  92. "patch": {
  93. "consumes": [
  94. "application/json"
  95. ],
  96. "produces": [
  97. "application/json"
  98. ],
  99. "tags": [
  100. "admin"
  101. ],
  102. "summary": "Edit an existing user",
  103. "operationId": "adminEditUser",
  104. "parameters": [
  105. {
  106. "type": "string",
  107. "description": "username of user to edit",
  108. "name": "username",
  109. "in": "path",
  110. "required": true
  111. },
  112. {
  113. "name": "body",
  114. "in": "body",
  115. "schema": {
  116. "$ref": "#/definitions/EditUserOption"
  117. }
  118. }
  119. ],
  120. "responses": {
  121. "200": {
  122. "$ref": "#/responses/User"
  123. },
  124. "403": {
  125. "$ref": "#/responses/forbidden"
  126. },
  127. "422": {
  128. "$ref": "#/responses/validationError"
  129. }
  130. }
  131. }
  132. },
  133. "/admin/users/{username}/keys": {
  134. "post": {
  135. "consumes": [
  136. "application/json"
  137. ],
  138. "produces": [
  139. "application/json"
  140. ],
  141. "tags": [
  142. "admin"
  143. ],
  144. "summary": "Add a public key on behalf of a user",
  145. "operationId": "adminCreatePublicKey",
  146. "parameters": [
  147. {
  148. "type": "string",
  149. "description": "username of the user",
  150. "name": "username",
  151. "in": "path",
  152. "required": true
  153. }
  154. ],
  155. "responses": {
  156. "201": {
  157. "$ref": "#/responses/PublicKey"
  158. },
  159. "403": {
  160. "$ref": "#/responses/forbidden"
  161. },
  162. "422": {
  163. "$ref": "#/responses/validationError"
  164. }
  165. }
  166. }
  167. },
  168. "/admin/users/{username}/orgs": {
  169. "post": {
  170. "consumes": [
  171. "application/json"
  172. ],
  173. "produces": [
  174. "application/json"
  175. ],
  176. "tags": [
  177. "admin"
  178. ],
  179. "summary": "Create an organization",
  180. "operationId": "adminCreateOrg",
  181. "parameters": [
  182. {
  183. "type": "string",
  184. "description": "username of the user that will own the created organization",
  185. "name": "username",
  186. "in": "path",
  187. "required": true
  188. }
  189. ],
  190. "responses": {
  191. "201": {
  192. "$ref": "#/responses/Organization"
  193. },
  194. "403": {
  195. "$ref": "#/responses/forbidden"
  196. },
  197. "422": {
  198. "$ref": "#/responses/validationError"
  199. }
  200. }
  201. }
  202. },
  203. "/admin/users/{username}/repos": {
  204. "post": {
  205. "consumes": [
  206. "application/json"
  207. ],
  208. "produces": [
  209. "application/json"
  210. ],
  211. "tags": [
  212. "admin"
  213. ],
  214. "summary": "Create a repository on behalf a user",
  215. "operationId": "adminCreateRepo",
  216. "parameters": [
  217. {
  218. "type": "string",
  219. "description": "username of the user. This user will own the created repository",
  220. "name": "username",
  221. "in": "path",
  222. "required": true
  223. }
  224. ],
  225. "responses": {
  226. "201": {
  227. "$ref": "#/responses/Repository"
  228. },
  229. "403": {
  230. "$ref": "#/responses/forbidden"
  231. },
  232. "422": {
  233. "$ref": "#/responses/validationError"
  234. }
  235. }
  236. }
  237. },
  238. "/markdown": {
  239. "post": {
  240. "consumes": [
  241. "application/json"
  242. ],
  243. "produces": [
  244. "text/html"
  245. ],
  246. "tags": [
  247. "miscellaneous"
  248. ],
  249. "summary": "Render a markdown document as HTML",
  250. "operationId": "renderMarkdown",
  251. "parameters": [
  252. {
  253. "name": "body",
  254. "in": "body",
  255. "schema": {
  256. "$ref": "#/definitions/MarkdownOption"
  257. }
  258. }
  259. ],
  260. "responses": {
  261. "200": {
  262. "$ref": "#/responses/MarkdownRender"
  263. },
  264. "422": {
  265. "$ref": "#/responses/validationError"
  266. }
  267. }
  268. }
  269. },
  270. "/markdown/raw": {
  271. "post": {
  272. "consumes": [
  273. "text/plain"
  274. ],
  275. "produces": [
  276. "text/html"
  277. ],
  278. "tags": [
  279. "miscellaneous"
  280. ],
  281. "summary": "Render raw markdown as HTML",
  282. "operationId": "renderMarkdownRaw",
  283. "parameters": [
  284. {
  285. "type": "string",
  286. "name": "body",
  287. "in": "body"
  288. }
  289. ],
  290. "responses": {
  291. "200": {
  292. "$ref": "#/responses/MarkdownRender"
  293. },
  294. "422": {
  295. "$ref": "#/responses/validationError"
  296. }
  297. }
  298. }
  299. },
  300. "/org/{org}/repos": {
  301. "post": {
  302. "consumes": [
  303. "application/json"
  304. ],
  305. "produces": [
  306. "application/json"
  307. ],
  308. "tags": [
  309. "organization"
  310. ],
  311. "summary": "Create a repository in an organization",
  312. "operationId": "createOrgRepo",
  313. "parameters": [
  314. {
  315. "type": "string",
  316. "description": "name of organization",
  317. "name": "org",
  318. "in": "path",
  319. "required": true
  320. },
  321. {
  322. "name": "body",
  323. "in": "body",
  324. "schema": {
  325. "$ref": "#/definitions/CreateRepoOption"
  326. }
  327. }
  328. ],
  329. "responses": {
  330. "201": {
  331. "$ref": "#/responses/Repository"
  332. },
  333. "403": {
  334. "$ref": "#/responses/forbidden"
  335. },
  336. "422": {
  337. "$ref": "#/responses/validationError"
  338. }
  339. }
  340. }
  341. },
  342. "/orgs/{org}": {
  343. "get": {
  344. "produces": [
  345. "application/json"
  346. ],
  347. "tags": [
  348. "organization"
  349. ],
  350. "summary": "Get an organization",
  351. "operationId": "orgGet",
  352. "parameters": [
  353. {
  354. "type": "string",
  355. "description": "name of the organization to get",
  356. "name": "org",
  357. "in": "path",
  358. "required": true
  359. }
  360. ],
  361. "responses": {
  362. "200": {
  363. "$ref": "#/responses/Organization"
  364. }
  365. }
  366. },
  367. "patch": {
  368. "consumes": [
  369. "application/json"
  370. ],
  371. "produces": [
  372. "application/json"
  373. ],
  374. "tags": [
  375. "organization"
  376. ],
  377. "summary": "Edit an organization",
  378. "operationId": "orgEdit",
  379. "parameters": [
  380. {
  381. "type": "string",
  382. "description": "name of the organization to edit",
  383. "name": "org",
  384. "in": "path",
  385. "required": true
  386. },
  387. {
  388. "name": "body",
  389. "in": "body",
  390. "schema": {
  391. "$ref": "#/definitions/EditOrgOption"
  392. }
  393. }
  394. ],
  395. "responses": {
  396. "200": {
  397. "$ref": "#/responses/Organization"
  398. }
  399. }
  400. }
  401. },
  402. "/orgs/{org}/hooks": {
  403. "get": {
  404. "produces": [
  405. "application/json"
  406. ],
  407. "tags": [
  408. "organization"
  409. ],
  410. "summary": "List an organization's webhooks",
  411. "operationId": "orgListHooks",
  412. "responses": {
  413. "200": {
  414. "$ref": "#/responses/HookList"
  415. }
  416. }
  417. }
  418. },
  419. "/orgs/{org}/hooks/": {
  420. "post": {
  421. "consumes": [
  422. "application/json"
  423. ],
  424. "produces": [
  425. "application/json"
  426. ],
  427. "tags": [
  428. "organization"
  429. ],
  430. "summary": "Create a hook",
  431. "operationId": "orgCreateHook",
  432. "responses": {
  433. "201": {
  434. "$ref": "#/responses/Hook"
  435. }
  436. }
  437. }
  438. },
  439. "/orgs/{org}/hooks/{id}": {
  440. "get": {
  441. "produces": [
  442. "application/json"
  443. ],
  444. "tags": [
  445. "organization"
  446. ],
  447. "summary": "Get a hook",
  448. "operationId": "orgGetHook",
  449. "responses": {
  450. "200": {
  451. "$ref": "#/responses/Hook"
  452. }
  453. }
  454. },
  455. "delete": {
  456. "produces": [
  457. "application/json"
  458. ],
  459. "tags": [
  460. "organization"
  461. ],
  462. "summary": "Delete a hook",
  463. "operationId": "orgDeleteHook",
  464. "responses": {
  465. "204": {
  466. "$ref": "#/responses/empty"
  467. }
  468. }
  469. },
  470. "patch": {
  471. "consumes": [
  472. "application/json"
  473. ],
  474. "produces": [
  475. "application/json"
  476. ],
  477. "tags": [
  478. "organization"
  479. ],
  480. "summary": "Update a hook",
  481. "operationId": "orgEditHook",
  482. "responses": {
  483. "200": {
  484. "$ref": "#/responses/Hook"
  485. }
  486. }
  487. }
  488. },
  489. "/orgs/{org}/members": {
  490. "get": {
  491. "produces": [
  492. "application/json"
  493. ],
  494. "tags": [
  495. "organization"
  496. ],
  497. "summary": "List an organization's members",
  498. "operationId": "orgListMembers",
  499. "parameters": [
  500. {
  501. "type": "string",
  502. "description": "name of the organization",
  503. "name": "org",
  504. "in": "path",
  505. "required": true
  506. }
  507. ],
  508. "responses": {
  509. "200": {
  510. "$ref": "#/responses/UserList"
  511. }
  512. }
  513. }
  514. },
  515. "/orgs/{org}/members/{username}": {
  516. "get": {
  517. "tags": [
  518. "organization"
  519. ],
  520. "summary": "Check if a user is a member of an organization",
  521. "operationId": "orgIsMember",
  522. "parameters": [
  523. {
  524. "type": "string",
  525. "description": "name of the organization",
  526. "name": "org",
  527. "in": "path",
  528. "required": true
  529. },
  530. {
  531. "type": "string",
  532. "description": "username of the user",
  533. "name": "username",
  534. "in": "path",
  535. "required": true
  536. }
  537. ],
  538. "responses": {
  539. "204": {
  540. "description": "user is a member",
  541. "schema": {
  542. "$ref": "#/responses/empty"
  543. }
  544. },
  545. "404": {
  546. "description": "user is not a member",
  547. "schema": {
  548. "$ref": "#/responses/empty"
  549. }
  550. }
  551. }
  552. },
  553. "delete": {
  554. "produces": [
  555. "application/json"
  556. ],
  557. "tags": [
  558. "organization"
  559. ],
  560. "summary": "Remove a member from an organization",
  561. "operationId": "orgDeleteMember",
  562. "parameters": [
  563. {
  564. "type": "string",
  565. "description": "name of the organization",
  566. "name": "org",
  567. "in": "path",
  568. "required": true
  569. },
  570. {
  571. "type": "string",
  572. "description": "username of the user",
  573. "name": "username",
  574. "in": "path",
  575. "required": true
  576. }
  577. ],
  578. "responses": {
  579. "204": {
  580. "description": "member removed",
  581. "schema": {
  582. "$ref": "#/responses/empty"
  583. }
  584. }
  585. }
  586. }
  587. },
  588. "/orgs/{org}/public_members": {
  589. "get": {
  590. "produces": [
  591. "application/json"
  592. ],
  593. "tags": [
  594. "organization"
  595. ],
  596. "summary": "List an organization's public members",
  597. "operationId": "orgListPublicMembers",
  598. "parameters": [
  599. {
  600. "type": "string",
  601. "description": "name of the organization",
  602. "name": "org",
  603. "in": "path",
  604. "required": true
  605. }
  606. ],
  607. "responses": {
  608. "200": {
  609. "$ref": "#/responses/UserList"
  610. }
  611. }
  612. }
  613. },
  614. "/orgs/{org}/public_members/{username}": {
  615. "get": {
  616. "tags": [
  617. "organization"
  618. ],
  619. "summary": "Check if a user is a public member of an organization",
  620. "operationId": "orgIsPublicMember",
  621. "parameters": [
  622. {
  623. "type": "string",
  624. "description": "name of the organization",
  625. "name": "org",
  626. "in": "path",
  627. "required": true
  628. },
  629. {
  630. "type": "string",
  631. "description": "username of the user",
  632. "name": "username",
  633. "in": "path",
  634. "required": true
  635. }
  636. ],
  637. "responses": {
  638. "204": {
  639. "description": "user is a public member",
  640. "schema": {
  641. "$ref": "#/responses/empty"
  642. }
  643. },
  644. "404": {
  645. "description": "user is not a public member",
  646. "schema": {
  647. "$ref": "#/responses/empty"
  648. }
  649. }
  650. }
  651. },
  652. "put": {
  653. "produces": [
  654. "application/json"
  655. ],
  656. "tags": [
  657. "organization"
  658. ],
  659. "summary": "Publicize a user's membership",
  660. "operationId": "orgPublicizeMember",
  661. "parameters": [
  662. {
  663. "type": "string",
  664. "description": "name of the organization",
  665. "name": "org",
  666. "in": "path",
  667. "required": true
  668. },
  669. {
  670. "type": "string",
  671. "description": "username of the user",
  672. "name": "username",
  673. "in": "path",
  674. "required": true
  675. }
  676. ],
  677. "responses": {
  678. "204": {
  679. "description": "membership publicized",
  680. "schema": {
  681. "$ref": "#/responses/empty"
  682. }
  683. }
  684. }
  685. },
  686. "delete": {
  687. "produces": [
  688. "application/json"
  689. ],
  690. "tags": [
  691. "organization"
  692. ],
  693. "summary": "Conceal a user's membership",
  694. "operationId": "orgConcealMember",
  695. "parameters": [
  696. {
  697. "type": "string",
  698. "description": "name of the organization",
  699. "name": "org",
  700. "in": "path",
  701. "required": true
  702. },
  703. {
  704. "type": "string",
  705. "description": "username of the user",
  706. "name": "username",
  707. "in": "path",
  708. "required": true
  709. }
  710. ],
  711. "responses": {
  712. "204": {
  713. "$ref": "#/responses/empty"
  714. }
  715. }
  716. }
  717. },
  718. "/orgs/{org}/repos": {
  719. "get": {
  720. "produces": [
  721. "application/json"
  722. ],
  723. "tags": [
  724. "organization"
  725. ],
  726. "summary": "List an organization's repos",
  727. "operationId": "orgListRepos",
  728. "parameters": [
  729. {
  730. "type": "string",
  731. "description": "name of the organization",
  732. "name": "org",
  733. "in": "path",
  734. "required": true
  735. }
  736. ],
  737. "responses": {
  738. "200": {
  739. "$ref": "#/responses/RepositoryList"
  740. }
  741. }
  742. }
  743. },
  744. "/orgs/{org}/teams": {
  745. "get": {
  746. "produces": [
  747. "application/json"
  748. ],
  749. "tags": [
  750. "organization"
  751. ],
  752. "summary": "List an organization's teams",
  753. "operationId": "orgListTeams",
  754. "parameters": [
  755. {
  756. "type": "string",
  757. "description": "name of the organization",
  758. "name": "org",
  759. "in": "path",
  760. "required": true
  761. }
  762. ],
  763. "responses": {
  764. "200": {
  765. "$ref": "#/responses/TeamList"
  766. }
  767. }
  768. },
  769. "post": {
  770. "consumes": [
  771. "application/json"
  772. ],
  773. "produces": [
  774. "application/json"
  775. ],
  776. "tags": [
  777. "organization"
  778. ],
  779. "summary": "Create a team",
  780. "operationId": "orgCreateTeam",
  781. "parameters": [
  782. {
  783. "type": "string",
  784. "description": "name of the organization",
  785. "name": "org",
  786. "in": "path",
  787. "required": true
  788. },
  789. {
  790. "name": "body",
  791. "in": "body",
  792. "schema": {
  793. "$ref": "#/definitions/CreateTeamOption"
  794. }
  795. }
  796. ],
  797. "responses": {
  798. "201": {
  799. "$ref": "#/responses/Team"
  800. }
  801. }
  802. }
  803. },
  804. "/repos/migrate": {
  805. "post": {
  806. "consumes": [
  807. "application/json"
  808. ],
  809. "produces": [
  810. "application/json"
  811. ],
  812. "tags": [
  813. "repository"
  814. ],
  815. "summary": "Migrate a remote git repository",
  816. "operationId": "repoMigrate",
  817. "parameters": [
  818. {
  819. "name": "body",
  820. "in": "body",
  821. "schema": {
  822. "$ref": "#/definitions/MigrateRepoForm"
  823. }
  824. }
  825. ],
  826. "responses": {
  827. "201": {
  828. "$ref": "#/responses/Repository"
  829. }
  830. }
  831. }
  832. },
  833. "/repos/search": {
  834. "get": {
  835. "produces": [
  836. "application/json"
  837. ],
  838. "tags": [
  839. "repository"
  840. ],
  841. "summary": "Search for repositories",
  842. "operationId": "repoSearch",
  843. "parameters": [
  844. {
  845. "type": "string",
  846. "description": "keyword",
  847. "name": "q",
  848. "in": "query"
  849. },
  850. {
  851. "type": "integer",
  852. "description": "search only for repos that the user with the given id owns or contributes to",
  853. "name": "uid",
  854. "in": "query"
  855. },
  856. {
  857. "type": "integer",
  858. "description": "page number of results to return (1-based)",
  859. "name": "page",
  860. "in": "query"
  861. },
  862. {
  863. "type": "integer",
  864. "description": "page size of results, maximum page size is 50",
  865. "name": "limit",
  866. "in": "query"
  867. },
  868. {
  869. "type": "string",
  870. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  871. "name": "mode",
  872. "in": "query"
  873. },
  874. {
  875. "type": "boolean",
  876. "description": "if `uid` is given, search only for repos that the user owns",
  877. "name": "exclusive",
  878. "in": "query"
  879. }
  880. ],
  881. "responses": {
  882. "200": {
  883. "$ref": "#/responses/SearchResults"
  884. },
  885. "422": {
  886. "$ref": "#/responses/validationError"
  887. }
  888. }
  889. }
  890. },
  891. "/repos/{owner}/{repo}": {
  892. "get": {
  893. "produces": [
  894. "application/json"
  895. ],
  896. "tags": [
  897. "repository"
  898. ],
  899. "summary": "Get a repository",
  900. "operationId": "repoGet",
  901. "parameters": [
  902. {
  903. "type": "string",
  904. "description": "owner of the repo",
  905. "name": "owner",
  906. "in": "path",
  907. "required": true
  908. },
  909. {
  910. "type": "string",
  911. "description": "name of the repo",
  912. "name": "repo",
  913. "in": "path",
  914. "required": true
  915. }
  916. ],
  917. "responses": {
  918. "200": {
  919. "$ref": "#/responses/Repository"
  920. }
  921. }
  922. },
  923. "delete": {
  924. "produces": [
  925. "application/json"
  926. ],
  927. "tags": [
  928. "repository"
  929. ],
  930. "summary": "Delete a repository",
  931. "operationId": "repoDelete",
  932. "parameters": [
  933. {
  934. "type": "string",
  935. "description": "owner of the repo to delete",
  936. "name": "owner",
  937. "in": "path",
  938. "required": true
  939. },
  940. {
  941. "type": "string",
  942. "description": "name of the repo to delete",
  943. "name": "repo",
  944. "in": "path",
  945. "required": true
  946. }
  947. ],
  948. "responses": {
  949. "204": {
  950. "$ref": "#/responses/empty"
  951. },
  952. "403": {
  953. "$ref": "#/responses/forbidden"
  954. }
  955. }
  956. }
  957. },
  958. "/repos/{owner}/{repo}/archive/{filepath}": {
  959. "get": {
  960. "produces": [
  961. "application/json"
  962. ],
  963. "tags": [
  964. "repository"
  965. ],
  966. "summary": "Get an archive of a repository",
  967. "operationId": "repoGetArchive",
  968. "parameters": [
  969. {
  970. "type": "string",
  971. "description": "owner of the repo",
  972. "name": "owner",
  973. "in": "path",
  974. "required": true
  975. },
  976. {
  977. "type": "string",
  978. "description": "name of the repo",
  979. "name": "repo",
  980. "in": "path",
  981. "required": true
  982. },
  983. {
  984. "type": "string",
  985. "description": "archive to download, consisting of a git reference and archive",
  986. "name": "archive",
  987. "in": "path",
  988. "required": true
  989. }
  990. ],
  991. "responses": {
  992. "200": {}
  993. }
  994. }
  995. },
  996. "/repos/{owner}/{repo}/branches": {
  997. "get": {
  998. "produces": [
  999. "application/json"
  1000. ],
  1001. "tags": [
  1002. "repository"
  1003. ],
  1004. "summary": "List a repository's branches",
  1005. "operationId": "repoListBranches",
  1006. "parameters": [
  1007. {
  1008. "type": "string",
  1009. "description": "owner of the repo",
  1010. "name": "owner",
  1011. "in": "path",
  1012. "required": true
  1013. },
  1014. {
  1015. "type": "string",
  1016. "description": "name of the repo",
  1017. "name": "repo",
  1018. "in": "path",
  1019. "required": true
  1020. }
  1021. ],
  1022. "responses": {
  1023. "200": {
  1024. "$ref": "#/responses/BranchList"
  1025. }
  1026. }
  1027. }
  1028. },
  1029. "/repos/{owner}/{repo}/branches/{branch}": {
  1030. "get": {
  1031. "produces": [
  1032. "application/json"
  1033. ],
  1034. "tags": [
  1035. "repository"
  1036. ],
  1037. "summary": "List a repository's branches",
  1038. "operationId": "repoGetBranch",
  1039. "parameters": [
  1040. {
  1041. "type": "string",
  1042. "description": "owner of the repo",
  1043. "name": "owner",
  1044. "in": "path",
  1045. "required": true
  1046. },
  1047. {
  1048. "type": "string",
  1049. "description": "name of the repo",
  1050. "name": "repo",
  1051. "in": "path",
  1052. "required": true
  1053. },
  1054. {
  1055. "type": "string",
  1056. "description": "branch to get",
  1057. "name": "branch",
  1058. "in": "path",
  1059. "required": true
  1060. }
  1061. ],
  1062. "responses": {
  1063. "200": {
  1064. "$ref": "#/responses/Branch"
  1065. }
  1066. }
  1067. }
  1068. },
  1069. "/repos/{owner}/{repo}/collaborators": {
  1070. "get": {
  1071. "produces": [
  1072. "application/json"
  1073. ],
  1074. "tags": [
  1075. "repository"
  1076. ],
  1077. "summary": "List a repository's collaborators",
  1078. "operationId": "repoListCollaborators",
  1079. "parameters": [
  1080. {
  1081. "type": "string",
  1082. "description": "owner of the repo",
  1083. "name": "owner",
  1084. "in": "path",
  1085. "required": true
  1086. },
  1087. {
  1088. "type": "string",
  1089. "description": "name of the repo",
  1090. "name": "repo",
  1091. "in": "path",
  1092. "required": true
  1093. }
  1094. ],
  1095. "responses": {
  1096. "200": {
  1097. "$ref": "#/responses/UserList"
  1098. }
  1099. }
  1100. }
  1101. },
  1102. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  1103. "get": {
  1104. "produces": [
  1105. "application/json"
  1106. ],
  1107. "tags": [
  1108. "repository"
  1109. ],
  1110. "summary": "Check if a user is a collaborator of a repository",
  1111. "operationId": "repoCheckCollaborator",
  1112. "parameters": [
  1113. {
  1114. "type": "string",
  1115. "description": "owner of the repo",
  1116. "name": "owner",
  1117. "in": "path",
  1118. "required": true
  1119. },
  1120. {
  1121. "type": "string",
  1122. "description": "name of the repo",
  1123. "name": "repo",
  1124. "in": "path",
  1125. "required": true
  1126. },
  1127. {
  1128. "type": "string",
  1129. "description": "username of the collaborator",
  1130. "name": "collaborator",
  1131. "in": "path",
  1132. "required": true
  1133. }
  1134. ],
  1135. "responses": {
  1136. "204": {
  1137. "$ref": "#/responses/empty"
  1138. },
  1139. "404": {
  1140. "$ref": "#/responses/empty"
  1141. }
  1142. }
  1143. },
  1144. "put": {
  1145. "produces": [
  1146. "application/json"
  1147. ],
  1148. "tags": [
  1149. "repository"
  1150. ],
  1151. "summary": "Add a collaborator to a repository",
  1152. "operationId": "repoAddCollaborator",
  1153. "parameters": [
  1154. {
  1155. "type": "string",
  1156. "description": "owner of the repo",
  1157. "name": "owner",
  1158. "in": "path",
  1159. "required": true
  1160. },
  1161. {
  1162. "type": "string",
  1163. "description": "name of the repo",
  1164. "name": "repo",
  1165. "in": "path",
  1166. "required": true
  1167. },
  1168. {
  1169. "type": "string",
  1170. "description": "username of the collaborator to add",
  1171. "name": "collaborator",
  1172. "in": "path",
  1173. "required": true
  1174. },
  1175. {
  1176. "name": "body",
  1177. "in": "body",
  1178. "schema": {
  1179. "$ref": "#/definitions/AddCollaboratorOption"
  1180. }
  1181. }
  1182. ],
  1183. "responses": {
  1184. "204": {
  1185. "$ref": "#/responses/empty"
  1186. }
  1187. }
  1188. },
  1189. "delete": {
  1190. "produces": [
  1191. "application/json"
  1192. ],
  1193. "tags": [
  1194. "repository"
  1195. ],
  1196. "summary": "Delete a collaborator from a repository",
  1197. "operationId": "repoDeleteCollaborator",
  1198. "parameters": [
  1199. {
  1200. "type": "string",
  1201. "description": "owner of the repo",
  1202. "name": "owner",
  1203. "in": "path",
  1204. "required": true
  1205. },
  1206. {
  1207. "type": "string",
  1208. "description": "name of the repo",
  1209. "name": "repo",
  1210. "in": "path",
  1211. "required": true
  1212. },
  1213. {
  1214. "type": "string",
  1215. "description": "username of the collaborator to delete",
  1216. "name": "collaborator",
  1217. "in": "path",
  1218. "required": true
  1219. }
  1220. ],
  1221. "responses": {
  1222. "204": {
  1223. "$ref": "#/responses/empty"
  1224. }
  1225. }
  1226. }
  1227. },
  1228. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  1229. "get": {
  1230. "produces": [
  1231. "application/json"
  1232. ],
  1233. "tags": [
  1234. "repository"
  1235. ],
  1236. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  1237. "operationId": "repoGetCombinedStatusByRef",
  1238. "parameters": [
  1239. {
  1240. "type": "string",
  1241. "description": "owner of the repo",
  1242. "name": "owner",
  1243. "in": "path",
  1244. "required": true
  1245. },
  1246. {
  1247. "type": "string",
  1248. "description": "name of the repo",
  1249. "name": "repo",
  1250. "in": "path",
  1251. "required": true
  1252. },
  1253. {
  1254. "type": "string",
  1255. "description": "name of branch/tag/commit",
  1256. "name": "ref",
  1257. "in": "path",
  1258. "required": true
  1259. }
  1260. ],
  1261. "responses": {
  1262. "200": {
  1263. "$ref": "#/responses/Status"
  1264. }
  1265. }
  1266. }
  1267. },
  1268. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  1269. "get": {
  1270. "produces": [
  1271. "application/json"
  1272. ],
  1273. "tags": [
  1274. "repository"
  1275. ],
  1276. "summary": "Get the EditorConfig definitions of a file in a repository",
  1277. "operationId": "repoGetEditorConfig",
  1278. "parameters": [
  1279. {
  1280. "type": "string",
  1281. "description": "owner of the repo",
  1282. "name": "owner",
  1283. "in": "path",
  1284. "required": true
  1285. },
  1286. {
  1287. "type": "string",
  1288. "description": "name of the repo",
  1289. "name": "repo",
  1290. "in": "path",
  1291. "required": true
  1292. },
  1293. {
  1294. "type": "string",
  1295. "description": "filepath of file to get",
  1296. "name": "filepath",
  1297. "in": "path",
  1298. "required": true
  1299. }
  1300. ],
  1301. "responses": {
  1302. "200": {}
  1303. }
  1304. }
  1305. },
  1306. "/repos/{owner}/{repo}/forks": {
  1307. "get": {
  1308. "produces": [
  1309. "application/json"
  1310. ],
  1311. "tags": [
  1312. "repository"
  1313. ],
  1314. "summary": "List a repository's forks",
  1315. "operationId": "listForks",
  1316. "parameters": [
  1317. {
  1318. "type": "string",
  1319. "description": "owner of the repo",
  1320. "name": "owner",
  1321. "in": "path",
  1322. "required": true
  1323. },
  1324. {
  1325. "type": "string",
  1326. "description": "name of the repo",
  1327. "name": "repo",
  1328. "in": "path",
  1329. "required": true
  1330. }
  1331. ],
  1332. "responses": {
  1333. "200": {
  1334. "$ref": "#/responses/RepositoryList"
  1335. }
  1336. }
  1337. },
  1338. "post": {
  1339. "produces": [
  1340. "application/json"
  1341. ],
  1342. "tags": [
  1343. "repository"
  1344. ],
  1345. "summary": "Fork a repository",
  1346. "operationId": "createFork",
  1347. "parameters": [
  1348. {
  1349. "type": "string",
  1350. "description": "owner of the repo to fork",
  1351. "name": "owner",
  1352. "in": "path",
  1353. "required": true
  1354. },
  1355. {
  1356. "type": "string",
  1357. "description": "name of the repo to fork",
  1358. "name": "repo",
  1359. "in": "path",
  1360. "required": true
  1361. },
  1362. {
  1363. "name": "body",
  1364. "in": "body",
  1365. "schema": {
  1366. "$ref": "#/definitions/CreateForkOption"
  1367. }
  1368. }
  1369. ],
  1370. "responses": {
  1371. "202": {
  1372. "$ref": "#/responses/Repository"
  1373. }
  1374. }
  1375. }
  1376. },
  1377. "/repos/{owner}/{repo}/hooks": {
  1378. "get": {
  1379. "produces": [
  1380. "application/json"
  1381. ],
  1382. "tags": [
  1383. "repository"
  1384. ],
  1385. "summary": "List the hooks in a repository",
  1386. "operationId": "repoListHooks",
  1387. "parameters": [
  1388. {
  1389. "type": "string",
  1390. "description": "owner of the repo",
  1391. "name": "owner",
  1392. "in": "path",
  1393. "required": true
  1394. },
  1395. {
  1396. "type": "string",
  1397. "description": "name of the repo",
  1398. "name": "repo",
  1399. "in": "path",
  1400. "required": true
  1401. }
  1402. ],
  1403. "responses": {
  1404. "200": {
  1405. "$ref": "#/responses/HookList"
  1406. }
  1407. }
  1408. },
  1409. "post": {
  1410. "consumes": [
  1411. "application/json"
  1412. ],
  1413. "produces": [
  1414. "application/json"
  1415. ],
  1416. "tags": [
  1417. "repository"
  1418. ],
  1419. "summary": "Create a hook",
  1420. "operationId": "repoCreateHook",
  1421. "parameters": [
  1422. {
  1423. "type": "string",
  1424. "description": "owner of the repo",
  1425. "name": "owner",
  1426. "in": "path",
  1427. "required": true
  1428. },
  1429. {
  1430. "type": "string",
  1431. "description": "name of the repo",
  1432. "name": "repo",
  1433. "in": "path",
  1434. "required": true
  1435. },
  1436. {
  1437. "name": "body",
  1438. "in": "body",
  1439. "schema": {
  1440. "$ref": "#/definitions/CreateHookOption"
  1441. }
  1442. }
  1443. ],
  1444. "responses": {
  1445. "201": {
  1446. "$ref": "#/responses/Hook"
  1447. }
  1448. }
  1449. }
  1450. },
  1451. "/repos/{owner}/{repo}/hooks/{id}": {
  1452. "get": {
  1453. "produces": [
  1454. "application/json"
  1455. ],
  1456. "tags": [
  1457. "repository"
  1458. ],
  1459. "summary": "Get a hook",
  1460. "operationId": "repoGetHook",
  1461. "parameters": [
  1462. {
  1463. "type": "string",
  1464. "description": "owner of the repo",
  1465. "name": "owner",
  1466. "in": "path",
  1467. "required": true
  1468. },
  1469. {
  1470. "type": "string",
  1471. "description": "name of the repo",
  1472. "name": "repo",
  1473. "in": "path",
  1474. "required": true
  1475. },
  1476. {
  1477. "type": "integer",
  1478. "description": "id of the hook to get",
  1479. "name": "id",
  1480. "in": "path",
  1481. "required": true
  1482. }
  1483. ],
  1484. "responses": {
  1485. "200": {
  1486. "$ref": "#/responses/Hook"
  1487. }
  1488. }
  1489. },
  1490. "patch": {
  1491. "produces": [
  1492. "application/json"
  1493. ],
  1494. "tags": [
  1495. "repository"
  1496. ],
  1497. "summary": "Edit a hook in a repository",
  1498. "operationId": "repoEditHook",
  1499. "parameters": [
  1500. {
  1501. "type": "string",
  1502. "description": "owner of the repo",
  1503. "name": "owner",
  1504. "in": "path",
  1505. "required": true
  1506. },
  1507. {
  1508. "type": "string",
  1509. "description": "name of the repo",
  1510. "name": "repo",
  1511. "in": "path",
  1512. "required": true
  1513. },
  1514. {
  1515. "name": "body",
  1516. "in": "body",
  1517. "schema": {
  1518. "$ref": "#/definitions/EditHookOption"
  1519. }
  1520. }
  1521. ],
  1522. "responses": {
  1523. "200": {
  1524. "$ref": "#/responses/Hook"
  1525. }
  1526. }
  1527. }
  1528. },
  1529. "/repos/{owner}/{repo}/issue/{index}/comments": {
  1530. "get": {
  1531. "produces": [
  1532. "application/json"
  1533. ],
  1534. "tags": [
  1535. "issue"
  1536. ],
  1537. "summary": "List all comments on an issue",
  1538. "operationId": "issueGetComments",
  1539. "parameters": [
  1540. {
  1541. "type": "string",
  1542. "description": "owner of the repo",
  1543. "name": "owner",
  1544. "in": "path",
  1545. "required": true
  1546. },
  1547. {
  1548. "type": "string",
  1549. "description": "name of the repo",
  1550. "name": "repo",
  1551. "in": "path",
  1552. "required": true
  1553. },
  1554. {
  1555. "type": "integer",
  1556. "description": "index of the issue",
  1557. "name": "id",
  1558. "in": "path",
  1559. "required": true
  1560. },
  1561. {
  1562. "type": "string",
  1563. "description": "if provided, only comments updated since the specified time are returned.",
  1564. "name": "string",
  1565. "in": "query"
  1566. }
  1567. ],
  1568. "responses": {
  1569. "200": {
  1570. "$ref": "#/responses/CommentList"
  1571. }
  1572. }
  1573. }
  1574. },
  1575. "/repos/{owner}/{repo}/issue/{index}/labels": {
  1576. "put": {
  1577. "consumes": [
  1578. "application/json"
  1579. ],
  1580. "produces": [
  1581. "application/json"
  1582. ],
  1583. "tags": [
  1584. "issue"
  1585. ],
  1586. "summary": "Replace an issue's labels",
  1587. "operationId": "issueReplaceLabels",
  1588. "parameters": [
  1589. {
  1590. "type": "string",
  1591. "description": "owner of the repo",
  1592. "name": "owner",
  1593. "in": "path",
  1594. "required": true
  1595. },
  1596. {
  1597. "type": "string",
  1598. "description": "name of the repo",
  1599. "name": "repo",
  1600. "in": "path",
  1601. "required": true
  1602. },
  1603. {
  1604. "type": "integer",
  1605. "description": "index of the issue",
  1606. "name": "index",
  1607. "in": "path",
  1608. "required": true
  1609. },
  1610. {
  1611. "name": "body",
  1612. "in": "body",
  1613. "schema": {
  1614. "$ref": "#/definitions/IssueLabelsOption"
  1615. }
  1616. }
  1617. ],
  1618. "responses": {
  1619. "200": {
  1620. "$ref": "#/responses/LabelList"
  1621. }
  1622. }
  1623. },
  1624. "post": {
  1625. "consumes": [
  1626. "application/json"
  1627. ],
  1628. "produces": [
  1629. "application/json"
  1630. ],
  1631. "tags": [
  1632. "issue"
  1633. ],
  1634. "summary": "Add a label to an issue",
  1635. "operationId": "issueAddLabel",
  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": "integer",
  1653. "description": "index of the issue",
  1654. "name": "index",
  1655. "in": "path",
  1656. "required": true
  1657. },
  1658. {
  1659. "name": "body",
  1660. "in": "body",
  1661. "schema": {
  1662. "$ref": "#/definitions/IssueLabelsOption"
  1663. }
  1664. }
  1665. ],
  1666. "responses": {
  1667. "200": {
  1668. "$ref": "#/responses/LabelList"
  1669. }
  1670. }
  1671. },
  1672. "delete": {
  1673. "produces": [
  1674. "application/json"
  1675. ],
  1676. "tags": [
  1677. "issue"
  1678. ],
  1679. "summary": "Remove all labels from an issue",
  1680. "operationId": "issueClearLabels",
  1681. "parameters": [
  1682. {
  1683. "type": "string",
  1684. "description": "owner of the repo",
  1685. "name": "owner",
  1686. "in": "path",
  1687. "required": true
  1688. },
  1689. {
  1690. "type": "string",
  1691. "description": "name of the repo",
  1692. "name": "repo",
  1693. "in": "path",
  1694. "required": true
  1695. },
  1696. {
  1697. "type": "integer",
  1698. "description": "index of the issue",
  1699. "name": "index",
  1700. "in": "path",
  1701. "required": true
  1702. }
  1703. ],
  1704. "responses": {
  1705. "204": {
  1706. "$ref": "#/responses/empty"
  1707. }
  1708. }
  1709. }
  1710. },
  1711. "/repos/{owner}/{repo}/issue/{index}/labels/{id}": {
  1712. "delete": {
  1713. "produces": [
  1714. "application/json"
  1715. ],
  1716. "tags": [
  1717. "issue"
  1718. ],
  1719. "summary": "Remove a label from an issue",
  1720. "operationId": "issueRemoveLabel",
  1721. "parameters": [
  1722. {
  1723. "type": "string",
  1724. "description": "owner of the repo",
  1725. "name": "owner",
  1726. "in": "path",
  1727. "required": true
  1728. },
  1729. {
  1730. "type": "string",
  1731. "description": "name of the repo",
  1732. "name": "repo",
  1733. "in": "path",
  1734. "required": true
  1735. },
  1736. {
  1737. "type": "integer",
  1738. "description": "index of the issue",
  1739. "name": "index",
  1740. "in": "path",
  1741. "required": true
  1742. },
  1743. {
  1744. "type": "integer",
  1745. "description": "id of the label to remove",
  1746. "name": "id",
  1747. "in": "path",
  1748. "required": true
  1749. }
  1750. ],
  1751. "responses": {
  1752. "204": {
  1753. "$ref": "#/responses/empty"
  1754. }
  1755. }
  1756. }
  1757. },
  1758. "/repos/{owner}/{repo}/issues": {
  1759. "get": {
  1760. "produces": [
  1761. "application/json"
  1762. ],
  1763. "tags": [
  1764. "issue"
  1765. ],
  1766. "summary": "List a repository's issues",
  1767. "operationId": "issueListIssues",
  1768. "parameters": [
  1769. {
  1770. "type": "string",
  1771. "description": "owner of the repo",
  1772. "name": "owner",
  1773. "in": "path",
  1774. "required": true
  1775. },
  1776. {
  1777. "type": "string",
  1778. "description": "name of the repo",
  1779. "name": "repo",
  1780. "in": "path",
  1781. "required": true
  1782. },
  1783. {
  1784. "type": "string",
  1785. "description": "whether issue is open or closed",
  1786. "name": "state",
  1787. "in": "query"
  1788. },
  1789. {
  1790. "type": "integer",
  1791. "description": "page number of requested issues",
  1792. "name": "page",
  1793. "in": "query"
  1794. }
  1795. ],
  1796. "responses": {
  1797. "200": {
  1798. "$ref": "#/responses/IssueList"
  1799. }
  1800. }
  1801. },
  1802. "post": {
  1803. "consumes": [
  1804. "application/json"
  1805. ],
  1806. "produces": [
  1807. "application/json"
  1808. ],
  1809. "tags": [
  1810. "issue"
  1811. ],
  1812. "summary": "Create an issue",
  1813. "operationId": "issueCreateIssue",
  1814. "parameters": [
  1815. {
  1816. "type": "string",
  1817. "description": "owner of the repo",
  1818. "name": "owner",
  1819. "in": "path",
  1820. "required": true
  1821. },
  1822. {
  1823. "type": "string",
  1824. "description": "name of the repo",
  1825. "name": "repo",
  1826. "in": "path",
  1827. "required": true
  1828. },
  1829. {
  1830. "name": "body",
  1831. "in": "body",
  1832. "schema": {
  1833. "$ref": "#/definitions/CreateIssueOption"
  1834. }
  1835. }
  1836. ],
  1837. "responses": {
  1838. "201": {
  1839. "$ref": "#/responses/Issue"
  1840. }
  1841. }
  1842. }
  1843. },
  1844. "/repos/{owner}/{repo}/issues/comments": {
  1845. "get": {
  1846. "produces": [
  1847. "application/json"
  1848. ],
  1849. "tags": [
  1850. "issue"
  1851. ],
  1852. "summary": "List all comments in a repository",
  1853. "operationId": "issueGetRepoComments",
  1854. "parameters": [
  1855. {
  1856. "type": "string",
  1857. "description": "owner of the repo",
  1858. "name": "owner",
  1859. "in": "path",
  1860. "required": true
  1861. },
  1862. {
  1863. "type": "string",
  1864. "description": "name of the repo",
  1865. "name": "repo",
  1866. "in": "path",
  1867. "required": true
  1868. },
  1869. {
  1870. "type": "string",
  1871. "description": "if provided, only comments updated since the provided time are returned.",
  1872. "name": "string",
  1873. "in": "query"
  1874. }
  1875. ],
  1876. "responses": {
  1877. "200": {
  1878. "$ref": "#/responses/CommentList"
  1879. }
  1880. }
  1881. }
  1882. },
  1883. "/repos/{owner}/{repo}/issues/comments/{id}": {
  1884. "delete": {
  1885. "tags": [
  1886. "issue"
  1887. ],
  1888. "summary": "Delete a comment",
  1889. "operationId": "issueDeleteComment",
  1890. "parameters": [
  1891. {
  1892. "type": "string",
  1893. "description": "owner of the repo",
  1894. "name": "owner",
  1895. "in": "path",
  1896. "required": true
  1897. },
  1898. {
  1899. "type": "string",
  1900. "description": "name of the repo",
  1901. "name": "repo",
  1902. "in": "path",
  1903. "required": true
  1904. },
  1905. {
  1906. "type": "integer",
  1907. "description": "id of comment to delete",
  1908. "name": "id",
  1909. "in": "path",
  1910. "required": true
  1911. }
  1912. ],
  1913. "responses": {
  1914. "204": {
  1915. "$ref": "#/responses/empty"
  1916. }
  1917. }
  1918. },
  1919. "patch": {
  1920. "consumes": [
  1921. "application/json"
  1922. ],
  1923. "produces": [
  1924. "application/json"
  1925. ],
  1926. "tags": [
  1927. "issue"
  1928. ],
  1929. "summary": "Edit a comment",
  1930. "operationId": "issueEditComment",
  1931. "parameters": [
  1932. {
  1933. "type": "string",
  1934. "description": "owner of the repo",
  1935. "name": "owner",
  1936. "in": "path",
  1937. "required": true
  1938. },
  1939. {
  1940. "type": "string",
  1941. "description": "name of the repo",
  1942. "name": "repo",
  1943. "in": "path",
  1944. "required": true
  1945. },
  1946. {
  1947. "type": "integer",
  1948. "description": "id of the comment to edit",
  1949. "name": "id",
  1950. "in": "path",
  1951. "required": true
  1952. },
  1953. {
  1954. "name": "body",
  1955. "in": "body",
  1956. "schema": {
  1957. "$ref": "#/definitions/EditIssueCommentOption"
  1958. }
  1959. }
  1960. ],
  1961. "responses": {
  1962. "200": {
  1963. "$ref": "#/responses/Comment"
  1964. }
  1965. }
  1966. }
  1967. },
  1968. "/repos/{owner}/{repo}/issues/{id}": {
  1969. "get": {
  1970. "produces": [
  1971. "application/json"
  1972. ],
  1973. "tags": [
  1974. "issue"
  1975. ],
  1976. "summary": "Get an issue by id",
  1977. "operationId": "issueGetIssue",
  1978. "parameters": [
  1979. {
  1980. "type": "string",
  1981. "description": "owner of the repo",
  1982. "name": "owner",
  1983. "in": "path",
  1984. "required": true
  1985. },
  1986. {
  1987. "type": "string",
  1988. "description": "name of the repo",
  1989. "name": "repo",
  1990. "in": "path",
  1991. "required": true
  1992. },
  1993. {
  1994. "type": "integer",
  1995. "description": "id of the issue to get",
  1996. "name": "id",
  1997. "in": "path",
  1998. "required": true
  1999. }
  2000. ],
  2001. "responses": {
  2002. "200": {
  2003. "$ref": "#/responses/Issue"
  2004. }
  2005. }
  2006. },
  2007. "patch": {
  2008. "consumes": [
  2009. "application/json"
  2010. ],
  2011. "produces": [
  2012. "application/json"
  2013. ],
  2014. "tags": [
  2015. "issue"
  2016. ],
  2017. "summary": "Edit an issue",
  2018. "operationId": "issueEditIssue",
  2019. "parameters": [
  2020. {
  2021. "type": "string",
  2022. "description": "owner of the repo",
  2023. "name": "owner",
  2024. "in": "path",
  2025. "required": true
  2026. },
  2027. {
  2028. "type": "string",
  2029. "description": "name of the repo",
  2030. "name": "repo",
  2031. "in": "path",
  2032. "required": true
  2033. },
  2034. {
  2035. "type": "integer",
  2036. "description": "id of the issue to edit",
  2037. "name": "id",
  2038. "in": "path",
  2039. "required": true
  2040. },
  2041. {
  2042. "name": "body",
  2043. "in": "body",
  2044. "schema": {
  2045. "$ref": "#/definitions/EditIssueOption"
  2046. }
  2047. }
  2048. ],
  2049. "responses": {
  2050. "201": {
  2051. "$ref": "#/responses/Issue"
  2052. }
  2053. }
  2054. }
  2055. },
  2056. "/repos/{owner}/{repo}/issues/{index}/comments": {
  2057. "post": {
  2058. "consumes": [
  2059. "application/json"
  2060. ],
  2061. "produces": [
  2062. "application/json"
  2063. ],
  2064. "tags": [
  2065. "issue"
  2066. ],
  2067. "summary": "Add a comment to an issue",
  2068. "operationId": "issueCreateComment",
  2069. "parameters": [
  2070. {
  2071. "type": "string",
  2072. "description": "owner of the repo",
  2073. "name": "owner",
  2074. "in": "path",
  2075. "required": true
  2076. },
  2077. {
  2078. "type": "string",
  2079. "description": "name of the repo",
  2080. "name": "repo",
  2081. "in": "path",
  2082. "required": true
  2083. },
  2084. {
  2085. "type": "integer",
  2086. "description": "index of the issue",
  2087. "name": "id",
  2088. "in": "path",
  2089. "required": true
  2090. },
  2091. {
  2092. "name": "body",
  2093. "in": "body",
  2094. "schema": {
  2095. "$ref": "#/definitions/CreateIssueOption"
  2096. }
  2097. }
  2098. ],
  2099. "responses": {
  2100. "201": {
  2101. "$ref": "#/responses/Comment"
  2102. }
  2103. }
  2104. }
  2105. },
  2106. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  2107. "delete": {
  2108. "tags": [
  2109. "issue"
  2110. ],
  2111. "summary": "Delete a comment",
  2112. "operationId": "issueDeleteCommentDeprecated",
  2113. "deprecated": true,
  2114. "parameters": [
  2115. {
  2116. "type": "string",
  2117. "description": "owner of the repo",
  2118. "name": "owner",
  2119. "in": "path",
  2120. "required": true
  2121. },
  2122. {
  2123. "type": "string",
  2124. "description": "name of the repo",
  2125. "name": "repo",
  2126. "in": "path",
  2127. "required": true
  2128. },
  2129. {
  2130. "type": "integer",
  2131. "description": "this parameter is ignored",
  2132. "name": "index",
  2133. "in": "path",
  2134. "required": true
  2135. },
  2136. {
  2137. "type": "integer",
  2138. "description": "id of comment to delete",
  2139. "name": "id",
  2140. "in": "path",
  2141. "required": true
  2142. }
  2143. ],
  2144. "responses": {
  2145. "204": {
  2146. "$ref": "#/responses/empty"
  2147. }
  2148. }
  2149. },
  2150. "patch": {
  2151. "consumes": [
  2152. "application/json"
  2153. ],
  2154. "produces": [
  2155. "application/json"
  2156. ],
  2157. "tags": [
  2158. "issue"
  2159. ],
  2160. "summary": "Edit a comment",
  2161. "operationId": "issueEditCommentDeprecated",
  2162. "deprecated": true,
  2163. "parameters": [
  2164. {
  2165. "type": "string",
  2166. "description": "owner of the repo",
  2167. "name": "owner",
  2168. "in": "path",
  2169. "required": true
  2170. },
  2171. {
  2172. "type": "string",
  2173. "description": "name of the repo",
  2174. "name": "repo",
  2175. "in": "path",
  2176. "required": true
  2177. },
  2178. {
  2179. "type": "integer",
  2180. "description": "this parameter is ignored",
  2181. "name": "index",
  2182. "in": "path",
  2183. "required": true
  2184. },
  2185. {
  2186. "type": "integer",
  2187. "description": "id of the comment to edit",
  2188. "name": "id",
  2189. "in": "path",
  2190. "required": true
  2191. },
  2192. {
  2193. "name": "body",
  2194. "in": "body",
  2195. "schema": {
  2196. "$ref": "#/definitions/EditIssueCommentOption"
  2197. }
  2198. }
  2199. ],
  2200. "responses": {
  2201. "200": {
  2202. "$ref": "#/responses/Comment"
  2203. }
  2204. }
  2205. }
  2206. },
  2207. "/repos/{owner}/{repo}/issues/{index}/labels": {
  2208. "get": {
  2209. "produces": [
  2210. "application/json"
  2211. ],
  2212. "tags": [
  2213. "issue"
  2214. ],
  2215. "summary": "Get an issue's labels",
  2216. "operationId": "issueGetLabels",
  2217. "parameters": [
  2218. {
  2219. "type": "string",
  2220. "description": "owner of the repo",
  2221. "name": "owner",
  2222. "in": "path",
  2223. "required": true
  2224. },
  2225. {
  2226. "type": "string",
  2227. "description": "name of the repo",
  2228. "name": "repo",
  2229. "in": "path",
  2230. "required": true
  2231. },
  2232. {
  2233. "type": "integer",
  2234. "description": "index of the issue",
  2235. "name": "index",
  2236. "in": "path",
  2237. "required": true
  2238. }
  2239. ],
  2240. "responses": {
  2241. "200": {
  2242. "$ref": "#/responses/LabelList"
  2243. },
  2244. "404": {
  2245. "$ref": "#/responses/notFound"
  2246. }
  2247. }
  2248. }
  2249. },
  2250. "/repos/{owner}/{repo}/issues/{index}/times": {
  2251. "get": {
  2252. "produces": [
  2253. "application/json"
  2254. ],
  2255. "tags": [
  2256. "issue"
  2257. ],
  2258. "summary": "List an issue's tracked times",
  2259. "operationId": "issueTrackedTimes",
  2260. "parameters": [
  2261. {
  2262. "type": "string",
  2263. "description": "owner of the repo",
  2264. "name": "owner",
  2265. "in": "path",
  2266. "required": true
  2267. },
  2268. {
  2269. "type": "string",
  2270. "description": "name of the repo",
  2271. "name": "repo",
  2272. "in": "path",
  2273. "required": true
  2274. },
  2275. {
  2276. "type": "integer",
  2277. "description": "index of the issue",
  2278. "name": "repo",
  2279. "in": "path",
  2280. "required": true
  2281. }
  2282. ],
  2283. "responses": {
  2284. "200": {
  2285. "$ref": "#/responses/TrackedTimeList"
  2286. }
  2287. }
  2288. },
  2289. "post": {
  2290. "consumes": [
  2291. "application/json"
  2292. ],
  2293. "produces": [
  2294. "application/json"
  2295. ],
  2296. "tags": [
  2297. "issue"
  2298. ],
  2299. "summary": "Add a tracked time to a issue",
  2300. "operationId": "issueAddTime",
  2301. "parameters": [
  2302. {
  2303. "type": "string",
  2304. "description": "owner of the repo",
  2305. "name": "owner",
  2306. "in": "path",
  2307. "required": true
  2308. },
  2309. {
  2310. "type": "string",
  2311. "description": "name of the repo",
  2312. "name": "repo",
  2313. "in": "path",
  2314. "required": true
  2315. },
  2316. {
  2317. "type": "integer",
  2318. "description": "index of the issue to add tracked time to",
  2319. "name": "id",
  2320. "in": "path",
  2321. "required": true
  2322. },
  2323. {
  2324. "name": "body",
  2325. "in": "body",
  2326. "schema": {
  2327. "$ref": "#/definitions/AddTimeOption"
  2328. }
  2329. }
  2330. ],
  2331. "responses": {
  2332. "200": {
  2333. "$ref": "#/responses/TrackedTime"
  2334. },
  2335. "400": {
  2336. "$ref": "#/responses/error"
  2337. },
  2338. "403": {
  2339. "$ref": "#/responses/error"
  2340. }
  2341. }
  2342. }
  2343. },
  2344. "/repos/{owner}/{repo}/keys": {
  2345. "get": {
  2346. "produces": [
  2347. "application/json"
  2348. ],
  2349. "tags": [
  2350. "repository"
  2351. ],
  2352. "summary": "List a repository's keys",
  2353. "operationId": "repoListKeys",
  2354. "parameters": [
  2355. {
  2356. "type": "string",
  2357. "description": "owner of the repo",
  2358. "name": "owner",
  2359. "in": "path",
  2360. "required": true
  2361. },
  2362. {
  2363. "type": "string",
  2364. "description": "name of the repo",
  2365. "name": "repo",
  2366. "in": "path",
  2367. "required": true
  2368. }
  2369. ],
  2370. "responses": {
  2371. "200": {
  2372. "$ref": "#/responses/DeployKeyList"
  2373. }
  2374. }
  2375. },
  2376. "post": {
  2377. "consumes": [
  2378. "application/json"
  2379. ],
  2380. "produces": [
  2381. "application/json"
  2382. ],
  2383. "tags": [
  2384. "repository"
  2385. ],
  2386. "summary": "Add a key to a repository",
  2387. "operationId": "repoCreateKey",
  2388. "parameters": [
  2389. {
  2390. "type": "string",
  2391. "description": "owner of the repo",
  2392. "name": "owner",
  2393. "in": "path",
  2394. "required": true
  2395. },
  2396. {
  2397. "type": "string",
  2398. "description": "name of the repo",
  2399. "name": "repo",
  2400. "in": "path",
  2401. "required": true
  2402. },
  2403. {
  2404. "name": "body",
  2405. "in": "body",
  2406. "schema": {
  2407. "$ref": "#/definitions/CreateKeyOption"
  2408. }
  2409. }
  2410. ],
  2411. "responses": {
  2412. "201": {
  2413. "$ref": "#/responses/DeployKey"
  2414. }
  2415. }
  2416. }
  2417. },
  2418. "/repos/{owner}/{repo}/keys/{id}": {
  2419. "get": {
  2420. "produces": [
  2421. "application/json"
  2422. ],
  2423. "tags": [
  2424. "repository"
  2425. ],
  2426. "summary": "Get a repository's key by id",
  2427. "operationId": "repoGetKey",
  2428. "parameters": [
  2429. {
  2430. "type": "string",
  2431. "description": "owner of the repo",
  2432. "name": "owner",
  2433. "in": "path",
  2434. "required": true
  2435. },
  2436. {
  2437. "type": "string",
  2438. "description": "name of the repo",
  2439. "name": "repo",
  2440. "in": "path",
  2441. "required": true
  2442. },
  2443. {
  2444. "type": "integer",
  2445. "description": "id of the key to get",
  2446. "name": "id",
  2447. "in": "path",
  2448. "required": true
  2449. }
  2450. ],
  2451. "responses": {
  2452. "200": {
  2453. "$ref": "#/responses/DeployKey"
  2454. }
  2455. }
  2456. },
  2457. "delete": {
  2458. "tags": [
  2459. "repository"
  2460. ],
  2461. "summary": "Delete a key from a repository",
  2462. "operationId": "repoDeleteKey",
  2463. "parameters": [
  2464. {
  2465. "type": "string",
  2466. "description": "owner of the repo",
  2467. "name": "owner",
  2468. "in": "path",
  2469. "required": true
  2470. },
  2471. {
  2472. "type": "string",
  2473. "description": "name of the repo",
  2474. "name": "repo",
  2475. "in": "path",
  2476. "required": true
  2477. },
  2478. {
  2479. "type": "integer",
  2480. "description": "id of the key to delete",
  2481. "name": "id",
  2482. "in": "path",
  2483. "required": true
  2484. }
  2485. ],
  2486. "responses": {
  2487. "204": {
  2488. "$ref": "#/responses/empty"
  2489. }
  2490. }
  2491. }
  2492. },
  2493. "/repos/{owner}/{repo}/labels": {
  2494. "get": {
  2495. "produces": [
  2496. "application/json"
  2497. ],
  2498. "tags": [
  2499. "issue"
  2500. ],
  2501. "summary": "Get all of a repository's labels",
  2502. "operationId": "issueListLabels",
  2503. "parameters": [
  2504. {
  2505. "type": "string",
  2506. "description": "owner of the repo",
  2507. "name": "owner",
  2508. "in": "path",
  2509. "required": true
  2510. },
  2511. {
  2512. "type": "string",
  2513. "description": "name of the repo",
  2514. "name": "repo",
  2515. "in": "path",
  2516. "required": true
  2517. }
  2518. ],
  2519. "responses": {
  2520. "200": {
  2521. "$ref": "#/responses/LabelList"
  2522. }
  2523. }
  2524. },
  2525. "post": {
  2526. "consumes": [
  2527. "application/json"
  2528. ],
  2529. "produces": [
  2530. "application/json"
  2531. ],
  2532. "tags": [
  2533. "issue"
  2534. ],
  2535. "summary": "Create a label",
  2536. "operationId": "issueCreateLabel",
  2537. "parameters": [
  2538. {
  2539. "type": "string",
  2540. "description": "owner of the repo",
  2541. "name": "owner",
  2542. "in": "path",
  2543. "required": true
  2544. },
  2545. {
  2546. "type": "string",
  2547. "description": "name of the repo",
  2548. "name": "repo",
  2549. "in": "path",
  2550. "required": true
  2551. },
  2552. {
  2553. "name": "body",
  2554. "in": "body",
  2555. "schema": {
  2556. "$ref": "#/definitions/CreateLabelOption"
  2557. }
  2558. }
  2559. ],
  2560. "responses": {
  2561. "201": {
  2562. "$ref": "#/responses/Label"
  2563. }
  2564. }
  2565. }
  2566. },
  2567. "/repos/{owner}/{repo}/labels/{id}": {
  2568. "get": {
  2569. "produces": [
  2570. "application/json"
  2571. ],
  2572. "tags": [
  2573. "issue"
  2574. ],
  2575. "summary": "Get a single label",
  2576. "operationId": "issueGetLabel",
  2577. "parameters": [
  2578. {
  2579. "type": "string",
  2580. "description": "owner of the repo",
  2581. "name": "owner",
  2582. "in": "path",
  2583. "required": true
  2584. },
  2585. {
  2586. "type": "string",
  2587. "description": "name of the repo",
  2588. "name": "repo",
  2589. "in": "path",
  2590. "required": true
  2591. },
  2592. {
  2593. "type": "integer",
  2594. "description": "id of the label to get",
  2595. "name": "id",
  2596. "in": "path",
  2597. "required": true
  2598. }
  2599. ],
  2600. "responses": {
  2601. "200": {
  2602. "$ref": "#/responses/Label"
  2603. }
  2604. }
  2605. },
  2606. "delete": {
  2607. "tags": [
  2608. "issue"
  2609. ],
  2610. "summary": "Delete a label",
  2611. "operationId": "issueDeleteLabel",
  2612. "parameters": [
  2613. {
  2614. "type": "string",
  2615. "description": "owner of the repo",
  2616. "name": "owner",
  2617. "in": "path",
  2618. "required": true
  2619. },
  2620. {
  2621. "type": "string",
  2622. "description": "name of the repo",
  2623. "name": "repo",
  2624. "in": "path",
  2625. "required": true
  2626. },
  2627. {
  2628. "type": "integer",
  2629. "description": "id of the label to delete",
  2630. "name": "id",
  2631. "in": "path",
  2632. "required": true
  2633. }
  2634. ],
  2635. "responses": {
  2636. "204": {
  2637. "$ref": "#/responses/empty"
  2638. }
  2639. }
  2640. },
  2641. "patch": {
  2642. "consumes": [
  2643. "application/json"
  2644. ],
  2645. "produces": [
  2646. "application/json"
  2647. ],
  2648. "tags": [
  2649. "issue"
  2650. ],
  2651. "summary": "Update a label",
  2652. "operationId": "issueEditLabel",
  2653. "parameters": [
  2654. {
  2655. "type": "string",
  2656. "description": "owner of the repo",
  2657. "name": "owner",
  2658. "in": "path",
  2659. "required": true
  2660. },
  2661. {
  2662. "type": "string",
  2663. "description": "name of the repo",
  2664. "name": "repo",
  2665. "in": "path",
  2666. "required": true
  2667. },
  2668. {
  2669. "type": "integer",
  2670. "description": "id of the label to edit",
  2671. "name": "id",
  2672. "in": "path",
  2673. "required": true
  2674. },
  2675. {
  2676. "name": "body",
  2677. "in": "body",
  2678. "schema": {
  2679. "$ref": "#/definitions/EditLabelOption"
  2680. }
  2681. }
  2682. ],
  2683. "responses": {
  2684. "200": {
  2685. "$ref": "#/responses/Label"
  2686. }
  2687. }
  2688. }
  2689. },
  2690. "/repos/{owner}/{repo}/milestones": {
  2691. "get": {
  2692. "produces": [
  2693. "application/json"
  2694. ],
  2695. "tags": [
  2696. "issue"
  2697. ],
  2698. "summary": "Get all of a repository's milestones",
  2699. "operationId": "issueGetMilestones",
  2700. "parameters": [
  2701. {
  2702. "type": "string",
  2703. "description": "owner of the repo",
  2704. "name": "owner",
  2705. "in": "path",
  2706. "required": true
  2707. },
  2708. {
  2709. "type": "string",
  2710. "description": "name of the repo",
  2711. "name": "repo",
  2712. "in": "path",
  2713. "required": true
  2714. },
  2715. {
  2716. "type": "integer",
  2717. "description": "id of the milestone to get",
  2718. "name": "id",
  2719. "in": "path",
  2720. "required": true
  2721. }
  2722. ],
  2723. "responses": {
  2724. "200": {
  2725. "$ref": "#/responses/MilestoneList"
  2726. }
  2727. }
  2728. },
  2729. "post": {
  2730. "consumes": [
  2731. "application/json"
  2732. ],
  2733. "produces": [
  2734. "application/json"
  2735. ],
  2736. "tags": [
  2737. "issue"
  2738. ],
  2739. "summary": "Create a milestone",
  2740. "operationId": "issueCreateMilestone",
  2741. "parameters": [
  2742. {
  2743. "type": "string",
  2744. "description": "owner of the repo",
  2745. "name": "owner",
  2746. "in": "path",
  2747. "required": true
  2748. },
  2749. {
  2750. "type": "string",
  2751. "description": "name of the repo",
  2752. "name": "repo",
  2753. "in": "path",
  2754. "required": true
  2755. },
  2756. {
  2757. "name": "body",
  2758. "in": "body",
  2759. "schema": {
  2760. "$ref": "#/definitions/CreateMilestoneOption"
  2761. }
  2762. }
  2763. ],
  2764. "responses": {
  2765. "201": {
  2766. "$ref": "#/responses/Milestone"
  2767. }
  2768. }
  2769. }
  2770. },
  2771. "/repos/{owner}/{repo}/milestones/{id}": {
  2772. "get": {
  2773. "produces": [
  2774. "application/json"
  2775. ],
  2776. "tags": [
  2777. "issue"
  2778. ],
  2779. "summary": "Get a milestone",
  2780. "operationId": "issueGetMilestone",
  2781. "responses": {
  2782. "200": {
  2783. "$ref": "#/responses/Milestone"
  2784. }
  2785. }
  2786. },
  2787. "delete": {
  2788. "tags": [
  2789. "issue"
  2790. ],
  2791. "summary": "Delete a milestone",
  2792. "operationId": "issueDeleteMilestone",
  2793. "parameters": [
  2794. {
  2795. "type": "string",
  2796. "description": "owner of the repo",
  2797. "name": "owner",
  2798. "in": "path",
  2799. "required": true
  2800. },
  2801. {
  2802. "type": "string",
  2803. "description": "name of the repo",
  2804. "name": "repo",
  2805. "in": "path",
  2806. "required": true
  2807. },
  2808. {
  2809. "type": "integer",
  2810. "description": "id of the milestone to delete",
  2811. "name": "body",
  2812. "in": "path",
  2813. "required": true
  2814. }
  2815. ],
  2816. "responses": {
  2817. "204": {
  2818. "$ref": "#/responses/empty"
  2819. }
  2820. }
  2821. },
  2822. "patch": {
  2823. "consumes": [
  2824. "application/json"
  2825. ],
  2826. "produces": [
  2827. "application/json"
  2828. ],
  2829. "tags": [
  2830. "issue"
  2831. ],
  2832. "summary": "Update a milestone",
  2833. "operationId": "issueEditMilestone",
  2834. "parameters": [
  2835. {
  2836. "type": "string",
  2837. "description": "owner of the repo",
  2838. "name": "owner",
  2839. "in": "path",
  2840. "required": true
  2841. },
  2842. {
  2843. "type": "string",
  2844. "description": "name of the repo",
  2845. "name": "repo",
  2846. "in": "path",
  2847. "required": true
  2848. },
  2849. {
  2850. "name": "body",
  2851. "in": "body",
  2852. "schema": {
  2853. "$ref": "#/definitions/EditMilestoneOption"
  2854. }
  2855. }
  2856. ],
  2857. "responses": {
  2858. "200": {
  2859. "$ref": "#/responses/Milestone"
  2860. }
  2861. }
  2862. }
  2863. },
  2864. "/repos/{owner}/{repo}/mirror-sync": {
  2865. "post": {
  2866. "produces": [
  2867. "application/json"
  2868. ],
  2869. "tags": [
  2870. "repository"
  2871. ],
  2872. "summary": "Sync a mirrored repository",
  2873. "operationId": "repoMirrorSync",
  2874. "parameters": [
  2875. {
  2876. "type": "string",
  2877. "description": "owner of the repo to sync",
  2878. "name": "owner",
  2879. "in": "path",
  2880. "required": true
  2881. },
  2882. {
  2883. "type": "string",
  2884. "description": "name of the repo to sync",
  2885. "name": "repo",
  2886. "in": "path",
  2887. "required": true
  2888. }
  2889. ],
  2890. "responses": {
  2891. "200": {
  2892. "$ref": "#/responses/empty"
  2893. }
  2894. }
  2895. }
  2896. },
  2897. "/repos/{owner}/{repo}/pulls": {
  2898. "get": {
  2899. "produces": [
  2900. "application/json"
  2901. ],
  2902. "tags": [
  2903. "repository"
  2904. ],
  2905. "summary": "List a repo's pull requests",
  2906. "operationId": "repoListPullRequests",
  2907. "parameters": [
  2908. {
  2909. "type": "string",
  2910. "description": "owner of the repo",
  2911. "name": "owner",
  2912. "in": "path",
  2913. "required": true
  2914. },
  2915. {
  2916. "type": "string",
  2917. "description": "name of the repo",
  2918. "name": "repo",
  2919. "in": "path",
  2920. "required": true
  2921. }
  2922. ],
  2923. "responses": {
  2924. "200": {
  2925. "$ref": "#/responses/PullRequestList"
  2926. }
  2927. }
  2928. },
  2929. "post": {
  2930. "consumes": [
  2931. "application/json"
  2932. ],
  2933. "produces": [
  2934. "application/json"
  2935. ],
  2936. "tags": [
  2937. "repository"
  2938. ],
  2939. "summary": "Create a pull request",
  2940. "operationId": "repoCreatePullRequest",
  2941. "parameters": [
  2942. {
  2943. "type": "string",
  2944. "description": "owner of the repo",
  2945. "name": "owner",
  2946. "in": "path",
  2947. "required": true
  2948. },
  2949. {
  2950. "type": "string",
  2951. "description": "name of the repo",
  2952. "name": "repo",
  2953. "in": "path",
  2954. "required": true
  2955. },
  2956. {
  2957. "name": "body",
  2958. "in": "body",
  2959. "schema": {
  2960. "$ref": "#/definitions/CreatePullRequestOption"
  2961. }
  2962. }
  2963. ],
  2964. "responses": {
  2965. "201": {
  2966. "$ref": "#/responses/PullRequest"
  2967. }
  2968. }
  2969. }
  2970. },
  2971. "/repos/{owner}/{repo}/pulls/{index}": {
  2972. "get": {
  2973. "produces": [
  2974. "application/json"
  2975. ],
  2976. "tags": [
  2977. "repository"
  2978. ],
  2979. "summary": "Get a pull request",
  2980. "operationId": "repoGetPullRequest",
  2981. "parameters": [
  2982. {
  2983. "type": "string",
  2984. "description": "owner of the repo",
  2985. "name": "owner",
  2986. "in": "path",
  2987. "required": true
  2988. },
  2989. {
  2990. "type": "string",
  2991. "description": "name of the repo",
  2992. "name": "repo",
  2993. "in": "path",
  2994. "required": true
  2995. },
  2996. {
  2997. "type": "integer",
  2998. "description": "index of the pull request to get",
  2999. "name": "index",
  3000. "in": "path",
  3001. "required": true
  3002. }
  3003. ],
  3004. "responses": {
  3005. "200": {
  3006. "$ref": "#/responses/PullRequest"
  3007. }
  3008. }
  3009. },
  3010. "patch": {
  3011. "consumes": [
  3012. "application/json"
  3013. ],
  3014. "produces": [
  3015. "application/json"
  3016. ],
  3017. "tags": [
  3018. "repository"
  3019. ],
  3020. "summary": "Update a pull request",
  3021. "operationId": "repoEditPullRequest",
  3022. "parameters": [
  3023. {
  3024. "type": "string",
  3025. "description": "owner of the repo",
  3026. "name": "owner",
  3027. "in": "path",
  3028. "required": true
  3029. },
  3030. {
  3031. "type": "string",
  3032. "description": "name of the repo",
  3033. "name": "repo",
  3034. "in": "path",
  3035. "required": true
  3036. },
  3037. {
  3038. "type": "integer",
  3039. "description": "index of the pull request to edit",
  3040. "name": "index",
  3041. "in": "path",
  3042. "required": true
  3043. },
  3044. {
  3045. "name": "body",
  3046. "in": "body",
  3047. "schema": {
  3048. "$ref": "#/definitions/EditPullRequestOption"
  3049. }
  3050. }
  3051. ],
  3052. "responses": {
  3053. "201": {
  3054. "$ref": "#/responses/PullRequest"
  3055. }
  3056. }
  3057. }
  3058. },
  3059. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  3060. "get": {
  3061. "produces": [
  3062. "application/json"
  3063. ],
  3064. "tags": [
  3065. "repository"
  3066. ],
  3067. "summary": "Check if a pull request has been merged",
  3068. "operationId": "repoPullRequestIsMerged",
  3069. "parameters": [
  3070. {
  3071. "type": "string",
  3072. "description": "owner of the repo",
  3073. "name": "owner",
  3074. "in": "path",
  3075. "required": true
  3076. },
  3077. {
  3078. "type": "string",
  3079. "description": "name of the repo",
  3080. "name": "repo",
  3081. "in": "path",
  3082. "required": true
  3083. },
  3084. {
  3085. "type": "integer",
  3086. "description": "index of the pull request",
  3087. "name": "index",
  3088. "in": "path",
  3089. "required": true
  3090. }
  3091. ],
  3092. "responses": {
  3093. "204": {
  3094. "description": "pull request has been merged",
  3095. "schema": {
  3096. "$ref": "#/responses/empty"
  3097. }
  3098. },
  3099. "404": {
  3100. "description": "pull request has not been merged",
  3101. "schema": {
  3102. "$ref": "#/responses/empty"
  3103. }
  3104. }
  3105. }
  3106. },
  3107. "post": {
  3108. "produces": [
  3109. "application/json"
  3110. ],
  3111. "tags": [
  3112. "repository"
  3113. ],
  3114. "summary": "Merge a pull request",
  3115. "operationId": "repoMergePullRequest",
  3116. "parameters": [
  3117. {
  3118. "type": "string",
  3119. "description": "owner of the repo",
  3120. "name": "owner",
  3121. "in": "path",
  3122. "required": true
  3123. },
  3124. {
  3125. "type": "string",
  3126. "description": "name of the repo",
  3127. "name": "repo",
  3128. "in": "path",
  3129. "required": true
  3130. },
  3131. {
  3132. "type": "integer",
  3133. "description": "index of the pull request to merge",
  3134. "name": "index",
  3135. "in": "path",
  3136. "required": true
  3137. }
  3138. ],
  3139. "responses": {
  3140. "200": {
  3141. "$ref": "#/responses/empty"
  3142. },
  3143. "405": {
  3144. "$ref": "#/responses/empty"
  3145. }
  3146. }
  3147. }
  3148. },
  3149. "/repos/{owner}/{repo}/raw/{filepath}": {
  3150. "get": {
  3151. "produces": [
  3152. "application/json"
  3153. ],
  3154. "tags": [
  3155. "repository"
  3156. ],
  3157. "summary": "Get a file from a repository",
  3158. "operationId": "repoGetRawFile",
  3159. "parameters": [
  3160. {
  3161. "type": "string",
  3162. "description": "owner of the repo",
  3163. "name": "owner",
  3164. "in": "path",
  3165. "required": true
  3166. },
  3167. {
  3168. "type": "string",
  3169. "description": "name of the repo",
  3170. "name": "repo",
  3171. "in": "path",
  3172. "required": true
  3173. },
  3174. {
  3175. "type": "string",
  3176. "description": "filepath of the file to get",
  3177. "name": "filepath",
  3178. "in": "path",
  3179. "required": true
  3180. }
  3181. ],
  3182. "responses": {
  3183. "200": {}
  3184. }
  3185. }
  3186. },
  3187. "/repos/{owner}/{repo}/releases": {
  3188. "get": {
  3189. "consumes": [
  3190. "application/json"
  3191. ],
  3192. "produces": [
  3193. "application/json"
  3194. ],
  3195. "tags": [
  3196. "repository"
  3197. ],
  3198. "summary": "Create a release",
  3199. "operationId": "repoCreateRelease",
  3200. "parameters": [
  3201. {
  3202. "type": "string",
  3203. "description": "owner of the repo",
  3204. "name": "owner",
  3205. "in": "path",
  3206. "required": true
  3207. },
  3208. {
  3209. "type": "string",
  3210. "description": "name of the repo",
  3211. "name": "repo",
  3212. "in": "path",
  3213. "required": true
  3214. },
  3215. {
  3216. "name": "body",
  3217. "in": "body",
  3218. "schema": {
  3219. "$ref": "#/definitions/CreateReleaseOption"
  3220. }
  3221. }
  3222. ],
  3223. "responses": {
  3224. "201": {
  3225. "$ref": "#/responses/Release"
  3226. }
  3227. }
  3228. }
  3229. },
  3230. "/repos/{owner}/{repo}/releases/{id}": {
  3231. "delete": {
  3232. "tags": [
  3233. "repository"
  3234. ],
  3235. "summary": "Delete a release",
  3236. "operationId": "repoDeleteRelease",
  3237. "parameters": [
  3238. {
  3239. "type": "string",
  3240. "description": "owner of the repo",
  3241. "name": "owner",
  3242. "in": "path",
  3243. "required": true
  3244. },
  3245. {
  3246. "type": "string",
  3247. "description": "name of the repo",
  3248. "name": "repo",
  3249. "in": "path",
  3250. "required": true
  3251. },
  3252. {
  3253. "type": "integer",
  3254. "description": "id of the release to delete",
  3255. "name": "id",
  3256. "in": "path",
  3257. "required": true
  3258. }
  3259. ],
  3260. "responses": {
  3261. "204": {
  3262. "$ref": "#/responses/empty"
  3263. }
  3264. }
  3265. },
  3266. "patch": {
  3267. "consumes": [
  3268. "application/json"
  3269. ],
  3270. "produces": [
  3271. "application/json"
  3272. ],
  3273. "tags": [
  3274. "repository"
  3275. ],
  3276. "summary": "Update a release",
  3277. "operationId": "repoEditRelease",
  3278. "parameters": [
  3279. {
  3280. "type": "string",
  3281. "description": "owner of the repo",
  3282. "name": "owner",
  3283. "in": "path",
  3284. "required": true
  3285. },
  3286. {
  3287. "type": "string",
  3288. "description": "name of the repo",
  3289. "name": "repo",
  3290. "in": "path",
  3291. "required": true
  3292. },
  3293. {
  3294. "type": "integer",
  3295. "description": "id of the release to edit",
  3296. "name": "id",
  3297. "in": "path",
  3298. "required": true
  3299. },
  3300. {
  3301. "name": "body",
  3302. "in": "body",
  3303. "schema": {
  3304. "$ref": "#/definitions/EditReleaseOption"
  3305. }
  3306. }
  3307. ],
  3308. "responses": {
  3309. "200": {
  3310. "$ref": "#/responses/Release"
  3311. }
  3312. }
  3313. }
  3314. },
  3315. "/repos/{owner}/{repo}/stargazers": {
  3316. "get": {
  3317. "produces": [
  3318. "application/json"
  3319. ],
  3320. "tags": [
  3321. "repository"
  3322. ],
  3323. "summary": "List a repo's stargazers",
  3324. "operationId": "repoListStargazers",
  3325. "parameters": [
  3326. {
  3327. "type": "string",
  3328. "description": "owner of the repo",
  3329. "name": "owner",
  3330. "in": "path",
  3331. "required": true
  3332. },
  3333. {
  3334. "type": "string",
  3335. "description": "name of the repo",
  3336. "name": "repo",
  3337. "in": "path",
  3338. "required": true
  3339. }
  3340. ],
  3341. "responses": {
  3342. "200": {
  3343. "$ref": "#/responses/UserList"
  3344. }
  3345. }
  3346. }
  3347. },
  3348. "/repos/{owner}/{repo}/statuses/{sha}": {
  3349. "get": {
  3350. "produces": [
  3351. "application/json"
  3352. ],
  3353. "tags": [
  3354. "repository"
  3355. ],
  3356. "summary": "Get a commit's statuses",
  3357. "operationId": "repoListStatuses",
  3358. "parameters": [
  3359. {
  3360. "type": "string",
  3361. "description": "owner of the repo",
  3362. "name": "owner",
  3363. "in": "path",
  3364. "required": true
  3365. },
  3366. {
  3367. "type": "string",
  3368. "description": "name of the repo",
  3369. "name": "repo",
  3370. "in": "path",
  3371. "required": true
  3372. },
  3373. {
  3374. "type": "string",
  3375. "description": "sha of the commit",
  3376. "name": "sha",
  3377. "in": "path",
  3378. "required": true
  3379. }
  3380. ],
  3381. "responses": {
  3382. "200": {
  3383. "$ref": "#/responses/StatusList"
  3384. }
  3385. }
  3386. },
  3387. "post": {
  3388. "produces": [
  3389. "application/json"
  3390. ],
  3391. "tags": [
  3392. "repository"
  3393. ],
  3394. "summary": "Create a commit status",
  3395. "operationId": "repoCreateStatus",
  3396. "parameters": [
  3397. {
  3398. "type": "string",
  3399. "description": "owner of the repo",
  3400. "name": "owner",
  3401. "in": "path",
  3402. "required": true
  3403. },
  3404. {
  3405. "type": "string",
  3406. "description": "name of the repo",
  3407. "name": "repo",
  3408. "in": "path",
  3409. "required": true
  3410. },
  3411. {
  3412. "type": "string",
  3413. "description": "sha of the commit",
  3414. "name": "sha",
  3415. "in": "path",
  3416. "required": true
  3417. },
  3418. {
  3419. "name": "body",
  3420. "in": "body",
  3421. "schema": {
  3422. "$ref": "#/definitions/CreateStatusOption"
  3423. }
  3424. }
  3425. ],
  3426. "responses": {
  3427. "200": {
  3428. "$ref": "#/responses/StatusList"
  3429. }
  3430. }
  3431. }
  3432. },
  3433. "/repos/{owner}/{repo}/subscribers": {
  3434. "get": {
  3435. "produces": [
  3436. "application/json"
  3437. ],
  3438. "tags": [
  3439. "repository"
  3440. ],
  3441. "summary": "List a repo's watchers",
  3442. "operationId": "repoListSubscribers",
  3443. "parameters": [
  3444. {
  3445. "type": "string",
  3446. "description": "owner of the repo",
  3447. "name": "owner",
  3448. "in": "path",
  3449. "required": true
  3450. },
  3451. {
  3452. "type": "string",
  3453. "description": "name of the repo",
  3454. "name": "repo",
  3455. "in": "path",
  3456. "required": true
  3457. }
  3458. ],
  3459. "responses": {
  3460. "200": {
  3461. "$ref": "#/responses/UserList"
  3462. }
  3463. }
  3464. }
  3465. },
  3466. "/repos/{owner}/{repo}/subscription": {
  3467. "get": {
  3468. "tags": [
  3469. "repository"
  3470. ],
  3471. "summary": "Check if the current user is watching a repo",
  3472. "operationId": "userCurrentCheckSubscription",
  3473. "parameters": [
  3474. {
  3475. "type": "string",
  3476. "description": "owner of the repo",
  3477. "name": "owner",
  3478. "in": "path",
  3479. "required": true
  3480. },
  3481. {
  3482. "type": "string",
  3483. "description": "name of the repo",
  3484. "name": "repo",
  3485. "in": "path",
  3486. "required": true
  3487. }
  3488. ],
  3489. "responses": {
  3490. "200": {
  3491. "$ref": "#/responses/WatchInfo"
  3492. }
  3493. }
  3494. },
  3495. "put": {
  3496. "tags": [
  3497. "repository"
  3498. ],
  3499. "summary": "Watch a repo",
  3500. "operationId": "userCurrentPutSubscription",
  3501. "parameters": [
  3502. {
  3503. "type": "string",
  3504. "description": "owner of the repo",
  3505. "name": "owner",
  3506. "in": "path",
  3507. "required": true
  3508. },
  3509. {
  3510. "type": "string",
  3511. "description": "name of the repo",
  3512. "name": "repo",
  3513. "in": "path",
  3514. "required": true
  3515. }
  3516. ],
  3517. "responses": {
  3518. "200": {
  3519. "$ref": "#/responses/WatchInfo"
  3520. }
  3521. }
  3522. },
  3523. "delete": {
  3524. "tags": [
  3525. "repository"
  3526. ],
  3527. "summary": "Unwatch a repo",
  3528. "operationId": "userCurrentDeleteSubscription",
  3529. "parameters": [
  3530. {
  3531. "type": "string",
  3532. "description": "owner of the repo",
  3533. "name": "owner",
  3534. "in": "path",
  3535. "required": true
  3536. },
  3537. {
  3538. "type": "string",
  3539. "description": "name of the repo",
  3540. "name": "repo",
  3541. "in": "path",
  3542. "required": true
  3543. }
  3544. ],
  3545. "responses": {
  3546. "204": {
  3547. "$ref": "#/responses/empty"
  3548. }
  3549. }
  3550. }
  3551. },
  3552. "/repos/{owner}/{repo}/times": {
  3553. "get": {
  3554. "produces": [
  3555. "application/json"
  3556. ],
  3557. "tags": [
  3558. "repository"
  3559. ],
  3560. "summary": "List a repo's tracked times",
  3561. "operationId": "repoTrackedTimes",
  3562. "parameters": [
  3563. {
  3564. "type": "string",
  3565. "description": "owner of the repo",
  3566. "name": "owner",
  3567. "in": "path",
  3568. "required": true
  3569. },
  3570. {
  3571. "type": "string",
  3572. "description": "name of the repo",
  3573. "name": "repo",
  3574. "in": "path",
  3575. "required": true
  3576. }
  3577. ],
  3578. "responses": {
  3579. "200": {
  3580. "$ref": "#/responses/TrackedTimeList"
  3581. }
  3582. }
  3583. }
  3584. },
  3585. "/repos/{owner}/{repo}/times/{tracker}": {
  3586. "get": {
  3587. "produces": [
  3588. "application/json"
  3589. ],
  3590. "tags": [
  3591. "user"
  3592. ],
  3593. "summary": "List a user's tracked times in a repo",
  3594. "operationId": "userTrackedTimes",
  3595. "parameters": [
  3596. {
  3597. "type": "string",
  3598. "description": "owner of the repo",
  3599. "name": "owner",
  3600. "in": "path",
  3601. "required": true
  3602. },
  3603. {
  3604. "type": "string",
  3605. "description": "name of the repo",
  3606. "name": "repo",
  3607. "in": "path",
  3608. "required": true
  3609. },
  3610. {
  3611. "type": "string",
  3612. "description": "username of user",
  3613. "name": "user",
  3614. "in": "path",
  3615. "required": true
  3616. }
  3617. ],
  3618. "responses": {
  3619. "200": {
  3620. "$ref": "#/responses/TrackedTimeList"
  3621. }
  3622. }
  3623. }
  3624. },
  3625. "/repos/{user}/{repo}/hooks/{id}": {
  3626. "delete": {
  3627. "produces": [
  3628. "application/json"
  3629. ],
  3630. "tags": [
  3631. "repository"
  3632. ],
  3633. "summary": "Delete a hook in a repository",
  3634. "operationId": "repoDeleteHook",
  3635. "parameters": [
  3636. {
  3637. "type": "string",
  3638. "description": "owner of the repo",
  3639. "name": "owner",
  3640. "in": "path",
  3641. "required": true
  3642. },
  3643. {
  3644. "type": "string",
  3645. "description": "name of the repo",
  3646. "name": "repo",
  3647. "in": "path",
  3648. "required": true
  3649. },
  3650. {
  3651. "type": "integer",
  3652. "description": "id of the hook to delete",
  3653. "name": "id",
  3654. "in": "path",
  3655. "required": true
  3656. }
  3657. ],
  3658. "responses": {
  3659. "204": {
  3660. "$ref": "#/responses/empty"
  3661. },
  3662. "404": {
  3663. "$ref": "#/responses/notFound"
  3664. }
  3665. }
  3666. }
  3667. },
  3668. "/repositories/{id}": {
  3669. "get": {
  3670. "produces": [
  3671. "application/json"
  3672. ],
  3673. "tags": [
  3674. "repository"
  3675. ],
  3676. "summary": "Get a repository by id",
  3677. "operationId": "repoGetByID",
  3678. "parameters": [
  3679. {
  3680. "type": "integer",
  3681. "description": "id of the repo to get",
  3682. "name": "id",
  3683. "in": "path",
  3684. "required": true
  3685. }
  3686. ],
  3687. "responses": {
  3688. "200": {
  3689. "$ref": "#/responses/Repository"
  3690. }
  3691. }
  3692. }
  3693. },
  3694. "/teams/{id}": {
  3695. "get": {
  3696. "produces": [
  3697. "application/json"
  3698. ],
  3699. "tags": [
  3700. "organization"
  3701. ],
  3702. "summary": "Get a team",
  3703. "operationId": "orgGetTeam",
  3704. "parameters": [
  3705. {
  3706. "type": "integer",
  3707. "description": "id of the team to get",
  3708. "name": "id",
  3709. "in": "path",
  3710. "required": true
  3711. }
  3712. ],
  3713. "responses": {
  3714. "200": {
  3715. "$ref": "#/responses/Team"
  3716. }
  3717. }
  3718. },
  3719. "delete": {
  3720. "tags": [
  3721. "organization"
  3722. ],
  3723. "summary": "Delete a team",
  3724. "operationId": "orgDeleteTeam",
  3725. "parameters": [
  3726. {
  3727. "type": "integer",
  3728. "description": "id of the team to delete",
  3729. "name": "id",
  3730. "in": "path",
  3731. "required": true
  3732. }
  3733. ],
  3734. "responses": {
  3735. "204": {
  3736. "description": "team deleted",
  3737. "schema": {
  3738. "$ref": "#/responses/empty"
  3739. }
  3740. }
  3741. }
  3742. },
  3743. "patch": {
  3744. "consumes": [
  3745. "application/json"
  3746. ],
  3747. "produces": [
  3748. "application/json"
  3749. ],
  3750. "tags": [
  3751. "organization"
  3752. ],
  3753. "summary": "Edit a team",
  3754. "operationId": "orgEditTeam",
  3755. "parameters": [
  3756. {
  3757. "type": "integer",
  3758. "description": "id of the team to edit",
  3759. "name": "id",
  3760. "in": "path",
  3761. "required": true
  3762. },
  3763. {
  3764. "name": "body",
  3765. "in": "body",
  3766. "schema": {
  3767. "$ref": "#/definitions/EditTeamOption"
  3768. }
  3769. }
  3770. ],
  3771. "responses": {
  3772. "200": {
  3773. "$ref": "#/responses/Team"
  3774. }
  3775. }
  3776. }
  3777. },
  3778. "/teams/{id}/members": {
  3779. "get": {
  3780. "produces": [
  3781. "application/json"
  3782. ],
  3783. "tags": [
  3784. "organization"
  3785. ],
  3786. "summary": "List a team's members",
  3787. "operationId": "orgListTeamMembers",
  3788. "parameters": [
  3789. {
  3790. "type": "integer",
  3791. "description": "id of the team",
  3792. "name": "id",
  3793. "in": "path",
  3794. "required": true
  3795. }
  3796. ],
  3797. "responses": {
  3798. "200": {
  3799. "$ref": "#/responses/UserList"
  3800. }
  3801. }
  3802. }
  3803. },
  3804. "/teams/{id}/members/{username}": {
  3805. "put": {
  3806. "produces": [
  3807. "application/json"
  3808. ],
  3809. "tags": [
  3810. "organization"
  3811. ],
  3812. "summary": "Add a team member",
  3813. "operationId": "orgAddTeamMember",
  3814. "parameters": [
  3815. {
  3816. "type": "integer",
  3817. "description": "id of the team",
  3818. "name": "id",
  3819. "in": "path",
  3820. "required": true
  3821. },
  3822. {
  3823. "type": "string",
  3824. "description": "username of the user to add",
  3825. "name": "username",
  3826. "in": "path",
  3827. "required": true
  3828. }
  3829. ],
  3830. "responses": {
  3831. "204": {
  3832. "$ref": "#/responses/empty"
  3833. }
  3834. }
  3835. },
  3836. "delete": {
  3837. "produces": [
  3838. "application/json"
  3839. ],
  3840. "tags": [
  3841. "organization"
  3842. ],
  3843. "summary": "Remove a team member",
  3844. "operationId": "orgAddTeamMember",
  3845. "parameters": [
  3846. {
  3847. "type": "integer",
  3848. "description": "id of the team",
  3849. "name": "id",
  3850. "in": "path",
  3851. "required": true
  3852. },
  3853. {
  3854. "type": "string",
  3855. "description": "username of the user to remove",
  3856. "name": "username",
  3857. "in": "path",
  3858. "required": true
  3859. }
  3860. ],
  3861. "responses": {
  3862. "204": {
  3863. "$ref": "#/responses/empty"
  3864. }
  3865. }
  3866. }
  3867. },
  3868. "/teams/{id}/repos": {
  3869. "get": {
  3870. "produces": [
  3871. "application/json"
  3872. ],
  3873. "tags": [
  3874. "organization"
  3875. ],
  3876. "summary": "List a team's repos",
  3877. "operationId": "orgListTeamRepos",
  3878. "parameters": [
  3879. {
  3880. "type": "integer",
  3881. "description": "id of the team",
  3882. "name": "id",
  3883. "in": "path",
  3884. "required": true
  3885. }
  3886. ],
  3887. "responses": {
  3888. "200": {
  3889. "$ref": "#/responses/RepositoryList"
  3890. }
  3891. }
  3892. }
  3893. },
  3894. "/teams/{id}/repos/{org}/{repo}": {
  3895. "put": {
  3896. "produces": [
  3897. "application/json"
  3898. ],
  3899. "tags": [
  3900. "organization"
  3901. ],
  3902. "summary": "Add a repository to a team",
  3903. "operationId": "orgAddTeamMember",
  3904. "parameters": [
  3905. {
  3906. "type": "integer",
  3907. "description": "id of the team",
  3908. "name": "id",
  3909. "in": "path",
  3910. "required": true
  3911. },
  3912. {
  3913. "type": "string",
  3914. "description": "organization that owns the repo to add",
  3915. "name": "org",
  3916. "in": "path",
  3917. "required": true
  3918. },
  3919. {
  3920. "type": "string",
  3921. "description": "name of the repo to add",
  3922. "name": "repo",
  3923. "in": "path",
  3924. "required": true
  3925. }
  3926. ],
  3927. "responses": {
  3928. "204": {
  3929. "$ref": "#/responses/empty"
  3930. }
  3931. }
  3932. },
  3933. "delete": {
  3934. "description": "This does not delete the repository, it only removes the repository from the team.",
  3935. "produces": [
  3936. "application/json"
  3937. ],
  3938. "tags": [
  3939. "organization"
  3940. ],
  3941. "summary": "Remove a repository from a team",
  3942. "operationId": "orgAddTeamMember",
  3943. "parameters": [
  3944. {
  3945. "type": "integer",
  3946. "description": "id of the team",
  3947. "name": "id",
  3948. "in": "path",
  3949. "required": true
  3950. },
  3951. {
  3952. "type": "string",
  3953. "description": "organization that owns the repo to remove",
  3954. "name": "org",
  3955. "in": "path",
  3956. "required": true
  3957. },
  3958. {
  3959. "type": "string",
  3960. "description": "name of the repo to remove",
  3961. "name": "repo",
  3962. "in": "path",
  3963. "required": true
  3964. }
  3965. ],
  3966. "responses": {
  3967. "204": {
  3968. "$ref": "#/responses/empty"
  3969. }
  3970. }
  3971. }
  3972. },
  3973. "/user": {
  3974. "get": {
  3975. "produces": [
  3976. "application/json"
  3977. ],
  3978. "tags": [
  3979. "user"
  3980. ],
  3981. "summary": "Get the authenticated user",
  3982. "operationId": "userGetCurrent",
  3983. "responses": {
  3984. "200": {
  3985. "$ref": "#/responses/User"
  3986. }
  3987. }
  3988. }
  3989. },
  3990. "/user/emails": {
  3991. "get": {
  3992. "produces": [
  3993. "application/json"
  3994. ],
  3995. "tags": [
  3996. "user"
  3997. ],
  3998. "summary": "List the authenticated user's email addresses",
  3999. "operationId": "userListEmails",
  4000. "responses": {
  4001. "200": {
  4002. "$ref": "#/responses/EmailList"
  4003. }
  4004. }
  4005. },
  4006. "post": {
  4007. "produces": [
  4008. "application/json"
  4009. ],
  4010. "tags": [
  4011. "user"
  4012. ],
  4013. "summary": "Add email addresses",
  4014. "operationId": "userAddEmail",
  4015. "parameters": [
  4016. {
  4017. "name": "body",
  4018. "in": "body",
  4019. "schema": {
  4020. "$ref": "#/definitions/CreateEmailOption"
  4021. }
  4022. }
  4023. ],
  4024. "responses": {
  4025. "201": {
  4026. "$ref": "#/responses/EmailList"
  4027. }
  4028. }
  4029. },
  4030. "delete": {
  4031. "produces": [
  4032. "application/json"
  4033. ],
  4034. "tags": [
  4035. "user"
  4036. ],
  4037. "summary": "Delete email addresses",
  4038. "operationId": "userDeleteEmail",
  4039. "parameters": [
  4040. {
  4041. "name": "body",
  4042. "in": "body",
  4043. "schema": {
  4044. "$ref": "#/definitions/DeleteEmailOption"
  4045. }
  4046. }
  4047. ],
  4048. "responses": {
  4049. "204": {
  4050. "$ref": "#/responses/empty"
  4051. }
  4052. }
  4053. }
  4054. },
  4055. "/user/followers": {
  4056. "get": {
  4057. "produces": [
  4058. "application/json"
  4059. ],
  4060. "tags": [
  4061. "user"
  4062. ],
  4063. "summary": "List the authenticated user's followers",
  4064. "operationId": "userCurrentListFollowers",
  4065. "responses": {
  4066. "200": {
  4067. "$ref": "#/responses/UserList"
  4068. }
  4069. }
  4070. }
  4071. },
  4072. "/user/following": {
  4073. "get": {
  4074. "produces": [
  4075. "application/json"
  4076. ],
  4077. "tags": [
  4078. "user"
  4079. ],
  4080. "summary": "List the users that the authenticated user is following",
  4081. "operationId": "userCurrentListFollowing",
  4082. "responses": {
  4083. "200": {
  4084. "$ref": "#/responses/UserList"
  4085. }
  4086. }
  4087. }
  4088. },
  4089. "/user/following/{followee}": {
  4090. "get": {
  4091. "tags": [
  4092. "user"
  4093. ],
  4094. "summary": "Check whether a user is followed by the authenticated user",
  4095. "operationId": "userCurrentCheckFollowing",
  4096. "parameters": [
  4097. {
  4098. "type": "string",
  4099. "description": "username of followed user",
  4100. "name": "followee",
  4101. "in": "path",
  4102. "required": true
  4103. }
  4104. ],
  4105. "responses": {
  4106. "204": {
  4107. "$ref": "#/responses/empty"
  4108. },
  4109. "404": {
  4110. "$ref": "#/responses/notFound"
  4111. }
  4112. }
  4113. }
  4114. },
  4115. "/user/following/{username}": {
  4116. "put": {
  4117. "tags": [
  4118. "user"
  4119. ],
  4120. "summary": "Follow a user",
  4121. "operationId": "userCurrentPutFollow",
  4122. "parameters": [
  4123. {
  4124. "type": "string",
  4125. "description": "username of user to follow",
  4126. "name": "username",
  4127. "in": "path",
  4128. "required": true
  4129. }
  4130. ],
  4131. "responses": {
  4132. "204": {
  4133. "$ref": "#/responses/empty"
  4134. }
  4135. }
  4136. },
  4137. "delete": {
  4138. "tags": [
  4139. "user"
  4140. ],
  4141. "summary": "Unfollow a user",
  4142. "operationId": "userCurrentDeleteFollow",
  4143. "parameters": [
  4144. {
  4145. "type": "string",
  4146. "description": "username of user to unfollow",
  4147. "name": "username",
  4148. "in": "path",
  4149. "required": true
  4150. }
  4151. ],
  4152. "responses": {
  4153. "204": {
  4154. "$ref": "#/responses/empty"
  4155. }
  4156. }
  4157. }
  4158. },
  4159. "/user/gpg_keys": {
  4160. "get": {
  4161. "produces": [
  4162. "application/json"
  4163. ],
  4164. "tags": [
  4165. "user"
  4166. ],
  4167. "summary": "List the authenticated user's GPG keys",
  4168. "operationId": "userCurrentListGPGKeys",
  4169. "responses": {
  4170. "200": {
  4171. "$ref": "#/responses/GPGKeyList"
  4172. }
  4173. }
  4174. },
  4175. "post": {
  4176. "consumes": [
  4177. "application/json"
  4178. ],
  4179. "produces": [
  4180. "application/json"
  4181. ],
  4182. "tags": [
  4183. "user"
  4184. ],
  4185. "summary": "Create a GPG key",
  4186. "operationId": "userCurrentPostGPGKey",
  4187. "parameters": [
  4188. {
  4189. "name": "Form",
  4190. "in": "body",
  4191. "schema": {
  4192. "$ref": "#/definitions/CreateGPGKeyOption"
  4193. }
  4194. }
  4195. ],
  4196. "responses": {
  4197. "201": {
  4198. "$ref": "#/responses/GPGKey"
  4199. },
  4200. "422": {
  4201. "$ref": "#/responses/validationError"
  4202. }
  4203. }
  4204. }
  4205. },
  4206. "/user/gpg_keys/{id}": {
  4207. "get": {
  4208. "produces": [
  4209. "application/json"
  4210. ],
  4211. "tags": [
  4212. "user"
  4213. ],
  4214. "summary": "Get a GPG key",
  4215. "operationId": "userCurrentGetGPGKey",
  4216. "parameters": [
  4217. {
  4218. "type": "integer",
  4219. "description": "id of key to get",
  4220. "name": "id",
  4221. "in": "path",
  4222. "required": true
  4223. }
  4224. ],
  4225. "responses": {
  4226. "200": {
  4227. "$ref": "#/responses/GPGKey"
  4228. },
  4229. "404": {
  4230. "$ref": "#/responses/notFound"
  4231. }
  4232. }
  4233. },
  4234. "delete": {
  4235. "produces": [
  4236. "application/json"
  4237. ],
  4238. "tags": [
  4239. "user"
  4240. ],
  4241. "summary": "Remove a GPG key",
  4242. "operationId": "userCurrentDeleteGPGKey",
  4243. "parameters": [
  4244. {
  4245. "type": "integer",
  4246. "description": "id of key to delete",
  4247. "name": "id",
  4248. "in": "path",
  4249. "required": true
  4250. }
  4251. ],
  4252. "responses": {
  4253. "204": {
  4254. "$ref": "#/responses/empty"
  4255. },
  4256. "403": {
  4257. "$ref": "#/responses/forbidden"
  4258. }
  4259. }
  4260. }
  4261. },
  4262. "/user/keys": {
  4263. "get": {
  4264. "produces": [
  4265. "application/json"
  4266. ],
  4267. "tags": [
  4268. "user"
  4269. ],
  4270. "summary": "List the authenticated user's public keys",
  4271. "operationId": "userCurrentListKeys",
  4272. "responses": {
  4273. "200": {
  4274. "$ref": "#/responses/PublicKeyList"
  4275. }
  4276. }
  4277. },
  4278. "post": {
  4279. "consumes": [
  4280. "application/json"
  4281. ],
  4282. "produces": [
  4283. "application/json"
  4284. ],
  4285. "tags": [
  4286. "user"
  4287. ],
  4288. "summary": "Create a public key",
  4289. "operationId": "userCurrentPostKey",
  4290. "parameters": [
  4291. {
  4292. "name": "body",
  4293. "in": "body",
  4294. "schema": {
  4295. "$ref": "#/definitions/CreateKeyOption"
  4296. }
  4297. }
  4298. ],
  4299. "responses": {
  4300. "201": {
  4301. "$ref": "#/responses/PublicKey"
  4302. },
  4303. "422": {
  4304. "$ref": "#/responses/validationError"
  4305. }
  4306. }
  4307. }
  4308. },
  4309. "/user/keys/{id}": {
  4310. "get": {
  4311. "produces": [
  4312. "application/json"
  4313. ],
  4314. "tags": [
  4315. "user"
  4316. ],
  4317. "summary": "Get a public key",
  4318. "operationId": "userCurrentGetKey",
  4319. "parameters": [
  4320. {
  4321. "type": "integer",
  4322. "description": "id of key to get",
  4323. "name": "id",
  4324. "in": "path",
  4325. "required": true
  4326. }
  4327. ],
  4328. "responses": {
  4329. "200": {
  4330. "$ref": "#/responses/PublicKey"
  4331. },
  4332. "404": {
  4333. "$ref": "#/responses/notFound"
  4334. }
  4335. }
  4336. },
  4337. "delete": {
  4338. "produces": [
  4339. "application/json"
  4340. ],
  4341. "tags": [
  4342. "user"
  4343. ],
  4344. "summary": "Delete a public key",
  4345. "operationId": "userCurrentDeleteKey",
  4346. "parameters": [
  4347. {
  4348. "type": "integer",
  4349. "description": "id of key to delete",
  4350. "name": "id",
  4351. "in": "path",
  4352. "required": true
  4353. }
  4354. ],
  4355. "responses": {
  4356. "204": {
  4357. "$ref": "#/responses/empty"
  4358. },
  4359. "403": {
  4360. "$ref": "#/responses/forbidden"
  4361. }
  4362. }
  4363. }
  4364. },
  4365. "/user/orgs": {
  4366. "get": {
  4367. "produces": [
  4368. "application/json"
  4369. ],
  4370. "tags": [
  4371. "organization"
  4372. ],
  4373. "summary": "List the current user's organizations",
  4374. "operationId": "orgListCurrentUserOrgs",
  4375. "responses": {
  4376. "200": {
  4377. "$ref": "#/responses/OrganizationList"
  4378. }
  4379. }
  4380. }
  4381. },
  4382. "/user/repos": {
  4383. "get": {
  4384. "produces": [
  4385. "application/json"
  4386. ],
  4387. "tags": [
  4388. "user"
  4389. ],
  4390. "summary": "List the repos that the authenticated user owns or has access to",
  4391. "operationId": "userCurrentListRepos",
  4392. "responses": {
  4393. "200": {
  4394. "$ref": "#/responses/RepositoryList"
  4395. }
  4396. }
  4397. },
  4398. "post": {
  4399. "consumes": [
  4400. "application/json"
  4401. ],
  4402. "produces": [
  4403. "application/json"
  4404. ],
  4405. "tags": [
  4406. "repository",
  4407. "user"
  4408. ],
  4409. "summary": "Create a repository",
  4410. "operationId": "createCurrentUserRepo",
  4411. "parameters": [
  4412. {
  4413. "name": "body",
  4414. "in": "body",
  4415. "schema": {
  4416. "$ref": "#/definitions/CreateRepoOption"
  4417. }
  4418. }
  4419. ],
  4420. "responses": {
  4421. "201": {
  4422. "$ref": "#/responses/Repository"
  4423. }
  4424. }
  4425. }
  4426. },
  4427. "/user/starred": {
  4428. "get": {
  4429. "produces": [
  4430. "application/json"
  4431. ],
  4432. "tags": [
  4433. "user"
  4434. ],
  4435. "summary": "The repos that the authenticated user has starred",
  4436. "operationId": "userCurrentListStarred",
  4437. "responses": {
  4438. "200": {
  4439. "$ref": "#/responses/RepositoryList"
  4440. }
  4441. }
  4442. }
  4443. },
  4444. "/user/starred/{owner}/{repo}": {
  4445. "get": {
  4446. "tags": [
  4447. "user"
  4448. ],
  4449. "summary": "Whether the authenticated is starring the repo",
  4450. "operationId": "userCurrentCheckStarring",
  4451. "parameters": [
  4452. {
  4453. "type": "string",
  4454. "description": "owner of the repo",
  4455. "name": "owner",
  4456. "in": "path",
  4457. "required": true
  4458. },
  4459. {
  4460. "type": "string",
  4461. "description": "name of the repo",
  4462. "name": "repo",
  4463. "in": "path",
  4464. "required": true
  4465. }
  4466. ],
  4467. "responses": {
  4468. "204": {
  4469. "$ref": "#/responses/empty"
  4470. },
  4471. "404": {
  4472. "$ref": "#/responses/notFound"
  4473. }
  4474. }
  4475. },
  4476. "put": {
  4477. "tags": [
  4478. "user"
  4479. ],
  4480. "summary": "Star the given repo",
  4481. "operationId": "userCurrentPutStar",
  4482. "parameters": [
  4483. {
  4484. "type": "string",
  4485. "description": "owner of the repo to star",
  4486. "name": "owner",
  4487. "in": "path",
  4488. "required": true
  4489. },
  4490. {
  4491. "type": "string",
  4492. "description": "name of the repo to star",
  4493. "name": "repo",
  4494. "in": "path",
  4495. "required": true
  4496. }
  4497. ],
  4498. "responses": {
  4499. "204": {
  4500. "$ref": "#/responses/empty"
  4501. }
  4502. }
  4503. },
  4504. "delete": {
  4505. "tags": [
  4506. "user"
  4507. ],
  4508. "summary": "Unstar the given repo",
  4509. "operationId": "userCurrentDeleteStar",
  4510. "parameters": [
  4511. {
  4512. "type": "string",
  4513. "description": "owner of the repo to unstar",
  4514. "name": "owner",
  4515. "in": "path",
  4516. "required": true
  4517. },
  4518. {
  4519. "type": "string",
  4520. "description": "name of the repo to unstar",
  4521. "name": "repo",
  4522. "in": "path",
  4523. "required": true
  4524. }
  4525. ],
  4526. "responses": {
  4527. "204": {
  4528. "$ref": "#/responses/empty"
  4529. }
  4530. }
  4531. }
  4532. },
  4533. "/user/subscriptions": {
  4534. "get": {
  4535. "produces": [
  4536. "application/json"
  4537. ],
  4538. "tags": [
  4539. "user"
  4540. ],
  4541. "summary": "List repositories watched by the authenticated user",
  4542. "operationId": "userCurrentListSubscriptions",
  4543. "responses": {
  4544. "200": {
  4545. "$ref": "#/responses/RepositoryList"
  4546. }
  4547. }
  4548. }
  4549. },
  4550. "/user/times": {
  4551. "get": {
  4552. "produces": [
  4553. "application/json"
  4554. ],
  4555. "tags": [
  4556. "user"
  4557. ],
  4558. "summary": "List the current user's tracked times",
  4559. "operationId": "userCurrentTrackedTimes",
  4560. "responses": {
  4561. "200": {
  4562. "$ref": "#/responses/TrackedTimeList"
  4563. }
  4564. }
  4565. }
  4566. },
  4567. "/user/{username}/orgs": {
  4568. "get": {
  4569. "produces": [
  4570. "application/json"
  4571. ],
  4572. "tags": [
  4573. "organization"
  4574. ],
  4575. "summary": "List a user's organizations",
  4576. "operationId": "orgListUserOrgs",
  4577. "parameters": [
  4578. {
  4579. "type": "string",
  4580. "description": "username of user",
  4581. "name": "username",
  4582. "in": "path"
  4583. }
  4584. ],
  4585. "responses": {
  4586. "200": {
  4587. "$ref": "#/responses/OrganizationList"
  4588. }
  4589. }
  4590. }
  4591. },
  4592. "/users/search": {
  4593. "get": {
  4594. "produces": [
  4595. "application/json"
  4596. ],
  4597. "tags": [
  4598. "user"
  4599. ],
  4600. "summary": "Search for users",
  4601. "operationId": "userSearch",
  4602. "parameters": [
  4603. {
  4604. "type": "string",
  4605. "description": "keyword",
  4606. "name": "q",
  4607. "in": "query"
  4608. },
  4609. {
  4610. "type": "integer",
  4611. "description": "maximum number of users to return",
  4612. "name": "limit",
  4613. "in": "query"
  4614. }
  4615. ],
  4616. "responses": {
  4617. "200": {
  4618. "$ref": "#/responses/UserList"
  4619. }
  4620. }
  4621. }
  4622. },
  4623. "/users/{follower}/following/{followee}": {
  4624. "get": {
  4625. "tags": [
  4626. "user"
  4627. ],
  4628. "summary": "Check if one user is following another user",
  4629. "operationId": "userCheckFollowing",
  4630. "parameters": [
  4631. {
  4632. "type": "string",
  4633. "description": "username of following user",
  4634. "name": "follower",
  4635. "in": "path",
  4636. "required": true
  4637. },
  4638. {
  4639. "type": "string",
  4640. "description": "username of followed user",
  4641. "name": "followee",
  4642. "in": "path",
  4643. "required": true
  4644. }
  4645. ],
  4646. "responses": {
  4647. "204": {
  4648. "$ref": "#/responses/empty"
  4649. },
  4650. "404": {
  4651. "$ref": "#/responses/notFound"
  4652. }
  4653. }
  4654. }
  4655. },
  4656. "/users/{username}": {
  4657. "get": {
  4658. "produces": [
  4659. "application/json"
  4660. ],
  4661. "tags": [
  4662. "user"
  4663. ],
  4664. "summary": "Get a user",
  4665. "operationId": "userGet",
  4666. "parameters": [
  4667. {
  4668. "type": "string",
  4669. "description": "username of user to get",
  4670. "name": "username",
  4671. "in": "path",
  4672. "required": true
  4673. }
  4674. ],
  4675. "responses": {
  4676. "200": {
  4677. "$ref": "#/responses/User"
  4678. },
  4679. "404": {
  4680. "$ref": "#/responses/notFound"
  4681. }
  4682. }
  4683. }
  4684. },
  4685. "/users/{username}/followers": {
  4686. "get": {
  4687. "produces": [
  4688. "application/json"
  4689. ],
  4690. "tags": [
  4691. "user"
  4692. ],
  4693. "summary": "List the given user's followers",
  4694. "operationId": "userListFollowers",
  4695. "parameters": [
  4696. {
  4697. "type": "string",
  4698. "description": "username of user",
  4699. "name": "username",
  4700. "in": "path",
  4701. "required": true
  4702. }
  4703. ],
  4704. "responses": {
  4705. "200": {
  4706. "$ref": "#/responses/UserList"
  4707. }
  4708. }
  4709. }
  4710. },
  4711. "/users/{username}/following": {
  4712. "get": {
  4713. "produces": [
  4714. "application/json"
  4715. ],
  4716. "tags": [
  4717. "user"
  4718. ],
  4719. "summary": "List the users that the given user is following",
  4720. "operationId": "userListFollowing",
  4721. "parameters": [
  4722. {
  4723. "type": "string",
  4724. "description": "username of user",
  4725. "name": "username",
  4726. "in": "path",
  4727. "required": true
  4728. }
  4729. ],
  4730. "responses": {
  4731. "200": {
  4732. "$ref": "#/responses/UserList"
  4733. }
  4734. }
  4735. }
  4736. },
  4737. "/users/{username}/gpg_keys": {
  4738. "get": {
  4739. "produces": [
  4740. "application/json"
  4741. ],
  4742. "tags": [
  4743. "user"
  4744. ],
  4745. "summary": "List the given user's GPG keys",
  4746. "operationId": "userListGPGKeys",
  4747. "parameters": [
  4748. {
  4749. "type": "string",
  4750. "description": "username of user",
  4751. "name": "username",
  4752. "in": "path",
  4753. "required": true
  4754. }
  4755. ],
  4756. "responses": {
  4757. "200": {
  4758. "$ref": "#/responses/GPGKeyList"
  4759. }
  4760. }
  4761. }
  4762. },
  4763. "/users/{username}/keys": {
  4764. "get": {
  4765. "produces": [
  4766. "application/json"
  4767. ],
  4768. "tags": [
  4769. "user"
  4770. ],
  4771. "summary": "List the given user's public keys",
  4772. "operationId": "userListKeys",
  4773. "parameters": [
  4774. {
  4775. "type": "string",
  4776. "description": "username of user",
  4777. "name": "username",
  4778. "in": "path",
  4779. "required": true
  4780. }
  4781. ],
  4782. "responses": {
  4783. "200": {
  4784. "$ref": "#/responses/PublicKeyList"
  4785. }
  4786. }
  4787. }
  4788. },
  4789. "/users/{username}/repos": {
  4790. "get": {
  4791. "produces": [
  4792. "application/json"
  4793. ],
  4794. "tags": [
  4795. "user"
  4796. ],
  4797. "summary": "List the repos owned by the given user",
  4798. "operationId": "userListRepos",
  4799. "parameters": [
  4800. {
  4801. "type": "string",
  4802. "description": "username of user",
  4803. "name": "username",
  4804. "in": "path",
  4805. "required": true
  4806. }
  4807. ],
  4808. "responses": {
  4809. "200": {
  4810. "$ref": "#/responses/RepositoryList"
  4811. }
  4812. }
  4813. }
  4814. },
  4815. "/users/{username}/starred": {
  4816. "get": {
  4817. "produces": [
  4818. "application/json"
  4819. ],
  4820. "tags": [
  4821. "user"
  4822. ],
  4823. "summary": "The repos that the given user has starred",
  4824. "operationId": "userListStarred",
  4825. "parameters": [
  4826. {
  4827. "type": "string",
  4828. "description": "username of user",
  4829. "name": "username",
  4830. "in": "path",
  4831. "required": true
  4832. }
  4833. ],
  4834. "responses": {
  4835. "200": {
  4836. "$ref": "#/responses/RepositoryList"
  4837. }
  4838. }
  4839. }
  4840. },
  4841. "/users/{username}/subscriptions": {
  4842. "get": {
  4843. "produces": [
  4844. "application/json"
  4845. ],
  4846. "tags": [
  4847. "user"
  4848. ],
  4849. "summary": "List the repositories watched by a user",
  4850. "operationId": "userListSubscriptions",
  4851. "parameters": [
  4852. {
  4853. "type": "string",
  4854. "description": "username of the user",
  4855. "name": "username",
  4856. "in": "path"
  4857. }
  4858. ],
  4859. "responses": {
  4860. "200": {
  4861. "$ref": "#/responses/RepositoryList"
  4862. }
  4863. }
  4864. }
  4865. },
  4866. "/users/{username}/tokens": {
  4867. "get": {
  4868. "produces": [
  4869. "application/json"
  4870. ],
  4871. "tags": [
  4872. "user"
  4873. ],
  4874. "summary": "List the authenticated user's access tokens",
  4875. "operationId": "userGetTokens",
  4876. "responses": {
  4877. "200": {
  4878. "$ref": "#/responses/AccessTokenList"
  4879. }
  4880. }
  4881. },
  4882. "post": {
  4883. "consumes": [
  4884. "application/json"
  4885. ],
  4886. "produces": [
  4887. "application/json"
  4888. ],
  4889. "tags": [
  4890. "user"
  4891. ],
  4892. "summary": "Create an access token",
  4893. "operationId": "userCreateToken",
  4894. "parameters": [
  4895. {
  4896. "type": "string",
  4897. "x-go-name": "Name",
  4898. "name": "name",
  4899. "in": "query"
  4900. }
  4901. ],
  4902. "responses": {
  4903. "200": {
  4904. "$ref": "#/responses/AccessToken"
  4905. }
  4906. }
  4907. }
  4908. },
  4909. "/version": {
  4910. "get": {
  4911. "produces": [
  4912. "application/json"
  4913. ],
  4914. "tags": [
  4915. "miscellaneous"
  4916. ],
  4917. "summary": "Returns the version of the Gitea application",
  4918. "operationId": "getVersion",
  4919. "responses": {
  4920. "200": {
  4921. "$ref": "#/responses/ServerVersion"
  4922. }
  4923. }
  4924. }
  4925. }
  4926. },
  4927. "definitions": {
  4928. "AddCollaboratorOption": {
  4929. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  4930. "type": "object",
  4931. "properties": {
  4932. "permission": {
  4933. "type": "string",
  4934. "x-go-name": "Permission"
  4935. }
  4936. },
  4937. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  4938. },
  4939. "AddTimeOption": {
  4940. "description": "AddTimeOption options for adding time to an issue",
  4941. "type": "object",
  4942. "required": [
  4943. "time"
  4944. ],
  4945. "properties": {
  4946. "time": {
  4947. "description": "time in seconds",
  4948. "type": "integer",
  4949. "format": "int64",
  4950. "x-go-name": "Time"
  4951. }
  4952. },
  4953. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  4954. },
  4955. "Branch": {
  4956. "description": "Branch represents a repository branch",
  4957. "type": "object",
  4958. "properties": {
  4959. "commit": {
  4960. "$ref": "#/definitions/PayloadCommit"
  4961. },
  4962. "name": {
  4963. "type": "string",
  4964. "x-go-name": "Name"
  4965. }
  4966. },
  4967. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  4968. },
  4969. "Comment": {
  4970. "description": "Comment represents a comment on a commit or issue",
  4971. "type": "object",
  4972. "properties": {
  4973. "body": {
  4974. "type": "string",
  4975. "x-go-name": "Body"
  4976. },
  4977. "created_at": {
  4978. "type": "string",
  4979. "format": "date-time",
  4980. "x-go-name": "Created"
  4981. },
  4982. "html_url": {
  4983. "type": "string",
  4984. "x-go-name": "HTMLURL"
  4985. },
  4986. "id": {
  4987. "type": "integer",
  4988. "format": "int64",
  4989. "x-go-name": "ID"
  4990. },
  4991. "issue_url": {
  4992. "type": "string",
  4993. "x-go-name": "IssueURL"
  4994. },
  4995. "pull_request_url": {
  4996. "type": "string",
  4997. "x-go-name": "PRURL"
  4998. },
  4999. "updated_at": {
  5000. "type": "string",
  5001. "format": "date-time",
  5002. "x-go-name": "Updated"
  5003. },
  5004. "user": {
  5005. "$ref": "#/definitions/User"
  5006. }
  5007. },
  5008. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5009. },
  5010. "CreateEmailOption": {
  5011. "description": "CreateEmailOption options when creating email addresses",
  5012. "type": "object",
  5013. "properties": {
  5014. "emails": {
  5015. "description": "email addresses to add",
  5016. "type": "array",
  5017. "items": {
  5018. "type": "string"
  5019. },
  5020. "x-go-name": "Emails"
  5021. }
  5022. },
  5023. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5024. },
  5025. "CreateForkOption": {
  5026. "description": "CreateForkOption options for creating a fork",
  5027. "type": "object",
  5028. "properties": {
  5029. "organization": {
  5030. "description": "organization name, if forking into an organization",
  5031. "type": "string",
  5032. "x-go-name": "Organization"
  5033. }
  5034. },
  5035. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5036. },
  5037. "CreateGPGKeyOption": {
  5038. "description": "CreateGPGKeyOption options create user GPG key",
  5039. "type": "object",
  5040. "required": [
  5041. "armored_public_key"
  5042. ],
  5043. "properties": {
  5044. "armored_public_key": {
  5045. "description": "An armored GPG key to add",
  5046. "type": "string",
  5047. "uniqueItems": true,
  5048. "x-go-name": "ArmoredKey"
  5049. }
  5050. },
  5051. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5052. },
  5053. "CreateHookOption": {
  5054. "description": "CreateHookOption options when create a hook",
  5055. "type": "object",
  5056. "required": [
  5057. "type",
  5058. "config"
  5059. ],
  5060. "properties": {
  5061. "active": {
  5062. "type": "boolean",
  5063. "default": false,
  5064. "x-go-name": "Active"
  5065. },
  5066. "config": {
  5067. "type": "object",
  5068. "additionalProperties": {
  5069. "type": "string"
  5070. },
  5071. "x-go-name": "Config"
  5072. },
  5073. "events": {
  5074. "type": "array",
  5075. "items": {
  5076. "type": "string"
  5077. },
  5078. "x-go-name": "Events"
  5079. },
  5080. "type": {
  5081. "type": "string",
  5082. "enum": [
  5083. "gitea",
  5084. "gogs",
  5085. "slack",
  5086. "discord"
  5087. ],
  5088. "x-go-name": "Type"
  5089. }
  5090. },
  5091. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5092. },
  5093. "CreateIssueCommentOption": {
  5094. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  5095. "type": "object",
  5096. "required": [
  5097. "body"
  5098. ],
  5099. "properties": {
  5100. "body": {
  5101. "type": "string",
  5102. "x-go-name": "Body"
  5103. }
  5104. },
  5105. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5106. },
  5107. "CreateIssueOption": {
  5108. "description": "CreateIssueOption options to create one issue",
  5109. "type": "object",
  5110. "required": [
  5111. "title"
  5112. ],
  5113. "properties": {
  5114. "assignee": {
  5115. "description": "username of assignee",
  5116. "type": "string",
  5117. "x-go-name": "Assignee"
  5118. },
  5119. "body": {
  5120. "type": "string",
  5121. "x-go-name": "Body"
  5122. },
  5123. "closed": {
  5124. "type": "boolean",
  5125. "x-go-name": "Closed"
  5126. },
  5127. "labels": {
  5128. "description": "list of label ids",
  5129. "type": "array",
  5130. "items": {
  5131. "type": "integer",
  5132. "format": "int64"
  5133. },
  5134. "x-go-name": "Labels"
  5135. },
  5136. "milestone": {
  5137. "description": "milestone id",
  5138. "type": "integer",
  5139. "format": "int64",
  5140. "x-go-name": "Milestone"
  5141. },
  5142. "title": {
  5143. "type": "string",
  5144. "x-go-name": "Title"
  5145. }
  5146. },
  5147. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5148. },
  5149. "CreateKeyOption": {
  5150. "description": "CreateKeyOption options when creating a key",
  5151. "type": "object",
  5152. "required": [
  5153. "title",
  5154. "key"
  5155. ],
  5156. "properties": {
  5157. "key": {
  5158. "description": "An armored SSH key to add",
  5159. "type": "string",
  5160. "uniqueItems": true,
  5161. "x-go-name": "Key"
  5162. },
  5163. "title": {
  5164. "description": "Title of the key to add",
  5165. "type": "string",
  5166. "uniqueItems": true,
  5167. "x-go-name": "Title"
  5168. }
  5169. },
  5170. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5171. },
  5172. "CreateLabelOption": {
  5173. "description": "CreateLabelOption options for creating a label",
  5174. "type": "object",
  5175. "required": [
  5176. "name",
  5177. "color"
  5178. ],
  5179. "properties": {
  5180. "color": {
  5181. "type": "string",
  5182. "x-go-name": "Color",
  5183. "example": "#00aabb"
  5184. },
  5185. "name": {
  5186. "type": "string",
  5187. "x-go-name": "Name"
  5188. }
  5189. },
  5190. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5191. },
  5192. "CreateMilestoneOption": {
  5193. "description": "CreateMilestoneOption options for creating a milestone",
  5194. "type": "object",
  5195. "properties": {
  5196. "description": {
  5197. "type": "string",
  5198. "x-go-name": "Description"
  5199. },
  5200. "due_on": {
  5201. "type": "string",
  5202. "format": "date-time",
  5203. "x-go-name": "Deadline"
  5204. },
  5205. "title": {
  5206. "type": "string",
  5207. "x-go-name": "Title"
  5208. }
  5209. },
  5210. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5211. },
  5212. "CreateOrgOption": {
  5213. "description": "CreateOrgOption options for creating an organization",
  5214. "type": "object",
  5215. "required": [
  5216. "username"
  5217. ],
  5218. "properties": {
  5219. "description": {
  5220. "type": "string",
  5221. "x-go-name": "Description"
  5222. },
  5223. "full_name": {
  5224. "type": "string",
  5225. "x-go-name": "FullName"
  5226. },
  5227. "location": {
  5228. "type": "string",
  5229. "x-go-name": "Location"
  5230. },
  5231. "username": {
  5232. "type": "string",
  5233. "x-go-name": "UserName"
  5234. },
  5235. "website": {
  5236. "type": "string",
  5237. "x-go-name": "Website"
  5238. }
  5239. },
  5240. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5241. },
  5242. "CreatePullRequestOption": {
  5243. "description": "CreatePullRequestOption options when creating a pull request",
  5244. "type": "object",
  5245. "properties": {
  5246. "assignee": {
  5247. "type": "string",
  5248. "x-go-name": "Assignee"
  5249. },
  5250. "base": {
  5251. "type": "string",
  5252. "x-go-name": "Base"
  5253. },
  5254. "body": {
  5255. "type": "string",
  5256. "x-go-name": "Body"
  5257. },
  5258. "head": {
  5259. "type": "string",
  5260. "x-go-name": "Head"
  5261. },
  5262. "labels": {
  5263. "type": "array",
  5264. "items": {
  5265. "type": "integer",
  5266. "format": "int64"
  5267. },
  5268. "x-go-name": "Labels"
  5269. },
  5270. "milestone": {
  5271. "type": "integer",
  5272. "format": "int64",
  5273. "x-go-name": "Milestone"
  5274. },
  5275. "title": {
  5276. "type": "string",
  5277. "x-go-name": "Title"
  5278. }
  5279. },
  5280. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5281. },
  5282. "CreateReleaseOption": {
  5283. "description": "CreateReleaseOption options when creating a release",
  5284. "type": "object",
  5285. "required": [
  5286. "tag_name"
  5287. ],
  5288. "properties": {
  5289. "body": {
  5290. "type": "string",
  5291. "x-go-name": "Note"
  5292. },
  5293. "draft": {
  5294. "type": "boolean",
  5295. "x-go-name": "IsDraft"
  5296. },
  5297. "name": {
  5298. "type": "string",
  5299. "x-go-name": "Title"
  5300. },
  5301. "prerelease": {
  5302. "type": "boolean",
  5303. "x-go-name": "IsPrerelease"
  5304. },
  5305. "tag_name": {
  5306. "type": "string",
  5307. "x-go-name": "TagName"
  5308. },
  5309. "target_commitish": {
  5310. "type": "string",
  5311. "x-go-name": "Target"
  5312. }
  5313. },
  5314. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5315. },
  5316. "CreateRepoOption": {
  5317. "description": "CreateRepoOption options when creating repository",
  5318. "type": "object",
  5319. "required": [
  5320. "name"
  5321. ],
  5322. "properties": {
  5323. "auto_init": {
  5324. "description": "Whether the repository should be auto-intialized?",
  5325. "type": "boolean",
  5326. "x-go-name": "AutoInit"
  5327. },
  5328. "description": {
  5329. "description": "Description of the repository to create",
  5330. "type": "string",
  5331. "x-go-name": "Description"
  5332. },
  5333. "gitignores": {
  5334. "description": "Gitignores to use",
  5335. "type": "string",
  5336. "x-go-name": "Gitignores"
  5337. },
  5338. "license": {
  5339. "description": "License to use",
  5340. "type": "string",
  5341. "x-go-name": "License"
  5342. },
  5343. "name": {
  5344. "description": "Name of the repository to create",
  5345. "type": "string",
  5346. "uniqueItems": true,
  5347. "x-go-name": "Name"
  5348. },
  5349. "private": {
  5350. "description": "Whether the repository is private",
  5351. "type": "boolean",
  5352. "x-go-name": "Private"
  5353. },
  5354. "readme": {
  5355. "description": "Readme of the repository to create",
  5356. "type": "string",
  5357. "x-go-name": "Readme"
  5358. }
  5359. },
  5360. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5361. },
  5362. "CreateStatusOption": {
  5363. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  5364. "type": "object",
  5365. "properties": {
  5366. "context": {
  5367. "type": "string",
  5368. "x-go-name": "Context"
  5369. },
  5370. "description": {
  5371. "type": "string",
  5372. "x-go-name": "Description"
  5373. },
  5374. "state": {
  5375. "$ref": "#/definitions/StatusState"
  5376. },
  5377. "target_url": {
  5378. "type": "string",
  5379. "x-go-name": "TargetURL"
  5380. }
  5381. },
  5382. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5383. },
  5384. "CreateTeamOption": {
  5385. "description": "CreateTeamOption options for creating a team",
  5386. "type": "object",
  5387. "required": [
  5388. "name"
  5389. ],
  5390. "properties": {
  5391. "description": {
  5392. "type": "string",
  5393. "x-go-name": "Description"
  5394. },
  5395. "name": {
  5396. "type": "string",
  5397. "x-go-name": "Name"
  5398. },
  5399. "permission": {
  5400. "type": "string",
  5401. "enum": [
  5402. "read",
  5403. "write",
  5404. "admin"
  5405. ],
  5406. "x-go-name": "Permission"
  5407. }
  5408. },
  5409. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5410. },
  5411. "CreateUserOption": {
  5412. "description": "CreateUserOption create user options",
  5413. "type": "object",
  5414. "required": [
  5415. "username",
  5416. "email",
  5417. "password"
  5418. ],
  5419. "properties": {
  5420. "email": {
  5421. "type": "string",
  5422. "format": "email",
  5423. "x-go-name": "Email"
  5424. },
  5425. "full_name": {
  5426. "type": "string",
  5427. "x-go-name": "FullName"
  5428. },
  5429. "login_name": {
  5430. "type": "string",
  5431. "x-go-name": "LoginName"
  5432. },
  5433. "password": {
  5434. "type": "string",
  5435. "x-go-name": "Password"
  5436. },
  5437. "send_notify": {
  5438. "type": "boolean",
  5439. "x-go-name": "SendNotify"
  5440. },
  5441. "source_id": {
  5442. "type": "integer",
  5443. "format": "int64",
  5444. "x-go-name": "SourceID"
  5445. },
  5446. "username": {
  5447. "type": "string",
  5448. "x-go-name": "Username"
  5449. }
  5450. },
  5451. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5452. },
  5453. "DeleteEmailOption": {
  5454. "description": "DeleteEmailOption options when deleting email addresses",
  5455. "type": "object",
  5456. "properties": {
  5457. "emails": {
  5458. "description": "email addresses to delete",
  5459. "type": "array",
  5460. "items": {
  5461. "type": "string"
  5462. },
  5463. "x-go-name": "Emails"
  5464. }
  5465. },
  5466. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5467. },
  5468. "DeployKey": {
  5469. "description": "DeployKey a deploy key",
  5470. "type": "object",
  5471. "properties": {
  5472. "created_at": {
  5473. "type": "string",
  5474. "format": "date-time",
  5475. "x-go-name": "Created"
  5476. },
  5477. "id": {
  5478. "type": "integer",
  5479. "format": "int64",
  5480. "x-go-name": "ID"
  5481. },
  5482. "key": {
  5483. "type": "string",
  5484. "x-go-name": "Key"
  5485. },
  5486. "read_only": {
  5487. "type": "boolean",
  5488. "x-go-name": "ReadOnly"
  5489. },
  5490. "title": {
  5491. "type": "string",
  5492. "x-go-name": "Title"
  5493. },
  5494. "url": {
  5495. "type": "string",
  5496. "x-go-name": "URL"
  5497. }
  5498. },
  5499. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5500. },
  5501. "EditHookOption": {
  5502. "description": "EditHookOption options when modify one hook",
  5503. "type": "object",
  5504. "properties": {
  5505. "active": {
  5506. "type": "boolean",
  5507. "x-go-name": "Active"
  5508. },
  5509. "config": {
  5510. "type": "object",
  5511. "additionalProperties": {
  5512. "type": "string"
  5513. },
  5514. "x-go-name": "Config"
  5515. },
  5516. "events": {
  5517. "type": "array",
  5518. "items": {
  5519. "type": "string"
  5520. },
  5521. "x-go-name": "Events"
  5522. }
  5523. },
  5524. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5525. },
  5526. "EditIssueCommentOption": {
  5527. "description": "EditIssueCommentOption options for editing a comment",
  5528. "type": "object",
  5529. "required": [
  5530. "body"
  5531. ],
  5532. "properties": {
  5533. "body": {
  5534. "type": "string",
  5535. "x-go-name": "Body"
  5536. }
  5537. },
  5538. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5539. },
  5540. "EditIssueOption": {
  5541. "description": "EditIssueOption options for editing an issue",
  5542. "type": "object",
  5543. "properties": {
  5544. "assignee": {
  5545. "type": "string",
  5546. "x-go-name": "Assignee"
  5547. },
  5548. "body": {
  5549. "type": "string",
  5550. "x-go-name": "Body"
  5551. },
  5552. "milestone": {
  5553. "type": "integer",
  5554. "format": "int64",
  5555. "x-go-name": "Milestone"
  5556. },
  5557. "state": {
  5558. "type": "string",
  5559. "x-go-name": "State"
  5560. },
  5561. "title": {
  5562. "type": "string",
  5563. "x-go-name": "Title"
  5564. }
  5565. },
  5566. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5567. },
  5568. "EditLabelOption": {
  5569. "description": "EditLabelOption options for editing a label",
  5570. "type": "object",
  5571. "properties": {
  5572. "color": {
  5573. "type": "string",
  5574. "x-go-name": "Color"
  5575. },
  5576. "name": {
  5577. "type": "string",
  5578. "x-go-name": "Name"
  5579. }
  5580. },
  5581. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5582. },
  5583. "EditMilestoneOption": {
  5584. "description": "EditMilestoneOption options for editing a milestone",
  5585. "type": "object",
  5586. "properties": {
  5587. "description": {
  5588. "type": "string",
  5589. "x-go-name": "Description"
  5590. },
  5591. "due_on": {
  5592. "type": "string",
  5593. "format": "date-time",
  5594. "x-go-name": "Deadline"
  5595. },
  5596. "state": {
  5597. "type": "string",
  5598. "x-go-name": "State"
  5599. },
  5600. "title": {
  5601. "type": "string",
  5602. "x-go-name": "Title"
  5603. }
  5604. },
  5605. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5606. },
  5607. "EditOrgOption": {
  5608. "description": "EditOrgOption options for editing an organization",
  5609. "type": "object",
  5610. "properties": {
  5611. "description": {
  5612. "type": "string",
  5613. "x-go-name": "Description"
  5614. },
  5615. "full_name": {
  5616. "type": "string",
  5617. "x-go-name": "FullName"
  5618. },
  5619. "location": {
  5620. "type": "string",
  5621. "x-go-name": "Location"
  5622. },
  5623. "website": {
  5624. "type": "string",
  5625. "x-go-name": "Website"
  5626. }
  5627. },
  5628. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5629. },
  5630. "EditPullRequestOption": {
  5631. "description": "EditPullRequestOption options when modify pull request",
  5632. "type": "object",
  5633. "properties": {
  5634. "assignee": {
  5635. "type": "string",
  5636. "x-go-name": "Assignee"
  5637. },
  5638. "body": {
  5639. "type": "string",
  5640. "x-go-name": "Body"
  5641. },
  5642. "labels": {
  5643. "type": "array",
  5644. "items": {
  5645. "type": "integer",
  5646. "format": "int64"
  5647. },
  5648. "x-go-name": "Labels"
  5649. },
  5650. "milestone": {
  5651. "type": "integer",
  5652. "format": "int64",
  5653. "x-go-name": "Milestone"
  5654. },
  5655. "state": {
  5656. "type": "string",
  5657. "x-go-name": "State"
  5658. },
  5659. "title": {
  5660. "type": "string",
  5661. "x-go-name": "Title"
  5662. }
  5663. },
  5664. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5665. },
  5666. "EditReleaseOption": {
  5667. "description": "EditReleaseOption options when editing a release",
  5668. "type": "object",
  5669. "properties": {
  5670. "body": {
  5671. "type": "string",
  5672. "x-go-name": "Note"
  5673. },
  5674. "draft": {
  5675. "type": "boolean",
  5676. "x-go-name": "IsDraft"
  5677. },
  5678. "name": {
  5679. "type": "string",
  5680. "x-go-name": "Title"
  5681. },
  5682. "prerelease": {
  5683. "type": "boolean",
  5684. "x-go-name": "IsPrerelease"
  5685. },
  5686. "tag_name": {
  5687. "type": "string",
  5688. "x-go-name": "TagName"
  5689. },
  5690. "target_commitish": {
  5691. "type": "string",
  5692. "x-go-name": "Target"
  5693. }
  5694. },
  5695. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5696. },
  5697. "EditTeamOption": {
  5698. "description": "EditTeamOption options for editing a team",
  5699. "type": "object",
  5700. "required": [
  5701. "name"
  5702. ],
  5703. "properties": {
  5704. "description": {
  5705. "type": "string",
  5706. "x-go-name": "Description"
  5707. },
  5708. "name": {
  5709. "type": "string",
  5710. "x-go-name": "Name"
  5711. },
  5712. "permission": {
  5713. "type": "string",
  5714. "enum": [
  5715. "read",
  5716. "write",
  5717. "admin"
  5718. ],
  5719. "x-go-name": "Permission"
  5720. }
  5721. },
  5722. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5723. },
  5724. "EditUserOption": {
  5725. "description": "EditUserOption edit user options",
  5726. "type": "object",
  5727. "required": [
  5728. "email"
  5729. ],
  5730. "properties": {
  5731. "active": {
  5732. "type": "boolean",
  5733. "x-go-name": "Active"
  5734. },
  5735. "admin": {
  5736. "type": "boolean",
  5737. "x-go-name": "Admin"
  5738. },
  5739. "allow_git_hook": {
  5740. "type": "boolean",
  5741. "x-go-name": "AllowGitHook"
  5742. },
  5743. "allow_import_local": {
  5744. "type": "boolean",
  5745. "x-go-name": "AllowImportLocal"
  5746. },
  5747. "email": {
  5748. "type": "string",
  5749. "format": "email",
  5750. "x-go-name": "Email"
  5751. },
  5752. "full_name": {
  5753. "type": "string",
  5754. "x-go-name": "FullName"
  5755. },
  5756. "location": {
  5757. "type": "string",
  5758. "x-go-name": "Location"
  5759. },
  5760. "login_name": {
  5761. "type": "string",
  5762. "x-go-name": "LoginName"
  5763. },
  5764. "max_repo_creation": {
  5765. "type": "integer",
  5766. "format": "int64",
  5767. "x-go-name": "MaxRepoCreation"
  5768. },
  5769. "password": {
  5770. "type": "string",
  5771. "x-go-name": "Password"
  5772. },
  5773. "source_id": {
  5774. "type": "integer",
  5775. "format": "int64",
  5776. "x-go-name": "SourceID"
  5777. },
  5778. "website": {
  5779. "type": "string",
  5780. "x-go-name": "Website"
  5781. }
  5782. },
  5783. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5784. },
  5785. "Email": {
  5786. "description": "Email an email address belonging to a user",
  5787. "type": "object",
  5788. "properties": {
  5789. "email": {
  5790. "type": "string",
  5791. "format": "email",
  5792. "x-go-name": "Email"
  5793. },
  5794. "primary": {
  5795. "type": "boolean",
  5796. "x-go-name": "Primary"
  5797. },
  5798. "verified": {
  5799. "type": "boolean",
  5800. "x-go-name": "Verified"
  5801. }
  5802. },
  5803. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5804. },
  5805. "GPGKey": {
  5806. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  5807. "type": "object",
  5808. "properties": {
  5809. "can_certify": {
  5810. "type": "boolean",
  5811. "x-go-name": "CanCertify"
  5812. },
  5813. "can_encrypt_comms": {
  5814. "type": "boolean",
  5815. "x-go-name": "CanEncryptComms"
  5816. },
  5817. "can_encrypt_storage": {
  5818. "type": "boolean",
  5819. "x-go-name": "CanEncryptStorage"
  5820. },
  5821. "can_sign": {
  5822. "type": "boolean",
  5823. "x-go-name": "CanSign"
  5824. },
  5825. "created_at": {
  5826. "type": "string",
  5827. "format": "date-time",
  5828. "x-go-name": "Created"
  5829. },
  5830. "emails": {
  5831. "type": "array",
  5832. "items": {
  5833. "$ref": "#/definitions/GPGKeyEmail"
  5834. },
  5835. "x-go-name": "Emails"
  5836. },
  5837. "expires_at": {
  5838. "type": "string",
  5839. "format": "date-time",
  5840. "x-go-name": "Expires"
  5841. },
  5842. "id": {
  5843. "type": "integer",
  5844. "format": "int64",
  5845. "x-go-name": "ID"
  5846. },
  5847. "key_id": {
  5848. "type": "string",
  5849. "x-go-name": "KeyID"
  5850. },
  5851. "primary_key_id": {
  5852. "type": "string",
  5853. "x-go-name": "PrimaryKeyID"
  5854. },
  5855. "public_key": {
  5856. "type": "string",
  5857. "x-go-name": "PublicKey"
  5858. },
  5859. "subkeys": {
  5860. "type": "array",
  5861. "items": {
  5862. "$ref": "#/definitions/GPGKey"
  5863. },
  5864. "x-go-name": "SubsKey"
  5865. }
  5866. },
  5867. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5868. },
  5869. "GPGKeyEmail": {
  5870. "description": "GPGKeyEmail an email attached to a GPGKey",
  5871. "type": "object",
  5872. "properties": {
  5873. "email": {
  5874. "type": "string",
  5875. "x-go-name": "Email"
  5876. },
  5877. "verified": {
  5878. "type": "boolean",
  5879. "x-go-name": "Verified"
  5880. }
  5881. },
  5882. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5883. },
  5884. "Issue": {
  5885. "description": "Issue represents an issue in a repository",
  5886. "type": "object",
  5887. "properties": {
  5888. "assignee": {
  5889. "$ref": "#/definitions/User"
  5890. },
  5891. "body": {
  5892. "type": "string",
  5893. "x-go-name": "Body"
  5894. },
  5895. "comments": {
  5896. "type": "integer",
  5897. "format": "int64",
  5898. "x-go-name": "Comments"
  5899. },
  5900. "created_at": {
  5901. "type": "string",
  5902. "format": "date-time",
  5903. "x-go-name": "Created"
  5904. },
  5905. "id": {
  5906. "type": "integer",
  5907. "format": "int64",
  5908. "x-go-name": "ID"
  5909. },
  5910. "labels": {
  5911. "type": "array",
  5912. "items": {
  5913. "$ref": "#/definitions/Label"
  5914. },
  5915. "x-go-name": "Labels"
  5916. },
  5917. "milestone": {
  5918. "$ref": "#/definitions/Milestone"
  5919. },
  5920. "number": {
  5921. "type": "integer",
  5922. "format": "int64",
  5923. "x-go-name": "Index"
  5924. },
  5925. "pull_request": {
  5926. "$ref": "#/definitions/PullRequestMeta"
  5927. },
  5928. "state": {
  5929. "$ref": "#/definitions/StateType"
  5930. },
  5931. "title": {
  5932. "type": "string",
  5933. "x-go-name": "Title"
  5934. },
  5935. "updated_at": {
  5936. "type": "string",
  5937. "format": "date-time",
  5938. "x-go-name": "Updated"
  5939. },
  5940. "url": {
  5941. "type": "string",
  5942. "x-go-name": "URL"
  5943. },
  5944. "user": {
  5945. "$ref": "#/definitions/User"
  5946. }
  5947. },
  5948. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5949. },
  5950. "IssueLabelsOption": {
  5951. "description": "IssueLabelsOption a collection of labels",
  5952. "type": "object",
  5953. "properties": {
  5954. "labels": {
  5955. "description": "list of label IDs",
  5956. "type": "array",
  5957. "items": {
  5958. "type": "integer",
  5959. "format": "int64"
  5960. },
  5961. "x-go-name": "Labels"
  5962. }
  5963. },
  5964. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5965. },
  5966. "Label": {
  5967. "description": "Label a label to an issue or a pr",
  5968. "type": "object",
  5969. "properties": {
  5970. "color": {
  5971. "type": "string",
  5972. "x-go-name": "Color",
  5973. "example": "00aabb"
  5974. },
  5975. "id": {
  5976. "type": "integer",
  5977. "format": "int64",
  5978. "x-go-name": "ID"
  5979. },
  5980. "name": {
  5981. "type": "string",
  5982. "x-go-name": "Name"
  5983. },
  5984. "url": {
  5985. "type": "string",
  5986. "x-go-name": "URL"
  5987. }
  5988. },
  5989. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  5990. },
  5991. "MarkdownOption": {
  5992. "description": "MarkdownOption markdown options",
  5993. "type": "object",
  5994. "properties": {
  5995. "Context": {
  5996. "description": "Context to render\n\nin: body",
  5997. "type": "string"
  5998. },
  5999. "Mode": {
  6000. "description": "Mode to render\n\nin: body",
  6001. "type": "string"
  6002. },
  6003. "Text": {
  6004. "description": "Text markdown to render\n\nin: body",
  6005. "type": "string"
  6006. },
  6007. "Wiki": {
  6008. "description": "Is it a wiki page ?\n\nin: body",
  6009. "type": "boolean"
  6010. }
  6011. },
  6012. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6013. },
  6014. "MigrateRepoForm": {
  6015. "description": "MigrateRepoForm form for migrating repository",
  6016. "type": "object",
  6017. "required": [
  6018. "clone_addr",
  6019. "uid",
  6020. "repo_name"
  6021. ],
  6022. "properties": {
  6023. "auth_password": {
  6024. "type": "string",
  6025. "x-go-name": "AuthPassword"
  6026. },
  6027. "auth_username": {
  6028. "type": "string",
  6029. "x-go-name": "AuthUsername"
  6030. },
  6031. "clone_addr": {
  6032. "type": "string",
  6033. "x-go-name": "CloneAddr"
  6034. },
  6035. "description": {
  6036. "type": "string",
  6037. "x-go-name": "Description"
  6038. },
  6039. "mirror": {
  6040. "type": "boolean",
  6041. "x-go-name": "Mirror"
  6042. },
  6043. "private": {
  6044. "type": "boolean",
  6045. "x-go-name": "Private"
  6046. },
  6047. "repo_name": {
  6048. "type": "string",
  6049. "x-go-name": "RepoName"
  6050. },
  6051. "uid": {
  6052. "type": "integer",
  6053. "format": "int64",
  6054. "x-go-name": "UID"
  6055. }
  6056. },
  6057. "x-go-package": "code.gitea.io/gitea/modules/auth"
  6058. },
  6059. "Milestone": {
  6060. "description": "Milestone milestone is a collection of issues on one repository",
  6061. "type": "object",
  6062. "properties": {
  6063. "closed_at": {
  6064. "type": "string",
  6065. "format": "date-time",
  6066. "x-go-name": "Closed"
  6067. },
  6068. "closed_issues": {
  6069. "type": "integer",
  6070. "format": "int64",
  6071. "x-go-name": "ClosedIssues"
  6072. },
  6073. "description": {
  6074. "type": "string",
  6075. "x-go-name": "Description"
  6076. },
  6077. "due_on": {
  6078. "type": "string",
  6079. "format": "date-time",
  6080. "x-go-name": "Deadline"
  6081. },
  6082. "id": {
  6083. "type": "integer",
  6084. "format": "int64",
  6085. "x-go-name": "ID"
  6086. },
  6087. "open_issues": {
  6088. "type": "integer",
  6089. "format": "int64",
  6090. "x-go-name": "OpenIssues"
  6091. },
  6092. "state": {
  6093. "$ref": "#/definitions/StateType"
  6094. },
  6095. "title": {
  6096. "type": "string",
  6097. "x-go-name": "Title"
  6098. }
  6099. },
  6100. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6101. },
  6102. "Organization": {
  6103. "description": "Organization represents an organization",
  6104. "type": "object",
  6105. "properties": {
  6106. "avatar_url": {
  6107. "type": "string",
  6108. "x-go-name": "AvatarURL"
  6109. },
  6110. "description": {
  6111. "type": "string",
  6112. "x-go-name": "Description"
  6113. },
  6114. "full_name": {
  6115. "type": "string",
  6116. "x-go-name": "FullName"
  6117. },
  6118. "id": {
  6119. "type": "integer",
  6120. "format": "int64",
  6121. "x-go-name": "ID"
  6122. },
  6123. "location": {
  6124. "type": "string",
  6125. "x-go-name": "Location"
  6126. },
  6127. "username": {
  6128. "type": "string",
  6129. "x-go-name": "UserName"
  6130. },
  6131. "website": {
  6132. "type": "string",
  6133. "x-go-name": "Website"
  6134. }
  6135. },
  6136. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6137. },
  6138. "PRBranchInfo": {
  6139. "description": "PRBranchInfo information about a branch",
  6140. "type": "object",
  6141. "properties": {
  6142. "label": {
  6143. "type": "string",
  6144. "x-go-name": "Name"
  6145. },
  6146. "ref": {
  6147. "type": "string",
  6148. "x-go-name": "Ref"
  6149. },
  6150. "repo": {
  6151. "$ref": "#/definitions/Repository"
  6152. },
  6153. "repo_id": {
  6154. "type": "integer",
  6155. "format": "int64",
  6156. "x-go-name": "RepoID"
  6157. },
  6158. "sha": {
  6159. "type": "string",
  6160. "x-go-name": "Sha"
  6161. }
  6162. },
  6163. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6164. },
  6165. "PayloadCommit": {
  6166. "description": "PayloadCommit represents a commit",
  6167. "type": "object",
  6168. "properties": {
  6169. "author": {
  6170. "$ref": "#/definitions/PayloadUser"
  6171. },
  6172. "committer": {
  6173. "$ref": "#/definitions/PayloadUser"
  6174. },
  6175. "id": {
  6176. "description": "sha1 hash of the commit",
  6177. "type": "string",
  6178. "x-go-name": "ID"
  6179. },
  6180. "message": {
  6181. "type": "string",
  6182. "x-go-name": "Message"
  6183. },
  6184. "timestamp": {
  6185. "type": "string",
  6186. "format": "date-time",
  6187. "x-go-name": "Timestamp"
  6188. },
  6189. "url": {
  6190. "type": "string",
  6191. "x-go-name": "URL"
  6192. },
  6193. "verification": {
  6194. "$ref": "#/definitions/PayloadCommitVerification"
  6195. }
  6196. },
  6197. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6198. },
  6199. "PayloadCommitVerification": {
  6200. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  6201. "type": "object",
  6202. "properties": {
  6203. "payload": {
  6204. "type": "string",
  6205. "x-go-name": "Payload"
  6206. },
  6207. "reason": {
  6208. "type": "string",
  6209. "x-go-name": "Reason"
  6210. },
  6211. "signature": {
  6212. "type": "string",
  6213. "x-go-name": "Signature"
  6214. },
  6215. "verified": {
  6216. "type": "boolean",
  6217. "x-go-name": "Verified"
  6218. }
  6219. },
  6220. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6221. },
  6222. "PayloadUser": {
  6223. "description": "PayloadUser represents the author or committer of a commit",
  6224. "type": "object",
  6225. "properties": {
  6226. "email": {
  6227. "type": "string",
  6228. "format": "email",
  6229. "x-go-name": "Email"
  6230. },
  6231. "name": {
  6232. "description": "Full name of the commit author",
  6233. "type": "string",
  6234. "x-go-name": "Name"
  6235. },
  6236. "username": {
  6237. "type": "string",
  6238. "x-go-name": "UserName"
  6239. }
  6240. },
  6241. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6242. },
  6243. "Permission": {
  6244. "description": "Permission represents a set of permissions",
  6245. "type": "object",
  6246. "properties": {
  6247. "admin": {
  6248. "type": "boolean",
  6249. "x-go-name": "Admin"
  6250. },
  6251. "pull": {
  6252. "type": "boolean",
  6253. "x-go-name": "Pull"
  6254. },
  6255. "push": {
  6256. "type": "boolean",
  6257. "x-go-name": "Push"
  6258. }
  6259. },
  6260. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6261. },
  6262. "PublicKey": {
  6263. "description": "PublicKey publickey is a user key to push code to repository",
  6264. "type": "object",
  6265. "properties": {
  6266. "created_at": {
  6267. "type": "string",
  6268. "format": "date-time",
  6269. "x-go-name": "Created"
  6270. },
  6271. "id": {
  6272. "type": "integer",
  6273. "format": "int64",
  6274. "x-go-name": "ID"
  6275. },
  6276. "key": {
  6277. "type": "string",
  6278. "x-go-name": "Key"
  6279. },
  6280. "title": {
  6281. "type": "string",
  6282. "x-go-name": "Title"
  6283. },
  6284. "fingerprint": {
  6285. "type": "string",
  6286. "x-go-name": "Fingerprint"
  6287. },
  6288. "url": {
  6289. "type": "string",
  6290. "x-go-name": "URL"
  6291. }
  6292. },
  6293. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6294. },
  6295. "PullRequest": {
  6296. "description": "PullRequest represents a pull request",
  6297. "type": "object",
  6298. "properties": {
  6299. "assignee": {
  6300. "$ref": "#/definitions/User"
  6301. },
  6302. "base": {
  6303. "$ref": "#/definitions/PRBranchInfo"
  6304. },
  6305. "body": {
  6306. "type": "string",
  6307. "x-go-name": "Body"
  6308. },
  6309. "comments": {
  6310. "type": "integer",
  6311. "format": "int64",
  6312. "x-go-name": "Comments"
  6313. },
  6314. "created_at": {
  6315. "type": "string",
  6316. "format": "date-time",
  6317. "x-go-name": "Created"
  6318. },
  6319. "diff_url": {
  6320. "type": "string",
  6321. "x-go-name": "DiffURL"
  6322. },
  6323. "head": {
  6324. "$ref": "#/definitions/PRBranchInfo"
  6325. },
  6326. "html_url": {
  6327. "type": "string",
  6328. "x-go-name": "HTMLURL"
  6329. },
  6330. "id": {
  6331. "type": "integer",
  6332. "format": "int64",
  6333. "x-go-name": "ID"
  6334. },
  6335. "labels": {
  6336. "type": "array",
  6337. "items": {
  6338. "$ref": "#/definitions/Label"
  6339. },
  6340. "x-go-name": "Labels"
  6341. },
  6342. "merge_base": {
  6343. "type": "string",
  6344. "x-go-name": "MergeBase"
  6345. },
  6346. "merge_commit_sha": {
  6347. "type": "string",
  6348. "x-go-name": "MergedCommitID"
  6349. },
  6350. "mergeable": {
  6351. "type": "boolean",
  6352. "x-go-name": "Mergeable"
  6353. },
  6354. "merged": {
  6355. "type": "boolean",
  6356. "x-go-name": "HasMerged"
  6357. },
  6358. "merged_at": {
  6359. "type": "string",
  6360. "format": "date-time",
  6361. "x-go-name": "Merged"
  6362. },
  6363. "merged_by": {
  6364. "$ref": "#/definitions/User"
  6365. },
  6366. "milestone": {
  6367. "$ref": "#/definitions/Milestone"
  6368. },
  6369. "number": {
  6370. "type": "integer",
  6371. "format": "int64",
  6372. "x-go-name": "Index"
  6373. },
  6374. "patch_url": {
  6375. "type": "string",
  6376. "x-go-name": "PatchURL"
  6377. },
  6378. "state": {
  6379. "$ref": "#/definitions/StateType"
  6380. },
  6381. "title": {
  6382. "type": "string",
  6383. "x-go-name": "Title"
  6384. },
  6385. "updated_at": {
  6386. "type": "string",
  6387. "format": "date-time",
  6388. "x-go-name": "Updated"
  6389. },
  6390. "url": {
  6391. "type": "string",
  6392. "x-go-name": "URL"
  6393. },
  6394. "user": {
  6395. "$ref": "#/definitions/User"
  6396. }
  6397. },
  6398. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6399. },
  6400. "PullRequestMeta": {
  6401. "description": "PullRequestMeta PR info if an issue is a PR",
  6402. "type": "object",
  6403. "properties": {
  6404. "merged": {
  6405. "type": "boolean",
  6406. "x-go-name": "HasMerged"
  6407. },
  6408. "merged_at": {
  6409. "type": "string",
  6410. "format": "date-time",
  6411. "x-go-name": "Merged"
  6412. }
  6413. },
  6414. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6415. },
  6416. "Release": {
  6417. "description": "Release represents a repository release",
  6418. "type": "object",
  6419. "properties": {
  6420. "author": {
  6421. "$ref": "#/definitions/User"
  6422. },
  6423. "body": {
  6424. "type": "string",
  6425. "x-go-name": "Note"
  6426. },
  6427. "created_at": {
  6428. "type": "string",
  6429. "format": "date-time",
  6430. "x-go-name": "CreatedAt"
  6431. },
  6432. "draft": {
  6433. "type": "boolean",
  6434. "x-go-name": "IsDraft"
  6435. },
  6436. "id": {
  6437. "type": "integer",
  6438. "format": "int64",
  6439. "x-go-name": "ID"
  6440. },
  6441. "name": {
  6442. "type": "string",
  6443. "x-go-name": "Title"
  6444. },
  6445. "prerelease": {
  6446. "type": "boolean",
  6447. "x-go-name": "IsPrerelease"
  6448. },
  6449. "published_at": {
  6450. "type": "string",
  6451. "format": "date-time",
  6452. "x-go-name": "PublishedAt"
  6453. },
  6454. "tag_name": {
  6455. "type": "string",
  6456. "x-go-name": "TagName"
  6457. },
  6458. "tarball_url": {
  6459. "type": "string",
  6460. "x-go-name": "TarURL"
  6461. },
  6462. "target_commitish": {
  6463. "type": "string",
  6464. "x-go-name": "Target"
  6465. },
  6466. "url": {
  6467. "type": "string",
  6468. "x-go-name": "URL"
  6469. },
  6470. "zipball_url": {
  6471. "type": "string",
  6472. "x-go-name": "ZipURL"
  6473. }
  6474. },
  6475. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6476. },
  6477. "Repository": {
  6478. "description": "Repository represents a repository",
  6479. "type": "object",
  6480. "properties": {
  6481. "clone_url": {
  6482. "type": "string",
  6483. "x-go-name": "CloneURL"
  6484. },
  6485. "created_at": {
  6486. "type": "string",
  6487. "format": "date-time",
  6488. "x-go-name": "Created"
  6489. },
  6490. "default_branch": {
  6491. "type": "string",
  6492. "x-go-name": "DefaultBranch"
  6493. },
  6494. "description": {
  6495. "type": "string",
  6496. "x-go-name": "Description"
  6497. },
  6498. "empty": {
  6499. "type": "boolean",
  6500. "x-go-name": "Empty"
  6501. },
  6502. "fork": {
  6503. "type": "boolean",
  6504. "x-go-name": "Fork"
  6505. },
  6506. "forks_count": {
  6507. "type": "integer",
  6508. "format": "int64",
  6509. "x-go-name": "Forks"
  6510. },
  6511. "full_name": {
  6512. "type": "string",
  6513. "x-go-name": "FullName"
  6514. },
  6515. "html_url": {
  6516. "type": "string",
  6517. "x-go-name": "HTMLURL"
  6518. },
  6519. "id": {
  6520. "type": "integer",
  6521. "format": "int64",
  6522. "x-go-name": "ID"
  6523. },
  6524. "mirror": {
  6525. "type": "boolean",
  6526. "x-go-name": "Mirror"
  6527. },
  6528. "name": {
  6529. "type": "string",
  6530. "x-go-name": "Name"
  6531. },
  6532. "open_issues_count": {
  6533. "type": "integer",
  6534. "format": "int64",
  6535. "x-go-name": "OpenIssues"
  6536. },
  6537. "owner": {
  6538. "$ref": "#/definitions/User"
  6539. },
  6540. "parent": {
  6541. "$ref": "#/definitions/Repository"
  6542. },
  6543. "permissions": {
  6544. "$ref": "#/definitions/Permission"
  6545. },
  6546. "private": {
  6547. "type": "boolean",
  6548. "x-go-name": "Private"
  6549. },
  6550. "size": {
  6551. "type": "integer",
  6552. "format": "int64",
  6553. "x-go-name": "Size"
  6554. },
  6555. "ssh_url": {
  6556. "type": "string",
  6557. "x-go-name": "SSHURL"
  6558. },
  6559. "stars_count": {
  6560. "type": "integer",
  6561. "format": "int64",
  6562. "x-go-name": "Stars"
  6563. },
  6564. "updated_at": {
  6565. "type": "string",
  6566. "format": "date-time",
  6567. "x-go-name": "Updated"
  6568. },
  6569. "watchers_count": {
  6570. "type": "integer",
  6571. "format": "int64",
  6572. "x-go-name": "Watchers"
  6573. },
  6574. "website": {
  6575. "type": "string",
  6576. "x-go-name": "Website"
  6577. }
  6578. },
  6579. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6580. },
  6581. "SearchResults": {
  6582. "description": "SearchResults results of a successful search",
  6583. "type": "object",
  6584. "properties": {
  6585. "data": {
  6586. "type": "array",
  6587. "items": {
  6588. "$ref": "#/definitions/Repository"
  6589. },
  6590. "x-go-name": "Data"
  6591. },
  6592. "ok": {
  6593. "type": "boolean",
  6594. "x-go-name": "OK"
  6595. }
  6596. },
  6597. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6598. },
  6599. "ServerVersion": {
  6600. "description": "ServerVersion wraps the version of the server",
  6601. "type": "object",
  6602. "properties": {
  6603. "version": {
  6604. "type": "string",
  6605. "x-go-name": "Version"
  6606. }
  6607. },
  6608. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6609. },
  6610. "StateType": {
  6611. "description": "StateType issue state type",
  6612. "type": "string",
  6613. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6614. },
  6615. "Status": {
  6616. "description": "Status holds a single Status of a single Commit",
  6617. "type": "object",
  6618. "properties": {
  6619. "context": {
  6620. "type": "string",
  6621. "x-go-name": "Context"
  6622. },
  6623. "created_at": {
  6624. "type": "string",
  6625. "format": "date-time",
  6626. "x-go-name": "Created"
  6627. },
  6628. "creator": {
  6629. "$ref": "#/definitions/User"
  6630. },
  6631. "description": {
  6632. "type": "string",
  6633. "x-go-name": "Description"
  6634. },
  6635. "id": {
  6636. "type": "integer",
  6637. "format": "int64",
  6638. "x-go-name": "ID"
  6639. },
  6640. "status": {
  6641. "$ref": "#/definitions/StatusState"
  6642. },
  6643. "target_url": {
  6644. "type": "string",
  6645. "x-go-name": "TargetURL"
  6646. },
  6647. "updated_at": {
  6648. "type": "string",
  6649. "format": "date-time",
  6650. "x-go-name": "Updated"
  6651. },
  6652. "url": {
  6653. "type": "string",
  6654. "x-go-name": "URL"
  6655. }
  6656. },
  6657. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6658. },
  6659. "StatusState": {
  6660. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  6661. "type": "string",
  6662. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6663. },
  6664. "Team": {
  6665. "description": "Team represents a team in an organization",
  6666. "type": "object",
  6667. "properties": {
  6668. "description": {
  6669. "type": "string",
  6670. "x-go-name": "Description"
  6671. },
  6672. "id": {
  6673. "type": "integer",
  6674. "format": "int64",
  6675. "x-go-name": "ID"
  6676. },
  6677. "name": {
  6678. "type": "string",
  6679. "x-go-name": "Name"
  6680. },
  6681. "permission": {
  6682. "type": "string",
  6683. "enum": [
  6684. "none",
  6685. "read",
  6686. "write",
  6687. "admin",
  6688. "owner"
  6689. ],
  6690. "x-go-name": "Permission"
  6691. }
  6692. },
  6693. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6694. },
  6695. "TrackedTime": {
  6696. "description": "TrackedTime worked time for an issue / pr",
  6697. "type": "object",
  6698. "properties": {
  6699. "created": {
  6700. "type": "string",
  6701. "format": "date-time",
  6702. "x-go-name": "Created"
  6703. },
  6704. "id": {
  6705. "type": "integer",
  6706. "format": "int64",
  6707. "x-go-name": "ID"
  6708. },
  6709. "issue_id": {
  6710. "type": "integer",
  6711. "format": "int64",
  6712. "x-go-name": "IssueID"
  6713. },
  6714. "time": {
  6715. "description": "Time in seconds",
  6716. "type": "integer",
  6717. "format": "int64",
  6718. "x-go-name": "Time"
  6719. },
  6720. "user_id": {
  6721. "type": "integer",
  6722. "format": "int64",
  6723. "x-go-name": "UserID"
  6724. }
  6725. },
  6726. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6727. },
  6728. "User": {
  6729. "description": "User represents a user",
  6730. "type": "object",
  6731. "properties": {
  6732. "avatar_url": {
  6733. "description": "URL to the user's avatar",
  6734. "type": "string",
  6735. "x-go-name": "AvatarURL"
  6736. },
  6737. "email": {
  6738. "type": "string",
  6739. "format": "email",
  6740. "x-go-name": "Email"
  6741. },
  6742. "full_name": {
  6743. "description": "the user's full name",
  6744. "type": "string",
  6745. "x-go-name": "FullName"
  6746. },
  6747. "id": {
  6748. "description": "the user's id",
  6749. "type": "integer",
  6750. "format": "int64",
  6751. "x-go-name": "ID"
  6752. },
  6753. "login": {
  6754. "description": "the user's username",
  6755. "type": "string",
  6756. "x-go-name": "UserName"
  6757. }
  6758. },
  6759. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6760. },
  6761. "WatchInfo": {
  6762. "description": "WatchInfo represents an API watch status of one repository",
  6763. "type": "object",
  6764. "properties": {
  6765. "created_at": {
  6766. "type": "string",
  6767. "format": "date-time",
  6768. "x-go-name": "CreatedAt"
  6769. },
  6770. "ignored": {
  6771. "type": "boolean",
  6772. "x-go-name": "Ignored"
  6773. },
  6774. "reason": {
  6775. "type": "object",
  6776. "x-go-name": "Reason"
  6777. },
  6778. "repository_url": {
  6779. "type": "string",
  6780. "x-go-name": "RepositoryURL"
  6781. },
  6782. "subscribed": {
  6783. "type": "boolean",
  6784. "x-go-name": "Subscribed"
  6785. },
  6786. "url": {
  6787. "type": "string",
  6788. "x-go-name": "URL"
  6789. }
  6790. },
  6791. "x-go-package": "code.gitea.io/gitea/vendor/code.gitea.io/sdk/gitea"
  6792. }
  6793. },
  6794. "responses": {
  6795. "AccessToken": {
  6796. "description": "AccessToken represents a API access token.",
  6797. "headers": {
  6798. "name": {
  6799. "type": "string"
  6800. },
  6801. "sha1": {
  6802. "type": "string"
  6803. }
  6804. }
  6805. },
  6806. "AccessTokenList": {
  6807. "description": "AccessTokenList represents a list of API access token."
  6808. },
  6809. "Branch": {
  6810. "schema": {
  6811. "$ref": "#/definitions/Branch"
  6812. }
  6813. },
  6814. "BranchList": {
  6815. "schema": {
  6816. "type": "array",
  6817. "items": {
  6818. "$ref": "#/definitions/Branch"
  6819. }
  6820. }
  6821. },
  6822. "Comment": {
  6823. "schema": {
  6824. "$ref": "#/definitions/Comment"
  6825. }
  6826. },
  6827. "CommentList": {
  6828. "schema": {
  6829. "type": "array",
  6830. "items": {
  6831. "$ref": "#/definitions/Comment"
  6832. }
  6833. }
  6834. },
  6835. "DeployKey": {
  6836. "schema": {
  6837. "$ref": "#/definitions/DeployKey"
  6838. }
  6839. },
  6840. "DeployKeyList": {
  6841. "schema": {
  6842. "type": "array",
  6843. "items": {
  6844. "$ref": "#/definitions/DeployKey"
  6845. }
  6846. }
  6847. },
  6848. "EmailList": {
  6849. "schema": {
  6850. "type": "array",
  6851. "items": {
  6852. "$ref": "#/definitions/Email"
  6853. }
  6854. }
  6855. },
  6856. "GPGKey": {
  6857. "schema": {
  6858. "$ref": "#/definitions/GPGKey"
  6859. }
  6860. },
  6861. "GPGKeyList": {
  6862. "schema": {
  6863. "type": "array",
  6864. "items": {
  6865. "$ref": "#/definitions/GPGKey"
  6866. }
  6867. }
  6868. },
  6869. "Hook": {
  6870. "schema": {
  6871. "type": "array",
  6872. "items": {
  6873. "$ref": "#/definitions/Branch"
  6874. }
  6875. }
  6876. },
  6877. "HookList": {
  6878. "schema": {
  6879. "type": "array",
  6880. "items": {
  6881. "$ref": "#/definitions/Branch"
  6882. }
  6883. }
  6884. },
  6885. "Issue": {
  6886. "schema": {
  6887. "$ref": "#/definitions/Issue"
  6888. }
  6889. },
  6890. "IssueList": {
  6891. "schema": {
  6892. "type": "array",
  6893. "items": {
  6894. "$ref": "#/definitions/Issue"
  6895. }
  6896. }
  6897. },
  6898. "Label": {
  6899. "schema": {
  6900. "$ref": "#/definitions/Label"
  6901. }
  6902. },
  6903. "LabelList": {
  6904. "schema": {
  6905. "type": "array",
  6906. "items": {
  6907. "$ref": "#/definitions/Label"
  6908. }
  6909. }
  6910. },
  6911. "MarkdownRender": {
  6912. "description": "MarkdownRender is a rendered markdown document"
  6913. },
  6914. "Milestone": {
  6915. "schema": {
  6916. "$ref": "#/definitions/Milestone"
  6917. }
  6918. },
  6919. "MilestoneList": {
  6920. "schema": {
  6921. "type": "array",
  6922. "items": {
  6923. "$ref": "#/definitions/Milestone"
  6924. }
  6925. }
  6926. },
  6927. "Organization": {
  6928. "schema": {
  6929. "$ref": "#/definitions/Organization"
  6930. }
  6931. },
  6932. "OrganizationList": {
  6933. "schema": {
  6934. "type": "array",
  6935. "items": {
  6936. "$ref": "#/definitions/Organization"
  6937. }
  6938. }
  6939. },
  6940. "PublicKey": {
  6941. "schema": {
  6942. "$ref": "#/definitions/PublicKey"
  6943. }
  6944. },
  6945. "PublicKeyList": {
  6946. "schema": {
  6947. "type": "array",
  6948. "items": {
  6949. "$ref": "#/definitions/PublicKey"
  6950. }
  6951. }
  6952. },
  6953. "PullRequest": {
  6954. "schema": {
  6955. "$ref": "#/definitions/PullRequest"
  6956. }
  6957. },
  6958. "PullRequestList": {
  6959. "schema": {
  6960. "type": "array",
  6961. "items": {
  6962. "$ref": "#/definitions/PullRequest"
  6963. }
  6964. }
  6965. },
  6966. "Release": {
  6967. "schema": {
  6968. "$ref": "#/definitions/Release"
  6969. }
  6970. },
  6971. "ReleaseList": {
  6972. "schema": {
  6973. "type": "array",
  6974. "items": {
  6975. "$ref": "#/definitions/Release"
  6976. }
  6977. }
  6978. },
  6979. "Repository": {
  6980. "schema": {
  6981. "$ref": "#/definitions/Repository"
  6982. }
  6983. },
  6984. "RepositoryList": {
  6985. "schema": {
  6986. "type": "array",
  6987. "items": {
  6988. "$ref": "#/definitions/Repository"
  6989. }
  6990. }
  6991. },
  6992. "SearchResults": {
  6993. "schema": {
  6994. "$ref": "#/definitions/SearchResults"
  6995. },
  6996. "headers": {
  6997. "body": {}
  6998. }
  6999. },
  7000. "ServerVersion": {
  7001. "schema": {
  7002. "$ref": "#/definitions/ServerVersion"
  7003. }
  7004. },
  7005. "Status": {
  7006. "schema": {
  7007. "$ref": "#/definitions/Status"
  7008. }
  7009. },
  7010. "StatusList": {
  7011. "schema": {
  7012. "type": "array",
  7013. "items": {
  7014. "$ref": "#/definitions/Status"
  7015. }
  7016. }
  7017. },
  7018. "Team": {
  7019. "schema": {
  7020. "$ref": "#/definitions/Team"
  7021. }
  7022. },
  7023. "TeamList": {
  7024. "schema": {
  7025. "type": "array",
  7026. "items": {
  7027. "$ref": "#/definitions/Team"
  7028. }
  7029. }
  7030. },
  7031. "TrackedTime": {
  7032. "schema": {
  7033. "$ref": "#/definitions/TrackedTime"
  7034. }
  7035. },
  7036. "TrackedTimeList": {
  7037. "schema": {
  7038. "type": "array",
  7039. "items": {
  7040. "$ref": "#/definitions/TrackedTime"
  7041. }
  7042. }
  7043. },
  7044. "User": {
  7045. "schema": {
  7046. "$ref": "#/definitions/User"
  7047. }
  7048. },
  7049. "UserList": {
  7050. "schema": {
  7051. "type": "array",
  7052. "items": {
  7053. "$ref": "#/definitions/User"
  7054. }
  7055. }
  7056. },
  7057. "WatchInfo": {
  7058. "schema": {
  7059. "$ref": "#/definitions/WatchInfo"
  7060. }
  7061. },
  7062. "empty": {
  7063. "description": "APIEmpty is an empty response"
  7064. },
  7065. "error": {
  7066. "description": "APIError is error format response",
  7067. "headers": {
  7068. "message": {
  7069. "type": "string"
  7070. },
  7071. "url": {
  7072. "type": "string"
  7073. }
  7074. }
  7075. },
  7076. "forbidden": {
  7077. "description": "APIForbiddenError is a forbidden error response",
  7078. "headers": {
  7079. "message": {
  7080. "type": "string"
  7081. },
  7082. "url": {
  7083. "type": "string"
  7084. }
  7085. }
  7086. },
  7087. "notFound": {
  7088. "description": "APINotFound is a not found empty response"
  7089. },
  7090. "parameterBodies": {
  7091. "schema": {
  7092. "$ref": "#/definitions/MigrateRepoForm"
  7093. },
  7094. "headers": {
  7095. "AddCollaboratorOption": {},
  7096. "AddTimeOption": {},
  7097. "CreateEmailOption": {},
  7098. "CreateForkOption": {},
  7099. "CreateHookOption": {},
  7100. "CreateIssueCommentOption": {},
  7101. "CreateIssueOption": {},
  7102. "CreateKeyOption": {},
  7103. "CreateLabelOption": {},
  7104. "CreateMilestoneOption": {},
  7105. "CreateOrgOption": {},
  7106. "CreatePullRequestOption": {},
  7107. "CreateReleaseOption": {},
  7108. "CreateRepoOption": {},
  7109. "CreateStatusOption": {},
  7110. "CreateTeamOption": {},
  7111. "CreateUserOption": {},
  7112. "DeleteEmailOption": {},
  7113. "EditHookOption": {},
  7114. "EditIssueCommentOption": {},
  7115. "EditIssueOption": {},
  7116. "EditLabelOption": {},
  7117. "EditMilestoneOption": {},
  7118. "EditOrgOption": {},
  7119. "EditPullRequestOption": {},
  7120. "EditReleaseOption": {},
  7121. "EditTeamOption": {},
  7122. "EditUserOption": {},
  7123. "IssueLabelsOption": {},
  7124. "MarkdownOption": {},
  7125. "MigrateRepoForm": {}
  7126. }
  7127. },
  7128. "redirect": {
  7129. "description": "APIRedirect is a redirect response"
  7130. },
  7131. "validationError": {
  7132. "description": "APIValidationError is error format response related to input validation",
  7133. "headers": {
  7134. "message": {
  7135. "type": "string"
  7136. },
  7137. "url": {
  7138. "type": "string"
  7139. }
  7140. }
  7141. }
  7142. },
  7143. "securityDefinitions": {
  7144. "AccessToken": {
  7145. "type": "apiKey",
  7146. "name": "access_token",
  7147. "in": "query"
  7148. },
  7149. "AuthorizationHeaderToken": {
  7150. "type": "apiKey",
  7151. "name": "Authorization",
  7152. "in": "header"
  7153. },
  7154. "BasicAuth": {
  7155. "type": "basic"
  7156. },
  7157. "Token": {
  7158. "type": "apiKey",
  7159. "name": "token",
  7160. "in": "query"
  7161. }
  7162. },
  7163. "security": [
  7164. {
  7165. "BasicAuth": [
  7166. "[]"
  7167. ]
  7168. },
  7169. {
  7170. "Token": [
  7171. "[]"
  7172. ]
  7173. },
  7174. {
  7175. "AccessToken": [
  7176. "[]"
  7177. ]
  7178. },
  7179. {
  7180. "AuthorizationHeaderToken": [
  7181. "[]"
  7182. ]
  7183. }
  7184. ]
  7185. }