| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268 |
- {
- "openapi": "3.0.3",
- "info": {
- "title": "Gogs API",
- "version": "v1",
- "description": "RESTful API for interacting with your Gogs instance. Follows a format similar to the GitHub REST API v3."
- },
- "servers": [
- {
- "url": "https://gogs.example.com/api/v1"
- }
- ],
- "security": [
- {
- "AccessToken": []
- }
- ],
- "tags": [
- {
- "name": "Repositories",
- "description": "Create, search, and manage repositories, branches, commits, and contents"
- },
- {
- "name": "Collaborators and Deploy Keys",
- "description": "Manage repository collaborators and deploy keys"
- },
- {
- "name": "Releases",
- "description": "List repository releases"
- },
- {
- "name": "Webhooks",
- "description": "Create, edit, and delete repository webhooks"
- },
- {
- "name": "Issues",
- "description": "Manage issues, comments, labels, and milestones"
- },
- {
- "name": "Users",
- "description": "Search users, manage access tokens, emails, followers, and public keys"
- },
- {
- "name": "Organizations",
- "description": "Manage organizations, members, and teams"
- },
- {
- "name": "Administration",
- "description": "Site administration endpoints (requires admin privileges)"
- },
- {
- "name": "Miscellaneous",
- "description": "Markdown rendering and Git data endpoints"
- }
- ],
- "paths": {
- "/repos/search": {
- "get": {
- "operationId": "searchRepos",
- "summary": "Search repositories",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Repository"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "q",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Search keyword"
- },
- {
- "name": "uid",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "description": "User ID to filter by"
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "default": 10
- },
- "description": "Max results"
- },
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "default": 1
- },
- "description": "Page number"
- }
- ]
- }
- },
- "/user/repos": {
- "get": {
- "operationId": "listYourRepos",
- "summary": "List your repositories",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "createRepo",
- "summary": "Create a repository",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "private": {
- "type": "boolean",
- "default": false
- },
- "auto_init": {
- "type": "boolean",
- "default": false
- },
- "gitignores": {
- "type": "string"
- },
- "license": {
- "type": "string"
- },
- "readme": {
- "type": "string",
- "default": "Default"
- }
- },
- "required": [
- "name"
- ]
- }
- }
- }
- }
- }
- },
- "/users/{username}/repos": {
- "get": {
- "operationId": "listUserRepos",
- "summary": "List user repositories",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ]
- }
- },
- "/orgs/{orgname}/repos": {
- "get": {
- "operationId": "listOrgRepos",
- "summary": "List organization repositories",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "orgname",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Organization name"
- }
- ]
- }
- },
- "/org/{org}/repos": {
- "post": {
- "operationId": "createOrgRepo",
- "summary": "Create a repository in an organization",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "org",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Organization name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "private": {
- "type": "boolean",
- "default": false
- },
- "auto_init": {
- "type": "boolean",
- "default": false
- },
- "gitignores": {
- "type": "string"
- },
- "license": {
- "type": "string"
- },
- "readme": {
- "type": "string",
- "default": "Default"
- }
- },
- "required": [
- "name"
- ]
- }
- }
- }
- },
- "description": "The authenticated user must be an owner of the specified organization."
- }
- },
- "/repos/migrate": {
- "post": {
- "operationId": "migrateRepo",
- "summary": "Migrate a repository",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "clone_addr": {
- "type": "string"
- },
- "auth_username": {
- "type": "string"
- },
- "auth_password": {
- "type": "string"
- },
- "uid": {
- "type": "integer"
- },
- "repo_name": {
- "type": "string"
- },
- "mirror": {
- "type": "boolean",
- "default": false
- },
- "private": {
- "type": "boolean",
- "default": false
- },
- "description": {
- "type": "string"
- }
- },
- "required": [
- "clone_addr",
- "uid",
- "repo_name"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}": {
- "get": {
- "operationId": "getRepo",
- "summary": "Get a repository",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- },
- "delete": {
- "operationId": "deleteRepo",
- "summary": "Delete a repository",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "description": "Requires owner access to the repository."
- }
- },
- "/repos/{owner}/{repo}/issue-tracker": {
- "patch": {
- "operationId": "editIssueTracker",
- "summary": "Edit issue tracker settings",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "204": {
- "description": "Settings updated successfully."
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "enable_issues": {
- "type": "boolean"
- },
- "enable_external_tracker": {
- "type": "boolean"
- },
- "external_tracker_url": {
- "type": "string"
- },
- "tracker_url_format": {
- "type": "string"
- },
- "tracker_issue_style": {
- "type": "string",
- "enum": [
- "numeric",
- "alphanumeric"
- ]
- }
- }
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/mirror-sync": {
- "post": {
- "operationId": "mirrorSync",
- "summary": "Mirror sync",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "202": {
- "description": "Mirror sync has been queued."
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "description": "Add a mirror repository to the sync queue. Returns 404 if the repository is not a mirror."
- }
- },
- "/repos/{owner}/{repo}/branches": {
- "get": {
- "operationId": "listBranches",
- "summary": "List branches",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Branch"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/branches/{branch}": {
- "get": {
- "operationId": "getBranch",
- "summary": "Get a branch",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Branch"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "branch",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Branch name"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/commits/{sha}": {
- "get": {
- "operationId": "getCommit",
- "summary": "Get a single commit",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Commit"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "sha",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Commit SHA"
- }
- ],
- "description": "Get details for a single commit. Set Accept header to application/vnd.gogs.sha to return only the SHA-1 hash of a commit reference."
- }
- },
- "/repos/{owner}/{repo}/raw/{ref}/{filepath}": {
- "get": {
- "operationId": "getRawContent",
- "summary": "Download raw content",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Raw file content",
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "ref",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Branch, tag, or commit"
- },
- {
- "name": "filepath",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "File path"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/archive/{archive}": {
- "get": {
- "operationId": "downloadArchive",
- "summary": "Download archive",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Archive file",
- "content": {
- "application/octet-stream": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "archive",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Ref and format, e.g. master.zip or master.tar.gz"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/contents/{path}": {
- "get": {
- "operationId": "getContents",
- "summary": "Get contents",
- "tags": [
- "Repositories"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Content"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "path",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "File or directory path"
- },
- {
- "name": "ref",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string"
- },
- "description": "Branch, tag, or commit. Defaults to the default branch."
- }
- ],
- "description": "Get the contents of a file, directory, symlink, or submodule in a repository."
- },
- "put": {
- "operationId": "putContents",
- "summary": "Create or update a file",
- "description": "Creates or updates a file in the repository. The content must be base64 encoded.",
- "tags": [
- "Repositories"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- },
- {
- "name": "path",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Path of the file to create or update"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string",
- "description": "Commit message"
- },
- "content": {
- "type": "string",
- "description": "Base64-encoded file content"
- },
- "branch": {
- "type": "string",
- "description": "Branch to commit to. Defaults to the repository's default branch."
- }
- },
- "required": [
- "message",
- "content"
- ]
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "File created or updated successfully.",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "content": {
- "$ref": "#/components/schemas/Content"
- },
- "commit": {
- "$ref": "#/components/schemas/Commit"
- }
- }
- }
- }
- }
- },
- "404": {
- "description": "Repository not found."
- },
- "422": {
- "description": "Validation error."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/collaborators": {
- "get": {
- "operationId": "listCollaborators",
- "summary": "List collaborators",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Collaborator"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/collaborators/{collaborator}": {
- "put": {
- "operationId": "addCollaborator",
- "summary": "Add a collaborator",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "204": {
- "description": "Collaborator has been added."
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "collaborator",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Collaborator username"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "default": "write"
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "removeCollaborator",
- "summary": "Remove a collaborator",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "collaborator",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Collaborator username"
- }
- ]
- },
- "get": {
- "operationId": "isCollaborator",
- "summary": "Check if a user is a collaborator",
- "description": "Returns 204 if the user is a collaborator, 404 if not.",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- },
- {
- "name": "collaborator",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username to check"
- }
- ],
- "responses": {
- "204": {
- "description": "User is a collaborator."
- },
- "404": {
- "description": "User is not a collaborator."
- },
- "422": {
- "description": "The specified user does not exist."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys": {
- "get": {
- "operationId": "listDeployKeys",
- "summary": "List deploy keys",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/DeployKey"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- },
- "post": {
- "operationId": "createDeployKey",
- "summary": "Add a deploy key",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DeployKey"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "key": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "key"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/keys/{id}": {
- "get": {
- "operationId": "getDeployKey",
- "summary": "Get a deploy key",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/DeployKey"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Key ID"
- }
- ]
- },
- "delete": {
- "operationId": "removeDeployKey",
- "summary": "Remove a deploy key",
- "tags": [
- "Collaborators and Deploy Keys"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Key ID"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/releases": {
- "get": {
- "operationId": "listReleases",
- "summary": "List releases",
- "tags": [
- "Releases"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Release"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/hooks": {
- "get": {
- "operationId": "listHooks",
- "summary": "List hooks",
- "tags": [
- "Webhooks"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Hook"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- },
- "post": {
- "operationId": "createHook",
- "summary": "Create a hook",
- "tags": [
- "Webhooks"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Hook"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "gogs",
- "slack",
- "discord",
- "dingtalk"
- ]
- },
- "config": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "content_type": {
- "type": "string",
- "enum": [
- "json",
- "form"
- ]
- },
- "secret": {
- "type": "string"
- }
- },
- "required": [
- "url",
- "content_type"
- ]
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- },
- "default": [
- "push"
- ]
- },
- "active": {
- "type": "boolean",
- "default": false
- }
- },
- "required": [
- "type",
- "config"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/hooks/{id}": {
- "patch": {
- "operationId": "editHook",
- "summary": "Edit a hook",
- "tags": [
- "Webhooks"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Hook"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Hook ID"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "config": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "content_type": {
- "type": "string"
- },
- "secret": {
- "type": "string"
- }
- }
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "active": {
- "type": "boolean"
- }
- },
- "required": [
- "config"
- ]
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "deleteHook",
- "summary": "Delete a hook",
- "tags": [
- "Webhooks"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Hook ID"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/issues": {
- "get": {
- "operationId": "listIssues",
- "summary": "List issues for a repository",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Issue"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "description": "This endpoint may also return pull requests. If an issue is a pull request, the object will include a pull_request key."
- },
- "post": {
- "operationId": "createIssue",
- "summary": "Create an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Issue"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "assignee": {
- "type": "string"
- },
- "milestone": {
- "type": "integer"
- },
- "labels": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- },
- "closed": {
- "type": "boolean",
- "default": false
- }
- },
- "required": [
- "title"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}": {
- "get": {
- "operationId": "getIssue",
- "summary": "Get a single issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Issue"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ]
- },
- "patch": {
- "operationId": "editIssue",
- "summary": "Edit an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Issue"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "assignee": {
- "type": "string"
- },
- "milestone": {
- "type": "integer"
- },
- "state": {
- "type": "string",
- "enum": [
- "open",
- "closed"
- ]
- }
- }
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments": {
- "get": {
- "operationId": "listIssueComments",
- "summary": "List comments on an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Comment"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- },
- {
- "name": "since",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string"
- },
- "description": "Only comments updated at or after this time (RFC 3339)"
- }
- ]
- },
- "post": {
- "operationId": "createComment",
- "summary": "Create a comment",
- "tags": [
- "Issues"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Comment"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string"
- }
- },
- "required": [
- "body"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/issues/comments": {
- "get": {
- "operationId": "listRepoComments",
- "summary": "List comments in a repository",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Comment"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "since",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string"
- },
- "description": "Only comments updated at or after this time (RFC 3339)"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/comments/{id}": {
- "patch": {
- "operationId": "editComment",
- "summary": "Edit a comment",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Comment"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Comment ID"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "body": {
- "type": "string"
- }
- },
- "required": [
- "body"
- ]
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "deleteComment",
- "summary": "Delete a comment",
- "tags": [
- "Issues"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Comment ID"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/labels": {
- "get": {
- "operationId": "listLabels",
- "summary": "List all labels for a repository",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- },
- "post": {
- "operationId": "createLabel",
- "summary": "Create a label",
- "tags": [
- "Issues"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "color": {
- "type": "string",
- "description": "Hex color code with leading #"
- }
- },
- "required": [
- "name",
- "color"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/labels/{id}": {
- "get": {
- "operationId": "getLabel",
- "summary": "Get a single label",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Label ID"
- }
- ]
- },
- "patch": {
- "operationId": "updateLabel",
- "summary": "Update a label",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Label ID"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "color": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "deleteLabel",
- "summary": "Delete a label",
- "tags": [
- "Issues"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Label ID"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels": {
- "get": {
- "operationId": "listIssueLabels",
- "summary": "List labels on an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ]
- },
- "post": {
- "operationId": "addIssueLabels",
- "summary": "Add labels to an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "labels": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- },
- "required": [
- "labels"
- ]
- }
- }
- }
- }
- },
- "put": {
- "operationId": "replaceIssueLabels",
- "summary": "Replace all labels for an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Label"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "labels": {
- "type": "array",
- "items": {
- "type": "integer"
- }
- }
- },
- "required": [
- "labels"
- ]
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "removeAllIssueLabels",
- "summary": "Remove all labels from an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/issues/{index}/labels/{id}": {
- "delete": {
- "operationId": "removeIssueLabel",
- "summary": "Remove a label from an issue",
- "tags": [
- "Issues"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "index",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Issue index"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Label ID"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/milestones": {
- "get": {
- "operationId": "listMilestones",
- "summary": "List milestones for a repository",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Milestone"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ]
- },
- "post": {
- "operationId": "createMilestone",
- "summary": "Create a milestone",
- "tags": [
- "Issues"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Milestone"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "due_on": {
- "type": "string",
- "format": "date-time"
- }
- },
- "required": [
- "title"
- ]
- }
- }
- }
- }
- }
- },
- "/repos/{owner}/{repo}/milestones/{id}": {
- "get": {
- "operationId": "getMilestone",
- "summary": "Get a single milestone",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Milestone"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Milestone ID"
- }
- ]
- },
- "patch": {
- "operationId": "editMilestone",
- "summary": "Edit a milestone",
- "tags": [
- "Issues"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Milestone"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Milestone ID"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "due_on": {
- "type": "string",
- "format": "date-time"
- },
- "state": {
- "type": "string",
- "enum": [
- "open",
- "closed"
- ]
- }
- }
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "deleteMilestone",
- "summary": "Delete a milestone",
- "tags": [
- "Issues"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Milestone ID"
- }
- ],
- "description": "Only users with write access to a repository can delete a milestone."
- }
- },
- "/users/search": {
- "get": {
- "operationId": "searchUsers",
- "summary": "Search for users",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- },
- "ok": {
- "type": "boolean"
- }
- }
- }
- }
- }
- }
- },
- "parameters": [
- {
- "name": "q",
- "in": "query",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Keyword of username"
- },
- {
- "name": "limit",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "default": 10
- },
- "description": "Max results"
- }
- ],
- "description": "Requests without authentication will return an empty email field for anti-spam purposes."
- }
- },
- "/users/{username}": {
- "get": {
- "operationId": "getUser",
- "summary": "Get a single user",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ]
- }
- },
- "/user": {
- "get": {
- "operationId": "getAuthenticatedUser",
- "summary": "Get the authenticated user",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- }
- }
- },
- "/users/{username}/tokens": {
- "get": {
- "operationId": "listAccessTokens",
- "summary": "List access tokens",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/AccessToken"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "security": [
- {
- "BasicAuth": []
- }
- ],
- "description": "Requires basic authentication."
- },
- "post": {
- "operationId": "createAccessToken",
- "summary": "Create an access token",
- "tags": [
- "Users"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/AccessToken"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- }
- },
- "required": [
- "name"
- ]
- }
- }
- }
- },
- "security": [
- {
- "BasicAuth": []
- }
- ],
- "description": "Requires basic authentication."
- }
- },
- "/user/emails": {
- "get": {
- "operationId": "listEmails",
- "summary": "List email addresses",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Email"
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "addEmails",
- "summary": "Add email addresses",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Email"
- }
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "emails": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "email"
- }
- }
- },
- "required": [
- "emails"
- ]
- }
- }
- }
- }
- },
- "delete": {
- "operationId": "deleteEmails",
- "summary": "Delete email addresses",
- "tags": [
- "Users"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "emails": {
- "type": "array",
- "items": {
- "type": "string",
- "format": "email"
- }
- }
- },
- "required": [
- "emails"
- ]
- }
- }
- }
- }
- }
- },
- "/users/{username}/followers": {
- "get": {
- "operationId": "listUserFollowers",
- "summary": "List followers of a user",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ]
- }
- },
- "/user/followers": {
- "get": {
- "operationId": "listMyFollowers",
- "summary": "List your followers",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- }
- }
- }
- },
- "/users/{username}/following": {
- "get": {
- "operationId": "listUserFollowing",
- "summary": "List users followed by a user",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ]
- }
- },
- "/user/following": {
- "get": {
- "operationId": "listMyFollowing",
- "summary": "List who you are following",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- }
- }
- }
- },
- "/user/following/{target}": {
- "get": {
- "operationId": "checkFollowing",
- "summary": "Check if you follow a user",
- "tags": [
- "Users"
- ],
- "responses": {
- "204": {
- "description": "The user is being followed."
- },
- "404": {
- "description": "Not following"
- }
- },
- "parameters": [
- {
- "name": "target",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Target username"
- }
- ]
- },
- "put": {
- "operationId": "followUser",
- "summary": "Follow a user",
- "tags": [
- "Users"
- ],
- "responses": {
- "204": {
- "description": "Successfully followed the user."
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "target",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Target username"
- }
- ]
- },
- "delete": {
- "operationId": "unfollowUser",
- "summary": "Unfollow a user",
- "tags": [
- "Users"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "target",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Target username"
- }
- ]
- }
- },
- "/users/{username}/following/{target}": {
- "get": {
- "operationId": "checkUserFollowing",
- "summary": "Check if a user follows another",
- "tags": [
- "Users"
- ],
- "responses": {
- "204": {
- "description": "The user is being followed."
- },
- "404": {
- "description": "Not following"
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- },
- {
- "name": "target",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Target username"
- }
- ]
- }
- },
- "/users/{username}/keys": {
- "get": {
- "operationId": "listUserKeys",
- "summary": "List public keys for a user",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PublicKey"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ]
- }
- },
- "/user/keys/{id}": {
- "get": {
- "operationId": "getPublicKey",
- "summary": "Get a single public key",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PublicKey"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Key ID"
- }
- ]
- },
- "delete": {
- "operationId": "deletePublicKey",
- "summary": "Delete a public key",
- "tags": [
- "Users"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "id",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Key ID"
- }
- ]
- }
- },
- "/user/keys": {
- "get": {
- "operationId": "listMyKeys",
- "summary": "List your public keys",
- "tags": [
- "Users"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/PublicKey"
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "createPublicKey",
- "summary": "Create a public key",
- "tags": [
- "Users"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PublicKey"
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "key": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "key"
- ]
- }
- }
- }
- }
- }
- },
- "/user/orgs": {
- "get": {
- "operationId": "listMyOrgs",
- "summary": "List your organizations",
- "tags": [
- "Organizations"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
- }
- }
- }
- },
- "post": {
- "operationId": "createMyOrg",
- "summary": "Create an organization",
- "description": "Creates an organization for the authenticated user.",
- "tags": [
- "Organizations"
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "username": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "website": {
- "type": "string"
- },
- "location": {
- "type": "string"
- }
- },
- "required": [
- "username"
- ]
- }
- }
- }
- },
- "responses": {
- "201": {
- "description": "Organization created successfully.",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
- },
- "422": {
- "description": "Organization name already exists or is not allowed."
- }
- }
- }
- },
- "/users/{username}/orgs": {
- "get": {
- "operationId": "listUserOrgs",
- "summary": "List user organizations",
- "tags": [
- "Organizations"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ]
- }
- },
- "/orgs/{orgname}": {
- "get": {
- "operationId": "getOrg",
- "summary": "Get an organization",
- "tags": [
- "Organizations"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "orgname",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Organization name"
- }
- ]
- },
- "patch": {
- "operationId": "editOrg",
- "summary": "Edit an organization",
- "tags": [
- "Organizations"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "orgname",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Organization name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "full_name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "website": {
- "type": "string"
- },
- "location": {
- "type": "string"
- }
- }
- }
- }
- }
- }
- }
- },
- "/orgs/{orgname}/teams": {
- "get": {
- "operationId": "listOrgTeams",
- "summary": "List teams of an organization",
- "tags": [
- "Organizations"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Team"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "orgname",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Organization name"
- }
- ]
- }
- },
- "/admin/users": {
- "post": {
- "operationId": "adminCreateUser",
- "summary": "Create a new user",
- "tags": [
- "Administration"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "source_id": {
- "type": "integer"
- },
- "login_name": {
- "type": "string"
- },
- "username": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "email": {
- "type": "string",
- "format": "email"
- },
- "password": {
- "type": "string"
- },
- "send_notify": {
- "type": "boolean"
- }
- },
- "required": [
- "username",
- "email"
- ]
- }
- }
- }
- },
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/users/{username}": {
- "patch": {
- "operationId": "adminEditUser",
- "summary": "Edit an existing user",
- "tags": [
- "Administration"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "source_id": {
- "type": "integer"
- },
- "login_name": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "email": {
- "type": "string",
- "format": "email"
- },
- "password": {
- "type": "string"
- },
- "website": {
- "type": "string"
- },
- "location": {
- "type": "string"
- },
- "active": {
- "type": "boolean"
- },
- "admin": {
- "type": "boolean"
- },
- "allow_git_hook": {
- "type": "boolean"
- },
- "allow_import_local": {
- "type": "boolean"
- },
- "max_repo_creation": {
- "type": "integer",
- "description": "Maximum number of repositories the user can create. -1 means no limit."
- }
- },
- "required": [
- "email"
- ]
- }
- }
- }
- },
- "description": "Requires the authenticated user to be a site administrator."
- },
- "delete": {
- "operationId": "adminDeleteUser",
- "summary": "Delete a user",
- "tags": [
- "Administration"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/users/{username}/keys": {
- "post": {
- "operationId": "adminCreateUserKey",
- "summary": "Create a public key for a user",
- "tags": [
- "Administration"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/PublicKey"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "title": {
- "type": "string"
- },
- "key": {
- "type": "string"
- }
- },
- "required": [
- "title",
- "key"
- ]
- }
- }
- }
- },
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/users/{username}/repos": {
- "post": {
- "operationId": "adminCreateRepo",
- "summary": "Create a repository for a user",
- "tags": [
- "Administration"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "private": {
- "type": "boolean",
- "default": false
- },
- "auto_init": {
- "type": "boolean",
- "default": false
- },
- "gitignores": {
- "type": "string"
- },
- "license": {
- "type": "string"
- },
- "readme": {
- "type": "string",
- "default": "Default"
- }
- },
- "required": [
- "name"
- ]
- }
- }
- }
- },
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/users/{username}/orgs": {
- "post": {
- "operationId": "adminCreateOrg",
- "summary": "Create an organization",
- "tags": [
- "Administration"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Organization"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "username": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "website": {
- "type": "string"
- },
- "location": {
- "type": "string"
- }
- },
- "required": [
- "username"
- ]
- }
- }
- }
- },
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/orgs/{orgname}/teams": {
- "post": {
- "operationId": "adminCreateTeam",
- "summary": "Create a team",
- "tags": [
- "Administration"
- ],
- "responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/Team"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "orgname",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Organization name"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin"
- ],
- "default": "read"
- }
- },
- "required": [
- "name"
- ]
- }
- }
- }
- },
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/teams/{teamid}/members": {
- "get": {
- "operationId": "adminListTeamMembers",
- "summary": "List all members of a team",
- "tags": [
- "Administration"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/User"
- }
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "teamid",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Team ID"
- }
- ],
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/teams/{teamid}/members/{username}": {
- "put": {
- "operationId": "adminAddTeamMember",
- "summary": "Add team membership",
- "tags": [
- "Administration"
- ],
- "responses": {
- "204": {
- "description": "Team membership has been updated."
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "teamid",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Team ID"
- },
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "description": "Requires the authenticated user to be a site administrator."
- },
- "delete": {
- "operationId": "adminRemoveTeamMember",
- "summary": "Remove team membership",
- "tags": [
- "Administration"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "teamid",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Team ID"
- },
- {
- "name": "username",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Username"
- }
- ],
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/admin/teams/{teamid}/repos/{reponame}": {
- "put": {
- "operationId": "adminAddTeamRepo",
- "summary": "Add or update team repository",
- "tags": [
- "Administration"
- ],
- "responses": {
- "204": {
- "description": "Team repository has been updated."
- },
- "404": {
- "description": "Resource not found."
- },
- "422": {
- "description": "Validation error."
- }
- },
- "parameters": [
- {
- "name": "teamid",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Team ID"
- },
- {
- "name": "reponame",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "description": "Requires the authenticated user to be a site administrator."
- },
- "delete": {
- "operationId": "adminRemoveTeamRepo",
- "summary": "Remove team repository",
- "tags": [
- "Administration"
- ],
- "responses": {
- "204": {
- "description": "The resource has been successfully deleted."
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "teamid",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Team ID"
- },
- {
- "name": "reponame",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- }
- ],
- "description": "Requires the authenticated user to be a site administrator."
- }
- },
- "/markdown": {
- "post": {
- "operationId": "renderMarkdown",
- "summary": "Render a Markdown document",
- "tags": [
- "Miscellaneous"
- ],
- "responses": {
- "200": {
- "description": "Rendered HTML",
- "content": {
- "text/html": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "text": {
- "type": "string"
- },
- "context": {
- "type": "string",
- "description": "Repository context URL"
- }
- },
- "required": [
- "text"
- ]
- }
- }
- }
- }
- }
- },
- "/markdown/raw": {
- "post": {
- "operationId": "renderMarkdownRaw",
- "summary": "Render a Markdown document in raw mode",
- "tags": [
- "Miscellaneous"
- ],
- "responses": {
- "200": {
- "description": "Rendered HTML",
- "content": {
- "text/html": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "422": {
- "description": "Validation error."
- }
- },
- "requestBody": {
- "required": true,
- "content": {
- "text/plain": {
- "schema": {
- "type": "string"
- }
- }
- }
- },
- "description": "Takes a Markdown document as plaintext and renders it without a repository context."
- }
- },
- "/repos/{owner}/{repo}/git/trees/{sha}": {
- "get": {
- "operationId": "getTree",
- "summary": "Get a tree",
- "tags": [
- "Miscellaneous"
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GitTree"
- }
- }
- }
- },
- "404": {
- "description": "Resource not found."
- }
- },
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository owner"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Repository name"
- },
- {
- "name": "sha",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Tree SHA"
- }
- ]
- }
- },
- "/repos/{owner}/{repo}/forks": {
- "get": {
- "operationId": "listForks",
- "summary": "List forks",
- "tags": [
- "Repositories"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Repository"
- }
- }
- }
- }
- },
- "404": {
- "description": "Repository not found."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/tags": {
- "get": {
- "operationId": "listTags",
- "summary": "List tags",
- "tags": [
- "Repositories"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Tag"
- }
- }
- }
- }
- },
- "404": {
- "description": "Repository not found."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/commits": {
- "get": {
- "operationId": "getAllCommits",
- "summary": "List all commits",
- "description": "Returns commits from the HEAD of the default branch.",
- "tags": [
- "Repositories"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- },
- {
- "name": "pageSize",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer",
- "default": 30
- },
- "description": "Number of commits to return"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Commit"
- }
- }
- }
- }
- },
- "404": {
- "description": "Repository not found."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/wiki": {
- "patch": {
- "operationId": "editWiki",
- "summary": "Edit wiki settings",
- "tags": [
- "Repositories"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- }
- ],
- "requestBody": {
- "required": true,
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "enable_wiki": {
- "type": "boolean",
- "description": "Whether to enable the wiki"
- },
- "allow_public_wiki": {
- "type": "boolean",
- "description": "Whether the wiki is publicly accessible"
- },
- "enable_external_wiki": {
- "type": "boolean",
- "description": "Whether to use an external wiki"
- },
- "external_wiki_url": {
- "type": "string",
- "description": "URL of the external wiki"
- }
- }
- }
- }
- }
- },
- "responses": {
- "204": {
- "description": "Wiki settings updated successfully."
- },
- "404": {
- "description": "Repository not found."
- },
- "422": {
- "description": "Validation error."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/editorconfig/{filename}": {
- "get": {
- "operationId": "getEditorconfig",
- "summary": "Get editorconfig definition",
- "description": "Returns the editorconfig definition for the given filename in the repository.",
- "tags": [
- "Repositories"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- },
- {
- "name": "filename",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Filename to get the editorconfig definition for"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/EditorConfigDefinition"
- }
- }
- }
- },
- "404": {
- "description": "No editorconfig file exists or no matching definition for the filename."
- }
- }
- }
- },
- "/repos/{owner}/{repo}/git/blobs/{sha}": {
- "get": {
- "operationId": "getGitBlob",
- "summary": "Get a git blob",
- "description": "Returns the content of a git blob object, base64 encoded.",
- "tags": [
- "Miscellaneous"
- ],
- "parameters": [
- {
- "name": "owner",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Owner of the repository"
- },
- {
- "name": "repo",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "Name of the repository"
- },
- {
- "name": "sha",
- "in": "path",
- "required": true,
- "schema": {
- "type": "string"
- },
- "description": "SHA of the git blob"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/GitBlob"
- }
- }
- }
- },
- "404": {
- "description": "Blob not found."
- }
- }
- }
- },
- "/user/issues": {
- "get": {
- "operationId": "listUserIssues",
- "summary": "List issues assigned to the authenticated user",
- "description": "Lists issues across all repositories assigned to the authenticated user. Also available at `GET /issues`.",
- "tags": [
- "Issues"
- ],
- "parameters": [
- {
- "name": "page",
- "in": "query",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "description": "Page number"
- },
- {
- "name": "state",
- "in": "query",
- "required": false,
- "schema": {
- "type": "string",
- "enum": [
- "open",
- "closed"
- ],
- "default": "open"
- },
- "description": "Filter by state"
- }
- ],
- "responses": {
- "200": {
- "description": "Success",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Issue"
- }
- }
- }
- }
- }
- }
- }
- }
- },
- "components": {
- "securitySchemes": {
- "BasicAuth": {
- "type": "http",
- "scheme": "basic"
- },
- "AccessToken": {
- "type": "apiKey",
- "in": "header",
- "name": "Authorization",
- "description": "Personal access token. Use format: token {YOUR_ACCESS_TOKEN}"
- },
- "TokenQuery": {
- "type": "apiKey",
- "in": "query",
- "name": "token",
- "description": "Access token as query parameter"
- }
- },
- "schemas": {
- "User": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "username": {
- "type": "string"
- },
- "login": {
- "type": "string",
- "description": "Alias of username for GitHub API compatibility"
- },
- "full_name": {
- "type": "string"
- },
- "email": {
- "type": "string",
- "format": "email"
- },
- "avatar_url": {
- "type": "string"
- }
- }
- },
- "Collaborator": {
- "description": "A repository collaborator with permission information",
- "allOf": [
- {
- "$ref": "#/components/schemas/User"
- },
- {
- "type": "object",
- "properties": {
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- }
- }
- }
- }
- ]
- },
- "Repository": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "owner": {
- "$ref": "#/components/schemas/User"
- },
- "name": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "private": {
- "type": "boolean"
- },
- "fork": {
- "type": "boolean"
- },
- "parent": {
- "$ref": "#/components/schemas/Repository",
- "nullable": true,
- "description": "Present when fork is true"
- },
- "empty": {
- "type": "boolean"
- },
- "mirror": {
- "type": "boolean"
- },
- "size": {
- "type": "integer"
- },
- "html_url": {
- "type": "string"
- },
- "ssh_url": {
- "type": "string"
- },
- "clone_url": {
- "type": "string"
- },
- "website": {
- "type": "string"
- },
- "stars_count": {
- "type": "integer"
- },
- "forks_count": {
- "type": "integer"
- },
- "watchers_count": {
- "type": "integer"
- },
- "open_issues_count": {
- "type": "integer"
- },
- "default_branch": {
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- },
- "permissions": {
- "type": "object",
- "properties": {
- "admin": {
- "type": "boolean"
- },
- "push": {
- "type": "boolean"
- },
- "pull": {
- "type": "boolean"
- }
- }
- }
- }
- },
- "Branch": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "commit": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "author": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "committer": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "timestamp": {
- "type": "string",
- "format": "date-time"
- }
- }
- }
- }
- },
- "Commit": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "sha": {
- "type": "string"
- },
- "html_url": {
- "type": "string"
- },
- "commit": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "author": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "date": {
- "type": "string"
- }
- }
- },
- "committer": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "email": {
- "type": "string"
- },
- "date": {
- "type": "string"
- }
- }
- },
- "tree": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "sha": {
- "type": "string"
- }
- }
- }
- }
- },
- "author": {
- "$ref": "#/components/schemas/User"
- },
- "committer": {
- "$ref": "#/components/schemas/User"
- },
- "parents": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "url": {
- "type": "string"
- },
- "sha": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "Issue": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "number": {
- "type": "integer"
- },
- "state": {
- "type": "string",
- "enum": [
- "open",
- "closed"
- ]
- },
- "title": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "user": {
- "$ref": "#/components/schemas/User"
- },
- "labels": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/Label"
- }
- },
- "assignee": {
- "$ref": "#/components/schemas/User",
- "nullable": true
- },
- "milestone": {
- "$ref": "#/components/schemas/Milestone",
- "nullable": true
- },
- "comments": {
- "type": "integer"
- },
- "pull_request": {
- "type": "object",
- "nullable": true
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "Comment": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "html_url": {
- "type": "string"
- },
- "user": {
- "$ref": "#/components/schemas/User"
- },
- "body": {
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "Label": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "color": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "Milestone": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "state": {
- "type": "string",
- "enum": [
- "open",
- "closed"
- ]
- },
- "title": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "open_issues": {
- "type": "integer"
- },
- "closed_issues": {
- "type": "integer"
- },
- "closed_at": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- },
- "due_on": {
- "type": "string",
- "format": "date-time",
- "nullable": true
- }
- }
- },
- "Hook": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "type": {
- "type": "string",
- "enum": [
- "gogs",
- "slack",
- "discord",
- "dingtalk"
- ]
- },
- "events": {
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "active": {
- "type": "boolean"
- },
- "config": {
- "type": "object"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "updated_at": {
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "Release": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "tag_name": {
- "type": "string"
- },
- "target_commitish": {
- "type": "string"
- },
- "name": {
- "type": "string"
- },
- "body": {
- "type": "string"
- },
- "draft": {
- "type": "boolean"
- },
- "prerelease": {
- "type": "boolean"
- },
- "author": {
- "$ref": "#/components/schemas/User"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "DeployKey": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "key": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- },
- "read_only": {
- "type": "boolean"
- }
- }
- },
- "PublicKey": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "key": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "title": {
- "type": "string"
- },
- "created_at": {
- "type": "string",
- "format": "date-time"
- }
- }
- },
- "AccessToken": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "sha1": {
- "type": "string"
- }
- }
- },
- "Email": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string",
- "format": "email"
- },
- "verified": {
- "type": "boolean"
- },
- "primary": {
- "type": "boolean"
- }
- }
- },
- "Organization": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "username": {
- "type": "string"
- },
- "full_name": {
- "type": "string"
- },
- "avatar_url": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "website": {
- "type": "string"
- },
- "location": {
- "type": "string"
- }
- }
- },
- "Team": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "description": {
- "type": "string"
- },
- "permission": {
- "type": "string",
- "enum": [
- "read",
- "write",
- "admin",
- "owner"
- ]
- }
- }
- },
- "Content": {
- "type": "object",
- "properties": {
- "type": {
- "type": "string",
- "enum": [
- "file",
- "dir",
- "symlink",
- "submodule"
- ]
- },
- "encoding": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "name": {
- "type": "string"
- },
- "path": {
- "type": "string"
- },
- "content": {
- "type": "string"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "git_url": {
- "type": "string"
- },
- "html_url": {
- "type": "string"
- },
- "download_url": {
- "type": "string"
- },
- "_links": {
- "type": "object",
- "properties": {
- "git": {
- "type": "string"
- },
- "self": {
- "type": "string"
- },
- "html": {
- "type": "string"
- }
- }
- }
- }
- },
- "GitTree": {
- "type": "object",
- "properties": {
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "tree": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "path": {
- "type": "string"
- },
- "mode": {
- "type": "string"
- },
- "type": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- },
- "sha": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- }
- }
- }
- },
- "Error": {
- "type": "object",
- "properties": {
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- }
- }
- },
- "GitBlob": {
- "type": "object",
- "properties": {
- "content": {
- "type": "string",
- "description": "Base64-encoded blob content"
- },
- "encoding": {
- "type": "string",
- "example": "base64"
- },
- "url": {
- "type": "string"
- },
- "sha": {
- "type": "string"
- },
- "size": {
- "type": "integer"
- }
- }
- },
- "Tag": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "commit": {
- "type": "object",
- "properties": {
- "id": {
- "type": "string"
- },
- "message": {
- "type": "string"
- },
- "url": {
- "type": "string"
- },
- "author": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "email": {
- "type": "string",
- "format": "email"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "committer": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string"
- },
- "email": {
- "type": "string",
- "format": "email"
- },
- "username": {
- "type": "string"
- }
- }
- },
- "timestamp": {
- "type": "string",
- "format": "date-time"
- }
- }
- }
- }
- },
- "EditorConfigDefinition": {
- "type": "object",
- "properties": {
- "charset": {
- "type": "string"
- },
- "indent_style": {
- "type": "string"
- },
- "indent_size": {
- "type": "string"
- },
- "end_of_line": {
- "type": "string"
- }
- }
- }
- }
- }
- }
|