Você não pode selecionar mais de 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

v1_json.tmpl 249KB

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