Ви не можете вибрати більше 25 тем Теми мають розпочинатися з літери або цифри, можуть містити дефіси (-) і не повинні перевищувати 35 символів.

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775677667776778677967806781678267836784678567866787678867896790679167926793679467956796679767986799680068016802680368046805680668076808680968106811681268136814681568166817681868196820682168226823682468256826682768286829683068316832683368346835683668376838683968406841684268436844684568466847684868496850685168526853685468556856685768586859686068616862686368646865686668676868686968706871687268736874687568766877687868796880688168826883688468856886688768886889689068916892689368946895689668976898689969006901690269036904690569066907690869096910691169126913691469156916691769186919692069216922692369246925692669276928692969306931693269336934693569366937693869396940694169426943694469456946694769486949695069516952695369546955695669576958695969606961696269636964696569666967696869696970697169726973697469756976697769786979698069816982698369846985698669876988698969906991699269936994699569966997699869997000700170027003700470057006700770087009701070117012701370147015701670177018701970207021702270237024702570267027702870297030703170327033703470357036703770387039704070417042704370447045704670477048704970507051705270537054705570567057705870597060706170627063706470657066706770687069707070717072707370747075707670777078707970807081708270837084708570867087708870897090709170927093709470957096709770987099710071017102710371047105710671077108710971107111711271137114711571167117711871197120712171227123712471257126712771287129713071317132713371347135713671377138713971407141714271437144714571467147714871497150715171527153715471557156715771587159716071617162716371647165716671677168716971707171717271737174717571767177717871797180718171827183718471857186718771887189719071917192719371947195719671977198719972007201720272037204720572067207720872097210721172127213721472157216721772187219722072217222722372247225722672277228722972307231723272337234723572367237723872397240724172427243724472457246724772487249725072517252725372547255725672577258725972607261726272637264726572667267726872697270727172727273727472757276727772787279728072817282728372847285728672877288728972907291729272937294729572967297729872997300730173027303730473057306730773087309731073117312731373147315731673177318731973207321732273237324732573267327732873297330733173327333733473357336733773387339734073417342734373447345734673477348734973507351735273537354735573567357735873597360736173627363736473657366736773687369737073717372737373747375737673777378737973807381738273837384738573867387738873897390739173927393739473957396739773987399740074017402740374047405740674077408740974107411741274137414741574167417741874197420742174227423742474257426742774287429743074317432743374347435743674377438743974407441744274437444744574467447744874497450745174527453745474557456745774587459746074617462746374647465746674677468746974707471747274737474747574767477747874797480748174827483748474857486748774887489749074917492749374947495749674977498749975007501750275037504750575067507750875097510751175127513751475157516751775187519752075217522752375247525752675277528752975307531753275337534753575367537753875397540754175427543754475457546754775487549755075517552755375547555755675577558755975607561756275637564756575667567756875697570757175727573757475757576757775787579758075817582758375847585758675877588758975907591759275937594759575967597759875997600760176027603760476057606760776087609761076117612761376147615761676177618761976207621762276237624762576267627762876297630763176327633763476357636763776387639764076417642764376447645764676477648764976507651765276537654765576567657765876597660766176627663766476657666766776687669767076717672767376747675767676777678767976807681768276837684768576867687768876897690769176927693769476957696769776987699770077017702770377047705770677077708770977107711771277137714771577167717771877197720772177227723772477257726772777287729773077317732773377347735773677377738773977407741774277437744774577467747774877497750775177527753775477557756775777587759776077617762776377647765776677677768776977707771777277737774777577767777777877797780778177827783778477857786778777887789779077917792779377947795779677977798779978007801780278037804780578067807780878097810781178127813781478157816781778187819782078217822782378247825782678277828782978307831783278337834783578367837783878397840784178427843784478457846784778487849785078517852785378547855785678577858785978607861786278637864786578667867786878697870787178727873787478757876787778787879788078817882788378847885788678877888788978907891789278937894789578967897789878997900790179027903790479057906790779087909791079117912791379147915791679177918791979207921792279237924792579267927792879297930793179327933793479357936793779387939794079417942794379447945794679477948794979507951795279537954795579567957795879597960796179627963796479657966796779687969797079717972797379747975797679777978797979807981798279837984798579867987798879897990799179927993799479957996799779987999800080018002800380048005800680078008800980108011801280138014801580168017801880198020802180228023802480258026802780288029803080318032803380348035803680378038803980408041804280438044804580468047804880498050805180528053805480558056805780588059806080618062806380648065806680678068806980708071807280738074807580768077807880798080808180828083808480858086808780888089809080918092809380948095809680978098809981008101810281038104810581068107810881098110811181128113811481158116811781188119812081218122812381248125812681278128812981308131813281338134813581368137813881398140814181428143814481458146814781488149815081518152815381548155815681578158815981608161816281638164816581668167816881698170817181728173817481758176817781788179818081818182818381848185818681878188818981908191819281938194819581968197819881998200820182028203820482058206820782088209821082118212821382148215821682178218821982208221822282238224822582268227822882298230823182328233823482358236823782388239824082418242824382448245824682478248824982508251825282538254825582568257825882598260826182628263826482658266826782688269827082718272827382748275827682778278827982808281828282838284828582868287828882898290829182928293829482958296829782988299830083018302830383048305830683078308830983108311831283138314831583168317831883198320832183228323832483258326832783288329833083318332833383348335833683378338833983408341834283438344834583468347834883498350835183528353835483558356835783588359836083618362836383648365836683678368836983708371837283738374837583768377837883798380838183828383838483858386838783888389839083918392839383948395839683978398839984008401840284038404840584068407840884098410841184128413841484158416841784188419842084218422842384248425842684278428842984308431843284338434843584368437843884398440844184428443844484458446844784488449845084518452845384548455845684578458845984608461846284638464846584668467846884698470847184728473847484758476847784788479848084818482848384848485848684878488848984908491849284938494849584968497849884998500850185028503850485058506850785088509851085118512851385148515851685178518851985208521852285238524852585268527852885298530853185328533853485358536853785388539854085418542854385448545854685478548854985508551855285538554855585568557855885598560856185628563856485658566856785688569857085718572857385748575857685778578857985808581858285838584858585868587858885898590859185928593859485958596859785988599860086018602860386048605860686078608860986108611861286138614861586168617861886198620862186228623862486258626862786288629863086318632863386348635863686378638863986408641864286438644864586468647864886498650865186528653865486558656865786588659866086618662866386648665866686678668866986708671867286738674867586768677867886798680868186828683868486858686868786888689869086918692869386948695869686978698869987008701870287038704870587068707870887098710871187128713871487158716871787188719872087218722872387248725872687278728872987308731873287338734873587368737873887398740874187428743874487458746874787488749875087518752875387548755875687578758875987608761876287638764876587668767876887698770877187728773877487758776877787788779878087818782878387848785878687878788878987908791879287938794879587968797879887998800880188028803880488058806880788088809881088118812881388148815881688178818881988208821882288238824882588268827882888298830883188328833883488358836883788388839884088418842884388448845884688478848884988508851885288538854885588568857885888598860886188628863886488658866886788688869887088718872887388748875887688778878887988808881888288838884888588868887888888898890889188928893889488958896889788988899890089018902890389048905890689078908890989108911891289138914891589168917891889198920892189228923892489258926892789288929893089318932893389348935893689378938893989408941894289438944894589468947894889498950895189528953895489558956895789588959896089618962896389648965896689678968896989708971897289738974897589768977897889798980898189828983898489858986898789888989899089918992899389948995899689978998899990009001900290039004900590069007900890099010901190129013901490159016901790189019902090219022902390249025902690279028902990309031903290339034903590369037903890399040904190429043904490459046904790489049905090519052905390549055905690579058905990609061906290639064906590669067906890699070907190729073907490759076907790789079908090819082908390849085908690879088908990909091909290939094909590969097909890999100910191029103910491059106910791089109911091119112911391149115911691179118911991209121912291239124912591269127912891299130913191329133913491359136913791389139914091419142914391449145914691479148914991509151915291539154915591569157915891599160916191629163916491659166916791689169917091719172917391749175917691779178917991809181918291839184918591869187918891899190919191929193919491959196919791989199920092019202920392049205920692079208920992109211921292139214921592169217921892199220922192229223922492259226922792289229923092319232923392349235923692379238923992409241924292439244924592469247924892499250925192529253925492559256925792589259926092619262926392649265926692679268926992709271927292739274927592769277927892799280928192829283928492859286928792889289929092919292929392949295929692979298929993009301930293039304930593069307930893099310931193129313931493159316931793189319932093219322932393249325932693279328932993309331933293339334933593369337933893399340934193429343934493459346934793489349935093519352935393549355935693579358935993609361936293639364936593669367936893699370937193729373937493759376937793789379938093819382938393849385938693879388938993909391939293939394939593969397939893999400940194029403940494059406940794089409941094119412941394149415941694179418941994209421942294239424942594269427942894299430943194329433943494359436943794389439944094419442944394449445944694479448944994509451945294539454945594569457945894599460946194629463946494659466946794689469947094719472947394749475947694779478947994809481948294839484948594869487948894899490949194929493949494959496949794989499950095019502950395049505950695079508950995109511951295139514951595169517951895199520952195229523952495259526952795289529953095319532953395349535953695379538953995409541954295439544954595469547954895499550955195529553955495559556955795589559956095619562956395649565956695679568956995709571957295739574957595769577957895799580958195829583958495859586958795889589959095919592959395949595959695979598959996009601960296039604960596069607960896099610961196129613961496159616961796189619962096219622962396249625962696279628962996309631963296339634963596369637963896399640964196429643964496459646964796489649965096519652965396549655965696579658965996609661966296639664966596669667966896699670967196729673967496759676967796789679968096819682968396849685968696879688968996909691969296939694969596969697969896999700970197029703970497059706970797089709971097119712971397149715971697179718971997209721972297239724972597269727972897299730973197329733973497359736973797389739974097419742974397449745974697479748974997509751975297539754975597569757975897599760976197629763976497659766976797689769977097719772977397749775977697779778977997809781978297839784978597869787978897899790979197929793979497959796979797989799980098019802980398049805980698079808980998109811981298139814981598169817981898199820982198229823982498259826982798289829983098319832983398349835983698379838983998409841984298439844984598469847984898499850985198529853985498559856985798589859986098619862986398649865986698679868986998709871987298739874987598769877987898799880988198829883988498859886988798889889989098919892989398949895989698979898989999009901990299039904990599069907990899099910991199129913991499159916991799189919992099219922992399249925992699279928992999309931993299339934993599369937993899399940994199429943994499459946994799489949995099519952995399549955995699579958995999609961996299639964996599669967996899699970997199729973997499759976997799789979998099819982998399849985998699879988998999909991999299939994999599969997999899991000010001100021000310004100051000610007100081000910010100111001210013100141001510016100171001810019100201002110022100231002410025100261002710028100291003010031100321003310034100351003610037100381003910040100411004210043100441004510046100471004810049100501005110052100531005410055100561005710058100591006010061100621006310064100651006610067100681006910070100711007210073100741007510076100771007810079100801008110082100831008410085100861008710088100891009010091100921009310094100951009610097100981009910100101011010210103101041010510106101071010810109101101011110112101131011410115101161011710118101191012010121101221012310124101251012610127101281012910130101311013210133101341013510136101371013810139101401014110142101431014410145101461014710148101491015010151101521015310154101551015610157101581015910160101611016210163101641016510166101671016810169101701017110172101731017410175101761017710178101791018010181101821018310184101851018610187101881018910190101911019210193101941019510196101971019810199102001020110202102031020410205102061020710208102091021010211102121021310214102151021610217102181021910220102211022210223102241022510226102271022810229102301023110232102331023410235102361023710238102391024010241102421024310244102451024610247102481024910250102511025210253102541025510256102571025810259102601026110262102631026410265102661026710268102691027010271102721027310274102751027610277102781027910280102811028210283102841028510286102871028810289102901029110292102931029410295102961029710298102991030010301103021030310304103051030610307103081030910310103111031210313103141031510316103171031810319103201032110322103231032410325103261032710328103291033010331103321033310334103351033610337103381033910340103411034210343103441034510346103471034810349103501035110352103531035410355103561035710358103591036010361103621036310364103651036610367103681036910370103711037210373103741037510376103771037810379103801038110382103831038410385103861038710388103891039010391103921039310394103951039610397103981039910400104011040210403104041040510406104071040810409104101041110412104131041410415104161041710418104191042010421104221042310424104251042610427104281042910430104311043210433104341043510436104371043810439104401044110442104431044410445104461044710448104491045010451104521045310454104551045610457104581045910460104611046210463104641046510466104671046810469104701047110472104731047410475104761047710478104791048010481104821048310484104851048610487104881048910490104911049210493104941049510496104971049810499105001050110502105031050410505105061050710508105091051010511105121051310514105151051610517105181051910520105211052210523105241052510526105271052810529105301053110532105331053410535105361053710538105391054010541105421054310544105451054610547105481054910550105511055210553105541055510556105571055810559105601056110562105631056410565105661056710568105691057010571105721057310574105751057610577105781057910580105811058210583105841058510586105871058810589105901059110592105931059410595105961059710598105991060010601106021060310604106051060610607106081060910610106111061210613106141061510616106171061810619106201062110622106231062410625106261062710628106291063010631106321063310634106351063610637106381063910640106411064210643106441064510646106471064810649106501065110652106531065410655106561065710658106591066010661106621066310664106651066610667106681066910670106711067210673106741067510676106771067810679106801068110682106831068410685106861068710688106891069010691106921069310694106951069610697106981069910700107011070210703107041070510706107071070810709107101071110712107131071410715107161071710718107191072010721107221072310724107251072610727107281072910730107311073210733107341073510736107371073810739107401074110742107431074410745107461074710748107491075010751107521075310754107551075610757107581075910760107611076210763107641076510766107671076810769107701077110772107731077410775107761077710778107791078010781107821078310784107851078610787107881078910790107911079210793107941079510796107971079810799108001080110802108031080410805108061080710808108091081010811108121081310814108151081610817108181081910820108211082210823108241082510826108271082810829108301083110832108331083410835108361083710838108391084010841108421084310844108451084610847108481084910850108511085210853108541085510856108571085810859108601086110862108631086410865108661086710868108691087010871108721087310874108751087610877108781087910880108811088210883108841088510886108871088810889108901089110892108931089410895108961089710898108991090010901109021090310904109051090610907109081090910910109111091210913109141091510916109171091810919109201092110922109231092410925109261092710928109291093010931109321093310934109351093610937109381093910940109411094210943109441094510946109471094810949109501095110952109531095410955109561095710958109591096010961109621096310964109651096610967109681096910970109711097210973109741097510976109771097810979109801098110982109831098410985109861098710988109891099010991109921099310994109951099610997109981099911000110011100211003110041100511006110071100811009110101101111012110131101411015110161101711018110191102011021110221102311024110251102611027110281102911030110311103211033110341103511036110371103811039110401104111042110431104411045110461104711048110491105011051110521105311054110551105611057110581105911060110611106211063110641106511066110671106811069110701107111072110731107411075110761107711078110791108011081110821108311084110851108611087110881108911090110911109211093110941109511096110971109811099111001110111102111031110411105111061110711108111091111011111111121111311114111151111611117111181111911120111211112211123111241112511126111271112811129111301113111132111331113411135111361113711138111391114011141111421114311144111451114611147111481114911150111511115211153111541115511156111571115811159111601116111162111631116411165111661116711168111691117011171111721117311174111751117611177111781117911180111811118211183111841118511186111871118811189111901119111192111931119411195111961119711198111991120011201112021120311204112051120611207112081120911210112111121211213112141121511216112171121811219112201122111222112231122411225112261122711228112291123011231112321123311234112351123611237112381123911240112411124211243112441124511246112471124811249112501125111252112531125411255112561125711258112591126011261112621126311264112651126611267112681126911270112711127211273112741127511276112771127811279112801128111282112831128411285112861128711288112891129011291112921129311294112951129611297112981129911300113011130211303113041130511306113071130811309113101131111312113131131411315113161131711318113191132011321113221132311324113251132611327113281132911330113311133211333113341133511336113371133811339113401134111342113431134411345113461134711348113491135011351113521135311354113551135611357113581135911360113611136211363113641136511366113671136811369113701137111372113731137411375113761137711378113791138011381113821138311384113851138611387113881138911390113911139211393113941139511396113971139811399114001140111402114031140411405114061140711408114091141011411114121141311414114151141611417114181141911420114211142211423114241142511426114271142811429114301143111432114331143411435114361143711438114391144011441114421144311444114451144611447114481144911450114511145211453114541145511456114571145811459114601146111462114631146411465114661146711468114691147011471114721147311474114751147611477114781147911480114811148211483114841148511486114871148811489114901149111492114931149411495114961149711498114991150011501115021150311504115051150611507115081150911510115111151211513115141151511516115171151811519115201152111522115231152411525115261152711528115291153011531115321153311534115351153611537115381153911540115411154211543115441154511546115471154811549115501155111552115531155411555115561155711558115591156011561115621156311564115651156611567115681156911570115711157211573115741157511576115771157811579115801158111582115831158411585115861158711588115891159011591115921159311594115951159611597115981159911600116011160211603116041160511606116071160811609116101161111612116131161411615116161161711618116191162011621116221162311624116251162611627116281162911630116311163211633116341163511636116371163811639116401164111642116431164411645116461164711648116491165011651116521165311654116551165611657116581165911660116611166211663116641166511666116671166811669116701167111672116731167411675116761167711678116791168011681116821168311684116851168611687116881168911690116911169211693116941169511696116971169811699117001170111702117031170411705117061170711708117091171011711117121171311714117151171611717117181171911720117211172211723117241172511726117271172811729117301173111732117331173411735117361173711738117391174011741117421174311744117451174611747117481174911750117511175211753117541175511756117571175811759117601176111762117631176411765117661176711768117691177011771117721177311774117751177611777117781177911780117811178211783117841178511786117871178811789117901179111792117931179411795117961179711798117991180011801118021180311804118051180611807118081180911810118111181211813118141181511816118171181811819118201182111822118231182411825118261182711828118291183011831118321183311834118351183611837118381183911840118411184211843118441184511846118471184811849118501185111852118531185411855118561185711858118591186011861118621186311864118651186611867118681186911870118711187211873118741187511876118771187811879118801188111882118831188411885118861188711888118891189011891118921189311894118951189611897118981189911900119011190211903119041190511906119071190811909119101191111912119131191411915119161191711918119191192011921119221192311924119251192611927119281192911930119311193211933119341193511936119371193811939119401194111942119431194411945119461194711948119491195011951119521195311954119551195611957119581195911960119611196211963119641196511966119671196811969119701197111972119731197411975119761197711978119791198011981119821198311984119851198611987119881198911990119911199211993119941199511996119971199811999120001200112002120031200412005120061200712008120091201012011120121201312014120151201612017120181201912020120211202212023120241202512026120271202812029120301203112032120331203412035120361203712038120391204012041120421204312044120451204612047120481204912050120511205212053120541205512056120571205812059120601206112062120631206412065120661206712068120691207012071120721207312074120751207612077120781207912080120811208212083120841208512086120871208812089120901209112092120931209412095120961209712098120991210012101121021210312104121051210612107121081210912110121111211212113121141211512116121171211812119121201212112122121231212412125121261212712128121291213012131121321213312134121351213612137121381213912140121411214212143121441214512146121471214812149121501215112152121531215412155121561215712158121591216012161121621216312164121651216612167121681216912170121711217212173121741217512176121771217812179121801218112182121831218412185121861218712188121891219012191121921219312194121951219612197121981219912200122011220212203122041220512206122071220812209122101221112212122131221412215122161221712218122191222012221122221222312224122251222612227122281222912230122311223212233122341223512236122371223812239122401224112242122431224412245122461224712248122491225012251122521225312254122551225612257122581225912260122611226212263122641226512266122671226812269122701227112272122731227412275122761227712278122791228012281122821228312284122851228612287122881228912290122911229212293122941229512296122971229812299123001230112302123031230412305123061230712308123091231012311123121231312314123151231612317123181231912320123211232212323123241232512326123271232812329123301233112332123331233412335123361233712338123391234012341123421234312344123451234612347123481234912350123511235212353123541235512356123571235812359123601236112362123631236412365123661236712368123691237012371123721237312374123751237612377123781237912380123811238212383123841238512386123871238812389123901239112392123931239412395123961239712398123991240012401124021240312404124051240612407124081240912410124111241212413124141241512416124171241812419124201242112422124231242412425124261242712428124291243012431124321243312434124351243612437124381243912440124411244212443124441244512446124471244812449124501245112452124531245412455124561245712458124591246012461124621246312464124651246612467124681246912470124711247212473124741247512476124771247812479124801248112482124831248412485124861248712488124891249012491124921249312494124951249612497124981249912500125011250212503125041250512506125071250812509125101251112512125131251412515125161251712518125191252012521125221252312524125251252612527125281252912530125311253212533125341253512536125371253812539125401254112542125431254412545125461254712548125491255012551125521255312554125551255612557125581255912560125611256212563125641256512566125671256812569125701257112572125731257412575125761257712578125791258012581125821258312584125851258612587125881258912590125911259212593125941259512596125971259812599126001260112602126031260412605126061260712608126091261012611126121261312614126151261612617126181261912620126211262212623126241262512626126271262812629126301263112632126331263412635126361263712638126391264012641126421264312644126451264612647126481264912650126511265212653126541265512656126571265812659126601266112662126631266412665126661266712668126691267012671126721267312674126751267612677126781267912680126811268212683126841268512686126871268812689126901269112692126931269412695126961269712698126991270012701127021270312704127051270612707127081270912710127111271212713127141271512716127171271812719127201272112722127231272412725127261272712728127291273012731127321273312734127351273612737127381273912740127411274212743127441274512746127471274812749127501275112752127531275412755127561275712758127591276012761127621276312764127651276612767127681276912770127711277212773127741277512776127771277812779127801278112782127831278412785127861278712788127891279012791127921279312794127951279612797127981279912800128011280212803128041280512806128071280812809128101281112812128131281412815128161281712818128191282012821128221282312824128251282612827128281282912830128311283212833128341283512836128371283812839128401284112842128431284412845128461284712848128491285012851128521285312854128551285612857128581285912860128611286212863128641286512866128671286812869128701287112872128731287412875128761287712878128791288012881128821288312884128851288612887128881288912890128911289212893128941289512896128971289812899129001290112902129031290412905129061290712908129091291012911129121291312914129151291612917129181291912920129211292212923129241292512926129271292812929129301293112932129331293412935129361293712938129391294012941129421294312944129451294612947129481294912950129511295212953129541295512956129571295812959129601296112962129631296412965129661296712968129691297012971129721297312974129751297612977129781297912980129811298212983129841298512986129871298812989129901299112992129931299412995129961299712998129991300013001130021300313004130051300613007130081300913010130111301213013130141301513016130171301813019130201302113022130231302413025130261302713028130291303013031130321303313034130351303613037130381303913040130411304213043130441304513046130471304813049130501305113052130531305413055130561305713058130591306013061130621306313064130651306613067130681306913070130711307213073130741307513076130771307813079130801308113082130831308413085130861308713088130891309013091130921309313094130951309613097130981309913100131011310213103131041310513106131071310813109131101311113112131131311413115131161311713118131191312013121131221312313124131251312613127131281312913130131311313213133131341313513136131371313813139131401314113142131431314413145131461314713148131491315013151131521315313154131551315613157131581315913160131611316213163131641316513166131671316813169131701317113172131731317413175131761317713178131791318013181131821318313184131851318613187131881318913190131911319213193131941319513196131971319813199132001320113202132031320413205132061320713208132091321013211132121321313214132151321613217132181321913220132211322213223132241322513226132271322813229132301323113232132331323413235132361323713238132391324013241132421324313244132451324613247132481324913250132511325213253132541325513256132571325813259132601326113262132631326413265132661326713268132691327013271132721327313274132751327613277132781327913280132811328213283132841328513286132871328813289132901329113292132931329413295132961329713298132991330013301133021330313304133051330613307133081330913310133111331213313133141331513316133171331813319133201332113322133231332413325133261332713328133291333013331133321333313334133351333613337133381333913340133411334213343133441334513346133471334813349133501335113352133531335413355133561335713358133591336013361133621336313364133651336613367133681336913370133711337213373133741337513376133771337813379133801338113382133831338413385133861338713388133891339013391133921339313394133951339613397133981339913400134011340213403134041340513406134071340813409134101341113412134131341413415134161341713418134191342013421134221342313424134251342613427134281342913430134311343213433134341343513436134371343813439134401344113442134431344413445134461344713448134491345013451134521345313454134551345613457134581345913460134611346213463134641346513466134671346813469134701347113472134731347413475134761347713478134791348013481134821348313484
  1. {
  2. "consumes": [
  3. "application/json",
  4. "text/plain"
  5. ],
  6. "produces": [
  7. "application/json",
  8. "text/html"
  9. ],
  10. "schemes": [
  11. "http",
  12. "https"
  13. ],
  14. "swagger": "2.0",
  15. "info": {
  16. "description": "This documentation describes the Gitea API.",
  17. "title": "Gitea API.",
  18. "license": {
  19. "name": "MIT",
  20. "url": "http://opensource.org/licenses/MIT"
  21. },
  22. "version": "1.1.1"
  23. },
  24. "basePath": "{{AppSubUrl}}/api/v1",
  25. "paths": {
  26. "/admin/orgs": {
  27. "get": {
  28. "produces": [
  29. "application/json"
  30. ],
  31. "tags": [
  32. "admin"
  33. ],
  34. "summary": "List all organizations",
  35. "operationId": "adminGetAllOrgs",
  36. "parameters": [
  37. {
  38. "type": "integer",
  39. "description": "page number of results to return (1-based)",
  40. "name": "page",
  41. "in": "query"
  42. },
  43. {
  44. "type": "integer",
  45. "description": "page size of results, maximum page size is 50",
  46. "name": "limit",
  47. "in": "query"
  48. }
  49. ],
  50. "responses": {
  51. "200": {
  52. "$ref": "#/responses/OrganizationList"
  53. },
  54. "403": {
  55. "$ref": "#/responses/forbidden"
  56. }
  57. }
  58. }
  59. },
  60. "/admin/users": {
  61. "get": {
  62. "produces": [
  63. "application/json"
  64. ],
  65. "tags": [
  66. "admin"
  67. ],
  68. "summary": "List all users",
  69. "operationId": "adminGetAllUsers",
  70. "parameters": [
  71. {
  72. "type": "integer",
  73. "description": "page number of results to return (1-based)",
  74. "name": "page",
  75. "in": "query"
  76. },
  77. {
  78. "type": "integer",
  79. "description": "page size of results, maximum page size is 50",
  80. "name": "limit",
  81. "in": "query"
  82. }
  83. ],
  84. "responses": {
  85. "200": {
  86. "$ref": "#/responses/UserList"
  87. },
  88. "403": {
  89. "$ref": "#/responses/forbidden"
  90. }
  91. }
  92. },
  93. "post": {
  94. "consumes": [
  95. "application/json"
  96. ],
  97. "produces": [
  98. "application/json"
  99. ],
  100. "tags": [
  101. "admin"
  102. ],
  103. "summary": "Create a user",
  104. "operationId": "adminCreateUser",
  105. "parameters": [
  106. {
  107. "name": "body",
  108. "in": "body",
  109. "schema": {
  110. "$ref": "#/definitions/CreateUserOption"
  111. }
  112. }
  113. ],
  114. "responses": {
  115. "201": {
  116. "$ref": "#/responses/User"
  117. },
  118. "400": {
  119. "$ref": "#/responses/error"
  120. },
  121. "403": {
  122. "$ref": "#/responses/forbidden"
  123. },
  124. "422": {
  125. "$ref": "#/responses/validationError"
  126. }
  127. }
  128. }
  129. },
  130. "/admin/users/{username}": {
  131. "delete": {
  132. "produces": [
  133. "application/json"
  134. ],
  135. "tags": [
  136. "admin"
  137. ],
  138. "summary": "Delete a user",
  139. "operationId": "adminDeleteUser",
  140. "parameters": [
  141. {
  142. "type": "string",
  143. "description": "username of user to delete",
  144. "name": "username",
  145. "in": "path",
  146. "required": true
  147. }
  148. ],
  149. "responses": {
  150. "204": {
  151. "$ref": "#/responses/empty"
  152. },
  153. "403": {
  154. "$ref": "#/responses/forbidden"
  155. },
  156. "422": {
  157. "$ref": "#/responses/validationError"
  158. }
  159. }
  160. },
  161. "patch": {
  162. "consumes": [
  163. "application/json"
  164. ],
  165. "produces": [
  166. "application/json"
  167. ],
  168. "tags": [
  169. "admin"
  170. ],
  171. "summary": "Edit an existing user",
  172. "operationId": "adminEditUser",
  173. "parameters": [
  174. {
  175. "type": "string",
  176. "description": "username of user to edit",
  177. "name": "username",
  178. "in": "path",
  179. "required": true
  180. },
  181. {
  182. "name": "body",
  183. "in": "body",
  184. "schema": {
  185. "$ref": "#/definitions/EditUserOption"
  186. }
  187. }
  188. ],
  189. "responses": {
  190. "200": {
  191. "$ref": "#/responses/User"
  192. },
  193. "403": {
  194. "$ref": "#/responses/forbidden"
  195. },
  196. "422": {
  197. "$ref": "#/responses/validationError"
  198. }
  199. }
  200. }
  201. },
  202. "/admin/users/{username}/keys": {
  203. "post": {
  204. "consumes": [
  205. "application/json"
  206. ],
  207. "produces": [
  208. "application/json"
  209. ],
  210. "tags": [
  211. "admin"
  212. ],
  213. "summary": "Add a public key on behalf of a user",
  214. "operationId": "adminCreatePublicKey",
  215. "parameters": [
  216. {
  217. "type": "string",
  218. "description": "username of the user",
  219. "name": "username",
  220. "in": "path",
  221. "required": true
  222. },
  223. {
  224. "name": "key",
  225. "in": "body",
  226. "schema": {
  227. "$ref": "#/definitions/CreateKeyOption"
  228. }
  229. }
  230. ],
  231. "responses": {
  232. "201": {
  233. "$ref": "#/responses/PublicKey"
  234. },
  235. "403": {
  236. "$ref": "#/responses/forbidden"
  237. },
  238. "422": {
  239. "$ref": "#/responses/validationError"
  240. }
  241. }
  242. }
  243. },
  244. "/admin/users/{username}/keys/{id}": {
  245. "delete": {
  246. "produces": [
  247. "application/json"
  248. ],
  249. "tags": [
  250. "admin"
  251. ],
  252. "summary": "Delete a user's public key",
  253. "operationId": "adminDeleteUserPublicKey",
  254. "parameters": [
  255. {
  256. "type": "string",
  257. "description": "username of user",
  258. "name": "username",
  259. "in": "path",
  260. "required": true
  261. },
  262. {
  263. "type": "integer",
  264. "format": "int64",
  265. "description": "id of the key to delete",
  266. "name": "id",
  267. "in": "path",
  268. "required": true
  269. }
  270. ],
  271. "responses": {
  272. "204": {
  273. "$ref": "#/responses/empty"
  274. },
  275. "403": {
  276. "$ref": "#/responses/forbidden"
  277. },
  278. "404": {
  279. "$ref": "#/responses/notFound"
  280. }
  281. }
  282. }
  283. },
  284. "/admin/users/{username}/orgs": {
  285. "post": {
  286. "consumes": [
  287. "application/json"
  288. ],
  289. "produces": [
  290. "application/json"
  291. ],
  292. "tags": [
  293. "admin"
  294. ],
  295. "summary": "Create an organization",
  296. "operationId": "adminCreateOrg",
  297. "parameters": [
  298. {
  299. "type": "string",
  300. "description": "username of the user that will own the created organization",
  301. "name": "username",
  302. "in": "path",
  303. "required": true
  304. },
  305. {
  306. "name": "organization",
  307. "in": "body",
  308. "required": true,
  309. "schema": {
  310. "$ref": "#/definitions/CreateOrgOption"
  311. }
  312. }
  313. ],
  314. "responses": {
  315. "201": {
  316. "$ref": "#/responses/Organization"
  317. },
  318. "403": {
  319. "$ref": "#/responses/forbidden"
  320. },
  321. "422": {
  322. "$ref": "#/responses/validationError"
  323. }
  324. }
  325. }
  326. },
  327. "/admin/users/{username}/repos": {
  328. "post": {
  329. "consumes": [
  330. "application/json"
  331. ],
  332. "produces": [
  333. "application/json"
  334. ],
  335. "tags": [
  336. "admin"
  337. ],
  338. "summary": "Create a repository on behalf of a user",
  339. "operationId": "adminCreateRepo",
  340. "parameters": [
  341. {
  342. "type": "string",
  343. "description": "username of the user. This user will own the created repository",
  344. "name": "username",
  345. "in": "path",
  346. "required": true
  347. },
  348. {
  349. "name": "repository",
  350. "in": "body",
  351. "required": true,
  352. "schema": {
  353. "$ref": "#/definitions/CreateRepoOption"
  354. }
  355. }
  356. ],
  357. "responses": {
  358. "201": {
  359. "$ref": "#/responses/Repository"
  360. },
  361. "403": {
  362. "$ref": "#/responses/forbidden"
  363. },
  364. "404": {
  365. "$ref": "#/responses/notFound"
  366. },
  367. "409": {
  368. "$ref": "#/responses/error"
  369. },
  370. "422": {
  371. "$ref": "#/responses/validationError"
  372. }
  373. }
  374. }
  375. },
  376. "/markdown": {
  377. "post": {
  378. "consumes": [
  379. "application/json"
  380. ],
  381. "produces": [
  382. "text/html"
  383. ],
  384. "tags": [
  385. "miscellaneous"
  386. ],
  387. "summary": "Render a markdown document as HTML",
  388. "operationId": "renderMarkdown",
  389. "parameters": [
  390. {
  391. "name": "body",
  392. "in": "body",
  393. "schema": {
  394. "$ref": "#/definitions/MarkdownOption"
  395. }
  396. }
  397. ],
  398. "responses": {
  399. "200": {
  400. "$ref": "#/responses/MarkdownRender"
  401. },
  402. "422": {
  403. "$ref": "#/responses/validationError"
  404. }
  405. }
  406. }
  407. },
  408. "/markdown/raw": {
  409. "post": {
  410. "consumes": [
  411. "text/plain"
  412. ],
  413. "produces": [
  414. "text/html"
  415. ],
  416. "tags": [
  417. "miscellaneous"
  418. ],
  419. "summary": "Render raw markdown as HTML",
  420. "operationId": "renderMarkdownRaw",
  421. "parameters": [
  422. {
  423. "description": "Request body to render",
  424. "name": "body",
  425. "in": "body",
  426. "required": true,
  427. "schema": {
  428. "type": "string"
  429. }
  430. }
  431. ],
  432. "responses": {
  433. "200": {
  434. "$ref": "#/responses/MarkdownRender"
  435. },
  436. "422": {
  437. "$ref": "#/responses/validationError"
  438. }
  439. }
  440. }
  441. },
  442. "/notifications": {
  443. "get": {
  444. "consumes": [
  445. "application/json"
  446. ],
  447. "produces": [
  448. "application/json"
  449. ],
  450. "tags": [
  451. "notification"
  452. ],
  453. "summary": "List users's notification threads",
  454. "operationId": "notifyGetList",
  455. "parameters": [
  456. {
  457. "type": "string",
  458. "description": "If true, show notifications marked as read. Default value is false",
  459. "name": "all",
  460. "in": "query"
  461. },
  462. {
  463. "type": "string",
  464. "format": "date-time",
  465. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  466. "name": "since",
  467. "in": "query"
  468. },
  469. {
  470. "type": "string",
  471. "format": "date-time",
  472. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  473. "name": "before",
  474. "in": "query"
  475. },
  476. {
  477. "type": "integer",
  478. "description": "page number of results to return (1-based)",
  479. "name": "page",
  480. "in": "query"
  481. },
  482. {
  483. "type": "integer",
  484. "description": "page size of results, maximum page size is 50",
  485. "name": "limit",
  486. "in": "query"
  487. }
  488. ],
  489. "responses": {
  490. "200": {
  491. "$ref": "#/responses/NotificationThreadList"
  492. }
  493. }
  494. },
  495. "put": {
  496. "consumes": [
  497. "application/json"
  498. ],
  499. "produces": [
  500. "application/json"
  501. ],
  502. "tags": [
  503. "notification"
  504. ],
  505. "summary": "Mark notification threads as read",
  506. "operationId": "notifyReadList",
  507. "parameters": [
  508. {
  509. "type": "string",
  510. "format": "date-time",
  511. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  512. "name": "last_read_at",
  513. "in": "query"
  514. }
  515. ],
  516. "responses": {
  517. "205": {
  518. "$ref": "#/responses/empty"
  519. }
  520. }
  521. }
  522. },
  523. "/notifications/new": {
  524. "get": {
  525. "tags": [
  526. "notification"
  527. ],
  528. "summary": "Check if unread notifications exist",
  529. "operationId": "notifyNewAvailable",
  530. "responses": {
  531. "200": {
  532. "$ref": "#/responses/NotificationCount"
  533. },
  534. "204": {
  535. "description": "No unread notification"
  536. }
  537. }
  538. }
  539. },
  540. "/notifications/threads/{id}": {
  541. "get": {
  542. "consumes": [
  543. "application/json"
  544. ],
  545. "produces": [
  546. "application/json"
  547. ],
  548. "tags": [
  549. "notification"
  550. ],
  551. "summary": "Get notification thread by ID",
  552. "operationId": "notifyGetThread",
  553. "parameters": [
  554. {
  555. "type": "string",
  556. "description": "id of notification thread",
  557. "name": "id",
  558. "in": "path",
  559. "required": true
  560. }
  561. ],
  562. "responses": {
  563. "200": {
  564. "$ref": "#/responses/NotificationThread"
  565. },
  566. "403": {
  567. "$ref": "#/responses/forbidden"
  568. },
  569. "404": {
  570. "$ref": "#/responses/notFound"
  571. }
  572. }
  573. },
  574. "patch": {
  575. "consumes": [
  576. "application/json"
  577. ],
  578. "produces": [
  579. "application/json"
  580. ],
  581. "tags": [
  582. "notification"
  583. ],
  584. "summary": "Mark notification thread as read by ID",
  585. "operationId": "notifyReadThread",
  586. "parameters": [
  587. {
  588. "type": "string",
  589. "description": "id of notification thread",
  590. "name": "id",
  591. "in": "path",
  592. "required": true
  593. }
  594. ],
  595. "responses": {
  596. "205": {
  597. "$ref": "#/responses/empty"
  598. },
  599. "403": {
  600. "$ref": "#/responses/forbidden"
  601. },
  602. "404": {
  603. "$ref": "#/responses/notFound"
  604. }
  605. }
  606. }
  607. },
  608. "/org/{org}/repos": {
  609. "post": {
  610. "consumes": [
  611. "application/json"
  612. ],
  613. "produces": [
  614. "application/json"
  615. ],
  616. "tags": [
  617. "organization"
  618. ],
  619. "summary": "Create a repository in an organization",
  620. "operationId": "createOrgRepoDeprecated",
  621. "deprecated": true,
  622. "parameters": [
  623. {
  624. "type": "string",
  625. "description": "name of organization",
  626. "name": "org",
  627. "in": "path",
  628. "required": true
  629. },
  630. {
  631. "name": "body",
  632. "in": "body",
  633. "schema": {
  634. "$ref": "#/definitions/CreateRepoOption"
  635. }
  636. }
  637. ],
  638. "responses": {
  639. "201": {
  640. "$ref": "#/responses/Repository"
  641. },
  642. "403": {
  643. "$ref": "#/responses/forbidden"
  644. },
  645. "422": {
  646. "$ref": "#/responses/validationError"
  647. }
  648. }
  649. }
  650. },
  651. "/orgs": {
  652. "get": {
  653. "produces": [
  654. "application/json"
  655. ],
  656. "tags": [
  657. "organization"
  658. ],
  659. "summary": "Get list of organizations",
  660. "operationId": "orgGetAll",
  661. "parameters": [
  662. {
  663. "type": "integer",
  664. "description": "page number of results to return (1-based)",
  665. "name": "page",
  666. "in": "query"
  667. },
  668. {
  669. "type": "integer",
  670. "description": "page size of results, maximum page size is 50",
  671. "name": "limit",
  672. "in": "query"
  673. }
  674. ],
  675. "responses": {
  676. "200": {
  677. "$ref": "#/responses/OrganizationList"
  678. }
  679. }
  680. },
  681. "post": {
  682. "consumes": [
  683. "application/json"
  684. ],
  685. "produces": [
  686. "application/json"
  687. ],
  688. "tags": [
  689. "organization"
  690. ],
  691. "summary": "Create an organization",
  692. "operationId": "orgCreate",
  693. "parameters": [
  694. {
  695. "name": "organization",
  696. "in": "body",
  697. "required": true,
  698. "schema": {
  699. "$ref": "#/definitions/CreateOrgOption"
  700. }
  701. }
  702. ],
  703. "responses": {
  704. "201": {
  705. "$ref": "#/responses/Organization"
  706. },
  707. "403": {
  708. "$ref": "#/responses/forbidden"
  709. },
  710. "422": {
  711. "$ref": "#/responses/validationError"
  712. }
  713. }
  714. }
  715. },
  716. "/orgs/{org}": {
  717. "get": {
  718. "produces": [
  719. "application/json"
  720. ],
  721. "tags": [
  722. "organization"
  723. ],
  724. "summary": "Get an organization",
  725. "operationId": "orgGet",
  726. "parameters": [
  727. {
  728. "type": "string",
  729. "description": "name of the organization to get",
  730. "name": "org",
  731. "in": "path",
  732. "required": true
  733. }
  734. ],
  735. "responses": {
  736. "200": {
  737. "$ref": "#/responses/Organization"
  738. }
  739. }
  740. },
  741. "delete": {
  742. "produces": [
  743. "application/json"
  744. ],
  745. "tags": [
  746. "organization"
  747. ],
  748. "summary": "Delete an organization",
  749. "operationId": "orgDelete",
  750. "parameters": [
  751. {
  752. "type": "string",
  753. "description": "organization that is to be deleted",
  754. "name": "org",
  755. "in": "path",
  756. "required": true
  757. }
  758. ],
  759. "responses": {
  760. "204": {
  761. "$ref": "#/responses/empty"
  762. }
  763. }
  764. },
  765. "patch": {
  766. "consumes": [
  767. "application/json"
  768. ],
  769. "produces": [
  770. "application/json"
  771. ],
  772. "tags": [
  773. "organization"
  774. ],
  775. "summary": "Edit an organization",
  776. "operationId": "orgEdit",
  777. "parameters": [
  778. {
  779. "type": "string",
  780. "description": "name of the organization to edit",
  781. "name": "org",
  782. "in": "path",
  783. "required": true
  784. },
  785. {
  786. "name": "body",
  787. "in": "body",
  788. "required": true,
  789. "schema": {
  790. "$ref": "#/definitions/EditOrgOption"
  791. }
  792. }
  793. ],
  794. "responses": {
  795. "200": {
  796. "$ref": "#/responses/Organization"
  797. }
  798. }
  799. }
  800. },
  801. "/orgs/{org}/hooks": {
  802. "get": {
  803. "produces": [
  804. "application/json"
  805. ],
  806. "tags": [
  807. "organization"
  808. ],
  809. "summary": "List an organization's webhooks",
  810. "operationId": "orgListHooks",
  811. "parameters": [
  812. {
  813. "type": "string",
  814. "description": "name of the organization",
  815. "name": "org",
  816. "in": "path",
  817. "required": true
  818. },
  819. {
  820. "type": "integer",
  821. "description": "page number of results to return (1-based)",
  822. "name": "page",
  823. "in": "query"
  824. },
  825. {
  826. "type": "integer",
  827. "description": "page size of results, maximum page size is 50",
  828. "name": "limit",
  829. "in": "query"
  830. }
  831. ],
  832. "responses": {
  833. "200": {
  834. "$ref": "#/responses/HookList"
  835. }
  836. }
  837. }
  838. },
  839. "/orgs/{org}/hooks/": {
  840. "post": {
  841. "consumes": [
  842. "application/json"
  843. ],
  844. "produces": [
  845. "application/json"
  846. ],
  847. "tags": [
  848. "organization"
  849. ],
  850. "summary": "Create a hook",
  851. "operationId": "orgCreateHook",
  852. "parameters": [
  853. {
  854. "type": "string",
  855. "description": "name of the organization",
  856. "name": "org",
  857. "in": "path",
  858. "required": true
  859. },
  860. {
  861. "name": "body",
  862. "in": "body",
  863. "required": true,
  864. "schema": {
  865. "$ref": "#/definitions/CreateHookOption"
  866. }
  867. }
  868. ],
  869. "responses": {
  870. "201": {
  871. "$ref": "#/responses/Hook"
  872. }
  873. }
  874. }
  875. },
  876. "/orgs/{org}/hooks/{id}": {
  877. "get": {
  878. "produces": [
  879. "application/json"
  880. ],
  881. "tags": [
  882. "organization"
  883. ],
  884. "summary": "Get a hook",
  885. "operationId": "orgGetHook",
  886. "parameters": [
  887. {
  888. "type": "string",
  889. "description": "name of the organization",
  890. "name": "org",
  891. "in": "path",
  892. "required": true
  893. },
  894. {
  895. "type": "integer",
  896. "format": "int64",
  897. "description": "id of the hook to get",
  898. "name": "id",
  899. "in": "path",
  900. "required": true
  901. }
  902. ],
  903. "responses": {
  904. "200": {
  905. "$ref": "#/responses/Hook"
  906. }
  907. }
  908. },
  909. "delete": {
  910. "produces": [
  911. "application/json"
  912. ],
  913. "tags": [
  914. "organization"
  915. ],
  916. "summary": "Delete a hook",
  917. "operationId": "orgDeleteHook",
  918. "parameters": [
  919. {
  920. "type": "string",
  921. "description": "name of the organization",
  922. "name": "org",
  923. "in": "path",
  924. "required": true
  925. },
  926. {
  927. "type": "integer",
  928. "format": "int64",
  929. "description": "id of the hook to delete",
  930. "name": "id",
  931. "in": "path",
  932. "required": true
  933. }
  934. ],
  935. "responses": {
  936. "204": {
  937. "$ref": "#/responses/empty"
  938. }
  939. }
  940. },
  941. "patch": {
  942. "consumes": [
  943. "application/json"
  944. ],
  945. "produces": [
  946. "application/json"
  947. ],
  948. "tags": [
  949. "organization"
  950. ],
  951. "summary": "Update a hook",
  952. "operationId": "orgEditHook",
  953. "parameters": [
  954. {
  955. "type": "string",
  956. "description": "name of the organization",
  957. "name": "org",
  958. "in": "path",
  959. "required": true
  960. },
  961. {
  962. "type": "integer",
  963. "format": "int64",
  964. "description": "id of the hook to update",
  965. "name": "id",
  966. "in": "path",
  967. "required": true
  968. },
  969. {
  970. "name": "body",
  971. "in": "body",
  972. "schema": {
  973. "$ref": "#/definitions/EditHookOption"
  974. }
  975. }
  976. ],
  977. "responses": {
  978. "200": {
  979. "$ref": "#/responses/Hook"
  980. }
  981. }
  982. }
  983. },
  984. "/orgs/{org}/members": {
  985. "get": {
  986. "produces": [
  987. "application/json"
  988. ],
  989. "tags": [
  990. "organization"
  991. ],
  992. "summary": "List an organization's members",
  993. "operationId": "orgListMembers",
  994. "parameters": [
  995. {
  996. "type": "string",
  997. "description": "name of the organization",
  998. "name": "org",
  999. "in": "path",
  1000. "required": true
  1001. },
  1002. {
  1003. "type": "integer",
  1004. "description": "page number of results to return (1-based)",
  1005. "name": "page",
  1006. "in": "query"
  1007. },
  1008. {
  1009. "type": "integer",
  1010. "description": "page size of results, maximum page size is 50",
  1011. "name": "limit",
  1012. "in": "query"
  1013. }
  1014. ],
  1015. "responses": {
  1016. "200": {
  1017. "$ref": "#/responses/UserList"
  1018. }
  1019. }
  1020. }
  1021. },
  1022. "/orgs/{org}/members/{username}": {
  1023. "get": {
  1024. "tags": [
  1025. "organization"
  1026. ],
  1027. "summary": "Check if a user is a member of an organization",
  1028. "operationId": "orgIsMember",
  1029. "parameters": [
  1030. {
  1031. "type": "string",
  1032. "description": "name of the organization",
  1033. "name": "org",
  1034. "in": "path",
  1035. "required": true
  1036. },
  1037. {
  1038. "type": "string",
  1039. "description": "username of the user",
  1040. "name": "username",
  1041. "in": "path",
  1042. "required": true
  1043. }
  1044. ],
  1045. "responses": {
  1046. "204": {
  1047. "description": "user is a member"
  1048. },
  1049. "302": {
  1050. "description": "redirection to /orgs/{org}/public_members/{username}"
  1051. },
  1052. "404": {
  1053. "description": "user is not a member"
  1054. }
  1055. }
  1056. },
  1057. "delete": {
  1058. "produces": [
  1059. "application/json"
  1060. ],
  1061. "tags": [
  1062. "organization"
  1063. ],
  1064. "summary": "Remove a member from an organization",
  1065. "operationId": "orgDeleteMember",
  1066. "parameters": [
  1067. {
  1068. "type": "string",
  1069. "description": "name of the organization",
  1070. "name": "org",
  1071. "in": "path",
  1072. "required": true
  1073. },
  1074. {
  1075. "type": "string",
  1076. "description": "username of the user",
  1077. "name": "username",
  1078. "in": "path",
  1079. "required": true
  1080. }
  1081. ],
  1082. "responses": {
  1083. "204": {
  1084. "description": "member removed"
  1085. }
  1086. }
  1087. }
  1088. },
  1089. "/orgs/{org}/public_members": {
  1090. "get": {
  1091. "produces": [
  1092. "application/json"
  1093. ],
  1094. "tags": [
  1095. "organization"
  1096. ],
  1097. "summary": "List an organization's public members",
  1098. "operationId": "orgListPublicMembers",
  1099. "parameters": [
  1100. {
  1101. "type": "string",
  1102. "description": "name of the organization",
  1103. "name": "org",
  1104. "in": "path",
  1105. "required": true
  1106. },
  1107. {
  1108. "type": "integer",
  1109. "description": "page number of results to return (1-based)",
  1110. "name": "page",
  1111. "in": "query"
  1112. },
  1113. {
  1114. "type": "integer",
  1115. "description": "page size of results, maximum page size is 50",
  1116. "name": "limit",
  1117. "in": "query"
  1118. }
  1119. ],
  1120. "responses": {
  1121. "200": {
  1122. "$ref": "#/responses/UserList"
  1123. }
  1124. }
  1125. }
  1126. },
  1127. "/orgs/{org}/public_members/{username}": {
  1128. "get": {
  1129. "tags": [
  1130. "organization"
  1131. ],
  1132. "summary": "Check if a user is a public member of an organization",
  1133. "operationId": "orgIsPublicMember",
  1134. "parameters": [
  1135. {
  1136. "type": "string",
  1137. "description": "name of the organization",
  1138. "name": "org",
  1139. "in": "path",
  1140. "required": true
  1141. },
  1142. {
  1143. "type": "string",
  1144. "description": "username of the user",
  1145. "name": "username",
  1146. "in": "path",
  1147. "required": true
  1148. }
  1149. ],
  1150. "responses": {
  1151. "204": {
  1152. "description": "user is a public member"
  1153. },
  1154. "404": {
  1155. "description": "user is not a public member"
  1156. }
  1157. }
  1158. },
  1159. "put": {
  1160. "produces": [
  1161. "application/json"
  1162. ],
  1163. "tags": [
  1164. "organization"
  1165. ],
  1166. "summary": "Publicize a user's membership",
  1167. "operationId": "orgPublicizeMember",
  1168. "parameters": [
  1169. {
  1170. "type": "string",
  1171. "description": "name of the organization",
  1172. "name": "org",
  1173. "in": "path",
  1174. "required": true
  1175. },
  1176. {
  1177. "type": "string",
  1178. "description": "username of the user",
  1179. "name": "username",
  1180. "in": "path",
  1181. "required": true
  1182. }
  1183. ],
  1184. "responses": {
  1185. "204": {
  1186. "description": "membership publicized"
  1187. },
  1188. "403": {
  1189. "$ref": "#/responses/forbidden"
  1190. }
  1191. }
  1192. },
  1193. "delete": {
  1194. "produces": [
  1195. "application/json"
  1196. ],
  1197. "tags": [
  1198. "organization"
  1199. ],
  1200. "summary": "Conceal a user's membership",
  1201. "operationId": "orgConcealMember",
  1202. "parameters": [
  1203. {
  1204. "type": "string",
  1205. "description": "name of the organization",
  1206. "name": "org",
  1207. "in": "path",
  1208. "required": true
  1209. },
  1210. {
  1211. "type": "string",
  1212. "description": "username of the user",
  1213. "name": "username",
  1214. "in": "path",
  1215. "required": true
  1216. }
  1217. ],
  1218. "responses": {
  1219. "204": {
  1220. "$ref": "#/responses/empty"
  1221. },
  1222. "403": {
  1223. "$ref": "#/responses/forbidden"
  1224. }
  1225. }
  1226. }
  1227. },
  1228. "/orgs/{org}/repos": {
  1229. "get": {
  1230. "produces": [
  1231. "application/json"
  1232. ],
  1233. "tags": [
  1234. "organization"
  1235. ],
  1236. "summary": "List an organization's repos",
  1237. "operationId": "orgListRepos",
  1238. "parameters": [
  1239. {
  1240. "type": "string",
  1241. "description": "name of the organization",
  1242. "name": "org",
  1243. "in": "path",
  1244. "required": true
  1245. },
  1246. {
  1247. "type": "integer",
  1248. "description": "page number of results to return (1-based)",
  1249. "name": "page",
  1250. "in": "query"
  1251. },
  1252. {
  1253. "type": "integer",
  1254. "description": "page size of results, maximum page size is 50",
  1255. "name": "limit",
  1256. "in": "query"
  1257. }
  1258. ],
  1259. "responses": {
  1260. "200": {
  1261. "$ref": "#/responses/RepositoryList"
  1262. }
  1263. }
  1264. },
  1265. "post": {
  1266. "consumes": [
  1267. "application/json"
  1268. ],
  1269. "produces": [
  1270. "application/json"
  1271. ],
  1272. "tags": [
  1273. "organization"
  1274. ],
  1275. "summary": "Create a repository in an organization",
  1276. "operationId": "createOrgRepo",
  1277. "parameters": [
  1278. {
  1279. "type": "string",
  1280. "description": "name of organization",
  1281. "name": "org",
  1282. "in": "path",
  1283. "required": true
  1284. },
  1285. {
  1286. "name": "body",
  1287. "in": "body",
  1288. "schema": {
  1289. "$ref": "#/definitions/CreateRepoOption"
  1290. }
  1291. }
  1292. ],
  1293. "responses": {
  1294. "201": {
  1295. "$ref": "#/responses/Repository"
  1296. },
  1297. "403": {
  1298. "$ref": "#/responses/forbidden"
  1299. },
  1300. "404": {
  1301. "$ref": "#/responses/notFound"
  1302. }
  1303. }
  1304. }
  1305. },
  1306. "/orgs/{org}/teams": {
  1307. "get": {
  1308. "produces": [
  1309. "application/json"
  1310. ],
  1311. "tags": [
  1312. "organization"
  1313. ],
  1314. "summary": "List an organization's teams",
  1315. "operationId": "orgListTeams",
  1316. "parameters": [
  1317. {
  1318. "type": "string",
  1319. "description": "name of the organization",
  1320. "name": "org",
  1321. "in": "path",
  1322. "required": true
  1323. },
  1324. {
  1325. "type": "integer",
  1326. "description": "page number of results to return (1-based)",
  1327. "name": "page",
  1328. "in": "query"
  1329. },
  1330. {
  1331. "type": "integer",
  1332. "description": "page size of results, maximum page size is 50",
  1333. "name": "limit",
  1334. "in": "query"
  1335. }
  1336. ],
  1337. "responses": {
  1338. "200": {
  1339. "$ref": "#/responses/TeamList"
  1340. }
  1341. }
  1342. },
  1343. "post": {
  1344. "consumes": [
  1345. "application/json"
  1346. ],
  1347. "produces": [
  1348. "application/json"
  1349. ],
  1350. "tags": [
  1351. "organization"
  1352. ],
  1353. "summary": "Create a team",
  1354. "operationId": "orgCreateTeam",
  1355. "parameters": [
  1356. {
  1357. "type": "string",
  1358. "description": "name of the organization",
  1359. "name": "org",
  1360. "in": "path",
  1361. "required": true
  1362. },
  1363. {
  1364. "name": "body",
  1365. "in": "body",
  1366. "schema": {
  1367. "$ref": "#/definitions/CreateTeamOption"
  1368. }
  1369. }
  1370. ],
  1371. "responses": {
  1372. "201": {
  1373. "$ref": "#/responses/Team"
  1374. },
  1375. "422": {
  1376. "$ref": "#/responses/validationError"
  1377. }
  1378. }
  1379. }
  1380. },
  1381. "/orgs/{org}/teams/search": {
  1382. "get": {
  1383. "produces": [
  1384. "application/json"
  1385. ],
  1386. "tags": [
  1387. "organization"
  1388. ],
  1389. "summary": "Search for teams within an organization",
  1390. "operationId": "teamSearch",
  1391. "parameters": [
  1392. {
  1393. "type": "string",
  1394. "description": "name of the organization",
  1395. "name": "org",
  1396. "in": "path",
  1397. "required": true
  1398. },
  1399. {
  1400. "type": "string",
  1401. "description": "keywords to search",
  1402. "name": "q",
  1403. "in": "query"
  1404. },
  1405. {
  1406. "type": "boolean",
  1407. "description": "include search within team description (defaults to true)",
  1408. "name": "include_desc",
  1409. "in": "query"
  1410. },
  1411. {
  1412. "type": "integer",
  1413. "description": "page number of results to return (1-based)",
  1414. "name": "page",
  1415. "in": "query"
  1416. },
  1417. {
  1418. "type": "integer",
  1419. "description": "page size of results, maximum page size is 50",
  1420. "name": "limit",
  1421. "in": "query"
  1422. }
  1423. ],
  1424. "responses": {
  1425. "200": {
  1426. "description": "SearchResults of a successful search",
  1427. "schema": {
  1428. "type": "object",
  1429. "properties": {
  1430. "data": {
  1431. "type": "array",
  1432. "items": {
  1433. "$ref": "#/definitions/Team"
  1434. }
  1435. },
  1436. "ok": {
  1437. "type": "boolean"
  1438. }
  1439. }
  1440. }
  1441. }
  1442. }
  1443. }
  1444. },
  1445. "/repos/issues/search": {
  1446. "get": {
  1447. "produces": [
  1448. "application/json"
  1449. ],
  1450. "tags": [
  1451. "issue"
  1452. ],
  1453. "summary": "Search for issues across the repositories that the user has access to",
  1454. "operationId": "issueSearchIssues",
  1455. "parameters": [
  1456. {
  1457. "type": "string",
  1458. "description": "whether issue is open or closed",
  1459. "name": "state",
  1460. "in": "query"
  1461. },
  1462. {
  1463. "type": "string",
  1464. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  1465. "name": "labels",
  1466. "in": "query"
  1467. },
  1468. {
  1469. "type": "string",
  1470. "description": "search string",
  1471. "name": "q",
  1472. "in": "query"
  1473. },
  1474. {
  1475. "type": "integer",
  1476. "format": "int64",
  1477. "description": "repository to prioritize in the results",
  1478. "name": "priority_repo_id",
  1479. "in": "query"
  1480. },
  1481. {
  1482. "type": "string",
  1483. "description": "filter by type (issues / pulls) if set",
  1484. "name": "type",
  1485. "in": "query"
  1486. },
  1487. {
  1488. "type": "integer",
  1489. "description": "page number of requested issues",
  1490. "name": "page",
  1491. "in": "query"
  1492. }
  1493. ],
  1494. "responses": {
  1495. "200": {
  1496. "$ref": "#/responses/IssueList"
  1497. }
  1498. }
  1499. }
  1500. },
  1501. "/repos/migrate": {
  1502. "post": {
  1503. "consumes": [
  1504. "application/json"
  1505. ],
  1506. "produces": [
  1507. "application/json"
  1508. ],
  1509. "tags": [
  1510. "repository"
  1511. ],
  1512. "summary": "Migrate a remote git repository",
  1513. "operationId": "repoMigrate",
  1514. "parameters": [
  1515. {
  1516. "name": "body",
  1517. "in": "body",
  1518. "schema": {
  1519. "$ref": "#/definitions/MigrateRepoForm"
  1520. }
  1521. }
  1522. ],
  1523. "responses": {
  1524. "201": {
  1525. "$ref": "#/responses/Repository"
  1526. },
  1527. "403": {
  1528. "$ref": "#/responses/forbidden"
  1529. },
  1530. "422": {
  1531. "$ref": "#/responses/validationError"
  1532. }
  1533. }
  1534. }
  1535. },
  1536. "/repos/search": {
  1537. "get": {
  1538. "produces": [
  1539. "application/json"
  1540. ],
  1541. "tags": [
  1542. "repository"
  1543. ],
  1544. "summary": "Search for repositories",
  1545. "operationId": "repoSearch",
  1546. "parameters": [
  1547. {
  1548. "type": "string",
  1549. "description": "keyword",
  1550. "name": "q",
  1551. "in": "query"
  1552. },
  1553. {
  1554. "type": "boolean",
  1555. "description": "Limit search to repositories with keyword as topic",
  1556. "name": "topic",
  1557. "in": "query"
  1558. },
  1559. {
  1560. "type": "boolean",
  1561. "description": "include search of keyword within repository description",
  1562. "name": "includeDesc",
  1563. "in": "query"
  1564. },
  1565. {
  1566. "type": "integer",
  1567. "format": "int64",
  1568. "description": "search only for repos that the user with the given id owns or contributes to",
  1569. "name": "uid",
  1570. "in": "query"
  1571. },
  1572. {
  1573. "type": "integer",
  1574. "format": "int64",
  1575. "description": "repo owner to prioritize in the results",
  1576. "name": "priority_owner_id",
  1577. "in": "query"
  1578. },
  1579. {
  1580. "type": "integer",
  1581. "format": "int64",
  1582. "description": "search only for repos that the user with the given id has starred",
  1583. "name": "starredBy",
  1584. "in": "query"
  1585. },
  1586. {
  1587. "type": "boolean",
  1588. "description": "include private repositories this user has access to (defaults to true)",
  1589. "name": "private",
  1590. "in": "query"
  1591. },
  1592. {
  1593. "type": "boolean",
  1594. "description": "include template repositories this user has access to (defaults to true)",
  1595. "name": "template",
  1596. "in": "query"
  1597. },
  1598. {
  1599. "type": "string",
  1600. "description": "type of repository to search for. Supported values are \"fork\", \"source\", \"mirror\" and \"collaborative\"",
  1601. "name": "mode",
  1602. "in": "query"
  1603. },
  1604. {
  1605. "type": "boolean",
  1606. "description": "if `uid` is given, search only for repos that the user owns",
  1607. "name": "exclusive",
  1608. "in": "query"
  1609. },
  1610. {
  1611. "type": "string",
  1612. "description": "sort repos by attribute. Supported values are \"alpha\", \"created\", \"updated\", \"size\", and \"id\". Default is \"alpha\"",
  1613. "name": "sort",
  1614. "in": "query"
  1615. },
  1616. {
  1617. "type": "string",
  1618. "description": "sort order, either \"asc\" (ascending) or \"desc\" (descending). Default is \"asc\", ignored if \"sort\" is not specified.",
  1619. "name": "order",
  1620. "in": "query"
  1621. },
  1622. {
  1623. "type": "integer",
  1624. "description": "page number of results to return (1-based)",
  1625. "name": "page",
  1626. "in": "query"
  1627. },
  1628. {
  1629. "type": "integer",
  1630. "description": "page size of results, maximum page size is 50",
  1631. "name": "limit",
  1632. "in": "query"
  1633. }
  1634. ],
  1635. "responses": {
  1636. "200": {
  1637. "$ref": "#/responses/SearchResults"
  1638. },
  1639. "422": {
  1640. "$ref": "#/responses/validationError"
  1641. }
  1642. }
  1643. }
  1644. },
  1645. "/repos/{owner}/{repo}": {
  1646. "get": {
  1647. "produces": [
  1648. "application/json"
  1649. ],
  1650. "tags": [
  1651. "repository"
  1652. ],
  1653. "summary": "Get a repository",
  1654. "operationId": "repoGet",
  1655. "parameters": [
  1656. {
  1657. "type": "string",
  1658. "description": "owner of the repo",
  1659. "name": "owner",
  1660. "in": "path",
  1661. "required": true
  1662. },
  1663. {
  1664. "type": "string",
  1665. "description": "name of the repo",
  1666. "name": "repo",
  1667. "in": "path",
  1668. "required": true
  1669. }
  1670. ],
  1671. "responses": {
  1672. "200": {
  1673. "$ref": "#/responses/Repository"
  1674. }
  1675. }
  1676. },
  1677. "delete": {
  1678. "produces": [
  1679. "application/json"
  1680. ],
  1681. "tags": [
  1682. "repository"
  1683. ],
  1684. "summary": "Delete a repository",
  1685. "operationId": "repoDelete",
  1686. "parameters": [
  1687. {
  1688. "type": "string",
  1689. "description": "owner of the repo to delete",
  1690. "name": "owner",
  1691. "in": "path",
  1692. "required": true
  1693. },
  1694. {
  1695. "type": "string",
  1696. "description": "name of the repo to delete",
  1697. "name": "repo",
  1698. "in": "path",
  1699. "required": true
  1700. }
  1701. ],
  1702. "responses": {
  1703. "204": {
  1704. "$ref": "#/responses/empty"
  1705. },
  1706. "403": {
  1707. "$ref": "#/responses/forbidden"
  1708. }
  1709. }
  1710. },
  1711. "patch": {
  1712. "produces": [
  1713. "application/json"
  1714. ],
  1715. "tags": [
  1716. "repository"
  1717. ],
  1718. "summary": "Edit a repository's properties. Only fields that are set will be changed.",
  1719. "operationId": "repoEdit",
  1720. "parameters": [
  1721. {
  1722. "type": "string",
  1723. "description": "owner of the repo to edit",
  1724. "name": "owner",
  1725. "in": "path",
  1726. "required": true
  1727. },
  1728. {
  1729. "type": "string",
  1730. "description": "name of the repo to edit",
  1731. "name": "repo",
  1732. "in": "path",
  1733. "required": true
  1734. },
  1735. {
  1736. "description": "Properties of a repo that you can edit",
  1737. "name": "body",
  1738. "in": "body",
  1739. "schema": {
  1740. "$ref": "#/definitions/EditRepoOption"
  1741. }
  1742. }
  1743. ],
  1744. "responses": {
  1745. "200": {
  1746. "$ref": "#/responses/Repository"
  1747. },
  1748. "403": {
  1749. "$ref": "#/responses/forbidden"
  1750. },
  1751. "422": {
  1752. "$ref": "#/responses/validationError"
  1753. }
  1754. }
  1755. }
  1756. },
  1757. "/repos/{owner}/{repo}/archive/{archive}": {
  1758. "get": {
  1759. "produces": [
  1760. "application/json"
  1761. ],
  1762. "tags": [
  1763. "repository"
  1764. ],
  1765. "summary": "Get an archive of a repository",
  1766. "operationId": "repoGetArchive",
  1767. "parameters": [
  1768. {
  1769. "type": "string",
  1770. "description": "owner of the repo",
  1771. "name": "owner",
  1772. "in": "path",
  1773. "required": true
  1774. },
  1775. {
  1776. "type": "string",
  1777. "description": "name of the repo",
  1778. "name": "repo",
  1779. "in": "path",
  1780. "required": true
  1781. },
  1782. {
  1783. "type": "string",
  1784. "description": "archive to download, consisting of a git reference and archive",
  1785. "name": "archive",
  1786. "in": "path",
  1787. "required": true
  1788. }
  1789. ],
  1790. "responses": {
  1791. "200": {
  1792. "description": "success"
  1793. },
  1794. "404": {
  1795. "$ref": "#/responses/notFound"
  1796. }
  1797. }
  1798. }
  1799. },
  1800. "/repos/{owner}/{repo}/branches": {
  1801. "get": {
  1802. "produces": [
  1803. "application/json"
  1804. ],
  1805. "tags": [
  1806. "repository"
  1807. ],
  1808. "summary": "List a repository's branches",
  1809. "operationId": "repoListBranches",
  1810. "parameters": [
  1811. {
  1812. "type": "string",
  1813. "description": "owner of the repo",
  1814. "name": "owner",
  1815. "in": "path",
  1816. "required": true
  1817. },
  1818. {
  1819. "type": "string",
  1820. "description": "name of the repo",
  1821. "name": "repo",
  1822. "in": "path",
  1823. "required": true
  1824. }
  1825. ],
  1826. "responses": {
  1827. "200": {
  1828. "$ref": "#/responses/BranchList"
  1829. }
  1830. }
  1831. }
  1832. },
  1833. "/repos/{owner}/{repo}/branches/{branch}": {
  1834. "get": {
  1835. "produces": [
  1836. "application/json"
  1837. ],
  1838. "tags": [
  1839. "repository"
  1840. ],
  1841. "summary": "Retrieve a specific branch from a repository, including its effective branch protection",
  1842. "operationId": "repoGetBranch",
  1843. "parameters": [
  1844. {
  1845. "type": "string",
  1846. "description": "owner of the repo",
  1847. "name": "owner",
  1848. "in": "path",
  1849. "required": true
  1850. },
  1851. {
  1852. "type": "string",
  1853. "description": "name of the repo",
  1854. "name": "repo",
  1855. "in": "path",
  1856. "required": true
  1857. },
  1858. {
  1859. "type": "string",
  1860. "description": "branch to get",
  1861. "name": "branch",
  1862. "in": "path",
  1863. "required": true
  1864. }
  1865. ],
  1866. "responses": {
  1867. "200": {
  1868. "$ref": "#/responses/Branch"
  1869. }
  1870. }
  1871. }
  1872. },
  1873. "/repos/{owner}/{repo}/collaborators": {
  1874. "get": {
  1875. "produces": [
  1876. "application/json"
  1877. ],
  1878. "tags": [
  1879. "repository"
  1880. ],
  1881. "summary": "List a repository's collaborators",
  1882. "operationId": "repoListCollaborators",
  1883. "parameters": [
  1884. {
  1885. "type": "string",
  1886. "description": "owner of the repo",
  1887. "name": "owner",
  1888. "in": "path",
  1889. "required": true
  1890. },
  1891. {
  1892. "type": "string",
  1893. "description": "name of the repo",
  1894. "name": "repo",
  1895. "in": "path",
  1896. "required": true
  1897. },
  1898. {
  1899. "type": "integer",
  1900. "description": "page number of results to return (1-based)",
  1901. "name": "page",
  1902. "in": "query"
  1903. },
  1904. {
  1905. "type": "integer",
  1906. "description": "page size of results, maximum page size is 50",
  1907. "name": "limit",
  1908. "in": "query"
  1909. }
  1910. ],
  1911. "responses": {
  1912. "200": {
  1913. "$ref": "#/responses/UserList"
  1914. }
  1915. }
  1916. }
  1917. },
  1918. "/repos/{owner}/{repo}/collaborators/{collaborator}": {
  1919. "get": {
  1920. "produces": [
  1921. "application/json"
  1922. ],
  1923. "tags": [
  1924. "repository"
  1925. ],
  1926. "summary": "Check if a user is a collaborator of a repository",
  1927. "operationId": "repoCheckCollaborator",
  1928. "parameters": [
  1929. {
  1930. "type": "string",
  1931. "description": "owner of the repo",
  1932. "name": "owner",
  1933. "in": "path",
  1934. "required": true
  1935. },
  1936. {
  1937. "type": "string",
  1938. "description": "name of the repo",
  1939. "name": "repo",
  1940. "in": "path",
  1941. "required": true
  1942. },
  1943. {
  1944. "type": "string",
  1945. "description": "username of the collaborator",
  1946. "name": "collaborator",
  1947. "in": "path",
  1948. "required": true
  1949. }
  1950. ],
  1951. "responses": {
  1952. "204": {
  1953. "$ref": "#/responses/empty"
  1954. },
  1955. "404": {
  1956. "$ref": "#/responses/notFound"
  1957. },
  1958. "422": {
  1959. "$ref": "#/responses/validationError"
  1960. }
  1961. }
  1962. },
  1963. "put": {
  1964. "produces": [
  1965. "application/json"
  1966. ],
  1967. "tags": [
  1968. "repository"
  1969. ],
  1970. "summary": "Add a collaborator to a repository",
  1971. "operationId": "repoAddCollaborator",
  1972. "parameters": [
  1973. {
  1974. "type": "string",
  1975. "description": "owner of the repo",
  1976. "name": "owner",
  1977. "in": "path",
  1978. "required": true
  1979. },
  1980. {
  1981. "type": "string",
  1982. "description": "name of the repo",
  1983. "name": "repo",
  1984. "in": "path",
  1985. "required": true
  1986. },
  1987. {
  1988. "type": "string",
  1989. "description": "username of the collaborator to add",
  1990. "name": "collaborator",
  1991. "in": "path",
  1992. "required": true
  1993. },
  1994. {
  1995. "name": "body",
  1996. "in": "body",
  1997. "schema": {
  1998. "$ref": "#/definitions/AddCollaboratorOption"
  1999. }
  2000. }
  2001. ],
  2002. "responses": {
  2003. "204": {
  2004. "$ref": "#/responses/empty"
  2005. },
  2006. "422": {
  2007. "$ref": "#/responses/validationError"
  2008. }
  2009. }
  2010. },
  2011. "delete": {
  2012. "produces": [
  2013. "application/json"
  2014. ],
  2015. "tags": [
  2016. "repository"
  2017. ],
  2018. "summary": "Delete a collaborator from a repository",
  2019. "operationId": "repoDeleteCollaborator",
  2020. "parameters": [
  2021. {
  2022. "type": "string",
  2023. "description": "owner of the repo",
  2024. "name": "owner",
  2025. "in": "path",
  2026. "required": true
  2027. },
  2028. {
  2029. "type": "string",
  2030. "description": "name of the repo",
  2031. "name": "repo",
  2032. "in": "path",
  2033. "required": true
  2034. },
  2035. {
  2036. "type": "string",
  2037. "description": "username of the collaborator to delete",
  2038. "name": "collaborator",
  2039. "in": "path",
  2040. "required": true
  2041. }
  2042. ],
  2043. "responses": {
  2044. "204": {
  2045. "$ref": "#/responses/empty"
  2046. },
  2047. "422": {
  2048. "$ref": "#/responses/validationError"
  2049. }
  2050. }
  2051. }
  2052. },
  2053. "/repos/{owner}/{repo}/commits": {
  2054. "get": {
  2055. "produces": [
  2056. "application/json"
  2057. ],
  2058. "tags": [
  2059. "repository"
  2060. ],
  2061. "summary": "Get a list of all commits from a repository",
  2062. "operationId": "repoGetAllCommits",
  2063. "parameters": [
  2064. {
  2065. "type": "string",
  2066. "description": "owner of the repo",
  2067. "name": "owner",
  2068. "in": "path",
  2069. "required": true
  2070. },
  2071. {
  2072. "type": "string",
  2073. "description": "name of the repo",
  2074. "name": "repo",
  2075. "in": "path",
  2076. "required": true
  2077. },
  2078. {
  2079. "type": "string",
  2080. "description": "SHA or branch to start listing commits from (usually 'master')",
  2081. "name": "sha",
  2082. "in": "query"
  2083. },
  2084. {
  2085. "type": "integer",
  2086. "description": "page number of results to return (1-based)",
  2087. "name": "page",
  2088. "in": "query"
  2089. },
  2090. {
  2091. "type": "integer",
  2092. "description": "page size of results, maximum page size is 50",
  2093. "name": "limit",
  2094. "in": "query"
  2095. }
  2096. ],
  2097. "responses": {
  2098. "200": {
  2099. "$ref": "#/responses/CommitList"
  2100. },
  2101. "404": {
  2102. "$ref": "#/responses/notFound"
  2103. },
  2104. "409": {
  2105. "$ref": "#/responses/EmptyRepository"
  2106. }
  2107. }
  2108. }
  2109. },
  2110. "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  2111. "get": {
  2112. "produces": [
  2113. "application/json"
  2114. ],
  2115. "tags": [
  2116. "repository"
  2117. ],
  2118. "summary": "Get a commit's combined status, by branch/tag/commit reference",
  2119. "operationId": "repoGetCombinedStatusByRef",
  2120. "parameters": [
  2121. {
  2122. "type": "string",
  2123. "description": "owner of the repo",
  2124. "name": "owner",
  2125. "in": "path",
  2126. "required": true
  2127. },
  2128. {
  2129. "type": "string",
  2130. "description": "name of the repo",
  2131. "name": "repo",
  2132. "in": "path",
  2133. "required": true
  2134. },
  2135. {
  2136. "type": "string",
  2137. "description": "name of branch/tag/commit",
  2138. "name": "ref",
  2139. "in": "path",
  2140. "required": true
  2141. },
  2142. {
  2143. "type": "integer",
  2144. "description": "page number of results",
  2145. "name": "page",
  2146. "in": "query"
  2147. }
  2148. ],
  2149. "responses": {
  2150. "200": {
  2151. "$ref": "#/responses/Status"
  2152. },
  2153. "400": {
  2154. "$ref": "#/responses/error"
  2155. }
  2156. }
  2157. }
  2158. },
  2159. "/repos/{owner}/{repo}/contents": {
  2160. "get": {
  2161. "produces": [
  2162. "application/json"
  2163. ],
  2164. "tags": [
  2165. "repository"
  2166. ],
  2167. "summary": "Gets the metadata of all the entries of the root dir",
  2168. "operationId": "repoGetContentsList",
  2169. "parameters": [
  2170. {
  2171. "type": "string",
  2172. "description": "owner of the repo",
  2173. "name": "owner",
  2174. "in": "path",
  2175. "required": true
  2176. },
  2177. {
  2178. "type": "string",
  2179. "description": "name of the repo",
  2180. "name": "repo",
  2181. "in": "path",
  2182. "required": true
  2183. },
  2184. {
  2185. "type": "string",
  2186. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2187. "name": "ref",
  2188. "in": "query"
  2189. }
  2190. ],
  2191. "responses": {
  2192. "200": {
  2193. "$ref": "#/responses/ContentsListResponse"
  2194. }
  2195. }
  2196. }
  2197. },
  2198. "/repos/{owner}/{repo}/contents/{filepath}": {
  2199. "get": {
  2200. "produces": [
  2201. "application/json"
  2202. ],
  2203. "tags": [
  2204. "repository"
  2205. ],
  2206. "summary": "Gets the metadata and contents (if a file) of an entry in a repository, or a list of entries if a dir",
  2207. "operationId": "repoGetContents",
  2208. "parameters": [
  2209. {
  2210. "type": "string",
  2211. "description": "owner of the repo",
  2212. "name": "owner",
  2213. "in": "path",
  2214. "required": true
  2215. },
  2216. {
  2217. "type": "string",
  2218. "description": "name of the repo",
  2219. "name": "repo",
  2220. "in": "path",
  2221. "required": true
  2222. },
  2223. {
  2224. "type": "string",
  2225. "description": "path of the dir, file, symlink or submodule in the repo",
  2226. "name": "filepath",
  2227. "in": "path",
  2228. "required": true
  2229. },
  2230. {
  2231. "type": "string",
  2232. "description": "The name of the commit/branch/tag. Default the repository’s default branch (usually master)",
  2233. "name": "ref",
  2234. "in": "query"
  2235. }
  2236. ],
  2237. "responses": {
  2238. "200": {
  2239. "$ref": "#/responses/ContentsResponse"
  2240. }
  2241. }
  2242. },
  2243. "put": {
  2244. "consumes": [
  2245. "application/json"
  2246. ],
  2247. "produces": [
  2248. "application/json"
  2249. ],
  2250. "tags": [
  2251. "repository"
  2252. ],
  2253. "summary": "Update a file in a repository",
  2254. "operationId": "repoUpdateFile",
  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": "path of the file to update",
  2273. "name": "filepath",
  2274. "in": "path",
  2275. "required": true
  2276. },
  2277. {
  2278. "name": "body",
  2279. "in": "body",
  2280. "required": true,
  2281. "schema": {
  2282. "$ref": "#/definitions/UpdateFileOptions"
  2283. }
  2284. }
  2285. ],
  2286. "responses": {
  2287. "200": {
  2288. "$ref": "#/responses/FileResponse"
  2289. }
  2290. }
  2291. },
  2292. "post": {
  2293. "consumes": [
  2294. "application/json"
  2295. ],
  2296. "produces": [
  2297. "application/json"
  2298. ],
  2299. "tags": [
  2300. "repository"
  2301. ],
  2302. "summary": "Create a file in a repository",
  2303. "operationId": "repoCreateFile",
  2304. "parameters": [
  2305. {
  2306. "type": "string",
  2307. "description": "owner of the repo",
  2308. "name": "owner",
  2309. "in": "path",
  2310. "required": true
  2311. },
  2312. {
  2313. "type": "string",
  2314. "description": "name of the repo",
  2315. "name": "repo",
  2316. "in": "path",
  2317. "required": true
  2318. },
  2319. {
  2320. "type": "string",
  2321. "description": "path of the file to create",
  2322. "name": "filepath",
  2323. "in": "path",
  2324. "required": true
  2325. },
  2326. {
  2327. "name": "body",
  2328. "in": "body",
  2329. "required": true,
  2330. "schema": {
  2331. "$ref": "#/definitions/CreateFileOptions"
  2332. }
  2333. }
  2334. ],
  2335. "responses": {
  2336. "201": {
  2337. "$ref": "#/responses/FileResponse"
  2338. }
  2339. }
  2340. },
  2341. "delete": {
  2342. "consumes": [
  2343. "application/json"
  2344. ],
  2345. "produces": [
  2346. "application/json"
  2347. ],
  2348. "tags": [
  2349. "repository"
  2350. ],
  2351. "summary": "Delete a file in a repository",
  2352. "operationId": "repoDeleteFile",
  2353. "parameters": [
  2354. {
  2355. "type": "string",
  2356. "description": "owner of the repo",
  2357. "name": "owner",
  2358. "in": "path",
  2359. "required": true
  2360. },
  2361. {
  2362. "type": "string",
  2363. "description": "name of the repo",
  2364. "name": "repo",
  2365. "in": "path",
  2366. "required": true
  2367. },
  2368. {
  2369. "type": "string",
  2370. "description": "path of the file to delete",
  2371. "name": "filepath",
  2372. "in": "path",
  2373. "required": true
  2374. },
  2375. {
  2376. "name": "body",
  2377. "in": "body",
  2378. "required": true,
  2379. "schema": {
  2380. "$ref": "#/definitions/DeleteFileOptions"
  2381. }
  2382. }
  2383. ],
  2384. "responses": {
  2385. "200": {
  2386. "$ref": "#/responses/FileDeleteResponse"
  2387. }
  2388. }
  2389. }
  2390. },
  2391. "/repos/{owner}/{repo}/editorconfig/{filepath}": {
  2392. "get": {
  2393. "produces": [
  2394. "application/json"
  2395. ],
  2396. "tags": [
  2397. "repository"
  2398. ],
  2399. "summary": "Get the EditorConfig definitions of a file in a repository",
  2400. "operationId": "repoGetEditorConfig",
  2401. "parameters": [
  2402. {
  2403. "type": "string",
  2404. "description": "owner of the repo",
  2405. "name": "owner",
  2406. "in": "path",
  2407. "required": true
  2408. },
  2409. {
  2410. "type": "string",
  2411. "description": "name of the repo",
  2412. "name": "repo",
  2413. "in": "path",
  2414. "required": true
  2415. },
  2416. {
  2417. "type": "string",
  2418. "description": "filepath of file to get",
  2419. "name": "filepath",
  2420. "in": "path",
  2421. "required": true
  2422. }
  2423. ],
  2424. "responses": {
  2425. "200": {
  2426. "description": "success"
  2427. },
  2428. "404": {
  2429. "$ref": "#/responses/notFound"
  2430. }
  2431. }
  2432. }
  2433. },
  2434. "/repos/{owner}/{repo}/forks": {
  2435. "get": {
  2436. "produces": [
  2437. "application/json"
  2438. ],
  2439. "tags": [
  2440. "repository"
  2441. ],
  2442. "summary": "List a repository's forks",
  2443. "operationId": "listForks",
  2444. "parameters": [
  2445. {
  2446. "type": "string",
  2447. "description": "owner of the repo",
  2448. "name": "owner",
  2449. "in": "path",
  2450. "required": true
  2451. },
  2452. {
  2453. "type": "string",
  2454. "description": "name of the repo",
  2455. "name": "repo",
  2456. "in": "path",
  2457. "required": true
  2458. },
  2459. {
  2460. "type": "integer",
  2461. "description": "page number of results to return (1-based)",
  2462. "name": "page",
  2463. "in": "query"
  2464. },
  2465. {
  2466. "type": "integer",
  2467. "description": "page size of results, maximum page size is 50",
  2468. "name": "limit",
  2469. "in": "query"
  2470. }
  2471. ],
  2472. "responses": {
  2473. "200": {
  2474. "$ref": "#/responses/RepositoryList"
  2475. }
  2476. }
  2477. },
  2478. "post": {
  2479. "produces": [
  2480. "application/json"
  2481. ],
  2482. "tags": [
  2483. "repository"
  2484. ],
  2485. "summary": "Fork a repository",
  2486. "operationId": "createFork",
  2487. "parameters": [
  2488. {
  2489. "type": "string",
  2490. "description": "owner of the repo to fork",
  2491. "name": "owner",
  2492. "in": "path",
  2493. "required": true
  2494. },
  2495. {
  2496. "type": "string",
  2497. "description": "name of the repo to fork",
  2498. "name": "repo",
  2499. "in": "path",
  2500. "required": true
  2501. },
  2502. {
  2503. "name": "body",
  2504. "in": "body",
  2505. "schema": {
  2506. "$ref": "#/definitions/CreateForkOption"
  2507. }
  2508. }
  2509. ],
  2510. "responses": {
  2511. "202": {
  2512. "$ref": "#/responses/Repository"
  2513. },
  2514. "403": {
  2515. "$ref": "#/responses/forbidden"
  2516. },
  2517. "422": {
  2518. "$ref": "#/responses/validationError"
  2519. }
  2520. }
  2521. }
  2522. },
  2523. "/repos/{owner}/{repo}/git/blobs/{sha}": {
  2524. "get": {
  2525. "produces": [
  2526. "application/json"
  2527. ],
  2528. "tags": [
  2529. "repository"
  2530. ],
  2531. "summary": "Gets the blob of a repository.",
  2532. "operationId": "GetBlob",
  2533. "parameters": [
  2534. {
  2535. "type": "string",
  2536. "description": "owner of the repo",
  2537. "name": "owner",
  2538. "in": "path",
  2539. "required": true
  2540. },
  2541. {
  2542. "type": "string",
  2543. "description": "name of the repo",
  2544. "name": "repo",
  2545. "in": "path",
  2546. "required": true
  2547. },
  2548. {
  2549. "type": "string",
  2550. "description": "sha of the commit",
  2551. "name": "sha",
  2552. "in": "path",
  2553. "required": true
  2554. }
  2555. ],
  2556. "responses": {
  2557. "200": {
  2558. "$ref": "#/responses/GitBlobResponse"
  2559. },
  2560. "400": {
  2561. "$ref": "#/responses/error"
  2562. }
  2563. }
  2564. }
  2565. },
  2566. "/repos/{owner}/{repo}/git/commits/{sha}": {
  2567. "get": {
  2568. "produces": [
  2569. "application/json"
  2570. ],
  2571. "tags": [
  2572. "repository"
  2573. ],
  2574. "summary": "Get a single commit from a repository",
  2575. "operationId": "repoGetSingleCommit",
  2576. "parameters": [
  2577. {
  2578. "type": "string",
  2579. "description": "owner of the repo",
  2580. "name": "owner",
  2581. "in": "path",
  2582. "required": true
  2583. },
  2584. {
  2585. "type": "string",
  2586. "description": "name of the repo",
  2587. "name": "repo",
  2588. "in": "path",
  2589. "required": true
  2590. },
  2591. {
  2592. "type": "string",
  2593. "description": "the commit hash",
  2594. "name": "sha",
  2595. "in": "path",
  2596. "required": true
  2597. }
  2598. ],
  2599. "responses": {
  2600. "200": {
  2601. "$ref": "#/responses/Commit"
  2602. },
  2603. "404": {
  2604. "$ref": "#/responses/notFound"
  2605. }
  2606. }
  2607. }
  2608. },
  2609. "/repos/{owner}/{repo}/git/refs": {
  2610. "get": {
  2611. "produces": [
  2612. "application/json"
  2613. ],
  2614. "tags": [
  2615. "repository"
  2616. ],
  2617. "summary": "Get specified ref or filtered repository's refs",
  2618. "operationId": "repoListAllGitRefs",
  2619. "parameters": [
  2620. {
  2621. "type": "string",
  2622. "description": "owner of the repo",
  2623. "name": "owner",
  2624. "in": "path",
  2625. "required": true
  2626. },
  2627. {
  2628. "type": "string",
  2629. "description": "name of the repo",
  2630. "name": "repo",
  2631. "in": "path",
  2632. "required": true
  2633. }
  2634. ],
  2635. "responses": {
  2636. "200": {
  2637. "$ref": "#/responses/ReferenceList"
  2638. },
  2639. "404": {
  2640. "$ref": "#/responses/notFound"
  2641. }
  2642. }
  2643. }
  2644. },
  2645. "/repos/{owner}/{repo}/git/refs/{ref}": {
  2646. "get": {
  2647. "produces": [
  2648. "application/json"
  2649. ],
  2650. "tags": [
  2651. "repository"
  2652. ],
  2653. "summary": "Get specified ref or filtered repository's refs",
  2654. "operationId": "repoListGitRefs",
  2655. "parameters": [
  2656. {
  2657. "type": "string",
  2658. "description": "owner of the repo",
  2659. "name": "owner",
  2660. "in": "path",
  2661. "required": true
  2662. },
  2663. {
  2664. "type": "string",
  2665. "description": "name of the repo",
  2666. "name": "repo",
  2667. "in": "path",
  2668. "required": true
  2669. },
  2670. {
  2671. "type": "string",
  2672. "description": "part or full name of the ref",
  2673. "name": "ref",
  2674. "in": "path",
  2675. "required": true
  2676. }
  2677. ],
  2678. "responses": {
  2679. "200": {
  2680. "$ref": "#/responses/ReferenceList"
  2681. },
  2682. "404": {
  2683. "$ref": "#/responses/notFound"
  2684. }
  2685. }
  2686. }
  2687. },
  2688. "/repos/{owner}/{repo}/git/tags/{sha}": {
  2689. "get": {
  2690. "produces": [
  2691. "application/json"
  2692. ],
  2693. "tags": [
  2694. "repository"
  2695. ],
  2696. "summary": "Gets the tag object of an annotated tag (not lightweight tags)",
  2697. "operationId": "GetTag",
  2698. "parameters": [
  2699. {
  2700. "type": "string",
  2701. "description": "owner of the repo",
  2702. "name": "owner",
  2703. "in": "path",
  2704. "required": true
  2705. },
  2706. {
  2707. "type": "string",
  2708. "description": "name of the repo",
  2709. "name": "repo",
  2710. "in": "path",
  2711. "required": true
  2712. },
  2713. {
  2714. "type": "string",
  2715. "description": "sha of the tag. The Git tags API only supports annotated tag objects, not lightweight tags.",
  2716. "name": "sha",
  2717. "in": "path",
  2718. "required": true
  2719. }
  2720. ],
  2721. "responses": {
  2722. "200": {
  2723. "$ref": "#/responses/AnnotatedTag"
  2724. },
  2725. "400": {
  2726. "$ref": "#/responses/error"
  2727. }
  2728. }
  2729. }
  2730. },
  2731. "/repos/{owner}/{repo}/git/trees/{sha}": {
  2732. "get": {
  2733. "produces": [
  2734. "application/json"
  2735. ],
  2736. "tags": [
  2737. "repository"
  2738. ],
  2739. "summary": "Gets the tree of a repository.",
  2740. "operationId": "GetTree",
  2741. "parameters": [
  2742. {
  2743. "type": "string",
  2744. "description": "owner of the repo",
  2745. "name": "owner",
  2746. "in": "path",
  2747. "required": true
  2748. },
  2749. {
  2750. "type": "string",
  2751. "description": "name of the repo",
  2752. "name": "repo",
  2753. "in": "path",
  2754. "required": true
  2755. },
  2756. {
  2757. "type": "string",
  2758. "description": "sha of the commit",
  2759. "name": "sha",
  2760. "in": "path",
  2761. "required": true
  2762. },
  2763. {
  2764. "type": "boolean",
  2765. "description": "show all directories and files",
  2766. "name": "recursive",
  2767. "in": "query"
  2768. },
  2769. {
  2770. "type": "integer",
  2771. "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",
  2772. "name": "page",
  2773. "in": "query"
  2774. },
  2775. {
  2776. "type": "integer",
  2777. "description": "number of items per page; default is 1000 or what is set in app.ini as DEFAULT_GIT_TREES_PER_PAGE",
  2778. "name": "per_page",
  2779. "in": "query"
  2780. }
  2781. ],
  2782. "responses": {
  2783. "200": {
  2784. "$ref": "#/responses/GitTreeResponse"
  2785. },
  2786. "400": {
  2787. "$ref": "#/responses/error"
  2788. }
  2789. }
  2790. }
  2791. },
  2792. "/repos/{owner}/{repo}/hooks": {
  2793. "get": {
  2794. "produces": [
  2795. "application/json"
  2796. ],
  2797. "tags": [
  2798. "repository"
  2799. ],
  2800. "summary": "List the hooks in a repository",
  2801. "operationId": "repoListHooks",
  2802. "parameters": [
  2803. {
  2804. "type": "string",
  2805. "description": "owner of the repo",
  2806. "name": "owner",
  2807. "in": "path",
  2808. "required": true
  2809. },
  2810. {
  2811. "type": "string",
  2812. "description": "name of the repo",
  2813. "name": "repo",
  2814. "in": "path",
  2815. "required": true
  2816. },
  2817. {
  2818. "type": "integer",
  2819. "description": "page number of results to return (1-based)",
  2820. "name": "page",
  2821. "in": "query"
  2822. },
  2823. {
  2824. "type": "integer",
  2825. "description": "page size of results, maximum page size is 50",
  2826. "name": "limit",
  2827. "in": "query"
  2828. }
  2829. ],
  2830. "responses": {
  2831. "200": {
  2832. "$ref": "#/responses/HookList"
  2833. }
  2834. }
  2835. },
  2836. "post": {
  2837. "consumes": [
  2838. "application/json"
  2839. ],
  2840. "produces": [
  2841. "application/json"
  2842. ],
  2843. "tags": [
  2844. "repository"
  2845. ],
  2846. "summary": "Create a hook",
  2847. "operationId": "repoCreateHook",
  2848. "parameters": [
  2849. {
  2850. "type": "string",
  2851. "description": "owner of the repo",
  2852. "name": "owner",
  2853. "in": "path",
  2854. "required": true
  2855. },
  2856. {
  2857. "type": "string",
  2858. "description": "name of the repo",
  2859. "name": "repo",
  2860. "in": "path",
  2861. "required": true
  2862. },
  2863. {
  2864. "name": "body",
  2865. "in": "body",
  2866. "schema": {
  2867. "$ref": "#/definitions/CreateHookOption"
  2868. }
  2869. }
  2870. ],
  2871. "responses": {
  2872. "201": {
  2873. "$ref": "#/responses/Hook"
  2874. }
  2875. }
  2876. }
  2877. },
  2878. "/repos/{owner}/{repo}/hooks/git": {
  2879. "get": {
  2880. "produces": [
  2881. "application/json"
  2882. ],
  2883. "tags": [
  2884. "repository"
  2885. ],
  2886. "summary": "List the Git hooks in a repository",
  2887. "operationId": "repoListGitHooks",
  2888. "parameters": [
  2889. {
  2890. "type": "string",
  2891. "description": "owner of the repo",
  2892. "name": "owner",
  2893. "in": "path",
  2894. "required": true
  2895. },
  2896. {
  2897. "type": "string",
  2898. "description": "name of the repo",
  2899. "name": "repo",
  2900. "in": "path",
  2901. "required": true
  2902. }
  2903. ],
  2904. "responses": {
  2905. "200": {
  2906. "$ref": "#/responses/GitHookList"
  2907. }
  2908. }
  2909. }
  2910. },
  2911. "/repos/{owner}/{repo}/hooks/git/{id}": {
  2912. "get": {
  2913. "produces": [
  2914. "application/json"
  2915. ],
  2916. "tags": [
  2917. "repository"
  2918. ],
  2919. "summary": "Get a Git hook",
  2920. "operationId": "repoGetGitHook",
  2921. "parameters": [
  2922. {
  2923. "type": "string",
  2924. "description": "owner of the repo",
  2925. "name": "owner",
  2926. "in": "path",
  2927. "required": true
  2928. },
  2929. {
  2930. "type": "string",
  2931. "description": "name of the repo",
  2932. "name": "repo",
  2933. "in": "path",
  2934. "required": true
  2935. },
  2936. {
  2937. "type": "string",
  2938. "description": "id of the hook to get",
  2939. "name": "id",
  2940. "in": "path",
  2941. "required": true
  2942. }
  2943. ],
  2944. "responses": {
  2945. "200": {
  2946. "$ref": "#/responses/GitHook"
  2947. },
  2948. "404": {
  2949. "$ref": "#/responses/notFound"
  2950. }
  2951. }
  2952. },
  2953. "delete": {
  2954. "produces": [
  2955. "application/json"
  2956. ],
  2957. "tags": [
  2958. "repository"
  2959. ],
  2960. "summary": "Delete a Git hook in a repository",
  2961. "operationId": "repoDeleteGitHook",
  2962. "parameters": [
  2963. {
  2964. "type": "string",
  2965. "description": "owner of the repo",
  2966. "name": "owner",
  2967. "in": "path",
  2968. "required": true
  2969. },
  2970. {
  2971. "type": "string",
  2972. "description": "name of the repo",
  2973. "name": "repo",
  2974. "in": "path",
  2975. "required": true
  2976. },
  2977. {
  2978. "type": "string",
  2979. "description": "id of the hook to get",
  2980. "name": "id",
  2981. "in": "path",
  2982. "required": true
  2983. }
  2984. ],
  2985. "responses": {
  2986. "204": {
  2987. "$ref": "#/responses/empty"
  2988. },
  2989. "404": {
  2990. "$ref": "#/responses/notFound"
  2991. }
  2992. }
  2993. },
  2994. "patch": {
  2995. "produces": [
  2996. "application/json"
  2997. ],
  2998. "tags": [
  2999. "repository"
  3000. ],
  3001. "summary": "Edit a Git hook in a repository",
  3002. "operationId": "repoEditGitHook",
  3003. "parameters": [
  3004. {
  3005. "type": "string",
  3006. "description": "owner of the repo",
  3007. "name": "owner",
  3008. "in": "path",
  3009. "required": true
  3010. },
  3011. {
  3012. "type": "string",
  3013. "description": "name of the repo",
  3014. "name": "repo",
  3015. "in": "path",
  3016. "required": true
  3017. },
  3018. {
  3019. "type": "string",
  3020. "description": "id of the hook to get",
  3021. "name": "id",
  3022. "in": "path",
  3023. "required": true
  3024. },
  3025. {
  3026. "name": "body",
  3027. "in": "body",
  3028. "schema": {
  3029. "$ref": "#/definitions/EditGitHookOption"
  3030. }
  3031. }
  3032. ],
  3033. "responses": {
  3034. "200": {
  3035. "$ref": "#/responses/GitHook"
  3036. },
  3037. "404": {
  3038. "$ref": "#/responses/notFound"
  3039. }
  3040. }
  3041. }
  3042. },
  3043. "/repos/{owner}/{repo}/hooks/{id}": {
  3044. "get": {
  3045. "produces": [
  3046. "application/json"
  3047. ],
  3048. "tags": [
  3049. "repository"
  3050. ],
  3051. "summary": "Get a hook",
  3052. "operationId": "repoGetHook",
  3053. "parameters": [
  3054. {
  3055. "type": "string",
  3056. "description": "owner of the repo",
  3057. "name": "owner",
  3058. "in": "path",
  3059. "required": true
  3060. },
  3061. {
  3062. "type": "string",
  3063. "description": "name of the repo",
  3064. "name": "repo",
  3065. "in": "path",
  3066. "required": true
  3067. },
  3068. {
  3069. "type": "integer",
  3070. "format": "int64",
  3071. "description": "id of the hook to get",
  3072. "name": "id",
  3073. "in": "path",
  3074. "required": true
  3075. }
  3076. ],
  3077. "responses": {
  3078. "200": {
  3079. "$ref": "#/responses/Hook"
  3080. },
  3081. "404": {
  3082. "$ref": "#/responses/notFound"
  3083. }
  3084. }
  3085. },
  3086. "delete": {
  3087. "produces": [
  3088. "application/json"
  3089. ],
  3090. "tags": [
  3091. "repository"
  3092. ],
  3093. "summary": "Delete a hook in a repository",
  3094. "operationId": "repoDeleteHook",
  3095. "parameters": [
  3096. {
  3097. "type": "string",
  3098. "description": "owner of the repo",
  3099. "name": "owner",
  3100. "in": "path",
  3101. "required": true
  3102. },
  3103. {
  3104. "type": "string",
  3105. "description": "name of the repo",
  3106. "name": "repo",
  3107. "in": "path",
  3108. "required": true
  3109. },
  3110. {
  3111. "type": "integer",
  3112. "format": "int64",
  3113. "description": "id of the hook to delete",
  3114. "name": "id",
  3115. "in": "path",
  3116. "required": true
  3117. }
  3118. ],
  3119. "responses": {
  3120. "204": {
  3121. "$ref": "#/responses/empty"
  3122. },
  3123. "404": {
  3124. "$ref": "#/responses/notFound"
  3125. }
  3126. }
  3127. },
  3128. "patch": {
  3129. "produces": [
  3130. "application/json"
  3131. ],
  3132. "tags": [
  3133. "repository"
  3134. ],
  3135. "summary": "Edit a hook in a repository",
  3136. "operationId": "repoEditHook",
  3137. "parameters": [
  3138. {
  3139. "type": "string",
  3140. "description": "owner of the repo",
  3141. "name": "owner",
  3142. "in": "path",
  3143. "required": true
  3144. },
  3145. {
  3146. "type": "string",
  3147. "description": "name of the repo",
  3148. "name": "repo",
  3149. "in": "path",
  3150. "required": true
  3151. },
  3152. {
  3153. "type": "integer",
  3154. "format": "int64",
  3155. "description": "index of the hook",
  3156. "name": "id",
  3157. "in": "path",
  3158. "required": true
  3159. },
  3160. {
  3161. "name": "body",
  3162. "in": "body",
  3163. "schema": {
  3164. "$ref": "#/definitions/EditHookOption"
  3165. }
  3166. }
  3167. ],
  3168. "responses": {
  3169. "200": {
  3170. "$ref": "#/responses/Hook"
  3171. }
  3172. }
  3173. }
  3174. },
  3175. "/repos/{owner}/{repo}/hooks/{id}/tests": {
  3176. "post": {
  3177. "produces": [
  3178. "application/json"
  3179. ],
  3180. "tags": [
  3181. "repository"
  3182. ],
  3183. "summary": "Test a push webhook",
  3184. "operationId": "repoTestHook",
  3185. "parameters": [
  3186. {
  3187. "type": "string",
  3188. "description": "owner of the repo",
  3189. "name": "owner",
  3190. "in": "path",
  3191. "required": true
  3192. },
  3193. {
  3194. "type": "string",
  3195. "description": "name of the repo",
  3196. "name": "repo",
  3197. "in": "path",
  3198. "required": true
  3199. },
  3200. {
  3201. "type": "integer",
  3202. "format": "int64",
  3203. "description": "id of the hook to test",
  3204. "name": "id",
  3205. "in": "path",
  3206. "required": true
  3207. }
  3208. ],
  3209. "responses": {
  3210. "204": {
  3211. "$ref": "#/responses/empty"
  3212. }
  3213. }
  3214. }
  3215. },
  3216. "/repos/{owner}/{repo}/issues": {
  3217. "get": {
  3218. "produces": [
  3219. "application/json"
  3220. ],
  3221. "tags": [
  3222. "issue"
  3223. ],
  3224. "summary": "List a repository's issues",
  3225. "operationId": "issueListIssues",
  3226. "parameters": [
  3227. {
  3228. "type": "string",
  3229. "description": "owner of the repo",
  3230. "name": "owner",
  3231. "in": "path",
  3232. "required": true
  3233. },
  3234. {
  3235. "type": "string",
  3236. "description": "name of the repo",
  3237. "name": "repo",
  3238. "in": "path",
  3239. "required": true
  3240. },
  3241. {
  3242. "type": "string",
  3243. "description": "whether issue is open or closed",
  3244. "name": "state",
  3245. "in": "query"
  3246. },
  3247. {
  3248. "type": "string",
  3249. "description": "comma separated list of labels. Fetch only issues that have any of this labels. Non existent labels are discarded",
  3250. "name": "labels",
  3251. "in": "query"
  3252. },
  3253. {
  3254. "type": "string",
  3255. "description": "search string",
  3256. "name": "q",
  3257. "in": "query"
  3258. },
  3259. {
  3260. "type": "string",
  3261. "description": "filter by type (issues / pulls) if set",
  3262. "name": "type",
  3263. "in": "query"
  3264. },
  3265. {
  3266. "type": "integer",
  3267. "description": "page number of results to return (1-based)",
  3268. "name": "page",
  3269. "in": "query"
  3270. },
  3271. {
  3272. "type": "integer",
  3273. "description": "page size of results, maximum page size is 50",
  3274. "name": "limit",
  3275. "in": "query"
  3276. }
  3277. ],
  3278. "responses": {
  3279. "200": {
  3280. "$ref": "#/responses/IssueList"
  3281. }
  3282. }
  3283. },
  3284. "post": {
  3285. "consumes": [
  3286. "application/json"
  3287. ],
  3288. "produces": [
  3289. "application/json"
  3290. ],
  3291. "tags": [
  3292. "issue"
  3293. ],
  3294. "summary": "Create an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3295. "operationId": "issueCreateIssue",
  3296. "parameters": [
  3297. {
  3298. "type": "string",
  3299. "description": "owner of the repo",
  3300. "name": "owner",
  3301. "in": "path",
  3302. "required": true
  3303. },
  3304. {
  3305. "type": "string",
  3306. "description": "name of the repo",
  3307. "name": "repo",
  3308. "in": "path",
  3309. "required": true
  3310. },
  3311. {
  3312. "name": "body",
  3313. "in": "body",
  3314. "schema": {
  3315. "$ref": "#/definitions/CreateIssueOption"
  3316. }
  3317. }
  3318. ],
  3319. "responses": {
  3320. "201": {
  3321. "$ref": "#/responses/Issue"
  3322. },
  3323. "403": {
  3324. "$ref": "#/responses/forbidden"
  3325. },
  3326. "412": {
  3327. "$ref": "#/responses/error"
  3328. },
  3329. "422": {
  3330. "$ref": "#/responses/validationError"
  3331. }
  3332. }
  3333. }
  3334. },
  3335. "/repos/{owner}/{repo}/issues/comments": {
  3336. "get": {
  3337. "produces": [
  3338. "application/json"
  3339. ],
  3340. "tags": [
  3341. "issue"
  3342. ],
  3343. "summary": "List all comments in a repository",
  3344. "operationId": "issueGetRepoComments",
  3345. "parameters": [
  3346. {
  3347. "type": "string",
  3348. "description": "owner of the repo",
  3349. "name": "owner",
  3350. "in": "path",
  3351. "required": true
  3352. },
  3353. {
  3354. "type": "string",
  3355. "description": "name of the repo",
  3356. "name": "repo",
  3357. "in": "path",
  3358. "required": true
  3359. },
  3360. {
  3361. "type": "string",
  3362. "format": "date-time",
  3363. "description": "if provided, only comments updated since the provided time are returned.",
  3364. "name": "since",
  3365. "in": "query"
  3366. },
  3367. {
  3368. "type": "string",
  3369. "format": "date-time",
  3370. "description": "if provided, only comments updated before the provided time are returned.",
  3371. "name": "before",
  3372. "in": "query"
  3373. },
  3374. {
  3375. "type": "integer",
  3376. "description": "page number of results to return (1-based)",
  3377. "name": "page",
  3378. "in": "query"
  3379. },
  3380. {
  3381. "type": "integer",
  3382. "description": "page size of results, maximum page size is 50",
  3383. "name": "limit",
  3384. "in": "query"
  3385. }
  3386. ],
  3387. "responses": {
  3388. "200": {
  3389. "$ref": "#/responses/CommentList"
  3390. }
  3391. }
  3392. }
  3393. },
  3394. "/repos/{owner}/{repo}/issues/comments/{id}": {
  3395. "get": {
  3396. "consumes": [
  3397. "application/json"
  3398. ],
  3399. "produces": [
  3400. "application/json"
  3401. ],
  3402. "tags": [
  3403. "issue"
  3404. ],
  3405. "summary": "Get a comment",
  3406. "operationId": "issueGetComment",
  3407. "parameters": [
  3408. {
  3409. "type": "string",
  3410. "description": "owner of the repo",
  3411. "name": "owner",
  3412. "in": "path",
  3413. "required": true
  3414. },
  3415. {
  3416. "type": "string",
  3417. "description": "name of the repo",
  3418. "name": "repo",
  3419. "in": "path",
  3420. "required": true
  3421. },
  3422. {
  3423. "type": "integer",
  3424. "format": "int64",
  3425. "description": "id of the comment",
  3426. "name": "id",
  3427. "in": "path",
  3428. "required": true
  3429. }
  3430. ],
  3431. "responses": {
  3432. "200": {
  3433. "$ref": "#/responses/Comment"
  3434. },
  3435. "204": {
  3436. "$ref": "#/responses/empty"
  3437. },
  3438. "403": {
  3439. "$ref": "#/responses/forbidden"
  3440. },
  3441. "404": {
  3442. "$ref": "#/responses/notFound"
  3443. }
  3444. }
  3445. },
  3446. "delete": {
  3447. "tags": [
  3448. "issue"
  3449. ],
  3450. "summary": "Delete a comment",
  3451. "operationId": "issueDeleteComment",
  3452. "parameters": [
  3453. {
  3454. "type": "string",
  3455. "description": "owner of the repo",
  3456. "name": "owner",
  3457. "in": "path",
  3458. "required": true
  3459. },
  3460. {
  3461. "type": "string",
  3462. "description": "name of the repo",
  3463. "name": "repo",
  3464. "in": "path",
  3465. "required": true
  3466. },
  3467. {
  3468. "type": "integer",
  3469. "format": "int64",
  3470. "description": "id of comment to delete",
  3471. "name": "id",
  3472. "in": "path",
  3473. "required": true
  3474. }
  3475. ],
  3476. "responses": {
  3477. "204": {
  3478. "$ref": "#/responses/empty"
  3479. },
  3480. "403": {
  3481. "$ref": "#/responses/forbidden"
  3482. },
  3483. "404": {
  3484. "$ref": "#/responses/notFound"
  3485. }
  3486. }
  3487. },
  3488. "patch": {
  3489. "consumes": [
  3490. "application/json"
  3491. ],
  3492. "produces": [
  3493. "application/json"
  3494. ],
  3495. "tags": [
  3496. "issue"
  3497. ],
  3498. "summary": "Edit a comment",
  3499. "operationId": "issueEditComment",
  3500. "parameters": [
  3501. {
  3502. "type": "string",
  3503. "description": "owner of the repo",
  3504. "name": "owner",
  3505. "in": "path",
  3506. "required": true
  3507. },
  3508. {
  3509. "type": "string",
  3510. "description": "name of the repo",
  3511. "name": "repo",
  3512. "in": "path",
  3513. "required": true
  3514. },
  3515. {
  3516. "type": "integer",
  3517. "format": "int64",
  3518. "description": "id of the comment to edit",
  3519. "name": "id",
  3520. "in": "path",
  3521. "required": true
  3522. },
  3523. {
  3524. "name": "body",
  3525. "in": "body",
  3526. "schema": {
  3527. "$ref": "#/definitions/EditIssueCommentOption"
  3528. }
  3529. }
  3530. ],
  3531. "responses": {
  3532. "200": {
  3533. "$ref": "#/responses/Comment"
  3534. },
  3535. "204": {
  3536. "$ref": "#/responses/empty"
  3537. },
  3538. "403": {
  3539. "$ref": "#/responses/forbidden"
  3540. },
  3541. "404": {
  3542. "$ref": "#/responses/notFound"
  3543. }
  3544. }
  3545. }
  3546. },
  3547. "/repos/{owner}/{repo}/issues/comments/{id}/reactions": {
  3548. "get": {
  3549. "consumes": [
  3550. "application/json"
  3551. ],
  3552. "produces": [
  3553. "application/json"
  3554. ],
  3555. "tags": [
  3556. "issue"
  3557. ],
  3558. "summary": "Get a list of reactions from a comment of an issue",
  3559. "operationId": "issueGetCommentReactions",
  3560. "parameters": [
  3561. {
  3562. "type": "string",
  3563. "description": "owner of the repo",
  3564. "name": "owner",
  3565. "in": "path",
  3566. "required": true
  3567. },
  3568. {
  3569. "type": "string",
  3570. "description": "name of the repo",
  3571. "name": "repo",
  3572. "in": "path",
  3573. "required": true
  3574. },
  3575. {
  3576. "type": "integer",
  3577. "format": "int64",
  3578. "description": "id of the comment to edit",
  3579. "name": "id",
  3580. "in": "path",
  3581. "required": true
  3582. }
  3583. ],
  3584. "responses": {
  3585. "200": {
  3586. "$ref": "#/responses/ReactionList"
  3587. },
  3588. "403": {
  3589. "$ref": "#/responses/forbidden"
  3590. }
  3591. }
  3592. },
  3593. "post": {
  3594. "consumes": [
  3595. "application/json"
  3596. ],
  3597. "produces": [
  3598. "application/json"
  3599. ],
  3600. "tags": [
  3601. "issue"
  3602. ],
  3603. "summary": "Add a reaction to a comment of an issue",
  3604. "operationId": "issuePostCommentReaction",
  3605. "parameters": [
  3606. {
  3607. "type": "string",
  3608. "description": "owner of the repo",
  3609. "name": "owner",
  3610. "in": "path",
  3611. "required": true
  3612. },
  3613. {
  3614. "type": "string",
  3615. "description": "name of the repo",
  3616. "name": "repo",
  3617. "in": "path",
  3618. "required": true
  3619. },
  3620. {
  3621. "type": "integer",
  3622. "format": "int64",
  3623. "description": "id of the comment to edit",
  3624. "name": "id",
  3625. "in": "path",
  3626. "required": true
  3627. },
  3628. {
  3629. "name": "content",
  3630. "in": "body",
  3631. "schema": {
  3632. "$ref": "#/definitions/EditReactionOption"
  3633. }
  3634. }
  3635. ],
  3636. "responses": {
  3637. "200": {
  3638. "$ref": "#/responses/Reaction"
  3639. },
  3640. "201": {
  3641. "$ref": "#/responses/Reaction"
  3642. },
  3643. "403": {
  3644. "$ref": "#/responses/forbidden"
  3645. }
  3646. }
  3647. },
  3648. "delete": {
  3649. "consumes": [
  3650. "application/json"
  3651. ],
  3652. "produces": [
  3653. "application/json"
  3654. ],
  3655. "tags": [
  3656. "issue"
  3657. ],
  3658. "summary": "Remove a reaction from a comment of an issue",
  3659. "operationId": "issueDeleteCommentReaction",
  3660. "parameters": [
  3661. {
  3662. "type": "string",
  3663. "description": "owner of the repo",
  3664. "name": "owner",
  3665. "in": "path",
  3666. "required": true
  3667. },
  3668. {
  3669. "type": "string",
  3670. "description": "name of the repo",
  3671. "name": "repo",
  3672. "in": "path",
  3673. "required": true
  3674. },
  3675. {
  3676. "type": "integer",
  3677. "format": "int64",
  3678. "description": "id of the comment to edit",
  3679. "name": "id",
  3680. "in": "path",
  3681. "required": true
  3682. },
  3683. {
  3684. "name": "content",
  3685. "in": "body",
  3686. "schema": {
  3687. "$ref": "#/definitions/EditReactionOption"
  3688. }
  3689. }
  3690. ],
  3691. "responses": {
  3692. "200": {
  3693. "$ref": "#/responses/empty"
  3694. },
  3695. "403": {
  3696. "$ref": "#/responses/forbidden"
  3697. }
  3698. }
  3699. }
  3700. },
  3701. "/repos/{owner}/{repo}/issues/{index}": {
  3702. "get": {
  3703. "produces": [
  3704. "application/json"
  3705. ],
  3706. "tags": [
  3707. "issue"
  3708. ],
  3709. "summary": "Get an issue",
  3710. "operationId": "issueGetIssue",
  3711. "parameters": [
  3712. {
  3713. "type": "string",
  3714. "description": "owner of the repo",
  3715. "name": "owner",
  3716. "in": "path",
  3717. "required": true
  3718. },
  3719. {
  3720. "type": "string",
  3721. "description": "name of the repo",
  3722. "name": "repo",
  3723. "in": "path",
  3724. "required": true
  3725. },
  3726. {
  3727. "type": "integer",
  3728. "format": "int64",
  3729. "description": "index of the issue to get",
  3730. "name": "index",
  3731. "in": "path",
  3732. "required": true
  3733. }
  3734. ],
  3735. "responses": {
  3736. "200": {
  3737. "$ref": "#/responses/Issue"
  3738. },
  3739. "404": {
  3740. "$ref": "#/responses/notFound"
  3741. }
  3742. }
  3743. },
  3744. "patch": {
  3745. "consumes": [
  3746. "application/json"
  3747. ],
  3748. "produces": [
  3749. "application/json"
  3750. ],
  3751. "tags": [
  3752. "issue"
  3753. ],
  3754. "summary": "Edit an issue. If using deadline only the date will be taken into account, and time of day ignored.",
  3755. "operationId": "issueEditIssue",
  3756. "parameters": [
  3757. {
  3758. "type": "string",
  3759. "description": "owner of the repo",
  3760. "name": "owner",
  3761. "in": "path",
  3762. "required": true
  3763. },
  3764. {
  3765. "type": "string",
  3766. "description": "name of the repo",
  3767. "name": "repo",
  3768. "in": "path",
  3769. "required": true
  3770. },
  3771. {
  3772. "type": "integer",
  3773. "format": "int64",
  3774. "description": "index of the issue to edit",
  3775. "name": "index",
  3776. "in": "path",
  3777. "required": true
  3778. },
  3779. {
  3780. "name": "body",
  3781. "in": "body",
  3782. "schema": {
  3783. "$ref": "#/definitions/EditIssueOption"
  3784. }
  3785. }
  3786. ],
  3787. "responses": {
  3788. "201": {
  3789. "$ref": "#/responses/Issue"
  3790. },
  3791. "403": {
  3792. "$ref": "#/responses/forbidden"
  3793. },
  3794. "404": {
  3795. "$ref": "#/responses/notFound"
  3796. },
  3797. "412": {
  3798. "$ref": "#/responses/error"
  3799. }
  3800. }
  3801. }
  3802. },
  3803. "/repos/{owner}/{repo}/issues/{index}/comments": {
  3804. "get": {
  3805. "produces": [
  3806. "application/json"
  3807. ],
  3808. "tags": [
  3809. "issue"
  3810. ],
  3811. "summary": "List all comments on an issue",
  3812. "operationId": "issueGetComments",
  3813. "parameters": [
  3814. {
  3815. "type": "string",
  3816. "description": "owner of the repo",
  3817. "name": "owner",
  3818. "in": "path",
  3819. "required": true
  3820. },
  3821. {
  3822. "type": "string",
  3823. "description": "name of the repo",
  3824. "name": "repo",
  3825. "in": "path",
  3826. "required": true
  3827. },
  3828. {
  3829. "type": "integer",
  3830. "format": "int64",
  3831. "description": "index of the issue",
  3832. "name": "index",
  3833. "in": "path",
  3834. "required": true
  3835. },
  3836. {
  3837. "type": "string",
  3838. "format": "date-time",
  3839. "description": "if provided, only comments updated since the specified time are returned.",
  3840. "name": "since",
  3841. "in": "query"
  3842. },
  3843. {
  3844. "type": "string",
  3845. "format": "date-time",
  3846. "description": "if provided, only comments updated before the provided time are returned.",
  3847. "name": "before",
  3848. "in": "query"
  3849. }
  3850. ],
  3851. "responses": {
  3852. "200": {
  3853. "$ref": "#/responses/CommentList"
  3854. }
  3855. }
  3856. },
  3857. "post": {
  3858. "consumes": [
  3859. "application/json"
  3860. ],
  3861. "produces": [
  3862. "application/json"
  3863. ],
  3864. "tags": [
  3865. "issue"
  3866. ],
  3867. "summary": "Add a comment to an issue",
  3868. "operationId": "issueCreateComment",
  3869. "parameters": [
  3870. {
  3871. "type": "string",
  3872. "description": "owner of the repo",
  3873. "name": "owner",
  3874. "in": "path",
  3875. "required": true
  3876. },
  3877. {
  3878. "type": "string",
  3879. "description": "name of the repo",
  3880. "name": "repo",
  3881. "in": "path",
  3882. "required": true
  3883. },
  3884. {
  3885. "type": "integer",
  3886. "format": "int64",
  3887. "description": "index of the issue",
  3888. "name": "index",
  3889. "in": "path",
  3890. "required": true
  3891. },
  3892. {
  3893. "name": "body",
  3894. "in": "body",
  3895. "schema": {
  3896. "$ref": "#/definitions/CreateIssueCommentOption"
  3897. }
  3898. }
  3899. ],
  3900. "responses": {
  3901. "201": {
  3902. "$ref": "#/responses/Comment"
  3903. },
  3904. "403": {
  3905. "$ref": "#/responses/forbidden"
  3906. }
  3907. }
  3908. }
  3909. },
  3910. "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
  3911. "delete": {
  3912. "tags": [
  3913. "issue"
  3914. ],
  3915. "summary": "Delete a comment",
  3916. "operationId": "issueDeleteCommentDeprecated",
  3917. "deprecated": true,
  3918. "parameters": [
  3919. {
  3920. "type": "string",
  3921. "description": "owner of the repo",
  3922. "name": "owner",
  3923. "in": "path",
  3924. "required": true
  3925. },
  3926. {
  3927. "type": "string",
  3928. "description": "name of the repo",
  3929. "name": "repo",
  3930. "in": "path",
  3931. "required": true
  3932. },
  3933. {
  3934. "type": "integer",
  3935. "description": "this parameter is ignored",
  3936. "name": "index",
  3937. "in": "path",
  3938. "required": true
  3939. },
  3940. {
  3941. "type": "integer",
  3942. "format": "int64",
  3943. "description": "id of comment to delete",
  3944. "name": "id",
  3945. "in": "path",
  3946. "required": true
  3947. }
  3948. ],
  3949. "responses": {
  3950. "204": {
  3951. "$ref": "#/responses/empty"
  3952. },
  3953. "403": {
  3954. "$ref": "#/responses/forbidden"
  3955. },
  3956. "404": {
  3957. "$ref": "#/responses/notFound"
  3958. }
  3959. }
  3960. },
  3961. "patch": {
  3962. "consumes": [
  3963. "application/json"
  3964. ],
  3965. "produces": [
  3966. "application/json"
  3967. ],
  3968. "tags": [
  3969. "issue"
  3970. ],
  3971. "summary": "Edit a comment",
  3972. "operationId": "issueEditCommentDeprecated",
  3973. "deprecated": true,
  3974. "parameters": [
  3975. {
  3976. "type": "string",
  3977. "description": "owner of the repo",
  3978. "name": "owner",
  3979. "in": "path",
  3980. "required": true
  3981. },
  3982. {
  3983. "type": "string",
  3984. "description": "name of the repo",
  3985. "name": "repo",
  3986. "in": "path",
  3987. "required": true
  3988. },
  3989. {
  3990. "type": "integer",
  3991. "description": "this parameter is ignored",
  3992. "name": "index",
  3993. "in": "path",
  3994. "required": true
  3995. },
  3996. {
  3997. "type": "integer",
  3998. "format": "int64",
  3999. "description": "id of the comment to edit",
  4000. "name": "id",
  4001. "in": "path",
  4002. "required": true
  4003. },
  4004. {
  4005. "name": "body",
  4006. "in": "body",
  4007. "schema": {
  4008. "$ref": "#/definitions/EditIssueCommentOption"
  4009. }
  4010. }
  4011. ],
  4012. "responses": {
  4013. "200": {
  4014. "$ref": "#/responses/Comment"
  4015. },
  4016. "204": {
  4017. "$ref": "#/responses/empty"
  4018. },
  4019. "403": {
  4020. "$ref": "#/responses/forbidden"
  4021. },
  4022. "404": {
  4023. "$ref": "#/responses/notFound"
  4024. }
  4025. }
  4026. }
  4027. },
  4028. "/repos/{owner}/{repo}/issues/{index}/deadline": {
  4029. "post": {
  4030. "consumes": [
  4031. "application/json"
  4032. ],
  4033. "produces": [
  4034. "application/json"
  4035. ],
  4036. "tags": [
  4037. "issue"
  4038. ],
  4039. "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.",
  4040. "operationId": "issueEditIssueDeadline",
  4041. "parameters": [
  4042. {
  4043. "type": "string",
  4044. "description": "owner of the repo",
  4045. "name": "owner",
  4046. "in": "path",
  4047. "required": true
  4048. },
  4049. {
  4050. "type": "string",
  4051. "description": "name of the repo",
  4052. "name": "repo",
  4053. "in": "path",
  4054. "required": true
  4055. },
  4056. {
  4057. "type": "integer",
  4058. "format": "int64",
  4059. "description": "index of the issue to create or update a deadline on",
  4060. "name": "index",
  4061. "in": "path",
  4062. "required": true
  4063. },
  4064. {
  4065. "name": "body",
  4066. "in": "body",
  4067. "schema": {
  4068. "$ref": "#/definitions/EditDeadlineOption"
  4069. }
  4070. }
  4071. ],
  4072. "responses": {
  4073. "201": {
  4074. "$ref": "#/responses/IssueDeadline"
  4075. },
  4076. "403": {
  4077. "$ref": "#/responses/forbidden"
  4078. },
  4079. "404": {
  4080. "$ref": "#/responses/notFound"
  4081. }
  4082. }
  4083. }
  4084. },
  4085. "/repos/{owner}/{repo}/issues/{index}/labels": {
  4086. "get": {
  4087. "produces": [
  4088. "application/json"
  4089. ],
  4090. "tags": [
  4091. "issue"
  4092. ],
  4093. "summary": "Get an issue's labels",
  4094. "operationId": "issueGetLabels",
  4095. "parameters": [
  4096. {
  4097. "type": "string",
  4098. "description": "owner of the repo",
  4099. "name": "owner",
  4100. "in": "path",
  4101. "required": true
  4102. },
  4103. {
  4104. "type": "string",
  4105. "description": "name of the repo",
  4106. "name": "repo",
  4107. "in": "path",
  4108. "required": true
  4109. },
  4110. {
  4111. "type": "integer",
  4112. "format": "int64",
  4113. "description": "index of the issue",
  4114. "name": "index",
  4115. "in": "path",
  4116. "required": true
  4117. }
  4118. ],
  4119. "responses": {
  4120. "200": {
  4121. "$ref": "#/responses/LabelList"
  4122. },
  4123. "404": {
  4124. "$ref": "#/responses/notFound"
  4125. }
  4126. }
  4127. },
  4128. "put": {
  4129. "consumes": [
  4130. "application/json"
  4131. ],
  4132. "produces": [
  4133. "application/json"
  4134. ],
  4135. "tags": [
  4136. "issue"
  4137. ],
  4138. "summary": "Replace an issue's labels",
  4139. "operationId": "issueReplaceLabels",
  4140. "parameters": [
  4141. {
  4142. "type": "string",
  4143. "description": "owner of the repo",
  4144. "name": "owner",
  4145. "in": "path",
  4146. "required": true
  4147. },
  4148. {
  4149. "type": "string",
  4150. "description": "name of the repo",
  4151. "name": "repo",
  4152. "in": "path",
  4153. "required": true
  4154. },
  4155. {
  4156. "type": "integer",
  4157. "format": "int64",
  4158. "description": "index of the issue",
  4159. "name": "index",
  4160. "in": "path",
  4161. "required": true
  4162. },
  4163. {
  4164. "name": "body",
  4165. "in": "body",
  4166. "schema": {
  4167. "$ref": "#/definitions/IssueLabelsOption"
  4168. }
  4169. }
  4170. ],
  4171. "responses": {
  4172. "200": {
  4173. "$ref": "#/responses/LabelList"
  4174. },
  4175. "403": {
  4176. "$ref": "#/responses/forbidden"
  4177. }
  4178. }
  4179. },
  4180. "post": {
  4181. "consumes": [
  4182. "application/json"
  4183. ],
  4184. "produces": [
  4185. "application/json"
  4186. ],
  4187. "tags": [
  4188. "issue"
  4189. ],
  4190. "summary": "Add a label to an issue",
  4191. "operationId": "issueAddLabel",
  4192. "parameters": [
  4193. {
  4194. "type": "string",
  4195. "description": "owner of the repo",
  4196. "name": "owner",
  4197. "in": "path",
  4198. "required": true
  4199. },
  4200. {
  4201. "type": "string",
  4202. "description": "name of the repo",
  4203. "name": "repo",
  4204. "in": "path",
  4205. "required": true
  4206. },
  4207. {
  4208. "type": "integer",
  4209. "format": "int64",
  4210. "description": "index of the issue",
  4211. "name": "index",
  4212. "in": "path",
  4213. "required": true
  4214. },
  4215. {
  4216. "name": "body",
  4217. "in": "body",
  4218. "schema": {
  4219. "$ref": "#/definitions/IssueLabelsOption"
  4220. }
  4221. }
  4222. ],
  4223. "responses": {
  4224. "200": {
  4225. "$ref": "#/responses/LabelList"
  4226. },
  4227. "403": {
  4228. "$ref": "#/responses/forbidden"
  4229. }
  4230. }
  4231. },
  4232. "delete": {
  4233. "produces": [
  4234. "application/json"
  4235. ],
  4236. "tags": [
  4237. "issue"
  4238. ],
  4239. "summary": "Remove all labels from an issue",
  4240. "operationId": "issueClearLabels",
  4241. "parameters": [
  4242. {
  4243. "type": "string",
  4244. "description": "owner of the repo",
  4245. "name": "owner",
  4246. "in": "path",
  4247. "required": true
  4248. },
  4249. {
  4250. "type": "string",
  4251. "description": "name of the repo",
  4252. "name": "repo",
  4253. "in": "path",
  4254. "required": true
  4255. },
  4256. {
  4257. "type": "integer",
  4258. "format": "int64",
  4259. "description": "index of the issue",
  4260. "name": "index",
  4261. "in": "path",
  4262. "required": true
  4263. }
  4264. ],
  4265. "responses": {
  4266. "204": {
  4267. "$ref": "#/responses/empty"
  4268. },
  4269. "403": {
  4270. "$ref": "#/responses/forbidden"
  4271. }
  4272. }
  4273. }
  4274. },
  4275. "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
  4276. "delete": {
  4277. "produces": [
  4278. "application/json"
  4279. ],
  4280. "tags": [
  4281. "issue"
  4282. ],
  4283. "summary": "Remove a label from an issue",
  4284. "operationId": "issueRemoveLabel",
  4285. "parameters": [
  4286. {
  4287. "type": "string",
  4288. "description": "owner of the repo",
  4289. "name": "owner",
  4290. "in": "path",
  4291. "required": true
  4292. },
  4293. {
  4294. "type": "string",
  4295. "description": "name of the repo",
  4296. "name": "repo",
  4297. "in": "path",
  4298. "required": true
  4299. },
  4300. {
  4301. "type": "integer",
  4302. "format": "int64",
  4303. "description": "index of the issue",
  4304. "name": "index",
  4305. "in": "path",
  4306. "required": true
  4307. },
  4308. {
  4309. "type": "integer",
  4310. "format": "int64",
  4311. "description": "id of the label to remove",
  4312. "name": "id",
  4313. "in": "path",
  4314. "required": true
  4315. }
  4316. ],
  4317. "responses": {
  4318. "204": {
  4319. "$ref": "#/responses/empty"
  4320. },
  4321. "403": {
  4322. "$ref": "#/responses/forbidden"
  4323. },
  4324. "422": {
  4325. "$ref": "#/responses/validationError"
  4326. }
  4327. }
  4328. }
  4329. },
  4330. "/repos/{owner}/{repo}/issues/{index}/reactions": {
  4331. "get": {
  4332. "consumes": [
  4333. "application/json"
  4334. ],
  4335. "produces": [
  4336. "application/json"
  4337. ],
  4338. "tags": [
  4339. "issue"
  4340. ],
  4341. "summary": "Get a list reactions of an issue",
  4342. "operationId": "issueGetIssueReactions",
  4343. "parameters": [
  4344. {
  4345. "type": "string",
  4346. "description": "owner of the repo",
  4347. "name": "owner",
  4348. "in": "path",
  4349. "required": true
  4350. },
  4351. {
  4352. "type": "string",
  4353. "description": "name of the repo",
  4354. "name": "repo",
  4355. "in": "path",
  4356. "required": true
  4357. },
  4358. {
  4359. "type": "integer",
  4360. "format": "int64",
  4361. "description": "index of the issue",
  4362. "name": "index",
  4363. "in": "path",
  4364. "required": true
  4365. },
  4366. {
  4367. "type": "integer",
  4368. "description": "page number of results to return (1-based)",
  4369. "name": "page",
  4370. "in": "query"
  4371. },
  4372. {
  4373. "type": "integer",
  4374. "description": "page size of results, maximum page size is 50",
  4375. "name": "limit",
  4376. "in": "query"
  4377. }
  4378. ],
  4379. "responses": {
  4380. "200": {
  4381. "$ref": "#/responses/ReactionList"
  4382. },
  4383. "403": {
  4384. "$ref": "#/responses/forbidden"
  4385. }
  4386. }
  4387. },
  4388. "post": {
  4389. "consumes": [
  4390. "application/json"
  4391. ],
  4392. "produces": [
  4393. "application/json"
  4394. ],
  4395. "tags": [
  4396. "issue"
  4397. ],
  4398. "summary": "Add a reaction to an issue",
  4399. "operationId": "issuePostIssueReaction",
  4400. "parameters": [
  4401. {
  4402. "type": "string",
  4403. "description": "owner of the repo",
  4404. "name": "owner",
  4405. "in": "path",
  4406. "required": true
  4407. },
  4408. {
  4409. "type": "string",
  4410. "description": "name of the repo",
  4411. "name": "repo",
  4412. "in": "path",
  4413. "required": true
  4414. },
  4415. {
  4416. "type": "integer",
  4417. "format": "int64",
  4418. "description": "index of the issue",
  4419. "name": "index",
  4420. "in": "path",
  4421. "required": true
  4422. },
  4423. {
  4424. "name": "content",
  4425. "in": "body",
  4426. "schema": {
  4427. "$ref": "#/definitions/EditReactionOption"
  4428. }
  4429. }
  4430. ],
  4431. "responses": {
  4432. "200": {
  4433. "$ref": "#/responses/Reaction"
  4434. },
  4435. "201": {
  4436. "$ref": "#/responses/Reaction"
  4437. },
  4438. "403": {
  4439. "$ref": "#/responses/forbidden"
  4440. }
  4441. }
  4442. },
  4443. "delete": {
  4444. "consumes": [
  4445. "application/json"
  4446. ],
  4447. "produces": [
  4448. "application/json"
  4449. ],
  4450. "tags": [
  4451. "issue"
  4452. ],
  4453. "summary": "Remove a reaction from an issue",
  4454. "operationId": "issueDeleteIssueReaction",
  4455. "parameters": [
  4456. {
  4457. "type": "string",
  4458. "description": "owner of the repo",
  4459. "name": "owner",
  4460. "in": "path",
  4461. "required": true
  4462. },
  4463. {
  4464. "type": "string",
  4465. "description": "name of the repo",
  4466. "name": "repo",
  4467. "in": "path",
  4468. "required": true
  4469. },
  4470. {
  4471. "type": "integer",
  4472. "format": "int64",
  4473. "description": "index of the issue",
  4474. "name": "index",
  4475. "in": "path",
  4476. "required": true
  4477. },
  4478. {
  4479. "name": "content",
  4480. "in": "body",
  4481. "schema": {
  4482. "$ref": "#/definitions/EditReactionOption"
  4483. }
  4484. }
  4485. ],
  4486. "responses": {
  4487. "200": {
  4488. "$ref": "#/responses/empty"
  4489. },
  4490. "403": {
  4491. "$ref": "#/responses/forbidden"
  4492. }
  4493. }
  4494. }
  4495. },
  4496. "/repos/{owner}/{repo}/issues/{index}/stopwatch/delete": {
  4497. "delete": {
  4498. "consumes": [
  4499. "application/json"
  4500. ],
  4501. "produces": [
  4502. "application/json"
  4503. ],
  4504. "tags": [
  4505. "issue"
  4506. ],
  4507. "summary": "Delete an issue's existing stopwatch.",
  4508. "operationId": "issueDeleteStopWatch",
  4509. "parameters": [
  4510. {
  4511. "type": "string",
  4512. "description": "owner of the repo",
  4513. "name": "owner",
  4514. "in": "path",
  4515. "required": true
  4516. },
  4517. {
  4518. "type": "string",
  4519. "description": "name of the repo",
  4520. "name": "repo",
  4521. "in": "path",
  4522. "required": true
  4523. },
  4524. {
  4525. "type": "integer",
  4526. "format": "int64",
  4527. "description": "index of the issue to stop the stopwatch on",
  4528. "name": "index",
  4529. "in": "path",
  4530. "required": true
  4531. }
  4532. ],
  4533. "responses": {
  4534. "204": {
  4535. "$ref": "#/responses/empty"
  4536. },
  4537. "403": {
  4538. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4539. },
  4540. "404": {
  4541. "$ref": "#/responses/notFound"
  4542. },
  4543. "409": {
  4544. "description": "Cannot cancel a non existent stopwatch"
  4545. }
  4546. }
  4547. }
  4548. },
  4549. "/repos/{owner}/{repo}/issues/{index}/stopwatch/start": {
  4550. "post": {
  4551. "consumes": [
  4552. "application/json"
  4553. ],
  4554. "produces": [
  4555. "application/json"
  4556. ],
  4557. "tags": [
  4558. "issue"
  4559. ],
  4560. "summary": "Start stopwatch on an issue.",
  4561. "operationId": "issueStartStopWatch",
  4562. "parameters": [
  4563. {
  4564. "type": "string",
  4565. "description": "owner of the repo",
  4566. "name": "owner",
  4567. "in": "path",
  4568. "required": true
  4569. },
  4570. {
  4571. "type": "string",
  4572. "description": "name of the repo",
  4573. "name": "repo",
  4574. "in": "path",
  4575. "required": true
  4576. },
  4577. {
  4578. "type": "integer",
  4579. "format": "int64",
  4580. "description": "index of the issue to create the stopwatch on",
  4581. "name": "index",
  4582. "in": "path",
  4583. "required": true
  4584. }
  4585. ],
  4586. "responses": {
  4587. "201": {
  4588. "$ref": "#/responses/empty"
  4589. },
  4590. "403": {
  4591. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4592. },
  4593. "404": {
  4594. "$ref": "#/responses/notFound"
  4595. },
  4596. "409": {
  4597. "description": "Cannot start a stopwatch again if it already exists"
  4598. }
  4599. }
  4600. }
  4601. },
  4602. "/repos/{owner}/{repo}/issues/{index}/stopwatch/stop": {
  4603. "post": {
  4604. "consumes": [
  4605. "application/json"
  4606. ],
  4607. "produces": [
  4608. "application/json"
  4609. ],
  4610. "tags": [
  4611. "issue"
  4612. ],
  4613. "summary": "Stop an issue's existing stopwatch.",
  4614. "operationId": "issueStopStopWatch",
  4615. "parameters": [
  4616. {
  4617. "type": "string",
  4618. "description": "owner of the repo",
  4619. "name": "owner",
  4620. "in": "path",
  4621. "required": true
  4622. },
  4623. {
  4624. "type": "string",
  4625. "description": "name of the repo",
  4626. "name": "repo",
  4627. "in": "path",
  4628. "required": true
  4629. },
  4630. {
  4631. "type": "integer",
  4632. "format": "int64",
  4633. "description": "index of the issue to stop the stopwatch on",
  4634. "name": "index",
  4635. "in": "path",
  4636. "required": true
  4637. }
  4638. ],
  4639. "responses": {
  4640. "201": {
  4641. "$ref": "#/responses/empty"
  4642. },
  4643. "403": {
  4644. "description": "Not repo writer, user does not have rights to toggle stopwatch"
  4645. },
  4646. "404": {
  4647. "$ref": "#/responses/notFound"
  4648. },
  4649. "409": {
  4650. "description": "Cannot stop a non existent stopwatch"
  4651. }
  4652. }
  4653. }
  4654. },
  4655. "/repos/{owner}/{repo}/issues/{index}/subscriptions": {
  4656. "get": {
  4657. "consumes": [
  4658. "application/json"
  4659. ],
  4660. "produces": [
  4661. "application/json"
  4662. ],
  4663. "tags": [
  4664. "issue"
  4665. ],
  4666. "summary": "Get users who subscribed on an issue.",
  4667. "operationId": "issueSubscriptions",
  4668. "parameters": [
  4669. {
  4670. "type": "string",
  4671. "description": "owner of the repo",
  4672. "name": "owner",
  4673. "in": "path",
  4674. "required": true
  4675. },
  4676. {
  4677. "type": "string",
  4678. "description": "name of the repo",
  4679. "name": "repo",
  4680. "in": "path",
  4681. "required": true
  4682. },
  4683. {
  4684. "type": "integer",
  4685. "format": "int64",
  4686. "description": "index of the issue",
  4687. "name": "index",
  4688. "in": "path",
  4689. "required": true
  4690. },
  4691. {
  4692. "type": "integer",
  4693. "description": "page number of results to return (1-based)",
  4694. "name": "page",
  4695. "in": "query"
  4696. },
  4697. {
  4698. "type": "integer",
  4699. "description": "page size of results, maximum page size is 50",
  4700. "name": "limit",
  4701. "in": "query"
  4702. }
  4703. ],
  4704. "responses": {
  4705. "200": {
  4706. "$ref": "#/responses/UserList"
  4707. },
  4708. "404": {
  4709. "$ref": "#/responses/notFound"
  4710. }
  4711. }
  4712. }
  4713. },
  4714. "/repos/{owner}/{repo}/issues/{index}/subscriptions/{user}": {
  4715. "put": {
  4716. "consumes": [
  4717. "application/json"
  4718. ],
  4719. "produces": [
  4720. "application/json"
  4721. ],
  4722. "tags": [
  4723. "issue"
  4724. ],
  4725. "summary": "Subscribe user to issue",
  4726. "operationId": "issueAddSubscription",
  4727. "parameters": [
  4728. {
  4729. "type": "string",
  4730. "description": "owner of the repo",
  4731. "name": "owner",
  4732. "in": "path",
  4733. "required": true
  4734. },
  4735. {
  4736. "type": "string",
  4737. "description": "name of the repo",
  4738. "name": "repo",
  4739. "in": "path",
  4740. "required": true
  4741. },
  4742. {
  4743. "type": "integer",
  4744. "format": "int64",
  4745. "description": "index of the issue",
  4746. "name": "index",
  4747. "in": "path",
  4748. "required": true
  4749. },
  4750. {
  4751. "type": "string",
  4752. "description": "user to subscribe",
  4753. "name": "user",
  4754. "in": "path",
  4755. "required": true
  4756. }
  4757. ],
  4758. "responses": {
  4759. "201": {
  4760. "$ref": "#/responses/empty"
  4761. },
  4762. "304": {
  4763. "description": "User can only subscribe itself if he is no admin"
  4764. },
  4765. "404": {
  4766. "$ref": "#/responses/notFound"
  4767. }
  4768. }
  4769. },
  4770. "delete": {
  4771. "consumes": [
  4772. "application/json"
  4773. ],
  4774. "produces": [
  4775. "application/json"
  4776. ],
  4777. "tags": [
  4778. "issue"
  4779. ],
  4780. "summary": "Unsubscribe user from issue",
  4781. "operationId": "issueDeleteSubscription",
  4782. "parameters": [
  4783. {
  4784. "type": "string",
  4785. "description": "owner of the repo",
  4786. "name": "owner",
  4787. "in": "path",
  4788. "required": true
  4789. },
  4790. {
  4791. "type": "string",
  4792. "description": "name of the repo",
  4793. "name": "repo",
  4794. "in": "path",
  4795. "required": true
  4796. },
  4797. {
  4798. "type": "integer",
  4799. "format": "int64",
  4800. "description": "index of the issue",
  4801. "name": "index",
  4802. "in": "path",
  4803. "required": true
  4804. },
  4805. {
  4806. "type": "string",
  4807. "description": "user witch unsubscribe",
  4808. "name": "user",
  4809. "in": "path",
  4810. "required": true
  4811. }
  4812. ],
  4813. "responses": {
  4814. "201": {
  4815. "$ref": "#/responses/empty"
  4816. },
  4817. "304": {
  4818. "description": "User can only subscribe itself if he is no admin"
  4819. },
  4820. "404": {
  4821. "$ref": "#/responses/notFound"
  4822. }
  4823. }
  4824. }
  4825. },
  4826. "/repos/{owner}/{repo}/issues/{index}/times": {
  4827. "get": {
  4828. "produces": [
  4829. "application/json"
  4830. ],
  4831. "tags": [
  4832. "issue"
  4833. ],
  4834. "summary": "List an issue's tracked times",
  4835. "operationId": "issueTrackedTimes",
  4836. "parameters": [
  4837. {
  4838. "type": "string",
  4839. "description": "owner of the repo",
  4840. "name": "owner",
  4841. "in": "path",
  4842. "required": true
  4843. },
  4844. {
  4845. "type": "string",
  4846. "description": "name of the repo",
  4847. "name": "repo",
  4848. "in": "path",
  4849. "required": true
  4850. },
  4851. {
  4852. "type": "integer",
  4853. "format": "int64",
  4854. "description": "index of the issue",
  4855. "name": "index",
  4856. "in": "path",
  4857. "required": true
  4858. },
  4859. {
  4860. "type": "string",
  4861. "format": "date-time",
  4862. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  4863. "name": "since",
  4864. "in": "query"
  4865. },
  4866. {
  4867. "type": "string",
  4868. "format": "date-time",
  4869. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  4870. "name": "before",
  4871. "in": "query"
  4872. },
  4873. {
  4874. "type": "integer",
  4875. "description": "page number of results to return (1-based)",
  4876. "name": "page",
  4877. "in": "query"
  4878. },
  4879. {
  4880. "type": "integer",
  4881. "description": "page size of results, maximum page size is 50",
  4882. "name": "limit",
  4883. "in": "query"
  4884. }
  4885. ],
  4886. "responses": {
  4887. "200": {
  4888. "$ref": "#/responses/TrackedTimeList"
  4889. },
  4890. "404": {
  4891. "$ref": "#/responses/notFound"
  4892. }
  4893. }
  4894. },
  4895. "post": {
  4896. "consumes": [
  4897. "application/json"
  4898. ],
  4899. "produces": [
  4900. "application/json"
  4901. ],
  4902. "tags": [
  4903. "issue"
  4904. ],
  4905. "summary": "Add tracked time to a issue",
  4906. "operationId": "issueAddTime",
  4907. "parameters": [
  4908. {
  4909. "type": "string",
  4910. "description": "owner of the repo",
  4911. "name": "owner",
  4912. "in": "path",
  4913. "required": true
  4914. },
  4915. {
  4916. "type": "string",
  4917. "description": "name of the repo",
  4918. "name": "repo",
  4919. "in": "path",
  4920. "required": true
  4921. },
  4922. {
  4923. "type": "integer",
  4924. "format": "int64",
  4925. "description": "index of the issue",
  4926. "name": "index",
  4927. "in": "path",
  4928. "required": true
  4929. },
  4930. {
  4931. "name": "body",
  4932. "in": "body",
  4933. "schema": {
  4934. "$ref": "#/definitions/AddTimeOption"
  4935. }
  4936. }
  4937. ],
  4938. "responses": {
  4939. "200": {
  4940. "$ref": "#/responses/TrackedTime"
  4941. },
  4942. "400": {
  4943. "$ref": "#/responses/error"
  4944. },
  4945. "403": {
  4946. "$ref": "#/responses/forbidden"
  4947. }
  4948. }
  4949. },
  4950. "delete": {
  4951. "consumes": [
  4952. "application/json"
  4953. ],
  4954. "produces": [
  4955. "application/json"
  4956. ],
  4957. "tags": [
  4958. "issue"
  4959. ],
  4960. "summary": "Reset a tracked time of an issue",
  4961. "operationId": "issueResetTime",
  4962. "parameters": [
  4963. {
  4964. "type": "string",
  4965. "description": "owner of the repo",
  4966. "name": "owner",
  4967. "in": "path",
  4968. "required": true
  4969. },
  4970. {
  4971. "type": "string",
  4972. "description": "name of the repo",
  4973. "name": "repo",
  4974. "in": "path",
  4975. "required": true
  4976. },
  4977. {
  4978. "type": "integer",
  4979. "format": "int64",
  4980. "description": "index of the issue to add tracked time to",
  4981. "name": "index",
  4982. "in": "path",
  4983. "required": true
  4984. }
  4985. ],
  4986. "responses": {
  4987. "204": {
  4988. "$ref": "#/responses/empty"
  4989. },
  4990. "400": {
  4991. "$ref": "#/responses/error"
  4992. },
  4993. "403": {
  4994. "$ref": "#/responses/forbidden"
  4995. }
  4996. }
  4997. }
  4998. },
  4999. "/repos/{owner}/{repo}/issues/{index}/times/{id}": {
  5000. "delete": {
  5001. "consumes": [
  5002. "application/json"
  5003. ],
  5004. "produces": [
  5005. "application/json"
  5006. ],
  5007. "tags": [
  5008. "issue"
  5009. ],
  5010. "summary": "Delete specific tracked time",
  5011. "operationId": "issueDeleteTime",
  5012. "parameters": [
  5013. {
  5014. "type": "string",
  5015. "description": "owner of the repo",
  5016. "name": "owner",
  5017. "in": "path",
  5018. "required": true
  5019. },
  5020. {
  5021. "type": "string",
  5022. "description": "name of the repo",
  5023. "name": "repo",
  5024. "in": "path",
  5025. "required": true
  5026. },
  5027. {
  5028. "type": "integer",
  5029. "format": "int64",
  5030. "description": "index of the issue",
  5031. "name": "index",
  5032. "in": "path",
  5033. "required": true
  5034. },
  5035. {
  5036. "type": "integer",
  5037. "format": "int64",
  5038. "description": "id of time to delete",
  5039. "name": "id",
  5040. "in": "path",
  5041. "required": true
  5042. }
  5043. ],
  5044. "responses": {
  5045. "204": {
  5046. "$ref": "#/responses/empty"
  5047. },
  5048. "400": {
  5049. "$ref": "#/responses/error"
  5050. },
  5051. "403": {
  5052. "$ref": "#/responses/forbidden"
  5053. }
  5054. }
  5055. }
  5056. },
  5057. "/repos/{owner}/{repo}/keys": {
  5058. "get": {
  5059. "produces": [
  5060. "application/json"
  5061. ],
  5062. "tags": [
  5063. "repository"
  5064. ],
  5065. "summary": "List a repository's keys",
  5066. "operationId": "repoListKeys",
  5067. "parameters": [
  5068. {
  5069. "type": "string",
  5070. "description": "owner of the repo",
  5071. "name": "owner",
  5072. "in": "path",
  5073. "required": true
  5074. },
  5075. {
  5076. "type": "string",
  5077. "description": "name of the repo",
  5078. "name": "repo",
  5079. "in": "path",
  5080. "required": true
  5081. },
  5082. {
  5083. "type": "integer",
  5084. "description": "the key_id to search for",
  5085. "name": "key_id",
  5086. "in": "query"
  5087. },
  5088. {
  5089. "type": "string",
  5090. "description": "fingerprint of the key",
  5091. "name": "fingerprint",
  5092. "in": "query"
  5093. },
  5094. {
  5095. "type": "integer",
  5096. "description": "page number of results to return (1-based)",
  5097. "name": "page",
  5098. "in": "query"
  5099. },
  5100. {
  5101. "type": "integer",
  5102. "description": "page size of results, maximum page size is 50",
  5103. "name": "limit",
  5104. "in": "query"
  5105. }
  5106. ],
  5107. "responses": {
  5108. "200": {
  5109. "$ref": "#/responses/DeployKeyList"
  5110. }
  5111. }
  5112. },
  5113. "post": {
  5114. "consumes": [
  5115. "application/json"
  5116. ],
  5117. "produces": [
  5118. "application/json"
  5119. ],
  5120. "tags": [
  5121. "repository"
  5122. ],
  5123. "summary": "Add a key to a repository",
  5124. "operationId": "repoCreateKey",
  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. "name": "body",
  5142. "in": "body",
  5143. "schema": {
  5144. "$ref": "#/definitions/CreateKeyOption"
  5145. }
  5146. }
  5147. ],
  5148. "responses": {
  5149. "201": {
  5150. "$ref": "#/responses/DeployKey"
  5151. },
  5152. "422": {
  5153. "$ref": "#/responses/validationError"
  5154. }
  5155. }
  5156. }
  5157. },
  5158. "/repos/{owner}/{repo}/keys/{id}": {
  5159. "get": {
  5160. "produces": [
  5161. "application/json"
  5162. ],
  5163. "tags": [
  5164. "repository"
  5165. ],
  5166. "summary": "Get a repository's key by id",
  5167. "operationId": "repoGetKey",
  5168. "parameters": [
  5169. {
  5170. "type": "string",
  5171. "description": "owner of the repo",
  5172. "name": "owner",
  5173. "in": "path",
  5174. "required": true
  5175. },
  5176. {
  5177. "type": "string",
  5178. "description": "name of the repo",
  5179. "name": "repo",
  5180. "in": "path",
  5181. "required": true
  5182. },
  5183. {
  5184. "type": "integer",
  5185. "format": "int64",
  5186. "description": "id of the key to get",
  5187. "name": "id",
  5188. "in": "path",
  5189. "required": true
  5190. }
  5191. ],
  5192. "responses": {
  5193. "200": {
  5194. "$ref": "#/responses/DeployKey"
  5195. }
  5196. }
  5197. },
  5198. "delete": {
  5199. "tags": [
  5200. "repository"
  5201. ],
  5202. "summary": "Delete a key from a repository",
  5203. "operationId": "repoDeleteKey",
  5204. "parameters": [
  5205. {
  5206. "type": "string",
  5207. "description": "owner of the repo",
  5208. "name": "owner",
  5209. "in": "path",
  5210. "required": true
  5211. },
  5212. {
  5213. "type": "string",
  5214. "description": "name of the repo",
  5215. "name": "repo",
  5216. "in": "path",
  5217. "required": true
  5218. },
  5219. {
  5220. "type": "integer",
  5221. "format": "int64",
  5222. "description": "id of the key to delete",
  5223. "name": "id",
  5224. "in": "path",
  5225. "required": true
  5226. }
  5227. ],
  5228. "responses": {
  5229. "204": {
  5230. "$ref": "#/responses/empty"
  5231. },
  5232. "403": {
  5233. "$ref": "#/responses/forbidden"
  5234. }
  5235. }
  5236. }
  5237. },
  5238. "/repos/{owner}/{repo}/labels": {
  5239. "get": {
  5240. "produces": [
  5241. "application/json"
  5242. ],
  5243. "tags": [
  5244. "issue"
  5245. ],
  5246. "summary": "Get all of a repository's labels",
  5247. "operationId": "issueListLabels",
  5248. "parameters": [
  5249. {
  5250. "type": "string",
  5251. "description": "owner of the repo",
  5252. "name": "owner",
  5253. "in": "path",
  5254. "required": true
  5255. },
  5256. {
  5257. "type": "string",
  5258. "description": "name of the repo",
  5259. "name": "repo",
  5260. "in": "path",
  5261. "required": true
  5262. },
  5263. {
  5264. "type": "integer",
  5265. "description": "page number of results to return (1-based)",
  5266. "name": "page",
  5267. "in": "query"
  5268. },
  5269. {
  5270. "type": "integer",
  5271. "description": "page size of results, maximum page size is 50",
  5272. "name": "limit",
  5273. "in": "query"
  5274. }
  5275. ],
  5276. "responses": {
  5277. "200": {
  5278. "$ref": "#/responses/LabelList"
  5279. }
  5280. }
  5281. },
  5282. "post": {
  5283. "consumes": [
  5284. "application/json"
  5285. ],
  5286. "produces": [
  5287. "application/json"
  5288. ],
  5289. "tags": [
  5290. "issue"
  5291. ],
  5292. "summary": "Create a label",
  5293. "operationId": "issueCreateLabel",
  5294. "parameters": [
  5295. {
  5296. "type": "string",
  5297. "description": "owner of the repo",
  5298. "name": "owner",
  5299. "in": "path",
  5300. "required": true
  5301. },
  5302. {
  5303. "type": "string",
  5304. "description": "name of the repo",
  5305. "name": "repo",
  5306. "in": "path",
  5307. "required": true
  5308. },
  5309. {
  5310. "name": "body",
  5311. "in": "body",
  5312. "schema": {
  5313. "$ref": "#/definitions/CreateLabelOption"
  5314. }
  5315. }
  5316. ],
  5317. "responses": {
  5318. "201": {
  5319. "$ref": "#/responses/Label"
  5320. },
  5321. "422": {
  5322. "$ref": "#/responses/validationError"
  5323. }
  5324. }
  5325. }
  5326. },
  5327. "/repos/{owner}/{repo}/labels/{id}": {
  5328. "get": {
  5329. "produces": [
  5330. "application/json"
  5331. ],
  5332. "tags": [
  5333. "issue"
  5334. ],
  5335. "summary": "Get a single label",
  5336. "operationId": "issueGetLabel",
  5337. "parameters": [
  5338. {
  5339. "type": "string",
  5340. "description": "owner of the repo",
  5341. "name": "owner",
  5342. "in": "path",
  5343. "required": true
  5344. },
  5345. {
  5346. "type": "string",
  5347. "description": "name of the repo",
  5348. "name": "repo",
  5349. "in": "path",
  5350. "required": true
  5351. },
  5352. {
  5353. "type": "integer",
  5354. "format": "int64",
  5355. "description": "id of the label to get",
  5356. "name": "id",
  5357. "in": "path",
  5358. "required": true
  5359. }
  5360. ],
  5361. "responses": {
  5362. "200": {
  5363. "$ref": "#/responses/Label"
  5364. }
  5365. }
  5366. },
  5367. "delete": {
  5368. "tags": [
  5369. "issue"
  5370. ],
  5371. "summary": "Delete a label",
  5372. "operationId": "issueDeleteLabel",
  5373. "parameters": [
  5374. {
  5375. "type": "string",
  5376. "description": "owner of the repo",
  5377. "name": "owner",
  5378. "in": "path",
  5379. "required": true
  5380. },
  5381. {
  5382. "type": "string",
  5383. "description": "name of the repo",
  5384. "name": "repo",
  5385. "in": "path",
  5386. "required": true
  5387. },
  5388. {
  5389. "type": "integer",
  5390. "format": "int64",
  5391. "description": "id of the label to delete",
  5392. "name": "id",
  5393. "in": "path",
  5394. "required": true
  5395. }
  5396. ],
  5397. "responses": {
  5398. "204": {
  5399. "$ref": "#/responses/empty"
  5400. }
  5401. }
  5402. },
  5403. "patch": {
  5404. "consumes": [
  5405. "application/json"
  5406. ],
  5407. "produces": [
  5408. "application/json"
  5409. ],
  5410. "tags": [
  5411. "issue"
  5412. ],
  5413. "summary": "Update a label",
  5414. "operationId": "issueEditLabel",
  5415. "parameters": [
  5416. {
  5417. "type": "string",
  5418. "description": "owner of the repo",
  5419. "name": "owner",
  5420. "in": "path",
  5421. "required": true
  5422. },
  5423. {
  5424. "type": "string",
  5425. "description": "name of the repo",
  5426. "name": "repo",
  5427. "in": "path",
  5428. "required": true
  5429. },
  5430. {
  5431. "type": "integer",
  5432. "format": "int64",
  5433. "description": "id of the label to edit",
  5434. "name": "id",
  5435. "in": "path",
  5436. "required": true
  5437. },
  5438. {
  5439. "name": "body",
  5440. "in": "body",
  5441. "schema": {
  5442. "$ref": "#/definitions/EditLabelOption"
  5443. }
  5444. }
  5445. ],
  5446. "responses": {
  5447. "200": {
  5448. "$ref": "#/responses/Label"
  5449. },
  5450. "422": {
  5451. "$ref": "#/responses/validationError"
  5452. }
  5453. }
  5454. }
  5455. },
  5456. "/repos/{owner}/{repo}/milestones": {
  5457. "get": {
  5458. "produces": [
  5459. "application/json"
  5460. ],
  5461. "tags": [
  5462. "issue"
  5463. ],
  5464. "summary": "Get all of a repository's opened milestones",
  5465. "operationId": "issueGetMilestonesList",
  5466. "parameters": [
  5467. {
  5468. "type": "string",
  5469. "description": "owner of the repo",
  5470. "name": "owner",
  5471. "in": "path",
  5472. "required": true
  5473. },
  5474. {
  5475. "type": "string",
  5476. "description": "name of the repo",
  5477. "name": "repo",
  5478. "in": "path",
  5479. "required": true
  5480. },
  5481. {
  5482. "type": "string",
  5483. "description": "Milestone state, Recognised values are open, closed and all. Defaults to \"open\"",
  5484. "name": "state",
  5485. "in": "query"
  5486. },
  5487. {
  5488. "type": "integer",
  5489. "description": "page number of results to return (1-based)",
  5490. "name": "page",
  5491. "in": "query"
  5492. },
  5493. {
  5494. "type": "integer",
  5495. "description": "page size of results, maximum page size is 50",
  5496. "name": "limit",
  5497. "in": "query"
  5498. }
  5499. ],
  5500. "responses": {
  5501. "200": {
  5502. "$ref": "#/responses/MilestoneList"
  5503. }
  5504. }
  5505. },
  5506. "post": {
  5507. "consumes": [
  5508. "application/json"
  5509. ],
  5510. "produces": [
  5511. "application/json"
  5512. ],
  5513. "tags": [
  5514. "issue"
  5515. ],
  5516. "summary": "Create a milestone",
  5517. "operationId": "issueCreateMilestone",
  5518. "parameters": [
  5519. {
  5520. "type": "string",
  5521. "description": "owner of the repo",
  5522. "name": "owner",
  5523. "in": "path",
  5524. "required": true
  5525. },
  5526. {
  5527. "type": "string",
  5528. "description": "name of the repo",
  5529. "name": "repo",
  5530. "in": "path",
  5531. "required": true
  5532. },
  5533. {
  5534. "name": "body",
  5535. "in": "body",
  5536. "schema": {
  5537. "$ref": "#/definitions/CreateMilestoneOption"
  5538. }
  5539. }
  5540. ],
  5541. "responses": {
  5542. "201": {
  5543. "$ref": "#/responses/Milestone"
  5544. }
  5545. }
  5546. }
  5547. },
  5548. "/repos/{owner}/{repo}/milestones/{id}": {
  5549. "get": {
  5550. "produces": [
  5551. "application/json"
  5552. ],
  5553. "tags": [
  5554. "issue"
  5555. ],
  5556. "summary": "Get a milestone",
  5557. "operationId": "issueGetMilestone",
  5558. "parameters": [
  5559. {
  5560. "type": "string",
  5561. "description": "owner of the repo",
  5562. "name": "owner",
  5563. "in": "path",
  5564. "required": true
  5565. },
  5566. {
  5567. "type": "string",
  5568. "description": "name of the repo",
  5569. "name": "repo",
  5570. "in": "path",
  5571. "required": true
  5572. },
  5573. {
  5574. "type": "integer",
  5575. "format": "int64",
  5576. "description": "id of the milestone",
  5577. "name": "id",
  5578. "in": "path",
  5579. "required": true
  5580. }
  5581. ],
  5582. "responses": {
  5583. "200": {
  5584. "$ref": "#/responses/Milestone"
  5585. }
  5586. }
  5587. },
  5588. "delete": {
  5589. "tags": [
  5590. "issue"
  5591. ],
  5592. "summary": "Delete a milestone",
  5593. "operationId": "issueDeleteMilestone",
  5594. "parameters": [
  5595. {
  5596. "type": "string",
  5597. "description": "owner of the repo",
  5598. "name": "owner",
  5599. "in": "path",
  5600. "required": true
  5601. },
  5602. {
  5603. "type": "string",
  5604. "description": "name of the repo",
  5605. "name": "repo",
  5606. "in": "path",
  5607. "required": true
  5608. },
  5609. {
  5610. "type": "integer",
  5611. "format": "int64",
  5612. "description": "id of the milestone to delete",
  5613. "name": "id",
  5614. "in": "path",
  5615. "required": true
  5616. }
  5617. ],
  5618. "responses": {
  5619. "204": {
  5620. "$ref": "#/responses/empty"
  5621. }
  5622. }
  5623. },
  5624. "patch": {
  5625. "consumes": [
  5626. "application/json"
  5627. ],
  5628. "produces": [
  5629. "application/json"
  5630. ],
  5631. "tags": [
  5632. "issue"
  5633. ],
  5634. "summary": "Update a milestone",
  5635. "operationId": "issueEditMilestone",
  5636. "parameters": [
  5637. {
  5638. "type": "string",
  5639. "description": "owner of the repo",
  5640. "name": "owner",
  5641. "in": "path",
  5642. "required": true
  5643. },
  5644. {
  5645. "type": "string",
  5646. "description": "name of the repo",
  5647. "name": "repo",
  5648. "in": "path",
  5649. "required": true
  5650. },
  5651. {
  5652. "type": "integer",
  5653. "format": "int64",
  5654. "description": "id of the milestone",
  5655. "name": "id",
  5656. "in": "path",
  5657. "required": true
  5658. },
  5659. {
  5660. "name": "body",
  5661. "in": "body",
  5662. "schema": {
  5663. "$ref": "#/definitions/EditMilestoneOption"
  5664. }
  5665. }
  5666. ],
  5667. "responses": {
  5668. "200": {
  5669. "$ref": "#/responses/Milestone"
  5670. }
  5671. }
  5672. }
  5673. },
  5674. "/repos/{owner}/{repo}/mirror-sync": {
  5675. "post": {
  5676. "produces": [
  5677. "application/json"
  5678. ],
  5679. "tags": [
  5680. "repository"
  5681. ],
  5682. "summary": "Sync a mirrored repository",
  5683. "operationId": "repoMirrorSync",
  5684. "parameters": [
  5685. {
  5686. "type": "string",
  5687. "description": "owner of the repo to sync",
  5688. "name": "owner",
  5689. "in": "path",
  5690. "required": true
  5691. },
  5692. {
  5693. "type": "string",
  5694. "description": "name of the repo to sync",
  5695. "name": "repo",
  5696. "in": "path",
  5697. "required": true
  5698. }
  5699. ],
  5700. "responses": {
  5701. "200": {
  5702. "$ref": "#/responses/empty"
  5703. },
  5704. "403": {
  5705. "$ref": "#/responses/forbidden"
  5706. }
  5707. }
  5708. }
  5709. },
  5710. "/repos/{owner}/{repo}/notifications": {
  5711. "get": {
  5712. "consumes": [
  5713. "application/json"
  5714. ],
  5715. "produces": [
  5716. "application/json"
  5717. ],
  5718. "tags": [
  5719. "notification"
  5720. ],
  5721. "summary": "List users's notification threads on a specific repo",
  5722. "operationId": "notifyGetRepoList",
  5723. "parameters": [
  5724. {
  5725. "type": "string",
  5726. "description": "owner of the repo",
  5727. "name": "owner",
  5728. "in": "path",
  5729. "required": true
  5730. },
  5731. {
  5732. "type": "string",
  5733. "description": "name of the repo",
  5734. "name": "repo",
  5735. "in": "path",
  5736. "required": true
  5737. },
  5738. {
  5739. "type": "string",
  5740. "description": "If true, show notifications marked as read. Default value is false",
  5741. "name": "all",
  5742. "in": "query"
  5743. },
  5744. {
  5745. "type": "string",
  5746. "format": "date-time",
  5747. "description": "Only show notifications updated after the given time. This is a timestamp in RFC 3339 format",
  5748. "name": "since",
  5749. "in": "query"
  5750. },
  5751. {
  5752. "type": "string",
  5753. "format": "date-time",
  5754. "description": "Only show notifications updated before the given time. This is a timestamp in RFC 3339 format",
  5755. "name": "before",
  5756. "in": "query"
  5757. },
  5758. {
  5759. "type": "integer",
  5760. "description": "page number of results to return (1-based)",
  5761. "name": "page",
  5762. "in": "query"
  5763. },
  5764. {
  5765. "type": "integer",
  5766. "description": "page size of results, maximum page size is 50",
  5767. "name": "limit",
  5768. "in": "query"
  5769. }
  5770. ],
  5771. "responses": {
  5772. "200": {
  5773. "$ref": "#/responses/NotificationThreadList"
  5774. }
  5775. }
  5776. },
  5777. "put": {
  5778. "consumes": [
  5779. "application/json"
  5780. ],
  5781. "produces": [
  5782. "application/json"
  5783. ],
  5784. "tags": [
  5785. "notification"
  5786. ],
  5787. "summary": "Mark notification threads as read on a specific repo",
  5788. "operationId": "notifyReadRepoList",
  5789. "parameters": [
  5790. {
  5791. "type": "string",
  5792. "description": "owner of the repo",
  5793. "name": "owner",
  5794. "in": "path",
  5795. "required": true
  5796. },
  5797. {
  5798. "type": "string",
  5799. "description": "name of the repo",
  5800. "name": "repo",
  5801. "in": "path",
  5802. "required": true
  5803. },
  5804. {
  5805. "type": "string",
  5806. "format": "date-time",
  5807. "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated.",
  5808. "name": "last_read_at",
  5809. "in": "query"
  5810. }
  5811. ],
  5812. "responses": {
  5813. "205": {
  5814. "$ref": "#/responses/empty"
  5815. }
  5816. }
  5817. }
  5818. },
  5819. "/repos/{owner}/{repo}/pulls": {
  5820. "get": {
  5821. "produces": [
  5822. "application/json"
  5823. ],
  5824. "tags": [
  5825. "repository"
  5826. ],
  5827. "summary": "List a repo's pull requests",
  5828. "operationId": "repoListPullRequests",
  5829. "parameters": [
  5830. {
  5831. "type": "string",
  5832. "description": "owner of the repo",
  5833. "name": "owner",
  5834. "in": "path",
  5835. "required": true
  5836. },
  5837. {
  5838. "type": "string",
  5839. "description": "name of the repo",
  5840. "name": "repo",
  5841. "in": "path",
  5842. "required": true
  5843. },
  5844. {
  5845. "enum": [
  5846. "closed",
  5847. "open",
  5848. "all"
  5849. ],
  5850. "type": "string",
  5851. "description": "State of pull request: open or closed (optional)",
  5852. "name": "state",
  5853. "in": "query"
  5854. },
  5855. {
  5856. "enum": [
  5857. "oldest",
  5858. "recentupdate",
  5859. "leastupdate",
  5860. "mostcomment",
  5861. "leastcomment",
  5862. "priority"
  5863. ],
  5864. "type": "string",
  5865. "description": "Type of sort",
  5866. "name": "sort",
  5867. "in": "query"
  5868. },
  5869. {
  5870. "type": "integer",
  5871. "format": "int64",
  5872. "description": "ID of the milestone",
  5873. "name": "milestone",
  5874. "in": "query"
  5875. },
  5876. {
  5877. "type": "array",
  5878. "items": {
  5879. "type": "integer",
  5880. "format": "int64"
  5881. },
  5882. "collectionFormat": "multi",
  5883. "description": "Label IDs",
  5884. "name": "labels",
  5885. "in": "query"
  5886. },
  5887. {
  5888. "type": "integer",
  5889. "description": "page number of results to return (1-based)",
  5890. "name": "page",
  5891. "in": "query"
  5892. },
  5893. {
  5894. "type": "integer",
  5895. "description": "page size of results, maximum page size is 50",
  5896. "name": "limit",
  5897. "in": "query"
  5898. }
  5899. ],
  5900. "responses": {
  5901. "200": {
  5902. "$ref": "#/responses/PullRequestList"
  5903. }
  5904. }
  5905. },
  5906. "post": {
  5907. "consumes": [
  5908. "application/json"
  5909. ],
  5910. "produces": [
  5911. "application/json"
  5912. ],
  5913. "tags": [
  5914. "repository"
  5915. ],
  5916. "summary": "Create a pull request",
  5917. "operationId": "repoCreatePullRequest",
  5918. "parameters": [
  5919. {
  5920. "type": "string",
  5921. "description": "owner of the repo",
  5922. "name": "owner",
  5923. "in": "path",
  5924. "required": true
  5925. },
  5926. {
  5927. "type": "string",
  5928. "description": "name of the repo",
  5929. "name": "repo",
  5930. "in": "path",
  5931. "required": true
  5932. },
  5933. {
  5934. "name": "body",
  5935. "in": "body",
  5936. "schema": {
  5937. "$ref": "#/definitions/CreatePullRequestOption"
  5938. }
  5939. }
  5940. ],
  5941. "responses": {
  5942. "201": {
  5943. "$ref": "#/responses/PullRequest"
  5944. },
  5945. "409": {
  5946. "$ref": "#/responses/error"
  5947. },
  5948. "422": {
  5949. "$ref": "#/responses/validationError"
  5950. }
  5951. }
  5952. }
  5953. },
  5954. "/repos/{owner}/{repo}/pulls/{index}": {
  5955. "get": {
  5956. "produces": [
  5957. "application/json"
  5958. ],
  5959. "tags": [
  5960. "repository"
  5961. ],
  5962. "summary": "Get a pull request",
  5963. "operationId": "repoGetPullRequest",
  5964. "parameters": [
  5965. {
  5966. "type": "string",
  5967. "description": "owner of the repo",
  5968. "name": "owner",
  5969. "in": "path",
  5970. "required": true
  5971. },
  5972. {
  5973. "type": "string",
  5974. "description": "name of the repo",
  5975. "name": "repo",
  5976. "in": "path",
  5977. "required": true
  5978. },
  5979. {
  5980. "type": "integer",
  5981. "format": "int64",
  5982. "description": "index of the pull request to get",
  5983. "name": "index",
  5984. "in": "path",
  5985. "required": true
  5986. }
  5987. ],
  5988. "responses": {
  5989. "200": {
  5990. "$ref": "#/responses/PullRequest"
  5991. },
  5992. "404": {
  5993. "$ref": "#/responses/notFound"
  5994. }
  5995. }
  5996. },
  5997. "patch": {
  5998. "consumes": [
  5999. "application/json"
  6000. ],
  6001. "produces": [
  6002. "application/json"
  6003. ],
  6004. "tags": [
  6005. "repository"
  6006. ],
  6007. "summary": "Update a pull request. If using deadline only the date will be taken into account, and time of day ignored.",
  6008. "operationId": "repoEditPullRequest",
  6009. "parameters": [
  6010. {
  6011. "type": "string",
  6012. "description": "owner of the repo",
  6013. "name": "owner",
  6014. "in": "path",
  6015. "required": true
  6016. },
  6017. {
  6018. "type": "string",
  6019. "description": "name of the repo",
  6020. "name": "repo",
  6021. "in": "path",
  6022. "required": true
  6023. },
  6024. {
  6025. "type": "integer",
  6026. "format": "int64",
  6027. "description": "index of the pull request to edit",
  6028. "name": "index",
  6029. "in": "path",
  6030. "required": true
  6031. },
  6032. {
  6033. "name": "body",
  6034. "in": "body",
  6035. "schema": {
  6036. "$ref": "#/definitions/EditPullRequestOption"
  6037. }
  6038. }
  6039. ],
  6040. "responses": {
  6041. "201": {
  6042. "$ref": "#/responses/PullRequest"
  6043. },
  6044. "403": {
  6045. "$ref": "#/responses/forbidden"
  6046. },
  6047. "412": {
  6048. "$ref": "#/responses/error"
  6049. },
  6050. "422": {
  6051. "$ref": "#/responses/validationError"
  6052. }
  6053. }
  6054. }
  6055. },
  6056. "/repos/{owner}/{repo}/pulls/{index}/merge": {
  6057. "get": {
  6058. "produces": [
  6059. "application/json"
  6060. ],
  6061. "tags": [
  6062. "repository"
  6063. ],
  6064. "summary": "Check if a pull request has been merged",
  6065. "operationId": "repoPullRequestIsMerged",
  6066. "parameters": [
  6067. {
  6068. "type": "string",
  6069. "description": "owner of the repo",
  6070. "name": "owner",
  6071. "in": "path",
  6072. "required": true
  6073. },
  6074. {
  6075. "type": "string",
  6076. "description": "name of the repo",
  6077. "name": "repo",
  6078. "in": "path",
  6079. "required": true
  6080. },
  6081. {
  6082. "type": "integer",
  6083. "format": "int64",
  6084. "description": "index of the pull request",
  6085. "name": "index",
  6086. "in": "path",
  6087. "required": true
  6088. }
  6089. ],
  6090. "responses": {
  6091. "204": {
  6092. "description": "pull request has been merged"
  6093. },
  6094. "404": {
  6095. "description": "pull request has not been merged"
  6096. }
  6097. }
  6098. },
  6099. "post": {
  6100. "produces": [
  6101. "application/json"
  6102. ],
  6103. "tags": [
  6104. "repository"
  6105. ],
  6106. "summary": "Merge a pull request",
  6107. "operationId": "repoMergePullRequest",
  6108. "parameters": [
  6109. {
  6110. "type": "string",
  6111. "description": "owner of the repo",
  6112. "name": "owner",
  6113. "in": "path",
  6114. "required": true
  6115. },
  6116. {
  6117. "type": "string",
  6118. "description": "name of the repo",
  6119. "name": "repo",
  6120. "in": "path",
  6121. "required": true
  6122. },
  6123. {
  6124. "type": "integer",
  6125. "format": "int64",
  6126. "description": "index of the pull request to merge",
  6127. "name": "index",
  6128. "in": "path",
  6129. "required": true
  6130. },
  6131. {
  6132. "name": "body",
  6133. "in": "body",
  6134. "schema": {
  6135. "$ref": "#/definitions/MergePullRequestOption"
  6136. }
  6137. }
  6138. ],
  6139. "responses": {
  6140. "200": {
  6141. "$ref": "#/responses/empty"
  6142. },
  6143. "405": {
  6144. "$ref": "#/responses/empty"
  6145. },
  6146. "409": {
  6147. "$ref": "#/responses/error"
  6148. }
  6149. }
  6150. }
  6151. },
  6152. "/repos/{owner}/{repo}/raw/{filepath}": {
  6153. "get": {
  6154. "produces": [
  6155. "application/json"
  6156. ],
  6157. "tags": [
  6158. "repository"
  6159. ],
  6160. "summary": "Get a file from a repository",
  6161. "operationId": "repoGetRawFile",
  6162. "parameters": [
  6163. {
  6164. "type": "string",
  6165. "description": "owner of the repo",
  6166. "name": "owner",
  6167. "in": "path",
  6168. "required": true
  6169. },
  6170. {
  6171. "type": "string",
  6172. "description": "name of the repo",
  6173. "name": "repo",
  6174. "in": "path",
  6175. "required": true
  6176. },
  6177. {
  6178. "type": "string",
  6179. "description": "filepath of the file to get",
  6180. "name": "filepath",
  6181. "in": "path",
  6182. "required": true
  6183. }
  6184. ],
  6185. "responses": {
  6186. "200": {
  6187. "description": "success"
  6188. },
  6189. "404": {
  6190. "$ref": "#/responses/notFound"
  6191. }
  6192. }
  6193. }
  6194. },
  6195. "/repos/{owner}/{repo}/releases": {
  6196. "get": {
  6197. "produces": [
  6198. "application/json"
  6199. ],
  6200. "tags": [
  6201. "repository"
  6202. ],
  6203. "summary": "List a repo's releases",
  6204. "operationId": "repoListReleases",
  6205. "parameters": [
  6206. {
  6207. "type": "string",
  6208. "description": "owner of the repo",
  6209. "name": "owner",
  6210. "in": "path",
  6211. "required": true
  6212. },
  6213. {
  6214. "type": "string",
  6215. "description": "name of the repo",
  6216. "name": "repo",
  6217. "in": "path",
  6218. "required": true
  6219. },
  6220. {
  6221. "type": "integer",
  6222. "description": "items count every page wants to load",
  6223. "name": "per_page",
  6224. "in": "query"
  6225. },
  6226. {
  6227. "type": "integer",
  6228. "description": "page number of results to return (1-based)",
  6229. "name": "page",
  6230. "in": "query"
  6231. },
  6232. {
  6233. "type": "integer",
  6234. "description": "page size of results, maximum page size is 50",
  6235. "name": "limit",
  6236. "in": "query"
  6237. }
  6238. ],
  6239. "responses": {
  6240. "200": {
  6241. "$ref": "#/responses/ReleaseList"
  6242. }
  6243. }
  6244. },
  6245. "post": {
  6246. "consumes": [
  6247. "application/json"
  6248. ],
  6249. "produces": [
  6250. "application/json"
  6251. ],
  6252. "tags": [
  6253. "repository"
  6254. ],
  6255. "summary": "Create a release",
  6256. "operationId": "repoCreateRelease",
  6257. "parameters": [
  6258. {
  6259. "type": "string",
  6260. "description": "owner of the repo",
  6261. "name": "owner",
  6262. "in": "path",
  6263. "required": true
  6264. },
  6265. {
  6266. "type": "string",
  6267. "description": "name of the repo",
  6268. "name": "repo",
  6269. "in": "path",
  6270. "required": true
  6271. },
  6272. {
  6273. "name": "body",
  6274. "in": "body",
  6275. "schema": {
  6276. "$ref": "#/definitions/CreateReleaseOption"
  6277. }
  6278. }
  6279. ],
  6280. "responses": {
  6281. "201": {
  6282. "$ref": "#/responses/Release"
  6283. },
  6284. "409": {
  6285. "$ref": "#/responses/error"
  6286. }
  6287. }
  6288. }
  6289. },
  6290. "/repos/{owner}/{repo}/releases/{id}": {
  6291. "get": {
  6292. "produces": [
  6293. "application/json"
  6294. ],
  6295. "tags": [
  6296. "repository"
  6297. ],
  6298. "summary": "Get a release",
  6299. "operationId": "repoGetRelease",
  6300. "parameters": [
  6301. {
  6302. "type": "string",
  6303. "description": "owner of the repo",
  6304. "name": "owner",
  6305. "in": "path",
  6306. "required": true
  6307. },
  6308. {
  6309. "type": "string",
  6310. "description": "name of the repo",
  6311. "name": "repo",
  6312. "in": "path",
  6313. "required": true
  6314. },
  6315. {
  6316. "type": "integer",
  6317. "format": "int64",
  6318. "description": "id of the release to get",
  6319. "name": "id",
  6320. "in": "path",
  6321. "required": true
  6322. }
  6323. ],
  6324. "responses": {
  6325. "200": {
  6326. "$ref": "#/responses/Release"
  6327. }
  6328. }
  6329. },
  6330. "delete": {
  6331. "tags": [
  6332. "repository"
  6333. ],
  6334. "summary": "Delete a release",
  6335. "operationId": "repoDeleteRelease",
  6336. "parameters": [
  6337. {
  6338. "type": "string",
  6339. "description": "owner of the repo",
  6340. "name": "owner",
  6341. "in": "path",
  6342. "required": true
  6343. },
  6344. {
  6345. "type": "string",
  6346. "description": "name of the repo",
  6347. "name": "repo",
  6348. "in": "path",
  6349. "required": true
  6350. },
  6351. {
  6352. "type": "integer",
  6353. "format": "int64",
  6354. "description": "id of the release to delete",
  6355. "name": "id",
  6356. "in": "path",
  6357. "required": true
  6358. }
  6359. ],
  6360. "responses": {
  6361. "204": {
  6362. "$ref": "#/responses/empty"
  6363. }
  6364. }
  6365. },
  6366. "patch": {
  6367. "consumes": [
  6368. "application/json"
  6369. ],
  6370. "produces": [
  6371. "application/json"
  6372. ],
  6373. "tags": [
  6374. "repository"
  6375. ],
  6376. "summary": "Update a release",
  6377. "operationId": "repoEditRelease",
  6378. "parameters": [
  6379. {
  6380. "type": "string",
  6381. "description": "owner of the repo",
  6382. "name": "owner",
  6383. "in": "path",
  6384. "required": true
  6385. },
  6386. {
  6387. "type": "string",
  6388. "description": "name of the repo",
  6389. "name": "repo",
  6390. "in": "path",
  6391. "required": true
  6392. },
  6393. {
  6394. "type": "integer",
  6395. "format": "int64",
  6396. "description": "id of the release to edit",
  6397. "name": "id",
  6398. "in": "path",
  6399. "required": true
  6400. },
  6401. {
  6402. "name": "body",
  6403. "in": "body",
  6404. "schema": {
  6405. "$ref": "#/definitions/EditReleaseOption"
  6406. }
  6407. }
  6408. ],
  6409. "responses": {
  6410. "200": {
  6411. "$ref": "#/responses/Release"
  6412. }
  6413. }
  6414. }
  6415. },
  6416. "/repos/{owner}/{repo}/releases/{id}/assets": {
  6417. "get": {
  6418. "produces": [
  6419. "application/json"
  6420. ],
  6421. "tags": [
  6422. "repository"
  6423. ],
  6424. "summary": "List release's attachments",
  6425. "operationId": "repoListReleaseAttachments",
  6426. "parameters": [
  6427. {
  6428. "type": "string",
  6429. "description": "owner of the repo",
  6430. "name": "owner",
  6431. "in": "path",
  6432. "required": true
  6433. },
  6434. {
  6435. "type": "string",
  6436. "description": "name of the repo",
  6437. "name": "repo",
  6438. "in": "path",
  6439. "required": true
  6440. },
  6441. {
  6442. "type": "integer",
  6443. "format": "int64",
  6444. "description": "id of the release",
  6445. "name": "id",
  6446. "in": "path",
  6447. "required": true
  6448. }
  6449. ],
  6450. "responses": {
  6451. "200": {
  6452. "$ref": "#/responses/AttachmentList"
  6453. }
  6454. }
  6455. },
  6456. "post": {
  6457. "consumes": [
  6458. "multipart/form-data"
  6459. ],
  6460. "produces": [
  6461. "application/json"
  6462. ],
  6463. "tags": [
  6464. "repository"
  6465. ],
  6466. "summary": "Create a release attachment",
  6467. "operationId": "repoCreateReleaseAttachment",
  6468. "parameters": [
  6469. {
  6470. "type": "string",
  6471. "description": "owner of the repo",
  6472. "name": "owner",
  6473. "in": "path",
  6474. "required": true
  6475. },
  6476. {
  6477. "type": "string",
  6478. "description": "name of the repo",
  6479. "name": "repo",
  6480. "in": "path",
  6481. "required": true
  6482. },
  6483. {
  6484. "type": "integer",
  6485. "format": "int64",
  6486. "description": "id of the release",
  6487. "name": "id",
  6488. "in": "path",
  6489. "required": true
  6490. },
  6491. {
  6492. "type": "string",
  6493. "description": "name of the attachment",
  6494. "name": "name",
  6495. "in": "query"
  6496. },
  6497. {
  6498. "type": "file",
  6499. "description": "attachment to upload",
  6500. "name": "attachment",
  6501. "in": "formData",
  6502. "required": true
  6503. }
  6504. ],
  6505. "responses": {
  6506. "201": {
  6507. "$ref": "#/responses/Attachment"
  6508. },
  6509. "400": {
  6510. "$ref": "#/responses/error"
  6511. }
  6512. }
  6513. }
  6514. },
  6515. "/repos/{owner}/{repo}/releases/{id}/assets/{attachment_id}": {
  6516. "get": {
  6517. "produces": [
  6518. "application/json"
  6519. ],
  6520. "tags": [
  6521. "repository"
  6522. ],
  6523. "summary": "Get a release attachment",
  6524. "operationId": "repoGetReleaseAttachment",
  6525. "parameters": [
  6526. {
  6527. "type": "string",
  6528. "description": "owner of the repo",
  6529. "name": "owner",
  6530. "in": "path",
  6531. "required": true
  6532. },
  6533. {
  6534. "type": "string",
  6535. "description": "name of the repo",
  6536. "name": "repo",
  6537. "in": "path",
  6538. "required": true
  6539. },
  6540. {
  6541. "type": "integer",
  6542. "format": "int64",
  6543. "description": "id of the release",
  6544. "name": "id",
  6545. "in": "path",
  6546. "required": true
  6547. },
  6548. {
  6549. "type": "integer",
  6550. "format": "int64",
  6551. "description": "id of the attachment to get",
  6552. "name": "attachment_id",
  6553. "in": "path",
  6554. "required": true
  6555. }
  6556. ],
  6557. "responses": {
  6558. "200": {
  6559. "$ref": "#/responses/Attachment"
  6560. }
  6561. }
  6562. },
  6563. "delete": {
  6564. "produces": [
  6565. "application/json"
  6566. ],
  6567. "tags": [
  6568. "repository"
  6569. ],
  6570. "summary": "Delete a release attachment",
  6571. "operationId": "repoDeleteReleaseAttachment",
  6572. "parameters": [
  6573. {
  6574. "type": "string",
  6575. "description": "owner of the repo",
  6576. "name": "owner",
  6577. "in": "path",
  6578. "required": true
  6579. },
  6580. {
  6581. "type": "string",
  6582. "description": "name of the repo",
  6583. "name": "repo",
  6584. "in": "path",
  6585. "required": true
  6586. },
  6587. {
  6588. "type": "integer",
  6589. "format": "int64",
  6590. "description": "id of the release",
  6591. "name": "id",
  6592. "in": "path",
  6593. "required": true
  6594. },
  6595. {
  6596. "type": "integer",
  6597. "format": "int64",
  6598. "description": "id of the attachment to delete",
  6599. "name": "attachment_id",
  6600. "in": "path",
  6601. "required": true
  6602. }
  6603. ],
  6604. "responses": {
  6605. "204": {
  6606. "$ref": "#/responses/empty"
  6607. }
  6608. }
  6609. },
  6610. "patch": {
  6611. "consumes": [
  6612. "application/json"
  6613. ],
  6614. "produces": [
  6615. "application/json"
  6616. ],
  6617. "tags": [
  6618. "repository"
  6619. ],
  6620. "summary": "Edit a release attachment",
  6621. "operationId": "repoEditReleaseAttachment",
  6622. "parameters": [
  6623. {
  6624. "type": "string",
  6625. "description": "owner of the repo",
  6626. "name": "owner",
  6627. "in": "path",
  6628. "required": true
  6629. },
  6630. {
  6631. "type": "string",
  6632. "description": "name of the repo",
  6633. "name": "repo",
  6634. "in": "path",
  6635. "required": true
  6636. },
  6637. {
  6638. "type": "integer",
  6639. "format": "int64",
  6640. "description": "id of the release",
  6641. "name": "id",
  6642. "in": "path",
  6643. "required": true
  6644. },
  6645. {
  6646. "type": "integer",
  6647. "format": "int64",
  6648. "description": "id of the attachment to edit",
  6649. "name": "attachment_id",
  6650. "in": "path",
  6651. "required": true
  6652. },
  6653. {
  6654. "name": "body",
  6655. "in": "body",
  6656. "schema": {
  6657. "$ref": "#/definitions/EditAttachmentOptions"
  6658. }
  6659. }
  6660. ],
  6661. "responses": {
  6662. "201": {
  6663. "$ref": "#/responses/Attachment"
  6664. }
  6665. }
  6666. }
  6667. },
  6668. "/repos/{owner}/{repo}/signing-key.gpg": {
  6669. "get": {
  6670. "produces": [
  6671. "text/plain"
  6672. ],
  6673. "tags": [
  6674. "repository"
  6675. ],
  6676. "summary": "Get signing-key.gpg for given repository",
  6677. "operationId": "repoSigningKey",
  6678. "parameters": [
  6679. {
  6680. "type": "string",
  6681. "description": "owner of the repo",
  6682. "name": "owner",
  6683. "in": "path",
  6684. "required": true
  6685. },
  6686. {
  6687. "type": "string",
  6688. "description": "name of the repo",
  6689. "name": "repo",
  6690. "in": "path",
  6691. "required": true
  6692. }
  6693. ],
  6694. "responses": {
  6695. "200": {
  6696. "description": "GPG armored public key",
  6697. "schema": {
  6698. "type": "string"
  6699. }
  6700. }
  6701. }
  6702. }
  6703. },
  6704. "/repos/{owner}/{repo}/stargazers": {
  6705. "get": {
  6706. "produces": [
  6707. "application/json"
  6708. ],
  6709. "tags": [
  6710. "repository"
  6711. ],
  6712. "summary": "List a repo's stargazers",
  6713. "operationId": "repoListStargazers",
  6714. "parameters": [
  6715. {
  6716. "type": "string",
  6717. "description": "owner of the repo",
  6718. "name": "owner",
  6719. "in": "path",
  6720. "required": true
  6721. },
  6722. {
  6723. "type": "string",
  6724. "description": "name of the repo",
  6725. "name": "repo",
  6726. "in": "path",
  6727. "required": true
  6728. },
  6729. {
  6730. "type": "integer",
  6731. "description": "page number of results to return (1-based)",
  6732. "name": "page",
  6733. "in": "query"
  6734. },
  6735. {
  6736. "type": "integer",
  6737. "description": "page size of results, maximum page size is 50",
  6738. "name": "limit",
  6739. "in": "query"
  6740. }
  6741. ],
  6742. "responses": {
  6743. "200": {
  6744. "$ref": "#/responses/UserList"
  6745. }
  6746. }
  6747. }
  6748. },
  6749. "/repos/{owner}/{repo}/statuses/{sha}": {
  6750. "get": {
  6751. "produces": [
  6752. "application/json"
  6753. ],
  6754. "tags": [
  6755. "repository"
  6756. ],
  6757. "summary": "Get a commit's statuses",
  6758. "operationId": "repoListStatuses",
  6759. "parameters": [
  6760. {
  6761. "type": "string",
  6762. "description": "owner of the repo",
  6763. "name": "owner",
  6764. "in": "path",
  6765. "required": true
  6766. },
  6767. {
  6768. "type": "string",
  6769. "description": "name of the repo",
  6770. "name": "repo",
  6771. "in": "path",
  6772. "required": true
  6773. },
  6774. {
  6775. "type": "string",
  6776. "description": "sha of the commit",
  6777. "name": "sha",
  6778. "in": "path",
  6779. "required": true
  6780. },
  6781. {
  6782. "enum": [
  6783. "oldest",
  6784. "recentupdate",
  6785. "leastupdate",
  6786. "leastindex",
  6787. "highestindex"
  6788. ],
  6789. "type": "string",
  6790. "description": "type of sort",
  6791. "name": "sort",
  6792. "in": "query"
  6793. },
  6794. {
  6795. "enum": [
  6796. "pending",
  6797. "success",
  6798. "error",
  6799. "failure",
  6800. "warning"
  6801. ],
  6802. "type": "string",
  6803. "description": "type of state",
  6804. "name": "state",
  6805. "in": "query"
  6806. },
  6807. {
  6808. "type": "integer",
  6809. "description": "page number of results to return (1-based)",
  6810. "name": "page",
  6811. "in": "query"
  6812. },
  6813. {
  6814. "type": "integer",
  6815. "description": "page size of results, maximum page size is 50",
  6816. "name": "limit",
  6817. "in": "query"
  6818. }
  6819. ],
  6820. "responses": {
  6821. "200": {
  6822. "$ref": "#/responses/StatusList"
  6823. },
  6824. "400": {
  6825. "$ref": "#/responses/error"
  6826. }
  6827. }
  6828. },
  6829. "post": {
  6830. "produces": [
  6831. "application/json"
  6832. ],
  6833. "tags": [
  6834. "repository"
  6835. ],
  6836. "summary": "Create a commit status",
  6837. "operationId": "repoCreateStatus",
  6838. "parameters": [
  6839. {
  6840. "type": "string",
  6841. "description": "owner of the repo",
  6842. "name": "owner",
  6843. "in": "path",
  6844. "required": true
  6845. },
  6846. {
  6847. "type": "string",
  6848. "description": "name of the repo",
  6849. "name": "repo",
  6850. "in": "path",
  6851. "required": true
  6852. },
  6853. {
  6854. "type": "string",
  6855. "description": "sha of the commit",
  6856. "name": "sha",
  6857. "in": "path",
  6858. "required": true
  6859. },
  6860. {
  6861. "name": "body",
  6862. "in": "body",
  6863. "schema": {
  6864. "$ref": "#/definitions/CreateStatusOption"
  6865. }
  6866. }
  6867. ],
  6868. "responses": {
  6869. "201": {
  6870. "$ref": "#/responses/Status"
  6871. },
  6872. "400": {
  6873. "$ref": "#/responses/error"
  6874. }
  6875. }
  6876. }
  6877. },
  6878. "/repos/{owner}/{repo}/subscribers": {
  6879. "get": {
  6880. "produces": [
  6881. "application/json"
  6882. ],
  6883. "tags": [
  6884. "repository"
  6885. ],
  6886. "summary": "List a repo's watchers",
  6887. "operationId": "repoListSubscribers",
  6888. "parameters": [
  6889. {
  6890. "type": "string",
  6891. "description": "owner of the repo",
  6892. "name": "owner",
  6893. "in": "path",
  6894. "required": true
  6895. },
  6896. {
  6897. "type": "string",
  6898. "description": "name of the repo",
  6899. "name": "repo",
  6900. "in": "path",
  6901. "required": true
  6902. },
  6903. {
  6904. "type": "integer",
  6905. "description": "page number of results to return (1-based)",
  6906. "name": "page",
  6907. "in": "query"
  6908. },
  6909. {
  6910. "type": "integer",
  6911. "description": "page size of results, maximum page size is 50",
  6912. "name": "limit",
  6913. "in": "query"
  6914. }
  6915. ],
  6916. "responses": {
  6917. "200": {
  6918. "$ref": "#/responses/UserList"
  6919. }
  6920. }
  6921. }
  6922. },
  6923. "/repos/{owner}/{repo}/subscription": {
  6924. "get": {
  6925. "tags": [
  6926. "repository"
  6927. ],
  6928. "summary": "Check if the current user is watching a repo",
  6929. "operationId": "userCurrentCheckSubscription",
  6930. "parameters": [
  6931. {
  6932. "type": "string",
  6933. "description": "owner of the repo",
  6934. "name": "owner",
  6935. "in": "path",
  6936. "required": true
  6937. },
  6938. {
  6939. "type": "string",
  6940. "description": "name of the repo",
  6941. "name": "repo",
  6942. "in": "path",
  6943. "required": true
  6944. }
  6945. ],
  6946. "responses": {
  6947. "200": {
  6948. "$ref": "#/responses/WatchInfo"
  6949. }
  6950. }
  6951. },
  6952. "put": {
  6953. "tags": [
  6954. "repository"
  6955. ],
  6956. "summary": "Watch a repo",
  6957. "operationId": "userCurrentPutSubscription",
  6958. "parameters": [
  6959. {
  6960. "type": "string",
  6961. "description": "owner of the repo",
  6962. "name": "owner",
  6963. "in": "path",
  6964. "required": true
  6965. },
  6966. {
  6967. "type": "string",
  6968. "description": "name of the repo",
  6969. "name": "repo",
  6970. "in": "path",
  6971. "required": true
  6972. }
  6973. ],
  6974. "responses": {
  6975. "200": {
  6976. "$ref": "#/responses/WatchInfo"
  6977. }
  6978. }
  6979. },
  6980. "delete": {
  6981. "tags": [
  6982. "repository"
  6983. ],
  6984. "summary": "Unwatch a repo",
  6985. "operationId": "userCurrentDeleteSubscription",
  6986. "parameters": [
  6987. {
  6988. "type": "string",
  6989. "description": "owner of the repo",
  6990. "name": "owner",
  6991. "in": "path",
  6992. "required": true
  6993. },
  6994. {
  6995. "type": "string",
  6996. "description": "name of the repo",
  6997. "name": "repo",
  6998. "in": "path",
  6999. "required": true
  7000. }
  7001. ],
  7002. "responses": {
  7003. "204": {
  7004. "$ref": "#/responses/empty"
  7005. }
  7006. }
  7007. }
  7008. },
  7009. "/repos/{owner}/{repo}/tags": {
  7010. "get": {
  7011. "produces": [
  7012. "application/json"
  7013. ],
  7014. "tags": [
  7015. "repository"
  7016. ],
  7017. "summary": "List a repository's tags",
  7018. "operationId": "repoListTags",
  7019. "parameters": [
  7020. {
  7021. "type": "string",
  7022. "description": "owner of the repo",
  7023. "name": "owner",
  7024. "in": "path",
  7025. "required": true
  7026. },
  7027. {
  7028. "type": "string",
  7029. "description": "name of the repo",
  7030. "name": "repo",
  7031. "in": "path",
  7032. "required": true
  7033. }
  7034. ],
  7035. "responses": {
  7036. "200": {
  7037. "$ref": "#/responses/TagList"
  7038. }
  7039. }
  7040. }
  7041. },
  7042. "/repos/{owner}/{repo}/times": {
  7043. "get": {
  7044. "produces": [
  7045. "application/json"
  7046. ],
  7047. "tags": [
  7048. "repository"
  7049. ],
  7050. "summary": "List a repo's tracked times",
  7051. "operationId": "repoTrackedTimes",
  7052. "parameters": [
  7053. {
  7054. "type": "string",
  7055. "description": "owner of the repo",
  7056. "name": "owner",
  7057. "in": "path",
  7058. "required": true
  7059. },
  7060. {
  7061. "type": "string",
  7062. "description": "name of the repo",
  7063. "name": "repo",
  7064. "in": "path",
  7065. "required": true
  7066. },
  7067. {
  7068. "type": "string",
  7069. "description": "optional filter by user",
  7070. "name": "user",
  7071. "in": "query"
  7072. },
  7073. {
  7074. "type": "string",
  7075. "format": "date-time",
  7076. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  7077. "name": "since",
  7078. "in": "query"
  7079. },
  7080. {
  7081. "type": "string",
  7082. "format": "date-time",
  7083. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  7084. "name": "before",
  7085. "in": "query"
  7086. },
  7087. {
  7088. "type": "integer",
  7089. "description": "page number of results to return (1-based)",
  7090. "name": "page",
  7091. "in": "query"
  7092. },
  7093. {
  7094. "type": "integer",
  7095. "description": "page size of results, maximum page size is 50",
  7096. "name": "limit",
  7097. "in": "query"
  7098. }
  7099. ],
  7100. "responses": {
  7101. "200": {
  7102. "$ref": "#/responses/TrackedTimeList"
  7103. },
  7104. "400": {
  7105. "$ref": "#/responses/error"
  7106. },
  7107. "403": {
  7108. "$ref": "#/responses/forbidden"
  7109. }
  7110. }
  7111. }
  7112. },
  7113. "/repos/{owner}/{repo}/times/{user}": {
  7114. "get": {
  7115. "produces": [
  7116. "application/json"
  7117. ],
  7118. "tags": [
  7119. "repository"
  7120. ],
  7121. "summary": "List a user's tracked times in a repo",
  7122. "operationId": "userTrackedTimes",
  7123. "deprecated": true,
  7124. "parameters": [
  7125. {
  7126. "type": "string",
  7127. "description": "owner of the repo",
  7128. "name": "owner",
  7129. "in": "path",
  7130. "required": true
  7131. },
  7132. {
  7133. "type": "string",
  7134. "description": "name of the repo",
  7135. "name": "repo",
  7136. "in": "path",
  7137. "required": true
  7138. },
  7139. {
  7140. "type": "string",
  7141. "description": "username of user",
  7142. "name": "user",
  7143. "in": "path",
  7144. "required": true
  7145. }
  7146. ],
  7147. "responses": {
  7148. "200": {
  7149. "$ref": "#/responses/TrackedTimeList"
  7150. },
  7151. "400": {
  7152. "$ref": "#/responses/error"
  7153. },
  7154. "403": {
  7155. "$ref": "#/responses/forbidden"
  7156. }
  7157. }
  7158. }
  7159. },
  7160. "/repos/{owner}/{repo}/topics": {
  7161. "get": {
  7162. "produces": [
  7163. "application/json"
  7164. ],
  7165. "tags": [
  7166. "repository"
  7167. ],
  7168. "summary": "Get list of topics that a repository has",
  7169. "operationId": "repoListTopics",
  7170. "parameters": [
  7171. {
  7172. "type": "string",
  7173. "description": "owner of the repo",
  7174. "name": "owner",
  7175. "in": "path",
  7176. "required": true
  7177. },
  7178. {
  7179. "type": "string",
  7180. "description": "name of the repo",
  7181. "name": "repo",
  7182. "in": "path",
  7183. "required": true
  7184. },
  7185. {
  7186. "type": "integer",
  7187. "description": "page number of results to return (1-based)",
  7188. "name": "page",
  7189. "in": "query"
  7190. },
  7191. {
  7192. "type": "integer",
  7193. "description": "page size of results, maximum page size is 50",
  7194. "name": "limit",
  7195. "in": "query"
  7196. }
  7197. ],
  7198. "responses": {
  7199. "200": {
  7200. "$ref": "#/responses/TopicNames"
  7201. }
  7202. }
  7203. },
  7204. "put": {
  7205. "produces": [
  7206. "application/json"
  7207. ],
  7208. "tags": [
  7209. "repository"
  7210. ],
  7211. "summary": "Replace list of topics for a repository",
  7212. "operationId": "repoUpdateTopics",
  7213. "parameters": [
  7214. {
  7215. "type": "string",
  7216. "description": "owner of the repo",
  7217. "name": "owner",
  7218. "in": "path",
  7219. "required": true
  7220. },
  7221. {
  7222. "type": "string",
  7223. "description": "name of the repo",
  7224. "name": "repo",
  7225. "in": "path",
  7226. "required": true
  7227. },
  7228. {
  7229. "name": "body",
  7230. "in": "body",
  7231. "schema": {
  7232. "$ref": "#/definitions/RepoTopicOptions"
  7233. }
  7234. }
  7235. ],
  7236. "responses": {
  7237. "204": {
  7238. "$ref": "#/responses/empty"
  7239. },
  7240. "422": {
  7241. "$ref": "#/responses/invalidTopicsError"
  7242. }
  7243. }
  7244. }
  7245. },
  7246. "/repos/{owner}/{repo}/topics/{topic}": {
  7247. "put": {
  7248. "produces": [
  7249. "application/json"
  7250. ],
  7251. "tags": [
  7252. "repository"
  7253. ],
  7254. "summary": "Add a topic to a repository",
  7255. "operationId": "repoAddTopíc",
  7256. "parameters": [
  7257. {
  7258. "type": "string",
  7259. "description": "owner of the repo",
  7260. "name": "owner",
  7261. "in": "path",
  7262. "required": true
  7263. },
  7264. {
  7265. "type": "string",
  7266. "description": "name of the repo",
  7267. "name": "repo",
  7268. "in": "path",
  7269. "required": true
  7270. },
  7271. {
  7272. "type": "string",
  7273. "description": "name of the topic to add",
  7274. "name": "topic",
  7275. "in": "path",
  7276. "required": true
  7277. }
  7278. ],
  7279. "responses": {
  7280. "204": {
  7281. "$ref": "#/responses/empty"
  7282. },
  7283. "422": {
  7284. "$ref": "#/responses/invalidTopicsError"
  7285. }
  7286. }
  7287. },
  7288. "delete": {
  7289. "produces": [
  7290. "application/json"
  7291. ],
  7292. "tags": [
  7293. "repository"
  7294. ],
  7295. "summary": "Delete a topic from a repository",
  7296. "operationId": "repoDeleteTopic",
  7297. "parameters": [
  7298. {
  7299. "type": "string",
  7300. "description": "owner of the repo",
  7301. "name": "owner",
  7302. "in": "path",
  7303. "required": true
  7304. },
  7305. {
  7306. "type": "string",
  7307. "description": "name of the repo",
  7308. "name": "repo",
  7309. "in": "path",
  7310. "required": true
  7311. },
  7312. {
  7313. "type": "string",
  7314. "description": "name of the topic to delete",
  7315. "name": "topic",
  7316. "in": "path",
  7317. "required": true
  7318. }
  7319. ],
  7320. "responses": {
  7321. "204": {
  7322. "$ref": "#/responses/empty"
  7323. },
  7324. "422": {
  7325. "$ref": "#/responses/invalidTopicsError"
  7326. }
  7327. }
  7328. }
  7329. },
  7330. "/repos/{owner}/{repo}/transfer": {
  7331. "post": {
  7332. "produces": [
  7333. "application/json"
  7334. ],
  7335. "tags": [
  7336. "repository"
  7337. ],
  7338. "summary": "Transfer a repo ownership",
  7339. "operationId": "repoTransfer",
  7340. "parameters": [
  7341. {
  7342. "type": "string",
  7343. "description": "owner of the repo to transfer",
  7344. "name": "owner",
  7345. "in": "path",
  7346. "required": true
  7347. },
  7348. {
  7349. "type": "string",
  7350. "description": "name of the repo to transfer",
  7351. "name": "repo",
  7352. "in": "path",
  7353. "required": true
  7354. },
  7355. {
  7356. "description": "Transfer Options",
  7357. "name": "body",
  7358. "in": "body",
  7359. "required": true,
  7360. "schema": {
  7361. "$ref": "#/definitions/TransferRepoOption"
  7362. }
  7363. }
  7364. ],
  7365. "responses": {
  7366. "202": {
  7367. "$ref": "#/responses/Repository"
  7368. },
  7369. "403": {
  7370. "$ref": "#/responses/forbidden"
  7371. },
  7372. "404": {
  7373. "$ref": "#/responses/notFound"
  7374. },
  7375. "422": {
  7376. "$ref": "#/responses/validationError"
  7377. }
  7378. }
  7379. }
  7380. },
  7381. "/repositories/{id}": {
  7382. "get": {
  7383. "produces": [
  7384. "application/json"
  7385. ],
  7386. "tags": [
  7387. "repository"
  7388. ],
  7389. "summary": "Get a repository by id",
  7390. "operationId": "repoGetByID",
  7391. "parameters": [
  7392. {
  7393. "type": "integer",
  7394. "format": "int64",
  7395. "description": "id of the repo to get",
  7396. "name": "id",
  7397. "in": "path",
  7398. "required": true
  7399. }
  7400. ],
  7401. "responses": {
  7402. "200": {
  7403. "$ref": "#/responses/Repository"
  7404. }
  7405. }
  7406. }
  7407. },
  7408. "/signing-key.gpg": {
  7409. "get": {
  7410. "produces": [
  7411. "text/plain"
  7412. ],
  7413. "tags": [
  7414. "miscellaneous"
  7415. ],
  7416. "summary": "Get default signing-key.gpg",
  7417. "operationId": "getSigningKey",
  7418. "responses": {
  7419. "200": {
  7420. "description": "GPG armored public key",
  7421. "schema": {
  7422. "type": "string"
  7423. }
  7424. }
  7425. }
  7426. }
  7427. },
  7428. "/teams/{id}": {
  7429. "get": {
  7430. "produces": [
  7431. "application/json"
  7432. ],
  7433. "tags": [
  7434. "organization"
  7435. ],
  7436. "summary": "Get a team",
  7437. "operationId": "orgGetTeam",
  7438. "parameters": [
  7439. {
  7440. "type": "integer",
  7441. "format": "int64",
  7442. "description": "id of the team to get",
  7443. "name": "id",
  7444. "in": "path",
  7445. "required": true
  7446. }
  7447. ],
  7448. "responses": {
  7449. "200": {
  7450. "$ref": "#/responses/Team"
  7451. }
  7452. }
  7453. },
  7454. "delete": {
  7455. "tags": [
  7456. "organization"
  7457. ],
  7458. "summary": "Delete a team",
  7459. "operationId": "orgDeleteTeam",
  7460. "parameters": [
  7461. {
  7462. "type": "integer",
  7463. "format": "int64",
  7464. "description": "id of the team to delete",
  7465. "name": "id",
  7466. "in": "path",
  7467. "required": true
  7468. }
  7469. ],
  7470. "responses": {
  7471. "204": {
  7472. "description": "team deleted"
  7473. }
  7474. }
  7475. },
  7476. "patch": {
  7477. "consumes": [
  7478. "application/json"
  7479. ],
  7480. "produces": [
  7481. "application/json"
  7482. ],
  7483. "tags": [
  7484. "organization"
  7485. ],
  7486. "summary": "Edit a team",
  7487. "operationId": "orgEditTeam",
  7488. "parameters": [
  7489. {
  7490. "type": "integer",
  7491. "description": "id of the team to edit",
  7492. "name": "id",
  7493. "in": "path",
  7494. "required": true
  7495. },
  7496. {
  7497. "name": "body",
  7498. "in": "body",
  7499. "schema": {
  7500. "$ref": "#/definitions/EditTeamOption"
  7501. }
  7502. }
  7503. ],
  7504. "responses": {
  7505. "200": {
  7506. "$ref": "#/responses/Team"
  7507. }
  7508. }
  7509. }
  7510. },
  7511. "/teams/{id}/members": {
  7512. "get": {
  7513. "produces": [
  7514. "application/json"
  7515. ],
  7516. "tags": [
  7517. "organization"
  7518. ],
  7519. "summary": "List a team's members",
  7520. "operationId": "orgListTeamMembers",
  7521. "parameters": [
  7522. {
  7523. "type": "integer",
  7524. "format": "int64",
  7525. "description": "id of the team",
  7526. "name": "id",
  7527. "in": "path",
  7528. "required": true
  7529. },
  7530. {
  7531. "type": "integer",
  7532. "description": "page number of results to return (1-based)",
  7533. "name": "page",
  7534. "in": "query"
  7535. },
  7536. {
  7537. "type": "integer",
  7538. "description": "page size of results, maximum page size is 50",
  7539. "name": "limit",
  7540. "in": "query"
  7541. }
  7542. ],
  7543. "responses": {
  7544. "200": {
  7545. "$ref": "#/responses/UserList"
  7546. }
  7547. }
  7548. }
  7549. },
  7550. "/teams/{id}/members/{username}": {
  7551. "get": {
  7552. "produces": [
  7553. "application/json"
  7554. ],
  7555. "tags": [
  7556. "organization"
  7557. ],
  7558. "summary": "List a particular member of team",
  7559. "operationId": "orgListTeamMember",
  7560. "parameters": [
  7561. {
  7562. "type": "integer",
  7563. "format": "int64",
  7564. "description": "id of the team",
  7565. "name": "id",
  7566. "in": "path",
  7567. "required": true
  7568. },
  7569. {
  7570. "type": "string",
  7571. "description": "username of the member to list",
  7572. "name": "username",
  7573. "in": "path",
  7574. "required": true
  7575. }
  7576. ],
  7577. "responses": {
  7578. "200": {
  7579. "$ref": "#/responses/User"
  7580. },
  7581. "404": {
  7582. "$ref": "#/responses/notFound"
  7583. }
  7584. }
  7585. },
  7586. "put": {
  7587. "produces": [
  7588. "application/json"
  7589. ],
  7590. "tags": [
  7591. "organization"
  7592. ],
  7593. "summary": "Add a team member",
  7594. "operationId": "orgAddTeamMember",
  7595. "parameters": [
  7596. {
  7597. "type": "integer",
  7598. "format": "int64",
  7599. "description": "id of the team",
  7600. "name": "id",
  7601. "in": "path",
  7602. "required": true
  7603. },
  7604. {
  7605. "type": "string",
  7606. "description": "username of the user to add",
  7607. "name": "username",
  7608. "in": "path",
  7609. "required": true
  7610. }
  7611. ],
  7612. "responses": {
  7613. "204": {
  7614. "$ref": "#/responses/empty"
  7615. },
  7616. "404": {
  7617. "$ref": "#/responses/notFound"
  7618. }
  7619. }
  7620. },
  7621. "delete": {
  7622. "produces": [
  7623. "application/json"
  7624. ],
  7625. "tags": [
  7626. "organization"
  7627. ],
  7628. "summary": "Remove a team member",
  7629. "operationId": "orgRemoveTeamMember",
  7630. "parameters": [
  7631. {
  7632. "type": "integer",
  7633. "format": "int64",
  7634. "description": "id of the team",
  7635. "name": "id",
  7636. "in": "path",
  7637. "required": true
  7638. },
  7639. {
  7640. "type": "string",
  7641. "description": "username of the user to remove",
  7642. "name": "username",
  7643. "in": "path",
  7644. "required": true
  7645. }
  7646. ],
  7647. "responses": {
  7648. "204": {
  7649. "$ref": "#/responses/empty"
  7650. },
  7651. "404": {
  7652. "$ref": "#/responses/notFound"
  7653. }
  7654. }
  7655. }
  7656. },
  7657. "/teams/{id}/repos": {
  7658. "get": {
  7659. "produces": [
  7660. "application/json"
  7661. ],
  7662. "tags": [
  7663. "organization"
  7664. ],
  7665. "summary": "List a team's repos",
  7666. "operationId": "orgListTeamRepos",
  7667. "parameters": [
  7668. {
  7669. "type": "integer",
  7670. "format": "int64",
  7671. "description": "id of the team",
  7672. "name": "id",
  7673. "in": "path",
  7674. "required": true
  7675. },
  7676. {
  7677. "type": "integer",
  7678. "description": "page number of results to return (1-based)",
  7679. "name": "page",
  7680. "in": "query"
  7681. },
  7682. {
  7683. "type": "integer",
  7684. "description": "page size of results, maximum page size is 50",
  7685. "name": "limit",
  7686. "in": "query"
  7687. }
  7688. ],
  7689. "responses": {
  7690. "200": {
  7691. "$ref": "#/responses/RepositoryList"
  7692. }
  7693. }
  7694. }
  7695. },
  7696. "/teams/{id}/repos/{org}/{repo}": {
  7697. "put": {
  7698. "produces": [
  7699. "application/json"
  7700. ],
  7701. "tags": [
  7702. "organization"
  7703. ],
  7704. "summary": "Add a repository to a team",
  7705. "operationId": "orgAddTeamRepository",
  7706. "parameters": [
  7707. {
  7708. "type": "integer",
  7709. "format": "int64",
  7710. "description": "id of the team",
  7711. "name": "id",
  7712. "in": "path",
  7713. "required": true
  7714. },
  7715. {
  7716. "type": "string",
  7717. "description": "organization that owns the repo to add",
  7718. "name": "org",
  7719. "in": "path",
  7720. "required": true
  7721. },
  7722. {
  7723. "type": "string",
  7724. "description": "name of the repo to add",
  7725. "name": "repo",
  7726. "in": "path",
  7727. "required": true
  7728. }
  7729. ],
  7730. "responses": {
  7731. "204": {
  7732. "$ref": "#/responses/empty"
  7733. },
  7734. "403": {
  7735. "$ref": "#/responses/forbidden"
  7736. }
  7737. }
  7738. },
  7739. "delete": {
  7740. "description": "This does not delete the repository, it only removes the repository from the team.",
  7741. "produces": [
  7742. "application/json"
  7743. ],
  7744. "tags": [
  7745. "organization"
  7746. ],
  7747. "summary": "Remove a repository from a team",
  7748. "operationId": "orgRemoveTeamRepository",
  7749. "parameters": [
  7750. {
  7751. "type": "integer",
  7752. "format": "int64",
  7753. "description": "id of the team",
  7754. "name": "id",
  7755. "in": "path",
  7756. "required": true
  7757. },
  7758. {
  7759. "type": "string",
  7760. "description": "organization that owns the repo to remove",
  7761. "name": "org",
  7762. "in": "path",
  7763. "required": true
  7764. },
  7765. {
  7766. "type": "string",
  7767. "description": "name of the repo to remove",
  7768. "name": "repo",
  7769. "in": "path",
  7770. "required": true
  7771. }
  7772. ],
  7773. "responses": {
  7774. "204": {
  7775. "$ref": "#/responses/empty"
  7776. },
  7777. "403": {
  7778. "$ref": "#/responses/forbidden"
  7779. }
  7780. }
  7781. }
  7782. },
  7783. "/topics/search": {
  7784. "get": {
  7785. "produces": [
  7786. "application/json"
  7787. ],
  7788. "tags": [
  7789. "repository"
  7790. ],
  7791. "summary": "search topics via keyword",
  7792. "operationId": "topicSearch",
  7793. "parameters": [
  7794. {
  7795. "type": "string",
  7796. "description": "keywords to search",
  7797. "name": "q",
  7798. "in": "query",
  7799. "required": true
  7800. },
  7801. {
  7802. "type": "integer",
  7803. "description": "page number of results to return (1-based)",
  7804. "name": "page",
  7805. "in": "query"
  7806. },
  7807. {
  7808. "type": "integer",
  7809. "description": "page size of results, maximum page size is 50",
  7810. "name": "limit",
  7811. "in": "query"
  7812. }
  7813. ],
  7814. "responses": {
  7815. "200": {
  7816. "$ref": "#/responses/TopicListResponse"
  7817. },
  7818. "403": {
  7819. "$ref": "#/responses/forbidden"
  7820. }
  7821. }
  7822. }
  7823. },
  7824. "/user": {
  7825. "get": {
  7826. "produces": [
  7827. "application/json"
  7828. ],
  7829. "tags": [
  7830. "user"
  7831. ],
  7832. "summary": "Get the authenticated user",
  7833. "operationId": "userGetCurrent",
  7834. "responses": {
  7835. "200": {
  7836. "$ref": "#/responses/User"
  7837. }
  7838. }
  7839. }
  7840. },
  7841. "/user/emails": {
  7842. "get": {
  7843. "produces": [
  7844. "application/json"
  7845. ],
  7846. "tags": [
  7847. "user"
  7848. ],
  7849. "summary": "List the authenticated user's email addresses",
  7850. "operationId": "userListEmails",
  7851. "responses": {
  7852. "200": {
  7853. "$ref": "#/responses/EmailList"
  7854. }
  7855. }
  7856. },
  7857. "post": {
  7858. "produces": [
  7859. "application/json"
  7860. ],
  7861. "tags": [
  7862. "user"
  7863. ],
  7864. "summary": "Add email addresses",
  7865. "operationId": "userAddEmail",
  7866. "parameters": [
  7867. {
  7868. "name": "body",
  7869. "in": "body",
  7870. "schema": {
  7871. "$ref": "#/definitions/CreateEmailOption"
  7872. }
  7873. }
  7874. ],
  7875. "responses": {
  7876. "201": {
  7877. "$ref": "#/responses/EmailList"
  7878. },
  7879. "422": {
  7880. "$ref": "#/responses/validationError"
  7881. }
  7882. }
  7883. },
  7884. "delete": {
  7885. "produces": [
  7886. "application/json"
  7887. ],
  7888. "tags": [
  7889. "user"
  7890. ],
  7891. "summary": "Delete email addresses",
  7892. "operationId": "userDeleteEmail",
  7893. "parameters": [
  7894. {
  7895. "name": "body",
  7896. "in": "body",
  7897. "schema": {
  7898. "$ref": "#/definitions/DeleteEmailOption"
  7899. }
  7900. }
  7901. ],
  7902. "responses": {
  7903. "204": {
  7904. "$ref": "#/responses/empty"
  7905. }
  7906. }
  7907. }
  7908. },
  7909. "/user/followers": {
  7910. "get": {
  7911. "produces": [
  7912. "application/json"
  7913. ],
  7914. "tags": [
  7915. "user"
  7916. ],
  7917. "summary": "List the authenticated user's followers",
  7918. "operationId": "userCurrentListFollowers",
  7919. "parameters": [
  7920. {
  7921. "type": "integer",
  7922. "description": "page number of results to return (1-based)",
  7923. "name": "page",
  7924. "in": "query"
  7925. },
  7926. {
  7927. "type": "integer",
  7928. "description": "page size of results, maximum page size is 50",
  7929. "name": "limit",
  7930. "in": "query"
  7931. }
  7932. ],
  7933. "responses": {
  7934. "200": {
  7935. "$ref": "#/responses/UserList"
  7936. }
  7937. }
  7938. }
  7939. },
  7940. "/user/following": {
  7941. "get": {
  7942. "produces": [
  7943. "application/json"
  7944. ],
  7945. "tags": [
  7946. "user"
  7947. ],
  7948. "summary": "List the users that the authenticated user is following",
  7949. "operationId": "userCurrentListFollowing",
  7950. "parameters": [
  7951. {
  7952. "type": "integer",
  7953. "description": "page number of results to return (1-based)",
  7954. "name": "page",
  7955. "in": "query"
  7956. },
  7957. {
  7958. "type": "integer",
  7959. "description": "page size of results, maximum page size is 50",
  7960. "name": "limit",
  7961. "in": "query"
  7962. }
  7963. ],
  7964. "responses": {
  7965. "200": {
  7966. "$ref": "#/responses/UserList"
  7967. }
  7968. }
  7969. }
  7970. },
  7971. "/user/following/{username}": {
  7972. "get": {
  7973. "tags": [
  7974. "user"
  7975. ],
  7976. "summary": "Check whether a user is followed by the authenticated user",
  7977. "operationId": "userCurrentCheckFollowing",
  7978. "parameters": [
  7979. {
  7980. "type": "string",
  7981. "description": "username of followed user",
  7982. "name": "username",
  7983. "in": "path",
  7984. "required": true
  7985. }
  7986. ],
  7987. "responses": {
  7988. "204": {
  7989. "$ref": "#/responses/empty"
  7990. },
  7991. "404": {
  7992. "$ref": "#/responses/notFound"
  7993. }
  7994. }
  7995. },
  7996. "put": {
  7997. "tags": [
  7998. "user"
  7999. ],
  8000. "summary": "Follow a user",
  8001. "operationId": "userCurrentPutFollow",
  8002. "parameters": [
  8003. {
  8004. "type": "string",
  8005. "description": "username of user to follow",
  8006. "name": "username",
  8007. "in": "path",
  8008. "required": true
  8009. }
  8010. ],
  8011. "responses": {
  8012. "204": {
  8013. "$ref": "#/responses/empty"
  8014. }
  8015. }
  8016. },
  8017. "delete": {
  8018. "tags": [
  8019. "user"
  8020. ],
  8021. "summary": "Unfollow a user",
  8022. "operationId": "userCurrentDeleteFollow",
  8023. "parameters": [
  8024. {
  8025. "type": "string",
  8026. "description": "username of user to unfollow",
  8027. "name": "username",
  8028. "in": "path",
  8029. "required": true
  8030. }
  8031. ],
  8032. "responses": {
  8033. "204": {
  8034. "$ref": "#/responses/empty"
  8035. }
  8036. }
  8037. }
  8038. },
  8039. "/user/gpg_keys": {
  8040. "get": {
  8041. "produces": [
  8042. "application/json"
  8043. ],
  8044. "tags": [
  8045. "user"
  8046. ],
  8047. "summary": "List the authenticated user's GPG keys",
  8048. "operationId": "userCurrentListGPGKeys",
  8049. "parameters": [
  8050. {
  8051. "type": "integer",
  8052. "description": "page number of results to return (1-based)",
  8053. "name": "page",
  8054. "in": "query"
  8055. },
  8056. {
  8057. "type": "integer",
  8058. "description": "page size of results, maximum page size is 50",
  8059. "name": "limit",
  8060. "in": "query"
  8061. }
  8062. ],
  8063. "responses": {
  8064. "200": {
  8065. "$ref": "#/responses/GPGKeyList"
  8066. }
  8067. }
  8068. },
  8069. "post": {
  8070. "consumes": [
  8071. "application/json"
  8072. ],
  8073. "produces": [
  8074. "application/json"
  8075. ],
  8076. "tags": [
  8077. "user"
  8078. ],
  8079. "summary": "Create a GPG key",
  8080. "operationId": "userCurrentPostGPGKey",
  8081. "parameters": [
  8082. {
  8083. "name": "Form",
  8084. "in": "body",
  8085. "schema": {
  8086. "$ref": "#/definitions/CreateGPGKeyOption"
  8087. }
  8088. }
  8089. ],
  8090. "responses": {
  8091. "201": {
  8092. "$ref": "#/responses/GPGKey"
  8093. },
  8094. "422": {
  8095. "$ref": "#/responses/validationError"
  8096. }
  8097. }
  8098. }
  8099. },
  8100. "/user/gpg_keys/{id}": {
  8101. "get": {
  8102. "produces": [
  8103. "application/json"
  8104. ],
  8105. "tags": [
  8106. "user"
  8107. ],
  8108. "summary": "Get a GPG key",
  8109. "operationId": "userCurrentGetGPGKey",
  8110. "parameters": [
  8111. {
  8112. "type": "integer",
  8113. "format": "int64",
  8114. "description": "id of key to get",
  8115. "name": "id",
  8116. "in": "path",
  8117. "required": true
  8118. }
  8119. ],
  8120. "responses": {
  8121. "200": {
  8122. "$ref": "#/responses/GPGKey"
  8123. },
  8124. "404": {
  8125. "$ref": "#/responses/notFound"
  8126. }
  8127. }
  8128. },
  8129. "delete": {
  8130. "produces": [
  8131. "application/json"
  8132. ],
  8133. "tags": [
  8134. "user"
  8135. ],
  8136. "summary": "Remove a GPG key",
  8137. "operationId": "userCurrentDeleteGPGKey",
  8138. "parameters": [
  8139. {
  8140. "type": "integer",
  8141. "format": "int64",
  8142. "description": "id of key to delete",
  8143. "name": "id",
  8144. "in": "path",
  8145. "required": true
  8146. }
  8147. ],
  8148. "responses": {
  8149. "204": {
  8150. "$ref": "#/responses/empty"
  8151. },
  8152. "403": {
  8153. "$ref": "#/responses/forbidden"
  8154. }
  8155. }
  8156. }
  8157. },
  8158. "/user/keys": {
  8159. "get": {
  8160. "produces": [
  8161. "application/json"
  8162. ],
  8163. "tags": [
  8164. "user"
  8165. ],
  8166. "summary": "List the authenticated user's public keys",
  8167. "operationId": "userCurrentListKeys",
  8168. "parameters": [
  8169. {
  8170. "type": "string",
  8171. "description": "fingerprint of the key",
  8172. "name": "fingerprint",
  8173. "in": "query"
  8174. },
  8175. {
  8176. "type": "integer",
  8177. "description": "page number of results to return (1-based)",
  8178. "name": "page",
  8179. "in": "query"
  8180. },
  8181. {
  8182. "type": "integer",
  8183. "description": "page size of results, maximum page size is 50",
  8184. "name": "limit",
  8185. "in": "query"
  8186. }
  8187. ],
  8188. "responses": {
  8189. "200": {
  8190. "$ref": "#/responses/PublicKeyList"
  8191. }
  8192. }
  8193. },
  8194. "post": {
  8195. "consumes": [
  8196. "application/json"
  8197. ],
  8198. "produces": [
  8199. "application/json"
  8200. ],
  8201. "tags": [
  8202. "user"
  8203. ],
  8204. "summary": "Create a public key",
  8205. "operationId": "userCurrentPostKey",
  8206. "parameters": [
  8207. {
  8208. "name": "body",
  8209. "in": "body",
  8210. "schema": {
  8211. "$ref": "#/definitions/CreateKeyOption"
  8212. }
  8213. }
  8214. ],
  8215. "responses": {
  8216. "201": {
  8217. "$ref": "#/responses/PublicKey"
  8218. },
  8219. "422": {
  8220. "$ref": "#/responses/validationError"
  8221. }
  8222. }
  8223. }
  8224. },
  8225. "/user/keys/{id}": {
  8226. "get": {
  8227. "produces": [
  8228. "application/json"
  8229. ],
  8230. "tags": [
  8231. "user"
  8232. ],
  8233. "summary": "Get a public key",
  8234. "operationId": "userCurrentGetKey",
  8235. "parameters": [
  8236. {
  8237. "type": "integer",
  8238. "format": "int64",
  8239. "description": "id of key to get",
  8240. "name": "id",
  8241. "in": "path",
  8242. "required": true
  8243. }
  8244. ],
  8245. "responses": {
  8246. "200": {
  8247. "$ref": "#/responses/PublicKey"
  8248. },
  8249. "404": {
  8250. "$ref": "#/responses/notFound"
  8251. }
  8252. }
  8253. },
  8254. "delete": {
  8255. "produces": [
  8256. "application/json"
  8257. ],
  8258. "tags": [
  8259. "user"
  8260. ],
  8261. "summary": "Delete a public key",
  8262. "operationId": "userCurrentDeleteKey",
  8263. "parameters": [
  8264. {
  8265. "type": "integer",
  8266. "format": "int64",
  8267. "description": "id of key to delete",
  8268. "name": "id",
  8269. "in": "path",
  8270. "required": true
  8271. }
  8272. ],
  8273. "responses": {
  8274. "204": {
  8275. "$ref": "#/responses/empty"
  8276. },
  8277. "403": {
  8278. "$ref": "#/responses/forbidden"
  8279. },
  8280. "404": {
  8281. "$ref": "#/responses/notFound"
  8282. }
  8283. }
  8284. }
  8285. },
  8286. "/user/orgs": {
  8287. "get": {
  8288. "produces": [
  8289. "application/json"
  8290. ],
  8291. "tags": [
  8292. "organization"
  8293. ],
  8294. "summary": "List the current user's organizations",
  8295. "operationId": "orgListCurrentUserOrgs",
  8296. "parameters": [
  8297. {
  8298. "type": "integer",
  8299. "description": "page number of results to return (1-based)",
  8300. "name": "page",
  8301. "in": "query"
  8302. },
  8303. {
  8304. "type": "integer",
  8305. "description": "page size of results, maximum page size is 50",
  8306. "name": "limit",
  8307. "in": "query"
  8308. }
  8309. ],
  8310. "responses": {
  8311. "200": {
  8312. "$ref": "#/responses/OrganizationList"
  8313. }
  8314. }
  8315. }
  8316. },
  8317. "/user/repos": {
  8318. "get": {
  8319. "produces": [
  8320. "application/json"
  8321. ],
  8322. "tags": [
  8323. "user"
  8324. ],
  8325. "summary": "List the repos that the authenticated user owns or has access to",
  8326. "operationId": "userCurrentListRepos",
  8327. "parameters": [
  8328. {
  8329. "type": "integer",
  8330. "description": "page number of results to return (1-based)",
  8331. "name": "page",
  8332. "in": "query"
  8333. },
  8334. {
  8335. "type": "integer",
  8336. "description": "page size of results, maximum page size is 50",
  8337. "name": "limit",
  8338. "in": "query"
  8339. }
  8340. ],
  8341. "responses": {
  8342. "200": {
  8343. "$ref": "#/responses/RepositoryList"
  8344. }
  8345. }
  8346. },
  8347. "post": {
  8348. "consumes": [
  8349. "application/json"
  8350. ],
  8351. "produces": [
  8352. "application/json"
  8353. ],
  8354. "tags": [
  8355. "repository",
  8356. "user"
  8357. ],
  8358. "summary": "Create a repository",
  8359. "operationId": "createCurrentUserRepo",
  8360. "parameters": [
  8361. {
  8362. "name": "body",
  8363. "in": "body",
  8364. "schema": {
  8365. "$ref": "#/definitions/CreateRepoOption"
  8366. }
  8367. }
  8368. ],
  8369. "responses": {
  8370. "201": {
  8371. "$ref": "#/responses/Repository"
  8372. },
  8373. "409": {
  8374. "description": "The repository with the same name already exists."
  8375. },
  8376. "422": {
  8377. "$ref": "#/responses/validationError"
  8378. }
  8379. }
  8380. }
  8381. },
  8382. "/user/starred": {
  8383. "get": {
  8384. "produces": [
  8385. "application/json"
  8386. ],
  8387. "tags": [
  8388. "user"
  8389. ],
  8390. "summary": "The repos that the authenticated user has starred",
  8391. "operationId": "userCurrentListStarred",
  8392. "parameters": [
  8393. {
  8394. "type": "integer",
  8395. "description": "page number of results to return (1-based)",
  8396. "name": "page",
  8397. "in": "query"
  8398. },
  8399. {
  8400. "type": "integer",
  8401. "description": "page size of results, maximum page size is 50",
  8402. "name": "limit",
  8403. "in": "query"
  8404. }
  8405. ],
  8406. "responses": {
  8407. "200": {
  8408. "$ref": "#/responses/RepositoryList"
  8409. }
  8410. }
  8411. }
  8412. },
  8413. "/user/starred/{owner}/{repo}": {
  8414. "get": {
  8415. "tags": [
  8416. "user"
  8417. ],
  8418. "summary": "Whether the authenticated is starring the repo",
  8419. "operationId": "userCurrentCheckStarring",
  8420. "parameters": [
  8421. {
  8422. "type": "string",
  8423. "description": "owner of the repo",
  8424. "name": "owner",
  8425. "in": "path",
  8426. "required": true
  8427. },
  8428. {
  8429. "type": "string",
  8430. "description": "name of the repo",
  8431. "name": "repo",
  8432. "in": "path",
  8433. "required": true
  8434. }
  8435. ],
  8436. "responses": {
  8437. "204": {
  8438. "$ref": "#/responses/empty"
  8439. },
  8440. "404": {
  8441. "$ref": "#/responses/notFound"
  8442. }
  8443. }
  8444. },
  8445. "put": {
  8446. "tags": [
  8447. "user"
  8448. ],
  8449. "summary": "Star the given repo",
  8450. "operationId": "userCurrentPutStar",
  8451. "parameters": [
  8452. {
  8453. "type": "string",
  8454. "description": "owner of the repo to star",
  8455. "name": "owner",
  8456. "in": "path",
  8457. "required": true
  8458. },
  8459. {
  8460. "type": "string",
  8461. "description": "name of the repo to star",
  8462. "name": "repo",
  8463. "in": "path",
  8464. "required": true
  8465. }
  8466. ],
  8467. "responses": {
  8468. "204": {
  8469. "$ref": "#/responses/empty"
  8470. }
  8471. }
  8472. },
  8473. "delete": {
  8474. "tags": [
  8475. "user"
  8476. ],
  8477. "summary": "Unstar the given repo",
  8478. "operationId": "userCurrentDeleteStar",
  8479. "parameters": [
  8480. {
  8481. "type": "string",
  8482. "description": "owner of the repo to unstar",
  8483. "name": "owner",
  8484. "in": "path",
  8485. "required": true
  8486. },
  8487. {
  8488. "type": "string",
  8489. "description": "name of the repo to unstar",
  8490. "name": "repo",
  8491. "in": "path",
  8492. "required": true
  8493. }
  8494. ],
  8495. "responses": {
  8496. "204": {
  8497. "$ref": "#/responses/empty"
  8498. }
  8499. }
  8500. }
  8501. },
  8502. "/user/stopwatches": {
  8503. "get": {
  8504. "consumes": [
  8505. "application/json"
  8506. ],
  8507. "produces": [
  8508. "application/json"
  8509. ],
  8510. "tags": [
  8511. "user"
  8512. ],
  8513. "summary": "Get list of all existing stopwatches",
  8514. "operationId": "userGetStopWatches",
  8515. "parameters": [
  8516. {
  8517. "type": "integer",
  8518. "description": "page number of results to return (1-based)",
  8519. "name": "page",
  8520. "in": "query"
  8521. },
  8522. {
  8523. "type": "integer",
  8524. "description": "page size of results, maximum page size is 50",
  8525. "name": "limit",
  8526. "in": "query"
  8527. }
  8528. ],
  8529. "responses": {
  8530. "200": {
  8531. "$ref": "#/responses/StopWatchList"
  8532. }
  8533. }
  8534. }
  8535. },
  8536. "/user/subscriptions": {
  8537. "get": {
  8538. "produces": [
  8539. "application/json"
  8540. ],
  8541. "tags": [
  8542. "user"
  8543. ],
  8544. "summary": "List repositories watched by the authenticated user",
  8545. "operationId": "userCurrentListSubscriptions",
  8546. "parameters": [
  8547. {
  8548. "type": "integer",
  8549. "description": "page number of results to return (1-based)",
  8550. "name": "page",
  8551. "in": "query"
  8552. },
  8553. {
  8554. "type": "integer",
  8555. "description": "page size of results, maximum page size is 50",
  8556. "name": "limit",
  8557. "in": "query"
  8558. }
  8559. ],
  8560. "responses": {
  8561. "200": {
  8562. "$ref": "#/responses/RepositoryList"
  8563. }
  8564. }
  8565. }
  8566. },
  8567. "/user/teams": {
  8568. "get": {
  8569. "produces": [
  8570. "application/json"
  8571. ],
  8572. "tags": [
  8573. "user"
  8574. ],
  8575. "summary": "List all the teams a user belongs to",
  8576. "operationId": "userListTeams",
  8577. "parameters": [
  8578. {
  8579. "type": "integer",
  8580. "description": "page number of results to return (1-based)",
  8581. "name": "page",
  8582. "in": "query"
  8583. },
  8584. {
  8585. "type": "integer",
  8586. "description": "page size of results, maximum page size is 50",
  8587. "name": "limit",
  8588. "in": "query"
  8589. }
  8590. ],
  8591. "responses": {
  8592. "200": {
  8593. "$ref": "#/responses/TeamList"
  8594. }
  8595. }
  8596. }
  8597. },
  8598. "/user/times": {
  8599. "get": {
  8600. "produces": [
  8601. "application/json"
  8602. ],
  8603. "tags": [
  8604. "user"
  8605. ],
  8606. "summary": "List the current user's tracked times",
  8607. "operationId": "userCurrentTrackedTimes",
  8608. "parameters": [
  8609. {
  8610. "type": "string",
  8611. "format": "date-time",
  8612. "description": "Only show times updated after the given time. This is a timestamp in RFC 3339 format",
  8613. "name": "since",
  8614. "in": "query"
  8615. },
  8616. {
  8617. "type": "string",
  8618. "format": "date-time",
  8619. "description": "Only show times updated before the given time. This is a timestamp in RFC 3339 format",
  8620. "name": "before",
  8621. "in": "query"
  8622. }
  8623. ],
  8624. "responses": {
  8625. "200": {
  8626. "$ref": "#/responses/TrackedTimeList"
  8627. }
  8628. }
  8629. }
  8630. },
  8631. "/users/search": {
  8632. "get": {
  8633. "produces": [
  8634. "application/json"
  8635. ],
  8636. "tags": [
  8637. "user"
  8638. ],
  8639. "summary": "Search for users",
  8640. "operationId": "userSearch",
  8641. "parameters": [
  8642. {
  8643. "type": "string",
  8644. "description": "keyword",
  8645. "name": "q",
  8646. "in": "query"
  8647. },
  8648. {
  8649. "type": "integer",
  8650. "format": "int64",
  8651. "description": "ID of the user to search for",
  8652. "name": "uid",
  8653. "in": "query"
  8654. },
  8655. {
  8656. "type": "integer",
  8657. "description": "page number of results to return (1-based)",
  8658. "name": "page",
  8659. "in": "query"
  8660. },
  8661. {
  8662. "type": "integer",
  8663. "description": "page size of results, maximum page size is 50",
  8664. "name": "limit",
  8665. "in": "query"
  8666. }
  8667. ],
  8668. "responses": {
  8669. "200": {
  8670. "description": "SearchResults of a successful search",
  8671. "schema": {
  8672. "type": "object",
  8673. "properties": {
  8674. "data": {
  8675. "type": "array",
  8676. "items": {
  8677. "$ref": "#/definitions/User"
  8678. }
  8679. },
  8680. "ok": {
  8681. "type": "boolean"
  8682. }
  8683. }
  8684. }
  8685. }
  8686. }
  8687. }
  8688. },
  8689. "/users/{follower}/following/{followee}": {
  8690. "get": {
  8691. "tags": [
  8692. "user"
  8693. ],
  8694. "summary": "Check if one user is following another user",
  8695. "operationId": "userCheckFollowing",
  8696. "parameters": [
  8697. {
  8698. "type": "string",
  8699. "description": "username of following user",
  8700. "name": "follower",
  8701. "in": "path",
  8702. "required": true
  8703. },
  8704. {
  8705. "type": "string",
  8706. "description": "username of followed user",
  8707. "name": "followee",
  8708. "in": "path",
  8709. "required": true
  8710. }
  8711. ],
  8712. "responses": {
  8713. "204": {
  8714. "$ref": "#/responses/empty"
  8715. },
  8716. "404": {
  8717. "$ref": "#/responses/notFound"
  8718. }
  8719. }
  8720. }
  8721. },
  8722. "/users/{username}": {
  8723. "get": {
  8724. "produces": [
  8725. "application/json"
  8726. ],
  8727. "tags": [
  8728. "user"
  8729. ],
  8730. "summary": "Get a user",
  8731. "operationId": "userGet",
  8732. "parameters": [
  8733. {
  8734. "type": "string",
  8735. "description": "username of user to get",
  8736. "name": "username",
  8737. "in": "path",
  8738. "required": true
  8739. }
  8740. ],
  8741. "responses": {
  8742. "200": {
  8743. "$ref": "#/responses/User"
  8744. },
  8745. "404": {
  8746. "$ref": "#/responses/notFound"
  8747. }
  8748. }
  8749. }
  8750. },
  8751. "/users/{username}/followers": {
  8752. "get": {
  8753. "produces": [
  8754. "application/json"
  8755. ],
  8756. "tags": [
  8757. "user"
  8758. ],
  8759. "summary": "List the given user's followers",
  8760. "operationId": "userListFollowers",
  8761. "parameters": [
  8762. {
  8763. "type": "string",
  8764. "description": "username of user",
  8765. "name": "username",
  8766. "in": "path",
  8767. "required": true
  8768. },
  8769. {
  8770. "type": "integer",
  8771. "description": "page number of results to return (1-based)",
  8772. "name": "page",
  8773. "in": "query"
  8774. },
  8775. {
  8776. "type": "integer",
  8777. "description": "page size of results, maximum page size is 50",
  8778. "name": "limit",
  8779. "in": "query"
  8780. }
  8781. ],
  8782. "responses": {
  8783. "200": {
  8784. "$ref": "#/responses/UserList"
  8785. }
  8786. }
  8787. }
  8788. },
  8789. "/users/{username}/following": {
  8790. "get": {
  8791. "produces": [
  8792. "application/json"
  8793. ],
  8794. "tags": [
  8795. "user"
  8796. ],
  8797. "summary": "List the users that the given user is following",
  8798. "operationId": "userListFollowing",
  8799. "parameters": [
  8800. {
  8801. "type": "string",
  8802. "description": "username of user",
  8803. "name": "username",
  8804. "in": "path",
  8805. "required": true
  8806. },
  8807. {
  8808. "type": "integer",
  8809. "description": "page number of results to return (1-based)",
  8810. "name": "page",
  8811. "in": "query"
  8812. },
  8813. {
  8814. "type": "integer",
  8815. "description": "page size of results, maximum page size is 50",
  8816. "name": "limit",
  8817. "in": "query"
  8818. }
  8819. ],
  8820. "responses": {
  8821. "200": {
  8822. "$ref": "#/responses/UserList"
  8823. }
  8824. }
  8825. }
  8826. },
  8827. "/users/{username}/gpg_keys": {
  8828. "get": {
  8829. "produces": [
  8830. "application/json"
  8831. ],
  8832. "tags": [
  8833. "user"
  8834. ],
  8835. "summary": "List the given user's GPG keys",
  8836. "operationId": "userListGPGKeys",
  8837. "parameters": [
  8838. {
  8839. "type": "string",
  8840. "description": "username of user",
  8841. "name": "username",
  8842. "in": "path",
  8843. "required": true
  8844. },
  8845. {
  8846. "type": "integer",
  8847. "description": "page number of results to return (1-based)",
  8848. "name": "page",
  8849. "in": "query"
  8850. },
  8851. {
  8852. "type": "integer",
  8853. "description": "page size of results, maximum page size is 50",
  8854. "name": "limit",
  8855. "in": "query"
  8856. }
  8857. ],
  8858. "responses": {
  8859. "200": {
  8860. "$ref": "#/responses/GPGKeyList"
  8861. }
  8862. }
  8863. }
  8864. },
  8865. "/users/{username}/heatmap": {
  8866. "get": {
  8867. "produces": [
  8868. "application/json"
  8869. ],
  8870. "tags": [
  8871. "user"
  8872. ],
  8873. "summary": "Get a user's heatmap",
  8874. "operationId": "userGetHeatmapData",
  8875. "parameters": [
  8876. {
  8877. "type": "string",
  8878. "description": "username of user to get",
  8879. "name": "username",
  8880. "in": "path",
  8881. "required": true
  8882. }
  8883. ],
  8884. "responses": {
  8885. "200": {
  8886. "$ref": "#/responses/UserHeatmapData"
  8887. },
  8888. "404": {
  8889. "$ref": "#/responses/notFound"
  8890. }
  8891. }
  8892. }
  8893. },
  8894. "/users/{username}/keys": {
  8895. "get": {
  8896. "produces": [
  8897. "application/json"
  8898. ],
  8899. "tags": [
  8900. "user"
  8901. ],
  8902. "summary": "List the given user's public keys",
  8903. "operationId": "userListKeys",
  8904. "parameters": [
  8905. {
  8906. "type": "string",
  8907. "description": "username of user",
  8908. "name": "username",
  8909. "in": "path",
  8910. "required": true
  8911. },
  8912. {
  8913. "type": "string",
  8914. "description": "fingerprint of the key",
  8915. "name": "fingerprint",
  8916. "in": "query"
  8917. },
  8918. {
  8919. "type": "integer",
  8920. "description": "page number of results to return (1-based)",
  8921. "name": "page",
  8922. "in": "query"
  8923. },
  8924. {
  8925. "type": "integer",
  8926. "description": "page size of results, maximum page size is 50",
  8927. "name": "limit",
  8928. "in": "query"
  8929. }
  8930. ],
  8931. "responses": {
  8932. "200": {
  8933. "$ref": "#/responses/PublicKeyList"
  8934. }
  8935. }
  8936. }
  8937. },
  8938. "/users/{username}/orgs": {
  8939. "get": {
  8940. "produces": [
  8941. "application/json"
  8942. ],
  8943. "tags": [
  8944. "organization"
  8945. ],
  8946. "summary": "List a user's organizations",
  8947. "operationId": "orgListUserOrgs",
  8948. "parameters": [
  8949. {
  8950. "type": "string",
  8951. "description": "username of user",
  8952. "name": "username",
  8953. "in": "path",
  8954. "required": true
  8955. },
  8956. {
  8957. "type": "integer",
  8958. "description": "page number of results to return (1-based)",
  8959. "name": "page",
  8960. "in": "query"
  8961. },
  8962. {
  8963. "type": "integer",
  8964. "description": "page size of results, maximum page size is 50",
  8965. "name": "limit",
  8966. "in": "query"
  8967. }
  8968. ],
  8969. "responses": {
  8970. "200": {
  8971. "$ref": "#/responses/OrganizationList"
  8972. }
  8973. }
  8974. }
  8975. },
  8976. "/users/{username}/repos": {
  8977. "get": {
  8978. "produces": [
  8979. "application/json"
  8980. ],
  8981. "tags": [
  8982. "user"
  8983. ],
  8984. "summary": "List the repos owned by the given user",
  8985. "operationId": "userListRepos",
  8986. "parameters": [
  8987. {
  8988. "type": "string",
  8989. "description": "username of user",
  8990. "name": "username",
  8991. "in": "path",
  8992. "required": true
  8993. },
  8994. {
  8995. "type": "integer",
  8996. "description": "page number of results to return (1-based)",
  8997. "name": "page",
  8998. "in": "query"
  8999. },
  9000. {
  9001. "type": "integer",
  9002. "description": "page size of results, maximum page size is 50",
  9003. "name": "limit",
  9004. "in": "query"
  9005. }
  9006. ],
  9007. "responses": {
  9008. "200": {
  9009. "$ref": "#/responses/RepositoryList"
  9010. }
  9011. }
  9012. }
  9013. },
  9014. "/users/{username}/starred": {
  9015. "get": {
  9016. "produces": [
  9017. "application/json"
  9018. ],
  9019. "tags": [
  9020. "user"
  9021. ],
  9022. "summary": "The repos that the given user has starred",
  9023. "operationId": "userListStarred",
  9024. "parameters": [
  9025. {
  9026. "type": "string",
  9027. "description": "username of user",
  9028. "name": "username",
  9029. "in": "path",
  9030. "required": true
  9031. },
  9032. {
  9033. "type": "integer",
  9034. "description": "page number of results to return (1-based)",
  9035. "name": "page",
  9036. "in": "query"
  9037. },
  9038. {
  9039. "type": "integer",
  9040. "description": "page size of results, maximum page size is 50",
  9041. "name": "limit",
  9042. "in": "query"
  9043. }
  9044. ],
  9045. "responses": {
  9046. "200": {
  9047. "$ref": "#/responses/RepositoryList"
  9048. }
  9049. }
  9050. }
  9051. },
  9052. "/users/{username}/subscriptions": {
  9053. "get": {
  9054. "produces": [
  9055. "application/json"
  9056. ],
  9057. "tags": [
  9058. "user"
  9059. ],
  9060. "summary": "List the repositories watched by a user",
  9061. "operationId": "userListSubscriptions",
  9062. "parameters": [
  9063. {
  9064. "type": "string",
  9065. "description": "username of the user",
  9066. "name": "username",
  9067. "in": "path",
  9068. "required": true
  9069. },
  9070. {
  9071. "type": "integer",
  9072. "description": "page number of results to return (1-based)",
  9073. "name": "page",
  9074. "in": "query"
  9075. },
  9076. {
  9077. "type": "integer",
  9078. "description": "page size of results, maximum page size is 50",
  9079. "name": "limit",
  9080. "in": "query"
  9081. }
  9082. ],
  9083. "responses": {
  9084. "200": {
  9085. "$ref": "#/responses/RepositoryList"
  9086. }
  9087. }
  9088. }
  9089. },
  9090. "/users/{username}/tokens": {
  9091. "get": {
  9092. "produces": [
  9093. "application/json"
  9094. ],
  9095. "tags": [
  9096. "user"
  9097. ],
  9098. "summary": "List the authenticated user's access tokens",
  9099. "operationId": "userGetTokens",
  9100. "parameters": [
  9101. {
  9102. "type": "string",
  9103. "description": "username of user",
  9104. "name": "username",
  9105. "in": "path",
  9106. "required": true
  9107. },
  9108. {
  9109. "type": "integer",
  9110. "description": "page number of results to return (1-based)",
  9111. "name": "page",
  9112. "in": "query"
  9113. },
  9114. {
  9115. "type": "integer",
  9116. "description": "page size of results, maximum page size is 50",
  9117. "name": "limit",
  9118. "in": "query"
  9119. }
  9120. ],
  9121. "responses": {
  9122. "200": {
  9123. "$ref": "#/responses/AccessTokenList"
  9124. }
  9125. }
  9126. },
  9127. "post": {
  9128. "consumes": [
  9129. "application/json"
  9130. ],
  9131. "produces": [
  9132. "application/json"
  9133. ],
  9134. "tags": [
  9135. "user"
  9136. ],
  9137. "summary": "Create an access token",
  9138. "operationId": "userCreateToken",
  9139. "parameters": [
  9140. {
  9141. "type": "string",
  9142. "x-go-name": "Name",
  9143. "description": "username of user",
  9144. "name": "username",
  9145. "in": "path",
  9146. "required": true
  9147. },
  9148. {
  9149. "name": "accessToken",
  9150. "in": "body",
  9151. "schema": {
  9152. "type": "object",
  9153. "required": [
  9154. "name"
  9155. ],
  9156. "properties": {
  9157. "name": {
  9158. "type": "string"
  9159. }
  9160. }
  9161. }
  9162. }
  9163. ],
  9164. "responses": {
  9165. "200": {
  9166. "$ref": "#/responses/AccessToken"
  9167. }
  9168. }
  9169. }
  9170. },
  9171. "/users/{username}/tokens/{token}": {
  9172. "delete": {
  9173. "produces": [
  9174. "application/json"
  9175. ],
  9176. "tags": [
  9177. "user"
  9178. ],
  9179. "summary": "delete an access token",
  9180. "operationId": "userDeleteAccessToken",
  9181. "parameters": [
  9182. {
  9183. "type": "string",
  9184. "description": "username of user",
  9185. "name": "username",
  9186. "in": "path",
  9187. "required": true
  9188. },
  9189. {
  9190. "type": "integer",
  9191. "format": "int64",
  9192. "description": "token to be deleted",
  9193. "name": "token",
  9194. "in": "path",
  9195. "required": true
  9196. }
  9197. ],
  9198. "responses": {
  9199. "204": {
  9200. "$ref": "#/responses/empty"
  9201. }
  9202. }
  9203. }
  9204. },
  9205. "/version": {
  9206. "get": {
  9207. "produces": [
  9208. "application/json"
  9209. ],
  9210. "tags": [
  9211. "miscellaneous"
  9212. ],
  9213. "summary": "Returns the version of the Gitea application",
  9214. "operationId": "getVersion",
  9215. "responses": {
  9216. "200": {
  9217. "$ref": "#/responses/ServerVersion"
  9218. }
  9219. }
  9220. }
  9221. }
  9222. },
  9223. "definitions": {
  9224. "APIError": {
  9225. "description": "APIError is an api error with a message",
  9226. "type": "object",
  9227. "properties": {
  9228. "message": {
  9229. "type": "string",
  9230. "x-go-name": "Message"
  9231. },
  9232. "url": {
  9233. "type": "string",
  9234. "x-go-name": "URL"
  9235. }
  9236. },
  9237. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9238. },
  9239. "AccessToken": {
  9240. "type": "object",
  9241. "title": "AccessToken represents an API access token.",
  9242. "properties": {
  9243. "id": {
  9244. "type": "integer",
  9245. "format": "int64",
  9246. "x-go-name": "ID"
  9247. },
  9248. "name": {
  9249. "type": "string",
  9250. "x-go-name": "Name"
  9251. },
  9252. "sha1": {
  9253. "type": "string",
  9254. "x-go-name": "Token"
  9255. },
  9256. "token_last_eight": {
  9257. "type": "string",
  9258. "x-go-name": "TokenLastEight"
  9259. }
  9260. },
  9261. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9262. },
  9263. "AddCollaboratorOption": {
  9264. "description": "AddCollaboratorOption options when adding a user as a collaborator of a repository",
  9265. "type": "object",
  9266. "properties": {
  9267. "permission": {
  9268. "type": "string",
  9269. "x-go-name": "Permission"
  9270. }
  9271. },
  9272. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9273. },
  9274. "AddTimeOption": {
  9275. "description": "AddTimeOption options for adding time to an issue",
  9276. "type": "object",
  9277. "required": [
  9278. "time"
  9279. ],
  9280. "properties": {
  9281. "created": {
  9282. "type": "string",
  9283. "format": "date-time",
  9284. "x-go-name": "Created"
  9285. },
  9286. "time": {
  9287. "description": "time in seconds",
  9288. "type": "integer",
  9289. "format": "int64",
  9290. "x-go-name": "Time"
  9291. },
  9292. "user_name": {
  9293. "description": "User who spent the time (optional)",
  9294. "type": "string",
  9295. "x-go-name": "User"
  9296. }
  9297. },
  9298. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9299. },
  9300. "AnnotatedTag": {
  9301. "description": "AnnotatedTag represents an annotated tag",
  9302. "type": "object",
  9303. "properties": {
  9304. "message": {
  9305. "type": "string",
  9306. "x-go-name": "Message"
  9307. },
  9308. "object": {
  9309. "$ref": "#/definitions/AnnotatedTagObject"
  9310. },
  9311. "sha": {
  9312. "type": "string",
  9313. "x-go-name": "SHA"
  9314. },
  9315. "tag": {
  9316. "type": "string",
  9317. "x-go-name": "Tag"
  9318. },
  9319. "tagger": {
  9320. "$ref": "#/definitions/CommitUser"
  9321. },
  9322. "url": {
  9323. "type": "string",
  9324. "x-go-name": "URL"
  9325. },
  9326. "verification": {
  9327. "$ref": "#/definitions/PayloadCommitVerification"
  9328. }
  9329. },
  9330. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9331. },
  9332. "AnnotatedTagObject": {
  9333. "description": "AnnotatedTagObject contains meta information of the tag object",
  9334. "type": "object",
  9335. "properties": {
  9336. "sha": {
  9337. "type": "string",
  9338. "x-go-name": "SHA"
  9339. },
  9340. "type": {
  9341. "type": "string",
  9342. "x-go-name": "Type"
  9343. },
  9344. "url": {
  9345. "type": "string",
  9346. "x-go-name": "URL"
  9347. }
  9348. },
  9349. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9350. },
  9351. "Attachment": {
  9352. "description": "Attachment a generic attachment",
  9353. "type": "object",
  9354. "properties": {
  9355. "browser_download_url": {
  9356. "type": "string",
  9357. "x-go-name": "DownloadURL"
  9358. },
  9359. "created_at": {
  9360. "type": "string",
  9361. "format": "date-time",
  9362. "x-go-name": "Created"
  9363. },
  9364. "download_count": {
  9365. "type": "integer",
  9366. "format": "int64",
  9367. "x-go-name": "DownloadCount"
  9368. },
  9369. "id": {
  9370. "type": "integer",
  9371. "format": "int64",
  9372. "x-go-name": "ID"
  9373. },
  9374. "name": {
  9375. "type": "string",
  9376. "x-go-name": "Name"
  9377. },
  9378. "size": {
  9379. "type": "integer",
  9380. "format": "int64",
  9381. "x-go-name": "Size"
  9382. },
  9383. "uuid": {
  9384. "type": "string",
  9385. "x-go-name": "UUID"
  9386. }
  9387. },
  9388. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9389. },
  9390. "Branch": {
  9391. "description": "Branch represents a repository branch",
  9392. "type": "object",
  9393. "properties": {
  9394. "commit": {
  9395. "$ref": "#/definitions/PayloadCommit"
  9396. },
  9397. "enable_status_check": {
  9398. "type": "boolean",
  9399. "x-go-name": "EnableStatusCheck"
  9400. },
  9401. "name": {
  9402. "type": "string",
  9403. "x-go-name": "Name"
  9404. },
  9405. "protected": {
  9406. "type": "boolean",
  9407. "x-go-name": "Protected"
  9408. },
  9409. "required_approvals": {
  9410. "type": "integer",
  9411. "format": "int64",
  9412. "x-go-name": "RequiredApprovals"
  9413. },
  9414. "status_check_contexts": {
  9415. "type": "array",
  9416. "items": {
  9417. "type": "string"
  9418. },
  9419. "x-go-name": "StatusCheckContexts"
  9420. },
  9421. "user_can_merge": {
  9422. "type": "boolean",
  9423. "x-go-name": "UserCanMerge"
  9424. },
  9425. "user_can_push": {
  9426. "type": "boolean",
  9427. "x-go-name": "UserCanPush"
  9428. }
  9429. },
  9430. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9431. },
  9432. "Comment": {
  9433. "description": "Comment represents a comment on a commit or issue",
  9434. "type": "object",
  9435. "properties": {
  9436. "body": {
  9437. "type": "string",
  9438. "x-go-name": "Body"
  9439. },
  9440. "created_at": {
  9441. "type": "string",
  9442. "format": "date-time",
  9443. "x-go-name": "Created"
  9444. },
  9445. "html_url": {
  9446. "type": "string",
  9447. "x-go-name": "HTMLURL"
  9448. },
  9449. "id": {
  9450. "type": "integer",
  9451. "format": "int64",
  9452. "x-go-name": "ID"
  9453. },
  9454. "issue_url": {
  9455. "type": "string",
  9456. "x-go-name": "IssueURL"
  9457. },
  9458. "original_author": {
  9459. "type": "string",
  9460. "x-go-name": "OriginalAuthor"
  9461. },
  9462. "original_author_id": {
  9463. "type": "integer",
  9464. "format": "int64",
  9465. "x-go-name": "OriginalAuthorID"
  9466. },
  9467. "pull_request_url": {
  9468. "type": "string",
  9469. "x-go-name": "PRURL"
  9470. },
  9471. "updated_at": {
  9472. "type": "string",
  9473. "format": "date-time",
  9474. "x-go-name": "Updated"
  9475. },
  9476. "user": {
  9477. "$ref": "#/definitions/User"
  9478. }
  9479. },
  9480. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9481. },
  9482. "Commit": {
  9483. "type": "object",
  9484. "title": "Commit contains information generated from a Git commit.",
  9485. "properties": {
  9486. "author": {
  9487. "$ref": "#/definitions/User"
  9488. },
  9489. "commit": {
  9490. "$ref": "#/definitions/RepoCommit"
  9491. },
  9492. "committer": {
  9493. "$ref": "#/definitions/User"
  9494. },
  9495. "html_url": {
  9496. "type": "string",
  9497. "x-go-name": "HTMLURL"
  9498. },
  9499. "parents": {
  9500. "type": "array",
  9501. "items": {
  9502. "$ref": "#/definitions/CommitMeta"
  9503. },
  9504. "x-go-name": "Parents"
  9505. },
  9506. "sha": {
  9507. "type": "string",
  9508. "x-go-name": "SHA"
  9509. },
  9510. "url": {
  9511. "type": "string",
  9512. "x-go-name": "URL"
  9513. }
  9514. },
  9515. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9516. },
  9517. "CommitDateOptions": {
  9518. "description": "CommitDateOptions store dates for GIT_AUTHOR_DATE and GIT_COMMITTER_DATE",
  9519. "type": "object",
  9520. "properties": {
  9521. "author": {
  9522. "type": "string",
  9523. "format": "date-time",
  9524. "x-go-name": "Author"
  9525. },
  9526. "committer": {
  9527. "type": "string",
  9528. "format": "date-time",
  9529. "x-go-name": "Committer"
  9530. }
  9531. },
  9532. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9533. },
  9534. "CommitMeta": {
  9535. "type": "object",
  9536. "title": "CommitMeta contains meta information of a commit in terms of API.",
  9537. "properties": {
  9538. "sha": {
  9539. "type": "string",
  9540. "x-go-name": "SHA"
  9541. },
  9542. "url": {
  9543. "type": "string",
  9544. "x-go-name": "URL"
  9545. }
  9546. },
  9547. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9548. },
  9549. "CommitUser": {
  9550. "type": "object",
  9551. "title": "CommitUser contains information of a user in the context of a commit.",
  9552. "properties": {
  9553. "date": {
  9554. "type": "string",
  9555. "x-go-name": "Date"
  9556. },
  9557. "email": {
  9558. "type": "string",
  9559. "format": "email",
  9560. "x-go-name": "Email"
  9561. },
  9562. "name": {
  9563. "type": "string",
  9564. "x-go-name": "Name"
  9565. }
  9566. },
  9567. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9568. },
  9569. "ContentsResponse": {
  9570. "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  9571. "type": "object",
  9572. "properties": {
  9573. "_links": {
  9574. "$ref": "#/definitions/FileLinksResponse"
  9575. },
  9576. "content": {
  9577. "description": "`content` is populated when `type` is `file`, otherwise null",
  9578. "type": "string",
  9579. "x-go-name": "Content"
  9580. },
  9581. "download_url": {
  9582. "type": "string",
  9583. "x-go-name": "DownloadURL"
  9584. },
  9585. "encoding": {
  9586. "description": "`encoding` is populated when `type` is `file`, otherwise null",
  9587. "type": "string",
  9588. "x-go-name": "Encoding"
  9589. },
  9590. "git_url": {
  9591. "type": "string",
  9592. "x-go-name": "GitURL"
  9593. },
  9594. "html_url": {
  9595. "type": "string",
  9596. "x-go-name": "HTMLURL"
  9597. },
  9598. "name": {
  9599. "type": "string",
  9600. "x-go-name": "Name"
  9601. },
  9602. "path": {
  9603. "type": "string",
  9604. "x-go-name": "Path"
  9605. },
  9606. "sha": {
  9607. "type": "string",
  9608. "x-go-name": "SHA"
  9609. },
  9610. "size": {
  9611. "type": "integer",
  9612. "format": "int64",
  9613. "x-go-name": "Size"
  9614. },
  9615. "submodule_git_url": {
  9616. "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
  9617. "type": "string",
  9618. "x-go-name": "SubmoduleGitURL"
  9619. },
  9620. "target": {
  9621. "description": "`target` is populated when `type` is `symlink`, otherwise null",
  9622. "type": "string",
  9623. "x-go-name": "Target"
  9624. },
  9625. "type": {
  9626. "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
  9627. "type": "string",
  9628. "x-go-name": "Type"
  9629. },
  9630. "url": {
  9631. "type": "string",
  9632. "x-go-name": "URL"
  9633. }
  9634. },
  9635. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9636. },
  9637. "CreateEmailOption": {
  9638. "description": "CreateEmailOption options when creating email addresses",
  9639. "type": "object",
  9640. "properties": {
  9641. "emails": {
  9642. "description": "email addresses to add",
  9643. "type": "array",
  9644. "items": {
  9645. "type": "string"
  9646. },
  9647. "x-go-name": "Emails"
  9648. }
  9649. },
  9650. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9651. },
  9652. "CreateFileOptions": {
  9653. "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)",
  9654. "type": "object",
  9655. "required": [
  9656. "content"
  9657. ],
  9658. "properties": {
  9659. "author": {
  9660. "$ref": "#/definitions/Identity"
  9661. },
  9662. "branch": {
  9663. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  9664. "type": "string",
  9665. "x-go-name": "BranchName"
  9666. },
  9667. "committer": {
  9668. "$ref": "#/definitions/Identity"
  9669. },
  9670. "content": {
  9671. "description": "content must be base64 encoded",
  9672. "type": "string",
  9673. "x-go-name": "Content"
  9674. },
  9675. "dates": {
  9676. "$ref": "#/definitions/CommitDateOptions"
  9677. },
  9678. "message": {
  9679. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  9680. "type": "string",
  9681. "x-go-name": "Message"
  9682. },
  9683. "new_branch": {
  9684. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  9685. "type": "string",
  9686. "x-go-name": "NewBranchName"
  9687. }
  9688. },
  9689. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9690. },
  9691. "CreateForkOption": {
  9692. "description": "CreateForkOption options for creating a fork",
  9693. "type": "object",
  9694. "properties": {
  9695. "organization": {
  9696. "description": "organization name, if forking into an organization",
  9697. "type": "string",
  9698. "x-go-name": "Organization"
  9699. }
  9700. },
  9701. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9702. },
  9703. "CreateGPGKeyOption": {
  9704. "description": "CreateGPGKeyOption options create user GPG key",
  9705. "type": "object",
  9706. "required": [
  9707. "armored_public_key"
  9708. ],
  9709. "properties": {
  9710. "armored_public_key": {
  9711. "description": "An armored GPG key to add",
  9712. "type": "string",
  9713. "uniqueItems": true,
  9714. "x-go-name": "ArmoredKey"
  9715. }
  9716. },
  9717. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9718. },
  9719. "CreateHookOption": {
  9720. "description": "CreateHookOption options when create a hook",
  9721. "type": "object",
  9722. "required": [
  9723. "type",
  9724. "config"
  9725. ],
  9726. "properties": {
  9727. "active": {
  9728. "type": "boolean",
  9729. "default": false,
  9730. "x-go-name": "Active"
  9731. },
  9732. "branch_filter": {
  9733. "type": "string",
  9734. "x-go-name": "BranchFilter"
  9735. },
  9736. "config": {
  9737. "$ref": "#/definitions/CreateHookOptionConfig"
  9738. },
  9739. "events": {
  9740. "type": "array",
  9741. "items": {
  9742. "type": "string"
  9743. },
  9744. "x-go-name": "Events"
  9745. },
  9746. "type": {
  9747. "type": "string",
  9748. "enum": [
  9749. "dingtalk",
  9750. "discord",
  9751. "gitea",
  9752. "gogs",
  9753. "msteams",
  9754. "slack",
  9755. "telegram",
  9756. "feishu"
  9757. ],
  9758. "x-go-name": "Type"
  9759. }
  9760. },
  9761. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9762. },
  9763. "CreateHookOptionConfig": {
  9764. "description": "CreateHookOptionConfig has all config options in it\nrequired are \"content_type\" and \"url\" Required",
  9765. "type": "object",
  9766. "additionalProperties": {
  9767. "type": "string"
  9768. },
  9769. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9770. },
  9771. "CreateIssueCommentOption": {
  9772. "description": "CreateIssueCommentOption options for creating a comment on an issue",
  9773. "type": "object",
  9774. "required": [
  9775. "body"
  9776. ],
  9777. "properties": {
  9778. "body": {
  9779. "type": "string",
  9780. "x-go-name": "Body"
  9781. }
  9782. },
  9783. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9784. },
  9785. "CreateIssueOption": {
  9786. "description": "CreateIssueOption options to create one issue",
  9787. "type": "object",
  9788. "required": [
  9789. "title"
  9790. ],
  9791. "properties": {
  9792. "assignee": {
  9793. "description": "username of assignee",
  9794. "type": "string",
  9795. "x-go-name": "Assignee"
  9796. },
  9797. "assignees": {
  9798. "type": "array",
  9799. "items": {
  9800. "type": "string"
  9801. },
  9802. "x-go-name": "Assignees"
  9803. },
  9804. "body": {
  9805. "type": "string",
  9806. "x-go-name": "Body"
  9807. },
  9808. "closed": {
  9809. "type": "boolean",
  9810. "x-go-name": "Closed"
  9811. },
  9812. "due_date": {
  9813. "type": "string",
  9814. "format": "date-time",
  9815. "x-go-name": "Deadline"
  9816. },
  9817. "labels": {
  9818. "description": "list of label ids",
  9819. "type": "array",
  9820. "items": {
  9821. "type": "integer",
  9822. "format": "int64"
  9823. },
  9824. "x-go-name": "Labels"
  9825. },
  9826. "milestone": {
  9827. "description": "milestone id",
  9828. "type": "integer",
  9829. "format": "int64",
  9830. "x-go-name": "Milestone"
  9831. },
  9832. "title": {
  9833. "type": "string",
  9834. "x-go-name": "Title"
  9835. }
  9836. },
  9837. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9838. },
  9839. "CreateKeyOption": {
  9840. "description": "CreateKeyOption options when creating a key",
  9841. "type": "object",
  9842. "required": [
  9843. "title",
  9844. "key"
  9845. ],
  9846. "properties": {
  9847. "key": {
  9848. "description": "An armored SSH key to add",
  9849. "type": "string",
  9850. "uniqueItems": true,
  9851. "x-go-name": "Key"
  9852. },
  9853. "read_only": {
  9854. "description": "Describe if the key has only read access or read/write",
  9855. "type": "boolean",
  9856. "x-go-name": "ReadOnly"
  9857. },
  9858. "title": {
  9859. "description": "Title of the key to add",
  9860. "type": "string",
  9861. "uniqueItems": true,
  9862. "x-go-name": "Title"
  9863. }
  9864. },
  9865. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9866. },
  9867. "CreateLabelOption": {
  9868. "description": "CreateLabelOption options for creating a label",
  9869. "type": "object",
  9870. "required": [
  9871. "name",
  9872. "color"
  9873. ],
  9874. "properties": {
  9875. "color": {
  9876. "type": "string",
  9877. "x-go-name": "Color",
  9878. "example": "#00aabb"
  9879. },
  9880. "description": {
  9881. "type": "string",
  9882. "x-go-name": "Description"
  9883. },
  9884. "name": {
  9885. "type": "string",
  9886. "x-go-name": "Name"
  9887. }
  9888. },
  9889. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9890. },
  9891. "CreateMilestoneOption": {
  9892. "description": "CreateMilestoneOption options for creating a milestone",
  9893. "type": "object",
  9894. "properties": {
  9895. "description": {
  9896. "type": "string",
  9897. "x-go-name": "Description"
  9898. },
  9899. "due_on": {
  9900. "type": "string",
  9901. "format": "date-time",
  9902. "x-go-name": "Deadline"
  9903. },
  9904. "title": {
  9905. "type": "string",
  9906. "x-go-name": "Title"
  9907. }
  9908. },
  9909. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9910. },
  9911. "CreateOrgOption": {
  9912. "description": "CreateOrgOption options for creating an organization",
  9913. "type": "object",
  9914. "required": [
  9915. "username"
  9916. ],
  9917. "properties": {
  9918. "description": {
  9919. "type": "string",
  9920. "x-go-name": "Description"
  9921. },
  9922. "full_name": {
  9923. "type": "string",
  9924. "x-go-name": "FullName"
  9925. },
  9926. "location": {
  9927. "type": "string",
  9928. "x-go-name": "Location"
  9929. },
  9930. "repo_admin_change_team_access": {
  9931. "type": "boolean",
  9932. "x-go-name": "RepoAdminChangeTeamAccess"
  9933. },
  9934. "username": {
  9935. "type": "string",
  9936. "x-go-name": "UserName"
  9937. },
  9938. "visibility": {
  9939. "description": "possible values are `public` (default), `limited` or `private`",
  9940. "type": "string",
  9941. "enum": [
  9942. "public",
  9943. "limited",
  9944. "private"
  9945. ],
  9946. "x-go-name": "Visibility"
  9947. },
  9948. "website": {
  9949. "type": "string",
  9950. "x-go-name": "Website"
  9951. }
  9952. },
  9953. "x-go-package": "code.gitea.io/gitea/modules/structs"
  9954. },
  9955. "CreatePullRequestOption": {
  9956. "description": "CreatePullRequestOption options when creating a pull request",
  9957. "type": "object",
  9958. "properties": {
  9959. "assignee": {
  9960. "type": "string",
  9961. "x-go-name": "Assignee"
  9962. },
  9963. "assignees": {
  9964. "type": "array",
  9965. "items": {
  9966. "type": "string"
  9967. },
  9968. "x-go-name": "Assignees"
  9969. },
  9970. "base": {
  9971. "type": "string",
  9972. "x-go-name": "Base"
  9973. },
  9974. "body": {
  9975. "type": "string",
  9976. "x-go-name": "Body"
  9977. },
  9978. "due_date": {
  9979. "type": "string",
  9980. "format": "date-time",
  9981. "x-go-name": "Deadline"
  9982. },
  9983. "head": {
  9984. "type": "string",
  9985. "x-go-name": "Head"
  9986. },
  9987. "labels": {
  9988. "type": "array",
  9989. "items": {
  9990. "type": "integer",
  9991. "format": "int64"
  9992. },
  9993. "x-go-name": "Labels"
  9994. },
  9995. "milestone": {
  9996. "type": "integer",
  9997. "format": "int64",
  9998. "x-go-name": "Milestone"
  9999. },
  10000. "title": {
  10001. "type": "string",
  10002. "x-go-name": "Title"
  10003. }
  10004. },
  10005. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10006. },
  10007. "CreateReleaseOption": {
  10008. "description": "CreateReleaseOption options when creating a release",
  10009. "type": "object",
  10010. "required": [
  10011. "tag_name"
  10012. ],
  10013. "properties": {
  10014. "body": {
  10015. "type": "string",
  10016. "x-go-name": "Note"
  10017. },
  10018. "draft": {
  10019. "type": "boolean",
  10020. "x-go-name": "IsDraft"
  10021. },
  10022. "name": {
  10023. "type": "string",
  10024. "x-go-name": "Title"
  10025. },
  10026. "prerelease": {
  10027. "type": "boolean",
  10028. "x-go-name": "IsPrerelease"
  10029. },
  10030. "tag_name": {
  10031. "type": "string",
  10032. "x-go-name": "TagName"
  10033. },
  10034. "target_commitish": {
  10035. "type": "string",
  10036. "x-go-name": "Target"
  10037. }
  10038. },
  10039. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10040. },
  10041. "CreateRepoOption": {
  10042. "description": "CreateRepoOption options when creating repository",
  10043. "type": "object",
  10044. "required": [
  10045. "name"
  10046. ],
  10047. "properties": {
  10048. "auto_init": {
  10049. "description": "Whether the repository should be auto-intialized?",
  10050. "type": "boolean",
  10051. "x-go-name": "AutoInit"
  10052. },
  10053. "description": {
  10054. "description": "Description of the repository to create",
  10055. "type": "string",
  10056. "x-go-name": "Description"
  10057. },
  10058. "gitignores": {
  10059. "description": "Gitignores to use",
  10060. "type": "string",
  10061. "x-go-name": "Gitignores"
  10062. },
  10063. "issue_labels": {
  10064. "description": "Issue Label set to use",
  10065. "type": "string",
  10066. "x-go-name": "IssueLabels"
  10067. },
  10068. "license": {
  10069. "description": "License to use",
  10070. "type": "string",
  10071. "x-go-name": "License"
  10072. },
  10073. "name": {
  10074. "description": "Name of the repository to create",
  10075. "type": "string",
  10076. "uniqueItems": true,
  10077. "x-go-name": "Name"
  10078. },
  10079. "private": {
  10080. "description": "Whether the repository is private",
  10081. "type": "boolean",
  10082. "x-go-name": "Private"
  10083. },
  10084. "readme": {
  10085. "description": "Readme of the repository to create",
  10086. "type": "string",
  10087. "x-go-name": "Readme"
  10088. }
  10089. },
  10090. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10091. },
  10092. "CreateStatusOption": {
  10093. "description": "CreateStatusOption holds the information needed to create a new Status for a Commit",
  10094. "type": "object",
  10095. "properties": {
  10096. "context": {
  10097. "type": "string",
  10098. "x-go-name": "Context"
  10099. },
  10100. "description": {
  10101. "type": "string",
  10102. "x-go-name": "Description"
  10103. },
  10104. "state": {
  10105. "$ref": "#/definitions/StatusState"
  10106. },
  10107. "target_url": {
  10108. "type": "string",
  10109. "x-go-name": "TargetURL"
  10110. }
  10111. },
  10112. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10113. },
  10114. "CreateTeamOption": {
  10115. "description": "CreateTeamOption options for creating a team",
  10116. "type": "object",
  10117. "required": [
  10118. "name"
  10119. ],
  10120. "properties": {
  10121. "can_create_org_repo": {
  10122. "type": "boolean",
  10123. "x-go-name": "CanCreateOrgRepo"
  10124. },
  10125. "description": {
  10126. "type": "string",
  10127. "x-go-name": "Description"
  10128. },
  10129. "includes_all_repositories": {
  10130. "type": "boolean",
  10131. "x-go-name": "IncludesAllRepositories"
  10132. },
  10133. "name": {
  10134. "type": "string",
  10135. "x-go-name": "Name"
  10136. },
  10137. "permission": {
  10138. "type": "string",
  10139. "enum": [
  10140. "read",
  10141. "write",
  10142. "admin"
  10143. ],
  10144. "x-go-name": "Permission"
  10145. },
  10146. "units": {
  10147. "type": "array",
  10148. "items": {
  10149. "type": "string"
  10150. },
  10151. "x-go-name": "Units",
  10152. "example": [
  10153. "repo.code",
  10154. "repo.issues",
  10155. "repo.ext_issues",
  10156. "repo.wiki",
  10157. "repo.pulls",
  10158. "repo.releases",
  10159. "repo.ext_wiki"
  10160. ]
  10161. }
  10162. },
  10163. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10164. },
  10165. "CreateUserOption": {
  10166. "description": "CreateUserOption create user options",
  10167. "type": "object",
  10168. "required": [
  10169. "username",
  10170. "email",
  10171. "password"
  10172. ],
  10173. "properties": {
  10174. "email": {
  10175. "type": "string",
  10176. "format": "email",
  10177. "x-go-name": "Email"
  10178. },
  10179. "full_name": {
  10180. "type": "string",
  10181. "x-go-name": "FullName"
  10182. },
  10183. "login_name": {
  10184. "type": "string",
  10185. "x-go-name": "LoginName"
  10186. },
  10187. "must_change_password": {
  10188. "type": "boolean",
  10189. "x-go-name": "MustChangePassword"
  10190. },
  10191. "password": {
  10192. "type": "string",
  10193. "x-go-name": "Password"
  10194. },
  10195. "send_notify": {
  10196. "type": "boolean",
  10197. "x-go-name": "SendNotify"
  10198. },
  10199. "source_id": {
  10200. "type": "integer",
  10201. "format": "int64",
  10202. "x-go-name": "SourceID"
  10203. },
  10204. "username": {
  10205. "type": "string",
  10206. "x-go-name": "Username"
  10207. }
  10208. },
  10209. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10210. },
  10211. "DeleteEmailOption": {
  10212. "description": "DeleteEmailOption options when deleting email addresses",
  10213. "type": "object",
  10214. "properties": {
  10215. "emails": {
  10216. "description": "email addresses to delete",
  10217. "type": "array",
  10218. "items": {
  10219. "type": "string"
  10220. },
  10221. "x-go-name": "Emails"
  10222. }
  10223. },
  10224. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10225. },
  10226. "DeleteFileOptions": {
  10227. "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)",
  10228. "type": "object",
  10229. "required": [
  10230. "sha"
  10231. ],
  10232. "properties": {
  10233. "author": {
  10234. "$ref": "#/definitions/Identity"
  10235. },
  10236. "branch": {
  10237. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  10238. "type": "string",
  10239. "x-go-name": "BranchName"
  10240. },
  10241. "committer": {
  10242. "$ref": "#/definitions/Identity"
  10243. },
  10244. "dates": {
  10245. "$ref": "#/definitions/CommitDateOptions"
  10246. },
  10247. "message": {
  10248. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  10249. "type": "string",
  10250. "x-go-name": "Message"
  10251. },
  10252. "new_branch": {
  10253. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  10254. "type": "string",
  10255. "x-go-name": "NewBranchName"
  10256. },
  10257. "sha": {
  10258. "description": "sha is the SHA for the file that already exists",
  10259. "type": "string",
  10260. "x-go-name": "SHA"
  10261. }
  10262. },
  10263. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10264. },
  10265. "DeployKey": {
  10266. "description": "DeployKey a deploy key",
  10267. "type": "object",
  10268. "properties": {
  10269. "created_at": {
  10270. "type": "string",
  10271. "format": "date-time",
  10272. "x-go-name": "Created"
  10273. },
  10274. "fingerprint": {
  10275. "type": "string",
  10276. "x-go-name": "Fingerprint"
  10277. },
  10278. "id": {
  10279. "type": "integer",
  10280. "format": "int64",
  10281. "x-go-name": "ID"
  10282. },
  10283. "key": {
  10284. "type": "string",
  10285. "x-go-name": "Key"
  10286. },
  10287. "key_id": {
  10288. "type": "integer",
  10289. "format": "int64",
  10290. "x-go-name": "KeyID"
  10291. },
  10292. "read_only": {
  10293. "type": "boolean",
  10294. "x-go-name": "ReadOnly"
  10295. },
  10296. "repository": {
  10297. "$ref": "#/definitions/Repository"
  10298. },
  10299. "title": {
  10300. "type": "string",
  10301. "x-go-name": "Title"
  10302. },
  10303. "url": {
  10304. "type": "string",
  10305. "x-go-name": "URL"
  10306. }
  10307. },
  10308. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10309. },
  10310. "EditAttachmentOptions": {
  10311. "description": "EditAttachmentOptions options for editing attachments",
  10312. "type": "object",
  10313. "properties": {
  10314. "name": {
  10315. "type": "string",
  10316. "x-go-name": "Name"
  10317. }
  10318. },
  10319. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10320. },
  10321. "EditDeadlineOption": {
  10322. "description": "EditDeadlineOption options for creating a deadline",
  10323. "type": "object",
  10324. "required": [
  10325. "due_date"
  10326. ],
  10327. "properties": {
  10328. "due_date": {
  10329. "type": "string",
  10330. "format": "date-time",
  10331. "x-go-name": "Deadline"
  10332. }
  10333. },
  10334. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10335. },
  10336. "EditGitHookOption": {
  10337. "description": "EditGitHookOption options when modifying one Git hook",
  10338. "type": "object",
  10339. "properties": {
  10340. "content": {
  10341. "type": "string",
  10342. "x-go-name": "Content"
  10343. }
  10344. },
  10345. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10346. },
  10347. "EditHookOption": {
  10348. "description": "EditHookOption options when modify one hook",
  10349. "type": "object",
  10350. "properties": {
  10351. "active": {
  10352. "type": "boolean",
  10353. "x-go-name": "Active"
  10354. },
  10355. "branch_filter": {
  10356. "type": "string",
  10357. "x-go-name": "BranchFilter"
  10358. },
  10359. "config": {
  10360. "type": "object",
  10361. "additionalProperties": {
  10362. "type": "string"
  10363. },
  10364. "x-go-name": "Config"
  10365. },
  10366. "events": {
  10367. "type": "array",
  10368. "items": {
  10369. "type": "string"
  10370. },
  10371. "x-go-name": "Events"
  10372. }
  10373. },
  10374. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10375. },
  10376. "EditIssueCommentOption": {
  10377. "description": "EditIssueCommentOption options for editing a comment",
  10378. "type": "object",
  10379. "required": [
  10380. "body"
  10381. ],
  10382. "properties": {
  10383. "body": {
  10384. "type": "string",
  10385. "x-go-name": "Body"
  10386. }
  10387. },
  10388. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10389. },
  10390. "EditIssueOption": {
  10391. "description": "EditIssueOption options for editing an issue",
  10392. "type": "object",
  10393. "properties": {
  10394. "assignee": {
  10395. "type": "string",
  10396. "x-go-name": "Assignee"
  10397. },
  10398. "assignees": {
  10399. "type": "array",
  10400. "items": {
  10401. "type": "string"
  10402. },
  10403. "x-go-name": "Assignees"
  10404. },
  10405. "body": {
  10406. "type": "string",
  10407. "x-go-name": "Body"
  10408. },
  10409. "due_date": {
  10410. "type": "string",
  10411. "format": "date-time",
  10412. "x-go-name": "Deadline"
  10413. },
  10414. "milestone": {
  10415. "type": "integer",
  10416. "format": "int64",
  10417. "x-go-name": "Milestone"
  10418. },
  10419. "state": {
  10420. "type": "string",
  10421. "x-go-name": "State"
  10422. },
  10423. "title": {
  10424. "type": "string",
  10425. "x-go-name": "Title"
  10426. },
  10427. "unset_due_date": {
  10428. "type": "boolean",
  10429. "x-go-name": "RemoveDeadline"
  10430. }
  10431. },
  10432. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10433. },
  10434. "EditLabelOption": {
  10435. "description": "EditLabelOption options for editing a label",
  10436. "type": "object",
  10437. "properties": {
  10438. "color": {
  10439. "type": "string",
  10440. "x-go-name": "Color"
  10441. },
  10442. "description": {
  10443. "type": "string",
  10444. "x-go-name": "Description"
  10445. },
  10446. "name": {
  10447. "type": "string",
  10448. "x-go-name": "Name"
  10449. }
  10450. },
  10451. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10452. },
  10453. "EditMilestoneOption": {
  10454. "description": "EditMilestoneOption options for editing a milestone",
  10455. "type": "object",
  10456. "properties": {
  10457. "description": {
  10458. "type": "string",
  10459. "x-go-name": "Description"
  10460. },
  10461. "due_on": {
  10462. "type": "string",
  10463. "format": "date-time",
  10464. "x-go-name": "Deadline"
  10465. },
  10466. "state": {
  10467. "type": "string",
  10468. "x-go-name": "State"
  10469. },
  10470. "title": {
  10471. "type": "string",
  10472. "x-go-name": "Title"
  10473. }
  10474. },
  10475. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10476. },
  10477. "EditOrgOption": {
  10478. "description": "EditOrgOption options for editing an organization",
  10479. "type": "object",
  10480. "properties": {
  10481. "description": {
  10482. "type": "string",
  10483. "x-go-name": "Description"
  10484. },
  10485. "full_name": {
  10486. "type": "string",
  10487. "x-go-name": "FullName"
  10488. },
  10489. "location": {
  10490. "type": "string",
  10491. "x-go-name": "Location"
  10492. },
  10493. "repo_admin_change_team_access": {
  10494. "type": "boolean",
  10495. "x-go-name": "RepoAdminChangeTeamAccess"
  10496. },
  10497. "visibility": {
  10498. "description": "possible values are `public`, `limited` or `private`",
  10499. "type": "string",
  10500. "enum": [
  10501. "public",
  10502. "limited",
  10503. "private"
  10504. ],
  10505. "x-go-name": "Visibility"
  10506. },
  10507. "website": {
  10508. "type": "string",
  10509. "x-go-name": "Website"
  10510. }
  10511. },
  10512. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10513. },
  10514. "EditPullRequestOption": {
  10515. "description": "EditPullRequestOption options when modify pull request",
  10516. "type": "object",
  10517. "properties": {
  10518. "assignee": {
  10519. "type": "string",
  10520. "x-go-name": "Assignee"
  10521. },
  10522. "assignees": {
  10523. "type": "array",
  10524. "items": {
  10525. "type": "string"
  10526. },
  10527. "x-go-name": "Assignees"
  10528. },
  10529. "body": {
  10530. "type": "string",
  10531. "x-go-name": "Body"
  10532. },
  10533. "due_date": {
  10534. "type": "string",
  10535. "format": "date-time",
  10536. "x-go-name": "Deadline"
  10537. },
  10538. "labels": {
  10539. "type": "array",
  10540. "items": {
  10541. "type": "integer",
  10542. "format": "int64"
  10543. },
  10544. "x-go-name": "Labels"
  10545. },
  10546. "milestone": {
  10547. "type": "integer",
  10548. "format": "int64",
  10549. "x-go-name": "Milestone"
  10550. },
  10551. "state": {
  10552. "type": "string",
  10553. "x-go-name": "State"
  10554. },
  10555. "title": {
  10556. "type": "string",
  10557. "x-go-name": "Title"
  10558. },
  10559. "unset_due_date": {
  10560. "type": "boolean",
  10561. "x-go-name": "RemoveDeadline"
  10562. }
  10563. },
  10564. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10565. },
  10566. "EditReactionOption": {
  10567. "description": "EditReactionOption contain the reaction type",
  10568. "type": "object",
  10569. "properties": {
  10570. "content": {
  10571. "type": "string",
  10572. "x-go-name": "Reaction"
  10573. }
  10574. },
  10575. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10576. },
  10577. "EditReleaseOption": {
  10578. "description": "EditReleaseOption options when editing a release",
  10579. "type": "object",
  10580. "properties": {
  10581. "body": {
  10582. "type": "string",
  10583. "x-go-name": "Note"
  10584. },
  10585. "draft": {
  10586. "type": "boolean",
  10587. "x-go-name": "IsDraft"
  10588. },
  10589. "name": {
  10590. "type": "string",
  10591. "x-go-name": "Title"
  10592. },
  10593. "prerelease": {
  10594. "type": "boolean",
  10595. "x-go-name": "IsPrerelease"
  10596. },
  10597. "tag_name": {
  10598. "type": "string",
  10599. "x-go-name": "TagName"
  10600. },
  10601. "target_commitish": {
  10602. "type": "string",
  10603. "x-go-name": "Target"
  10604. }
  10605. },
  10606. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10607. },
  10608. "EditRepoOption": {
  10609. "description": "EditRepoOption options when editing a repository's properties",
  10610. "type": "object",
  10611. "properties": {
  10612. "allow_merge_commits": {
  10613. "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`.",
  10614. "type": "boolean",
  10615. "x-go-name": "AllowMerge"
  10616. },
  10617. "allow_rebase": {
  10618. "description": "either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.",
  10619. "type": "boolean",
  10620. "x-go-name": "AllowRebase"
  10621. },
  10622. "allow_rebase_explicit": {
  10623. "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`.",
  10624. "type": "boolean",
  10625. "x-go-name": "AllowRebaseMerge"
  10626. },
  10627. "allow_squash_merge": {
  10628. "description": "either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.",
  10629. "type": "boolean",
  10630. "x-go-name": "AllowSquash"
  10631. },
  10632. "archived": {
  10633. "description": "set to `true` to archive this repository.",
  10634. "type": "boolean",
  10635. "x-go-name": "Archived"
  10636. },
  10637. "default_branch": {
  10638. "description": "sets the default branch for this repository.",
  10639. "type": "string",
  10640. "x-go-name": "DefaultBranch"
  10641. },
  10642. "description": {
  10643. "description": "a short description of the repository.",
  10644. "type": "string",
  10645. "x-go-name": "Description"
  10646. },
  10647. "external_tracker": {
  10648. "$ref": "#/definitions/ExternalTracker"
  10649. },
  10650. "external_wiki": {
  10651. "$ref": "#/definitions/ExternalWiki"
  10652. },
  10653. "has_issues": {
  10654. "description": "either `true` to enable issues for this repository or `false` to disable them.",
  10655. "type": "boolean",
  10656. "x-go-name": "HasIssues"
  10657. },
  10658. "has_pull_requests": {
  10659. "description": "either `true` to allow pull requests, or `false` to prevent pull request.",
  10660. "type": "boolean",
  10661. "x-go-name": "HasPullRequests"
  10662. },
  10663. "has_wiki": {
  10664. "description": "either `true` to enable the wiki for this repository or `false` to disable it.",
  10665. "type": "boolean",
  10666. "x-go-name": "HasWiki"
  10667. },
  10668. "ignore_whitespace_conflicts": {
  10669. "description": "either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.",
  10670. "type": "boolean",
  10671. "x-go-name": "IgnoreWhitespaceConflicts"
  10672. },
  10673. "internal_tracker": {
  10674. "$ref": "#/definitions/InternalTracker"
  10675. },
  10676. "name": {
  10677. "description": "name of the repository",
  10678. "type": "string",
  10679. "uniqueItems": true,
  10680. "x-go-name": "Name"
  10681. },
  10682. "private": {
  10683. "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.",
  10684. "type": "boolean",
  10685. "x-go-name": "Private"
  10686. },
  10687. "template": {
  10688. "description": "either `true` to make this repository a template or `false` to make it a normal repository",
  10689. "type": "boolean",
  10690. "x-go-name": "Template"
  10691. },
  10692. "website": {
  10693. "description": "a URL with more information about the repository.",
  10694. "type": "string",
  10695. "x-go-name": "Website"
  10696. }
  10697. },
  10698. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10699. },
  10700. "EditTeamOption": {
  10701. "description": "EditTeamOption options for editing a team",
  10702. "type": "object",
  10703. "required": [
  10704. "name"
  10705. ],
  10706. "properties": {
  10707. "can_create_org_repo": {
  10708. "type": "boolean",
  10709. "x-go-name": "CanCreateOrgRepo"
  10710. },
  10711. "description": {
  10712. "type": "string",
  10713. "x-go-name": "Description"
  10714. },
  10715. "includes_all_repositories": {
  10716. "type": "boolean",
  10717. "x-go-name": "IncludesAllRepositories"
  10718. },
  10719. "name": {
  10720. "type": "string",
  10721. "x-go-name": "Name"
  10722. },
  10723. "permission": {
  10724. "type": "string",
  10725. "enum": [
  10726. "read",
  10727. "write",
  10728. "admin"
  10729. ],
  10730. "x-go-name": "Permission"
  10731. },
  10732. "units": {
  10733. "type": "array",
  10734. "items": {
  10735. "type": "string"
  10736. },
  10737. "x-go-name": "Units",
  10738. "example": [
  10739. "repo.code",
  10740. "repo.issues",
  10741. "repo.ext_issues",
  10742. "repo.wiki",
  10743. "repo.pulls",
  10744. "repo.releases",
  10745. "repo.ext_wiki"
  10746. ]
  10747. }
  10748. },
  10749. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10750. },
  10751. "EditUserOption": {
  10752. "description": "EditUserOption edit user options",
  10753. "type": "object",
  10754. "required": [
  10755. "email"
  10756. ],
  10757. "properties": {
  10758. "active": {
  10759. "type": "boolean",
  10760. "x-go-name": "Active"
  10761. },
  10762. "admin": {
  10763. "type": "boolean",
  10764. "x-go-name": "Admin"
  10765. },
  10766. "allow_create_organization": {
  10767. "type": "boolean",
  10768. "x-go-name": "AllowCreateOrganization"
  10769. },
  10770. "allow_git_hook": {
  10771. "type": "boolean",
  10772. "x-go-name": "AllowGitHook"
  10773. },
  10774. "allow_import_local": {
  10775. "type": "boolean",
  10776. "x-go-name": "AllowImportLocal"
  10777. },
  10778. "email": {
  10779. "type": "string",
  10780. "format": "email",
  10781. "x-go-name": "Email"
  10782. },
  10783. "full_name": {
  10784. "type": "string",
  10785. "x-go-name": "FullName"
  10786. },
  10787. "location": {
  10788. "type": "string",
  10789. "x-go-name": "Location"
  10790. },
  10791. "login_name": {
  10792. "type": "string",
  10793. "x-go-name": "LoginName"
  10794. },
  10795. "max_repo_creation": {
  10796. "type": "integer",
  10797. "format": "int64",
  10798. "x-go-name": "MaxRepoCreation"
  10799. },
  10800. "must_change_password": {
  10801. "type": "boolean",
  10802. "x-go-name": "MustChangePassword"
  10803. },
  10804. "password": {
  10805. "type": "string",
  10806. "x-go-name": "Password"
  10807. },
  10808. "prohibit_login": {
  10809. "type": "boolean",
  10810. "x-go-name": "ProhibitLogin"
  10811. },
  10812. "source_id": {
  10813. "type": "integer",
  10814. "format": "int64",
  10815. "x-go-name": "SourceID"
  10816. },
  10817. "website": {
  10818. "type": "string",
  10819. "x-go-name": "Website"
  10820. }
  10821. },
  10822. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10823. },
  10824. "Email": {
  10825. "description": "Email an email address belonging to a user",
  10826. "type": "object",
  10827. "properties": {
  10828. "email": {
  10829. "type": "string",
  10830. "format": "email",
  10831. "x-go-name": "Email"
  10832. },
  10833. "primary": {
  10834. "type": "boolean",
  10835. "x-go-name": "Primary"
  10836. },
  10837. "verified": {
  10838. "type": "boolean",
  10839. "x-go-name": "Verified"
  10840. }
  10841. },
  10842. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10843. },
  10844. "ExternalTracker": {
  10845. "description": "ExternalTracker represents settings for external tracker",
  10846. "type": "object",
  10847. "properties": {
  10848. "external_tracker_format": {
  10849. "description": "External Issue Tracker URL Format. Use the placeholders {user}, {repo} and {index} for the username, repository name and issue index.",
  10850. "type": "string",
  10851. "x-go-name": "ExternalTrackerFormat"
  10852. },
  10853. "external_tracker_style": {
  10854. "description": "External Issue Tracker Number Format, either `numeric` or `alphanumeric`",
  10855. "type": "string",
  10856. "x-go-name": "ExternalTrackerStyle"
  10857. },
  10858. "external_tracker_url": {
  10859. "description": "URL of external issue tracker.",
  10860. "type": "string",
  10861. "x-go-name": "ExternalTrackerURL"
  10862. }
  10863. },
  10864. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10865. },
  10866. "ExternalWiki": {
  10867. "description": "ExternalWiki represents setting for external wiki",
  10868. "type": "object",
  10869. "properties": {
  10870. "external_wiki_url": {
  10871. "description": "URL of external wiki.",
  10872. "type": "string",
  10873. "x-go-name": "ExternalWikiURL"
  10874. }
  10875. },
  10876. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10877. },
  10878. "FileCommitResponse": {
  10879. "type": "object",
  10880. "title": "FileCommitResponse contains information generated from a Git commit for a repo's file.",
  10881. "properties": {
  10882. "author": {
  10883. "$ref": "#/definitions/CommitUser"
  10884. },
  10885. "committer": {
  10886. "$ref": "#/definitions/CommitUser"
  10887. },
  10888. "html_url": {
  10889. "type": "string",
  10890. "x-go-name": "HTMLURL"
  10891. },
  10892. "message": {
  10893. "type": "string",
  10894. "x-go-name": "Message"
  10895. },
  10896. "parents": {
  10897. "type": "array",
  10898. "items": {
  10899. "$ref": "#/definitions/CommitMeta"
  10900. },
  10901. "x-go-name": "Parents"
  10902. },
  10903. "sha": {
  10904. "type": "string",
  10905. "x-go-name": "SHA"
  10906. },
  10907. "tree": {
  10908. "$ref": "#/definitions/CommitMeta"
  10909. },
  10910. "url": {
  10911. "type": "string",
  10912. "x-go-name": "URL"
  10913. }
  10914. },
  10915. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10916. },
  10917. "FileDeleteResponse": {
  10918. "description": "FileDeleteResponse contains information about a repo's file that was deleted",
  10919. "type": "object",
  10920. "properties": {
  10921. "commit": {
  10922. "$ref": "#/definitions/FileCommitResponse"
  10923. },
  10924. "content": {
  10925. "type": "object",
  10926. "x-go-name": "Content"
  10927. },
  10928. "verification": {
  10929. "$ref": "#/definitions/PayloadCommitVerification"
  10930. }
  10931. },
  10932. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10933. },
  10934. "FileLinksResponse": {
  10935. "description": "FileLinksResponse contains the links for a repo's file",
  10936. "type": "object",
  10937. "properties": {
  10938. "git": {
  10939. "type": "string",
  10940. "x-go-name": "GitURL"
  10941. },
  10942. "html": {
  10943. "type": "string",
  10944. "x-go-name": "HTMLURL"
  10945. },
  10946. "self": {
  10947. "type": "string",
  10948. "x-go-name": "Self"
  10949. }
  10950. },
  10951. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10952. },
  10953. "FileResponse": {
  10954. "description": "FileResponse contains information about a repo's file",
  10955. "type": "object",
  10956. "properties": {
  10957. "commit": {
  10958. "$ref": "#/definitions/FileCommitResponse"
  10959. },
  10960. "content": {
  10961. "$ref": "#/definitions/ContentsResponse"
  10962. },
  10963. "verification": {
  10964. "$ref": "#/definitions/PayloadCommitVerification"
  10965. }
  10966. },
  10967. "x-go-package": "code.gitea.io/gitea/modules/structs"
  10968. },
  10969. "GPGKey": {
  10970. "description": "GPGKey a user GPG key to sign commit and tag in repository",
  10971. "type": "object",
  10972. "properties": {
  10973. "can_certify": {
  10974. "type": "boolean",
  10975. "x-go-name": "CanCertify"
  10976. },
  10977. "can_encrypt_comms": {
  10978. "type": "boolean",
  10979. "x-go-name": "CanEncryptComms"
  10980. },
  10981. "can_encrypt_storage": {
  10982. "type": "boolean",
  10983. "x-go-name": "CanEncryptStorage"
  10984. },
  10985. "can_sign": {
  10986. "type": "boolean",
  10987. "x-go-name": "CanSign"
  10988. },
  10989. "created_at": {
  10990. "type": "string",
  10991. "format": "date-time",
  10992. "x-go-name": "Created"
  10993. },
  10994. "emails": {
  10995. "type": "array",
  10996. "items": {
  10997. "$ref": "#/definitions/GPGKeyEmail"
  10998. },
  10999. "x-go-name": "Emails"
  11000. },
  11001. "expires_at": {
  11002. "type": "string",
  11003. "format": "date-time",
  11004. "x-go-name": "Expires"
  11005. },
  11006. "id": {
  11007. "type": "integer",
  11008. "format": "int64",
  11009. "x-go-name": "ID"
  11010. },
  11011. "key_id": {
  11012. "type": "string",
  11013. "x-go-name": "KeyID"
  11014. },
  11015. "primary_key_id": {
  11016. "type": "string",
  11017. "x-go-name": "PrimaryKeyID"
  11018. },
  11019. "public_key": {
  11020. "type": "string",
  11021. "x-go-name": "PublicKey"
  11022. },
  11023. "subkeys": {
  11024. "type": "array",
  11025. "items": {
  11026. "$ref": "#/definitions/GPGKey"
  11027. },
  11028. "x-go-name": "SubsKey"
  11029. }
  11030. },
  11031. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11032. },
  11033. "GPGKeyEmail": {
  11034. "description": "GPGKeyEmail an email attached to a GPGKey",
  11035. "type": "object",
  11036. "properties": {
  11037. "email": {
  11038. "type": "string",
  11039. "x-go-name": "Email"
  11040. },
  11041. "verified": {
  11042. "type": "boolean",
  11043. "x-go-name": "Verified"
  11044. }
  11045. },
  11046. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11047. },
  11048. "GitBlobResponse": {
  11049. "description": "GitBlobResponse represents a git blob",
  11050. "type": "object",
  11051. "properties": {
  11052. "content": {
  11053. "type": "string",
  11054. "x-go-name": "Content"
  11055. },
  11056. "encoding": {
  11057. "type": "string",
  11058. "x-go-name": "Encoding"
  11059. },
  11060. "sha": {
  11061. "type": "string",
  11062. "x-go-name": "SHA"
  11063. },
  11064. "size": {
  11065. "type": "integer",
  11066. "format": "int64",
  11067. "x-go-name": "Size"
  11068. },
  11069. "url": {
  11070. "type": "string",
  11071. "x-go-name": "URL"
  11072. }
  11073. },
  11074. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11075. },
  11076. "GitEntry": {
  11077. "description": "GitEntry represents a git tree",
  11078. "type": "object",
  11079. "properties": {
  11080. "mode": {
  11081. "type": "string",
  11082. "x-go-name": "Mode"
  11083. },
  11084. "path": {
  11085. "type": "string",
  11086. "x-go-name": "Path"
  11087. },
  11088. "sha": {
  11089. "type": "string",
  11090. "x-go-name": "SHA"
  11091. },
  11092. "size": {
  11093. "type": "integer",
  11094. "format": "int64",
  11095. "x-go-name": "Size"
  11096. },
  11097. "type": {
  11098. "type": "string",
  11099. "x-go-name": "Type"
  11100. },
  11101. "url": {
  11102. "type": "string",
  11103. "x-go-name": "URL"
  11104. }
  11105. },
  11106. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11107. },
  11108. "GitHook": {
  11109. "description": "GitHook represents a Git repository hook",
  11110. "type": "object",
  11111. "properties": {
  11112. "content": {
  11113. "type": "string",
  11114. "x-go-name": "Content"
  11115. },
  11116. "is_active": {
  11117. "type": "boolean",
  11118. "x-go-name": "IsActive"
  11119. },
  11120. "name": {
  11121. "type": "string",
  11122. "x-go-name": "Name"
  11123. }
  11124. },
  11125. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11126. },
  11127. "GitObject": {
  11128. "type": "object",
  11129. "title": "GitObject represents a Git object.",
  11130. "properties": {
  11131. "sha": {
  11132. "type": "string",
  11133. "x-go-name": "SHA"
  11134. },
  11135. "type": {
  11136. "type": "string",
  11137. "x-go-name": "Type"
  11138. },
  11139. "url": {
  11140. "type": "string",
  11141. "x-go-name": "URL"
  11142. }
  11143. },
  11144. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11145. },
  11146. "GitTreeResponse": {
  11147. "description": "GitTreeResponse returns a git tree",
  11148. "type": "object",
  11149. "properties": {
  11150. "page": {
  11151. "type": "integer",
  11152. "format": "int64",
  11153. "x-go-name": "Page"
  11154. },
  11155. "sha": {
  11156. "type": "string",
  11157. "x-go-name": "SHA"
  11158. },
  11159. "total_count": {
  11160. "type": "integer",
  11161. "format": "int64",
  11162. "x-go-name": "TotalCount"
  11163. },
  11164. "tree": {
  11165. "type": "array",
  11166. "items": {
  11167. "$ref": "#/definitions/GitEntry"
  11168. },
  11169. "x-go-name": "Entries"
  11170. },
  11171. "truncated": {
  11172. "type": "boolean",
  11173. "x-go-name": "Truncated"
  11174. },
  11175. "url": {
  11176. "type": "string",
  11177. "x-go-name": "URL"
  11178. }
  11179. },
  11180. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11181. },
  11182. "Hook": {
  11183. "description": "Hook a hook is a web hook when one repository changed",
  11184. "type": "object",
  11185. "properties": {
  11186. "active": {
  11187. "type": "boolean",
  11188. "x-go-name": "Active"
  11189. },
  11190. "config": {
  11191. "type": "object",
  11192. "additionalProperties": {
  11193. "type": "string"
  11194. },
  11195. "x-go-name": "Config"
  11196. },
  11197. "created_at": {
  11198. "type": "string",
  11199. "format": "date-time",
  11200. "x-go-name": "Created"
  11201. },
  11202. "events": {
  11203. "type": "array",
  11204. "items": {
  11205. "type": "string"
  11206. },
  11207. "x-go-name": "Events"
  11208. },
  11209. "id": {
  11210. "type": "integer",
  11211. "format": "int64",
  11212. "x-go-name": "ID"
  11213. },
  11214. "type": {
  11215. "type": "string",
  11216. "x-go-name": "Type"
  11217. },
  11218. "updated_at": {
  11219. "type": "string",
  11220. "format": "date-time",
  11221. "x-go-name": "Updated"
  11222. }
  11223. },
  11224. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11225. },
  11226. "Identity": {
  11227. "description": "Identity for a person's identity like an author or committer",
  11228. "type": "object",
  11229. "properties": {
  11230. "email": {
  11231. "type": "string",
  11232. "format": "email",
  11233. "x-go-name": "Email"
  11234. },
  11235. "name": {
  11236. "type": "string",
  11237. "x-go-name": "Name"
  11238. }
  11239. },
  11240. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11241. },
  11242. "InternalTracker": {
  11243. "description": "InternalTracker represents settings for internal tracker",
  11244. "type": "object",
  11245. "properties": {
  11246. "allow_only_contributors_to_track_time": {
  11247. "description": "Let only contributors track time (Built-in issue tracker)",
  11248. "type": "boolean",
  11249. "x-go-name": "AllowOnlyContributorsToTrackTime"
  11250. },
  11251. "enable_issue_dependencies": {
  11252. "description": "Enable dependencies for issues and pull requests (Built-in issue tracker)",
  11253. "type": "boolean",
  11254. "x-go-name": "EnableIssueDependencies"
  11255. },
  11256. "enable_time_tracker": {
  11257. "description": "Enable time tracking (Built-in issue tracker)",
  11258. "type": "boolean",
  11259. "x-go-name": "EnableTimeTracker"
  11260. }
  11261. },
  11262. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11263. },
  11264. "Issue": {
  11265. "description": "Issue represents an issue in a repository",
  11266. "type": "object",
  11267. "properties": {
  11268. "assignee": {
  11269. "$ref": "#/definitions/User"
  11270. },
  11271. "assignees": {
  11272. "type": "array",
  11273. "items": {
  11274. "$ref": "#/definitions/User"
  11275. },
  11276. "x-go-name": "Assignees"
  11277. },
  11278. "body": {
  11279. "type": "string",
  11280. "x-go-name": "Body"
  11281. },
  11282. "closed_at": {
  11283. "type": "string",
  11284. "format": "date-time",
  11285. "x-go-name": "Closed"
  11286. },
  11287. "comments": {
  11288. "type": "integer",
  11289. "format": "int64",
  11290. "x-go-name": "Comments"
  11291. },
  11292. "created_at": {
  11293. "type": "string",
  11294. "format": "date-time",
  11295. "x-go-name": "Created"
  11296. },
  11297. "due_date": {
  11298. "type": "string",
  11299. "format": "date-time",
  11300. "x-go-name": "Deadline"
  11301. },
  11302. "html_url": {
  11303. "type": "string",
  11304. "x-go-name": "HTMLURL"
  11305. },
  11306. "id": {
  11307. "type": "integer",
  11308. "format": "int64",
  11309. "x-go-name": "ID"
  11310. },
  11311. "labels": {
  11312. "type": "array",
  11313. "items": {
  11314. "$ref": "#/definitions/Label"
  11315. },
  11316. "x-go-name": "Labels"
  11317. },
  11318. "milestone": {
  11319. "$ref": "#/definitions/Milestone"
  11320. },
  11321. "number": {
  11322. "type": "integer",
  11323. "format": "int64",
  11324. "x-go-name": "Index"
  11325. },
  11326. "original_author": {
  11327. "type": "string",
  11328. "x-go-name": "OriginalAuthor"
  11329. },
  11330. "original_author_id": {
  11331. "type": "integer",
  11332. "format": "int64",
  11333. "x-go-name": "OriginalAuthorID"
  11334. },
  11335. "pull_request": {
  11336. "$ref": "#/definitions/PullRequestMeta"
  11337. },
  11338. "repository": {
  11339. "$ref": "#/definitions/RepositoryMeta"
  11340. },
  11341. "state": {
  11342. "$ref": "#/definitions/StateType"
  11343. },
  11344. "title": {
  11345. "type": "string",
  11346. "x-go-name": "Title"
  11347. },
  11348. "updated_at": {
  11349. "type": "string",
  11350. "format": "date-time",
  11351. "x-go-name": "Updated"
  11352. },
  11353. "url": {
  11354. "type": "string",
  11355. "x-go-name": "URL"
  11356. },
  11357. "user": {
  11358. "$ref": "#/definitions/User"
  11359. }
  11360. },
  11361. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11362. },
  11363. "IssueDeadline": {
  11364. "description": "IssueDeadline represents an issue deadline",
  11365. "type": "object",
  11366. "properties": {
  11367. "due_date": {
  11368. "type": "string",
  11369. "format": "date-time",
  11370. "x-go-name": "Deadline"
  11371. }
  11372. },
  11373. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11374. },
  11375. "IssueLabelsOption": {
  11376. "description": "IssueLabelsOption a collection of labels",
  11377. "type": "object",
  11378. "properties": {
  11379. "labels": {
  11380. "description": "list of label IDs",
  11381. "type": "array",
  11382. "items": {
  11383. "type": "integer",
  11384. "format": "int64"
  11385. },
  11386. "x-go-name": "Labels"
  11387. }
  11388. },
  11389. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11390. },
  11391. "Label": {
  11392. "description": "Label a label to an issue or a pr",
  11393. "type": "object",
  11394. "properties": {
  11395. "color": {
  11396. "type": "string",
  11397. "x-go-name": "Color",
  11398. "example": "00aabb"
  11399. },
  11400. "description": {
  11401. "type": "string",
  11402. "x-go-name": "Description"
  11403. },
  11404. "id": {
  11405. "type": "integer",
  11406. "format": "int64",
  11407. "x-go-name": "ID"
  11408. },
  11409. "name": {
  11410. "type": "string",
  11411. "x-go-name": "Name"
  11412. },
  11413. "url": {
  11414. "type": "string",
  11415. "x-go-name": "URL"
  11416. }
  11417. },
  11418. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11419. },
  11420. "MarkdownOption": {
  11421. "description": "MarkdownOption markdown options",
  11422. "type": "object",
  11423. "properties": {
  11424. "Context": {
  11425. "description": "Context to render\n\nin: body",
  11426. "type": "string"
  11427. },
  11428. "Mode": {
  11429. "description": "Mode to render\n\nin: body",
  11430. "type": "string"
  11431. },
  11432. "Text": {
  11433. "description": "Text markdown to render\n\nin: body",
  11434. "type": "string"
  11435. },
  11436. "Wiki": {
  11437. "description": "Is it a wiki page ?\n\nin: body",
  11438. "type": "boolean"
  11439. }
  11440. },
  11441. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11442. },
  11443. "MergePullRequestOption": {
  11444. "description": "MergePullRequestForm form for merging Pull Request",
  11445. "type": "object",
  11446. "required": [
  11447. "Do"
  11448. ],
  11449. "properties": {
  11450. "Do": {
  11451. "type": "string",
  11452. "enum": [
  11453. "merge",
  11454. "rebase",
  11455. "rebase-merge",
  11456. "squash"
  11457. ]
  11458. },
  11459. "MergeMessageField": {
  11460. "type": "string"
  11461. },
  11462. "MergeTitleField": {
  11463. "type": "string"
  11464. },
  11465. "force_merge": {
  11466. "type": "boolean",
  11467. "x-go-name": "ForceMerge"
  11468. }
  11469. },
  11470. "x-go-name": "MergePullRequestForm",
  11471. "x-go-package": "code.gitea.io/gitea/modules/auth"
  11472. },
  11473. "MigrateRepoForm": {
  11474. "description": "MigrateRepoForm form for migrating repository",
  11475. "type": "object",
  11476. "required": [
  11477. "clone_addr",
  11478. "uid",
  11479. "repo_name"
  11480. ],
  11481. "properties": {
  11482. "auth_password": {
  11483. "type": "string",
  11484. "x-go-name": "AuthPassword"
  11485. },
  11486. "auth_username": {
  11487. "type": "string",
  11488. "x-go-name": "AuthUsername"
  11489. },
  11490. "clone_addr": {
  11491. "type": "string",
  11492. "x-go-name": "CloneAddr"
  11493. },
  11494. "description": {
  11495. "type": "string",
  11496. "x-go-name": "Description"
  11497. },
  11498. "issues": {
  11499. "type": "boolean",
  11500. "x-go-name": "Issues"
  11501. },
  11502. "labels": {
  11503. "type": "boolean",
  11504. "x-go-name": "Labels"
  11505. },
  11506. "milestones": {
  11507. "type": "boolean",
  11508. "x-go-name": "Milestones"
  11509. },
  11510. "mirror": {
  11511. "type": "boolean",
  11512. "x-go-name": "Mirror"
  11513. },
  11514. "private": {
  11515. "type": "boolean",
  11516. "x-go-name": "Private"
  11517. },
  11518. "pull_requests": {
  11519. "type": "boolean",
  11520. "x-go-name": "PullRequests"
  11521. },
  11522. "releases": {
  11523. "type": "boolean",
  11524. "x-go-name": "Releases"
  11525. },
  11526. "repo_name": {
  11527. "type": "string",
  11528. "x-go-name": "RepoName"
  11529. },
  11530. "uid": {
  11531. "type": "integer",
  11532. "format": "int64",
  11533. "x-go-name": "UID"
  11534. },
  11535. "wiki": {
  11536. "type": "boolean",
  11537. "x-go-name": "Wiki"
  11538. }
  11539. },
  11540. "x-go-package": "code.gitea.io/gitea/modules/auth"
  11541. },
  11542. "Milestone": {
  11543. "description": "Milestone milestone is a collection of issues on one repository",
  11544. "type": "object",
  11545. "properties": {
  11546. "closed_at": {
  11547. "type": "string",
  11548. "format": "date-time",
  11549. "x-go-name": "Closed"
  11550. },
  11551. "closed_issues": {
  11552. "type": "integer",
  11553. "format": "int64",
  11554. "x-go-name": "ClosedIssues"
  11555. },
  11556. "description": {
  11557. "type": "string",
  11558. "x-go-name": "Description"
  11559. },
  11560. "due_on": {
  11561. "type": "string",
  11562. "format": "date-time",
  11563. "x-go-name": "Deadline"
  11564. },
  11565. "id": {
  11566. "type": "integer",
  11567. "format": "int64",
  11568. "x-go-name": "ID"
  11569. },
  11570. "open_issues": {
  11571. "type": "integer",
  11572. "format": "int64",
  11573. "x-go-name": "OpenIssues"
  11574. },
  11575. "state": {
  11576. "$ref": "#/definitions/StateType"
  11577. },
  11578. "title": {
  11579. "type": "string",
  11580. "x-go-name": "Title"
  11581. }
  11582. },
  11583. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11584. },
  11585. "NotificationCount": {
  11586. "description": "NotificationCount number of unread notifications",
  11587. "type": "object",
  11588. "properties": {
  11589. "new": {
  11590. "type": "integer",
  11591. "format": "int64",
  11592. "x-go-name": "New"
  11593. }
  11594. },
  11595. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11596. },
  11597. "NotificationSubject": {
  11598. "description": "NotificationSubject contains the notification subject (Issue/Pull/Commit)",
  11599. "type": "object",
  11600. "properties": {
  11601. "latest_comment_url": {
  11602. "type": "string",
  11603. "x-go-name": "LatestCommentURL"
  11604. },
  11605. "title": {
  11606. "type": "string",
  11607. "x-go-name": "Title"
  11608. },
  11609. "type": {
  11610. "type": "string",
  11611. "x-go-name": "Type"
  11612. },
  11613. "url": {
  11614. "type": "string",
  11615. "x-go-name": "URL"
  11616. }
  11617. },
  11618. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11619. },
  11620. "NotificationThread": {
  11621. "description": "NotificationThread expose Notification on API",
  11622. "type": "object",
  11623. "properties": {
  11624. "id": {
  11625. "type": "integer",
  11626. "format": "int64",
  11627. "x-go-name": "ID"
  11628. },
  11629. "pinned": {
  11630. "type": "boolean",
  11631. "x-go-name": "Pinned"
  11632. },
  11633. "repository": {
  11634. "$ref": "#/definitions/Repository"
  11635. },
  11636. "subject": {
  11637. "$ref": "#/definitions/NotificationSubject"
  11638. },
  11639. "unread": {
  11640. "type": "boolean",
  11641. "x-go-name": "Unread"
  11642. },
  11643. "updated_at": {
  11644. "type": "string",
  11645. "format": "date-time",
  11646. "x-go-name": "UpdatedAt"
  11647. },
  11648. "url": {
  11649. "type": "string",
  11650. "x-go-name": "URL"
  11651. }
  11652. },
  11653. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11654. },
  11655. "Organization": {
  11656. "description": "Organization represents an organization",
  11657. "type": "object",
  11658. "properties": {
  11659. "avatar_url": {
  11660. "type": "string",
  11661. "x-go-name": "AvatarURL"
  11662. },
  11663. "description": {
  11664. "type": "string",
  11665. "x-go-name": "Description"
  11666. },
  11667. "full_name": {
  11668. "type": "string",
  11669. "x-go-name": "FullName"
  11670. },
  11671. "id": {
  11672. "type": "integer",
  11673. "format": "int64",
  11674. "x-go-name": "ID"
  11675. },
  11676. "location": {
  11677. "type": "string",
  11678. "x-go-name": "Location"
  11679. },
  11680. "repo_admin_change_team_access": {
  11681. "type": "boolean",
  11682. "x-go-name": "RepoAdminChangeTeamAccess"
  11683. },
  11684. "username": {
  11685. "type": "string",
  11686. "x-go-name": "UserName"
  11687. },
  11688. "visibility": {
  11689. "type": "string",
  11690. "x-go-name": "Visibility"
  11691. },
  11692. "website": {
  11693. "type": "string",
  11694. "x-go-name": "Website"
  11695. }
  11696. },
  11697. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11698. },
  11699. "PRBranchInfo": {
  11700. "description": "PRBranchInfo information about a branch",
  11701. "type": "object",
  11702. "properties": {
  11703. "label": {
  11704. "type": "string",
  11705. "x-go-name": "Name"
  11706. },
  11707. "ref": {
  11708. "type": "string",
  11709. "x-go-name": "Ref"
  11710. },
  11711. "repo": {
  11712. "$ref": "#/definitions/Repository"
  11713. },
  11714. "repo_id": {
  11715. "type": "integer",
  11716. "format": "int64",
  11717. "x-go-name": "RepoID"
  11718. },
  11719. "sha": {
  11720. "type": "string",
  11721. "x-go-name": "Sha"
  11722. }
  11723. },
  11724. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11725. },
  11726. "PayloadCommit": {
  11727. "description": "PayloadCommit represents a commit",
  11728. "type": "object",
  11729. "properties": {
  11730. "added": {
  11731. "type": "array",
  11732. "items": {
  11733. "type": "string"
  11734. },
  11735. "x-go-name": "Added"
  11736. },
  11737. "author": {
  11738. "$ref": "#/definitions/PayloadUser"
  11739. },
  11740. "committer": {
  11741. "$ref": "#/definitions/PayloadUser"
  11742. },
  11743. "id": {
  11744. "description": "sha1 hash of the commit",
  11745. "type": "string",
  11746. "x-go-name": "ID"
  11747. },
  11748. "message": {
  11749. "type": "string",
  11750. "x-go-name": "Message"
  11751. },
  11752. "modified": {
  11753. "type": "array",
  11754. "items": {
  11755. "type": "string"
  11756. },
  11757. "x-go-name": "Modified"
  11758. },
  11759. "removed": {
  11760. "type": "array",
  11761. "items": {
  11762. "type": "string"
  11763. },
  11764. "x-go-name": "Removed"
  11765. },
  11766. "timestamp": {
  11767. "type": "string",
  11768. "format": "date-time",
  11769. "x-go-name": "Timestamp"
  11770. },
  11771. "url": {
  11772. "type": "string",
  11773. "x-go-name": "URL"
  11774. },
  11775. "verification": {
  11776. "$ref": "#/definitions/PayloadCommitVerification"
  11777. }
  11778. },
  11779. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11780. },
  11781. "PayloadCommitVerification": {
  11782. "description": "PayloadCommitVerification represents the GPG verification of a commit",
  11783. "type": "object",
  11784. "properties": {
  11785. "payload": {
  11786. "type": "string",
  11787. "x-go-name": "Payload"
  11788. },
  11789. "reason": {
  11790. "type": "string",
  11791. "x-go-name": "Reason"
  11792. },
  11793. "signature": {
  11794. "type": "string",
  11795. "x-go-name": "Signature"
  11796. },
  11797. "signer": {
  11798. "$ref": "#/definitions/PayloadUser"
  11799. },
  11800. "verified": {
  11801. "type": "boolean",
  11802. "x-go-name": "Verified"
  11803. }
  11804. },
  11805. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11806. },
  11807. "PayloadUser": {
  11808. "description": "PayloadUser represents the author or committer of a commit",
  11809. "type": "object",
  11810. "properties": {
  11811. "email": {
  11812. "type": "string",
  11813. "format": "email",
  11814. "x-go-name": "Email"
  11815. },
  11816. "name": {
  11817. "description": "Full name of the commit author",
  11818. "type": "string",
  11819. "x-go-name": "Name"
  11820. },
  11821. "username": {
  11822. "type": "string",
  11823. "x-go-name": "UserName"
  11824. }
  11825. },
  11826. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11827. },
  11828. "Permission": {
  11829. "description": "Permission represents a set of permissions",
  11830. "type": "object",
  11831. "properties": {
  11832. "admin": {
  11833. "type": "boolean",
  11834. "x-go-name": "Admin"
  11835. },
  11836. "pull": {
  11837. "type": "boolean",
  11838. "x-go-name": "Pull"
  11839. },
  11840. "push": {
  11841. "type": "boolean",
  11842. "x-go-name": "Push"
  11843. }
  11844. },
  11845. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11846. },
  11847. "PublicKey": {
  11848. "description": "PublicKey publickey is a user key to push code to repository",
  11849. "type": "object",
  11850. "properties": {
  11851. "created_at": {
  11852. "type": "string",
  11853. "format": "date-time",
  11854. "x-go-name": "Created"
  11855. },
  11856. "fingerprint": {
  11857. "type": "string",
  11858. "x-go-name": "Fingerprint"
  11859. },
  11860. "id": {
  11861. "type": "integer",
  11862. "format": "int64",
  11863. "x-go-name": "ID"
  11864. },
  11865. "key": {
  11866. "type": "string",
  11867. "x-go-name": "Key"
  11868. },
  11869. "key_type": {
  11870. "type": "string",
  11871. "x-go-name": "KeyType"
  11872. },
  11873. "read_only": {
  11874. "type": "boolean",
  11875. "x-go-name": "ReadOnly"
  11876. },
  11877. "title": {
  11878. "type": "string",
  11879. "x-go-name": "Title"
  11880. },
  11881. "url": {
  11882. "type": "string",
  11883. "x-go-name": "URL"
  11884. },
  11885. "user": {
  11886. "$ref": "#/definitions/User"
  11887. }
  11888. },
  11889. "x-go-package": "code.gitea.io/gitea/modules/structs"
  11890. },
  11891. "PullRequest": {
  11892. "description": "PullRequest represents a pull request",
  11893. "type": "object",
  11894. "properties": {
  11895. "assignee": {
  11896. "$ref": "#/definitions/User"
  11897. },
  11898. "assignees": {
  11899. "type": "array",
  11900. "items": {
  11901. "$ref": "#/definitions/User"
  11902. },
  11903. "x-go-name": "Assignees"
  11904. },
  11905. "base": {
  11906. "$ref": "#/definitions/PRBranchInfo"
  11907. },
  11908. "body": {
  11909. "type": "string",
  11910. "x-go-name": "Body"
  11911. },
  11912. "closed_at": {
  11913. "type": "string",
  11914. "format": "date-time",
  11915. "x-go-name": "Closed"
  11916. },
  11917. "comments": {
  11918. "type": "integer",
  11919. "format": "int64",
  11920. "x-go-name": "Comments"
  11921. },
  11922. "created_at": {
  11923. "type": "string",
  11924. "format": "date-time",
  11925. "x-go-name": "Created"
  11926. },
  11927. "diff_url": {
  11928. "type": "string",
  11929. "x-go-name": "DiffURL"
  11930. },
  11931. "due_date": {
  11932. "type": "string",
  11933. "format": "date-time",
  11934. "x-go-name": "Deadline"
  11935. },
  11936. "head": {
  11937. "$ref": "#/definitions/PRBranchInfo"
  11938. },
  11939. "html_url": {
  11940. "type": "string",
  11941. "x-go-name": "HTMLURL"
  11942. },
  11943. "id": {
  11944. "type": "integer",
  11945. "format": "int64",
  11946. "x-go-name": "ID"
  11947. },
  11948. "labels": {
  11949. "type": "array",
  11950. "items": {
  11951. "$ref": "#/definitions/Label"
  11952. },
  11953. "x-go-name": "Labels"
  11954. },
  11955. "merge_base": {
  11956. "type": "string",
  11957. "x-go-name": "MergeBase"
  11958. },
  11959. "merge_commit_sha": {
  11960. "type": "string",
  11961. "x-go-name": "MergedCommitID"
  11962. },
  11963. "mergeable": {
  11964. "type": "boolean",
  11965. "x-go-name": "Mergeable"
  11966. },
  11967. "merged": {
  11968. "type": "boolean",
  11969. "x-go-name": "HasMerged"
  11970. },
  11971. "merged_at": {
  11972. "type": "string",
  11973. "format": "date-time",
  11974. "x-go-name": "Merged"
  11975. },
  11976. "merged_by": {
  11977. "$ref": "#/definitions/User"
  11978. },
  11979. "milestone": {
  11980. "$ref": "#/definitions/Milestone"
  11981. },
  11982. "number": {
  11983. "type": "integer",
  11984. "format": "int64",
  11985. "x-go-name": "Index"
  11986. },
  11987. "patch_url": {
  11988. "type": "string",
  11989. "x-go-name": "PatchURL"
  11990. },
  11991. "state": {
  11992. "$ref": "#/definitions/StateType"
  11993. },
  11994. "title": {
  11995. "type": "string",
  11996. "x-go-name": "Title"
  11997. },
  11998. "updated_at": {
  11999. "type": "string",
  12000. "format": "date-time",
  12001. "x-go-name": "Updated"
  12002. },
  12003. "url": {
  12004. "type": "string",
  12005. "x-go-name": "URL"
  12006. },
  12007. "user": {
  12008. "$ref": "#/definitions/User"
  12009. }
  12010. },
  12011. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12012. },
  12013. "PullRequestMeta": {
  12014. "description": "PullRequestMeta PR info if an issue is a PR",
  12015. "type": "object",
  12016. "properties": {
  12017. "merged": {
  12018. "type": "boolean",
  12019. "x-go-name": "HasMerged"
  12020. },
  12021. "merged_at": {
  12022. "type": "string",
  12023. "format": "date-time",
  12024. "x-go-name": "Merged"
  12025. }
  12026. },
  12027. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12028. },
  12029. "Reaction": {
  12030. "description": "Reaction contain one reaction",
  12031. "type": "object",
  12032. "properties": {
  12033. "content": {
  12034. "type": "string",
  12035. "x-go-name": "Reaction"
  12036. },
  12037. "created_at": {
  12038. "type": "string",
  12039. "format": "date-time",
  12040. "x-go-name": "Created"
  12041. },
  12042. "user": {
  12043. "$ref": "#/definitions/User"
  12044. }
  12045. },
  12046. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12047. },
  12048. "Reference": {
  12049. "type": "object",
  12050. "title": "Reference represents a Git reference.",
  12051. "properties": {
  12052. "object": {
  12053. "$ref": "#/definitions/GitObject"
  12054. },
  12055. "ref": {
  12056. "type": "string",
  12057. "x-go-name": "Ref"
  12058. },
  12059. "url": {
  12060. "type": "string",
  12061. "x-go-name": "URL"
  12062. }
  12063. },
  12064. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12065. },
  12066. "Release": {
  12067. "description": "Release represents a repository release",
  12068. "type": "object",
  12069. "properties": {
  12070. "assets": {
  12071. "type": "array",
  12072. "items": {
  12073. "$ref": "#/definitions/Attachment"
  12074. },
  12075. "x-go-name": "Attachments"
  12076. },
  12077. "author": {
  12078. "$ref": "#/definitions/User"
  12079. },
  12080. "body": {
  12081. "type": "string",
  12082. "x-go-name": "Note"
  12083. },
  12084. "created_at": {
  12085. "type": "string",
  12086. "format": "date-time",
  12087. "x-go-name": "CreatedAt"
  12088. },
  12089. "draft": {
  12090. "type": "boolean",
  12091. "x-go-name": "IsDraft"
  12092. },
  12093. "id": {
  12094. "type": "integer",
  12095. "format": "int64",
  12096. "x-go-name": "ID"
  12097. },
  12098. "name": {
  12099. "type": "string",
  12100. "x-go-name": "Title"
  12101. },
  12102. "prerelease": {
  12103. "type": "boolean",
  12104. "x-go-name": "IsPrerelease"
  12105. },
  12106. "published_at": {
  12107. "type": "string",
  12108. "format": "date-time",
  12109. "x-go-name": "PublishedAt"
  12110. },
  12111. "tag_name": {
  12112. "type": "string",
  12113. "x-go-name": "TagName"
  12114. },
  12115. "tarball_url": {
  12116. "type": "string",
  12117. "x-go-name": "TarURL"
  12118. },
  12119. "target_commitish": {
  12120. "type": "string",
  12121. "x-go-name": "Target"
  12122. },
  12123. "url": {
  12124. "type": "string",
  12125. "x-go-name": "URL"
  12126. },
  12127. "zipball_url": {
  12128. "type": "string",
  12129. "x-go-name": "ZipURL"
  12130. }
  12131. },
  12132. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12133. },
  12134. "RepoCommit": {
  12135. "type": "object",
  12136. "title": "RepoCommit contains information of a commit in the context of a repository.",
  12137. "properties": {
  12138. "author": {
  12139. "$ref": "#/definitions/CommitUser"
  12140. },
  12141. "committer": {
  12142. "$ref": "#/definitions/CommitUser"
  12143. },
  12144. "message": {
  12145. "type": "string",
  12146. "x-go-name": "Message"
  12147. },
  12148. "tree": {
  12149. "$ref": "#/definitions/CommitMeta"
  12150. },
  12151. "url": {
  12152. "type": "string",
  12153. "x-go-name": "URL"
  12154. }
  12155. },
  12156. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12157. },
  12158. "RepoTopicOptions": {
  12159. "description": "RepoTopicOptions a collection of repo topic names",
  12160. "type": "object",
  12161. "properties": {
  12162. "topics": {
  12163. "description": "list of topic names",
  12164. "type": "array",
  12165. "items": {
  12166. "type": "string"
  12167. },
  12168. "x-go-name": "Topics"
  12169. }
  12170. },
  12171. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12172. },
  12173. "Repository": {
  12174. "description": "Repository represents a repository",
  12175. "type": "object",
  12176. "properties": {
  12177. "allow_merge_commits": {
  12178. "type": "boolean",
  12179. "x-go-name": "AllowMerge"
  12180. },
  12181. "allow_rebase": {
  12182. "type": "boolean",
  12183. "x-go-name": "AllowRebase"
  12184. },
  12185. "allow_rebase_explicit": {
  12186. "type": "boolean",
  12187. "x-go-name": "AllowRebaseMerge"
  12188. },
  12189. "allow_squash_merge": {
  12190. "type": "boolean",
  12191. "x-go-name": "AllowSquash"
  12192. },
  12193. "archived": {
  12194. "type": "boolean",
  12195. "x-go-name": "Archived"
  12196. },
  12197. "avatar_url": {
  12198. "type": "string",
  12199. "x-go-name": "AvatarURL"
  12200. },
  12201. "clone_url": {
  12202. "type": "string",
  12203. "x-go-name": "CloneURL"
  12204. },
  12205. "created_at": {
  12206. "type": "string",
  12207. "format": "date-time",
  12208. "x-go-name": "Created"
  12209. },
  12210. "default_branch": {
  12211. "type": "string",
  12212. "x-go-name": "DefaultBranch"
  12213. },
  12214. "description": {
  12215. "type": "string",
  12216. "x-go-name": "Description"
  12217. },
  12218. "empty": {
  12219. "type": "boolean",
  12220. "x-go-name": "Empty"
  12221. },
  12222. "external_tracker": {
  12223. "$ref": "#/definitions/ExternalTracker"
  12224. },
  12225. "external_wiki": {
  12226. "$ref": "#/definitions/ExternalWiki"
  12227. },
  12228. "fork": {
  12229. "type": "boolean",
  12230. "x-go-name": "Fork"
  12231. },
  12232. "forks_count": {
  12233. "type": "integer",
  12234. "format": "int64",
  12235. "x-go-name": "Forks"
  12236. },
  12237. "full_name": {
  12238. "type": "string",
  12239. "x-go-name": "FullName"
  12240. },
  12241. "has_issues": {
  12242. "type": "boolean",
  12243. "x-go-name": "HasIssues"
  12244. },
  12245. "has_pull_requests": {
  12246. "type": "boolean",
  12247. "x-go-name": "HasPullRequests"
  12248. },
  12249. "has_wiki": {
  12250. "type": "boolean",
  12251. "x-go-name": "HasWiki"
  12252. },
  12253. "html_url": {
  12254. "type": "string",
  12255. "x-go-name": "HTMLURL"
  12256. },
  12257. "id": {
  12258. "type": "integer",
  12259. "format": "int64",
  12260. "x-go-name": "ID"
  12261. },
  12262. "ignore_whitespace_conflicts": {
  12263. "type": "boolean",
  12264. "x-go-name": "IgnoreWhitespaceConflicts"
  12265. },
  12266. "internal_tracker": {
  12267. "$ref": "#/definitions/InternalTracker"
  12268. },
  12269. "mirror": {
  12270. "type": "boolean",
  12271. "x-go-name": "Mirror"
  12272. },
  12273. "name": {
  12274. "type": "string",
  12275. "x-go-name": "Name"
  12276. },
  12277. "open_issues_count": {
  12278. "type": "integer",
  12279. "format": "int64",
  12280. "x-go-name": "OpenIssues"
  12281. },
  12282. "open_pr_counter": {
  12283. "type": "integer",
  12284. "format": "int64",
  12285. "x-go-name": "OpenPulls"
  12286. },
  12287. "original_url": {
  12288. "type": "string",
  12289. "x-go-name": "OriginalURL"
  12290. },
  12291. "owner": {
  12292. "$ref": "#/definitions/User"
  12293. },
  12294. "parent": {
  12295. "$ref": "#/definitions/Repository"
  12296. },
  12297. "permissions": {
  12298. "$ref": "#/definitions/Permission"
  12299. },
  12300. "private": {
  12301. "type": "boolean",
  12302. "x-go-name": "Private"
  12303. },
  12304. "release_counter": {
  12305. "type": "integer",
  12306. "format": "int64",
  12307. "x-go-name": "Releases"
  12308. },
  12309. "size": {
  12310. "type": "integer",
  12311. "format": "int64",
  12312. "x-go-name": "Size"
  12313. },
  12314. "ssh_url": {
  12315. "type": "string",
  12316. "x-go-name": "SSHURL"
  12317. },
  12318. "stars_count": {
  12319. "type": "integer",
  12320. "format": "int64",
  12321. "x-go-name": "Stars"
  12322. },
  12323. "template": {
  12324. "type": "boolean",
  12325. "x-go-name": "Template"
  12326. },
  12327. "updated_at": {
  12328. "type": "string",
  12329. "format": "date-time",
  12330. "x-go-name": "Updated"
  12331. },
  12332. "watchers_count": {
  12333. "type": "integer",
  12334. "format": "int64",
  12335. "x-go-name": "Watchers"
  12336. },
  12337. "website": {
  12338. "type": "string",
  12339. "x-go-name": "Website"
  12340. }
  12341. },
  12342. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12343. },
  12344. "RepositoryMeta": {
  12345. "description": "RepositoryMeta basic repository information",
  12346. "type": "object",
  12347. "properties": {
  12348. "full_name": {
  12349. "type": "string",
  12350. "x-go-name": "FullName"
  12351. },
  12352. "id": {
  12353. "type": "integer",
  12354. "format": "int64",
  12355. "x-go-name": "ID"
  12356. },
  12357. "name": {
  12358. "type": "string",
  12359. "x-go-name": "Name"
  12360. },
  12361. "owner": {
  12362. "type": "string",
  12363. "x-go-name": "Owner"
  12364. }
  12365. },
  12366. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12367. },
  12368. "SearchResults": {
  12369. "description": "SearchResults results of a successful search",
  12370. "type": "object",
  12371. "properties": {
  12372. "data": {
  12373. "type": "array",
  12374. "items": {
  12375. "$ref": "#/definitions/Repository"
  12376. },
  12377. "x-go-name": "Data"
  12378. },
  12379. "ok": {
  12380. "type": "boolean",
  12381. "x-go-name": "OK"
  12382. }
  12383. },
  12384. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12385. },
  12386. "ServerVersion": {
  12387. "description": "ServerVersion wraps the version of the server",
  12388. "type": "object",
  12389. "properties": {
  12390. "version": {
  12391. "type": "string",
  12392. "x-go-name": "Version"
  12393. }
  12394. },
  12395. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12396. },
  12397. "StateType": {
  12398. "description": "StateType issue state type",
  12399. "type": "string",
  12400. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12401. },
  12402. "Status": {
  12403. "description": "Status holds a single Status of a single Commit",
  12404. "type": "object",
  12405. "properties": {
  12406. "context": {
  12407. "type": "string",
  12408. "x-go-name": "Context"
  12409. },
  12410. "created_at": {
  12411. "type": "string",
  12412. "format": "date-time",
  12413. "x-go-name": "Created"
  12414. },
  12415. "creator": {
  12416. "$ref": "#/definitions/User"
  12417. },
  12418. "description": {
  12419. "type": "string",
  12420. "x-go-name": "Description"
  12421. },
  12422. "id": {
  12423. "type": "integer",
  12424. "format": "int64",
  12425. "x-go-name": "ID"
  12426. },
  12427. "status": {
  12428. "$ref": "#/definitions/StatusState"
  12429. },
  12430. "target_url": {
  12431. "type": "string",
  12432. "x-go-name": "TargetURL"
  12433. },
  12434. "updated_at": {
  12435. "type": "string",
  12436. "format": "date-time",
  12437. "x-go-name": "Updated"
  12438. },
  12439. "url": {
  12440. "type": "string",
  12441. "x-go-name": "URL"
  12442. }
  12443. },
  12444. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12445. },
  12446. "StatusState": {
  12447. "description": "StatusState holds the state of a Status\nIt can be \"pending\", \"success\", \"error\", \"failure\", and \"warning\"",
  12448. "type": "string",
  12449. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12450. },
  12451. "StopWatch": {
  12452. "description": "StopWatch represent a running stopwatch",
  12453. "type": "object",
  12454. "properties": {
  12455. "created": {
  12456. "type": "string",
  12457. "format": "date-time",
  12458. "x-go-name": "Created"
  12459. },
  12460. "issue_index": {
  12461. "type": "integer",
  12462. "format": "int64",
  12463. "x-go-name": "IssueIndex"
  12464. }
  12465. },
  12466. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12467. },
  12468. "Tag": {
  12469. "description": "Tag represents a repository tag",
  12470. "type": "object",
  12471. "properties": {
  12472. "commit": {
  12473. "$ref": "#/definitions/CommitMeta"
  12474. },
  12475. "id": {
  12476. "type": "string",
  12477. "x-go-name": "ID"
  12478. },
  12479. "name": {
  12480. "type": "string",
  12481. "x-go-name": "Name"
  12482. },
  12483. "tarball_url": {
  12484. "type": "string",
  12485. "x-go-name": "TarballURL"
  12486. },
  12487. "zipball_url": {
  12488. "type": "string",
  12489. "x-go-name": "ZipballURL"
  12490. }
  12491. },
  12492. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12493. },
  12494. "Team": {
  12495. "description": "Team represents a team in an organization",
  12496. "type": "object",
  12497. "properties": {
  12498. "can_create_org_repo": {
  12499. "type": "boolean",
  12500. "x-go-name": "CanCreateOrgRepo"
  12501. },
  12502. "description": {
  12503. "type": "string",
  12504. "x-go-name": "Description"
  12505. },
  12506. "id": {
  12507. "type": "integer",
  12508. "format": "int64",
  12509. "x-go-name": "ID"
  12510. },
  12511. "includes_all_repositories": {
  12512. "type": "boolean",
  12513. "x-go-name": "IncludesAllRepositories"
  12514. },
  12515. "name": {
  12516. "type": "string",
  12517. "x-go-name": "Name"
  12518. },
  12519. "organization": {
  12520. "$ref": "#/definitions/Organization"
  12521. },
  12522. "permission": {
  12523. "type": "string",
  12524. "enum": [
  12525. "none",
  12526. "read",
  12527. "write",
  12528. "admin",
  12529. "owner"
  12530. ],
  12531. "x-go-name": "Permission"
  12532. },
  12533. "units": {
  12534. "type": "array",
  12535. "items": {
  12536. "type": "string"
  12537. },
  12538. "x-go-name": "Units",
  12539. "example": [
  12540. "repo.code",
  12541. "repo.issues",
  12542. "repo.ext_issues",
  12543. "repo.wiki",
  12544. "repo.pulls",
  12545. "repo.releases",
  12546. "repo.ext_wiki"
  12547. ]
  12548. }
  12549. },
  12550. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12551. },
  12552. "TimeStamp": {
  12553. "description": "TimeStamp defines a timestamp",
  12554. "type": "integer",
  12555. "format": "int64",
  12556. "x-go-package": "code.gitea.io/gitea/modules/timeutil"
  12557. },
  12558. "TopicName": {
  12559. "description": "TopicName a list of repo topic names",
  12560. "type": "object",
  12561. "properties": {
  12562. "topics": {
  12563. "type": "array",
  12564. "items": {
  12565. "type": "string"
  12566. },
  12567. "x-go-name": "TopicNames"
  12568. }
  12569. },
  12570. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12571. },
  12572. "TopicResponse": {
  12573. "description": "TopicResponse for returning topics",
  12574. "type": "object",
  12575. "properties": {
  12576. "created": {
  12577. "type": "string",
  12578. "format": "date-time",
  12579. "x-go-name": "Created"
  12580. },
  12581. "id": {
  12582. "type": "integer",
  12583. "format": "int64",
  12584. "x-go-name": "ID"
  12585. },
  12586. "repo_count": {
  12587. "type": "integer",
  12588. "format": "int64",
  12589. "x-go-name": "RepoCount"
  12590. },
  12591. "topic_name": {
  12592. "type": "string",
  12593. "x-go-name": "Name"
  12594. },
  12595. "updated": {
  12596. "type": "string",
  12597. "format": "date-time",
  12598. "x-go-name": "Updated"
  12599. }
  12600. },
  12601. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12602. },
  12603. "TrackedTime": {
  12604. "description": "TrackedTime worked time for an issue / pr",
  12605. "type": "object",
  12606. "properties": {
  12607. "created": {
  12608. "type": "string",
  12609. "format": "date-time",
  12610. "x-go-name": "Created"
  12611. },
  12612. "id": {
  12613. "type": "integer",
  12614. "format": "int64",
  12615. "x-go-name": "ID"
  12616. },
  12617. "issue": {
  12618. "$ref": "#/definitions/Issue"
  12619. },
  12620. "issue_id": {
  12621. "description": "deprecated (only for backwards compatibility)",
  12622. "type": "integer",
  12623. "format": "int64",
  12624. "x-go-name": "IssueID"
  12625. },
  12626. "time": {
  12627. "description": "Time in seconds",
  12628. "type": "integer",
  12629. "format": "int64",
  12630. "x-go-name": "Time"
  12631. },
  12632. "user_id": {
  12633. "description": "deprecated (only for backwards compatibility)",
  12634. "type": "integer",
  12635. "format": "int64",
  12636. "x-go-name": "UserID"
  12637. },
  12638. "user_name": {
  12639. "type": "string",
  12640. "x-go-name": "UserName"
  12641. }
  12642. },
  12643. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12644. },
  12645. "TransferRepoOption": {
  12646. "description": "TransferRepoOption options when transfer a repository's ownership",
  12647. "type": "object",
  12648. "required": [
  12649. "new_owner"
  12650. ],
  12651. "properties": {
  12652. "new_owner": {
  12653. "type": "string",
  12654. "x-go-name": "NewOwner"
  12655. },
  12656. "team_ids": {
  12657. "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.",
  12658. "type": "array",
  12659. "items": {
  12660. "type": "integer",
  12661. "format": "int64"
  12662. },
  12663. "x-go-name": "TeamIDs"
  12664. }
  12665. },
  12666. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12667. },
  12668. "UpdateFileOptions": {
  12669. "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)",
  12670. "type": "object",
  12671. "required": [
  12672. "sha",
  12673. "content"
  12674. ],
  12675. "properties": {
  12676. "author": {
  12677. "$ref": "#/definitions/Identity"
  12678. },
  12679. "branch": {
  12680. "description": "branch (optional) to base this file from. if not given, the default branch is used",
  12681. "type": "string",
  12682. "x-go-name": "BranchName"
  12683. },
  12684. "committer": {
  12685. "$ref": "#/definitions/Identity"
  12686. },
  12687. "content": {
  12688. "description": "content must be base64 encoded",
  12689. "type": "string",
  12690. "x-go-name": "Content"
  12691. },
  12692. "dates": {
  12693. "$ref": "#/definitions/CommitDateOptions"
  12694. },
  12695. "from_path": {
  12696. "description": "from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL",
  12697. "type": "string",
  12698. "x-go-name": "FromPath"
  12699. },
  12700. "message": {
  12701. "description": "message (optional) for the commit of this file. if not supplied, a default message will be used",
  12702. "type": "string",
  12703. "x-go-name": "Message"
  12704. },
  12705. "new_branch": {
  12706. "description": "new_branch (optional) will make a new branch from `branch` before creating the file",
  12707. "type": "string",
  12708. "x-go-name": "NewBranchName"
  12709. },
  12710. "sha": {
  12711. "description": "sha is the SHA for the file that already exists",
  12712. "type": "string",
  12713. "x-go-name": "SHA"
  12714. }
  12715. },
  12716. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12717. },
  12718. "User": {
  12719. "description": "User represents a user",
  12720. "type": "object",
  12721. "properties": {
  12722. "avatar_url": {
  12723. "description": "URL to the user's avatar",
  12724. "type": "string",
  12725. "x-go-name": "AvatarURL"
  12726. },
  12727. "created": {
  12728. "type": "string",
  12729. "format": "date-time",
  12730. "x-go-name": "Created"
  12731. },
  12732. "email": {
  12733. "type": "string",
  12734. "format": "email",
  12735. "x-go-name": "Email"
  12736. },
  12737. "full_name": {
  12738. "description": "the user's full name",
  12739. "type": "string",
  12740. "x-go-name": "FullName"
  12741. },
  12742. "id": {
  12743. "description": "the user's id",
  12744. "type": "integer",
  12745. "format": "int64",
  12746. "x-go-name": "ID"
  12747. },
  12748. "is_admin": {
  12749. "description": "Is the user an administrator",
  12750. "type": "boolean",
  12751. "x-go-name": "IsAdmin"
  12752. },
  12753. "language": {
  12754. "description": "User locale",
  12755. "type": "string",
  12756. "x-go-name": "Language"
  12757. },
  12758. "last_login": {
  12759. "type": "string",
  12760. "format": "date-time",
  12761. "x-go-name": "LastLogin"
  12762. },
  12763. "login": {
  12764. "description": "the user's username",
  12765. "type": "string",
  12766. "x-go-name": "UserName"
  12767. }
  12768. },
  12769. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12770. },
  12771. "UserHeatmapData": {
  12772. "description": "UserHeatmapData represents the data needed to create a heatmap",
  12773. "type": "object",
  12774. "properties": {
  12775. "contributions": {
  12776. "type": "integer",
  12777. "format": "int64",
  12778. "x-go-name": "Contributions"
  12779. },
  12780. "timestamp": {
  12781. "$ref": "#/definitions/TimeStamp"
  12782. }
  12783. },
  12784. "x-go-package": "code.gitea.io/gitea/models"
  12785. },
  12786. "WatchInfo": {
  12787. "description": "WatchInfo represents an API watch status of one repository",
  12788. "type": "object",
  12789. "properties": {
  12790. "created_at": {
  12791. "type": "string",
  12792. "format": "date-time",
  12793. "x-go-name": "CreatedAt"
  12794. },
  12795. "ignored": {
  12796. "type": "boolean",
  12797. "x-go-name": "Ignored"
  12798. },
  12799. "reason": {
  12800. "type": "object",
  12801. "x-go-name": "Reason"
  12802. },
  12803. "repository_url": {
  12804. "type": "string",
  12805. "x-go-name": "RepositoryURL"
  12806. },
  12807. "subscribed": {
  12808. "type": "boolean",
  12809. "x-go-name": "Subscribed"
  12810. },
  12811. "url": {
  12812. "type": "string",
  12813. "x-go-name": "URL"
  12814. }
  12815. },
  12816. "x-go-package": "code.gitea.io/gitea/modules/structs"
  12817. }
  12818. },
  12819. "responses": {
  12820. "AccessToken": {
  12821. "description": "AccessToken represents an API access token.",
  12822. "headers": {
  12823. "id": {
  12824. "type": "integer",
  12825. "format": "int64"
  12826. },
  12827. "name": {
  12828. "type": "string"
  12829. },
  12830. "sha1": {
  12831. "type": "string"
  12832. },
  12833. "token_last_eight": {
  12834. "type": "string"
  12835. }
  12836. }
  12837. },
  12838. "AccessTokenList": {
  12839. "description": "AccessTokenList represents a list of API access token.",
  12840. "schema": {
  12841. "type": "array",
  12842. "items": {
  12843. "$ref": "#/definitions/AccessToken"
  12844. }
  12845. }
  12846. },
  12847. "AnnotatedTag": {
  12848. "description": "AnnotatedTag",
  12849. "schema": {
  12850. "$ref": "#/definitions/AnnotatedTag"
  12851. }
  12852. },
  12853. "Attachment": {
  12854. "description": "Attachment",
  12855. "schema": {
  12856. "$ref": "#/definitions/Attachment"
  12857. }
  12858. },
  12859. "AttachmentList": {
  12860. "description": "AttachmentList",
  12861. "schema": {
  12862. "type": "array",
  12863. "items": {
  12864. "$ref": "#/definitions/Attachment"
  12865. }
  12866. }
  12867. },
  12868. "Branch": {
  12869. "description": "Branch",
  12870. "schema": {
  12871. "$ref": "#/definitions/Branch"
  12872. }
  12873. },
  12874. "BranchList": {
  12875. "description": "BranchList",
  12876. "schema": {
  12877. "type": "array",
  12878. "items": {
  12879. "$ref": "#/definitions/Branch"
  12880. }
  12881. }
  12882. },
  12883. "Comment": {
  12884. "description": "Comment",
  12885. "schema": {
  12886. "$ref": "#/definitions/Comment"
  12887. }
  12888. },
  12889. "CommentList": {
  12890. "description": "CommentList",
  12891. "schema": {
  12892. "type": "array",
  12893. "items": {
  12894. "$ref": "#/definitions/Comment"
  12895. }
  12896. }
  12897. },
  12898. "Commit": {
  12899. "description": "Commit",
  12900. "schema": {
  12901. "$ref": "#/definitions/Commit"
  12902. }
  12903. },
  12904. "CommitList": {
  12905. "description": "CommitList",
  12906. "schema": {
  12907. "type": "array",
  12908. "items": {
  12909. "$ref": "#/definitions/Commit"
  12910. }
  12911. },
  12912. "headers": {
  12913. "X-HasMore": {
  12914. "type": "boolean",
  12915. "description": "True if there is another page"
  12916. },
  12917. "X-Page": {
  12918. "type": "integer",
  12919. "format": "int64",
  12920. "description": "The current page"
  12921. },
  12922. "X-PageCount": {
  12923. "type": "integer",
  12924. "format": "int64",
  12925. "description": "Total number of pages"
  12926. },
  12927. "X-PerPage": {
  12928. "type": "integer",
  12929. "format": "int64",
  12930. "description": "Commits per page"
  12931. },
  12932. "X-Total": {
  12933. "type": "integer",
  12934. "format": "int64",
  12935. "description": "Total commit count"
  12936. }
  12937. }
  12938. },
  12939. "ContentsListResponse": {
  12940. "description": "ContentsListResponse",
  12941. "schema": {
  12942. "type": "array",
  12943. "items": {
  12944. "$ref": "#/definitions/ContentsResponse"
  12945. }
  12946. }
  12947. },
  12948. "ContentsResponse": {
  12949. "description": "ContentsResponse",
  12950. "schema": {
  12951. "$ref": "#/definitions/ContentsResponse"
  12952. }
  12953. },
  12954. "DeployKey": {
  12955. "description": "DeployKey",
  12956. "schema": {
  12957. "$ref": "#/definitions/DeployKey"
  12958. }
  12959. },
  12960. "DeployKeyList": {
  12961. "description": "DeployKeyList",
  12962. "schema": {
  12963. "type": "array",
  12964. "items": {
  12965. "$ref": "#/definitions/DeployKey"
  12966. }
  12967. }
  12968. },
  12969. "EmailList": {
  12970. "description": "EmailList",
  12971. "schema": {
  12972. "type": "array",
  12973. "items": {
  12974. "$ref": "#/definitions/Email"
  12975. }
  12976. }
  12977. },
  12978. "EmptyRepository": {
  12979. "description": "EmptyRepository",
  12980. "schema": {
  12981. "$ref": "#/definitions/APIError"
  12982. }
  12983. },
  12984. "FileDeleteResponse": {
  12985. "description": "FileDeleteResponse",
  12986. "schema": {
  12987. "$ref": "#/definitions/FileDeleteResponse"
  12988. }
  12989. },
  12990. "FileResponse": {
  12991. "description": "FileResponse",
  12992. "schema": {
  12993. "$ref": "#/definitions/FileResponse"
  12994. }
  12995. },
  12996. "GPGKey": {
  12997. "description": "GPGKey",
  12998. "schema": {
  12999. "$ref": "#/definitions/GPGKey"
  13000. }
  13001. },
  13002. "GPGKeyList": {
  13003. "description": "GPGKeyList",
  13004. "schema": {
  13005. "type": "array",
  13006. "items": {
  13007. "$ref": "#/definitions/GPGKey"
  13008. }
  13009. }
  13010. },
  13011. "GitBlobResponse": {
  13012. "description": "GitBlobResponse",
  13013. "schema": {
  13014. "$ref": "#/definitions/GitBlobResponse"
  13015. }
  13016. },
  13017. "GitHook": {
  13018. "description": "GitHook",
  13019. "schema": {
  13020. "$ref": "#/definitions/GitHook"
  13021. }
  13022. },
  13023. "GitHookList": {
  13024. "description": "GitHookList",
  13025. "schema": {
  13026. "type": "array",
  13027. "items": {
  13028. "$ref": "#/definitions/GitHook"
  13029. }
  13030. }
  13031. },
  13032. "GitTreeResponse": {
  13033. "description": "GitTreeResponse",
  13034. "schema": {
  13035. "$ref": "#/definitions/GitTreeResponse"
  13036. }
  13037. },
  13038. "Hook": {
  13039. "description": "Hook",
  13040. "schema": {
  13041. "$ref": "#/definitions/Hook"
  13042. }
  13043. },
  13044. "HookList": {
  13045. "description": "HookList",
  13046. "schema": {
  13047. "type": "array",
  13048. "items": {
  13049. "$ref": "#/definitions/Hook"
  13050. }
  13051. }
  13052. },
  13053. "Issue": {
  13054. "description": "Issue",
  13055. "schema": {
  13056. "$ref": "#/definitions/Issue"
  13057. }
  13058. },
  13059. "IssueDeadline": {
  13060. "description": "IssueDeadline",
  13061. "schema": {
  13062. "$ref": "#/definitions/IssueDeadline"
  13063. }
  13064. },
  13065. "IssueList": {
  13066. "description": "IssueList",
  13067. "schema": {
  13068. "type": "array",
  13069. "items": {
  13070. "$ref": "#/definitions/Issue"
  13071. }
  13072. }
  13073. },
  13074. "Label": {
  13075. "description": "Label",
  13076. "schema": {
  13077. "$ref": "#/definitions/Label"
  13078. }
  13079. },
  13080. "LabelList": {
  13081. "description": "LabelList",
  13082. "schema": {
  13083. "type": "array",
  13084. "items": {
  13085. "$ref": "#/definitions/Label"
  13086. }
  13087. }
  13088. },
  13089. "MarkdownRender": {
  13090. "description": "MarkdownRender is a rendered markdown document",
  13091. "schema": {
  13092. "type": "string"
  13093. }
  13094. },
  13095. "Milestone": {
  13096. "description": "Milestone",
  13097. "schema": {
  13098. "$ref": "#/definitions/Milestone"
  13099. }
  13100. },
  13101. "MilestoneList": {
  13102. "description": "MilestoneList",
  13103. "schema": {
  13104. "type": "array",
  13105. "items": {
  13106. "$ref": "#/definitions/Milestone"
  13107. }
  13108. }
  13109. },
  13110. "NotificationCount": {
  13111. "description": "Number of unread notifications",
  13112. "schema": {
  13113. "$ref": "#/definitions/NotificationCount"
  13114. }
  13115. },
  13116. "NotificationThread": {
  13117. "description": "NotificationThread",
  13118. "schema": {
  13119. "$ref": "#/definitions/NotificationThread"
  13120. }
  13121. },
  13122. "NotificationThreadList": {
  13123. "description": "NotificationThreadList",
  13124. "schema": {
  13125. "type": "array",
  13126. "items": {
  13127. "$ref": "#/definitions/NotificationThread"
  13128. }
  13129. }
  13130. },
  13131. "Organization": {
  13132. "description": "Organization",
  13133. "schema": {
  13134. "$ref": "#/definitions/Organization"
  13135. }
  13136. },
  13137. "OrganizationList": {
  13138. "description": "OrganizationList",
  13139. "schema": {
  13140. "type": "array",
  13141. "items": {
  13142. "$ref": "#/definitions/Organization"
  13143. }
  13144. }
  13145. },
  13146. "PublicKey": {
  13147. "description": "PublicKey",
  13148. "schema": {
  13149. "$ref": "#/definitions/PublicKey"
  13150. }
  13151. },
  13152. "PublicKeyList": {
  13153. "description": "PublicKeyList",
  13154. "schema": {
  13155. "type": "array",
  13156. "items": {
  13157. "$ref": "#/definitions/PublicKey"
  13158. }
  13159. }
  13160. },
  13161. "PullRequest": {
  13162. "description": "PullRequest",
  13163. "schema": {
  13164. "$ref": "#/definitions/PullRequest"
  13165. }
  13166. },
  13167. "PullRequestList": {
  13168. "description": "PullRequestList",
  13169. "schema": {
  13170. "type": "array",
  13171. "items": {
  13172. "$ref": "#/definitions/PullRequest"
  13173. }
  13174. }
  13175. },
  13176. "Reaction": {
  13177. "description": "Reaction",
  13178. "schema": {
  13179. "$ref": "#/definitions/Reaction"
  13180. }
  13181. },
  13182. "ReactionList": {
  13183. "description": "ReactionList",
  13184. "schema": {
  13185. "type": "array",
  13186. "items": {
  13187. "$ref": "#/definitions/Reaction"
  13188. }
  13189. }
  13190. },
  13191. "Reference": {
  13192. "description": "Reference",
  13193. "schema": {
  13194. "$ref": "#/definitions/Reference"
  13195. }
  13196. },
  13197. "ReferenceList": {
  13198. "description": "ReferenceList",
  13199. "schema": {
  13200. "type": "array",
  13201. "items": {
  13202. "$ref": "#/definitions/Reference"
  13203. }
  13204. }
  13205. },
  13206. "Release": {
  13207. "description": "Release",
  13208. "schema": {
  13209. "$ref": "#/definitions/Release"
  13210. }
  13211. },
  13212. "ReleaseList": {
  13213. "description": "ReleaseList",
  13214. "schema": {
  13215. "type": "array",
  13216. "items": {
  13217. "$ref": "#/definitions/Release"
  13218. }
  13219. }
  13220. },
  13221. "Repository": {
  13222. "description": "Repository",
  13223. "schema": {
  13224. "$ref": "#/definitions/Repository"
  13225. }
  13226. },
  13227. "RepositoryList": {
  13228. "description": "RepositoryList",
  13229. "schema": {
  13230. "type": "array",
  13231. "items": {
  13232. "$ref": "#/definitions/Repository"
  13233. }
  13234. }
  13235. },
  13236. "SearchResults": {
  13237. "description": "SearchResults",
  13238. "schema": {
  13239. "$ref": "#/definitions/SearchResults"
  13240. }
  13241. },
  13242. "ServerVersion": {
  13243. "description": "ServerVersion",
  13244. "schema": {
  13245. "$ref": "#/definitions/ServerVersion"
  13246. }
  13247. },
  13248. "Status": {
  13249. "description": "Status",
  13250. "schema": {
  13251. "$ref": "#/definitions/Status"
  13252. }
  13253. },
  13254. "StatusList": {
  13255. "description": "StatusList",
  13256. "schema": {
  13257. "type": "array",
  13258. "items": {
  13259. "$ref": "#/definitions/Status"
  13260. }
  13261. }
  13262. },
  13263. "StopWatch": {
  13264. "description": "StopWatch",
  13265. "schema": {
  13266. "$ref": "#/definitions/StopWatch"
  13267. }
  13268. },
  13269. "StopWatchList": {
  13270. "description": "StopWatchList",
  13271. "schema": {
  13272. "type": "array",
  13273. "items": {
  13274. "$ref": "#/definitions/StopWatch"
  13275. }
  13276. }
  13277. },
  13278. "Tag": {
  13279. "description": "Tag",
  13280. "schema": {
  13281. "$ref": "#/definitions/Tag"
  13282. }
  13283. },
  13284. "TagList": {
  13285. "description": "TagList",
  13286. "schema": {
  13287. "type": "array",
  13288. "items": {
  13289. "$ref": "#/definitions/Tag"
  13290. }
  13291. }
  13292. },
  13293. "Team": {
  13294. "description": "Team",
  13295. "schema": {
  13296. "$ref": "#/definitions/Team"
  13297. }
  13298. },
  13299. "TeamList": {
  13300. "description": "TeamList",
  13301. "schema": {
  13302. "type": "array",
  13303. "items": {
  13304. "$ref": "#/definitions/Team"
  13305. }
  13306. }
  13307. },
  13308. "TopicListResponse": {
  13309. "description": "TopicListResponse",
  13310. "schema": {
  13311. "type": "array",
  13312. "items": {
  13313. "$ref": "#/definitions/TopicResponse"
  13314. }
  13315. }
  13316. },
  13317. "TopicNames": {
  13318. "description": "TopicNames",
  13319. "schema": {
  13320. "$ref": "#/definitions/TopicName"
  13321. }
  13322. },
  13323. "TrackedTime": {
  13324. "description": "TrackedTime",
  13325. "schema": {
  13326. "$ref": "#/definitions/TrackedTime"
  13327. }
  13328. },
  13329. "TrackedTimeList": {
  13330. "description": "TrackedTimeList",
  13331. "schema": {
  13332. "type": "array",
  13333. "items": {
  13334. "$ref": "#/definitions/TrackedTime"
  13335. }
  13336. }
  13337. },
  13338. "User": {
  13339. "description": "User",
  13340. "schema": {
  13341. "$ref": "#/definitions/User"
  13342. }
  13343. },
  13344. "UserHeatmapData": {
  13345. "description": "UserHeatmapData",
  13346. "schema": {
  13347. "type": "array",
  13348. "items": {
  13349. "$ref": "#/definitions/UserHeatmapData"
  13350. }
  13351. }
  13352. },
  13353. "UserList": {
  13354. "description": "UserList",
  13355. "schema": {
  13356. "type": "array",
  13357. "items": {
  13358. "$ref": "#/definitions/User"
  13359. }
  13360. }
  13361. },
  13362. "WatchInfo": {
  13363. "description": "WatchInfo",
  13364. "schema": {
  13365. "$ref": "#/definitions/WatchInfo"
  13366. }
  13367. },
  13368. "empty": {
  13369. "description": "APIEmpty is an empty response"
  13370. },
  13371. "error": {
  13372. "description": "APIError is error format response",
  13373. "headers": {
  13374. "message": {
  13375. "type": "string"
  13376. },
  13377. "url": {
  13378. "type": "string"
  13379. }
  13380. }
  13381. },
  13382. "forbidden": {
  13383. "description": "APIForbiddenError is a forbidden error response",
  13384. "headers": {
  13385. "message": {
  13386. "type": "string"
  13387. },
  13388. "url": {
  13389. "type": "string"
  13390. }
  13391. }
  13392. },
  13393. "invalidTopicsError": {
  13394. "description": "APIInvalidTopicsError is error format response to invalid topics",
  13395. "headers": {
  13396. "invalidTopics": {
  13397. "type": "array",
  13398. "items": {
  13399. "type": "string"
  13400. }
  13401. },
  13402. "message": {
  13403. "type": "string"
  13404. }
  13405. }
  13406. },
  13407. "notFound": {
  13408. "description": "APINotFound is a not found empty response"
  13409. },
  13410. "parameterBodies": {
  13411. "description": "parameterBodies",
  13412. "schema": {
  13413. "$ref": "#/definitions/EditReactionOption"
  13414. }
  13415. },
  13416. "redirect": {
  13417. "description": "APIRedirect is a redirect response"
  13418. },
  13419. "validationError": {
  13420. "description": "APIValidationError is error format response related to input validation",
  13421. "headers": {
  13422. "message": {
  13423. "type": "string"
  13424. },
  13425. "url": {
  13426. "type": "string"
  13427. }
  13428. }
  13429. }
  13430. },
  13431. "securityDefinitions": {
  13432. "AccessToken": {
  13433. "type": "apiKey",
  13434. "name": "access_token",
  13435. "in": "query"
  13436. },
  13437. "AuthorizationHeaderToken": {
  13438. "description": "API tokens must be prepended with \"token\" followed by a space.",
  13439. "type": "apiKey",
  13440. "name": "Authorization",
  13441. "in": "header"
  13442. },
  13443. "BasicAuth": {
  13444. "type": "basic"
  13445. },
  13446. "SudoHeader": {
  13447. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  13448. "type": "apiKey",
  13449. "name": "Sudo",
  13450. "in": "header"
  13451. },
  13452. "SudoParam": {
  13453. "description": "Sudo API request as the user provided as the key. Admin privileges are required.",
  13454. "type": "apiKey",
  13455. "name": "sudo",
  13456. "in": "query"
  13457. },
  13458. "Token": {
  13459. "type": "apiKey",
  13460. "name": "token",
  13461. "in": "query"
  13462. }
  13463. },
  13464. "security": [
  13465. {
  13466. "BasicAuth": []
  13467. },
  13468. {
  13469. "Token": []
  13470. },
  13471. {
  13472. "AccessToken": []
  13473. },
  13474. {
  13475. "AuthorizationHeaderToken": []
  13476. },
  13477. {
  13478. "SudoParam": []
  13479. },
  13480. {
  13481. "SudoHeader": []
  13482. }
  13483. ]
  13484. }